@push.rocks/smartproxy 29.1.0 → 30.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/changelog.md +30 -0
- package/dist_rust/rustproxy_linux_amd64_musl +0 -0
- package/dist_rust/rustproxy_linux_amd64_musl.tsrust-build.json +5 -5
- package/dist_rust/rustproxy_linux_arm64_musl +0 -0
- package/dist_rust/rustproxy_linux_arm64_musl.tsrust-build.json +5 -5
- package/dist_ts/00_commitinfo_data.js +1 -1
- package/dist_ts/proxies/smart-proxy/smart-proxy.js +10 -2
- package/dist_ts/proxies/smart-proxy/utils/index.d.ts +1 -1
- package/dist_ts/proxies/smart-proxy/utils/index.js +2 -2
- package/dist_ts/proxies/smart-proxy/utils/ip-entry-validation.d.ts +14 -0
- package/dist_ts/proxies/smart-proxy/utils/ip-entry-validation.js +200 -0
- package/dist_ts/proxies/smart-proxy/utils/route-validation-error.d.ts +9 -0
- package/dist_ts/proxies/smart-proxy/utils/route-validation-error.js +19 -1
- package/dist_ts/proxies/smart-proxy/utils/route-validator.d.ts +9 -12
- package/dist_ts/proxies/smart-proxy/utils/route-validator.js +84 -81
- package/package.json +2 -2
- package/readme.md +15 -5
- package/ts/00_commitinfo_data.ts +1 -1
- package/ts/proxies/smart-proxy/smart-proxy.ts +10 -1
- package/ts/proxies/smart-proxy/utils/index.ts +1 -1
- package/ts/proxies/smart-proxy/utils/ip-entry-validation.ts +201 -0
- package/ts/proxies/smart-proxy/utils/route-validation-error.ts +20 -0
- package/ts/proxies/smart-proxy/utils/route-validator.ts +94 -83
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
import * as plugins from '../../../plugins.js';
|
|
2
|
+
/**
|
|
3
|
+
* Validation of configured IP entries, one rule per Rust parser that reads them.
|
|
4
|
+
*
|
|
5
|
+
* Every check accepts exactly what its Rust reader can match and answers why it refuses anything
|
|
6
|
+
* else, so a configuration that validates never carries an entry the engine silently ignores:
|
|
7
|
+
*
|
|
8
|
+
* - Security lists (`security.ipAllowList`, `security.ipBlockList`, `defaults.security`,
|
|
9
|
+
* `securityPolicy.blockedIps`/`blockedCidrs`) are read by `rustproxy-security` `IpPattern::parse`:
|
|
10
|
+
* `*`, an address or an `ipnet` prefix, compared as parsed addresses with the client converted
|
|
11
|
+
* from IPv4-mapped IPv6 to IPv4. Anything else becomes `0.0.0.0` and never matches.
|
|
12
|
+
* - Source matches (`match.clientIp`, `trustedProxyIPs` of a route policy or the settings) are read
|
|
13
|
+
* by `rustproxy-routing` `matchers::ip_matches`: `*`, an `ipnet` prefix, a four-part IPv4 wildcard,
|
|
14
|
+
* or an exact address compared as text against the client's Rust `Display` form, after a leading
|
|
15
|
+
* `::ffff:` is stripped from both sides.
|
|
16
|
+
* - VPN assigned addresses (`security.vpn.allowedAssignedIps`) are compared as text against the
|
|
17
|
+
* address the VPN metadata carries.
|
|
18
|
+
*
|
|
19
|
+
* A check answers `null` for an entry it accepts, else the reason it refuses it.
|
|
20
|
+
*/
|
|
21
|
+
const ipv4MappedPrefixLength = 96;
|
|
22
|
+
/** An address without a zone index, in any textual form `node:net` and Rust both read. */
|
|
23
|
+
const ipFamilyOf = (value) => {
|
|
24
|
+
if (value.includes('%'))
|
|
25
|
+
return 0;
|
|
26
|
+
return plugins.net.isIP(value);
|
|
27
|
+
};
|
|
28
|
+
/** The eight 16-bit segments of an IPv6 address `node:net` already accepted. */
|
|
29
|
+
const ipv6SegmentsOf = (address) => {
|
|
30
|
+
const toSegments = (text) => {
|
|
31
|
+
if (text === '')
|
|
32
|
+
return [];
|
|
33
|
+
const segments = [];
|
|
34
|
+
for (const part of text.split(':')) {
|
|
35
|
+
if (part.includes('.')) {
|
|
36
|
+
const [a, b, c, d] = part.split('.').map(Number);
|
|
37
|
+
segments.push((a << 8) | b, (c << 8) | d);
|
|
38
|
+
}
|
|
39
|
+
else {
|
|
40
|
+
segments.push(parseInt(part, 16));
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
return segments;
|
|
44
|
+
};
|
|
45
|
+
const compressionAt = address.indexOf('::');
|
|
46
|
+
if (compressionAt === -1) {
|
|
47
|
+
return toSegments(address);
|
|
48
|
+
}
|
|
49
|
+
const head = toSegments(address.slice(0, compressionAt));
|
|
50
|
+
const tail = toSegments(address.slice(compressionAt + 2));
|
|
51
|
+
return [...head, ...new Array(8 - head.length - tail.length).fill(0), ...tail];
|
|
52
|
+
};
|
|
53
|
+
/** The IPv4 address an IPv4-mapped IPv6 address (`::ffff:a.b.c.d`) carries, else `null`. */
|
|
54
|
+
const ipv4MappedOf = (segments) => {
|
|
55
|
+
if (segments.slice(0, 5).some((segment) => segment !== 0) || segments[5] !== 0xffff) {
|
|
56
|
+
return null;
|
|
57
|
+
}
|
|
58
|
+
return [segments[6] >> 8, segments[6] & 0xff, segments[7] >> 8, segments[7] & 0xff].join('.');
|
|
59
|
+
};
|
|
60
|
+
/**
|
|
61
|
+
* The address as Rust's `Display` writes it: IPv4 unchanged (`node:net` admits only plain decimal
|
|
62
|
+
* octets), IPv4-mapped IPv6 as `::ffff:a.b.c.d`, any other IPv6 in lowercase hex without leading
|
|
63
|
+
* zeros and with the first longest run of two or more zero segments written as `::`.
|
|
64
|
+
*/
|
|
65
|
+
export const formatIpAddress = (address) => {
|
|
66
|
+
if (ipFamilyOf(address) !== 6) {
|
|
67
|
+
return address;
|
|
68
|
+
}
|
|
69
|
+
const segments = ipv6SegmentsOf(address);
|
|
70
|
+
const mapped = ipv4MappedOf(segments);
|
|
71
|
+
if (mapped !== null) {
|
|
72
|
+
return `::ffff:${mapped}`;
|
|
73
|
+
}
|
|
74
|
+
let longestStart = 0;
|
|
75
|
+
let longestLength = 0;
|
|
76
|
+
let currentStart = 0;
|
|
77
|
+
let currentLength = 0;
|
|
78
|
+
segments.forEach((segment, index) => {
|
|
79
|
+
if (segment === 0) {
|
|
80
|
+
if (currentLength === 0)
|
|
81
|
+
currentStart = index;
|
|
82
|
+
currentLength += 1;
|
|
83
|
+
if (currentLength > longestLength) {
|
|
84
|
+
longestStart = currentStart;
|
|
85
|
+
longestLength = currentLength;
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
else {
|
|
89
|
+
currentLength = 0;
|
|
90
|
+
}
|
|
91
|
+
});
|
|
92
|
+
const hex = (part) => part.map((segment) => segment.toString(16)).join(':');
|
|
93
|
+
if (longestLength > 1) {
|
|
94
|
+
return `${hex(segments.slice(0, longestStart))}::${hex(segments.slice(longestStart + longestLength))}`;
|
|
95
|
+
}
|
|
96
|
+
return hex(segments);
|
|
97
|
+
};
|
|
98
|
+
/**
|
|
99
|
+
* An address, `/` and a prefix length as `ipnet` parses it: up to two digits and at most 32 for
|
|
100
|
+
* IPv4, up to three digits and at most 128 for IPv6. Host bits may be set.
|
|
101
|
+
*/
|
|
102
|
+
const parsePrefix = (value) => {
|
|
103
|
+
const parts = value.split('/');
|
|
104
|
+
if (parts.length !== 2)
|
|
105
|
+
return null;
|
|
106
|
+
const [address, lengthText] = parts;
|
|
107
|
+
const family = ipFamilyOf(address);
|
|
108
|
+
if (family === 4 && /^\d{1,2}$/.test(lengthText) && Number(lengthText) <= 32) {
|
|
109
|
+
return { address, family, length: Number(lengthText) };
|
|
110
|
+
}
|
|
111
|
+
if (family === 6 && /^\d{1,3}$/.test(lengthText) && Number(lengthText) <= 128) {
|
|
112
|
+
return { address, family, length: Number(lengthText) };
|
|
113
|
+
}
|
|
114
|
+
return null;
|
|
115
|
+
};
|
|
116
|
+
/** The IPv4 prefix an IPv4-mapped IPv6 prefix of at least 96 bits covers, else `null`. */
|
|
117
|
+
const ipv4PrefixOfMapped = (prefix) => {
|
|
118
|
+
if (prefix.family !== 6 || prefix.length < ipv4MappedPrefixLength)
|
|
119
|
+
return null;
|
|
120
|
+
const mapped = ipv4MappedOf(ipv6SegmentsOf(prefix.address));
|
|
121
|
+
return mapped === null ? null : `${mapped}/${prefix.length - ipv4MappedPrefixLength}`;
|
|
122
|
+
};
|
|
123
|
+
/** A four-part IPv4 wildcard with plain decimal octets first and only `*` parts after them. */
|
|
124
|
+
const isIpv4TrailingWildcard = (value) => {
|
|
125
|
+
const parts = value.split('.');
|
|
126
|
+
if (parts.length !== 4)
|
|
127
|
+
return false;
|
|
128
|
+
const firstWildcard = parts.indexOf('*');
|
|
129
|
+
if (firstWildcard === -1)
|
|
130
|
+
return false;
|
|
131
|
+
return parts.slice(0, firstWildcard).every((part) => /^(0|[1-9]\d{0,2})$/.test(part) && Number(part) <= 255)
|
|
132
|
+
&& parts.slice(firstWildcard).every((part) => part === '*');
|
|
133
|
+
};
|
|
134
|
+
const zoneIndexReason = 'a zone index (%…) is not supported';
|
|
135
|
+
/** Checks an entry of a security list: `ipAllowList`, `ipBlockList` or a global block list. */
|
|
136
|
+
export const checkSecurityIpEntry = (entry) => {
|
|
137
|
+
if (typeof entry !== 'string')
|
|
138
|
+
return 'must be a string';
|
|
139
|
+
if (entry === '*')
|
|
140
|
+
return null;
|
|
141
|
+
if (entry.includes('%'))
|
|
142
|
+
return zoneIndexReason;
|
|
143
|
+
const family = ipFamilyOf(entry);
|
|
144
|
+
if (family !== 0) {
|
|
145
|
+
const mapped = family === 6 ? ipv4MappedOf(ipv6SegmentsOf(entry)) : null;
|
|
146
|
+
return mapped === null
|
|
147
|
+
? null
|
|
148
|
+
: `an IPv4-mapped address never matches, because clients are compared as IPv4; write ${mapped}`;
|
|
149
|
+
}
|
|
150
|
+
const prefix = parsePrefix(entry);
|
|
151
|
+
if (prefix) {
|
|
152
|
+
const ipv4Prefix = ipv4PrefixOfMapped(prefix);
|
|
153
|
+
return ipv4Prefix === null
|
|
154
|
+
? null
|
|
155
|
+
: `an IPv4-mapped prefix never matches, because clients are compared as IPv4; write ${ipv4Prefix}`;
|
|
156
|
+
}
|
|
157
|
+
return "must be '*', an IPv4 or IPv6 address, or an address prefix such as 192.0.2.0/24";
|
|
158
|
+
};
|
|
159
|
+
/** Checks a source-match entry: `match.clientIp` or a `trustedProxyIPs` entry. */
|
|
160
|
+
export const checkSourceMatchIpEntry = (entry) => {
|
|
161
|
+
if (typeof entry !== 'string')
|
|
162
|
+
return 'must be a string';
|
|
163
|
+
if (entry === '*')
|
|
164
|
+
return null;
|
|
165
|
+
if (entry.includes('%'))
|
|
166
|
+
return zoneIndexReason;
|
|
167
|
+
if (ipFamilyOf(entry) !== 0) {
|
|
168
|
+
const canonical = formatIpAddress(entry);
|
|
169
|
+
return canonical === entry
|
|
170
|
+
? null
|
|
171
|
+
: `an exact address is compared as text with the client address; write ${canonical}`;
|
|
172
|
+
}
|
|
173
|
+
const prefix = parsePrefix(entry);
|
|
174
|
+
if (prefix) {
|
|
175
|
+
const ipv4Prefix = ipv4PrefixOfMapped(prefix);
|
|
176
|
+
return ipv4Prefix === null
|
|
177
|
+
? null
|
|
178
|
+
: `an IPv4-mapped prefix never matches, because clients are compared as IPv4; write ${ipv4Prefix}`;
|
|
179
|
+
}
|
|
180
|
+
if (isIpv4TrailingWildcard(entry))
|
|
181
|
+
return null;
|
|
182
|
+
return "must be '*', an IPv4 or IPv6 address, an address prefix such as 192.0.2.0/24, "
|
|
183
|
+
+ 'or a four-part IPv4 wildcard such as 192.0.2.*';
|
|
184
|
+
};
|
|
185
|
+
/** Checks a `security.vpn.allowedAssignedIps` entry. */
|
|
186
|
+
export const checkAssignedIpEntry = (entry) => {
|
|
187
|
+
if (typeof entry !== 'string')
|
|
188
|
+
return 'must be a string';
|
|
189
|
+
if (entry.includes('%'))
|
|
190
|
+
return zoneIndexReason;
|
|
191
|
+
if (ipFamilyOf(entry) === 0)
|
|
192
|
+
return 'must be one IPv4 or IPv6 address';
|
|
193
|
+
const canonical = formatIpAddress(entry);
|
|
194
|
+
return canonical === entry
|
|
195
|
+
? null
|
|
196
|
+
: `an assigned address is compared as text with the VPN client's address; write ${canonical}`;
|
|
197
|
+
};
|
|
198
|
+
/** Formats one refused entry for a validation message. */
|
|
199
|
+
export const describeRefusedIpEntry = (labelArg, entryArg, reasonArg) => `${labelArg}: ${String(entryArg)} (${reasonArg})`;
|
|
200
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"ip-entry-validation.js","sourceRoot":"","sources":["../../../../ts/proxies/smart-proxy/utils/ip-entry-validation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,qBAAqB,CAAC;AAE/C;;;;;;;;;;;;;;;;;;GAkBG;AAEH,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAElC,0FAA0F;AAC1F,MAAM,UAAU,GAAG,CAAC,KAAa,EAAa,EAAE;IAC9C,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,CAAC,CAAC;IAClC,OAAO,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAc,CAAC;AAC9C,CAAC,CAAC;AAEF,gFAAgF;AAChF,MAAM,cAAc,GAAG,CAAC,OAAe,EAAY,EAAE;IACnD,MAAM,UAAU,GAAG,CAAC,IAAY,EAAY,EAAE;QAC5C,IAAI,IAAI,KAAK,EAAE;YAAE,OAAO,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAa,EAAE,CAAC;QAC9B,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;YACnC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvB,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACjD,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC5C,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;IACF,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,IAAI,aAAa,KAAK,CAAC,CAAC,EAAE,CAAC;QACzB,OAAO,UAAU,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IACD,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC;IACzD,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC,CAAC;IAC1D,OAAO,CAAC,GAAG,IAAI,EAAE,GAAG,IAAI,KAAK,CAAS,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;AACzF,CAAC,CAAC;AAEF,4FAA4F;AAC5F,MAAM,YAAY,GAAG,CAAC,QAAkB,EAAiB,EAAE;IACzD,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC;QACpF,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAChG,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,OAAe,EAAU,EAAE;IACzD,IAAI,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,MAAM,QAAQ,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IACzC,MAAM,MAAM,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;IACtC,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,OAAO,UAAU,MAAM,EAAE,CAAC;IAC5B,CAAC;IACD,IAAI,YAAY,GAAG,CAAC,CAAC;IACrB,IAAI,aAAa,GAAG,CAAC,CAAC;IACtB,IAAI,YAAY,GAAG,CAAC,CAAC;IACrB,IAAI,aAAa,GAAG,CAAC,CAAC;IACtB,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;QAClC,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC;YAClB,IAAI,aAAa,KAAK,CAAC;gBAAE,YAAY,GAAG,KAAK,CAAC;YAC9C,aAAa,IAAI,CAAC,CAAC;YACnB,IAAI,aAAa,GAAG,aAAa,EAAE,CAAC;gBAClC,YAAY,GAAG,YAAY,CAAC;gBAC5B,aAAa,GAAG,aAAa,CAAC;YAChC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,aAAa,GAAG,CAAC,CAAC;QACpB,CAAC;IACH,CAAC,CAAC,CAAC;IACH,MAAM,GAAG,GAAG,CAAC,IAAc,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACtF,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;QACtB,OAAO,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,KAAK,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,GAAG,aAAa,CAAC,CAAC,EAAE,CAAC;IACzG,CAAC;IACD,OAAO,GAAG,CAAC,QAAQ,CAAC,CAAC;AACvB,CAAC,CAAC;AAQF;;;GAGG;AACH,MAAM,WAAW,GAAG,CAAC,KAAa,EAAwB,EAAE;IAC1D,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC/B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACpC,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,KAAK,CAAC;IACpC,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IACnC,IAAI,MAAM,KAAK,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,CAAC;QAC7E,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;IACzD,CAAC;IACD,IAAI,MAAM,KAAK,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,UAAU,CAAC,IAAI,GAAG,EAAE,CAAC;QAC9E,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;IACzD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,0FAA0F;AAC1F,MAAM,kBAAkB,GAAG,CAAC,MAAqB,EAAiB,EAAE;IAClE,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,sBAAsB;QAAE,OAAO,IAAI,CAAC;IAC/E,MAAM,MAAM,GAAG,YAAY,CAAC,cAAc,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5D,OAAO,MAAM,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,sBAAsB,EAAE,CAAC;AACxF,CAAC,CAAC;AAEF,+FAA+F;AAC/F,MAAM,sBAAsB,GAAG,CAAC,KAAa,EAAW,EAAE;IACxD,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC/B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACrC,MAAM,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACzC,IAAI,aAAa,KAAK,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IACvC,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC;WACvG,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC;AAChE,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,oCAAoC,CAAC;AAE7D,+FAA+F;AAC/F,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,KAAc,EAAiB,EAAE;IACpE,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,kBAAkB,CAAC;IACzD,IAAI,KAAK,KAAK,GAAG;QAAE,OAAO,IAAI,CAAC;IAC/B,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,eAAe,CAAC;IAChD,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IACjC,IAAI,MAAM,KAAK,CAAC,EAAE,CAAC;QACjB,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACzE,OAAO,MAAM,KAAK,IAAI;YACpB,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,qFAAqF,MAAM,EAAE,CAAC;IACpG,CAAC;IACD,MAAM,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IAClC,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,UAAU,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC9C,OAAO,UAAU,KAAK,IAAI;YACxB,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,oFAAoF,UAAU,EAAE,CAAC;IACvG,CAAC;IACD,OAAO,iFAAiF,CAAC;AAC3F,CAAC,CAAC;AAEF,kFAAkF;AAClF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,KAAc,EAAiB,EAAE;IACvE,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,kBAAkB,CAAC;IACzD,IAAI,KAAK,KAAK,GAAG;QAAE,OAAO,IAAI,CAAC;IAC/B,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,eAAe,CAAC;IAChD,IAAI,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,MAAM,SAAS,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QACzC,OAAO,SAAS,KAAK,KAAK;YACxB,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,uEAAuE,SAAS,EAAE,CAAC;IACzF,CAAC;IACD,MAAM,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IAClC,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,UAAU,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAC9C,OAAO,UAAU,KAAK,IAAI;YACxB,CAAC,CAAC,IAAI;YACN,CAAC,CAAC,oFAAoF,UAAU,EAAE,CAAC;IACvG,CAAC;IACD,IAAI,sBAAsB,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAC/C,OAAO,gFAAgF;UACnF,gDAAgD,CAAC;AACvD,CAAC,CAAC;AAEF,wDAAwD;AACxD,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,KAAc,EAAiB,EAAE;IACpE,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,kBAAkB,CAAC;IACzD,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,eAAe,CAAC;IAChD,IAAI,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC;QAAE,OAAO,kCAAkC,CAAC;IACvE,MAAM,SAAS,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IACzC,OAAO,SAAS,KAAK,KAAK;QACxB,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,gFAAgF,SAAS,EAAE,CAAC;AAClG,CAAC,CAAC;AAEF,0DAA0D;AAC1D,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,QAAgB,EAAE,QAAiB,EAAE,SAAiB,EAAU,EAAE,CACvG,GAAG,QAAQ,KAAK,MAAM,CAAC,QAAQ,CAAC,KAAK,SAAS,GAAG,CAAC"}
|
|
@@ -22,3 +22,12 @@ export declare class RouteValidationError extends Error {
|
|
|
22
22
|
readonly errors: IRouteValidationErrorEntry[];
|
|
23
23
|
constructor(summaryArg: string, errorsArg: IRouteValidationErrorEntry[]);
|
|
24
24
|
}
|
|
25
|
+
/**
|
|
26
|
+
* Thrown when SmartProxy refuses settings outside its routes because they failed validation.
|
|
27
|
+
*
|
|
28
|
+
* `messages` lists every reason. The message names the first reasons only.
|
|
29
|
+
*/
|
|
30
|
+
export declare class SettingsValidationError extends Error {
|
|
31
|
+
readonly messages: string[];
|
|
32
|
+
constructor(summaryArg: string, messagesArg: string[]);
|
|
33
|
+
}
|
|
@@ -38,4 +38,22 @@ export class RouteValidationError extends Error {
|
|
|
38
38
|
this.errors = errorsArg;
|
|
39
39
|
}
|
|
40
40
|
}
|
|
41
|
-
|
|
41
|
+
/**
|
|
42
|
+
* Thrown when SmartProxy refuses settings outside its routes because they failed validation.
|
|
43
|
+
*
|
|
44
|
+
* `messages` lists every reason. The message names the first reasons only.
|
|
45
|
+
*/
|
|
46
|
+
export class SettingsValidationError extends Error {
|
|
47
|
+
messages;
|
|
48
|
+
constructor(summaryArg, messagesArg) {
|
|
49
|
+
const shownMessages = messagesArg.slice(0, MAX_MESSAGES_PER_ROUTE_IN_MESSAGE).map(truncateText);
|
|
50
|
+
const hiddenMessageCount = messagesArg.length - shownMessages.length;
|
|
51
|
+
if (hiddenMessageCount > 0) {
|
|
52
|
+
shownMessages.push(`and ${hiddenMessageCount} more`);
|
|
53
|
+
}
|
|
54
|
+
super(`${summaryArg}: ${shownMessages.join('; ')}`);
|
|
55
|
+
this.name = 'SettingsValidationError';
|
|
56
|
+
this.messages = messagesArg;
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicm91dGUtdmFsaWRhdGlvbi1lcnJvci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3RzL3Byb3hpZXMvc21hcnQtcHJveHkvdXRpbHMvcm91dGUtdmFsaWRhdGlvbi1lcnJvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFlQSxNQUFNLHFCQUFxQixHQUFHLEVBQUUsQ0FBQztBQUNqQyxNQUFNLGlDQUFpQyxHQUFHLENBQUMsQ0FBQztBQUM1QyxNQUFNLDBCQUEwQixHQUFHLEdBQUcsQ0FBQztBQUV2QyxTQUFTLFlBQVksQ0FBQyxPQUFlO0lBQ25DLE9BQU8sT0FBTyxDQUFDLE1BQU0sR0FBRywwQkFBMEI7UUFDaEQsQ0FBQyxDQUFDLEdBQUcsT0FBTyxDQUFDLEtBQUssQ0FBQyxDQUFDLEVBQUUsMEJBQTBCLENBQUMsR0FBRztRQUNwRCxDQUFDLENBQUMsT0FBTyxDQUFDO0FBQ2QsQ0FBQztBQUVELFNBQVMsV0FBVyxDQUFDLFFBQW9DO0lBQ3ZELE1BQU0sYUFBYSxHQUFHLFFBQVEsQ0FBQyxRQUFRO1NBQ3BDLEtBQUssQ0FBQyxDQUFDLEVBQUUsaUNBQWlDLENBQUM7U0FDM0MsR0FBRyxDQUFDLFlBQVksQ0FBQyxDQUFDO0lBQ3JCLE1BQU0sa0JBQWtCLEdBQUcsUUFBUSxDQUFDLFFBQVEsQ0FBQyxNQUFNLEdBQUcsYUFBYSxDQUFDLE1BQU0sQ0FBQztJQUMzRSxJQUFJLGtCQUFrQixHQUFHLENBQUMsRUFBRSxDQUFDO1FBQzNCLGFBQWEsQ0FBQyxJQUFJLENBQUMsT0FBTyxrQkFBa0IsT0FBTyxDQUFDLENBQUM7SUFDdkQsQ0FBQztJQUNELE9BQU8sVUFBVSxZQUFZLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxNQUFNLGFBQWEsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQztBQUNoRixDQUFDO0FBRUQsU0FBUyxhQUFhLENBQUMsVUFBa0IsRUFBRSxTQUF1QztJQUNoRixNQUFNLFdBQVcsR0FBRyxTQUFTLENBQUMsS0FBSyxDQUFDLENBQUMsRUFBRSxxQkFBcUIsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxXQUFXLENBQUMsQ0FBQztJQUMvRSxNQUFNLGdCQUFnQixHQUFHLFNBQVMsQ0FBQyxNQUFNLEdBQUcsV0FBVyxDQUFDLE1BQU0sQ0FBQztJQUMvRCxJQUFJLGdCQUFnQixHQUFHLENBQUMsRUFBRSxDQUFDO1FBQ3pCLFdBQVcsQ0FBQyxJQUFJLENBQUMsT0FBTyxnQkFBZ0IsZ0JBQWdCLENBQUMsQ0FBQztJQUM1RCxDQUFDO0lBQ0QsT0FBTyxHQUFHLFVBQVUsS0FBSyxTQUFTLENBQUMsTUFBTSwwQkFBMEIsV0FBVyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDO0FBQy9GLENBQUM7QUFFRDs7Ozs7R0FLRztBQUNILE1BQU0sT0FBTyxvQkFBcUIsU0FBUSxLQUFLO0lBQzdCLE1BQU0sQ0FBK0I7SUFFckQsWUFBWSxVQUFrQixFQUFFLFNBQXVDO1FBQ3JFLEtBQUssQ0FBQyxhQUFhLENBQUMsVUFBVSxFQUFFLFNBQVMsQ0FBQyxDQUFDLENBQUM7UUFDNUMsSUFBSSxDQUFDLElBQUksR0FBRyxzQkFBc0IsQ0FBQztRQUNuQyxJQUFJLENBQUMsTUFBTSxHQUFHLFNBQVMsQ0FBQztJQUMxQixDQUFDO0NBQ0Y7QUFFRDs7OztHQUlHO0FBQ0gsTUFBTSxPQUFPLHVCQUF3QixTQUFRLEtBQUs7SUFDaEMsUUFBUSxDQUFXO0lBRW5DLFlBQVksVUFBa0IsRUFBRSxXQUFxQjtRQUNuRCxNQUFNLGFBQWEsR0FBRyxXQUFXLENBQUMsS0FBSyxDQUFDLENBQUMsRUFBRSxpQ0FBaUMsQ0FBQyxDQUFDLEdBQUcsQ0FBQyxZQUFZLENBQUMsQ0FBQztRQUNoRyxNQUFNLGtCQUFrQixHQUFHLFdBQVcsQ0FBQyxNQUFNLEdBQUcsYUFBYSxDQUFDLE1BQU0sQ0FBQztRQUNyRSxJQUFJLGtCQUFrQixHQUFHLENBQUMsRUFBRSxDQUFDO1lBQzNCLGFBQWEsQ0FBQyxJQUFJLENBQUMsT0FBTyxrQkFBa0IsT0FBTyxDQUFDLENBQUM7UUFDdkQsQ0FBQztRQUNELEtBQUssQ0FBQyxHQUFHLFVBQVUsS0FBSyxhQUFhLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQztRQUNwRCxJQUFJLENBQUMsSUFBSSxHQUFHLHlCQUF5QixDQUFDO1FBQ3RDLElBQUksQ0FBQyxRQUFRLEdBQUcsV0FBVyxDQUFDO0lBQzlCLENBQUM7Q0FDRiJ9
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import type { IRouteConfig, IRouteMatch, IRouteAction } from '../models/route-types.js';
|
|
2
|
+
import type { ISmartProxyOptions, ISmartProxySecurityPolicy } from '../models/interfaces.js';
|
|
2
3
|
import { type IRouteValidationErrorEntry } from './route-validation-error.js';
|
|
3
4
|
/**
|
|
4
5
|
* Validates route configurations for correctness and safety
|
|
@@ -22,6 +23,14 @@ export declare class RouteValidator {
|
|
|
22
23
|
* A name or id that several routes share gets `[<index>]` appended, so every label is unique.
|
|
23
24
|
*/
|
|
24
25
|
static getRouteLabels(routes: IRouteConfig[]): string[];
|
|
26
|
+
/**
|
|
27
|
+
* Validate the IP entries of the settings outside routes: the global `trustedProxyIPs`, the
|
|
28
|
+
* `defaults.security` lists the engine copies into routes without security, and the global
|
|
29
|
+
* `securityPolicy`. Answers every reason, empty when the settings are valid.
|
|
30
|
+
*/
|
|
31
|
+
static validateSettings(settings: Pick<ISmartProxyOptions, 'trustedProxyIPs' | 'defaults' | 'securityPolicy'>): string[];
|
|
32
|
+
/** Validate the IP entries of a global ingress security policy. */
|
|
33
|
+
static validateSecurityPolicy(policy: ISmartProxySecurityPolicy): string[];
|
|
25
34
|
/**
|
|
26
35
|
* Validate multiple route configurations.
|
|
27
36
|
*
|
|
@@ -54,18 +63,6 @@ export declare class RouteValidator {
|
|
|
54
63
|
* Validate path pattern
|
|
55
64
|
*/
|
|
56
65
|
private static isValidPath;
|
|
57
|
-
/**
|
|
58
|
-
* Validate IP pattern
|
|
59
|
-
*/
|
|
60
|
-
private static isValidIPPattern;
|
|
61
|
-
/**
|
|
62
|
-
* Validate IPv4 address
|
|
63
|
-
*/
|
|
64
|
-
private static isValidIPv4;
|
|
65
|
-
/**
|
|
66
|
-
* Validate IPv6 address
|
|
67
|
-
*/
|
|
68
|
-
private static isValidIPv6;
|
|
69
66
|
/**
|
|
70
67
|
* Log validation errors
|
|
71
68
|
*/
|