sing-box/docs/configuration/inbound/tun.md

305 lines
6.3 KiB
Markdown
Raw Normal View History

---
icon: material/new-box
---
!!! quote "Changes in sing-box 1.9.0"
:material-plus: [platform.http_proxy.bypass_domain](#platformhttp_proxybypass_domain)
:material-plus: [platform.http_proxy.match_domain](#platformhttp_proxymatch_domain)
!!! quote "Changes in sing-box 1.8.0"
:material-plus: [gso](#gso)
:material-alert-decagram: [stack](#stack)
!!! quote ""
2022-08-05 08:55:46 +00:00
Only supported on Linux, Windows and macOS.
### Structure
```json
{
2022-08-31 04:50:26 +00:00
"type": "tun",
"tag": "tun-in",
"interface_name": "tun0",
"inet4_address": "172.19.0.1/30",
2022-09-10 02:21:42 +00:00
"inet6_address": "fdfe:dcba:9876::1/126",
2022-09-09 07:40:35 +00:00
"mtu": 9000,
"gso": false,
2022-08-31 04:50:26 +00:00
"auto_route": true,
"strict_route": true,
2022-10-12 08:20:17 +00:00
"inet4_route_address": [
"0.0.0.0/1",
"128.0.0.0/1"
],
"inet6_route_address": [
"::/1",
"8000::/1"
],
"inet4_route_exclude_address": [
"192.168.0.0/16"
],
"inet6_route_exclude_address": [
"fc00::/7"
],
2022-08-31 04:50:26 +00:00
"endpoint_independent_nat": false,
"udp_timeout": "5m",
2022-09-15 04:20:38 +00:00
"stack": "system",
"include_interface": [
"lan0"
],
"exclude_interface": [
"lan1"
],
2022-08-31 04:50:26 +00:00
"include_uid": [
0
],
"include_uid_range": [
"1000-99999"
],
"exclude_uid": [
1000
],
"exclude_uid_range": [
"1000-99999"
],
"include_android_user": [
0,
10
],
"include_package": [
"com.android.chrome"
],
"exclude_package": [
"com.android.captiveportallogin"
],
"platform": {
"http_proxy": {
"enabled": false,
"server": "127.0.0.1",
"server_port": 8080,
"bypass_domain": [],
"match_domain": []
}
},
... // Listen Fields
}
```
!!! note ""
You can ignore the JSON Array [] tag when the content is only one item
2022-08-08 12:57:50 +00:00
!!! warning ""
If tun is running in non-privileged mode, addresses and MTU will not be configured automatically, please make sure the settings are accurate.
2022-08-08 12:57:50 +00:00
2022-08-31 04:50:26 +00:00
### Fields
2022-08-08 12:57:50 +00:00
#### interface_name
Virtual device name, automatically selected if empty.
#### inet4_address
==Required==
IPv4 prefix for the tun interface.
#### inet6_address
IPv6 prefix for the tun interface.
#### mtu
The maximum transmission unit.
#### gso
!!! question "Since sing-box 1.8.0"
!!! quote ""
Only supported on Linux.
Enable generic segmentation offload.
#### auto_route
Set the default route to the Tun.
!!! quote ""
2022-07-15 03:51:51 +00:00
To avoid traffic loopback, set `route.auto_detect_interface` or `route.default_interface` or `outbound.bind_interface`
2022-09-09 07:40:35 +00:00
!!! note "Use with Android VPN"
By default, VPN takes precedence over tun. To make tun go through VPN, enable `route.override_android_vpn`.
2022-08-26 15:52:17 +00:00
#### strict_route
2022-10-01 03:48:46 +00:00
Enforce strict routing rules when `auto_route` is enabled:
2022-08-26 15:52:17 +00:00
2022-11-06 02:15:13 +00:00
*In Linux*:
2022-08-26 15:52:17 +00:00
* Let unsupported network unreachable
* Route all connections to tun
It prevents address leaks and makes DNS hijacking work on Android.
2022-08-26 15:52:17 +00:00
2022-11-06 02:15:13 +00:00
*In Windows*:
* Add firewall rules to prevent DNS leak caused by
Windows' [ordinary multihomed DNS resolution behavior](https://learn.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/dd197552%28v%3Dws.10%29)
It may prevent some applications (such as VirtualBox) from working properly in certain situations.
2022-10-12 08:20:17 +00:00
#### inet4_route_address
Use custom routes instead of default when `auto_route` is enabled.
#### inet6_route_address
Use custom routes instead of default when `auto_route` is enabled.
#### inet4_route_exclude_address
Exclude custom routes when `auto_route` is enabled.
#### inet6_route_exclude_address
Exclude custom routes when `auto_route` is enabled.
2022-07-27 04:03:07 +00:00
#### endpoint_independent_nat
2022-09-09 07:40:35 +00:00
!!! info ""
This item is only available on the gvisor stack, other stacks are endpoint-independent NAT by default.
2022-08-05 08:55:46 +00:00
Enable endpoint-independent NAT.
2022-07-27 04:03:07 +00:00
Performance may degrade slightly, so it is not recommended to enable on when it is not needed.
#### udp_timeout
UDP NAT expiration time in seconds, default is 300 (5 minutes).
2022-08-08 12:57:50 +00:00
#### stack
!!! quote "Changes in sing-box 1.8.0"
2022-08-08 12:57:50 +00:00
:material-delete-alert: The legacy LWIP stack has been deprecated and removed.
2022-08-08 12:57:50 +00:00
TCP/IP stack.
| Stack | Description |
|----------|-------------------------------------------------------------------------------------------------------|
| `system` | Perform L3 to L4 translation using the system network stack |
| `gvisor` | Perform L3 to L4 translation using [gVisor](https://github.com/google/gvisor)'s virtual network stack |
| `mixed` | Mixed `system` TCP stack and `gvisor` UDP stack |
2022-08-08 12:57:50 +00:00
Defaults to the `mixed` stack if the gVisor build tag is enabled, otherwise defaults to the `system` stack.
2022-08-08 12:57:50 +00:00
#### include_interface
!!! quote ""
Interface rules are only supported on Linux and require auto_route.
Limit interfaces in route. Not limited by default.
Conflict with `exclude_interface`.
#### exclude_interface
Exclude interfaces in route.
Conflict with `include_interface`.
#### include_uid
!!! quote ""
UID rules are only supported on Linux and require auto_route.
Limit users in route. Not limited by default.
#### include_uid_range
Limit users in route, but in range.
#### exclude_uid
Exclude users in route.
#### exclude_uid_range
Exclude users in route, but in range.
#### include_android_user
!!! quote ""
Android user and package rules are only supported on Android and require auto_route.
Limit android users in route.
| Common user | ID |
|--------------|----|
| Main | 0 |
| Work Profile | 10 |
#### include_package
Limit android packages in route.
#### exclude_package
Exclude android packages in route.
#### platform
Platform-specific settings, provided by client applications.
#### platform.http_proxy
System HTTP proxy settings.
#### platform.http_proxy.enabled
Enable system HTTP proxy.
#### platform.http_proxy.server
==Required==
HTTP proxy server address.
#### platform.http_proxy.server_port
==Required==
HTTP proxy server port.
#### platform.http_proxy.bypass_domain
!!! note ""
On Apple platforms, `bypass_domain` items matches hostname **suffixes**.
Hostnames that bypass the HTTP proxy.
#### platform.http_proxy.match_domain
!!! quote ""
Only supported in graphical clients on Apple platforms.
Hostnames that use the HTTP proxy.
### Listen Fields
2023-12-14 14:23:52 +00:00
See [Listen Fields](/configuration/shared/listen/) for details.