Files
ShadowsocksX-NG/ShadowsocksX-NG2/Tests/CustomRuleValidatorTests.swift
T
Qiu Yuzhou 9b32400b24 feat(proxy): add custom rule storage, validation, and ACL merge
Persist user custom rules (exact domain, domain suffix, IPv4/IPv6 CIDR)
with stable identity and source metadata. Reject rules that conflict
with the fixed local scope or are shadowed by sslocal domain-proxy /
IP-direct priority, with explainable reasons. Merge valid custom rules
into both rule sub-modes ACL; global and direct modes do not load them.
Rule content changes recompile ACL via full restart with rollback.
Diagnostics expose only count and content-version summary.
2026-09-26 20:27:56 +08:00

255 lines
9.4 KiB
Swift

import Foundation
import XCTest
@testable import ShadowsocksX_NG2
/// 自定义规则校验(issue #66 AC2):固定本地冲突、ACL 优先级遮蔽与重复拒绝,
/// 并返回可解释原因。
final class CustomRuleValidatorTests: XCTestCase {
private let customSource = RuleSourceIdentity(
kind: .custom, upstreamVersion: "user", label: "自定义")
private let gfwSource = RuleSourceIdentity(
kind: .gfwlist, upstreamVersion: "v1", label: "GFWList")
private let chinaSource = RuleSourceIdentity(
kind: .geolocationCN, upstreamVersion: "v1", label: "geolocation-cn")
private func rule(
_ action: RuleAction,
_ match: RuleMatch,
id: UUID = UUID()
) -> CustomRule {
CustomRule(id: id, action: action, match: match)
}
// MARK: 有效规则
func testValidDomainAndCIDRRulesAreAccepted() throws {
let custom = [
rule(.proxy, try RuleMatch(domainSuffix: "blocked.example")),
rule(.direct, try RuleMatch(domainExact: "ok.example.cn")),
rule(.direct, try RuleMatch(ipv4CIDR: "203.0.113.0/24")),
rule(.proxy, try RuleMatch(ipv6CIDR: "2001:db8::/32")),
]
let result = CustomRuleValidator.validate(
custom: custom, defaultAction: .directWhenUnmatched)
XCTAssertTrue(result.rejected.isEmpty)
XCTAssertEqual(result.accepted.count, 4)
XCTAssertEqual(result.accepted.first?.action, .proxy)
XCTAssertEqual(result.accepted.first?.aclLine, "||blocked.example")
}
// MARK: 固定本地冲突
func testProxyRuleOverFixedLocalIPRangeIsRejected() throws {
let custom = [rule(.proxy, try RuleMatch(ipv4CIDR: "10.1.2.3/32"))]
let result = CustomRuleValidator.validate(
custom: custom, defaultAction: .directWhenUnmatched)
XCTAssertEqual(result.accepted.count, 0)
XCTAssertEqual(result.rejected.count, 1)
XCTAssertEqual(result.rejected[0].reason, .conflictsWithFixedLocalScope)
XCTAssertFalse(result.rejected[0].explanation.isEmpty)
}
func testProxyRuleOverlappingFixedLocalIPRangeIsRejected() throws {
// 172.0.0.0/8 与固定本地 172.16.0.0/12 相交。
let custom = [rule(.proxy, try RuleMatch(ipv4CIDR: "172.0.0.0/8"))]
let result = CustomRuleValidator.validate(
custom: custom, defaultAction: .proxyWhenUnmatched)
XCTAssertEqual(result.rejected.map(\.reason), [.conflictsWithFixedLocalScope])
}
func testProxyRuleOverLocalHostnameIsRejected() throws {
let custom = [
rule(.proxy, try RuleMatch(domainExact: "localhost")),
rule(.proxy, try RuleMatch(domainExact: "printer.local")),
rule(.proxy, try RuleMatch(domainExact: "myhost")),
rule(.proxy, try RuleMatch(domainSuffix: "home.local")),
]
let result = CustomRuleValidator.validate(
custom: custom, defaultAction: .directWhenUnmatched)
XCTAssertEqual(result.accepted.count, 0)
XCTAssertEqual(result.rejected.count, 4)
XCTAssertTrue(
result.rejected.allSatisfy { $0.reason == .conflictsWithFixedLocalScope })
}
func testDirectRuleOverFixedLocalIsAllowed() throws {
let custom = [rule(.direct, try RuleMatch(ipv4CIDR: "127.0.0.0/8"))]
let result = CustomRuleValidator.validate(
custom: custom, defaultAction: .proxyWhenUnmatched)
XCTAssertTrue(result.rejected.isEmpty)
XCTAssertEqual(result.accepted.count, 1)
}
func testProxyRuleOutsideFixedLocalIsAllowed() throws {
let custom = [
rule(.proxy, try RuleMatch(ipv4CIDR: "203.0.113.0/24")),
rule(.proxy, try RuleMatch(domainSuffix: "example.com")),
rule(.proxy, try RuleMatch(ipv4CIDR: "172.15.0.0/16")),
]
let result = CustomRuleValidator.validate(
custom: custom, defaultAction: .directWhenUnmatched)
XCTAssertTrue(result.rejected.isEmpty)
XCTAssertEqual(result.accepted.count, 3)
}
// MARK: 遮蔽
func testDomainDirectShadowedByBroaderDomainProxyIsRejectedWhenProxySideWritten() throws {
let builtIn = [
ProxyRule(
action: .proxy, match: try RuleMatch(domainSuffix: "blocked.example"), source: gfwSource)
]
let custom = [rule(.direct, try RuleMatch(domainExact: "sub.blocked.example"))]
let result = CustomRuleValidator.validate(
custom: custom, builtIn: builtIn, defaultAction: .directWhenUnmatched)
XCTAssertEqual(result.accepted.count, 0)
XCTAssertEqual(result.rejected.map(\.reason), [.shadowedByDomainProxy])
XCTAssertTrue(result.rejected[0].explanation.contains("blocked.example"))
}
func testDomainDirectNotShadowedWhenProxySideNotWritten() throws {
// 「未匹配时代理」骨架不写 proxy_list,域名代理表为空,直连规则不会被遮蔽。
let builtIn = [
ProxyRule(
action: .proxy, match: try RuleMatch(domainSuffix: "blocked.example"), source: gfwSource)
]
let custom = [rule(.direct, try RuleMatch(domainExact: "sub.blocked.example"))]
let result = CustomRuleValidator.validate(
custom: custom, builtIn: builtIn, defaultAction: .proxyWhenUnmatched)
XCTAssertTrue(result.rejected.isEmpty)
XCTAssertEqual(result.accepted.count, 1)
}
func testIPProxyShadowedByBroaderIPDirectIsRejectedWhenProxySideWritten() throws {
let builtIn = [
ProxyRule(
action: .direct, match: try RuleMatch(ipv4CIDR: "203.0.113.0/24"), source: chinaSource)
]
let custom = [rule(.proxy, try RuleMatch(ipv4CIDR: "203.0.113.10/32"))]
let result = CustomRuleValidator.validate(
custom: custom, builtIn: builtIn, defaultAction: .directWhenUnmatched)
XCTAssertEqual(result.rejected.map(\.reason), [.shadowedByIPDirect])
}
func testIPProxyNotRejectedWhenProxySideNotWritten() throws {
// 「未匹配时代理」不写 proxy_list;IP 代理规则不参与 bypass 优先判定。
let builtIn = [
ProxyRule(
action: .direct, match: try RuleMatch(ipv4CIDR: "203.0.113.0/24"), source: chinaSource)
]
let custom = [rule(.proxy, try RuleMatch(ipv4CIDR: "203.0.113.10/32"))]
let result = CustomRuleValidator.validate(
custom: custom, builtIn: builtIn, defaultAction: .proxyWhenUnmatched)
XCTAssertTrue(result.rejected.isEmpty)
XCTAssertEqual(result.accepted.count, 1)
}
func testDomainProxyNotShadowedByDomainDirect() throws {
// 域名 proxy_list 优先于 bypass_list:代理规则不会被直连遮蔽。
let builtIn = [
ProxyRule(
action: .direct, match: try RuleMatch(domainSuffix: "example.com"), source: chinaSource)
]
let custom = [rule(.proxy, try RuleMatch(domainExact: "a.example.com"))]
let result = CustomRuleValidator.validate(
custom: custom, builtIn: builtIn, defaultAction: .directWhenUnmatched)
XCTAssertTrue(result.rejected.isEmpty)
}
func testCustomToCustomDomainShadowingIsDetected() throws {
let custom = [
rule(.proxy, try RuleMatch(domainSuffix: "example.com")),
rule(.direct, try RuleMatch(domainExact: "a.example.com")),
]
let result = CustomRuleValidator.validate(
custom: custom, defaultAction: .directWhenUnmatched)
XCTAssertEqual(result.accepted.count, 1, "只保留先通过校验的代理规则")
XCTAssertEqual(result.rejected.map(\.reason), [.shadowedByDomainProxy])
XCTAssertEqual(result.rejected[0].rule.action, .direct)
}
func testCustomToCustomIPShadowingIsDetected() throws {
let custom = [
rule(.direct, try RuleMatch(ipv4CIDR: "198.51.100.0/24")),
rule(.proxy, try RuleMatch(ipv4CIDR: "198.51.100.5/32")),
]
let result = CustomRuleValidator.validate(
custom: custom, defaultAction: .directWhenUnmatched)
XCTAssertEqual(result.rejected.map(\.reason), [.shadowedByIPDirect])
XCTAssertEqual(result.rejected[0].rule.action, .proxy)
}
// MARK: 重复
func testDuplicateContentIsRejected() throws {
let match = try RuleMatch(domainSuffix: "example.com")
let custom = [
rule(.proxy, match),
rule(.proxy, match),
]
let result = CustomRuleValidator.validate(
custom: custom, defaultAction: .directWhenUnmatched)
XCTAssertEqual(result.accepted.count, 1)
XCTAssertEqual(result.rejected.map(\.reason), [.duplicate])
}
// MARK: 覆盖判定
func testDomainCoverageMatrix() throws {
let suffixExample = try RuleMatch(domainSuffix: "example.com")
let exactA = try RuleMatch(domainExact: "a.example.com")
let exactExample = try RuleMatch(domainExact: "example.com")
let suffixA = try RuleMatch(domainSuffix: "a.example.com")
let suffixOther = try RuleMatch(domainSuffix: "other.example")
XCTAssertTrue(RuleCoverage.domainCovers(suffixExample, exactA))
XCTAssertTrue(RuleCoverage.domainCovers(suffixExample, exactExample))
XCTAssertTrue(RuleCoverage.domainCovers(suffixExample, suffixA))
XCTAssertFalse(RuleCoverage.domainCovers(exactA, suffixA), "精确不覆盖后缀")
XCTAssertFalse(RuleCoverage.domainCovers(suffixA, suffixExample), "窄后缀不覆盖宽后缀")
XCTAssertFalse(RuleCoverage.domainCovers(suffixExample, suffixOther))
XCTAssertTrue(RuleCoverage.domainCovers(exactA, exactA))
}
func testIPCoverageMatrix() throws {
let slash8 = try RuleMatch(ipv4CIDR: "10.0.0.0/8")
let slash16 = try RuleMatch(ipv4CIDR: "10.1.0.0/16")
let host = try RuleMatch(ipv4CIDR: "10.1.2.3/32")
let other = try RuleMatch(ipv4CIDR: "11.0.0.0/8")
XCTAssertTrue(RuleCoverage.ipCovers(slash8, slash16))
XCTAssertTrue(RuleCoverage.ipCovers(slash8, host))
XCTAssertFalse(RuleCoverage.ipCovers(slash16, slash8))
XCTAssertFalse(RuleCoverage.ipCovers(slash8, other))
}
}