3 let fs = require("fs");
4 let uci = require("uci");
5 let ubus = require("ubus");
7 let STATEFILE = "/var/run/fw4.state";
10 let FLATTEN_LIST = 0x02;
12 let UNSUPPORTED = 0x08;
14 let DEPRECATED = 0x20;
16 let ipv4_icmptypes = {
17 "any": [ 0xFF, 0, 0xFF ],
18 "echo-reply": [ 0, 0, 0xFF ],
19 "pong": [ 0, 0, 0xFF ], /* Alias */
21 "destination-unreachable": [ 3, 0, 0xFF ],
22 "network-unreachable": [ 3, 0, 0 ],
23 "host-unreachable": [ 3, 1, 1 ],
24 "protocol-unreachable": [ 3, 2, 2 ],
25 "port-unreachable": [ 3, 3, 3 ],
26 "fragmentation-needed": [ 3, 4, 4 ],
27 "source-route-failed": [ 3, 5, 5 ],
28 "network-unknown": [ 3, 6, 6 ],
29 "host-unknown": [ 3, 7, 7 ],
30 "network-prohibited": [ 3, 9, 9 ],
31 "host-prohibited": [ 3, 10, 10 ],
32 "TOS-network-unreachable": [ 3, 11, 11 ],
33 "TOS-host-unreachable": [ 3, 12, 12 ],
34 "communication-prohibited": [ 3, 13, 13 ],
35 "host-precedence-violation": [ 3, 14, 14 ],
36 "precedence-cutoff": [ 3, 15, 15 ],
38 "source-quench": [ 4, 0, 0xFF ],
40 "redirect": [ 5, 0, 0xFF ],
41 "network-redirect": [ 5, 0, 0 ],
42 "host-redirect": [ 5, 1, 1 ],
43 "TOS-network-redirect": [ 5, 2, 2 ],
44 "TOS-host-redirect": [ 5, 3, 3 ],
46 "echo-request": [ 8, 0, 0xFF ],
47 "ping": [ 8, 0, 0xFF ], /* Alias */
49 "router-advertisement": [ 9, 0, 0xFF ],
51 "router-solicitation": [ 10, 0, 0xFF ],
53 "time-exceeded": [ 11, 0, 0xFF ],
54 "ttl-exceeded": [ 11, 0, 0xFF ], /* Alias */
55 "ttl-zero-during-transit": [ 11, 0, 0 ],
56 "ttl-zero-during-reassembly": [ 11, 1, 1 ],
58 "parameter-problem": [ 12, 0, 0xFF ],
59 "ip-header-bad": [ 12, 0, 0 ],
60 "required-option-missing": [ 12, 1, 1 ],
62 "timestamp-request": [ 13, 0, 0xFF ],
64 "timestamp-reply": [ 14, 0, 0xFF ],
66 "address-mask-request": [ 17, 0, 0xFF ],
68 "address-mask-reply": [ 18, 0, 0xFF ]
71 let ipv6_icmptypes = {
72 "destination-unreachable": [ 1, 0, 0xFF ],
73 "no-route": [ 1, 0, 0 ],
74 "communication-prohibited": [ 1, 1, 1 ],
75 "address-unreachable": [ 1, 3, 3 ],
76 "port-unreachable": [ 1, 4, 4 ],
78 "packet-too-big": [ 2, 0, 0xFF ],
80 "time-exceeded": [ 3, 0, 0xFF ],
81 "ttl-exceeded": [ 3, 0, 0xFF ], /* Alias */
82 "ttl-zero-during-transit": [ 3, 0, 0 ],
83 "ttl-zero-during-reassembly": [ 3, 1, 1 ],
85 "parameter-problem": [ 4, 0, 0xFF ],
86 "bad-header": [ 4, 0, 0 ],
87 "unknown-header-type": [ 4, 1, 1 ],
88 "unknown-option": [ 4, 2, 2 ],
90 "echo-request": [ 128, 0, 0xFF ],
91 "ping": [ 128, 0, 0xFF ], /* Alias */
93 "echo-reply": [ 129, 0, 0xFF ],
94 "pong": [ 129, 0, 0xFF ], /* Alias */
96 "router-solicitation": [ 133, 0, 0xFF ],
98 "router-advertisement": [ 134, 0, 0xFF ],
100 "neighbour-solicitation": [ 135, 0, 0xFF ],
101 "neighbor-solicitation": [ 135, 0, 0xFF ], /* Alias */
103 "neighbour-advertisement": [ 136, 0, 0xFF ],
104 "neighbor-advertisement": [ 136, 0, 0xFF ], /* Alias */
106 "redirect": [ 137, 0, 0xFF ]
134 function to_mask(bits, v6) {
137 if (bits < 0 || bits > (v6 ? 128 : 32))
140 for (let i = 0; i < (v6 ? 16 : 4); i++) {
141 let b = (bits < 8) ? bits : 8;
142 m[i] = (0xff << (8 - b)) & 0xff;
149 function to_bits(mask) {
150 let a = iptoarr(mask);
157 for (let i = 0, z = false; i < length(a); i++) {
160 while (!z && (a[i] & 0x80)) {
161 a[i] = (a[i] << 1) & 0xff;
172 function apply_mask(addr, mask) {
173 let a = iptoarr(addr);
178 if (type(mask) == "int") {
179 for (let i = 0; i < length(a); i++) {
180 let b = (mask < 8) ? mask : 8;
181 a[i] &= (0xff << (8 - b)) & 0xff;
186 let m = iptoarr(mask);
188 if (!m || length(a) != length(m))
191 for (let i = 0; i < length(a); i++)
198 function to_array(x) {
199 if (type(x) == "array")
205 if (type(x) == "object")
210 return (x == "") ? [] : split(x, /[ \t]+/);
213 function filter_pos(x) {
214 let rv = filter(x, e => !e.invert);
215 return length(rv) ? rv : null;
218 function filter_neg(x) {
219 let rv = filter(x, e => e.invert);
220 return length(rv) ? rv : null;
223 function subnets_split_af(x) {
226 for (let ag in to_array(x)) {
227 for (let a in filter(ag.addrs, a => (a.family == 4))) {
229 push(rv[0], { ...a, invert: ag.invert });
232 for (let a in filter(ag.addrs, a => (a.family == 6))) {
234 push(rv[1], { ...a, invert: ag.invert });
241 function ensure_tcpudp(x) {
242 if (length(filter(x, p => (p.name == "tcp" || p.name == "udp"))))
245 let rest = filter(x, p => !p.any),
246 any = filter(x, p => p.any);
248 if (length(any) && !length(rest)) {
250 push(x, { name: "tcp" }, { name: "udp" });
257 let is_family = (x, v) => (x.family == 0 || x.family == v);
258 let family_is_ipv4 = (x) => (x.family == 0 || x.family == 4);
259 let family_is_ipv6 = (x) => (x.family == 0 || x.family == 6);
261 function infer_family(f, objects) {
265 for (let i = 0; i < length(objects); i += 2) {
266 let objs = to_array(objects[i]),
267 desc = objects[i + 1];
269 for (let obj in objs) {
270 if (!obj || obj.family == 0 || obj.family == res)
280 ? sprintf('references IPv%d only %s but is restricted to IPv%d by %s', obj.family, desc, res, by)
281 : sprintf('is restricted to IPv%d but referenced %s is IPv%d only', res, desc, obj.family);
288 function map_setmatch(set, match, proto) {
289 if (!set || (('inet_service' in set.types) && proto != 'tcp' && proto != 'udp'))
294 for (let i, t in set.types) {
295 let dir = (((match.dir && match.dir[i]) || set.directions[i] || 'src') == 'src' ? 's' : 'd');
299 fields[i] = sprintf('ip %saddr', dir);
303 fields[i] = sprintf('ip6 %saddr', dir);
310 fields[i] = 'ether saddr';
314 fields[i] = sprintf('%s %sport', proto, dir);
324 read_kernel_version: function() {
325 let fd = fs.open("/proc/version", "r"),
329 let m = match(fd.read("line"), /^Linux version ([0-9]+)\.([0-9]+)\.([0-9]+)/);
331 v = m ? (+m[1] << 24) | (+m[2] << 16) | (+m[3] << 8) : 0;
338 read_state: function() {
339 let fd = fs.open(STATEFILE, "r");
344 state = json(fd.read("all"));
347 warn(sprintf("Unable to parse '%s': %s\n", STATEFILE, e));
356 read_ubus: function() {
359 rules = [], networks = {},
360 bus = ubus.connect();
363 ifaces = bus.call("network.interface", "dump");
364 services = bus.call("service", "get_data", { "type": "firewall" });
369 warn(sprintf("Unable to connect to ubus: %s\n", ubus.error()));
374 // Gather logical network information from ubus
377 if (type(ifaces) == "object" && type(ifaces.interface) == "array") {
378 for (let ifc in ifaces.interface) {
381 device: ifc.l3_device
384 if (type(ifc["ipv4-address"]) == "array") {
385 for (let addr in ifc["ipv4-address"]) {
386 net.ipaddrs = net.ipaddrs || [];
390 mask: to_mask(addr.mask, false),
396 if (type(ifc["ipv6-address"]) == "array") {
397 for (let addr in ifc["ipv6-address"]) {
398 net.ipaddrs = net.ipaddrs || [];
402 mask: to_mask(addr.mask, true),
408 if (type(ifc["ipv6-prefix-assignment"]) == "array") {
409 for (let addr in ifc["ipv6-prefix-assignment"]) {
410 if (addr["local-address"]) {
411 net.ipaddrs = net.ipaddrs || [];
414 addr: addr["local-address"].address,
415 mask: to_mask(addr["local-address"].mask, true),
416 bits: addr["local-address"].mask
422 if (type(ifc.data) == "object" && type(ifc.data.firewall) == "array") {
425 for (let rulespec in ifc.data.firewall) {
429 name: (rulespec.type != 'ipset') ? sprintf('ubus:%s[%s] %s %d', ifc.interface, ifc.proto, rulespec.type || 'rule', n) : rulespec.name,
430 device: rulespec.device || ifc.l3_device
437 networks[ifc.interface] = net;
443 // Gather firewall rule definitions from ubus services
446 if (type(services) == "object") {
447 for (let svcname, service in services) {
448 if (type(service) == "object" && type(service.firewall) == "array") {
451 for (let rulespec in services[svcname].firewall) {
455 name: (rulespec.type != 'ipset') ? sprintf('ubus:%s %s %d', svcname, rulespec.type || 'rule', n) : rulespec.name
462 for (let svcinst, instance in service) {
463 if (type(instance) == "object" && type(instance.firewall) == "array") {
466 for (let rulespec in instance.firewall) {
470 name: (rulespec.type != 'ipset') ? sprintf('ubus:%s[%s] %s %d', svcname, svcinst, rulespec.type || 'rule', n) : rulespec.name
486 load: function(use_statefile) {
489 this.state = use_statefile ? this.read_state() : null;
491 this.cursor = uci.cursor();
492 this.cursor.load("firewall");
493 this.cursor.load("/usr/share/firewall4/helpers");
496 this.state = this.read_ubus();
498 this.kernel = this.read_kernel_version();
502 // Read helper mapping
505 this.cursor.foreach("helpers", "helper", h => self.parse_helper(h));
509 // Read default policies
512 this.cursor.foreach("firewall", "defaults", d => self.parse_defaults(d));
514 if (!this.state.defaults)
515 this.parse_defaults({});
519 // Build list of ipsets
522 if (!this.state.ipsets) {
523 map(filter(this.state.ubus_rules, n => (n.type == "ipset")), s => self.parse_ipset(s));
524 this.cursor.foreach("firewall", "ipset", s => self.parse_ipset(s));
529 // Build list of logical zones
532 if (!this.state.zones)
533 this.cursor.foreach("firewall", "zone", z => self.parse_zone(z));
537 // Build list of forwardings
540 this.cursor.foreach("firewall", "forwarding", f => self.parse_forwarding(f));
544 // Build list of rules
547 map(filter(this.state.ubus_rules, r => (r.type == "rule")), r => self.parse_rule(r));
548 this.cursor.foreach("firewall", "rule", r => self.parse_rule(r));
552 // Build list of redirects
555 map(filter(this.state.ubus_rules, r => (r.type == "redirect")), r => self.parse_redirect(r));
556 this.cursor.foreach("firewall", "redirect", r => self.parse_redirect(r));
560 // Build list of snats
563 map(filter(this.state.ubus_rules, n => (n.type == "nat")), n => self.parse_nat(n));
564 this.cursor.foreach("firewall", "nat", n => self.parse_nat(n));
568 let fd = fs.open(STATEFILE, "w");
572 zones: this.state.zones,
573 ipsets: this.state.ipsets,
574 networks: this.state.networks,
575 ubus_rules: this.state.ubus_rules
581 warn("Unable to write '%s': %s\n", STATEFILE, fs.error());
586 warn: function(fmt, ...args) {
590 let msg = sprintf(fmt, ...args);
593 warn("\033[33m", msg, "\033[m\n");
595 warn("[!] ", msg, "\n");
598 get: function(sid, opt) {
599 return this.cursor.get("firewall", sid, opt);
602 get_all: function(sid) {
603 return this.cursor.get_all("firewall", sid);
606 parse_options: function(s, spec) {
609 for (let key, val in spec) {
610 let datatype = "parse_" + val[0],
613 parsefn = (flags & PARSE_LIST) ? "parse_list" : "parse_opt";
615 let res = this[parsefn](s, key, datatype, defval, flags);
620 if (type(res) == "object" && res.invert && (flags & NO_INVERT)) {
621 this.warn_section(s, "option '" + key + '" must not be negated');
626 if (flags & DEPRECATED)
627 this.warn_section(s, "option '" + key + "' is deprecated by fw4");
628 else if (flags & UNSUPPORTED)
629 this.warn_section(s, "option '" + key + "' is not supported by fw4");
636 if (index(opt, '.') != 0 && opt != 'type' && !exists(spec, opt)) {
637 this.warn_section(s, "specifies unknown option '" + opt + "'");
644 parse_subnet: function(subnet) {
645 let parts = split(subnet, "/");
648 switch (length(parts)) {
650 a = iptoarr(parts[0]);
651 m = iptoarr(parts[1]);
657 if (length(a) != length(m))
660 b = to_bits(parts[1]);
670 if (type(b) != "int")
673 m = to_mask(b, length(a) == 16);
677 family: (length(a) == 16) ? 6 : 4,
684 parts = split(parts[0], "-");
686 switch (length(parts)) {
688 a = iptoarr(parts[0]);
689 b = iptoarr(parts[1]);
691 if (a && b && length(a) == length(b)) {
693 family: (length(a) == 16) ? 6 : 4,
703 a = iptoarr(parts[0]);
707 family: (length(a) == 16) ? 6 : 4,
709 mask: to_mask(length(a) * 8, length(a) == 16),
714 n = this.state.networks[parts[0]];
717 return [ ...(n.ipaddrs || []) ];
724 parse_enum: function(val, choices) {
725 if (type(val) == "string") {
728 for (let i = 0; i < length(choices); i++)
729 if (substr(choices[i], 0, length(val)) == val)
736 section_id: function(sid) {
737 let s = this.get_all(sid);
742 if (s[".anonymous"]) {
745 this.cursor.foreach("firewall", s[".type"], function(ss) {
746 if (ss[".name"] == s[".name"])
752 return sprintf("@%s[%d]", s[".type"], c);
758 warn_section: function(s, msg) {
761 this.warn("Section %s (%s) %s", this.section_id(s[".name"]), s.name, msg);
763 this.warn("Section %s %s", this.section_id(s[".name"]), msg);
767 this.warn("ubus %s (%s) %s", s.type || "rule", s.name, msg);
769 this.warn("ubus %s %s", s.type || "rule", msg);
773 parse_policy: function(val) {
774 return this.parse_enum(val, [
781 parse_bool: function(val) {
782 if (val == "1" || val == "on" || val == "true" || val == "yes")
784 else if (val == "0" || val == "off" || val == "false" || val == "no")
790 parse_family: function(val) {
791 if (val == 'any' || val == 'all' || val == '*')
793 else if (val == 'inet' || index(val, '4') > -1)
795 else if (index(val, '6') > -1)
801 parse_zone_ref: function(val) {
806 return { any: true };
808 for (let zone in this.state.zones) {
809 if (zone.name == val) {
820 parse_device: function(val) {
821 let rv = this.parse_invert(val);
834 parse_direction: function(val) {
835 if (val == 'in' || val == 'ingress')
837 else if (val == 'out' || val == 'egress')
843 parse_setmatch: function(val) {
844 let rv = this.parse_invert(val);
849 rv.val = trim(replace(rv.val, /^[^ \t]+/, function(m) {
854 let dir = split(rv.val, /[ \t,]/);
856 for (let i = 0; i < 3 && i < length(dir); i++) {
857 if (dir[i] == "dst" || dir[i] == "dest") {
858 rv.dir = rv.dir || [];
861 else if (dir[i] == "src") {
862 rv.dir = rv.dir || [];
867 return length(rv.name) ? rv : null;
870 parse_cthelper: function(val) {
871 let rv = this.parse_invert(val);
876 let helper = filter(this.state.helpers, h => (h.name == rv.val))[0];
878 return helper ? { ...rv, ...helper } : null;
881 parse_protocol: function(val) {
882 let p = this.parse_invert(val);
904 p.name = 'ipv6-icmp';
909 { invert: p.invert, name: 'tcp' },
910 { invert: p.invert, name: 'udp' }
925 return (p.any || length(p.name)) ? p : null;
928 parse_mac: function(val) {
929 let mac = this.parse_invert(val);
930 let m = mac ? match(mac.val, /^([0-9a-f]{1,2})[:-]([0-9a-f]{1,2})[:-]([0-9a-f]{1,2})[:-]([0-9a-f]{1,2})[:-]([0-9a-f]{1,2})[:-]([0-9a-f]{1,2})$/i) : null;
935 mac.mac = sprintf('%02x:%02x:%02x:%02x:%02x:%02x',
936 hex(m[1]), hex(m[2]), hex(m[3]),
937 hex(m[4]), hex(m[5]), hex(m[6]));
942 parse_port: function(val) {
943 let port = this.parse_invert(val);
944 let m = port ? match(port.val, /^([0-9]{1,5})([-:]([0-9]{1,5}))?$/i) : null;
950 let min_port = +m[1];
951 let max_port = +m[3];
953 if (min_port > max_port ||
954 min_port < 0 || max_port < 0 ||
955 min_port > 65535 || max_port > 65535)
964 if (pn != pn || pn < 0 || pn > 65535)
974 parse_network: function(val) {
975 let rv = this.parse_invert(val);
980 let nets = this.parse_subnet(rv.val);
986 rv.addrs = [ ...nets ];
991 parse_icmptype: function(val) {
994 if (exists(ipv4_icmptypes, val)) {
997 rv.type = ipv4_icmptypes[val][0];
998 rv.code_min = ipv4_icmptypes[val][1];
999 rv.code_max = ipv4_icmptypes[val][2];
1002 if (exists(ipv6_icmptypes, val)) {
1003 rv.family = rv.family ? 0 : 6;
1005 rv.type6 = ipv6_icmptypes[val][0];
1006 rv.code6_min = ipv6_icmptypes[val][1];
1007 rv.code6_max = ipv6_icmptypes[val][2];
1010 if (!exists(rv, "family")) {
1011 let m = match(val, /^([0-9]+)(\/([0-9]+))?$/);
1018 rv.code_min = +m[3];
1019 rv.code_max = rv.code_min;
1027 if (rv.type > 0xFF || rv.code_min > 0xFF || rv.code_max > 0xFF)
1033 rv.code6_min = rv.code_min;
1034 rv.code6_max = rv.code_max;
1040 parse_invert: function(val) {
1044 let rv = { invert: false };
1046 rv.val = trim(replace(val, /^[ \t]*!/, () => (rv.invert = true, '')));
1048 return length(rv.val) ? rv : null;
1051 parse_limit: function(val) {
1052 let rv = this.parse_invert(val);
1053 let m = rv ? match(rv.val, /^([0-9]+)(\/([a-z]+))?$/) : null;
1059 let u = m[3] ? this.parse_enum(m[3], [ "second", "minute", "hour", "day" ]) : "second";
1070 parse_int: function(val) {
1073 return (n == n) ? n : null;
1076 parse_date: function(val) {
1077 let m = match(val, /^([0-9-]+)T([0-9:]+)$/);
1078 let d = m ? match(m[1], /^([0-9]{1,4})(-([0-9]{1,2})(-([0-9]{1,2}))?)?$/) : null;
1079 let t = this.parse_time(m[2]);
1084 if (d == null || d[1] < 1970 || d[1] > 2038 || d[3] < 1 || d[3] > 12 || d[5] < 1 || d[5] > 31)
1094 hour: t ? +t[1] : 0,
1100 parse_time: function(val) {
1101 let t = match(val, /^([0-9]{1,2})(:([0-9]{1,2})(:([0-9]{1,2}))?)?$/);
1103 if (t == null || t[1] > 23 || t[3] > 59 || t[5] > 59)
1113 parse_weekdays: function(val) {
1114 let rv = this.parse_invert(val);
1119 for (let day in to_array(rv.val)) {
1120 day = this.parse_enum(day, [
1133 rv.days = rv.days || {};
1134 rv.days[day] = true;
1137 rv.days = keys(rv.days);
1139 return rv.days ? rv : null;
1142 parse_monthdays: function(val) {
1143 let rv = this.parse_invert(val);
1148 for (let day in to_array(rv.val)) {
1151 if (day < 1 || day > 31)
1154 rv.days = rv.days || [];
1155 rv.days[day] = true;
1158 return rv.days ? rv : null;
1161 parse_mark: function(val) {
1162 let rv = this.parse_invert(val);
1163 let m = rv ? match(rv.val, /^(0?x?[0-9a-f]+)(\/(0?x?[0-9a-f]+))?$/i) : null;
1170 if (n != n || n > 0xFFFFFFFF)
1174 rv.mask = 0xFFFFFFFF;
1179 if (n != n || n > 0xFFFFFFFF)
1188 parse_dscp: function(val) {
1189 let rv = this.parse_invert(val);
1194 rv.val = uc(rv.val);
1196 if (exists(dscp_classes, rv.val)) {
1197 rv.dscp = dscp_classes[rv.val];
1202 if (n != n || n < 0 || n > 0x3F)
1211 parse_target: function(val) {
1212 return this.parse_enum(val, [
1229 parse_reject_code: function(val) {
1230 return this.parse_enum(val, [
1239 parse_reflection_source: function(val) {
1240 return this.parse_enum(val, [
1246 parse_ipsettype: function(val) {
1247 let m = match(val, /^(src|dst|dest)_(.+)$/);
1248 let t = this.parse_enum(m ? m[2] : val, [
1256 return t ? [ (!m || m[1] == 'src') ? 'src' : 'dst', t ] : null;
1259 parse_ipsetentry: function(val, set) {
1260 let values = split(val, /[ \t]+/);
1262 if (length(values) != length(set.types))
1268 for (let i, t in set.types) {
1271 ip = iptoarr(values[i]);
1273 if (length(ip) != 4)
1276 rv[i] = arrtoip(ip);
1280 ip = iptoarr(values[i]);
1282 if (length(ip) != 16)
1285 rv[i] = arrtoip(ip);
1289 mac = this.parse_mac(values[i]);
1291 if (!mac || mac.invert)
1297 case 'inet_service':
1298 port = this.parse_port(values[i]);
1300 if (!port || port.invert || port.min != port.max)
1311 return length(rv) ? rv : null;
1314 parse_string: function(val) {
1318 parse_opt: function(s, opt, fn, defval, flags) {
1322 if (flags & REQUIRED) {
1323 this.warn_section(s, "option '" + opt + "' is mandatory but not set");
1330 if (type(val) == "array") {
1331 this.warn_section(s, "option '" + opt + "' must not be a list");
1334 else if (val == null) {
1338 let res = this[fn](val);
1341 this.warn_section(s, "option '" + opt + "' specifies invalid value '" + val + "'");
1348 parse_list: function(s, opt, fn, defval, flags) {
1353 if (flags & REQUIRED) {
1354 this.warn_section(s, "option '" + opt + "' is mandatory but not set");
1361 for (val in to_array(val)) {
1362 let res = this[fn](val);
1365 this.warn_section(s, "option '" + opt + "' specifies invalid value '" + val + "'");
1369 if (flags & FLATTEN_LIST)
1370 push(rv, ...to_array(res));
1375 return length(rv) ? rv : null;
1378 quote: function(s, force) {
1379 if (force === true || !match(s, /^([0-9A-Fa-f:.\/-]+)( \. [0-9A-Fa-f:.\/-]+)*$/))
1380 return sprintf('"%s"', replace(s + "", /(["\\])/g, '\\$1'));
1387 return sprintf("%s-%s", a.addr, a.addr2);
1389 if ((a.family == 4 && a.bits == 32) ||
1390 (a.family == 6 && a.bits == 128))
1393 return sprintf("%s/%d", apply_mask(a.addr, a.bits), a.bits);
1398 ? sprintf("%s-%s", a.addr, a.addr2)
1399 : apply_mask(a.addr, a.bits);
1404 return sprintf('%d', p.min);
1406 return sprintf('%d-%d', p.min, p.max);
1409 set: function(v, force) {
1412 v = filter(to_array(v), item => !seen[item]++);
1414 if (force || length(v) != 1)
1415 return sprintf('{ %s }', join(', ', map(v, this.quote)));
1417 return this.quote(v[0]);
1420 concat: function(v) {
1421 return join(' . ', to_array(v));
1424 ipproto: function(family) {
1434 nfproto: function(family, human_readable) {
1437 return human_readable ? "IPv4" : "ipv4";
1440 return human_readable ? "IPv6" : "ipv6";
1443 return human_readable ? "IPv4/IPv6" : null;
1447 datetime: function(stamp) {
1448 return sprintf('"%04d-%02d-%02d %02d:%02d:%02d"',
1449 stamp.year, stamp.month, stamp.day,
1450 stamp.hour, stamp.min, stamp.sec);
1453 date: function(stamp) {
1454 return sprintf('"%04d-%02d-%02d"', stamp.year, stamp.month, stamp.day);
1457 time: function(stamp) {
1458 return sprintf('"%02d:%02d:%02d"', stamp.hour, stamp.min, stamp.sec);
1462 return sprintf('0x%x', n);
1465 is_loopback_dev: function(dev) {
1466 let fd = fs.open(sprintf("/sys/class/net/%s/flags", dev), "r");
1471 let flags = +fd.read("line");
1475 return !!(flags & 0x8);
1478 is_loopback_addr: function(addr) {
1479 return (index(addr, "127.") == 0 || addr == "::1" || addr == "::1/128");
1482 filter_loopback_devs: function(devs, invert) {
1484 return filter(devs, d => (self.is_loopback_dev(d) == invert));
1487 filter_loopback_addrs: function(addrs, invert) {
1489 return filter(addrs, a => (self.is_loopback_addr(a) == invert));
1493 input_policy: function(reject_as_drop) {
1494 return (!reject_as_drop || this.state.defaults.input != 'reject') ? this.state.defaults.input : 'drop';
1497 output_policy: function(reject_as_drop) {
1498 return (!reject_as_drop || this.state.defaults.output != 'reject') ? this.state.defaults.output : 'drop';
1501 forward_policy: function(reject_as_drop) {
1502 return (!reject_as_drop || this.state.defaults.forward != 'reject') ? this.state.defaults.forward : 'drop';
1505 default_option: function(flag) {
1506 return this.state.defaults[flag];
1509 helpers: function() {
1510 return this.state.helpers;
1514 return this.state.zones;
1517 rules: function(chain) {
1518 return filter(this.state.rules, r => (r.chain == chain));
1521 redirects: function(chain) {
1522 return filter(this.state.redirects, r => (r.chain == chain));
1525 ipsets: function() {
1526 return this.state.ipsets;
1529 parse_setfile: function(set, cb) {
1530 let fd = fs.open(set.loadfile, "r");
1533 warn(sprintf("Unable to load file '%s' for set '%s': %s\n",
1534 set.loadfile, set.name, fs.error()));
1538 let line = null, count = 0;
1540 while ((line = fd.read("line")) !== "") {
1543 if (length(line) == 0 || ord(line) == 35)
1546 let v = this.parse_ipsetentry(line, set);
1549 this.warn("Skipping invalid entry '%s' in file '%s' for set '%s'",
1550 line, set.loadfile, set.name);
1564 print_setentries: function(set) {
1566 let printer = (entry) => {
1568 print("\t\telements = {\n");
1572 print("\t\t\t", join(" . ", entry), ",\n");
1575 map(set.entries, printer);
1578 this.parse_setfile(set, printer);
1584 parse_helper: function(data) {
1585 let helper = this.parse_options(data, {
1586 name: [ "string", null, REQUIRED ],
1587 description: [ "string" ],
1588 module: [ "string" ],
1589 family: [ "family" ],
1590 proto: [ "protocol", null, PARSE_LIST | FLATTEN_LIST | NO_INVERT ],
1591 port: [ "port", null, NO_INVERT ]
1594 if (helper === false) {
1595 this.warn("Helper definition '%s' skipped due to invalid options", data.name || data['.name']);
1598 else if (helper.proto.any) {
1599 this.warn("Helper definition '%s' must not specify wildcard protocol", data.name || data['.name']);
1602 else if (length(helper.proto) > 1) {
1603 this.warn("Helper definition '%s' must not specify multiple protocols", data.name || data['.name']);
1607 helper.available = ((fs.stat("/sys/module/" + helper.module) || {}).type == "directory");
1609 this.state.helpers = this.state.helpers || [];
1610 push(this.state.helpers, helper);
1613 parse_defaults: function(data) {
1614 if (this.state.defaults) {
1615 this.warn_section(data, ": ignoring duplicate defaults section");
1619 let defs = this.parse_options(data, {
1620 input: [ "policy", "drop" ],
1621 output: [ "policy", "drop" ],
1622 forward: [ "policy", "drop" ],
1624 drop_invalid: [ "bool" ],
1625 tcp_reject_code: [ "reject_code", "tcp-reset" ],
1626 any_reject_code: [ "reject_code", "port-unreachable" ],
1628 syn_flood: [ "bool" ],
1629 synflood_protect: [ "bool" ],
1630 synflood_rate: [ "limit", "25/second" ],
1631 synflood_burst: [ "int", "50" ],
1633 tcp_syncookies: [ "bool", "1" ],
1635 tcp_window_scaling: [ "bool", "1" ],
1637 accept_redirects: [ "bool" ],
1638 accept_source_route: [ "bool" ],
1640 auto_helper: [ "bool", "1" ],
1641 custom_chains: [ "bool", null, UNSUPPORTED ],
1642 disable_ipv6: [ "bool", null, UNSUPPORTED ],
1643 flow_offloading: [ "bool", "0" ],
1644 flow_offloading_hw: [ "bool", "0" ]
1647 if (defs.synflood_protect === null)
1648 defs.synflood_protect = defs.syn_flood;
1650 delete defs.syn_flood;
1652 this.state.defaults = defs;
1655 parse_zone: function(data) {
1656 let zone = this.parse_options(data, {
1657 enabled: [ "bool", "1" ],
1659 name: [ "string", null, REQUIRED ],
1660 family: [ "family" ],
1662 network: [ "device", null, PARSE_LIST ],
1663 device: [ "device", null, PARSE_LIST ],
1664 subnet: [ "network", null, PARSE_LIST ],
1666 input: [ "policy", this.state.defaults ? this.state.defaults.input : "drop" ],
1667 output: [ "policy", this.state.defaults ? this.state.defaults.output : "drop" ],
1668 forward: [ "policy", this.state.defaults ? this.state.defaults.forward : "drop" ],
1671 masq_allow_invalid: [ "bool" ],
1672 masq_src: [ "network", null, PARSE_LIST ],
1673 masq_dest: [ "network", null, PARSE_LIST ],
1675 extra: [ "string", null, UNSUPPORTED ],
1676 extra_src: [ "string", null, UNSUPPORTED ],
1677 extra_dest: [ "string", null, UNSUPPORTED ],
1679 mtu_fix: [ "bool" ],
1680 custom_chains: [ "bool", null, UNSUPPORTED ],
1683 log_limit: [ "limit", null, UNSUPPORTED ],
1685 auto_helper: [ "bool", "1" ],
1686 helper: [ "cthelper", null, PARSE_LIST ],
1688 counter: [ "bool", "1" ]
1691 if (zone === false) {
1692 this.warn_section(data, "skipped due to invalid options");
1695 else if (!zone.enabled) {
1696 this.warn_section(data, "is disabled, ignoring section");
1699 else if (zone.helper && !zone.helper.available) {
1700 this.warn_section(data, "uses unavailable ct helper '" + zone.helper.name + "', ignoring section");
1704 if (zone.mtu_fix && this.kernel < 0x040a0000) {
1705 this.warn_section(data, "option 'mtu_fix' requires kernel 4.10 or later");
1709 if (this.state.defaults && this.state.defaults.auto_helper === false)
1710 zone.auto_helper = false;
1712 let match_devices = [];
1713 let related_subnets = [];
1714 let match_subnets, masq_src_subnets, masq_dest_subnets;
1716 for (let e in to_array(zone.network)) {
1717 if (exists(this.state.networks, e.device)) {
1718 let net = this.state.networks[e.device];
1721 push(match_devices, {
1727 push(related_subnets, ...(net.ipaddrs || []));
1731 push(match_devices, ...to_array(zone.device));
1733 match_subnets = subnets_split_af(zone.subnet);
1734 masq_src_subnets = subnets_split_af(zone.masq_src);
1735 masq_dest_subnets = subnets_split_af(zone.masq_dest);
1737 push(related_subnets, ...(match_subnets[0] || []), ...(match_subnets[1] || []));
1739 let match_rules = [];
1741 let add_rule = (family, devices, subnets, zone) => {
1746 r.devices_pos = map(filter_pos(devices), d => d.device);
1747 r.devices_neg = map(filter_neg(devices), d => d.device);
1749 r.subnets_pos = map(filter_pos(subnets), this.cidr);
1750 r.subnets_neg = map(filter_neg(subnets), this.cidr);
1752 push(match_rules, r);
1755 let family = infer_family(zone.family, [
1756 zone.helper, "ct helper"
1759 // check if there's no AF specific bits, in this case we can do AF agnostic matching
1760 if (!family && length(match_devices) && !length(match_subnets[0]) && !length(match_subnets[1])) {
1761 add_rule(0, match_devices, null, zone);
1764 // we need to emit one or two AF specific rules
1766 if (family_is_ipv4(zone) && (length(match_devices) || length(match_subnets[0])))
1767 add_rule(4, match_devices, match_subnets[0], zone);
1769 if (family_is_ipv6(zone) && (length(match_devices) || length(match_subnets[1])))
1770 add_rule(6, match_devices, match_subnets[1], zone);
1773 zone.match_rules = match_rules;
1775 if (masq_src_subnets[0]) {
1776 zone.masq4_src_pos = map(filter_pos(masq_src_subnets[0]), this.cidr);
1777 zone.masq4_src_neg = map(filter_neg(masq_src_subnets[0]), this.cidr);
1780 if (masq_src_subnets[1]) {
1781 zone.masq6_src_pos = map(filter_pos(masq_src_subnets[1]), this.cidr);
1782 zone.masq6_src_neg = map(filter_neg(masq_src_subnets[1]), this.cidr);
1785 if (masq_dest_subnets[0]) {
1786 zone.masq4_dest_pos = map(filter_pos(masq_dest_subnets[0]), this.cidr);
1787 zone.masq4_dest_neg = map(filter_neg(masq_dest_subnets[0]), this.cidr);
1790 if (masq_dest_subnets[1]) {
1791 zone.masq6_dest_pos = map(filter_pos(masq_dest_subnets[1]), this.cidr);
1792 zone.masq6_dest_neg = map(filter_neg(masq_dest_subnets[1]), this.cidr);
1796 zone.sflags[zone.input] = true;
1799 zone.dflags[zone.output] = true;
1800 zone.dflags[zone.forward] = true;
1802 zone.match_devices = map(filter(match_devices, d => !d.invert), d => d.device);
1803 zone.match_subnets = map(filter(related_subnets, s => !s.invert), this.cidr);
1805 zone.related_subnets = related_subnets;
1807 if (zone.masq || zone.masq6)
1808 zone.dflags.snat = true;
1810 if ((zone.auto_helper && !(zone.masq || zone.masq6)) || length(zone.helper)) {
1811 zone.dflags.helper = true;
1813 for (let helper in (length(zone.helper) ? zone.helper : this.state.helpers)) {
1814 if (!helper.available)
1817 for (let proto in helper.proto) {
1818 this.state.rules = this.state.rules || [];
1819 push(this.state.rules, {
1820 chain: "helper_" + zone.name,
1821 family: helper.family,
1822 name: helper.description || helper.name,
1825 dports_pos: [ this.port(helper.port) ],
1833 this.state.zones = this.state.zones || [];
1834 push(this.state.zones, zone);
1837 parse_forwarding: function(data) {
1838 let fwd = this.parse_options(data, {
1839 enabled: [ "bool", "1" ],
1842 family: [ "family" ],
1844 src: [ "zone_ref", null, REQUIRED ],
1845 dest: [ "zone_ref", null, REQUIRED ]
1848 if (fwd === false) {
1849 this.warn_section(data, "skipped due to invalid options");
1852 else if (!fwd.enabled) {
1853 this.warn_section(data, "is disabled, ignoring section");
1857 let add_rule = (family, fwd) => {
1862 proto: { any: true }
1865 f.name = fwd.name || sprintf("Accept %s to %s forwarding",
1866 fwd.src.any ? "any" : fwd.src.zone.name,
1867 fwd.dest.any ? "any" : fwd.dest.zone.name);
1869 f.chain = fwd.src.any ? "forward" : sprintf("forward_%s", fwd.src.zone.name);
1872 f.target = "accept";
1874 f.jump_chain = sprintf("accept_to_%s", fwd.dest.zone.name);
1876 this.state.rules = this.state.rules || [];
1877 push(this.state.rules, f);
1881 let family = fwd.family;
1883 /* inherit family restrictions from related zones */
1884 if (family === 0 || family === null) {
1885 let f1 = fwd.src.zone ? fwd.src.zone.family : 0;
1886 let f2 = fwd.dest.zone ? fwd.dest.zone.family : 0;
1888 if (f1 != 0 && f2 != 0 && f1 != f2) {
1889 this.warn_section(data,
1890 sprintf("references src %s restricted to %s and dest restricted to %s, ignoring forwarding",
1891 fwd.src.zone.name, this.nfproto(f1, true),
1892 fwd.dest.zone.name, this.nfproto(f2, true)));
1897 this.warn_section(data,
1898 sprintf("inheriting %s restriction from src %s",
1899 this.nfproto(f1, true), fwd.src.zone.name));
1904 this.warn_section(data,
1905 sprintf("inheriting %s restriction from dest %s",
1906 this.nfproto(f2, true), fwd.dest.zone.name));
1912 add_rule(family, fwd);
1915 fwd.dest.zone.dflags.accept = true;
1918 parse_rule: function(data) {
1919 let rule = this.parse_options(data, {
1920 enabled: [ "bool", "1" ],
1922 name: [ "string", this.section_id(data[".name"]) ],
1923 _name: [ "string", null, DEPRECATED ],
1924 family: [ "family" ],
1926 src: [ "zone_ref" ],
1927 dest: [ "zone_ref" ],
1929 device: [ "device" ],
1930 direction: [ "direction" ],
1932 ipset: [ "setmatch" ],
1933 helper: [ "cthelper" ],
1934 set_helper: [ "cthelper", null, NO_INVERT ],
1936 proto: [ "protocol", "tcpudp", PARSE_LIST | FLATTEN_LIST ],
1938 src_ip: [ "network", null, PARSE_LIST ],
1939 src_mac: [ "mac", null, PARSE_LIST ],
1940 src_port: [ "port", null, PARSE_LIST ],
1942 dest_ip: [ "network", null, PARSE_LIST ],
1943 dest_port: [ "port", null, PARSE_LIST ],
1945 icmp_type: [ "icmptype", null, PARSE_LIST ],
1946 extra: [ "string", null, UNSUPPORTED ],
1949 limit_burst: [ "int" ],
1951 utc_time: [ "bool" ],
1952 start_date: [ "date" ],
1953 stop_date: [ "date" ],
1954 start_time: [ "time" ],
1955 stop_time: [ "time" ],
1956 weekdays: [ "weekdays" ],
1957 monthdays: [ "monthdays", null, UNSUPPORTED ],
1960 set_mark: [ "mark", null, NO_INVERT ],
1961 set_xmark: [ "mark", null, NO_INVERT ],
1964 set_dscp: [ "dscp", null, NO_INVERT ],
1966 counter: [ "bool", "1" ],
1968 target: [ "target" ]
1971 if (rule === false) {
1972 this.warn_section(data, "skipped due to invalid options");
1975 else if (!rule.enabled) {
1976 this.warn_section(data, "is disabled, ignoring section");
1980 if (rule.target in ["helper", "notrack"] && (!rule.src || !rule.src.zone)) {
1981 this.warn_section(data, "must specify a source zone for target '" + rule.target + "'");
1984 else if (rule.target in ["dscp", "mark"] && rule.dest) {
1985 this.warn_section(data, "must not specify option 'dest' for target '" + rule.target + "'");
1988 else if (rule.target == "dscp" && !rule.set_dscp) {
1989 this.warn_section(data, "must specify option 'set_dscp' for target 'dscp'");
1992 else if (rule.target == "mark" && !rule.set_mark && !rule.set_xmark) {
1993 this.warn_section(data, "must specify option 'set_mark' or 'set_xmark' for target 'mark'");
1996 else if (rule.target == "helper" && !rule.set_helper) {
1997 this.warn_section(data, "must specify option 'set_helper' for target 'helper'");
2004 ipset = filter(this.state.ipsets, s => (s.name == rule.ipset.name))[0];
2007 this.warn_section(data, "references unknown set '" + rule.ipset.name + "'");
2011 if (('inet_service' in ipset.types) && !ensure_tcpudp(rule.proto)) {
2012 this.warn_section(data, "references named set with port match but no UDP/TCP protocol, ignoring section");
2017 let need_src_action_chain = (rule) => (rule.src && rule.src.zone && rule.src.zone.log && rule.target != "accept");
2019 let add_rule = (family, proto, saddrs, daddrs, sports, dports, icmptypes, icmpcodes, ipset, rule) => {
2025 has_addrs: !!(length(saddrs) || length(daddrs)),
2026 has_ports: !!(length(sports) || length(dports)),
2027 saddrs_pos: map(filter_pos(saddrs), this.cidr),
2028 saddrs_neg: map(filter_neg(saddrs), this.cidr),
2029 daddrs_pos: map(filter_pos(daddrs), this.cidr),
2030 daddrs_neg: map(filter_neg(daddrs), this.cidr),
2031 sports_pos: map(filter_pos(sports), this.port),
2032 sports_neg: map(filter_neg(sports), this.port),
2033 dports_pos: map(filter_pos(dports), this.port),
2034 dports_neg: map(filter_neg(dports), this.port),
2035 smacs_pos: map(filter_pos(rule.src_mac), m => m.mac),
2036 smacs_neg: map(filter_neg(rule.src_mac), m => m.mac),
2037 icmp_types: map(icmptypes, i => (family == 4 ? i.type : i.type6)),
2038 icmp_codes: map(icmpcodes, ic => sprintf('%d . %d', (family == 4) ? ic.type : ic.type6, (family == 4) ? ic.code_min : ic.code6_min))
2041 if (!length(r.icmp_types))
2042 delete r.icmp_types;
2044 if (!length(r.icmp_codes))
2045 delete r.icmp_codes;
2049 invert: r.set_mark.invert,
2050 mark: r.set_mark.mark,
2051 mask: r.set_mark.mark | r.set_mark.mask
2057 let set_types = map_setmatch(ipset, rule.ipset, proto.name);
2059 if (set_types !== set_types) {
2060 this.warn_section(data, "destination MAC address matching not supported");
2062 } else if (set_types) {
2063 r.ipset = { ...r.ipset, fields: set_types };
2066 if (r.target == "notrack") {
2067 r.chain = sprintf("notrack_%s", r.src.zone.name);
2068 r.src.zone.dflags.notrack = true;
2070 else if (r.target == "helper") {
2071 r.chain = sprintf("helper_%s", r.src.zone.name);
2072 r.src.zone.dflags.helper = true;
2074 else if (r.target == "mark" || r.target == "dscp") {
2076 r.chain = "mangle_prerouting";
2077 r.src.zone.dflags[r.target] = true;
2080 r.chain = "mangle_output";
2088 r.chain = sprintf("%s_%s", r.dest ? "forward" : "input", r.src.zone.name);
2090 r.chain = r.dest ? "forward" : "input";
2093 if (r.dest && !r.src) {
2095 r.chain = sprintf("output_%s", r.dest.zone.name);
2100 if (r.dest && !r.dest.any) {
2101 r.jump_chain = sprintf("%s_to_%s", r.target, r.dest.zone.name);
2102 r.dest.zone.dflags[r.target] = true;
2104 else if (need_src_action_chain(r)) {
2105 r.jump_chain = sprintf("%s_from_%s", r.target, r.src.zone.name);
2106 r.src.zone.dflags[r.target] = true;
2108 else if (r.target == "reject")
2109 r.jump_chain = "handle_reject";
2112 this.state.rules = this.state.rules || [];
2113 push(this.state.rules, r);
2116 for (let proto in rule.proto) {
2117 let sip, dip, sports, dports, itypes4, itypes6;
2118 let family = rule.family;
2120 switch (proto.name) {
2122 itypes4 = filter(rule.icmp_type || [], family_is_ipv4);
2123 itypes6 = filter(rule.icmp_type || [], family_is_ipv6);
2128 itypes6 = filter(rule.icmp_type || [], family_is_ipv6);
2133 sports = rule.src_port;
2134 dports = rule.dest_port;
2138 family = infer_family(family, [
2140 rule.src, "source zone",
2141 rule.dest, "destination zone",
2142 rule.helper, "helper match",
2143 rule.set_helper, "helper to set"
2146 if (type(family) == "string") {
2147 this.warn_section(data, family + ", skipping");
2151 sip = subnets_split_af(rule.src_ip);
2152 dip = subnets_split_af(rule.dest_ip);
2154 let has_ipv4_specifics = (length(sip[0]) || length(dip[0]) || length(itypes4));
2155 let has_ipv6_specifics = (length(sip[1]) || length(dip[1]) || length(itypes6));
2157 /* if no family was configured, infer target family from IP addresses */
2158 if (family === null) {
2159 if (has_ipv4_specifics && !has_ipv6_specifics)
2161 else if (has_ipv6_specifics && !has_ipv4_specifics)
2167 /* check if there's no AF specific bits, in this case we can do an AF agnostic rule */
2168 if (!family && rule.target != "dscp" && !has_ipv4_specifics && !has_ipv6_specifics) {
2169 add_rule(0, proto, null, null, sports, dports, null, null, null, rule);
2172 /* we need to emit one or two AF specific rules */
2174 if (family == 0 || family == 4) {
2175 let icmp_types = filter(itypes4, i => (i.code_min == 0 && i.code_max == 0xFF));
2176 let icmp_codes = filter(itypes4, i => (i.code_min != 0 || i.code_max != 0xFF));
2178 if (length(icmp_types) || (!length(icmp_types) && !length(icmp_codes)))
2179 add_rule(4, proto, sip[0], dip[0], sports, dports, icmp_types, null, ipset, rule);
2181 if (length(icmp_codes))
2182 add_rule(4, proto, sip[0], dip[0], sports, dports, null, icmp_codes, ipset, rule);
2185 if (family == 0 || family == 6) {
2186 let icmp_types = filter(itypes6, i => (i.code_min == 0 && i.code_max == 0xFF));
2187 let icmp_codes = filter(itypes6, i => (i.code_min != 0 || i.code_max != 0xFF));
2189 if (length(icmp_types) || (!length(icmp_types) && !length(icmp_codes)))
2190 add_rule(6, proto, sip[1], dip[1], sports, dports, icmp_types, null, ipset, rule);
2192 if (length(icmp_codes))
2193 add_rule(6, proto, sip[1], dip[1], sports, dports, null, icmp_codes, ipset, rule);
2199 parse_redirect: function(data) {
2200 let redir = this.parse_options(data, {
2201 enabled: [ "bool", "1" ],
2203 name: [ "string", this.section_id(data[".name"]) ],
2204 _name: [ "string", null, DEPRECATED ],
2205 family: [ "family", "4" ],
2207 src: [ "zone_ref" ],
2208 dest: [ "zone_ref" ],
2210 ipset: [ "setmatch" ],
2211 helper: [ "cthelper", null, NO_INVERT ],
2213 proto: [ "protocol", "tcpudp", PARSE_LIST | FLATTEN_LIST ],
2215 src_ip: [ "network" ],
2216 src_mac: [ "mac", null, PARSE_LIST ],
2217 src_port: [ "port" ],
2219 src_dip: [ "network" ],
2220 src_dport: [ "port" ],
2222 dest_ip: [ "network" ],
2223 dest_port: [ "port" ],
2225 extra: [ "string", null, UNSUPPORTED ],
2228 limit_burst: [ "int" ],
2230 utc_time: [ "bool" ],
2231 start_date: [ "date" ],
2232 stop_date: [ "date" ],
2233 start_time: [ "time" ],
2234 stop_time: [ "time" ],
2235 weekdays: [ "weekdays" ],
2236 monthdays: [ "monthdays", null, UNSUPPORTED ],
2240 reflection: [ "bool", "1" ],
2241 reflection_src: [ "reflection_source", "internal" ],
2243 reflection_zone: [ "zone_ref", null, PARSE_LIST ],
2245 counter: [ "bool", "1" ],
2247 target: [ "target", "dnat" ]
2250 if (redir === false) {
2251 this.warn_section(data, "skipped due to invalid options");
2254 else if (!redir.enabled) {
2255 this.warn_section(data, "is disabled, ignoring section");
2259 if (!(redir.target in ["dnat", "snat"])) {
2260 this.warn_section(data, "has invalid target specified, defaulting to dnat");
2261 redir.target = "dnat";
2267 ipset = filter(this.state.ipsets, s => (s.name == redir.ipset.name))[0];
2270 this.warn_section(data, "references unknown set '" + redir.ipset.name + "'");
2274 if (('inet_service' in ipset.types) && !ensure_tcpudp(redir.proto)) {
2275 this.warn_section(data, "references named set with port match but no UDP/TCP protocol, ignoring section");
2280 let resolve_dest = (redir) => {
2281 for (let zone in this.state.zones) {
2282 for (let addr in zone.related_subnets) {
2283 if (redir.dest_ip.family != addr.family)
2286 let a = apply_mask(redir.dest_ip.addr, addr.bits);
2287 let b = apply_mask(addr.addr, addr.bits);
2304 if (redir.target == "dnat") {
2306 return this.warn_section(r, "has no source specified");
2307 else if (redir.src.any)
2308 return this.warn_section(r, "must not have source '*' for dnat target");
2309 else if (redir.dest_ip && redir.dest_ip.invert)
2310 return this.warn_section(r, "must not specify a negated 'dest_ip' value");
2312 if (!redir.dest && redir.dest_ip && resolve_dest(redir))
2313 this.warn_section(r, "does not specify a destination, assuming '" + redir.dest.zone.name + "'");
2315 if (!redir.dest_port)
2316 redir.dest_port = redir.src_dport;
2318 if (redir.reflection && redir.dest && redir.dest.zone && redir.src.zone.masq) {
2319 redir.dest.zone.dflags.accept = true;
2320 redir.dest.zone.dflags.dnat = true;
2321 redir.dest.zone.dflags.snat = true;
2325 redir.src.zone.dflags.helper = true;
2327 redir.src.zone.dflags[redir.target] = true;
2331 return this.warn_section(data, "has no destination specified");
2332 else if (redir.dest.any)
2333 return this.warn_section(data, "must not have destination '*' for snat target");
2334 else if (!redir.src_dip)
2335 return this.warn_section(data, "has no 'src_dip' option specified");
2336 else if (redir.src_dip.invert)
2337 return this.warn_section(data, "must not specify a negated 'src_dip' value");
2338 else if (redir.src_mac)
2339 return this.warn_section(data, "must not use 'src_mac' option for snat target");
2340 else if (redir.helper)
2341 return this.warn_section(data, "must not use 'helper' option for snat target");
2343 redir.dest.zone.dflags[redir.target] = true;
2347 let add_rule = (family, proto, saddrs, daddrs, raddrs, sport, dport, rport, ipset, redir) => {
2353 has_addrs: !!(length(saddrs) || length(daddrs)),
2354 has_ports: !!(sport || dport || rport),
2355 saddrs_pos: map(filter_pos(saddrs), this.cidr),
2356 saddrs_neg: map(filter_neg(saddrs), this.cidr),
2357 daddrs_pos: map(filter_pos(daddrs), this.cidr),
2358 daddrs_neg: map(filter_neg(daddrs), this.cidr),
2359 sports_pos: map(filter_pos(to_array(sport)), this.port),
2360 sports_neg: map(filter_neg(to_array(sport)), this.port),
2361 dports_pos: map(filter_pos(to_array(dport)), this.port),
2362 dports_neg: map(filter_neg(to_array(dport)), this.port),
2363 smacs_pos: map(filter_pos(redir.src_mac), m => m.mac),
2364 smacs_neg: map(filter_neg(redir.src_mac), m => m.mac),
2366 raddr: raddrs ? raddrs[0] : null,
2370 let set_types = map_setmatch(ipset, redir.ipset, proto.name);
2372 if (set_types !== set_types) {
2373 this.warn_section(data, "destination MAC address matching not supported");
2375 } else if (set_types) {
2376 r.ipset = { ...r.ipset, fields: set_types };
2381 r.chain = sprintf("dstnat_%s", r.src.zone.name);
2384 r.target = "redirect";
2389 r.chain = sprintf("srcnat_%s", r.dest.zone.name);
2393 this.state.redirects = this.state.redirects || [];
2394 push(this.state.redirects, r);
2397 let to_hostaddr = (a) => {
2398 let bits = (a.family == 4) ? 32 : 128;
2402 addr: apply_mask(a.addr, bits),
2407 for (let proto in redir.proto) {
2408 let sip, dip, rip, iip, eip, refip, sport, dport, rport;
2409 let family = redir.family;
2411 if (proto.name == "ipv6-icmp")
2414 family = infer_family(family, [
2416 redir.src, "source zone",
2417 redir.dest, "destination zone",
2418 redir.helper, "helper match"
2421 if (type(family) == "string") {
2422 this.warn_section(data, family + ", skipping");
2426 switch (redir.target) {
2428 sip = subnets_split_af(redir.src_ip);
2429 dip = subnets_split_af(redir.src_dip);
2430 rip = subnets_split_af(redir.dest_ip);
2432 switch (proto.name) {
2435 sport = redir.src_port;
2436 dport = redir.src_dport;
2437 rport = redir.dest_port;
2441 /* build reflection rules */
2442 if (redir.reflection && (length(rip[0]) || length(rip[1])) &&
2443 redir.src && redir.src.zone && redir.src.zone[family == 4 ? "masq" : "masq6"] &&
2444 redir.dest && redir.dest.zone) {
2447 name: redir.name + " (reflection)",
2449 helper: redir.helper,
2451 // XXX: this likely makes no sense for reflection rules
2452 //src_mac: redir.src_mac,
2455 limit_burst: redir.limit_burst,
2457 start_date: redir.start_date,
2458 stop_date: redir.stop_date,
2459 start_time: redir.start_time,
2460 stop_time: redir.stop_time,
2461 weekdays: redir.weekdays,
2466 let eaddrs = subnets_split_af(length(dip) ? dip : { addrs: redir.src.zone.related_subnets });
2467 let rzones = length(redir.reflection_zone) ? redir.reflection_zone : [ redir.dest ];
2469 for (let rzone in rzones) {
2470 if (!is_family(rzone, family)) {
2471 this.warn_section(data,
2472 sprintf("is restricted to IPv%d but referenced reflection zone is IPv%d only, skipping",
2473 family, rzone.family));
2477 let iaddrs = subnets_split_af({ addrs: rzone.zone.related_subnets });
2478 let refaddrs = (redir.reflection_src == "internal") ? iaddrs : eaddrs;
2481 map(refaddrs[0], to_hostaddr),
2482 map(refaddrs[1], to_hostaddr)
2486 map(eaddrs[0], to_hostaddr),
2487 map(eaddrs[1], to_hostaddr)
2490 for (let i = 0; i <= 1; i++) {
2491 if (length(rip[i])) {
2492 refredir.src = rzone;
2493 refredir.dest = null;
2494 refredir.target = "dnat";
2495 add_rule(i ? 6 : 4, proto, iaddrs[i], eaddrs[i], rip[i], sport, dport, rport, null, refredir);
2497 for (let refaddr in refaddrs[i]) {
2498 refredir.src = null;
2499 refredir.dest = rzone;
2500 refredir.target = "snat";
2501 add_rule(i ? 6 : 4, proto, iaddrs[i], rip[i], [ refaddr ], null, rport, null, null, refredir);
2512 sip = subnets_split_af(redir.src_ip);
2513 dip = subnets_split_af(redir.dest_ip);
2514 rip = subnets_split_af(redir.src_dip);
2516 switch (proto.name) {
2519 sport = redir.src_port;
2520 dport = redir.dest_port;
2521 rport = redir.src_dport;
2528 if (length(rip[0]) > 1 || length(rip[1]) > 1)
2529 this.warn_section(data, "specifies multiple rewrite addresses, using only first one");
2531 /* check if there's no AF specific bits, in this case we can do an AF agnostic rule */
2532 if (!family && !length(sip[0]) && !length(sip[1]) && !length(dip[0]) && !length(dip[1]) && !length(rip[0]) && !length(rip[1])) {
2533 add_rule(0, proto, null, null, null, sport, dport, rport, null, redir);
2536 /* we need to emit one or two AF specific rules */
2538 if (family == 0 || family == 4)
2539 add_rule(4, proto, sip[0], dip[0], rip[0], sport, dport, rport, ipset, redir);
2541 if (family == 0 || family == 6)
2542 add_rule(6, proto, sip[1], dip[1], rip[1], sport, dport, rport, ipset, redir);
2547 parse_nat: function(data) {
2548 let snat = this.parse_options(data, {
2549 enabled: [ "bool", "1" ],
2551 name: [ "string", this.section_id(data[".name"]) ],
2552 family: [ "family", "4" ],
2554 src: [ "zone_ref" ],
2555 device: [ "string" ],
2557 ipset: [ "setmatch", null, UNSUPPORTED ],
2559 proto: [ "protocol", "all", PARSE_LIST | FLATTEN_LIST ],
2561 src_ip: [ "network" ],
2562 src_port: [ "port" ],
2564 snat_ip: [ "network", null, NO_INVERT ],
2565 snat_port: [ "port", null, NO_INVERT ],
2567 dest_ip: [ "network" ],
2568 dest_port: [ "port" ],
2570 extra: [ "string", null, UNSUPPORTED ],
2573 limit_burst: [ "int" ],
2575 connlimit_ports: [ "bool" ],
2577 utc_time: [ "bool" ],
2578 start_date: [ "date" ],
2579 stop_date: [ "date" ],
2580 start_time: [ "time" ],
2581 stop_time: [ "time" ],
2582 weekdays: [ "weekdays" ],
2583 monthdays: [ "monthdays", null, UNSUPPORTED ],
2587 target: [ "target", "masquerade" ]
2590 if (snat === false) {
2591 this.warn_section(data, "skipped due to invalid options");
2594 else if (!snat.enabled) {
2595 this.warn_section(data, "is disabled, ignoring section");
2599 if (!(snat.target in ["accept", "snat", "masquerade"])) {
2600 this.warn_section(data, "has invalid target specified, defaulting to masquerade");
2601 snat.target = "masquerade";
2604 if (snat.target == "snat" && !snat.snat_ip && !snat.snat_port) {
2605 this.warn_section(data, "needs either 'snat_ip' or 'snat_port' for target snat, ignoring section");
2608 else if (snat.target != "snat" && snat.snat_ip) {
2609 this.warn_section(data, "must not use 'snat_ip' for non-snat target, ignoring section");
2612 else if (snat.target != "snat" && snat.snat_port) {
2613 this.warn_section(data, "must not use 'snat_port' for non-snat target, ignoring section");
2617 if ((snat.snat_port || snat.src_port || snat.dest_port) && !ensure_tcpudp(snat.proto)) {
2618 this.warn_section(data, "specifies ports but no UDP/TCP protocol, ignoring section");
2622 if (snat.src && snat.src.zone)
2623 snat.src.zone.dflags.snat = true;
2625 let add_rule = (family, proto, saddrs, daddrs, raddrs, sport, dport, rport, snat) => {
2631 has_addrs: !!(length(saddrs) || length(daddrs) || length(raddrs)),
2632 has_ports: !!(sport || dport),
2633 saddrs_pos: map(filter_pos(saddrs), this.cidr),
2634 saddrs_neg: map(filter_neg(saddrs), this.cidr),
2635 daddrs_pos: map(filter_pos(daddrs), this.cidr),
2636 daddrs_neg: map(filter_neg(daddrs), this.cidr),
2637 sports_pos: map(filter_pos(to_array(sport)), this.port),
2638 sports_neg: map(filter_neg(to_array(sport)), this.port),
2639 dports_pos: map(filter_pos(to_array(dport)), this.port),
2640 dports_neg: map(filter_neg(to_array(dport)), this.port),
2642 raddr: raddrs ? raddrs[0] : null,
2645 chain: (snat.src && snat.src.zone) ? sprintf("srcnat_%s", snat.src.zone.name) : "srcnat"
2648 this.state.redirects = this.state.redirects || [];
2649 push(this.state.redirects, n);
2652 for (let proto in snat.proto) {
2653 let sip, dip, rip, sport, dport, rport;
2654 let family = snat.family;
2656 sip = subnets_split_af(snat.src_ip);
2657 dip = subnets_split_af(snat.dest_ip);
2658 rip = subnets_split_af(snat.snat_ip);
2660 switch (proto.name) {
2663 sport = snat.src_port;
2664 dport = snat.dest_port;
2665 rport = snat.snat_port;
2669 if (length(rip[0]) > 1 || length(rip[1]) > 1)
2670 this.warn_section(data, "specifies multiple rewrite addresses, using only first one");
2672 /* inherit family restrictions from related zones */
2673 if (family === 0 || family === null) {
2674 let f = (rule.src && rule.src.zone) ? rule.src.zone.family : 0;
2677 this.warn_section(r,
2678 sprintf("inheriting %s restriction from src %s",
2679 this.nfproto(f1, true), rule.src.zone.name));
2685 /* if no family was configured, infer target family from IP addresses */
2686 if (family === null) {
2687 if ((length(sip[0]) || length(dip[0]) || length(rip[0])) && !length(sip[1]) && !length(dip[1]) && !length(rip[1]))
2689 else if ((length(sip[1]) || length(dip[1]) || length(rip[1])) && !length(sip[0]) && !length(dip[0]) && !length(rip[0]))
2695 /* check if there's no AF specific bits, in this case we can do an AF agnostic rule */
2696 if (!family && !length(sip[0]) && !length(sip[1]) && !length(dip[0]) && !length(dip[1]) && !length(rip[0]) && !length(rip[1])) {
2697 add_rule(0, proto, null, null, null, sport, dport, rport, snat);
2700 /* we need to emit one or two AF specific rules */
2702 if (family == 0 || family == 4)
2703 add_rule(4, proto, sip[0], dip[0], rip[0], sport, dport, rport, snat);
2705 if (family == 0 || family == 6)
2706 add_rule(6, proto, sip[1], dip[1], rip[1], sport, dport, rport, snat);
2711 parse_ipset: function(data) {
2712 let ipset = this.parse_options(data, {
2713 enabled: [ "bool", "1" ],
2714 reload_set: [ "bool" ],
2715 counters: [ "bool" ],
2716 comment: [ "bool" ],
2718 name: [ "string", null, REQUIRED ],
2719 family: [ "family", "4" ],
2721 storage: [ "string", null, UNSUPPORTED ],
2722 match: [ "ipsettype", null, PARSE_LIST ],
2724 iprange: [ "string", null, UNSUPPORTED ],
2725 portrange: [ "string", null, UNSUPPORTED ],
2727 netmask: [ "int", null, UNSUPPORTED ],
2729 hashsize: [ "int", null, UNSUPPORTED ],
2730 timeout: [ "int", "-1" ],
2732 external: [ "string", null, UNSUPPORTED ],
2734 entry: [ "string", null, PARSE_LIST ],
2735 loadfile: [ "string" ]
2738 if (ipset === false) {
2739 this.warn_section(data, "skipped due to invalid options");
2742 else if (!ipset.enabled) {
2743 this.warn_section(data, "is disabled, ignoring section");
2747 if (ipset.family == 0) {
2748 this.warn_section(data, "must not specify family 'any'");
2751 else if (!length(ipset.match)) {
2752 this.warn_section(data, "has no datatypes assigned");
2756 let dirs = map(ipset.match, m => m[0]),
2757 types = map(ipset.match, m => m[1]),
2760 if ("set" in types) {
2761 this.warn_section(data, "match type 'set' is not supported");
2765 if ("net" in types) {
2766 if (this.kernel < 0x05060000) {
2767 this.warn_section(data, "match type 'net' requires kernel 5.6 or later");
2777 types: map(types, (t) => {
2781 return (ipset.family == 4) ? 'ipv4_addr' : 'ipv6_addr';
2784 return 'ether_addr';
2787 return 'inet_service';
2796 s.entries = filter(map(ipset.entry, (e) => {
2797 let v = self.parse_ipsetentry(e, s);
2800 self.warn_section(data, "ignoring invalid ipset entry '" + e + "'");
2803 }), (e) => (e != null));
2805 this.state.ipsets = this.state.ipsets || [];
2806 push(this.state.ipsets, s);