sing-box/docs/configuration/route/rule.md

356 lines
6.1 KiB
Markdown
Raw Normal View History

2024-06-24 01:41:00 +00:00
---
icon: material/alert-decagram
---
!!! quote "Changes in sing-box 1.10.0"
:material-delete-clock: [rule_set_ipcidr_match_source](#rule_set_ipcidr_match_source)
:material-plus: [rule_set_ip_cidr_match_source](#rule_set_ip_cidr_match_source)
2023-12-01 05:24:18 +00:00
!!! quote "Changes in sing-box 1.8.0"
:material-plus: [rule_set](#rule_set)
:material-plus: [rule_set_ipcidr_match_source](#rule_set_ipcidr_match_source)
:material-plus: [source_ip_is_private](#source_ip_is_private)
:material-plus: [ip_is_private](#ip_is_private)
:material-delete-clock: [source_geoip](#source_geoip)
:material-delete-clock: [geoip](#geoip)
:material-delete-clock: [geosite](#geosite)
2022-07-08 12:15:45 +00:00
### Structure
```json
{
"route": {
"rules": [
{
"inbound": [
"mixed-in"
],
2022-08-16 15:46:05 +00:00
"ip_version": 6,
2023-06-07 12:28:21 +00:00
"network": [
"tcp"
],
2022-07-27 04:03:07 +00:00
"auth_user": [
2022-07-17 07:11:26 +00:00
"usera",
"userb"
],
2022-07-08 12:15:45 +00:00
"protocol": [
"tls",
"http",
"quic"
],
"domain": [
"test.com"
],
"domain_suffix": [
".cn"
],
"domain_keyword": [
"test"
],
"domain_regex": [
"^stun\\..+"
],
"geosite": [
"cn"
],
"source_geoip": [
"private"
],
"geoip": [
"cn"
],
"source_ip_cidr": [
2022-08-25 14:22:20 +00:00
"10.0.0.0/24",
"192.168.0.1"
2022-07-08 12:15:45 +00:00
],
2023-12-01 05:24:18 +00:00
"source_ip_is_private": false,
2022-07-08 12:15:45 +00:00
"ip_cidr": [
2022-08-25 14:22:20 +00:00
"10.0.0.0/24",
"192.168.0.1"
2022-07-08 12:15:45 +00:00
],
2023-12-01 05:24:18 +00:00
"ip_is_private": false,
2022-07-08 12:15:45 +00:00
"source_port": [
12345
],
2022-07-27 04:03:07 +00:00
"source_port_range": [
"1000:2000",
":3000",
"4000:"
],
2022-07-08 12:15:45 +00:00
"port": [
80,
443
],
2022-07-27 04:03:07 +00:00
"port_range": [
"1000:2000",
":3000",
"4000:"
],
"process_name": [
"curl"
],
2022-08-31 06:33:52 +00:00
"process_path": [
"/usr/bin/curl"
],
2022-07-27 04:03:07 +00:00
"package_name": [
"com.termux"
],
"user": [
"sekai"
],
"user_id": [
1000
],
2022-09-10 14:42:20 +00:00
"clash_mode": "direct",
"wifi_ssid": [
"My WIFI"
],
"wifi_bssid": [
"00:00:00:00:00:00"
],
2023-12-01 05:24:18 +00:00
"rule_set": [
"geoip-cn",
"geosite-cn"
],
2024-06-24 01:41:00 +00:00
// deprecated
"rule_set_ipcidr_match_source": false,
2024-06-24 01:41:00 +00:00
"rule_set_ip_cidr_match_source": false,
2022-07-27 04:03:07 +00:00
"invert": false,
2022-07-08 12:15:45 +00:00
"outbound": "direct"
},
{
"type": "logical",
"mode": "and",
"rules": [],
2022-07-27 04:03:07 +00:00
"invert": false,
2022-07-08 12:15:45 +00:00
"outbound": "direct"
}
]
}
}
```
!!! note ""
You can ignore the JSON Array [] tag when the content is only one item
### Default Fields
!!! note ""
The default rule uses the following matching logic:
2023-12-01 05:24:18 +00:00
(`domain` || `domain_suffix` || `domain_keyword` || `domain_regex` || `geosite` || `geoip` || `ip_cidr` || `ip_is_private`) &&
2022-09-14 14:03:26 +00:00
(`port` || `port_range`) &&
2023-12-01 05:24:18 +00:00
(`source_geoip` || `source_ip_cidr` || `source_ip_is_private`) &&
2022-09-14 14:03:26 +00:00
(`source_port` || `source_port_range`) &&
`other fields`
2022-07-08 12:15:45 +00:00
2024-06-25 16:45:10 +00:00
Additionally, included rule-sets can be considered merged rather than as a single rule sub-item.
2023-12-01 05:24:18 +00:00
2022-07-08 12:15:45 +00:00
#### inbound
2023-12-14 14:23:52 +00:00
Tags of [Inbound](/configuration/inbound/).
2022-07-08 12:15:45 +00:00
2022-08-16 15:46:05 +00:00
#### ip_version
4 or 6.
Not limited if empty.
2022-07-27 04:03:07 +00:00
#### auth_user
2022-07-17 07:11:26 +00:00
Username, see each inbound for details.
#### protocol
Sniffed protocol, see [Sniff](/configuration/route/sniff/) for details.
2022-07-08 12:15:45 +00:00
#### network
`tcp` or `udp`.
#### domain
Match full domain.
#### domain_suffix
Match domain suffix.
#### domain_keyword
Match domain using keyword.
#### domain_regex
Match domain using regular expression.
#### geosite
2023-12-01 05:24:18 +00:00
!!! failure "Deprecated in sing-box 1.8.0"
Geosite is deprecated and may be removed in the future, check [Migration](/migration/#migrate-geosite-to-rule-sets).
2022-07-08 12:15:45 +00:00
Match geosite.
#### source_geoip
2023-12-01 05:24:18 +00:00
!!! failure "Deprecated in sing-box 1.8.0"
GeoIP is deprecated and may be removed in the future, check [Migration](/migration/#migrate-geoip-to-rule-sets).
2022-07-08 12:15:45 +00:00
Match source geoip.
#### geoip
2023-12-01 05:24:18 +00:00
!!! failure "Deprecated in sing-box 1.8.0"
GeoIP is deprecated and may be removed in the future, check [Migration](/migration/#migrate-geoip-to-rule-sets).
2022-07-08 12:15:45 +00:00
Match geoip.
#### source_ip_cidr
2023-12-01 05:24:18 +00:00
Match source IP CIDR.
#### ip_is_private
!!! question "Since sing-box 1.8.0"
Match non-public IP.
2022-07-08 12:15:45 +00:00
#### ip_cidr
2023-12-01 05:24:18 +00:00
Match IP CIDR.
#### source_ip_is_private
!!! question "Since sing-box 1.8.0"
Match non-public source IP.
2022-07-08 12:15:45 +00:00
#### source_port
Match source port.
2022-07-27 04:03:07 +00:00
#### source_port_range
Match source port range.
2022-07-08 12:15:45 +00:00
#### port
Match port.
2022-07-27 04:03:07 +00:00
#### port_range
Match port range.
#### process_name
!!! quote ""
2022-07-27 04:03:07 +00:00
Only supported on Linux, Windows, and macOS.
Match process name.
2022-08-31 06:33:52 +00:00
#### process_path
!!! quote ""
2022-08-31 06:33:52 +00:00
Only supported on Linux, Windows, and macOS.
Match process path.
2022-07-27 04:03:07 +00:00
#### package_name
Match android package name.
#### user
!!! quote ""
2022-07-27 04:03:07 +00:00
2022-08-09 08:36:17 +00:00
Only supported on Linux.
2022-07-27 04:03:07 +00:00
Match user name.
#### user_id
!!! quote ""
2022-07-27 04:03:07 +00:00
Only supported on Linux.
Match user id.
2022-09-10 14:42:20 +00:00
#### clash_mode
Match Clash mode.
#### wifi_ssid
!!! quote ""
Only supported in graphical clients on Android and Apple platforms.
Match WiFi SSID.
#### wifi_bssid
!!! quote ""
Only supported in graphical clients on Android and Apple platforms.
Match WiFi BSSID.
2023-12-01 05:24:18 +00:00
#### rule_set
!!! question "Since sing-box 1.8.0"
2024-06-25 16:45:10 +00:00
Match [rule-set](/configuration/route/#rule_set).
2023-12-01 05:24:18 +00:00
#### rule_set_ipcidr_match_source
!!! question "Since sing-box 1.8.0"
2024-06-24 01:41:00 +00:00
!!! failure "Deprecated in sing-box 1.10.0"
`rule_set_ipcidr_match_source` is renamed to `rule_set_ip_cidr_match_source` and will be remove in sing-box 1.11.0.
2024-06-25 16:45:10 +00:00
Make `ip_cidr` in rule-sets match the source IP.
2024-06-24 01:41:00 +00:00
#### rule_set_ip_cidr_match_source
!!! question "Since sing-box 1.10.0"
2024-06-25 16:45:10 +00:00
Make `ip_cidr` in rule-sets match the source IP.
2023-12-01 05:24:18 +00:00
2022-07-27 04:03:07 +00:00
#### invert
Invert match result.
2022-07-08 12:15:45 +00:00
#### outbound
2022-07-27 04:03:07 +00:00
==Required==
2022-07-08 12:15:45 +00:00
Tag of the target outbound.
### Logical Fields
#### type
`logical`
#### mode
2023-06-07 12:28:21 +00:00
==Required==
2022-07-08 12:15:45 +00:00
`and` or `or`
#### rules
2022-07-27 04:03:07 +00:00
==Required==
2023-12-01 05:24:18 +00:00
Included rules.