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 null_if_empty(x) {
224 return length(x) ? x : null;
227 function subnets_split_af(x) {
230 for (let ag in to_array(x)) {
231 for (let a in filter(ag.addrs, a => (a.family == 4))) {
233 push(rv[0], { ...a, invert: ag.invert });
236 for (let a in filter(ag.addrs, a => (a.family == 6))) {
238 push(rv[1], { ...a, invert: ag.invert });
245 function ensure_tcpudp(x) {
246 if (length(filter(x, p => (p.name == "tcp" || p.name == "udp"))))
249 let rest = filter(x, p => !p.any),
250 any = filter(x, p => p.any);
252 if (length(any) && !length(rest)) {
254 push(x, { name: "tcp" }, { name: "udp" });
261 let is_family = (x, v) => (!x.family || x.family == v);
262 let family_is_ipv4 = (x) => (!x.family || x.family == 4);
263 let family_is_ipv6 = (x) => (!x.family || x.family == 6);
265 function infer_family(f, objects) {
269 for (let i = 0; i < length(objects); i += 2) {
270 let objs = to_array(objects[i]),
271 desc = objects[i + 1];
273 for (let obj in objs) {
274 if (!obj || !obj.family || obj.family == res)
284 ? sprintf('references IPv%d only %s but is restricted to IPv%d by %s', obj.family, desc, res, by)
285 : sprintf('is restricted to IPv%d but referenced %s is IPv%d only', res, desc, obj.family);
292 function map_setmatch(set, match, proto) {
293 if (!set || (('inet_service' in set.types) && proto != 'tcp' && proto != 'udp'))
298 for (let i, t in set.types) {
299 let dir = (((match.dir && match.dir[i]) || set.directions[i] || 'src') == 'src' ? 's' : 'd');
303 fields[i] = sprintf('ip %saddr', dir);
307 fields[i] = sprintf('ip6 %saddr', dir);
314 fields[i] = 'ether saddr';
318 fields[i] = sprintf('%s %sport', proto, dir);
328 read_kernel_version: function() {
329 let fd = fs.open("/proc/version", "r"),
333 let m = match(fd.read("line"), /^Linux version ([0-9]+)\.([0-9]+)\.([0-9]+)/);
335 v = m ? (+m[1] << 24) | (+m[2] << 16) | (+m[3] << 8) : 0;
342 read_state: function() {
343 let fd = fs.open(STATEFILE, "r");
348 state = json(fd.read("all"));
351 warn(sprintf("Unable to parse '%s': %s\n", STATEFILE, e));
360 read_ubus: function() {
363 rules = [], networks = {},
364 bus = ubus.connect();
367 ifaces = bus.call("network.interface", "dump");
368 services = bus.call("service", "get_data", { "type": "firewall" });
373 warn(sprintf("Unable to connect to ubus: %s\n", ubus.error()));
378 // Gather logical network information from ubus
381 if (type(ifaces) == "object" && type(ifaces.interface) == "array") {
382 for (let ifc in ifaces.interface) {
385 device: ifc.l3_device,
389 if (type(ifc["ipv4-address"]) == "array") {
390 for (let addr in ifc["ipv4-address"]) {
391 net.ipaddrs = net.ipaddrs || [];
395 mask: to_mask(addr.mask, false),
401 if (type(ifc["ipv6-address"]) == "array") {
402 for (let addr in ifc["ipv6-address"]) {
403 net.ipaddrs = net.ipaddrs || [];
407 mask: to_mask(addr.mask, true),
413 if (type(ifc["ipv6-prefix-assignment"]) == "array") {
414 for (let addr in ifc["ipv6-prefix-assignment"]) {
415 if (addr["local-address"]) {
416 net.ipaddrs = net.ipaddrs || [];
419 addr: addr["local-address"].address,
420 mask: to_mask(addr["local-address"].mask, true),
421 bits: addr["local-address"].mask
427 if (type(ifc.data) == "object" && type(ifc.data.firewall) == "array") {
430 for (let rulespec in ifc.data.firewall) {
434 name: (rulespec.type != 'ipset') ? sprintf('ubus:%s[%s] %s %d', ifc.interface, ifc.proto, rulespec.type || 'rule', n) : rulespec.name,
435 device: rulespec.device || ifc.l3_device
442 networks[ifc.interface] = net;
448 // Gather firewall rule definitions from ubus services
451 if (type(services) == "object") {
452 for (let svcname, service in services) {
453 if (type(service) == "object" && type(service.firewall) == "array") {
456 for (let rulespec in services[svcname].firewall) {
460 name: (rulespec.type != 'ipset') ? sprintf('ubus:%s %s %d', svcname, rulespec.type || 'rule', n) : rulespec.name
467 for (let svcinst, instance in service) {
468 if (type(instance) == "object" && type(instance.firewall) == "array") {
471 for (let rulespec in instance.firewall) {
475 name: (rulespec.type != 'ipset') ? sprintf('ubus:%s[%s] %s %d', svcname, svcinst, rulespec.type || 'rule', n) : rulespec.name
491 load: function(use_statefile) {
494 this.state = use_statefile ? this.read_state() : null;
496 this.cursor = uci.cursor();
497 this.cursor.load("firewall");
498 this.cursor.load("/usr/share/firewall4/helpers");
501 this.state = this.read_ubus();
503 this.kernel = this.read_kernel_version();
507 // Read helper mapping
510 this.cursor.foreach("helpers", "helper", h => self.parse_helper(h));
514 // Read default policies
517 this.cursor.foreach("firewall", "defaults", d => self.parse_defaults(d));
519 if (!this.state.defaults)
520 this.parse_defaults({});
524 // Build list of ipsets
527 if (!this.state.ipsets) {
528 map(filter(this.state.ubus_rules, n => (n.type == "ipset")), s => self.parse_ipset(s));
529 this.cursor.foreach("firewall", "ipset", s => self.parse_ipset(s));
534 // Build list of logical zones
537 if (!this.state.zones)
538 this.cursor.foreach("firewall", "zone", z => self.parse_zone(z));
542 // Build list of forwardings
545 this.cursor.foreach("firewall", "forwarding", f => self.parse_forwarding(f));
549 // Build list of rules
552 map(filter(this.state.ubus_rules, r => (r.type == "rule")), r => self.parse_rule(r));
553 this.cursor.foreach("firewall", "rule", r => self.parse_rule(r));
557 // Build list of redirects
560 map(filter(this.state.ubus_rules, r => (r.type == "redirect")), r => self.parse_redirect(r));
561 this.cursor.foreach("firewall", "redirect", r => self.parse_redirect(r));
565 // Build list of snats
568 map(filter(this.state.ubus_rules, n => (n.type == "nat")), n => self.parse_nat(n));
569 this.cursor.foreach("firewall", "nat", n => self.parse_nat(n));
573 let fd = fs.open(STATEFILE, "w");
577 zones: this.state.zones,
578 ipsets: this.state.ipsets,
579 networks: this.state.networks,
580 ubus_rules: this.state.ubus_rules
586 warn("Unable to write '%s': %s\n", STATEFILE, fs.error());
591 warn: function(fmt, ...args) {
595 let msg = sprintf(fmt, ...args);
598 warn("\033[33m", msg, "\033[m\n");
600 warn("[!] ", msg, "\n");
603 get: function(sid, opt) {
604 return this.cursor.get("firewall", sid, opt);
607 get_all: function(sid) {
608 return this.cursor.get_all("firewall", sid);
611 parse_options: function(s, spec) {
614 for (let key, val in spec) {
615 let datatype = "parse_" + val[0],
618 parsefn = (flags & PARSE_LIST) ? "parse_list" : "parse_opt";
620 let res = this[parsefn](s, key, datatype, defval, flags);
625 if (type(res) == "object" && res.invert && (flags & NO_INVERT)) {
626 this.warn_section(s, "option '" + key + '" must not be negated');
631 if (flags & DEPRECATED)
632 this.warn_section(s, "option '" + key + "' is deprecated by fw4");
633 else if (flags & UNSUPPORTED)
634 this.warn_section(s, "option '" + key + "' is not supported by fw4");
641 if (index(opt, '.') != 0 && opt != 'type' && !exists(spec, opt)) {
642 this.warn_section(s, "specifies unknown option '" + opt + "'");
649 parse_subnet: function(subnet) {
650 let parts = split(subnet, "/");
653 switch (length(parts)) {
655 a = iptoarr(parts[0]);
656 m = iptoarr(parts[1]);
662 if (length(a) != length(m))
665 b = to_bits(parts[1]);
675 if (type(b) != "int")
678 m = to_mask(b, length(a) == 16);
682 family: (length(a) == 16) ? 6 : 4,
689 parts = split(parts[0], "-");
691 switch (length(parts)) {
693 a = iptoarr(parts[0]);
694 b = iptoarr(parts[1]);
696 if (a && b && length(a) == length(b)) {
698 family: (length(a) == 16) ? 6 : 4,
708 a = iptoarr(parts[0]);
712 family: (length(a) == 16) ? 6 : 4,
714 mask: to_mask(length(a) * 8, length(a) == 16),
719 n = this.state.networks[parts[0]];
722 return [ ...(n.ipaddrs || []) ];
729 parse_enum: function(val, choices) {
730 if (type(val) == "string") {
733 for (let i = 0; i < length(choices); i++)
734 if (substr(choices[i], 0, length(val)) == val)
741 section_id: function(sid) {
742 let s = this.get_all(sid);
747 if (s[".anonymous"]) {
750 this.cursor.foreach("firewall", s[".type"], function(ss) {
751 if (ss[".name"] == s[".name"])
757 return sprintf("@%s[%d]", s[".type"], c);
763 warn_section: function(s, msg) {
766 this.warn("Section %s (%s) %s", this.section_id(s[".name"]), s.name, msg);
768 this.warn("Section %s %s", this.section_id(s[".name"]), msg);
772 this.warn("ubus %s (%s) %s", s.type || "rule", s.name, msg);
774 this.warn("ubus %s %s", s.type || "rule", msg);
778 parse_policy: function(val) {
779 return this.parse_enum(val, [
786 parse_bool: function(val) {
787 if (val == "1" || val == "on" || val == "true" || val == "yes")
789 else if (val == "0" || val == "off" || val == "false" || val == "no")
795 parse_family: function(val) {
796 if (val == 'any' || val == 'all' || val == '*')
798 else if (val == 'inet' || index(val, '4') > -1)
800 else if (index(val, '6') > -1)
806 parse_zone_ref: function(val) {
811 return { any: true };
813 for (let zone in this.state.zones) {
814 if (zone.name == val) {
825 parse_device: function(val) {
826 let rv = this.parse_invert(val);
839 parse_direction: function(val) {
840 if (val == 'in' || val == 'ingress')
842 else if (val == 'out' || val == 'egress')
848 parse_setmatch: function(val) {
849 let rv = this.parse_invert(val);
854 rv.val = trim(replace(rv.val, /^[^ \t]+/, function(m) {
859 let dir = split(rv.val, /[ \t,]/);
861 for (let i = 0; i < 3 && i < length(dir); i++) {
862 if (dir[i] == "dst" || dir[i] == "dest") {
863 rv.dir = rv.dir || [];
866 else if (dir[i] == "src") {
867 rv.dir = rv.dir || [];
872 return length(rv.name) ? rv : null;
875 parse_cthelper: function(val) {
876 let rv = this.parse_invert(val);
881 let helper = filter(this.state.helpers, h => (h.name == rv.val))[0];
883 return helper ? { ...rv, ...helper } : null;
886 parse_protocol: function(val) {
887 let p = this.parse_invert(val);
909 p.name = 'ipv6-icmp';
914 { invert: p.invert, name: 'tcp' },
915 { invert: p.invert, name: 'udp' }
930 return (p.any || length(p.name)) ? p : null;
933 parse_mac: function(val) {
934 let mac = this.parse_invert(val);
935 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;
940 mac.mac = sprintf('%02x:%02x:%02x:%02x:%02x:%02x',
941 hex(m[1]), hex(m[2]), hex(m[3]),
942 hex(m[4]), hex(m[5]), hex(m[6]));
947 parse_port: function(val) {
948 let port = this.parse_invert(val);
949 let m = port ? match(port.val, /^([0-9]{1,5})([-:]([0-9]{1,5}))?$/i) : null;
955 let min_port = +m[1];
956 let max_port = +m[3];
958 if (min_port > max_port ||
959 min_port < 0 || max_port < 0 ||
960 min_port > 65535 || max_port > 65535)
969 if (pn != pn || pn < 0 || pn > 65535)
979 parse_network: function(val) {
980 let rv = this.parse_invert(val);
985 let nets = this.parse_subnet(rv.val);
991 rv.addrs = [ ...nets ];
996 parse_icmptype: function(val) {
999 if (exists(ipv4_icmptypes, val)) {
1002 rv.type = ipv4_icmptypes[val][0];
1003 rv.code_min = ipv4_icmptypes[val][1];
1004 rv.code_max = ipv4_icmptypes[val][2];
1007 if (exists(ipv6_icmptypes, val)) {
1008 rv.family = rv.family ? 0 : 6;
1010 rv.type6 = ipv6_icmptypes[val][0];
1011 rv.code6_min = ipv6_icmptypes[val][1];
1012 rv.code6_max = ipv6_icmptypes[val][2];
1015 if (!exists(rv, "family")) {
1016 let m = match(val, /^([0-9]+)(\/([0-9]+))?$/);
1023 rv.code_min = +m[3];
1024 rv.code_max = rv.code_min;
1032 if (rv.type > 0xFF || rv.code_min > 0xFF || rv.code_max > 0xFF)
1038 rv.code6_min = rv.code_min;
1039 rv.code6_max = rv.code_max;
1045 parse_invert: function(val) {
1049 let rv = { invert: false };
1051 rv.val = trim(replace(val, /^[ \t]*!/, () => (rv.invert = true, '')));
1053 return length(rv.val) ? rv : null;
1056 parse_limit: function(val) {
1057 let rv = this.parse_invert(val);
1058 let m = rv ? match(rv.val, /^([0-9]+)(\/([a-z]+))?$/) : null;
1064 let u = m[3] ? this.parse_enum(m[3], [ "second", "minute", "hour", "day" ]) : "second";
1075 parse_int: function(val) {
1078 return (n == n) ? n : null;
1081 parse_date: function(val) {
1082 let m = match(val, /^([0-9-]+)T([0-9:]+)$/);
1083 let d = m ? match(m[1], /^([0-9]{1,4})(-([0-9]{1,2})(-([0-9]{1,2}))?)?$/) : null;
1084 let t = this.parse_time(m[2]);
1089 if (d == null || d[1] < 1970 || d[1] > 2038 || d[3] < 1 || d[3] > 12 || d[5] < 1 || d[5] > 31)
1099 hour: t ? +t[1] : 0,
1105 parse_time: function(val) {
1106 let t = match(val, /^([0-9]{1,2})(:([0-9]{1,2})(:([0-9]{1,2}))?)?$/);
1108 if (t == null || t[1] > 23 || t[3] > 59 || t[5] > 59)
1118 parse_weekdays: function(val) {
1119 let rv = this.parse_invert(val);
1124 for (let day in to_array(rv.val)) {
1125 day = this.parse_enum(day, [
1138 rv.days = rv.days || {};
1139 rv.days[day] = true;
1142 rv.days = keys(rv.days);
1144 return rv.days ? rv : null;
1147 parse_monthdays: function(val) {
1148 let rv = this.parse_invert(val);
1153 for (let day in to_array(rv.val)) {
1156 if (day < 1 || day > 31)
1159 rv.days = rv.days || [];
1160 rv.days[day] = true;
1163 return rv.days ? rv : null;
1166 parse_mark: function(val) {
1167 let rv = this.parse_invert(val);
1168 let m = rv ? match(rv.val, /^(0?x?[0-9a-f]+)(\/(0?x?[0-9a-f]+))?$/i) : null;
1175 if (n != n || n > 0xFFFFFFFF)
1179 rv.mask = 0xFFFFFFFF;
1184 if (n != n || n > 0xFFFFFFFF)
1193 parse_dscp: function(val) {
1194 let rv = this.parse_invert(val);
1199 rv.val = uc(rv.val);
1201 if (exists(dscp_classes, rv.val)) {
1202 rv.dscp = dscp_classes[rv.val];
1207 if (n != n || n < 0 || n > 0x3F)
1216 parse_target: function(val) {
1217 return this.parse_enum(val, [
1234 parse_reject_code: function(val) {
1235 return this.parse_enum(val, [
1244 parse_reflection_source: function(val) {
1245 return this.parse_enum(val, [
1251 parse_ipsettype: function(val) {
1252 let m = match(val, /^(src|dst|dest)_(.+)$/);
1253 let t = this.parse_enum(m ? m[2] : val, [
1261 return t ? [ (!m || m[1] == 'src') ? 'src' : 'dst', t ] : null;
1264 parse_ipsetentry: function(val, set) {
1265 let values = split(val, /[ \t]+/);
1267 if (length(values) != length(set.types))
1273 for (let i, t in set.types) {
1276 ip = filter(this.parse_subnet(values[i]), a => (a.family == 4));
1278 switch (length(ip)) {
1279 case 0: return null;
1281 default: this.warn("Set entry '%s' resolves to multiple addresses, using first one", values[i]);
1284 rv[i] = ("net" in set.fw4types) ? ip[0].addr + "/" + ip[0].bits : ip[0].addr;
1288 ip = filter(this.parse_subnet(values[i]), a => (a.family == 6));
1290 switch(length(ip)) {
1291 case 0: return null;
1293 case 2: this.warn("Set entry '%s' resolves to multiple addresses, using first one", values[i]);
1296 rv[i] = ("net" in set.fw4types) ? ip[0].addr + "/" + ip[0].bits : ip[0].addr;
1301 mac = this.parse_mac(values[i]);
1303 if (!mac || mac.invert)
1309 case 'inet_service':
1310 port = this.parse_port(values[i]);
1312 if (!port || port.invert || port.min != port.max)
1323 return length(rv) ? rv : null;
1326 parse_string: function(val) {
1330 parse_opt: function(s, opt, fn, defval, flags) {
1334 if (flags & REQUIRED) {
1335 this.warn_section(s, "option '" + opt + "' is mandatory but not set");
1342 if (type(val) == "array") {
1343 this.warn_section(s, "option '" + opt + "' must not be a list");
1346 else if (val == null) {
1350 let res = this[fn](val);
1353 this.warn_section(s, "option '" + opt + "' specifies invalid value '" + val + "'");
1360 parse_list: function(s, opt, fn, defval, flags) {
1365 if (flags & REQUIRED) {
1366 this.warn_section(s, "option '" + opt + "' is mandatory but not set");
1373 for (val in to_array(val)) {
1374 let res = this[fn](val);
1377 this.warn_section(s, "option '" + opt + "' specifies invalid value '" + val + "'");
1381 if (flags & FLATTEN_LIST)
1382 push(rv, ...to_array(res));
1387 return length(rv) ? rv : null;
1390 quote: function(s, force) {
1391 if (force === true || !match(s, /^([0-9A-Fa-f:.\/-]+)( \. [0-9A-Fa-f:.\/-]+)*$/))
1392 return sprintf('"%s"', replace(s + "", /(["\\])/g, '\\$1'));
1399 return sprintf("%s-%s", a.addr, a.addr2);
1401 if ((a.family == 4 && a.bits == 32) ||
1402 (a.family == 6 && a.bits == 128))
1405 return sprintf("%s/%d", apply_mask(a.addr, a.bits), a.bits);
1410 ? sprintf("%s-%s", a.addr, a.addr2)
1411 : apply_mask(a.addr, a.bits);
1416 return sprintf('%d', p.min);
1418 return sprintf('%d-%d', p.min, p.max);
1421 set: function(v, force) {
1424 v = filter(to_array(v), item => !seen[item]++);
1426 if (force || length(v) != 1)
1427 return sprintf('{ %s }', join(', ', map(v, this.quote)));
1429 return this.quote(v[0]);
1432 concat: function(v) {
1433 return join(' . ', to_array(v));
1436 ipproto: function(family) {
1446 nfproto: function(family, human_readable) {
1449 return human_readable ? "IPv4" : "ipv4";
1452 return human_readable ? "IPv6" : "ipv6";
1455 return human_readable ? "IPv4/IPv6" : null;
1459 datetime: function(stamp) {
1460 return sprintf('"%04d-%02d-%02d %02d:%02d:%02d"',
1461 stamp.year, stamp.month, stamp.day,
1462 stamp.hour, stamp.min, stamp.sec);
1465 date: function(stamp) {
1466 return sprintf('"%04d-%02d-%02d"', stamp.year, stamp.month, stamp.day);
1469 time: function(stamp) {
1470 return sprintf('"%02d:%02d:%02d"', stamp.hour, stamp.min, stamp.sec);
1474 return sprintf('0x%x', n);
1477 is_loopback_dev: function(dev) {
1478 let fd = fs.open(sprintf("/sys/class/net/%s/flags", dev), "r");
1483 let flags = +fd.read("line");
1487 return !!(flags & 0x8);
1490 is_loopback_addr: function(addr) {
1491 return (index(addr, "127.") == 0 || addr == "::1" || addr == "::1/128");
1494 filter_loopback_devs: function(devs, invert) {
1495 return null_if_empty(filter(devs, d => (this.is_loopback_dev(d) == invert)));
1498 filter_loopback_addrs: function(addrs, invert) {
1499 return null_if_empty(filter(addrs, a => (this.is_loopback_addr(a) == invert)));
1503 input_policy: function(reject_as_drop) {
1504 return (!reject_as_drop || this.state.defaults.input != 'reject') ? this.state.defaults.input : 'drop';
1507 output_policy: function(reject_as_drop) {
1508 return (!reject_as_drop || this.state.defaults.output != 'reject') ? this.state.defaults.output : 'drop';
1511 forward_policy: function(reject_as_drop) {
1512 return (!reject_as_drop || this.state.defaults.forward != 'reject') ? this.state.defaults.forward : 'drop';
1515 default_option: function(flag) {
1516 return this.state.defaults[flag];
1519 helpers: function() {
1520 return this.state.helpers;
1524 return this.state.zones;
1527 rules: function(chain) {
1528 return filter(this.state.rules, r => (r.chain == chain));
1531 redirects: function(chain) {
1532 return filter(this.state.redirects, r => (r.chain == chain));
1535 ipsets: function() {
1536 return this.state.ipsets;
1539 parse_setfile: function(set, cb) {
1540 let fd = fs.open(set.loadfile, "r");
1543 warn(sprintf("Unable to load file '%s' for set '%s': %s\n",
1544 set.loadfile, set.name, fs.error()));
1548 let line = null, count = 0;
1550 while ((line = fd.read("line")) !== "") {
1553 if (length(line) == 0 || ord(line) == 35)
1556 let v = this.parse_ipsetentry(line, set);
1559 this.warn("Skipping invalid entry '%s' in file '%s' for set '%s'",
1560 line, set.loadfile, set.name);
1574 print_setentries: function(set) {
1576 let printer = (entry) => {
1578 print("\t\telements = {\n");
1582 print("\t\t\t", join(" . ", entry), ",\n");
1585 map(set.entries, printer);
1588 this.parse_setfile(set, printer);
1594 parse_helper: function(data) {
1595 let helper = this.parse_options(data, {
1596 name: [ "string", null, REQUIRED ],
1597 description: [ "string" ],
1598 module: [ "string" ],
1599 family: [ "family" ],
1600 proto: [ "protocol", null, PARSE_LIST | FLATTEN_LIST | NO_INVERT ],
1601 port: [ "port", null, NO_INVERT ]
1604 if (helper === false) {
1605 this.warn("Helper definition '%s' skipped due to invalid options", data.name || data['.name']);
1608 else if (helper.proto.any) {
1609 this.warn("Helper definition '%s' must not specify wildcard protocol", data.name || data['.name']);
1612 else if (length(helper.proto) > 1) {
1613 this.warn("Helper definition '%s' must not specify multiple protocols", data.name || data['.name']);
1617 helper.available = ((fs.stat("/sys/module/" + helper.module) || {}).type == "directory");
1619 this.state.helpers = this.state.helpers || [];
1620 push(this.state.helpers, helper);
1623 parse_defaults: function(data) {
1624 if (this.state.defaults) {
1625 this.warn_section(data, ": ignoring duplicate defaults section");
1629 let defs = this.parse_options(data, {
1630 input: [ "policy", "drop" ],
1631 output: [ "policy", "drop" ],
1632 forward: [ "policy", "drop" ],
1634 drop_invalid: [ "bool" ],
1635 tcp_reject_code: [ "reject_code", "tcp-reset" ],
1636 any_reject_code: [ "reject_code", "port-unreachable" ],
1638 syn_flood: [ "bool" ],
1639 synflood_protect: [ "bool" ],
1640 synflood_rate: [ "limit", "25/second" ],
1641 synflood_burst: [ "int", "50" ],
1643 tcp_syncookies: [ "bool", "1" ],
1645 tcp_window_scaling: [ "bool", "1" ],
1647 accept_redirects: [ "bool" ],
1648 accept_source_route: [ "bool" ],
1650 auto_helper: [ "bool", "1" ],
1651 custom_chains: [ "bool", null, UNSUPPORTED ],
1652 disable_ipv6: [ "bool", null, UNSUPPORTED ],
1653 flow_offloading: [ "bool", "0" ],
1654 flow_offloading_hw: [ "bool", "0" ]
1657 if (defs.synflood_protect === null)
1658 defs.synflood_protect = defs.syn_flood;
1660 delete defs.syn_flood;
1662 this.state.defaults = defs;
1665 parse_zone: function(data) {
1666 let zone = this.parse_options(data, {
1667 enabled: [ "bool", "1" ],
1669 name: [ "string", null, REQUIRED ],
1670 family: [ "family" ],
1672 network: [ "device", null, PARSE_LIST ],
1673 device: [ "device", null, PARSE_LIST ],
1674 subnet: [ "network", null, PARSE_LIST ],
1676 input: [ "policy", this.state.defaults ? this.state.defaults.input : "drop" ],
1677 output: [ "policy", this.state.defaults ? this.state.defaults.output : "drop" ],
1678 forward: [ "policy", this.state.defaults ? this.state.defaults.forward : "drop" ],
1681 masq_allow_invalid: [ "bool" ],
1682 masq_src: [ "network", null, PARSE_LIST ],
1683 masq_dest: [ "network", null, PARSE_LIST ],
1687 extra: [ "string", null, UNSUPPORTED ],
1688 extra_src: [ "string", null, UNSUPPORTED ],
1689 extra_dest: [ "string", null, UNSUPPORTED ],
1691 mtu_fix: [ "bool" ],
1692 custom_chains: [ "bool", null, UNSUPPORTED ],
1695 log_limit: [ "limit", null, UNSUPPORTED ],
1697 auto_helper: [ "bool", "1" ],
1698 helper: [ "cthelper", null, PARSE_LIST ],
1700 counter: [ "bool", "1" ]
1703 if (zone === false) {
1704 this.warn_section(data, "skipped due to invalid options");
1707 else if (!zone.enabled) {
1708 this.warn_section(data, "is disabled, ignoring section");
1711 else if (zone.helper && !zone.helper.available) {
1712 this.warn_section(data, "uses unavailable ct helper '" + zone.helper.name + "', ignoring section");
1716 if (zone.mtu_fix && this.kernel < 0x040a0000) {
1717 this.warn_section(data, "option 'mtu_fix' requires kernel 4.10 or later");
1721 if (this.state.defaults && this.state.defaults.auto_helper === false)
1722 zone.auto_helper = false;
1724 let match_devices = [];
1725 let related_subnets = [];
1726 let related_ubus_networks = [];
1727 let match_subnets, masq_src_subnets, masq_dest_subnets;
1729 for (let name, net in this.state.networks) {
1730 if (net.zone === zone.name)
1731 push(related_ubus_networks, { invert: false, device: name });
1734 for (let e in [ ...to_array(zone.network), ...related_ubus_networks ]) {
1735 if (exists(this.state.networks, e.device)) {
1736 let net = this.state.networks[e.device];
1739 push(match_devices, {
1745 push(related_subnets, ...(net.ipaddrs || []));
1749 push(match_devices, ...to_array(zone.device));
1751 match_subnets = subnets_split_af(zone.subnet);
1752 masq_src_subnets = subnets_split_af(zone.masq_src);
1753 masq_dest_subnets = subnets_split_af(zone.masq_dest);
1755 push(related_subnets, ...(match_subnets[0] || []), ...(match_subnets[1] || []));
1757 let match_rules = [];
1759 let add_rule = (family, devices, subnets, zone) => {
1764 r.devices_pos = null_if_empty(devices[0]);
1765 r.devices_neg = null_if_empty(devices[1]);
1766 r.devices_neg_wildcard = null_if_empty(devices[2]);
1768 r.subnets_pos = map(filter_pos(subnets), this.cidr);
1769 r.subnets_neg = map(filter_neg(subnets), this.cidr);
1771 push(match_rules, r);
1774 let family = infer_family(zone.family, [
1775 zone.helper, "ct helper"
1778 // group non-inverted device matches into wildcard and non-wildcard ones
1779 let devices = [], plain_devices = [], plain_invert_devices = [], wildcard_invert_devices = [];
1781 for (let device in match_devices) {
1782 let m = match(device.device, /^([^+]*)(\+)?$/);
1785 this.warn_section(data, "skipping invalid wildcard pattern '" + device.device + '"');
1789 // filter `+` (match any device) since nftables does not support
1790 // wildcard only matches
1791 if (!device.invert && m[0] == '+')
1794 // replace inverted `+` (match no device) with invalid pattern
1795 if (device.invert && m[0] == '+') {
1796 device.device = '/never/';
1797 device.invert = false;
1800 // replace "name+" matches with "name*"
1801 else if (m[2] == '+')
1802 device.device = m[1] + '*';
1804 device.wildcard = !!m[2];
1806 if (!device.invert && device.wildcard)
1807 push(devices, [ [ device.device ], plain_invert_devices, wildcard_invert_devices ]);
1808 else if (!device.invert)
1809 push(plain_devices, device.device);
1810 else if (device.wildcard)
1811 push(wildcard_invert_devices, device.device);
1813 push(plain_invert_devices, device.device);
1816 if (length(plain_devices))
1819 plain_invert_devices,
1820 wildcard_invert_devices
1822 else if (!length(devices))
1825 plain_invert_devices,
1826 wildcard_invert_devices
1829 // emit zone jump rules for each device group
1830 if (length(match_devices) || length(match_subnets[0]) || length(match_subnets[1])) {
1831 for (let devgroup in devices) {
1832 // check if there's no AF specific bits, in this case we can do AF agnostic matching
1833 if (!family && !length(match_subnets[0]) && !length(match_subnets[1])) {
1834 add_rule(0, devgroup, null, zone);
1837 // we need to emit one or two AF specific rules
1839 if (family_is_ipv4(zone) && length(match_subnets[0]))
1840 add_rule(4, devgroup, match_subnets[0], zone);
1842 if (family_is_ipv6(zone) && length(match_subnets[1]))
1843 add_rule(6, devgroup, match_subnets[1], zone);
1848 zone.match_rules = match_rules;
1850 if (masq_src_subnets[0]) {
1851 zone.masq4_src_pos = map(filter_pos(masq_src_subnets[0]), this.cidr);
1852 zone.masq4_src_neg = map(filter_neg(masq_src_subnets[0]), this.cidr);
1855 if (masq_src_subnets[1]) {
1856 zone.masq6_src_pos = map(filter_pos(masq_src_subnets[1]), this.cidr);
1857 zone.masq6_src_neg = map(filter_neg(masq_src_subnets[1]), this.cidr);
1860 if (masq_dest_subnets[0]) {
1861 zone.masq4_dest_pos = map(filter_pos(masq_dest_subnets[0]), this.cidr);
1862 zone.masq4_dest_neg = map(filter_neg(masq_dest_subnets[0]), this.cidr);
1865 if (masq_dest_subnets[1]) {
1866 zone.masq6_dest_pos = map(filter_pos(masq_dest_subnets[1]), this.cidr);
1867 zone.masq6_dest_neg = map(filter_neg(masq_dest_subnets[1]), this.cidr);
1871 zone.sflags[zone.input] = true;
1874 zone.dflags[zone.output] = true;
1875 zone.dflags[zone.forward] = true;
1877 zone.match_devices = map(filter(match_devices, d => !d.invert), d => d.device);
1878 zone.match_subnets = map(filter(related_subnets, s => !s.invert), this.cidr);
1880 zone.related_subnets = related_subnets;
1882 if (zone.masq || zone.masq6)
1883 zone.dflags.snat = true;
1885 if ((zone.auto_helper && !(zone.masq || zone.masq6)) || length(zone.helper)) {
1886 zone.dflags.helper = true;
1888 for (let helper in (length(zone.helper) ? zone.helper : this.state.helpers)) {
1889 if (!helper.available)
1892 for (let proto in helper.proto) {
1893 this.state.rules = this.state.rules || [];
1894 push(this.state.rules, {
1895 chain: "helper_" + zone.name,
1896 family: helper.family,
1897 name: helper.description || helper.name,
1900 dports_pos: [ this.port(helper.port) ],
1908 this.state.zones = this.state.zones || [];
1909 push(this.state.zones, zone);
1912 parse_forwarding: function(data) {
1913 let fwd = this.parse_options(data, {
1914 enabled: [ "bool", "1" ],
1917 family: [ "family" ],
1919 src: [ "zone_ref", null, REQUIRED ],
1920 dest: [ "zone_ref", null, REQUIRED ]
1923 if (fwd === false) {
1924 this.warn_section(data, "skipped due to invalid options");
1927 else if (!fwd.enabled) {
1928 this.warn_section(data, "is disabled, ignoring section");
1932 let add_rule = (family, fwd) => {
1937 proto: { any: true }
1940 f.name = fwd.name || sprintf("Accept %s to %s forwarding",
1941 fwd.src.any ? "any" : fwd.src.zone.name,
1942 fwd.dest.any ? "any" : fwd.dest.zone.name);
1944 f.chain = fwd.src.any ? "forward" : sprintf("forward_%s", fwd.src.zone.name);
1947 f.target = "accept";
1949 f.jump_chain = sprintf("accept_to_%s", fwd.dest.zone.name);
1951 this.state.rules = this.state.rules || [];
1952 push(this.state.rules, f);
1956 let family = fwd.family;
1958 /* inherit family restrictions from related zones */
1959 if (family === 0 || family === null) {
1960 let f1 = fwd.src.zone ? fwd.src.zone.family : 0;
1961 let f2 = fwd.dest.zone ? fwd.dest.zone.family : 0;
1963 if (f1 != 0 && f2 != 0 && f1 != f2) {
1964 this.warn_section(data,
1965 sprintf("references src %s restricted to %s and dest restricted to %s, ignoring forwarding",
1966 fwd.src.zone.name, this.nfproto(f1, true),
1967 fwd.dest.zone.name, this.nfproto(f2, true)));
1972 this.warn_section(data,
1973 sprintf("inheriting %s restriction from src %s",
1974 this.nfproto(f1, true), fwd.src.zone.name));
1979 this.warn_section(data,
1980 sprintf("inheriting %s restriction from dest %s",
1981 this.nfproto(f2, true), fwd.dest.zone.name));
1987 add_rule(family, fwd);
1990 fwd.dest.zone.dflags.accept = true;
1993 parse_rule: function(data) {
1994 let rule = this.parse_options(data, {
1995 enabled: [ "bool", "1" ],
1997 name: [ "string", this.section_id(data[".name"]) ],
1998 _name: [ "string", null, DEPRECATED ],
1999 family: [ "family" ],
2001 src: [ "zone_ref" ],
2002 dest: [ "zone_ref" ],
2004 device: [ "device" ],
2005 direction: [ "direction" ],
2007 ipset: [ "setmatch" ],
2008 helper: [ "cthelper" ],
2009 set_helper: [ "cthelper", null, NO_INVERT ],
2011 proto: [ "protocol", "tcpudp", PARSE_LIST | FLATTEN_LIST ],
2013 src_ip: [ "network", null, PARSE_LIST ],
2014 src_mac: [ "mac", null, PARSE_LIST ],
2015 src_port: [ "port", null, PARSE_LIST ],
2017 dest_ip: [ "network", null, PARSE_LIST ],
2018 dest_port: [ "port", null, PARSE_LIST ],
2020 icmp_type: [ "icmptype", null, PARSE_LIST ],
2021 extra: [ "string", null, UNSUPPORTED ],
2024 limit_burst: [ "int" ],
2026 utc_time: [ "bool" ],
2027 start_date: [ "date" ],
2028 stop_date: [ "date" ],
2029 start_time: [ "time" ],
2030 stop_time: [ "time" ],
2031 weekdays: [ "weekdays" ],
2032 monthdays: [ "monthdays", null, UNSUPPORTED ],
2035 set_mark: [ "mark", null, NO_INVERT ],
2036 set_xmark: [ "mark", null, NO_INVERT ],
2039 set_dscp: [ "dscp", null, NO_INVERT ],
2041 counter: [ "bool", "1" ],
2043 target: [ "target" ]
2046 if (rule === false) {
2047 this.warn_section(data, "skipped due to invalid options");
2050 else if (!rule.enabled) {
2051 this.warn_section(data, "is disabled, ignoring section");
2055 if (rule.target in ["helper", "notrack"] && (!rule.src || !rule.src.zone)) {
2056 this.warn_section(data, "must specify a source zone for target '" + rule.target + "'");
2059 else if (rule.target == "dscp" && !rule.set_dscp) {
2060 this.warn_section(data, "must specify option 'set_dscp' for target 'dscp'");
2063 else if (rule.target == "mark" && !rule.set_mark && !rule.set_xmark) {
2064 this.warn_section(data, "must specify option 'set_mark' or 'set_xmark' for target 'mark'");
2067 else if (rule.target == "helper" && !rule.set_helper) {
2068 this.warn_section(data, "must specify option 'set_helper' for target 'helper'");
2075 ipset = filter(this.state.ipsets, s => (s.name == rule.ipset.name))[0];
2078 this.warn_section(data, "references unknown set '" + rule.ipset.name + "'");
2082 if (('inet_service' in ipset.types) && !ensure_tcpudp(rule.proto)) {
2083 this.warn_section(data, "references named set with port match but no UDP/TCP protocol, ignoring section");
2088 let need_src_action_chain = (rule) => (rule.src && rule.src.zone && rule.src.zone.log && rule.target != "accept");
2090 let add_rule = (family, proto, saddrs, daddrs, sports, dports, icmptypes, icmpcodes, ipset, rule) => {
2096 has_addrs: !!(length(saddrs) || length(daddrs)),
2097 has_ports: !!(length(sports) || length(dports)),
2098 saddrs_pos: map(filter_pos(saddrs), this.cidr),
2099 saddrs_neg: map(filter_neg(saddrs), this.cidr),
2100 daddrs_pos: map(filter_pos(daddrs), this.cidr),
2101 daddrs_neg: map(filter_neg(daddrs), this.cidr),
2102 sports_pos: map(filter_pos(sports), this.port),
2103 sports_neg: map(filter_neg(sports), this.port),
2104 dports_pos: map(filter_pos(dports), this.port),
2105 dports_neg: map(filter_neg(dports), this.port),
2106 smacs_pos: map(filter_pos(rule.src_mac), m => m.mac),
2107 smacs_neg: map(filter_neg(rule.src_mac), m => m.mac),
2108 icmp_types: map(icmptypes, i => (family == 4 ? i.type : i.type6)),
2109 icmp_codes: map(icmpcodes, ic => sprintf('%d . %d', (family == 4) ? ic.type : ic.type6, (family == 4) ? ic.code_min : ic.code6_min))
2112 if (!length(r.icmp_types))
2113 delete r.icmp_types;
2115 if (!length(r.icmp_codes))
2116 delete r.icmp_codes;
2120 invert: r.set_mark.invert,
2121 mark: r.set_mark.mark,
2122 mask: r.set_mark.mark | r.set_mark.mask
2128 let set_types = map_setmatch(ipset, rule.ipset, proto.name);
2130 if (set_types !== set_types) {
2131 this.warn_section(data, "destination MAC address matching not supported");
2133 } else if (set_types) {
2134 r.ipset = { ...r.ipset, fields: set_types };
2137 if (r.target == "notrack") {
2138 r.chain = sprintf("notrack_%s", r.src.zone.name);
2139 r.src.zone.dflags.notrack = true;
2141 else if (r.target == "helper") {
2142 r.chain = sprintf("helper_%s", r.src.zone.name);
2143 r.src.zone.dflags.helper = true;
2145 else if (r.target == "mark" || r.target == "dscp") {
2146 if ((r.src?.any && r.dest?.any) || (r.src?.zone && r.dest?.zone))
2147 r.chain = "mangle_forward";
2148 else if (r.src?.any && r.dest?.zone)
2149 r.chain = "mangle_postrouting";
2150 else if (r.src?.zone && r.dest?.any)
2151 r.chain = "mangle_prerouting";
2152 else if (r.src && !r.dest)
2153 r.chain = "mangle_input";
2155 r.chain = "mangle_output";
2158 r.src.zone.dflags[r.target] = true;
2161 r.dest.zone.dflags[r.target] = true;
2168 r.chain = sprintf("%s_%s", r.dest ? "forward" : "input", r.src.zone.name);
2170 r.chain = r.dest ? "forward" : "input";
2173 if (r.dest && !r.src) {
2175 r.chain = sprintf("output_%s", r.dest.zone.name);
2180 if (r.dest && !r.dest.any) {
2181 r.jump_chain = sprintf("%s_to_%s", r.target, r.dest.zone.name);
2182 r.dest.zone.dflags[r.target] = true;
2184 else if (need_src_action_chain(r)) {
2185 r.jump_chain = sprintf("%s_from_%s", r.target, r.src.zone.name);
2186 r.src.zone.dflags[r.target] = true;
2188 else if (r.target == "reject")
2189 r.jump_chain = "handle_reject";
2192 this.state.rules = this.state.rules || [];
2193 push(this.state.rules, r);
2196 for (let proto in rule.proto) {
2197 let sip, dip, sports, dports, itypes4, itypes6;
2198 let family = rule.family;
2200 switch (proto.name) {
2202 itypes4 = filter(rule.icmp_type || [], family_is_ipv4);
2203 itypes6 = filter(rule.icmp_type || [], family_is_ipv6);
2208 itypes6 = filter(rule.icmp_type || [], family_is_ipv6);
2213 sports = rule.src_port;
2214 dports = rule.dest_port;
2218 family = infer_family(family, [
2220 rule.src, "source zone",
2221 rule.dest, "destination zone",
2222 rule.helper, "helper match",
2223 rule.set_helper, "helper to set"
2226 if (type(family) == "string") {
2227 this.warn_section(data, family + ", skipping");
2231 sip = subnets_split_af(rule.src_ip);
2232 dip = subnets_split_af(rule.dest_ip);
2234 let has_ipv4_specifics = (length(sip[0]) || length(dip[0]) || length(itypes4) || rule.dscp !== null);
2235 let has_ipv6_specifics = (length(sip[1]) || length(dip[1]) || length(itypes6) || rule.dscp !== null);
2237 /* if no family was configured, infer target family from IP addresses */
2238 if (family === null) {
2239 if (has_ipv4_specifics && !has_ipv6_specifics)
2241 else if (has_ipv6_specifics && !has_ipv4_specifics)
2247 /* check if there's no AF specific bits, in this case we can do an AF agnostic rule */
2248 if (!family && rule.target != "dscp" && !has_ipv4_specifics && !has_ipv6_specifics) {
2249 add_rule(0, proto, null, null, sports, dports, null, null, null, rule);
2252 /* we need to emit one or two AF specific rules */
2254 if (family == 0 || family == 4) {
2255 let icmp_types = filter(itypes4, i => (i.code_min == 0 && i.code_max == 0xFF));
2256 let icmp_codes = filter(itypes4, i => (i.code_min != 0 || i.code_max != 0xFF));
2258 if (length(icmp_types) || (!length(icmp_types) && !length(icmp_codes)))
2259 add_rule(4, proto, sip[0], dip[0], sports, dports, icmp_types, null, ipset, rule);
2261 if (length(icmp_codes))
2262 add_rule(4, proto, sip[0], dip[0], sports, dports, null, icmp_codes, ipset, rule);
2265 if (family == 0 || family == 6) {
2266 let icmp_types = filter(itypes6, i => (i.code_min == 0 && i.code_max == 0xFF));
2267 let icmp_codes = filter(itypes6, i => (i.code_min != 0 || i.code_max != 0xFF));
2269 if (length(icmp_types) || (!length(icmp_types) && !length(icmp_codes)))
2270 add_rule(6, proto, sip[1], dip[1], sports, dports, icmp_types, null, ipset, rule);
2272 if (length(icmp_codes))
2273 add_rule(6, proto, sip[1], dip[1], sports, dports, null, icmp_codes, ipset, rule);
2279 parse_redirect: function(data) {
2280 let redir = this.parse_options(data, {
2281 enabled: [ "bool", "1" ],
2283 name: [ "string", this.section_id(data[".name"]) ],
2284 _name: [ "string", null, DEPRECATED ],
2285 family: [ "family" ],
2287 src: [ "zone_ref" ],
2288 dest: [ "zone_ref" ],
2290 ipset: [ "setmatch" ],
2291 helper: [ "cthelper", null, NO_INVERT ],
2293 proto: [ "protocol", "tcpudp", PARSE_LIST | FLATTEN_LIST ],
2295 src_ip: [ "network" ],
2296 src_mac: [ "mac", null, PARSE_LIST ],
2297 src_port: [ "port" ],
2299 src_dip: [ "network" ],
2300 src_dport: [ "port" ],
2302 dest_ip: [ "network" ],
2303 dest_port: [ "port" ],
2305 extra: [ "string", null, UNSUPPORTED ],
2308 limit_burst: [ "int" ],
2310 utc_time: [ "bool" ],
2311 start_date: [ "date" ],
2312 stop_date: [ "date" ],
2313 start_time: [ "time" ],
2314 stop_time: [ "time" ],
2315 weekdays: [ "weekdays" ],
2316 monthdays: [ "monthdays", null, UNSUPPORTED ],
2320 reflection: [ "bool", "1" ],
2321 reflection_src: [ "reflection_source", "internal" ],
2323 reflection_zone: [ "zone_ref", null, PARSE_LIST ],
2325 counter: [ "bool", "1" ],
2327 target: [ "target", "dnat" ]
2330 if (redir === false) {
2331 this.warn_section(data, "skipped due to invalid options");
2334 else if (!redir.enabled) {
2335 this.warn_section(data, "is disabled, ignoring section");
2339 if (!(redir.target in ["dnat", "snat"])) {
2340 this.warn_section(data, "has invalid target specified, defaulting to dnat");
2341 redir.target = "dnat";
2347 ipset = filter(this.state.ipsets, s => (s.name == redir.ipset.name))[0];
2350 this.warn_section(data, "references unknown set '" + redir.ipset.name + "'");
2354 if (('inet_service' in ipset.types) && !ensure_tcpudp(redir.proto)) {
2355 this.warn_section(data, "references named set with port match but no UDP/TCP protocol, ignoring section");
2360 let resolve_dest = (redir) => {
2361 for (let zone in this.state.zones) {
2362 for (let addr in zone.related_subnets) {
2363 if (redir.dest_ip.family != addr.family)
2366 let a = apply_mask(redir.dest_ip.addr, addr.bits);
2367 let b = apply_mask(addr.addr, addr.bits);
2384 if (redir.target == "dnat") {
2386 return this.warn_section(r, "has no source specified");
2387 else if (redir.src.any)
2388 return this.warn_section(r, "must not have source '*' for dnat target");
2389 else if (redir.dest_ip && redir.dest_ip.invert)
2390 return this.warn_section(r, "must not specify a negated 'dest_ip' value");
2392 if (!redir.dest && redir.dest_ip && resolve_dest(redir))
2393 this.warn_section(r, "does not specify a destination, assuming '" + redir.dest.zone.name + "'");
2395 if (!redir.dest_port)
2396 redir.dest_port = redir.src_dport;
2398 if (redir.reflection && redir.dest && redir.dest.zone && redir.src.zone.masq) {
2399 redir.dest.zone.dflags.accept = true;
2400 redir.dest.zone.dflags.dnat = true;
2401 redir.dest.zone.dflags.snat = true;
2405 redir.src.zone.dflags.helper = true;
2407 redir.src.zone.dflags[redir.target] = true;
2411 return this.warn_section(data, "has no destination specified");
2412 else if (redir.dest.any)
2413 return this.warn_section(data, "must not have destination '*' for snat target");
2414 else if (!redir.src_dip)
2415 return this.warn_section(data, "has no 'src_dip' option specified");
2416 else if (redir.src_dip.invert)
2417 return this.warn_section(data, "must not specify a negated 'src_dip' value");
2418 else if (redir.src_mac)
2419 return this.warn_section(data, "must not use 'src_mac' option for snat target");
2420 else if (redir.helper)
2421 return this.warn_section(data, "must not use 'helper' option for snat target");
2423 redir.dest.zone.dflags[redir.target] = true;
2427 let add_rule = (family, proto, saddrs, daddrs, raddrs, sport, dport, rport, ipset, redir) => {
2433 has_addrs: !!(length(saddrs) || length(daddrs)),
2434 has_ports: !!(sport || dport || rport),
2435 saddrs_pos: map(filter_pos(saddrs), this.cidr),
2436 saddrs_neg: map(filter_neg(saddrs), this.cidr),
2437 daddrs_pos: map(filter_pos(daddrs), this.cidr),
2438 daddrs_neg: map(filter_neg(daddrs), this.cidr),
2439 sports_pos: map(filter_pos(to_array(sport)), this.port),
2440 sports_neg: map(filter_neg(to_array(sport)), this.port),
2441 dports_pos: map(filter_pos(to_array(dport)), this.port),
2442 dports_neg: map(filter_neg(to_array(dport)), this.port),
2443 smacs_pos: map(filter_pos(redir.src_mac), m => m.mac),
2444 smacs_neg: map(filter_neg(redir.src_mac), m => m.mac),
2446 raddr: raddrs ? raddrs[0] : null,
2450 let set_types = map_setmatch(ipset, redir.ipset, proto.name);
2452 if (set_types !== set_types) {
2453 this.warn_section(data, "destination MAC address matching not supported");
2455 } else if (set_types) {
2456 r.ipset = { ...r.ipset, fields: set_types };
2461 r.chain = sprintf("dstnat_%s", r.src.zone.name);
2464 r.target = "redirect";
2469 r.chain = sprintf("srcnat_%s", r.dest.zone.name);
2473 this.state.redirects = this.state.redirects || [];
2474 push(this.state.redirects, r);
2477 let to_hostaddr = (a) => {
2478 let bits = (a.family == 4) ? 32 : 128;
2482 addr: apply_mask(a.addr, bits),
2487 for (let proto in redir.proto) {
2488 let sip, dip, rip, iip, eip, refip, sport, dport, rport;
2489 let family = redir.family;
2491 if (proto.name == "ipv6-icmp")
2494 family = infer_family(family, [
2496 redir.src, "source zone",
2497 redir.dest, "destination zone",
2498 redir.helper, "helper match"
2501 if (type(family) == "string") {
2502 this.warn_section(data, family + ", skipping");
2506 switch (redir.target) {
2508 sip = subnets_split_af(redir.src_ip);
2509 dip = subnets_split_af(redir.src_dip);
2510 rip = subnets_split_af(redir.dest_ip);
2512 switch (proto.name) {
2515 sport = redir.src_port;
2516 dport = redir.src_dport;
2517 rport = redir.dest_port;
2521 /* build reflection rules */
2522 if (redir.reflection && (length(rip[0]) || length(rip[1])) &&
2523 redir.src && redir.src.zone && redir.src.zone[family == 4 ? "masq" : "masq6"] &&
2524 redir.dest && redir.dest.zone) {
2527 name: redir.name + " (reflection)",
2529 helper: redir.helper,
2531 // XXX: this likely makes no sense for reflection rules
2532 //src_mac: redir.src_mac,
2535 limit_burst: redir.limit_burst,
2537 start_date: redir.start_date,
2538 stop_date: redir.stop_date,
2539 start_time: redir.start_time,
2540 stop_time: redir.stop_time,
2541 weekdays: redir.weekdays,
2546 let eaddrs = subnets_split_af(length(dip) ? dip : { addrs: redir.src.zone.related_subnets });
2547 let rzones = length(redir.reflection_zone) ? redir.reflection_zone : [ redir.dest ];
2549 for (let rzone in rzones) {
2550 if (!is_family(rzone, family)) {
2551 this.warn_section(data,
2552 sprintf("is restricted to IPv%d but referenced reflection zone is IPv%d only, skipping",
2553 family, rzone.family));
2557 let iaddrs = subnets_split_af({ addrs: rzone.zone.related_subnets });
2558 let refaddrs = (redir.reflection_src == "internal") ? iaddrs : eaddrs;
2561 map(refaddrs[0], to_hostaddr),
2562 map(refaddrs[1], to_hostaddr)
2566 map(eaddrs[0], to_hostaddr),
2567 map(eaddrs[1], to_hostaddr)
2570 for (let i = 0; i <= 1; i++) {
2571 if (length(rip[i])) {
2572 refredir.src = rzone;
2573 refredir.dest = null;
2574 refredir.target = "dnat";
2575 add_rule(i ? 6 : 4, proto, iaddrs[i], eaddrs[i], rip[i], sport, dport, rport, null, refredir);
2577 for (let refaddr in refaddrs[i]) {
2578 refredir.src = null;
2579 refredir.dest = rzone;
2580 refredir.target = "snat";
2581 add_rule(i ? 6 : 4, proto, iaddrs[i], rip[i], [ refaddr ], null, rport, null, null, refredir);
2592 sip = subnets_split_af(redir.src_ip);
2593 dip = subnets_split_af(redir.dest_ip);
2594 rip = subnets_split_af(redir.src_dip);
2596 switch (proto.name) {
2599 sport = redir.src_port;
2600 dport = redir.dest_port;
2601 rport = redir.src_dport;
2608 if (length(rip[0]) > 1 || length(rip[1]) > 1)
2609 this.warn_section(data, "specifies multiple rewrite addresses, using only first one");
2611 /* check if there's no AF specific bits, in this case we can do an AF agnostic rule */
2612 if (!family && !length(sip[0]) && !length(sip[1]) && !length(dip[0]) && !length(dip[1]) && !length(rip[0]) && !length(rip[1])) {
2613 /* for backwards compatibility, treat unspecified family as IPv4 unless user explicitly requested any (0) */
2617 add_rule(family, proto, null, null, null, sport, dport, rport, null, redir);
2620 /* we need to emit one or two AF specific rules */
2622 if ((!family || family == 4) && (length(sip[0]) || length(dip[0]) || length(rip[0])))
2623 add_rule(4, proto, sip[0], dip[0], rip[0], sport, dport, rport, ipset, redir);
2625 if ((!family || family == 6) && (length(sip[1]) || length(dip[1]) || length(rip[1])))
2626 add_rule(6, proto, sip[1], dip[1], rip[1], sport, dport, rport, ipset, redir);
2631 parse_nat: function(data) {
2632 let snat = this.parse_options(data, {
2633 enabled: [ "bool", "1" ],
2635 name: [ "string", this.section_id(data[".name"]) ],
2636 family: [ "family", "4" ],
2638 src: [ "zone_ref" ],
2639 device: [ "string" ],
2641 ipset: [ "setmatch", null, UNSUPPORTED ],
2643 proto: [ "protocol", "all", PARSE_LIST | FLATTEN_LIST ],
2645 src_ip: [ "network" ],
2646 src_port: [ "port" ],
2648 snat_ip: [ "network", null, NO_INVERT ],
2649 snat_port: [ "port", null, NO_INVERT ],
2651 dest_ip: [ "network" ],
2652 dest_port: [ "port" ],
2654 extra: [ "string", null, UNSUPPORTED ],
2657 limit_burst: [ "int" ],
2659 connlimit_ports: [ "bool" ],
2661 utc_time: [ "bool" ],
2662 start_date: [ "date" ],
2663 stop_date: [ "date" ],
2664 start_time: [ "time" ],
2665 stop_time: [ "time" ],
2666 weekdays: [ "weekdays" ],
2667 monthdays: [ "monthdays", null, UNSUPPORTED ],
2671 target: [ "target", "masquerade" ]
2674 if (snat === false) {
2675 this.warn_section(data, "skipped due to invalid options");
2678 else if (!snat.enabled) {
2679 this.warn_section(data, "is disabled, ignoring section");
2683 if (!(snat.target in ["accept", "snat", "masquerade"])) {
2684 this.warn_section(data, "has invalid target specified, defaulting to masquerade");
2685 snat.target = "masquerade";
2688 if (snat.target == "snat" && !snat.snat_ip && !snat.snat_port) {
2689 this.warn_section(data, "needs either 'snat_ip' or 'snat_port' for target snat, ignoring section");
2692 else if (snat.target != "snat" && snat.snat_ip) {
2693 this.warn_section(data, "must not use 'snat_ip' for non-snat target, ignoring section");
2696 else if (snat.target != "snat" && snat.snat_port) {
2697 this.warn_section(data, "must not use 'snat_port' for non-snat target, ignoring section");
2701 if ((snat.snat_port || snat.src_port || snat.dest_port) && !ensure_tcpudp(snat.proto)) {
2702 this.warn_section(data, "specifies ports but no UDP/TCP protocol, ignoring section");
2706 if (snat.src && snat.src.zone)
2707 snat.src.zone.dflags.snat = true;
2709 let add_rule = (family, proto, saddrs, daddrs, raddrs, sport, dport, rport, snat) => {
2715 has_addrs: !!(length(saddrs) || length(daddrs) || length(raddrs)),
2716 has_ports: !!(sport || dport),
2717 saddrs_pos: map(filter_pos(saddrs), this.cidr),
2718 saddrs_neg: map(filter_neg(saddrs), this.cidr),
2719 daddrs_pos: map(filter_pos(daddrs), this.cidr),
2720 daddrs_neg: map(filter_neg(daddrs), this.cidr),
2721 sports_pos: map(filter_pos(to_array(sport)), this.port),
2722 sports_neg: map(filter_neg(to_array(sport)), this.port),
2723 dports_pos: map(filter_pos(to_array(dport)), this.port),
2724 dports_neg: map(filter_neg(to_array(dport)), this.port),
2726 raddr: raddrs ? raddrs[0] : null,
2729 chain: (snat.src && snat.src.zone) ? sprintf("srcnat_%s", snat.src.zone.name) : "srcnat"
2732 this.state.redirects = this.state.redirects || [];
2733 push(this.state.redirects, n);
2736 for (let proto in snat.proto) {
2737 let sip, dip, rip, sport, dport, rport;
2738 let family = snat.family;
2740 sip = subnets_split_af(snat.src_ip);
2741 dip = subnets_split_af(snat.dest_ip);
2742 rip = subnets_split_af(snat.snat_ip);
2744 switch (proto.name) {
2747 sport = snat.src_port;
2748 dport = snat.dest_port;
2749 rport = snat.snat_port;
2753 if (length(rip[0]) > 1 || length(rip[1]) > 1)
2754 this.warn_section(data, "specifies multiple rewrite addresses, using only first one");
2756 /* inherit family restrictions from related zones */
2757 if (family === 0 || family === null) {
2758 let f = (rule.src && rule.src.zone) ? rule.src.zone.family : 0;
2761 this.warn_section(r,
2762 sprintf("inheriting %s restriction from src %s",
2763 this.nfproto(f1, true), rule.src.zone.name));
2769 /* if no family was configured, infer target family from IP addresses */
2770 if (family === null) {
2771 if ((length(sip[0]) || length(dip[0]) || length(rip[0])) && !length(sip[1]) && !length(dip[1]) && !length(rip[1]))
2773 else if ((length(sip[1]) || length(dip[1]) || length(rip[1])) && !length(sip[0]) && !length(dip[0]) && !length(rip[0]))
2779 /* check if there's no AF specific bits, in this case we can do an AF agnostic rule */
2780 if (!family && !length(sip[0]) && !length(sip[1]) && !length(dip[0]) && !length(dip[1]) && !length(rip[0]) && !length(rip[1])) {
2781 add_rule(0, proto, null, null, null, sport, dport, rport, snat);
2784 /* we need to emit one or two AF specific rules */
2786 if (family == 0 || family == 4)
2787 add_rule(4, proto, sip[0], dip[0], rip[0], sport, dport, rport, snat);
2789 if (family == 0 || family == 6)
2790 add_rule(6, proto, sip[1], dip[1], rip[1], sport, dport, rport, snat);
2795 parse_ipset: function(data) {
2796 let ipset = this.parse_options(data, {
2797 enabled: [ "bool", "1" ],
2798 reload_set: [ "bool" ],
2799 counters: [ "bool" ],
2800 comment: [ "bool" ],
2802 name: [ "string", null, REQUIRED ],
2803 family: [ "family", "4" ],
2805 storage: [ "string", null, UNSUPPORTED ],
2806 match: [ "ipsettype", null, PARSE_LIST ],
2808 iprange: [ "string", null, UNSUPPORTED ],
2809 portrange: [ "string", null, UNSUPPORTED ],
2811 netmask: [ "int", null, UNSUPPORTED ],
2813 hashsize: [ "int", null, UNSUPPORTED ],
2814 timeout: [ "int", "-1" ],
2816 external: [ "string", null, UNSUPPORTED ],
2818 entry: [ "string", null, PARSE_LIST ],
2819 loadfile: [ "string" ]
2822 if (ipset === false) {
2823 this.warn_section(data, "skipped due to invalid options");
2826 else if (!ipset.enabled) {
2827 this.warn_section(data, "is disabled, ignoring section");
2831 if (ipset.family == 0) {
2832 this.warn_section(data, "must not specify family 'any'");
2835 else if (!length(ipset.match)) {
2836 this.warn_section(data, "has no datatypes assigned");
2840 let dirs = map(ipset.match, m => m[0]),
2841 types = map(ipset.match, m => m[1]),
2844 if ("set" in types) {
2845 this.warn_section(data, "match type 'set' is not supported");
2849 if ("net" in types) {
2850 if (this.kernel < 0x05060000) {
2851 this.warn_section(data, "match type 'net' requires kernel 5.6 or later");
2863 types: map(types, (t) => {
2867 return (ipset.family == 4) ? 'ipv4_addr' : 'ipv6_addr';
2870 return 'ether_addr';
2873 return 'inet_service';
2882 s.entries = filter(map(ipset.entry, (e) => {
2883 let v = self.parse_ipsetentry(e, s);
2886 self.warn_section(data, "ignoring invalid ipset entry '" + e + "'");
2889 }), (e) => (e != null));
2891 this.state.ipsets = this.state.ipsets || [];
2892 push(this.state.ipsets, s);