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 + "'");
645 parse_subnet: function(subnet) {
646 let parts = split(subnet, "/");
649 switch (length(parts)) {
651 a = iptoarr(parts[0]);
652 m = iptoarr(parts[1]);
658 if (length(a) != length(m))
661 b = to_bits(parts[1]);
671 if (type(b) != "int")
674 m = to_mask(b, length(a) == 16);
678 family: (length(a) == 16) ? 6 : 4,
685 parts = split(parts[0], "-");
687 switch (length(parts)) {
689 a = iptoarr(parts[0]);
690 b = iptoarr(parts[1]);
692 if (a && b && length(a) == length(b)) {
694 family: (length(a) == 16) ? 6 : 4,
704 a = iptoarr(parts[0]);
708 family: (length(a) == 16) ? 6 : 4,
710 mask: to_mask(length(a) * 8, length(a) == 16),
715 n = this.state.networks[parts[0]];
718 return [ ...(n.ipaddrs || []) ];
725 parse_enum: function(val, choices) {
726 if (type(val) == "string") {
729 for (let i = 0; i < length(choices); i++)
730 if (substr(choices[i], 0, length(val)) == val)
737 section_id: function(sid) {
738 let s = this.get_all(sid);
743 if (s[".anonymous"]) {
746 this.cursor.foreach("firewall", s[".type"], function(ss) {
747 if (ss[".name"] == s[".name"])
753 return sprintf("@%s[%d]", s[".type"], c);
759 warn_section: function(s, msg) {
762 this.warn("Section %s (%s) %s", this.section_id(s[".name"]), s.name, msg);
764 this.warn("Section %s %s", this.section_id(s[".name"]), msg);
768 this.warn("ubus %s (%s) %s", s.type || "rule", s.name, msg);
770 this.warn("ubus %s %s", s.type || "rule", msg);
774 parse_policy: function(val) {
775 return this.parse_enum(val, [
782 parse_bool: function(val) {
783 if (val == "1" || val == "on" || val == "true" || val == "yes")
785 else if (val == "0" || val == "off" || val == "false" || val == "no")
791 parse_family: function(val) {
792 if (val == 'any' || val == 'all' || val == '*')
794 else if (val == 'inet' || index(val, '4') > -1)
796 else if (index(val, '6') > -1)
802 parse_zone_ref: function(val) {
807 return { any: true };
809 for (let zone in this.state.zones) {
810 if (zone.name == val) {
821 parse_device: function(val) {
822 let rv = this.parse_invert(val);
835 parse_direction: function(val) {
836 if (val == 'in' || val == 'ingress')
838 else if (val == 'out' || val == 'egress')
844 parse_setmatch: function(val) {
845 let rv = this.parse_invert(val);
850 rv.val = trim(replace(rv.val, /^[^ \t]+/, function(m) {
855 let dir = split(rv.val, /[ \t,]/);
857 for (let i = 0; i < 3 && i < length(dir); i++) {
858 if (dir[i] == "dst" || dir[i] == "dest") {
859 rv.dir = rv.dir || [];
862 else if (dir[i] == "src") {
863 rv.dir = rv.dir || [];
868 return length(rv.name) ? rv : null;
871 parse_cthelper: function(val) {
872 let rv = this.parse_invert(val);
877 let helper = filter(this.state.helpers, h => (h.name == rv.val))[0];
879 return helper ? { ...rv, ...helper } : null;
882 parse_protocol: function(val) {
883 let p = this.parse_invert(val);
905 p.name = 'ipv6-icmp';
910 { invert: p.invert, name: 'tcp' },
911 { invert: p.invert, name: 'udp' }
926 return (p.any || length(p.name)) ? p : null;
929 parse_mac: function(val) {
930 let mac = this.parse_invert(val);
931 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;
936 mac.mac = sprintf('%02x:%02x:%02x:%02x:%02x:%02x',
937 hex(m[1]), hex(m[2]), hex(m[3]),
938 hex(m[4]), hex(m[5]), hex(m[6]));
943 parse_port: function(val) {
944 let port = this.parse_invert(val);
945 let m = port ? match(port.val, /^([0-9]{1,5})([-:]([0-9]{1,5}))?$/i) : null;
951 let min_port = +m[1];
952 let max_port = +m[3];
954 if (min_port > max_port ||
955 min_port < 0 || max_port < 0 ||
956 min_port > 65535 || max_port > 65535)
965 if (pn != pn || pn < 0 || pn > 65535)
975 parse_network: function(val) {
976 let rv = this.parse_invert(val);
981 let nets = this.parse_subnet(rv.val);
987 rv.addrs = [ ...nets ];
992 parse_icmptype: function(val) {
995 if (exists(ipv4_icmptypes, val)) {
998 rv.type = ipv4_icmptypes[val][0];
999 rv.code_min = ipv4_icmptypes[val][1];
1000 rv.code_max = ipv4_icmptypes[val][2];
1003 if (exists(ipv6_icmptypes, val)) {
1004 rv.family = rv.family ? 0 : 6;
1006 rv.type6 = ipv6_icmptypes[val][0];
1007 rv.code6_min = ipv6_icmptypes[val][1];
1008 rv.code6_max = ipv6_icmptypes[val][2];
1011 if (!exists(rv, "family")) {
1012 let m = match(val, /^([0-9]+)(\/([0-9]+))?$/);
1019 rv.code_min = +m[3];
1020 rv.code_max = rv.code_min;
1028 if (rv.type > 0xFF || rv.code_min > 0xFF || rv.code_max > 0xFF)
1034 rv.code6_min = rv.code_min;
1035 rv.code6_max = rv.code_max;
1041 parse_invert: function(val) {
1045 let rv = { invert: false };
1047 rv.val = trim(replace(val, /^[ \t]*!/, () => (rv.invert = true, '')));
1049 return length(rv.val) ? rv : null;
1052 parse_limit: function(val) {
1053 let rv = this.parse_invert(val);
1054 let m = rv ? match(rv.val, /^([0-9]+)(\/([a-z]+))?$/) : null;
1060 let u = m[3] ? this.parse_enum(m[3], [ "second", "minute", "hour", "day" ]) : "second";
1071 parse_int: function(val) {
1074 return (n == n) ? n : null;
1077 parse_date: function(val) {
1078 let m = match(val, /^([0-9-]+)T([0-9:]+)$/);
1079 let d = m ? match(m[1], /^([0-9]{1,4})(-([0-9]{1,2})(-([0-9]{1,2}))?)?$/) : null;
1080 let t = this.parse_time(m[2]);
1085 if (d == null || d[1] < 1970 || d[1] > 2038 || d[3] < 1 || d[3] > 12 || d[5] < 1 || d[5] > 31)
1095 hour: t ? +t[1] : 0,
1101 parse_time: function(val) {
1102 let t = match(val, /^([0-9]{1,2})(:([0-9]{1,2})(:([0-9]{1,2}))?)?$/);
1104 if (t == null || t[1] > 23 || t[3] > 59 || t[5] > 59)
1114 parse_weekdays: function(val) {
1115 let rv = this.parse_invert(val);
1120 for (let day in to_array(rv.val)) {
1121 day = this.parse_enum(day, [
1134 rv.days = rv.days || {};
1135 rv.days[day] = true;
1138 rv.days = keys(rv.days);
1140 return rv.days ? rv : null;
1143 parse_monthdays: function(val) {
1144 let rv = this.parse_invert(val);
1149 for (let day in to_array(rv.val)) {
1152 if (day < 1 || day > 31)
1155 rv.days = rv.days || [];
1156 rv.days[day] = true;
1159 return rv.days ? rv : null;
1162 parse_mark: function(val) {
1163 let rv = this.parse_invert(val);
1164 let m = rv ? match(rv.val, /^(0?x?[0-9a-f]+)(\/(0?x?[0-9a-f]+))?$/i) : null;
1171 if (n != n || n > 0xFFFFFFFF)
1175 rv.mask = 0xFFFFFFFF;
1180 if (n != n || n > 0xFFFFFFFF)
1189 parse_dscp: function(val) {
1190 let rv = this.parse_invert(val);
1195 rv.val = uc(rv.val);
1197 if (exists(dscp_classes, rv.val)) {
1198 rv.dscp = dscp_classes[rv.val];
1203 if (n != n || n < 0 || n > 0x3F)
1212 parse_target: function(val) {
1213 return this.parse_enum(val, [
1230 parse_reject_code: function(val) {
1231 return this.parse_enum(val, [
1240 parse_reflection_source: function(val) {
1241 return this.parse_enum(val, [
1247 parse_ipsettype: function(val) {
1248 let m = match(val, /^(src|dst|dest)_(.+)$/);
1249 let t = this.parse_enum(m ? m[2] : val, [
1257 return t ? [ (!m || m[1] == 'src') ? 'src' : 'dst', t ] : null;
1260 parse_ipsetentry: function(val, set) {
1261 let values = split(val, /[ \t]+/);
1263 if (length(values) != length(set.types))
1269 for (let i, t in set.types) {
1272 ip = iptoarr(values[i]);
1274 if (length(ip) != 4)
1277 rv[i] = arrtoip(ip);
1281 ip = iptoarr(values[i]);
1283 if (length(ip) != 16)
1286 rv[i] = arrtoip(ip);
1290 mac = this.parse_mac(values[i]);
1292 if (!mac || mac.invert)
1298 case 'inet_service':
1299 port = this.parse_port(values[i]);
1301 if (!port || port.invert || port.min != port.max)
1312 return length(rv) ? rv : null;
1315 parse_string: function(val) {
1319 parse_opt: function(s, opt, fn, defval, flags) {
1323 if (flags & REQUIRED) {
1324 this.warn_section(s, "option '" + opt + "' is mandatory but not set");
1331 if (type(val) == "array") {
1332 this.warn_section(s, "option '" + opt + "' must not be a list");
1335 else if (val == null) {
1339 let res = this[fn](val);
1342 this.warn_section(s, "option '" + opt + "' specifies invalid value '" + val + "'");
1349 parse_list: function(s, opt, fn, defval, flags) {
1354 if (flags & REQUIRED) {
1355 this.warn_section(s, "option '" + opt + "' is mandatory but not set");
1362 for (val in to_array(val)) {
1363 let res = this[fn](val);
1366 this.warn_section(s, "option '" + opt + "' specifies invalid value '" + val + "'");
1370 if (flags & FLATTEN_LIST)
1371 push(rv, ...to_array(res));
1376 return length(rv) ? rv : null;
1379 quote: function(s, force) {
1380 if (force === true || !match(s, /^([0-9A-Fa-f:.\/-]+)( \. [0-9A-Fa-f:.\/-]+)*$/))
1381 return sprintf('"%s"', replace(s + "", /(["\\])/g, '\\$1'));
1388 return sprintf("%s-%s", a.addr, a.addr2);
1390 if ((a.family == 4 && a.bits == 32) ||
1391 (a.family == 6 && a.bits == 128))
1394 return sprintf("%s/%d", apply_mask(a.addr, a.bits), a.bits);
1399 ? sprintf("%s-%s", a.addr, a.addr2)
1400 : apply_mask(a.addr, a.bits);
1405 return sprintf('%d', p.min);
1407 return sprintf('%d-%d', p.min, p.max);
1410 set: function(v, force) {
1413 v = filter(to_array(v), item => !seen[item]++);
1415 if (force || length(v) != 1)
1416 return sprintf('{ %s }', join(', ', map(v, this.quote)));
1418 return this.quote(v[0]);
1421 concat: function(v) {
1422 return join(' . ', to_array(v));
1425 ipproto: function(family) {
1435 nfproto: function(family, human_readable) {
1438 return human_readable ? "IPv4" : "ipv4";
1441 return human_readable ? "IPv6" : "ipv6";
1444 return human_readable ? "IPv4/IPv6" : null;
1448 datetime: function(stamp) {
1449 return sprintf('"%04d-%02d-%02d %02d:%02d:%02d"',
1450 stamp.year, stamp.month, stamp.day,
1451 stamp.hour, stamp.min, stamp.sec);
1454 date: function(stamp) {
1455 return sprintf('"%04d-%02d-%02d"', stamp.year, stamp.month, stamp.day);
1458 time: function(stamp) {
1459 return sprintf('"%02d:%02d:%02d"', stamp.hour, stamp.min, stamp.sec);
1463 return sprintf('0x%x', n);
1466 is_loopback_dev: function(dev) {
1467 let fd = fs.open(sprintf("/sys/class/net/%s/flags", dev), "r");
1472 let flags = +fd.read("line");
1476 return !!(flags & 0x8);
1479 is_loopback_addr: function(addr) {
1480 return (index(addr, "127.") == 0 || addr == "::1" || addr == "::1/128");
1483 filter_loopback_devs: function(devs, invert) {
1485 return filter(devs, d => (self.is_loopback_dev(d) == invert));
1488 filter_loopback_addrs: function(addrs, invert) {
1490 return filter(addrs, a => (self.is_loopback_addr(a) == invert));
1494 input_policy: function(reject_as_drop) {
1495 return (!reject_as_drop || this.state.defaults.input != 'reject') ? this.state.defaults.input : 'drop';
1498 output_policy: function(reject_as_drop) {
1499 return (!reject_as_drop || this.state.defaults.output != 'reject') ? this.state.defaults.output : 'drop';
1502 forward_policy: function(reject_as_drop) {
1503 return (!reject_as_drop || this.state.defaults.forward != 'reject') ? this.state.defaults.forward : 'drop';
1506 default_option: function(flag) {
1507 return this.state.defaults[flag];
1510 helpers: function() {
1511 return this.state.helpers;
1515 return this.state.zones;
1518 rules: function(chain) {
1519 return filter(this.state.rules, r => (r.chain == chain));
1522 redirects: function(chain) {
1523 return filter(this.state.redirects, r => (r.chain == chain));
1526 ipsets: function() {
1527 return this.state.ipsets;
1530 parse_setfile: function(set, cb) {
1531 let fd = fs.open(set.loadfile, "r");
1534 warn(sprintf("Unable to load file '%s' for set '%s': %s\n",
1535 set.loadfile, set.name, fs.error()));
1539 let line = null, count = 0;
1541 while ((line = fd.read("line")) !== "") {
1544 if (length(line) == 0 || ord(line) == 35)
1547 let v = this.parse_ipsetentry(line, set);
1550 this.warn("Skipping invalid entry '%s' in file '%s' for set '%s'",
1551 line, set.loadfile, set.name);
1565 print_setentries: function(set) {
1567 let printer = (entry) => {
1569 print("\t\telements = {\n");
1573 print("\t\t\t", join(" . ", entry), ",\n");
1576 map(set.entries, printer);
1579 this.parse_setfile(set, printer);
1585 parse_helper: function(data) {
1586 let helper = this.parse_options(data, {
1587 name: [ "string", null, REQUIRED ],
1588 description: [ "string" ],
1589 module: [ "string" ],
1590 family: [ "family" ],
1591 proto: [ "protocol", null, PARSE_LIST | FLATTEN_LIST | NO_INVERT ],
1592 port: [ "port", null, NO_INVERT ]
1595 if (helper === false) {
1596 this.warn("Helper definition '%s' skipped due to invalid options", data.name || data['.name']);
1599 else if (helper.proto.any) {
1600 this.warn("Helper definition '%s' must not specify wildcard protocol", data.name || data['.name']);
1603 else if (length(helper.proto) > 1) {
1604 this.warn("Helper definition '%s' must not specify multiple protocols", data.name || data['.name']);
1608 helper.available = ((fs.stat("/sys/module/" + helper.module) || {}).type == "directory");
1610 this.state.helpers = this.state.helpers || [];
1611 push(this.state.helpers, helper);
1614 parse_defaults: function(data) {
1615 if (this.state.defaults) {
1616 this.warn_section(data, ": ignoring duplicate defaults section");
1620 let defs = this.parse_options(data, {
1621 input: [ "policy", "drop" ],
1622 output: [ "policy", "drop" ],
1623 forward: [ "policy", "drop" ],
1625 drop_invalid: [ "bool" ],
1626 tcp_reject_code: [ "reject_code", "tcp-reset" ],
1627 any_reject_code: [ "reject_code", "port-unreachable" ],
1629 syn_flood: [ "bool" ],
1630 synflood_protect: [ "bool" ],
1631 synflood_rate: [ "limit", "25/second" ],
1632 synflood_burst: [ "int", "50" ],
1634 tcp_syncookies: [ "bool", "1" ],
1636 tcp_window_scaling: [ "bool", "1" ],
1638 accept_redirects: [ "bool" ],
1639 accept_source_route: [ "bool" ],
1641 auto_helper: [ "bool", "1" ],
1642 custom_chains: [ "bool", null, UNSUPPORTED ],
1643 disable_ipv6: [ "bool", null, UNSUPPORTED ],
1644 flow_offloading: [ "bool", "0" ],
1645 flow_offloading_hw: [ "bool", "0" ]
1648 if (defs.synflood_protect === null)
1649 defs.synflood_protect = defs.syn_flood;
1651 delete defs.syn_flood;
1653 this.state.defaults = defs;
1656 parse_zone: function(data) {
1657 let zone = this.parse_options(data, {
1658 enabled: [ "bool", "1" ],
1660 name: [ "string", null, REQUIRED ],
1661 family: [ "family" ],
1663 network: [ "device", null, PARSE_LIST ],
1664 device: [ "device", null, PARSE_LIST ],
1665 subnet: [ "network", null, PARSE_LIST ],
1667 input: [ "policy", this.state.defaults ? this.state.defaults.input : "drop" ],
1668 output: [ "policy", this.state.defaults ? this.state.defaults.output : "drop" ],
1669 forward: [ "policy", this.state.defaults ? this.state.defaults.forward : "drop" ],
1672 masq_allow_invalid: [ "bool" ],
1673 masq_src: [ "network", null, PARSE_LIST ],
1674 masq_dest: [ "network", null, PARSE_LIST ],
1676 extra: [ "string", null, UNSUPPORTED ],
1677 extra_src: [ "string", null, UNSUPPORTED ],
1678 extra_dest: [ "string", null, UNSUPPORTED ],
1680 mtu_fix: [ "bool" ],
1681 custom_chains: [ "bool", null, UNSUPPORTED ],
1684 log_limit: [ "limit", null, UNSUPPORTED ],
1686 auto_helper: [ "bool", "1" ],
1687 helper: [ "cthelper", null, PARSE_LIST ],
1689 counter: [ "bool", "1" ]
1692 if (zone === false) {
1693 this.warn_section(data, "skipped due to invalid options");
1696 else if (!zone.enabled) {
1697 this.warn_section(data, "is disabled, ignoring section");
1700 else if (zone.helper && !zone.helper.available) {
1701 this.warn_section(data, "uses unavailable ct helper '" + zone.helper.name + "', ignoring section");
1705 if (zone.mtu_fix && this.kernel < 0x040a0000) {
1706 this.warn_section(data, "option 'mtu_fix' requires kernel 4.10 or later");
1710 if (this.state.defaults && this.state.defaults.auto_helper === false)
1711 zone.auto_helper = false;
1713 let match_devices = [];
1714 let related_subnets = [];
1715 let match_subnets, masq_src_subnets, masq_dest_subnets;
1717 for (let e in to_array(zone.network)) {
1718 if (exists(this.state.networks, e.device)) {
1719 let net = this.state.networks[e.device];
1722 push(match_devices, {
1728 push(related_subnets, ...(net.ipaddrs || []));
1732 push(match_devices, ...to_array(zone.device));
1734 match_subnets = subnets_split_af(zone.subnet);
1735 masq_src_subnets = subnets_split_af(zone.masq_src);
1736 masq_dest_subnets = subnets_split_af(zone.masq_dest);
1738 push(related_subnets, ...(match_subnets[0] || []), ...(match_subnets[1] || []));
1740 let match_rules = [];
1742 let add_rule = (family, devices, subnets, zone) => {
1747 r.devices_pos = map(filter_pos(devices), d => d.device);
1748 r.devices_neg = map(filter_neg(devices), d => d.device);
1750 r.subnets_pos = map(filter_pos(subnets), this.cidr);
1751 r.subnets_neg = map(filter_neg(subnets), this.cidr);
1753 push(match_rules, r);
1756 let family = infer_family(zone.family, [
1757 zone.helper, "ct helper"
1760 // check if there's no AF specific bits, in this case we can do AF agnostic matching
1761 if (!family && length(match_devices) && !length(match_subnets[0]) && !length(match_subnets[1])) {
1762 add_rule(0, match_devices, null, zone);
1765 // we need to emit one or two AF specific rules
1767 if (family_is_ipv4(zone) && (length(match_devices) || length(match_subnets[0])))
1768 add_rule(4, match_devices, match_subnets[0], zone);
1770 if (family_is_ipv6(zone) && (length(match_devices) || length(match_subnets[1])))
1771 add_rule(6, match_devices, match_subnets[1], zone);
1774 zone.match_rules = match_rules;
1776 if (masq_src_subnets[0]) {
1777 zone.masq4_src_pos = map(filter_pos(masq_src_subnets[0]), this.cidr);
1778 zone.masq4_src_neg = map(filter_neg(masq_src_subnets[0]), this.cidr);
1781 if (masq_src_subnets[1]) {
1782 zone.masq6_src_pos = map(filter_pos(masq_src_subnets[1]), this.cidr);
1783 zone.masq6_src_neg = map(filter_neg(masq_src_subnets[1]), this.cidr);
1786 if (masq_dest_subnets[0]) {
1787 zone.masq4_dest_pos = map(filter_pos(masq_dest_subnets[0]), this.cidr);
1788 zone.masq4_dest_neg = map(filter_neg(masq_dest_subnets[0]), this.cidr);
1791 if (masq_dest_subnets[1]) {
1792 zone.masq6_dest_pos = map(filter_pos(masq_dest_subnets[1]), this.cidr);
1793 zone.masq6_dest_neg = map(filter_neg(masq_dest_subnets[1]), this.cidr);
1797 zone.sflags[zone.input] = true;
1800 zone.dflags[zone.output] = true;
1801 zone.dflags[zone.forward] = true;
1803 zone.match_devices = map(filter(match_devices, d => !d.invert), d => d.device);
1804 zone.match_subnets = map(filter(related_subnets, s => !s.invert), this.cidr);
1806 zone.related_subnets = related_subnets;
1808 if (zone.masq || zone.masq6)
1809 zone.dflags.snat = true;
1811 if ((zone.auto_helper && !(zone.masq || zone.masq6)) || length(zone.helper)) {
1812 zone.dflags.helper = true;
1814 for (let helper in (length(zone.helper) ? zone.helper : this.state.helpers)) {
1815 if (!helper.available)
1818 for (let proto in helper.proto) {
1819 this.state.rules = this.state.rules || [];
1820 push(this.state.rules, {
1821 chain: "helper_" + zone.name,
1822 family: helper.family,
1823 name: helper.description || helper.name,
1826 dports_pos: [ this.port(helper.port) ],
1834 this.state.zones = this.state.zones || [];
1835 push(this.state.zones, zone);
1838 parse_forwarding: function(data) {
1839 let fwd = this.parse_options(data, {
1840 enabled: [ "bool", "1" ],
1843 family: [ "family" ],
1845 src: [ "zone_ref", null, REQUIRED ],
1846 dest: [ "zone_ref", null, REQUIRED ]
1849 if (fwd === false) {
1850 this.warn_section(data, "skipped due to invalid options");
1853 else if (!fwd.enabled) {
1854 this.warn_section(data, "is disabled, ignoring section");
1858 let add_rule = (family, fwd) => {
1863 proto: { any: true }
1866 f.name = fwd.name || sprintf("Accept %s to %s forwarding",
1867 fwd.src.any ? "any" : fwd.src.zone.name,
1868 fwd.dest.any ? "any" : fwd.dest.zone.name);
1870 f.chain = fwd.src.any ? "forward" : sprintf("forward_%s", fwd.src.zone.name);
1873 f.target = "accept";
1875 f.jump_chain = sprintf("accept_to_%s", fwd.dest.zone.name);
1877 this.state.rules = this.state.rules || [];
1878 push(this.state.rules, f);
1882 let family = fwd.family;
1884 /* inherit family restrictions from related zones */
1885 if (family === 0 || family === null) {
1886 let f1 = fwd.src.zone ? fwd.src.zone.family : 0;
1887 let f2 = fwd.dest.zone ? fwd.dest.zone.family : 0;
1889 if (f1 != 0 && f2 != 0 && f1 != f2) {
1890 this.warn_section(data,
1891 sprintf("references src %s restricted to %s and dest restricted to %s, ignoring forwarding",
1892 fwd.src.zone.name, this.nfproto(f1, true),
1893 fwd.dest.zone.name, this.nfproto(f2, true)));
1898 this.warn_section(data,
1899 sprintf("inheriting %s restriction from src %s",
1900 this.nfproto(f1, true), fwd.src.zone.name));
1905 this.warn_section(data,
1906 sprintf("inheriting %s restriction from dest %s",
1907 this.nfproto(f2, true), fwd.dest.zone.name));
1913 add_rule(family, fwd);
1916 fwd.dest.zone.dflags.accept = true;
1919 parse_rule: function(data) {
1920 let rule = this.parse_options(data, {
1921 enabled: [ "bool", "1" ],
1923 name: [ "string", this.section_id(data[".name"]) ],
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 family: [ "family", "4" ],
2206 src: [ "zone_ref" ],
2207 dest: [ "zone_ref" ],
2209 ipset: [ "setmatch" ],
2210 helper: [ "cthelper", null, NO_INVERT ],
2212 proto: [ "protocol", "tcpudp", PARSE_LIST | FLATTEN_LIST ],
2214 src_ip: [ "network" ],
2215 src_mac: [ "mac", null, PARSE_LIST ],
2216 src_port: [ "port" ],
2218 src_dip: [ "network" ],
2219 src_dport: [ "port" ],
2221 dest_ip: [ "network" ],
2222 dest_port: [ "port" ],
2224 extra: [ "string", null, UNSUPPORTED ],
2227 limit_burst: [ "int" ],
2229 utc_time: [ "bool" ],
2230 start_date: [ "date" ],
2231 stop_date: [ "date" ],
2232 start_time: [ "time" ],
2233 stop_time: [ "time" ],
2234 weekdays: [ "weekdays" ],
2235 monthdays: [ "monthdays", null, UNSUPPORTED ],
2239 reflection: [ "bool", "1" ],
2240 reflection_src: [ "reflection_source", "internal" ],
2242 reflection_zone: [ "zone_ref", null, PARSE_LIST ],
2244 counter: [ "bool", "1" ],
2246 target: [ "target", "dnat" ]
2249 if (redir === false) {
2250 this.warn_section(data, "skipped due to invalid options");
2253 else if (!redir.enabled) {
2254 this.warn_section(data, "is disabled, ignoring section");
2258 if (!(redir.target in ["dnat", "snat"])) {
2259 this.warn_section(data, "has invalid target specified, defaulting to dnat");
2260 redir.target = "dnat";
2266 ipset = filter(this.state.ipsets, s => (s.name == redir.ipset.name))[0];
2269 this.warn_section(data, "references unknown set '" + redir.ipset.name + "'");
2273 if (('inet_service' in ipset.types) && !ensure_tcpudp(redir.proto)) {
2274 this.warn_section(data, "references named set with port match but no UDP/TCP protocol, ignoring section");
2279 let resolve_dest = (redir) => {
2280 for (let zone in this.state.zones) {
2281 for (let addr in zone.related_subnets) {
2282 if (redir.dest_ip.family != addr.family)
2285 let a = apply_mask(redir.dest_ip.addr, addr.bits);
2286 let b = apply_mask(addr.addr, addr.bits);
2303 if (redir.target == "dnat") {
2305 return this.warn_section(r, "has no source specified");
2306 else if (redir.src.any)
2307 return this.warn_section(r, "must not have source '*' for dnat target");
2308 else if (redir.dest_ip && redir.dest_ip.invert)
2309 return this.warn_section(r, "must not specify a negated 'dest_ip' value");
2311 if (!redir.dest && redir.dest_ip && resolve_dest(redir))
2312 this.warn_section(r, "does not specify a destination, assuming '" + redir.dest.zone.name + "'");
2314 if (!redir.dest_port)
2315 redir.dest_port = redir.src_dport;
2317 if (redir.reflection && redir.dest && redir.dest.zone && redir.src.zone.masq) {
2318 redir.dest.zone.dflags.accept = true;
2319 redir.dest.zone.dflags.dnat = true;
2320 redir.dest.zone.dflags.snat = true;
2324 redir.src.zone.dflags.helper = true;
2326 redir.src.zone.dflags[redir.target] = true;
2330 return this.warn_section(data, "has no destination specified");
2331 else if (redir.dest.any)
2332 return this.warn_section(data, "must not have destination '*' for snat target");
2333 else if (!redir.src_dip)
2334 return this.warn_section(data, "has no 'src_dip' option specified");
2335 else if (redir.src_dip.invert)
2336 return this.warn_section(data, "must not specify a negated 'src_dip' value");
2337 else if (redir.src_mac)
2338 return this.warn_section(data, "must not use 'src_mac' option for snat target");
2339 else if (redir.helper)
2340 return this.warn_section(data, "must not use 'helper' option for snat target");
2342 redir.dest.zone.dflags[redir.target] = true;
2346 let add_rule = (family, proto, saddrs, daddrs, raddrs, sport, dport, rport, ipset, redir) => {
2352 has_addrs: !!(length(saddrs) || length(daddrs)),
2353 has_ports: !!(sport || dport || rport),
2354 saddrs_pos: map(filter_pos(saddrs), this.cidr),
2355 saddrs_neg: map(filter_neg(saddrs), this.cidr),
2356 daddrs_pos: map(filter_pos(daddrs), this.cidr),
2357 daddrs_neg: map(filter_neg(daddrs), this.cidr),
2358 sports_pos: map(filter_pos(to_array(sport)), this.port),
2359 sports_neg: map(filter_neg(to_array(sport)), this.port),
2360 dports_pos: map(filter_pos(to_array(dport)), this.port),
2361 dports_neg: map(filter_neg(to_array(dport)), this.port),
2362 smacs_pos: map(filter_pos(redir.src_mac), m => m.mac),
2363 smacs_neg: map(filter_neg(redir.src_mac), m => m.mac),
2365 raddr: raddrs ? raddrs[0] : null,
2369 let set_types = map_setmatch(ipset, redir.ipset, proto.name);
2371 if (set_types !== set_types) {
2372 this.warn_section(data, "destination MAC address matching not supported");
2374 } else if (set_types) {
2375 r.ipset = { ...r.ipset, fields: set_types };
2380 r.chain = sprintf("dstnat_%s", r.src.zone.name);
2383 r.target = "redirect";
2388 r.chain = sprintf("srcnat_%s", r.dest.zone.name);
2392 this.state.redirects = this.state.redirects || [];
2393 push(this.state.redirects, r);
2396 let to_hostaddr = (a) => {
2397 let bits = (a.family == 4) ? 32 : 128;
2401 addr: apply_mask(a.addr, bits),
2406 for (let proto in redir.proto) {
2407 let sip, dip, rip, iip, eip, refip, sport, dport, rport;
2408 let family = redir.family;
2410 if (proto.name == "ipv6-icmp")
2413 family = infer_family(family, [
2415 redir.src, "source zone",
2416 redir.dest, "destination zone",
2417 redir.helper, "helper match"
2420 if (type(family) == "string") {
2421 this.warn_section(data, family + ", skipping");
2425 switch (redir.target) {
2427 sip = subnets_split_af(redir.src_ip);
2428 dip = subnets_split_af(redir.src_dip);
2429 rip = subnets_split_af(redir.dest_ip);
2431 switch (proto.name) {
2434 sport = redir.src_port;
2435 dport = redir.src_dport;
2436 rport = redir.dest_port;
2440 /* build reflection rules */
2441 if (redir.reflection && (length(rip[0]) || length(rip[1])) &&
2442 redir.src && redir.src.zone && redir.src.zone[family == 4 ? "masq" : "masq6"] &&
2443 redir.dest && redir.dest.zone) {
2446 name: redir.name + " (reflection)",
2448 helper: redir.helper,
2450 // XXX: this likely makes no sense for reflection rules
2451 //src_mac: redir.src_mac,
2454 limit_burst: redir.limit_burst,
2456 start_date: redir.start_date,
2457 stop_date: redir.stop_date,
2458 start_time: redir.start_time,
2459 stop_time: redir.stop_time,
2460 weekdays: redir.weekdays,
2465 let eaddrs = subnets_split_af(length(dip) ? dip : { addrs: redir.src.zone.related_subnets });
2466 let rzones = length(redir.reflection_zone) ? redir.reflection_zone : [ redir.dest ];
2468 for (let rzone in rzones) {
2469 if (!is_family(rzone, family)) {
2470 this.warn_section(data,
2471 sprintf("is restricted to IPv%d but referenced reflection zone is IPv%d only, skipping",
2472 family, rzone.family));
2476 let iaddrs = subnets_split_af({ addrs: rzone.zone.related_subnets });
2477 let refaddrs = (redir.reflection_src == "internal") ? iaddrs : eaddrs;
2480 map(refaddrs[0], to_hostaddr),
2481 map(refaddrs[1], to_hostaddr)
2485 map(eaddrs[0], to_hostaddr),
2486 map(eaddrs[1], to_hostaddr)
2489 for (let i = 0; i <= 1; i++) {
2490 if (length(rip[i])) {
2491 refredir.src = rzone;
2492 refredir.dest = null;
2493 refredir.target = "dnat";
2494 add_rule(i ? 6 : 4, proto, iaddrs[i], eaddrs[i], rip[i], sport, dport, rport, null, refredir);
2496 for (let refaddr in refaddrs[i]) {
2497 refredir.src = null;
2498 refredir.dest = rzone;
2499 refredir.target = "snat";
2500 add_rule(i ? 6 : 4, proto, iaddrs[i], rip[i], [ refaddr ], null, rport, null, null, refredir);
2511 sip = subnets_split_af(redir.src_ip);
2512 dip = subnets_split_af(redir.dest_ip);
2513 rip = subnets_split_af(redir.src_dip);
2515 switch (proto.name) {
2518 sport = redir.src_port;
2519 dport = redir.dest_port;
2520 rport = redir.src_dport;
2527 if (length(rip[0]) > 1 || length(rip[1]) > 1)
2528 this.warn_section(data, "specifies multiple rewrite addresses, using only first one");
2530 /* check if there's no AF specific bits, in this case we can do an AF agnostic rule */
2531 if (!family && !length(sip[0]) && !length(sip[1]) && !length(dip[0]) && !length(dip[1]) && !length(rip[0]) && !length(rip[1])) {
2532 add_rule(0, proto, null, null, null, sport, dport, rport, null, redir);
2535 /* we need to emit one or two AF specific rules */
2537 if (family == 0 || family == 4)
2538 add_rule(4, proto, sip[0], dip[0], rip[0], sport, dport, rport, ipset, redir);
2540 if (family == 0 || family == 6)
2541 add_rule(6, proto, sip[1], dip[1], rip[1], sport, dport, rport, ipset, redir);
2546 parse_nat: function(data) {
2547 let snat = this.parse_options(data, {
2548 enabled: [ "bool", "1" ],
2550 name: [ "string", this.section_id(data[".name"]) ],
2551 family: [ "family", "4" ],
2553 src: [ "zone_ref" ],
2554 device: [ "string" ],
2556 ipset: [ "setmatch", null, UNSUPPORTED ],
2558 proto: [ "protocol", "all", PARSE_LIST | FLATTEN_LIST ],
2560 src_ip: [ "network" ],
2561 src_port: [ "port" ],
2563 snat_ip: [ "network", null, NO_INVERT ],
2564 snat_port: [ "port", null, NO_INVERT ],
2566 dest_ip: [ "network" ],
2567 dest_port: [ "port" ],
2569 extra: [ "string", null, UNSUPPORTED ],
2572 limit_burst: [ "int" ],
2574 connlimit_ports: [ "bool" ],
2576 utc_time: [ "bool" ],
2577 start_date: [ "date" ],
2578 stop_date: [ "date" ],
2579 start_time: [ "time" ],
2580 stop_time: [ "time" ],
2581 weekdays: [ "weekdays" ],
2582 monthdays: [ "monthdays", null, UNSUPPORTED ],
2586 target: [ "target", "masquerade" ]
2589 if (snat === false) {
2590 this.warn_section(data, "skipped due to invalid options");
2593 else if (!snat.enabled) {
2594 this.warn_section(data, "is disabled, ignoring section");
2598 if (!(snat.target in ["accept", "snat", "masquerade"])) {
2599 this.warn_section(data, "has invalid target specified, defaulting to masquerade");
2600 snat.target = "masquerade";
2603 if (snat.target == "snat" && !snat.snat_ip && !snat.snat_port) {
2604 this.warn_section(data, "needs either 'snat_ip' or 'snat_port' for target snat, ignoring section");
2607 else if (snat.target != "snat" && snat.snat_ip) {
2608 this.warn_section(data, "must not use 'snat_ip' for non-snat target, ignoring section");
2611 else if (snat.target != "snat" && snat.snat_port) {
2612 this.warn_section(data, "must not use 'snat_port' for non-snat target, ignoring section");
2616 if ((snat.snat_port || snat.src_port || snat.dest_port) && !ensure_tcpudp(snat.proto)) {
2617 this.warn_section(data, "specifies ports but no UDP/TCP protocol, ignoring section");
2621 if (snat.src && snat.src.zone)
2622 snat.src.zone.dflags.snat = true;
2624 let add_rule = (family, proto, saddrs, daddrs, raddrs, sport, dport, rport, snat) => {
2630 has_addrs: !!(length(saddrs) || length(daddrs) || length(raddrs)),
2631 has_ports: !!(sport || dport),
2632 saddrs_pos: map(filter_pos(saddrs), this.cidr),
2633 saddrs_neg: map(filter_neg(saddrs), this.cidr),
2634 daddrs_pos: map(filter_pos(daddrs), this.cidr),
2635 daddrs_neg: map(filter_neg(daddrs), this.cidr),
2636 sports_pos: map(filter_pos(to_array(sport)), this.port),
2637 sports_neg: map(filter_neg(to_array(sport)), this.port),
2638 dports_pos: map(filter_pos(to_array(dport)), this.port),
2639 dports_neg: map(filter_neg(to_array(dport)), this.port),
2641 raddr: raddrs ? raddrs[0] : null,
2644 chain: (snat.src && snat.src.zone) ? sprintf("srcnat_%s", snat.src.zone.name) : "srcnat"
2647 this.state.redirects = this.state.redirects || [];
2648 push(this.state.redirects, n);
2651 for (let proto in snat.proto) {
2652 let sip, dip, rip, sport, dport, rport;
2653 let family = snat.family;
2655 sip = subnets_split_af(snat.src_ip);
2656 dip = subnets_split_af(snat.dest_ip);
2657 rip = subnets_split_af(snat.snat_ip);
2659 switch (proto.name) {
2662 sport = snat.src_port;
2663 dport = snat.dest_port;
2664 rport = snat.snat_port;
2668 if (length(rip[0]) > 1 || length(rip[1]) > 1)
2669 this.warn_section(data, "specifies multiple rewrite addresses, using only first one");
2671 /* inherit family restrictions from related zones */
2672 if (family === 0 || family === null) {
2673 let f = (rule.src && rule.src.zone) ? rule.src.zone.family : 0;
2676 this.warn_section(r,
2677 sprintf("inheriting %s restriction from src %s",
2678 this.nfproto(f1, true), rule.src.zone.name));
2684 /* if no family was configured, infer target family from IP addresses */
2685 if (family === null) {
2686 if ((length(sip[0]) || length(dip[0]) || length(rip[0])) && !length(sip[1]) && !length(dip[1]) && !length(rip[1]))
2688 else if ((length(sip[1]) || length(dip[1]) || length(rip[1])) && !length(sip[0]) && !length(dip[0]) && !length(rip[0]))
2694 /* check if there's no AF specific bits, in this case we can do an AF agnostic rule */
2695 if (!family && !length(sip[0]) && !length(sip[1]) && !length(dip[0]) && !length(dip[1]) && !length(rip[0]) && !length(rip[1])) {
2696 add_rule(0, proto, null, null, null, sport, dport, rport, snat);
2699 /* we need to emit one or two AF specific rules */
2701 if (family == 0 || family == 4)
2702 add_rule(4, proto, sip[0], dip[0], rip[0], sport, dport, rport, snat);
2704 if (family == 0 || family == 6)
2705 add_rule(6, proto, sip[1], dip[1], rip[1], sport, dport, rport, snat);
2710 parse_ipset: function(data) {
2711 let ipset = this.parse_options(data, {
2712 enabled: [ "bool", "1" ],
2713 reload_set: [ "bool" ],
2714 counters: [ "bool" ],
2715 comment: [ "bool" ],
2717 name: [ "string", null, REQUIRED ],
2718 family: [ "family", "4" ],
2720 storage: [ "string", null, UNSUPPORTED ],
2721 match: [ "ipsettype", null, PARSE_LIST ],
2723 iprange: [ "string", null, UNSUPPORTED ],
2724 portrange: [ "string", null, UNSUPPORTED ],
2726 netmask: [ "int", null, UNSUPPORTED ],
2728 hashsize: [ "int", null, UNSUPPORTED ],
2729 timeout: [ "int", "-1" ],
2731 external: [ "string", null, UNSUPPORTED ],
2733 entry: [ "string", null, PARSE_LIST ],
2734 loadfile: [ "string" ]
2737 if (ipset === false) {
2738 this.warn_section(data, "skipped due to invalid options");
2741 else if (!ipset.enabled) {
2742 this.warn_section(data, "is disabled, ignoring section");
2746 if (ipset.family == 0) {
2747 this.warn_section(data, "must not specify family 'any'");
2750 else if (!length(ipset.match)) {
2751 this.warn_section(data, "has no datatypes assigned");
2755 let dirs = map(ipset.match, m => m[0]),
2756 types = map(ipset.match, m => m[1]),
2759 if ("set" in types) {
2760 this.warn_section(data, "match type 'set' is not supported");
2764 if ("net" in types) {
2765 if (this.kernel < 0x05060000) {
2766 this.warn_section(data, "match type 'net' requires kernel 5.6 or later");
2776 types: map(types, (t) => {
2780 return (ipset.family == 4) ? 'ipv4_addr' : 'ipv6_addr';
2783 return 'ether_addr';
2786 return 'inet_service';
2795 s.entries = filter(map(ipset.entry, (e) => {
2796 let v = self.parse_ipsetentry(e, s);
2799 self.warn_section(data, "ignoring invalid ipset entry '" + e + "'");
2802 }), (e) => (e != null));
2804 this.state.ipsets = this.state.ipsets || [];
2805 push(this.state.ipsets, s);