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

433 lines
7.8 KiB
Markdown
Raw Normal View History

2024-06-24 01:41:00 +00:00
---
2024-11-06 11:02:55 +00:00
icon: material/new-box
2024-06-24 01:41:00 +00:00
---
2024-11-06 11:02:55 +00:00
!!! quote "sing-box 1.11.0 中的更改"
:material-plus: [action](#action)
2024-11-11 11:33:40 +00:00
:material-alert: [outbound](#outbound)
:material-plus: [network_type](#network_type)
:material-plus: [network_is_expensive](#network_is_expensive)
:material-plus: [network_is_constrained](#network_is_constrained)
2024-11-06 11:02:55 +00:00
2024-06-24 01:41:00 +00:00
!!! quote "sing-box 1.10.0 中的更改"
2024-07-07 07:45:50 +00:00
:material-plus: [client](#client)
2024-06-24 01:41:00 +00:00
:material-delete-clock: [rule_set_ipcidr_match_source](#rule_set_ipcidr_match_source)
2024-09-15 03:42:57 +00:00
:material-plus: [process_path_regex](#process_path_regex)
2023-12-01 05:24:18 +00:00
!!! quote "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)
### 结构
```json
{
"route": {
"rules": [
{
"inbound": [
"mixed-in"
],
"ip_version": 6,
2023-06-07 12:28:21 +00:00
"network": [
"tcp"
],
"auth_user": [
"usera",
"userb"
],
"protocol": [
"tls",
"http",
"quic"
],
2024-07-07 07:45:50 +00:00
"client": [
"chromium",
"safari",
"firefox",
"quic-go"
],
"domain": [
"test.com"
],
"domain_suffix": [
".cn"
],
"domain_keyword": [
"test"
],
"domain_regex": [
"^stun\\..+"
],
"geosite": [
"cn"
],
"source_geoip": [
"private"
],
"geoip": [
"cn"
],
"source_ip_cidr": [
"10.0.0.0/24"
],
2023-12-01 05:24:18 +00:00
"source_ip_is_private": false,
"ip_cidr": [
"10.0.0.0/24"
],
2023-12-01 05:24:18 +00:00
"ip_is_private": false,
"source_port": [
12345
],
"source_port_range": [
"1000:2000",
":3000",
"4000:"
],
"port": [
80,
443
],
"port_range": [
"1000:2000",
":3000",
"4000:"
],
"process_name": [
"curl"
],
2022-08-31 06:33:52 +00:00
"process_path": [
"/usr/bin/curl"
],
2024-09-15 03:42:57 +00:00
"process_path_regex": [
"^/usr/bin/.+"
],
"package_name": [
"com.termux"
],
"user": [
"sekai"
],
"user_id": [
1000
],
2022-09-10 14:42:20 +00:00
"clash_mode": "direct",
2024-11-11 11:33:40 +00:00
"network_type": [
"wifi"
],
"network_is_expensive": false,
"network_is_constrained": false,
"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
// 已弃用
"rule_set_ipcidr_match_source": false,
2024-06-24 01:41:00 +00:00
"rule_set_ip_cidr_match_source": false,
"invert": false,
2024-11-06 11:02:55 +00:00
"action": "route",
"outbound": "direct"
},
{
"type": "logical",
"mode": "and",
"rules": [],
"invert": false,
2024-11-06 11:02:55 +00:00
"action": "route",
"outbound": "direct"
}
]
}
}
```
!!! note ""
当内容只有一项时,可以忽略 JSON 数组 [] 标签。
2024-11-11 11:33:40 +00:00
### 默认字段
!!! note ""
默认规则使用以下匹配逻辑:
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`
2023-12-01 05:24:18 +00:00
另外,引用的规则集可视为被合并,而不是作为一个单独的规则子项。
#### inbound
2023-12-14 14:23:52 +00:00
[入站](/zh/configuration/inbound/) 标签。
#### ip_version
4 或 6。
默认不限制。
#### auth_user
认证用户名,参阅入站设置。
#### protocol
探测到的协议, 参阅 [协议探测](/zh/configuration/route/sniff/)。
2024-07-07 07:45:50 +00:00
#### client
!!! question "自 sing-box 1.10.0 起"
探测到的客户端类型, 参阅 [协议探测](/zh/configuration/route/sniff/)。
#### network
`tcp``udp`
#### domain
匹配完整域名。
#### domain_suffix
匹配域名后缀。
#### domain_keyword
匹配域名关键字。
#### domain_regex
匹配域名正则表达式。
#### geosite
2023-12-01 05:24:18 +00:00
!!! failure "已在 sing-box 1.8.0 废弃"
2023-12-03 06:53:22 +00:00
Geosite 已废弃且可能在不久的将来移除,参阅 [迁移指南](/zh/migration/#geosite)。
2023-12-01 05:24:18 +00:00
匹配 Geosite。
#### source_geoip
2023-12-01 05:24:18 +00:00
!!! failure "已在 sing-box 1.8.0 废弃"
2023-12-03 06:53:22 +00:00
GeoIP 已废弃且可能在不久的将来移除,参阅 [迁移指南](/zh/migration/#geoip)。
2023-12-01 05:24:18 +00:00
匹配源 GeoIP。
#### geoip
2023-12-01 05:24:18 +00:00
!!! failure "已在 sing-box 1.8.0 废弃"
2023-12-03 06:53:22 +00:00
GeoIP 已废弃且可能在不久的将来移除,参阅 [迁移指南](/zh/migration/#geoip)。
2023-12-01 05:24:18 +00:00
匹配 GeoIP。
#### source_ip_cidr
匹配源 IP CIDR。
2023-12-01 05:24:18 +00:00
#### source_ip_is_private
!!! question "自 sing-box 1.8.0 起"
匹配非公开源 IP。
#### ip_cidr
匹配 IP CIDR。
2023-12-01 05:24:18 +00:00
#### ip_is_private
!!! question "自 sing-box 1.8.0 起"
匹配非公开 IP。
#### source_port
匹配源端口。
#### source_port_range
匹配源端口范围。
#### port
匹配端口。
#### port_range
匹配端口范围。
#### process_name
!!! quote ""
仅支持 Linux、Windows 和 macOS。
匹配进程名称。
2022-08-31 06:33:52 +00:00
#### process_path
!!! quote ""
2022-08-31 06:33:52 +00:00
仅支持 Linux、Windows 和 macOS.
匹配进程路径。
2024-09-15 03:42:57 +00:00
#### process_path_regex
!!! question "自 sing-box 1.10.0 起"
!!! quote ""
仅支持 Linux、Windows 和 macOS.
使用正则表达式匹配进程路径。
#### package_name
匹配 Android 应用包名。
#### user
!!! quote ""
仅支持 Linux.
匹配用户名。
#### user_id
!!! quote ""
仅支持 Linux.
匹配用户 ID。
2022-09-10 14:42:20 +00:00
#### clash_mode
匹配 Clash 模式。
2024-11-11 11:33:40 +00:00
#### network_type
!!! question "自 sing-box 1.11.0 起"
!!! quote ""
仅在 Android 与 Apple 平台图形客户端中支持。
匹配网络类型。
Available values: `wifi`, `cellular`, `ethernet` and `other`.
#### network_is_expensive
!!! question "自 sing-box 1.11.0 起"
!!! quote ""
仅在 Android 与 Apple 平台图形客户端中支持。
匹配如果网络被视为计费 (在 Android) 或被视为昂贵,
像蜂窝网络或个人热点 (在 Apple 平台)。
#### network_is_constrained
!!! question "自 sing-box 1.11.0 起"
!!! quote ""
仅在 Apple 平台图形客户端中支持。
匹配如果网络在低数据模式下。
#### wifi_ssid
!!! quote ""
仅在 Android 与 Apple 平台图形客户端中支持。
匹配 WiFi SSID。
#### wifi_bssid
!!! quote ""
仅在 Android 与 Apple 平台图形客户端中支持。
匹配 WiFi BSSID。
2023-12-01 05:24:18 +00:00
#### rule_set
!!! question "自 sing-box 1.8.0 起"
匹配[规则集](/zh/configuration/route/#rule_set)。
#### rule_set_ipcidr_match_source
!!! question "自 sing-box 1.8.0 起"
2024-06-24 01:41:00 +00:00
!!! failure "已在 sing-box 1.10.0 废弃"
`rule_set_ipcidr_match_source` 已重命名为 `rule_set_ip_cidr_match_source` 且将在 sing-box 1.11.0 移除。
使规则集中的 `ip_cidr` 规则匹配源 IP。
#### rule_set_ip_cidr_match_source
!!! question "自 sing-box 1.10.0 起"
使规则集中的 `ip_cidr` 规则匹配源 IP。
2023-12-01 05:24:18 +00:00
#### invert
反选匹配结果。
2024-11-06 11:02:55 +00:00
#### action
==必填==
2024-11-11 11:33:40 +00:00
参阅 [规则动作](../rule_action/)。
2024-11-06 11:02:55 +00:00
#### outbound
!!! failure "已在 sing-box 1.11.0 废弃"
2024-11-11 11:33:40 +00:00
已移动到 [规则动作](../rule_action#route).
### 逻辑字段
#### type
`logical`
#### mode
2023-06-07 12:28:21 +00:00
==必填==
`and``or`
#### rules
==必填==
2023-12-01 05:24:18 +00:00
包括的规则。