root/usr/share/ucode/fw4.uc

   1 const fs = require("fs");
   2 const uci = require("uci");
   3 const ubus = require("ubus");
   4
   5 const STATEFILE = "/var/run/fw4.state";
   6
   7 const PARSE_LIST   = 0x01;
   8 const FLATTEN_LIST = 0x02;
   9 const NO_INVERT    = 0x04;
  10 const UNSUPPORTED  = 0x08;
  11 const REQUIRED     = 0x10;
  12 const DEPRECATED   = 0x20;
  13
  14 const ipv4_icmptypes = {
  15         "any": [ 0xFF, 0, 0xFF ],
  16         "echo-reply": [ 0, 0, 0xFF ],
  17         "pong": [ 0, 0, 0xFF ], /* Alias */
  18
  19         "destination-unreachable": [ 3, 0, 0xFF ],
  20         "network-unreachable": [ 3, 0, 0 ],
  21         "host-unreachable": [ 3, 1, 1 ],
  22         "protocol-unreachable": [ 3, 2, 2 ],
  23         "port-unreachable": [ 3, 3, 3 ],
  24         "fragmentation-needed": [ 3, 4, 4 ],
  25         "source-route-failed": [ 3, 5, 5 ],
  26         "network-unknown": [ 3, 6, 6 ],
  27         "host-unknown": [ 3, 7, 7 ],
  28         "network-prohibited": [ 3, 9, 9 ],
  29         "host-prohibited": [ 3, 10, 10 ],
  30         "TOS-network-unreachable": [ 3, 11, 11 ],
  31         "TOS-host-unreachable": [ 3, 12, 12 ],
  32         "communication-prohibited": [ 3, 13, 13 ],
  33         "host-precedence-violation": [ 3, 14, 14 ],
  34         "precedence-cutoff": [ 3, 15, 15 ],
  35
  36         "source-quench": [ 4, 0, 0xFF ],
  37
  38         "redirect": [ 5, 0, 0xFF ],
  39         "network-redirect": [ 5, 0, 0 ],
  40         "host-redirect": [ 5, 1, 1 ],
  41         "TOS-network-redirect": [ 5, 2, 2 ],
  42         "TOS-host-redirect": [ 5, 3, 3 ],
  43
  44         "echo-request": [ 8, 0, 0xFF ],
  45         "ping": [ 8, 0, 0xFF ], /* Alias */
  46
  47         "router-advertisement": [ 9, 0, 0xFF ],
  48
  49         "router-solicitation": [ 10, 0, 0xFF ],
  50
  51         "time-exceeded": [ 11, 0, 0xFF ],
  52         "ttl-exceeded": [ 11, 0, 0xFF ], /* Alias */
  53         "ttl-zero-during-transit": [ 11, 0, 0 ],
  54         "ttl-zero-during-reassembly": [ 11, 1, 1 ],
  55
  56         "parameter-problem": [ 12, 0, 0xFF ],
  57         "ip-header-bad": [ 12, 0, 0 ],
  58         "required-option-missing": [ 12, 1, 1 ],
  59
  60         "timestamp-request": [ 13, 0, 0xFF ],
  61
  62         "timestamp-reply": [ 14, 0, 0xFF ],
  63
  64         "address-mask-request": [ 17, 0, 0xFF ],
  65
  66         "address-mask-reply": [ 18, 0, 0xFF ]
  67 };
  68
  69 const ipv6_icmptypes = {
  70         "destination-unreachable": [ 1, 0, 0xFF ],
  71         "no-route": [ 1, 0, 0 ],
  72         "communication-prohibited": [ 1, 1, 1 ],
  73         "address-unreachable": [ 1, 3, 3 ],
  74         "port-unreachable": [ 1, 4, 4 ],
  75
  76         "packet-too-big": [ 2, 0, 0xFF ],
  77
  78         "time-exceeded": [ 3, 0, 0xFF ],
  79         "ttl-exceeded": [ 3, 0, 0xFF ], /* Alias */
  80         "ttl-zero-during-transit": [ 3, 0, 0 ],
  81         "ttl-zero-during-reassembly": [ 3, 1, 1 ],
  82
  83         "parameter-problem": [ 4, 0, 0xFF ],
  84         "bad-header": [ 4, 0, 0 ],
  85         "unknown-header-type": [ 4, 1, 1 ],
  86         "unknown-option": [ 4, 2, 2 ],
  87
  88         "echo-request": [ 128, 0, 0xFF ],
  89         "ping": [ 128, 0, 0xFF ], /* Alias */
  90
  91         "echo-reply": [ 129, 0, 0xFF ],
  92         "pong": [ 129, 0, 0xFF ], /* Alias */
  93
  94         "router-solicitation": [ 133, 0, 0xFF ],
  95
  96         "router-advertisement": [ 134, 0, 0xFF ],
  97
  98         "neighbour-solicitation": [ 135, 0, 0xFF ],
  99         "neighbor-solicitation": [ 135, 0, 0xFF ], /* Alias */
 100
 101         "neighbour-advertisement": [ 136, 0, 0xFF ],
 102         "neighbor-advertisement": [ 136, 0, 0xFF ], /* Alias */
 103
 104         "redirect": [ 137, 0, 0xFF ]
 105 };
 106
 107 const dscp_classes = {
 108         "CS0": 0x00,
 109         "CS1": 0x08,
 110         "CS2": 0x10,
 111         "CS3": 0x18,
 112         "CS4": 0x20,
 113         "CS5": 0x28,
 114         "CS6": 0x30,
 115         "CS7": 0x38,
 116         "BE": 0x00,
 117         "LE": 0x01,
 118         "AF11": 0x0a,
 119         "AF12": 0x0c,
 120         "AF13": 0x0e,
 121         "AF21": 0x12,
 122         "AF22": 0x14,
 123         "AF23": 0x16,
 124         "AF31": 0x1a,
 125         "AF32": 0x1c,
 126         "AF33": 0x1e,
 127         "AF41": 0x22,
 128         "AF42": 0x24,
 129         "AF43": 0x26,
 130         "EF": 0x2e
 131 };
 132
 133 function to_mask(bits, v6) {
 134         let m = [];
 135
 136         if (bits < 0 || bits > (v6 ? 128 : 32))
 137                 return null;
 138
 139         for (let i = 0; i < (v6 ? 16 : 4); i++) {
 140                 let b = (bits < 8) ? bits : 8;
 141                 m[i] = (0xff << (8 - b)) & 0xff;
 142                 bits -= b;
 143         }
 144
 145         return arrtoip(m);
 146 }
 147
 148 function to_bits(mask) {
 149         let a = iptoarr(mask);
 150
 151         if (!a)
 152                 return null;
 153
 154         let bits = 0;
 155
 156         for (let i = 0, z = false; i < length(a); i++) {
 157                 z ||= !a[i];
 158
 159                 while (!z && (a[i] & 0x80)) {
 160                         a[i] = (a[i] << 1) & 0xff;
 161                         bits++;
 162                 }
 163
 164                 if (a[i])
 165                         return null;
 166         }
 167
 168         return bits;
 169 }
 170
 171 function apply_mask(addr, mask) {
 172         let a = iptoarr(addr);
 173
 174         if (!a)
 175                 return null;
 176
 177         if (type(mask) == "int") {
 178                 for (let i = 0; i < length(a); i++) {
 179                         let b = (mask < 8) ? mask : 8;
 180                         a[i] &= (0xff << (8 - b)) & 0xff;
 181                         mask -= b;
 182                 }
 183         }
 184         else {
 185                 let m = iptoarr(mask);
 186
 187                 if (!m || length(a) != length(m))
 188                         return null;
 189
 190                 for (let i = 0; i < length(a); i++)
 191                         a[i] &= m[i];
 192         }
 193
 194         return arrtoip(a);
 195 }
 196
 197 function to_array(x) {
 198         if (type(x) == "array")
 199                 return x;
 200
 201         if (x == null)
 202                 return [];
 203
 204         if (type(x) == "object")
 205                 return [ x ];
 206
 207         x = trim("" + x);
 208
 209         return (x == "") ? [] : split(x, /[ \t]+/);
 210 }
 211
 212 function filter_pos(x) {
 213         let rv = filter(x, e => !e.invert);
 214         return length(rv) ? rv : null;
 215 }
 216
 217 function filter_neg(x) {
 218         let rv = filter(x, e => e.invert);
 219         return length(rv) ? rv : null;
 220 }
 221
 222 function null_if_empty(x) {
 223         return length(x) ? x : null;
 224 }
 225
 226 function subnets_split_af(x) {
 227         let rv = {};
 228
 229         for (let ag in to_array(x)) {
 230                 for (let a in filter(ag.addrs, a => (a.family == 4)))
 231                         push(rv[0] ||= [], { ...a, invert: ag.invert });
 232
 233                 for (let a in filter(ag.addrs, a => (a.family == 6)))
 234                         push(rv[1] ||= [], { ...a, invert: ag.invert });
 235         }
 236
 237         if (rv[0] || rv[1])
 238                 rv.family = (!rv[0] ^ !rv[1]) ? (rv[0] ? 4 : 6) : 0;
 239
 240         return rv;
 241 }
 242
 243 function subnets_group_by_masking(x) {
 244         let groups = [], plain = [], nc = [], invert_plain = [], invert_masked = [];
 245
 246         for (let a in to_array(x)) {
 247                 if (a.bits == -1 && !a.invert)
 248                         push(nc, a);
 249                 else if (!a.invert)
 250                         push(plain, a);
 251                 else if (a.bits == -1)
 252                         push(invert_masked, a);
 253                 else
 254                         push(invert_plain, a);
 255         }
 256
 257         for (let a in nc)
 258                 push(groups, [ null, null_if_empty(invert_plain), [ a, ...invert_masked ] ]);
 259
 260         if (length(plain)) {
 261                 push(groups, [
 262                         plain,
 263                         null_if_empty(invert_plain),
 264                         null_if_empty(invert_masked)
 265                 ]);
 266         }
 267         else if (!length(groups)) {
 268                 push(groups, [
 269                         null,
 270                         null_if_empty(invert_plain),
 271                         null_if_empty(invert_masked)
 272                 ]);
 273         }
 274
 275         return groups;
 276 }
 277
 278 function ensure_tcpudp(x) {
 279         if (length(filter(x, p => (p.name == "tcp" || p.name == "udp"))))
 280                 return true;
 281
 282         let rest = filter(x, p => !p.any),
 283             any = filter(x, p => p.any);
 284
 285         if (length(any) && !length(rest)) {
 286                 splice(x, 0);
 287                 push(x, { name: "tcp" }, { name: "udp" });
 288                 return true;
 289         }
 290
 291         return false;
 292 }
 293
 294 let is_family = (x, v) => (!x.family || x.family == v);
 295 let family_is_ipv4 = (x) => (!x.family || x.family == 4);
 296 let family_is_ipv6 = (x) => (!x.family || x.family == 6);
 297
 298 function infer_family(f, objects) {
 299         let res = f;
 300         let by = null;
 301
 302         for (let i = 0; i < length(objects); i += 2) {
 303                 let objs = to_array(objects[i]),
 304                     desc = objects[i + 1];
 305
 306                 for (let obj in objs) {
 307                         if (!obj || !obj.family || obj.family == res)
 308                                 continue;
 309
 310                         if (!res) {
 311                                 res = obj.family;
 312                                 by = obj.desc;
 313                                 continue;
 314                         }
 315
 316                         return by
 317                                 ? `references IPv${obj.family} only ${desc} but is restricted to IPv${res} by ${by}`
 318                                 : `is restricted to IPv${res} but referenced ${desc} is IPv${obj.family} only`;
 319                 }
 320         }
 321
 322         return res;
 323 }
 324
 325 function map_setmatch(set, match, proto) {
 326         if (!set || (('inet_service' in set.types) && proto != 'tcp' && proto != 'udp'))
 327                 return null;
 328
 329         let fields = [];
 330
 331         for (let i, t in set.types) {
 332                 let dir = ((match.dir?.[i] || set.directions[i] || 'src') == 'src' ? 's' : 'd');
 333
 334                 switch (t) {
 335                 case 'ipv4_addr':
 336                         fields[i] = `ip ${dir}saddr`;
 337                         break;
 338
 339                 case 'ipv6_addr':
 340                         fields[i] = `ip6 ${dir}saddr`;
 341                         break;
 342
 343                 case 'ether_addr':
 344                         if (dir != 's')
 345                                 return NaN;
 346
 347                         fields[i] = 'ether saddr';
 348                         break;
 349
 350                 case 'inet_service':
 351                         fields[i] = `${proto} ${dir}port`;
 352                         break;
 353                 }
 354         }
 355
 356         return fields;
 357 }
 358
 359 function resolve_lower_devices(devstatus, devname) {
 360         let dir = fs.opendir(`/sys/class/net/${devname}`);
 361         let devs = [];
 362
 363         if (dir) {
 364                 if (!devstatus || devstatus[devname]?.["hw-tc-offload"]) {
 365                         push(devs, devname);
 366                 }
 367                 else {
 368                         let e;
 369
 370                         while ((e = dir.read()) != null)
 371                                 if (index(e, "lower_") === 0)
 372                                         push(devs, ...resolve_lower_devices(devstatus, substr(e, 6)));
 373                 }
 374
 375                 dir.close();
 376         }
 377
 378         return devs;
 379 }
 380
 381 function nft_json_command(...args) {
 382         let cmd = [ "/usr/sbin/nft", "--terse", "--json", ...args ];
 383         let nft = fs.popen(join(" ", cmd), "r");
 384         let info;
 385
 386         if (nft) {
 387                 try {
 388                         info = filter(json(nft.read("all"))?.nftables,
 389                                 item => (type(item) == "object" && !item.metainfo));
 390                 }
 391                 catch (e) {
 392                         warn(`Unable to parse nftables JSON output: ${e}\n`);
 393                 }
 394
 395                 nft.close();
 396         }
 397         else {
 398                 warn(`Unable to popen() ${cmd}: ${fs.error()}\n`);
 399         }
 400
 401         return info || [];
 402 }
 403
 404 function nft_try_hw_offload(devices) {
 405         let nft_test = `
 406                 add table inet fw4-hw-offload-test;
 407                 add flowtable inet fw4-hw-offload-test ft {
 408                         hook ingress priority 0;
 409                         devices = { "${join('", "', devices)}" };
 410                         flags offload;
 411                 }
 412         `;
 413
 414         let rc = system(`/usr/sbin/nft -c '${replace(nft_test, "'", "'\\''")}' 2>/dev/null`);
 415
 416         return (rc == 0);
 417 }
 418
 419
 420 return {
 421         read_kernel_version: function() {
 422                 let fd = fs.open("/proc/version", "r"),
 423                     v = 0;
 424
 425                 if (fd) {
 426                     let m = match(fd.read("line"), /^Linux version ([0-9]+)\.([0-9]+)\.([0-9]+)/);
 427
 428                     v = m ? (+m[1] << 24) | (+m[2] << 16) | (+m[3] << 8) : 0;
 429                     fd.close();
 430                 }
 431
 432                 return v;
 433         },
 434
 435         resolve_offload_devices: function() {
 436                 if (!this.default_option("flow_offloading"))
 437                         return [];
 438
 439                 let devstatus = null;
 440                 let devices = [];
 441
 442                 if (this.default_option("flow_offloading_hw")) {
 443                         let bus = ubus.connect();
 444
 445                         if (bus) {
 446                                 devstatus = bus.call("network.device", "status") || {};
 447                                 bus.disconnect();
 448                         }
 449
 450                         for (let zone in this.zones())
 451                                 for (let device in zone.related_physdevs)
 452                                         push(devices, ...resolve_lower_devices(devstatus, device));
 453
 454                         devices = uniq(devices);
 455
 456                         if (nft_try_hw_offload(devices))
 457                                 return devices;
 458
 459                         this.warn('Hardware flow offloading unavailable, falling back to software offloading');
 460                         this.state.defaults.flow_offloading_hw = false;
 461
 462                         devices = [];
 463                 }
 464
 465                 for (let zone in this.zones())
 466                         for (let device in zone.match_devices)
 467                                 push(devices, ...resolve_lower_devices(null, device));
 468
 469                 return uniq(devices);
 470         },
 471
 472         check_set_types: function() {
 473                 let sets = {};
 474
 475                 for (let item in nft_json_command("list", "sets", "inet"))
 476                         if (item.set?.table == "fw4")
 477                                 sets[item.set.name] = (type(item.set.type) == "array") ? item.set.type : [ item.set.type ];
 478
 479                 return sets;
 480         },
 481
 482         check_flowtable: function() {
 483                 for (let item in nft_json_command("list", "flowtables", "inet"))
 484                         if (item.flowtable?.table == "fw4" && item.flowtable?.name == "ft")
 485                                 return true;
 486
 487                 return false;
 488         },
 489
 490         read_state: function() {
 491                 let fd = fs.open(STATEFILE, "r");
 492                 let state = null;
 493
 494                 if (fd) {
 495                         try {
 496                                 state = json(fd.read("all"));
 497                         }
 498                         catch (e) {
 499                                 warn(`Unable to parse '${STATEFILE}': ${e}\n`);
 500                         }
 501
 502                         fd.close();
 503                 }
 504
 505                 return state;
 506         },
 507
 508         read_ubus: function() {
 509                 let self = this,
 510                     ifaces, services,
 511                     rules = [], networks = {},
 512                     bus = ubus.connect();
 513
 514                 if (bus) {
 515                         ifaces = bus.call("network.interface", "dump");
 516                     services = bus.call("service", "get_data", { "type": "firewall" });
 517
 518                     bus.disconnect();
 519                 }
 520                 else {
 521                         warn(`Unable to connect to ubus: ${ubus.error()}\n`);
 522                 }
 523
 524
 525                 //
 526                 // Gather logical network information from ubus
 527                 //
 528
 529                 if (type(ifaces?.interface) == "array") {
 530                         for (let ifc in ifaces.interface) {
 531                                 let net = {
 532                                         up: ifc.up,
 533                                         device: ifc.l3_device,
 534                                         physdev: ifc.device,
 535                                         zone: ifc.data?.zone
 536                                 };
 537
 538                                 if (type(ifc["ipv4-address"]) == "array") {
 539                                         for (let addr in ifc["ipv4-address"]) {
 540                                                 push(net.ipaddrs ||= [], {
 541                                                         family: 4,
 542                                                         addr: addr.address,
 543                                                         mask: to_mask(addr.mask, false),
 544                                                         bits: addr.mask
 545                                                 });
 546                                         }
 547                                 }
 548
 549                                 if (type(ifc["ipv6-address"]) == "array") {
 550                                         for (let addr in ifc["ipv6-address"]) {
 551                                                 push(net.ipaddrs ||= [], {
 552                                                         family: 6,
 553                                                         addr: addr.address,
 554                                                         mask: to_mask(addr.mask, true),
 555                                                         bits: addr.mask
 556                                                 });
 557                                         }
 558                                 }
 559
 560                                 if (type(ifc["ipv6-prefix-assignment"]) == "array") {
 561                                         for (let addr in ifc["ipv6-prefix-assignment"]) {
 562                                                 if (addr["local-address"]) {
 563                                                         push(net.ipaddrs ||= [], {
 564                                                                 family: 6,
 565                                                                 addr: addr["local-address"].address,
 566                                                                 mask: to_mask(addr["local-address"].mask, true),
 567                                                                 bits: addr["local-address"].mask
 568                                                         });
 569                                                 }
 570                                         }
 571                                 }
 572
 573                                 if (type(ifc.data?.firewall) == "array") {
 574                                         let n = 0;
 575
 576                                         for (let rulespec in ifc.data.firewall) {
 577                                                 push(rules, {
 578                                                         ...rulespec,
 579
 580                                                         name: (rulespec.type != 'ipset') ? `ubus:${ifc.interface}[${ifc.proto}] ${rulespec.type || 'rule'} ${n}` : rulespec.name,
 581                                                         device: rulespec.device || ifc.l3_device
 582                                                 });
 583
 584                                                 n++;
 585                                         }
 586                                 }
 587
 588                                 networks[ifc.interface] = net;
 589                         }
 590                 }
 591
 592
 593                 //
 594                 // Gather firewall rule definitions from ubus services
 595                 //
 596
 597                 if (type(services) == "object") {
 598                         for (let svcname, service in services) {
 599                                 if (type(service?.firewall) == "array") {
 600                                         let n = 0;
 601
 602                                         for (let rulespec in services[svcname].firewall) {
 603                                                 push(rules, {
 604                                                         ...rulespec,
 605
 606                                                         name: (rulespec.type != 'ipset') ? `ubus:${svcname} ${rulespec.type || 'rule'} ${n}` : rulespec.name
 607                                                 });
 608
 609                                                 n++;
 610                                         }
 611                                 }
 612
 613                                 for (let svcinst, instance in service) {
 614                                         if (type(instance?.firewall) == "array") {
 615                                                 let n = 0;
 616
 617                                                 for (let rulespec in instance.firewall) {
 618                                                         push(rules, {
 619                                                                 ...rulespec,
 620
 621                                                                 name: (rulespec.type != 'ipset') ? `ubus:${svcname}[${svcinst}] ${rulespec.type || 'rule'} ${n}` : rulespec.name
 622                                                         });
 623
 624                                                         n++;
 625                                                 }
 626                                         }
 627                                 }
 628                         }
 629                 }
 630
 631                 return {
 632                         networks: networks,
 633                         ubus_rules: rules
 634                 };
 635         },
 636
 637         load: function(use_statefile) {
 638                 let self = this;
 639
 640                 this.state = use_statefile ? this.read_state() : null;
 641
 642                 this.cursor = uci.cursor();
 643                 this.cursor.load("firewall");
 644                 this.cursor.load("/usr/share/firewall4/helpers");
 645
 646                 if (!this.state)
 647                         this.state = this.read_ubus();
 648
 649                 this.kernel = this.read_kernel_version();
 650
 651
 652                 //
 653                 // Read helper mapping
 654                 //
 655
 656                 this.cursor.foreach("helpers", "helper", h => self.parse_helper(h));
 657
 658
 659                 //
 660                 // Read default policies
 661                 //
 662
 663                 this.cursor.foreach("firewall", "defaults", d => self.parse_defaults(d));
 664
 665                 if (!this.state.defaults)
 666                         this.parse_defaults({});
 667
 668
 669                 //
 670                 // Build list of ipsets
 671                 //
 672
 673                 if (!this.state.ipsets) {
 674                         map(filter(this.state.ubus_rules, n => (n.type == "ipset")), s => self.parse_ipset(s));
 675                         this.cursor.foreach("firewall", "ipset", s => self.parse_ipset(s));
 676                 }
 677
 678
 679                 //
 680                 // Build list of logical zones
 681                 //
 682
 683                 if (!this.state.zones)
 684                         this.cursor.foreach("firewall", "zone", z => self.parse_zone(z));
 685
 686
 687                 //
 688                 // Build list of rules
 689                 //
 690
 691                 map(filter(this.state.ubus_rules, r => (r.type == "rule")), r => self.parse_rule(r));
 692                 this.cursor.foreach("firewall", "rule", r => self.parse_rule(r));
 693
 694
 695                 //
 696                 // Build list of forwardings
 697                 //
 698
 699                 this.cursor.foreach("firewall", "forwarding", f => self.parse_forwarding(f));
 700
 701
 702                 //
 703                 // Build list of redirects
 704                 //
 705
 706                 map(filter(this.state.ubus_rules, r => (r.type == "redirect")), r => self.parse_redirect(r));
 707                 this.cursor.foreach("firewall", "redirect", r => self.parse_redirect(r));
 708
 709
 710                 //
 711                 // Build list of snats
 712                 //
 713
 714                 map(filter(this.state.ubus_rules, n => (n.type == "nat")), n => self.parse_nat(n));
 715                 this.cursor.foreach("firewall", "nat", n => self.parse_nat(n));
 716
 717
 718                 if (use_statefile) {
 719                         let fd = fs.open(STATEFILE, "w");
 720
 721                         if (fd) {
 722                                 fd.write({
 723                                         zones: this.state.zones,
 724                                         ipsets: this.state.ipsets,
 725                                         networks: this.state.networks,
 726                                         ubus_rules: this.state.ubus_rules
 727                                 });
 728
 729                                 fd.close();
 730                         }
 731                         else {
 732                                 warn(`Unable to write '${STATEFILE}': ${fs.error()}\n`);
 733                         }
 734                 }
 735         },
 736
 737         warn: function(fmt, ...args) {
 738                 if (getenv("QUIET"))
 739                         return;
 740
 741                 let msg = sprintf(fmt, ...args);
 742
 743                 if (getenv("TTY"))
 744                         warn(`\033[33m${msg}\033[m\n`);
 745                 else
 746                         warn(`[!] ${msg}\n`);
 747         },
 748
 749         get: function(sid, opt) {
 750                 return this.cursor.get("firewall", sid, opt);
 751         },
 752
 753         get_all: function(sid) {
 754                 return this.cursor.get_all("firewall", sid);
 755         },
 756
 757         parse_options: function(s, spec) {
 758                 let rv = {};
 759
 760                 for (let key, val in spec) {
 761                         let datatype = `parse_${val[0]}`,
 762                             defval = val[1],
 763                             flags = val[2] || 0,
 764                             parsefn = (flags & PARSE_LIST) ? "parse_list" : "parse_opt";
 765
 766                         let res = this[parsefn](s, key, datatype, defval, flags);
 767
 768                         if (res !== res)
 769                                 return false;
 770
 771                         if (type(res) == "object" && res.invert && (flags & NO_INVERT)) {
 772                                 this.warn_section(s, `option '${key}' must not be negated`);
 773                                 return false;
 774                         }
 775
 776                         if (res != null) {
 777                                 if (flags & DEPRECATED)
 778                                         this.warn_section(s, `option '${key}' is deprecated by fw4`);
 779                                 else if (flags & UNSUPPORTED)
 780                                         this.warn_section(s, `option '${key}' is not supported by fw4`);
 781                                 else
 782                                         rv[key] = res;
 783                         }
 784                 }
 785
 786                 for (let opt in s) {
 787                         if (index(opt, '.') != 0 && opt != 'type' && !exists(spec, opt)) {
 788                                 this.warn_section(s, `specifies unknown option '${opt}'`);
 789                         }
 790                 }
 791
 792                 return rv;
 793         },
 794
 795         parse_subnet: function(subnet) {
 796                 let parts = split(subnet, "/");
 797                 let a, b, m, n;
 798
 799                 switch (length(parts)) {
 800                 case 2:
 801                         a = iptoarr(parts[0]);
 802                         m = iptoarr(parts[1]);
 803
 804                         if (!a)
 805                                 return null;
 806
 807                         if (m) {
 808                                 if (length(a) != length(m))
 809                                         return null;
 810
 811                                 b = to_bits(parts[1]);
 812
 813                                 /* allow non-contiguous masks such as `::ffff:ffff:ffff:ffff` */
 814                                 if (b == null) {
 815                                         b = -1;
 816
 817                                         for (let i, x in m)
 818                                                 a[i] &= x;
 819                                 }
 820
 821                                 m = arrtoip(m);
 822                         }
 823                         else {
 824                                 b = +parts[1];
 825
 826                                 if (type(b) != "int")
 827                                         return null;
 828
 829                                 m = to_mask(b, length(a) == 16);
 830                         }
 831
 832                         return [{
 833                                 family: (length(a) == 16) ? 6 : 4,
 834                                 addr: arrtoip(a),
 835                                 mask: m,
 836                                 bits: b
 837                         }];
 838
 839                 case 1:
 840                         parts = split(parts[0], "-");
 841
 842                         switch (length(parts)) {
 843                         case 2:
 844                                 a = iptoarr(parts[0]);
 845                                 b = iptoarr(parts[1]);
 846
 847                                 if (a && b && length(a) == length(b)) {
 848                                         return [{
 849                                                 family: (length(a) == 16) ? 6 : 4,
 850                                                 addr: arrtoip(a),
 851                                                 addr2: arrtoip(b),
 852                                                 range: true
 853                                         }];
 854                                 }
 855
 856                                 break;
 857
 858                         case 1:
 859                                 a = iptoarr(parts[0]);
 860
 861                                 if (a) {
 862                                         return [{
 863                                                 family: (length(a) == 16) ? 6 : 4,
 864                                                 addr: arrtoip(a),
 865                                                 mask: to_mask(length(a) * 8, length(a) == 16),
 866                                                 bits: length(a) * 8
 867                                         }];
 868                                 }
 869
 870                                 n = this.state.networks[parts[0]];
 871
 872                                 if (n)
 873                                         return [ ...(n.ipaddrs || []) ];
 874                         }
 875                 }
 876
 877                 return null;
 878         },
 879
 880         parse_enum: function(val, choices) {
 881                 if (type(val) == "string") {
 882                         val = lc(val);
 883
 884                         for (let i = 0; i < length(choices); i++)
 885                                 if (lc(substr(choices[i], 0, length(val))) == val)
 886                                         return choices[i];
 887                 }
 888
 889                 return null;
 890         },
 891
 892         section_id: function(sid) {
 893                 let s = this.get_all(sid);
 894
 895                 if (!s)
 896                         return null;
 897
 898                 if (s[".anonymous"]) {
 899                         let c = 0;
 900
 901                         this.cursor.foreach("firewall", s[".type"], function(ss) {
 902                                 if (ss[".name"] == s[".name"])
 903                                         return false;
 904
 905                                 c++;
 906                         });
 907
 908                         return `@${s['.type']}[${c}]`;
 909                 }
 910
 911                 return s[".name"];
 912         },
 913
 914         warn_section: function(s, msg) {
 915                 if (s[".name"]) {
 916                         if (s.name)
 917                                 this.warn("Section %s (%s) %s", this.section_id(s[".name"]), s.name, msg);
 918                         else
 919                                 this.warn("Section %s %s", this.section_id(s[".name"]), msg);
 920                 }
 921                 else {
 922                         if (s.name)
 923                                 this.warn("ubus %s (%s) %s", s.type || "rule", s.name, msg);
 924                         else
 925                                 this.warn("ubus %s %s", s.type || "rule", msg);
 926                 }
 927         },
 928
 929         parse_policy: function(val) {
 930                 return this.parse_enum(val, [
 931                         "accept",
 932                         "reject",
 933                         "drop"
 934                 ]);
 935         },
 936
 937         parse_bool: function(val) {
 938                 if (val == "1" || val == "on" || val == "true" || val == "yes")
 939                         return true;
 940                 else if (val == "0" || val == "off" || val == "false" || val == "no")
 941                         return false;
 942                 else
 943                         return null;
 944         },
 945
 946         parse_family: function(val) {
 947                 if (val == 'any' || val == 'all' || val == '*')
 948                         return 0;
 949                 else if (val == 'inet' || index(val, '4') > -1)
 950                         return 4;
 951                 else if (index(val, '6') > -1)
 952                         return 6;
 953
 954                 return null;
 955         },
 956
 957         parse_zone_ref: function(val) {
 958                 if (val == null)
 959                         return null;
 960
 961                 if (val == '*')
 962                         return { any: true };
 963
 964                 for (let zone in this.state.zones) {
 965                         if (zone.name == val) {
 966                                 return {
 967                                         any: false,
 968                                         zone: zone
 969                                 };
 970                         }
 971                 }
 972
 973                 return null;
 974         },
 975
 976         parse_device: function(val) {
 977                 let rv = this.parse_invert(val);
 978
 979                 if (!rv)
 980                         return null;
 981
 982                 if (rv.val == '*')
 983                         rv.any = true;
 984                 else
 985                         rv.device = rv.val;
 986
 987                 return rv;
 988         },
 989
 990         parse_direction: function(val) {
 991                 if (val == 'in' || val == 'ingress')
 992                         return false;
 993                 else if (val == 'out' || val == 'egress')
 994                         return true;
 995
 996                 return null;
 997         },
 998
 999         parse_setmatch: function(val) {
1000                 let rv = this.parse_invert(val);
1001
1002                 if (!rv)
1003                         return null;
1004
1005                 rv.val = trim(replace(rv.val, /^[^ \t]+/, function(m) {
1006                         rv.name = m;
1007                         return '';
1008                 }));
1009
1010                 let dir = split(rv.val, /[ \t,]/);
1011
1012                 for (let i = 0; i < 3 && i < length(dir); i++) {
1013                         if (dir[i] == "dst" || dir[i] == "dest")
1014                                 (rv.dir ||= [])[i] = "dst";
1015                         else if (dir[i] == "src")
1016                                 (rv.dir ||= [])[i] = "src";
1017                 }
1018
1019                 return length(rv.name) ? rv : null;
1020         },
1021
1022         parse_cthelper: function(val) {
1023                 let rv = this.parse_invert(val);
1024
1025                 if (!rv)
1026                         return null;
1027
1028                 let helper = filter(this.state.helpers, h => (h.name == rv.val))[0];
1029
1030                 return helper ? { ...rv, ...helper } : null;
1031         },
1032
1033         parse_protocol: function(val) {
1034                 let p = this.parse_invert(val);
1035
1036                 if (!p)
1037                         return null;
1038
1039                 p.val = lc(p.val);
1040
1041                 switch (p.val) {
1042                 case 'all':
1043                 case 'any':
1044                 case '*':
1045                         p.any = true;
1046                         break;
1047
1048                 case '1':
1049                 case 'icmp':
1050                         p.name = 'icmp';
1051                         break;
1052
1053                 case '58':
1054                 case 'icmpv6':
1055                 case 'ipv6-icmp':
1056                         p.name = 'ipv6-icmp';
1057                         break;
1058
1059                 case 'tcpudp':
1060                         return [
1061                                 { invert: p.invert, name: 'tcp' },
1062                                 { invert: p.invert, name: 'udp' }
1063                         ];
1064
1065                 case '6':
1066                         p.name = 'tcp';
1067                         break;
1068
1069                 case '17':
1070                         p.name = 'udp';
1071                         break;
1072
1073                 default:
1074                         p.name = p.val;
1075                 }
1076
1077                 return (p.any || length(p.name)) ? p : null;
1078         },
1079
1080         parse_mac: function(val) {
1081                 let mac = this.parse_invert(val);
1082                 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;
1083
1084                 if (!m)
1085                         return null;
1086
1087                 mac.mac = sprintf('%02x:%02x:%02x:%02x:%02x:%02x',
1088                                   hex(m[1]), hex(m[2]), hex(m[3]),
1089                                   hex(m[4]), hex(m[5]), hex(m[6]));
1090
1091                 return mac;
1092         },
1093
1094         parse_port: function(val) {
1095                 let port = this.parse_invert(val);
1096                 let m = port ? match(port.val, /^([0-9]{1,5})([-:]([0-9]{1,5}))?$/i) : null;
1097
1098                 if (!m)
1099                         return null;
1100
1101                 if (m[3]) {
1102                         let min_port = +m[1];
1103                         let max_port = +m[3];
1104
1105                         if (min_port > max_port ||
1106                             min_port < 0 || max_port < 0 ||
1107                             min_port > 65535 || max_port > 65535)
1108                                 return null;
1109
1110                         port.min = min_port;
1111                         port.max = max_port;
1112                 }
1113                 else {
1114                         let pn = +m[1];
1115
1116                         if (pn != pn || pn < 0 || pn > 65535)
1117                                 return null;
1118
1119                         port.min = pn;
1120                         port.max = pn;
1121                 }
1122
1123                 return port;
1124         },
1125
1126         parse_network: function(val) {
1127                 let rv = this.parse_invert(val);
1128
1129                 if (!rv)
1130                         return null;
1131
1132                 let nets = this.parse_subnet(rv.val);
1133
1134                 if (nets === null)
1135                         return null;
1136
1137                 if (length(nets))
1138                         rv.addrs = [ ...nets ];
1139
1140                 return rv;
1141         },
1142
1143         parse_icmptype: function(val) {
1144                 let rv = {};
1145
1146                 if (exists(ipv4_icmptypes, val)) {
1147                         rv.family = 4;
1148
1149                         rv.type = ipv4_icmptypes[val][0];
1150                         rv.code_min = ipv4_icmptypes[val][1];
1151                         rv.code_max = ipv4_icmptypes[val][2];
1152                 }
1153
1154                 if (exists(ipv6_icmptypes, val)) {
1155                         rv.family = rv.family ? 0 : 6;
1156
1157                         rv.type6 = ipv6_icmptypes[val][0];
1158                         rv.code6_min = ipv6_icmptypes[val][1];
1159                         rv.code6_max = ipv6_icmptypes[val][2];
1160                 }
1161
1162                 if (!exists(rv, "family")) {
1163                         let m = match(val, /^([0-9]+)(\/([0-9]+))?$/);
1164
1165                         if (!m)
1166                                 return null;
1167
1168                         if (m[3]) {
1169                                 rv.type = +m[1];
1170                                 rv.code_min = +m[3];
1171                                 rv.code_max = rv.code_min;
1172                         }
1173                         else {
1174                                 rv.type = +m[1];
1175                                 rv.code_min = 0;
1176                                 rv.code_max = 0xFF;
1177                         }
1178
1179                         if (rv.type > 0xFF || rv.code_min > 0xFF || rv.code_max > 0xFF)
1180                                 return null;
1181
1182                         rv.family = 0;
1183
1184                         rv.type6 = rv.type;
1185                         rv.code6_min = rv.code_min;
1186                         rv.code6_max = rv.code_max;
1187                 }
1188
1189                 return rv;
1190         },
1191
1192         parse_invert: function(val) {
1193                 if (val == null)
1194                         return null;
1195
1196                 let rv = { invert: false };
1197
1198                 rv.val = trim(replace(val, /^[ \t]*!/, () => (rv.invert = true, '')));
1199
1200                 return length(rv.val) ? rv : null;
1201         },
1202
1203         parse_limit: function(val) {
1204                 let rv = this.parse_invert(val);
1205                 let m = rv ? match(rv.val, /^([0-9]+)(\/([a-z]+))?$/) : null;
1206
1207                 if (!m)
1208                         return null;
1209
1210                 let n = +m[1];
1211                 let u = m[3] ? this.parse_enum(m[3], [ "second", "minute", "hour", "day" ]) : "second";
1212
1213                 if (!u)
1214                         return null;
1215
1216                 rv.rate = n;
1217                 rv.unit = u;
1218
1219                 return rv;
1220         },
1221
1222         parse_int: function(val) {
1223                 let n = +val;
1224
1225                 return (n == n) ? n : null;
1226         },
1227
1228         parse_date: function(val) {
1229                 let m = match(val, /^([0-9-]+)T([0-9:]+)$/);
1230                 let d = m ? match(m[1], /^([0-9]{1,4})(-([0-9]{1,2})(-([0-9]{1,2}))?)?$/) : null;
1231                 let t = this.parse_time(m[2]);
1232
1233                 d[3] ||= 1;
1234                 d[5] ||= 1;
1235
1236                 if (d == null || d[1] < 1970 || d[1] > 2038 || d[3] < 1 || d[3] > 12 || d[5] < 1 || d[5] > 31)
1237                         return null;
1238
1239                 if (m[2] && !t)
1240                         return null;
1241
1242                 return {
1243                         year:  +d[1],
1244                         month: +d[3],
1245                         day:   +d[5],
1246                         hour:  t ? +t[1] : 0,
1247                         min:   t ? +t[3] : 0,
1248                         sec:   t ? +t[5] : 0
1249                 };
1250         },
1251
1252         parse_time: function(val) {
1253                 let t = match(val, /^([0-9]{1,2})(:([0-9]{1,2})(:([0-9]{1,2}))?)?$/);
1254
1255                 if (t == null || t[1] > 23 || t[3] > 59 || t[5] > 59)
1256                         return null;
1257
1258                 return {
1259                         hour: +t[1],
1260                         min:  +t[3],
1261                         sec:  +t[5]
1262                 };
1263         },
1264
1265         parse_weekdays: function(val) {
1266                 let rv = this.parse_invert(val);
1267
1268                 if (!rv)
1269                         return null;
1270
1271                 for (let day in to_array(rv.val)) {
1272                         day = this.parse_enum(day, [
1273                                 "Monday",
1274                                 "Tuesday",
1275                                 "Wednesday",
1276                                 "Thursday",
1277                                 "Friday",
1278                                 "Saturday",
1279                                 "Sunday"
1280                         ]);
1281
1282                         if (!day)
1283                                 return null;
1284
1285                         (rv.days ||= {})[day] = true;
1286                 }
1287
1288                 rv.days = keys(rv.days);
1289
1290                 return rv.days ? rv : null;
1291         },
1292
1293         parse_monthdays: function(val) {
1294                 let rv = this.parse_invert(val);
1295
1296                 if (!rv)
1297                         return null;
1298
1299                 for (let day in to_array(rv.val)) {
1300                         day = +day;
1301
1302                         if (day < 1 || day > 31)
1303                                 return null;
1304
1305                         (rv.days ||= [])[day] = true;
1306                 }
1307
1308                 return rv.days ? rv : null;
1309         },
1310
1311         parse_mark: function(val) {
1312                 let rv = this.parse_invert(val);
1313                 let m = rv ? match(rv.val, /^(0?x?[0-9a-f]+)(\/(0?x?[0-9a-f]+))?$/i) : null;
1314
1315                 if (!m)
1316                         return null;
1317
1318                 let n = +m[1];
1319
1320                 if (n != n || n > 0xFFFFFFFF)
1321                         return null;
1322
1323                 rv.mark = n;
1324                 rv.mask = 0xFFFFFFFF;
1325
1326                 if (m[3]) {
1327                         n = +m[3];
1328
1329                         if (n != n || n > 0xFFFFFFFF)
1330                                 return null;
1331
1332                         rv.mask = n;
1333                 }
1334
1335                 return rv;
1336         },
1337
1338         parse_dscp: function(val) {
1339                 let rv = this.parse_invert(val);
1340
1341                 if (!rv)
1342                         return null;
1343
1344                 rv.val = uc(rv.val);
1345
1346                 if (exists(dscp_classes, rv.val)) {
1347                         rv.dscp = dscp_classes[rv.val];
1348                 }
1349                 else {
1350                         let n = +rv.val;
1351
1352                         if (n != n || n < 0 || n > 0x3F)
1353                                 return null;
1354
1355                         rv.dscp = n;
1356                 }
1357
1358                 return rv;
1359         },
1360
1361         parse_target: function(val) {
1362                 return this.parse_enum(val, [
1363                         "accept",
1364                         "reject",
1365                         "drop",
1366                         "notrack",
1367                         "helper",
1368                         "mark",
1369                         "dscp",
1370                         "dnat",
1371                         "snat",
1372                         "masquerade",
1373                         "accept",
1374                         "reject",
1375                         "drop"
1376                 ]);
1377         },
1378
1379         parse_reject_code: function(val) {
1380                 return this.parse_enum(val, [
1381                         "tcp-reset",
1382                         "port-unreachable",
1383                         "admin-prohibited",
1384                         "host-unreachable",
1385                         "no-route"
1386                 ]);
1387         },
1388
1389         parse_reflection_source: function(val) {
1390                 return this.parse_enum(val, [
1391                         "internal",
1392                         "external"
1393                 ]);
1394         },
1395
1396         parse_ipsettype: function(val) {
1397                 let m = match(val, /^(src|dst|dest)_(.+)$/);
1398                 let t = this.parse_enum(m ? m[2] : val, [
1399                         "ip",
1400                         "port",
1401                         "mac",
1402                         "net",
1403                         "set"
1404                 ]);
1405
1406                 return t ? [ (!m || m[1] == 'src') ? 'src' : 'dst', t ] : null;
1407         },
1408
1409         parse_ipsetentry: function(val, set) {
1410                 let values = split(val, /[ \t]+/);
1411
1412                 if (length(values) != length(set.types))
1413                         return null;
1414
1415                 let rv = [];
1416                 let ip, mac, port;
1417
1418                 for (let i, t in set.types) {
1419                         switch (t) {
1420                         case 'ipv4_addr':
1421                                 ip = filter(this.parse_subnet(values[i]), a => (a.family == 4));
1422
1423                                 switch (length(ip) ?? 0) {
1424                                 case 0: return null;
1425                                 case 1: break;
1426                                 default: this.warn("Set entry '%s' resolves to multiple addresses, using first one", values[i]);
1427                                 }
1428
1429                                 rv[i] = ("net" in set.fw4types) ? `${ip[0].addr}/${ip[0].bits}` : ip[0].addr;
1430                                 break;
1431
1432                         case 'ipv6_addr':
1433                                 ip = filter(this.parse_subnet(values[i]), a => (a.family == 6));
1434
1435                                 switch(length(ip)) {
1436                                 case 0: return null;
1437                                 case 1: break;
1438                                 case 2: this.warn("Set entry '%s' resolves to multiple addresses, using first one", values[i]);
1439                                 }
1440
1441                                 rv[i] = ("net" in set.fw4types) ? `${ip[0].addr}/${ip[0].bits}` : ip[0].addr;
1442
1443                                 break;
1444
1445                         case 'ether_addr':
1446                                 mac = this.parse_mac(values[i]);
1447
1448                                 if (!mac || mac.invert)
1449                                         return null;
1450
1451                                 rv[i] = mac.mac;
1452                                 break;
1453
1454                         case 'inet_service':
1455                                 port = this.parse_port(values[i]);
1456
1457                                 if (!port || port.invert || port.min != port.max)
1458                                         return null;
1459
1460                                 rv[i] = port.min;
1461                                 break;
1462
1463                         default:
1464                                 rv[i] = values[i];
1465                         }
1466                 }
1467
1468                 return length(rv) ? rv : null;
1469         },
1470
1471         parse_string: function(val) {
1472                 return "" + val;
1473         },
1474
1475         parse_opt: function(s, opt, fn, defval, flags) {
1476                 let val = s[opt];
1477
1478                 if (val === null) {
1479                         if (flags & REQUIRED) {
1480                                 this.warn_section(s, `option '${opt}' is mandatory but not set`);
1481                                 return NaN;
1482                         }
1483
1484                         val = defval;
1485                 }
1486
1487                 if (type(val) == "array") {
1488                         this.warn_section(s, `option '${opt}' must not be a list`);
1489                         return NaN;
1490                 }
1491                 else if (val == null) {
1492                         return null;
1493                 }
1494
1495                 let res = this[fn](val);
1496
1497                 if (res === null) {
1498                         this.warn_section(s, `option '${opt}' specifies invalid value '${val}'`);
1499                         return NaN;
1500                 }
1501
1502                 return res;
1503         },
1504
1505         parse_list: function(s, opt, fn, defval, flags) {
1506                 let val = s[opt];
1507                 let rv = [];
1508
1509                 if (val == null) {
1510                         if (flags & REQUIRED) {
1511                                 this.warn_section(s, `option '${opt}' is mandatory but not set`);
1512                                 return NaN;
1513                         }
1514
1515                         val = defval;
1516                 }
1517
1518                 for (val in to_array(val)) {
1519                         let res = this[fn](val);
1520
1521                         if (res === null) {
1522                                 this.warn_section(s, `option '${opt}' specifies invalid value '${val}'`);
1523                                 return NaN;
1524                         }
1525
1526                         if (flags & FLATTEN_LIST)
1527                                 push(rv, ...to_array(res));
1528                         else
1529                                 push(rv, res);
1530                 }
1531
1532                 return length(rv) ? rv : null;
1533         },
1534
1535         quote: function(s, force) {
1536                 if (force === true || !match(s, /^([0-9A-Fa-f:.\/-]+)( \. [0-9A-Fa-f:.\/-]+)*$/))
1537                         return `"${replace(s + "", /(["\\])/g, '\\$1')}"`;
1538
1539                 return s;
1540         },
1541
1542         cidr: function(a) {
1543                 if (a.range)
1544                         return `${a.addr}-${a.addr2}`;
1545
1546                 if ((a.family == 4 && a.bits == 32) ||
1547                     (a.family == 6 && a.bits == 128))
1548                     return a.addr;
1549
1550                 if (a.bits >= 0)
1551                         return `${apply_mask(a.addr, a.bits)}/${a.bits}`;
1552
1553                 return `${a.addr}/${a.mask}`;
1554         },
1555
1556         host: function(a, v6brackets) {
1557                 return a.range
1558                         ? `${a.addr}-${a.addr2}`
1559                         : (a.family == 6 && v6brackets)
1560                                 ? `[${apply_mask(a.addr, a.bits)}]` : apply_mask(a.addr, a.bits);
1561         },
1562
1563         port: function(p) {
1564                 if (p.min == p.max)
1565                         return `${p.min}`;
1566
1567                 return `${p.min}-${p.max}`;
1568         },
1569
1570         set: function(v, force) {
1571                 let seen = {};
1572
1573                 v = filter(to_array(v), item => !seen[item]++);
1574
1575                 if (force || length(v) != 1)
1576                         return `{ ${join(', ', map(v, this.quote))} }`;
1577
1578                 return this.quote(v[0]);
1579         },
1580
1581         concat: function(v) {
1582                 return join(' . ', to_array(v));
1583         },
1584
1585         ipproto: function(family) {
1586                 switch (family) {
1587                 case 4:
1588                         return "ip";
1589
1590                 case 6:
1591                         return "ip6";
1592                 }
1593         },
1594
1595         nfproto: function(family, human_readable) {
1596                 switch (family) {
1597                 case 4:
1598                         return human_readable ? "IPv4" : "ipv4";
1599
1600                 case 6:
1601                         return human_readable ? "IPv6" : "ipv6";
1602
1603                 default:
1604                         return human_readable ? "IPv4/IPv6" : null;
1605                 }
1606         },
1607
1608         l4proto: function(family, proto) {
1609                 switch (proto.name) {
1610                 case 'icmp':
1611                         switch (family ?? 0) {
1612                         case 0:
1613                                 return this.set(['icmp', 'ipv6-icmp']);
1614
1615                         case 6:
1616                                 return 'ipv6-icmp';
1617                         }
1618
1619                 default:
1620                         return proto.name;
1621                 }
1622         },
1623
1624         datetime: function(stamp) {
1625                 return sprintf('"%04d-%02d-%02d %02d:%02d:%02d"',
1626                                stamp.year, stamp.month, stamp.day,
1627                                stamp.hour, stamp.min, stamp.sec);
1628         },
1629
1630         date: function(stamp) {
1631                 return sprintf('"%04d-%02d-%02d"', stamp.year, stamp.month, stamp.day);
1632         },
1633
1634         time: function(stamp) {
1635                 return sprintf('"%02d:%02d:%02d"', stamp.hour, stamp.min, stamp.sec);
1636         },
1637
1638         hex: function(n) {
1639                 return sprintf('0x%x', n);
1640         },
1641
1642         is_loopback_dev: function(dev) {
1643                 let fd = fs.open(`/sys/class/net/${dev}/flags`, "r");
1644
1645                 if (!fd)
1646                         return false;
1647
1648                 let flags = +fd.read("line");
1649
1650                 fd.close();
1651
1652                 return !!(flags & 0x8);
1653         },
1654
1655         is_loopback_addr: function(addr) {
1656                 return (index(addr, "127.") == 0 || addr == "::1" || addr == "::1/128");
1657         },
1658
1659         filter_loopback_devs: function(devs, invert) {
1660                 return null_if_empty(filter(devs, d => (this.is_loopback_dev(d) == invert)));
1661         },
1662
1663         filter_loopback_addrs: function(addrs, invert) {
1664                 return null_if_empty(filter(addrs, a => (this.is_loopback_addr(a) == invert)));
1665         },
1666
1667
1668         input_policy: function(reject_as_drop) {
1669                 return (!reject_as_drop || this.state.defaults.input != 'reject') ? this.state.defaults.input : 'drop';
1670         },
1671
1672         output_policy: function(reject_as_drop) {
1673                 return (!reject_as_drop || this.state.defaults.output != 'reject') ? this.state.defaults.output : 'drop';
1674         },
1675
1676         forward_policy: function(reject_as_drop) {
1677                 return (!reject_as_drop || this.state.defaults.forward != 'reject') ? this.state.defaults.forward : 'drop';
1678         },
1679
1680         default_option: function(flag) {
1681                 return this.state.defaults[flag];
1682         },
1683
1684         helpers: function() {
1685                 return this.state.helpers;
1686         },
1687
1688         zones: function() {
1689                 return this.state.zones;
1690         },
1691
1692         rules: function(chain) {
1693                 return filter(this.state.rules, r => (r.chain == chain));
1694         },
1695
1696         redirects: function(chain) {
1697                 return filter(this.state.redirects, r => (r.chain == chain));
1698         },
1699
1700         ipsets: function() {
1701                 return this.state.ipsets;
1702         },
1703
1704         parse_setfile: function(set, cb) {
1705                 let fd = fs.open(set.loadfile, "r");
1706
1707                 if (!fd) {
1708                         warn(`Unable to load file '${set.loadfile}' for set '${set.name}': ${fs.error()}\n`);
1709                         return;
1710                 }
1711
1712                 let line = null, count = 0;
1713
1714                 while ((line = fd.read("line")) !== "") {
1715                         line = trim(line);
1716
1717                         if (length(line) == 0 || ord(line) == 35)
1718                                 continue;
1719
1720                         let v = this.parse_ipsetentry(line, set);
1721
1722                         if (!v) {
1723                                 this.warn(`Skipping invalid entry '${line}' in file '${set.loadfile}' for set '${set.name}'`);
1724                                 continue;
1725                         }
1726
1727                         cb(v);
1728
1729                         count++;
1730                 }
1731
1732                 fd.close();
1733
1734                 return count;
1735         },
1736
1737         print_setentries: function(set) {
1738                 let first = true;
1739                 let printer = (entry) => {
1740                         if (first) {
1741                                 print("\t\telements = {\n");
1742                                 first = false;
1743                         }
1744
1745                         print("\t\t\t", join(" . ", entry), ",\n");
1746                 };
1747
1748                 map(set.entries, printer);
1749
1750                 if (set.loadfile)
1751                         this.parse_setfile(set, printer);
1752
1753                 if (!first)
1754                         print("\t\t}\n");
1755         },
1756
1757         parse_helper: function(data) {
1758                 let helper = this.parse_options(data, {
1759                         name: [ "string", null, REQUIRED ],
1760                         description: [ "string" ],
1761                         module: [ "string" ],
1762                         family: [ "family" ],
1763                         proto: [ "protocol", null, PARSE_LIST | FLATTEN_LIST | NO_INVERT ],
1764                         port: [ "port", null, NO_INVERT ]
1765                 });
1766
1767                 if (helper === false) {
1768                         this.warn("Helper definition '%s' skipped due to invalid options", data.name || data['.name']);
1769                         return;
1770                 }
1771                 else if (helper.proto.any) {
1772                         this.warn("Helper definition '%s' must not specify wildcard protocol", data.name || data['.name']);
1773                         return;
1774                 }
1775                 else if (length(helper.proto) > 1) {
1776                         this.warn("Helper definition '%s' must not specify multiple protocols", data.name || data['.name']);
1777                         return;
1778                 }
1779
1780                 helper.available = (fs.stat(`/sys/module/${helper.module}`)?.type == "directory");
1781
1782                 push(this.state.helpers ||= [], helper);
1783         },
1784
1785         parse_defaults: function(data) {
1786                 if (this.state.defaults) {
1787                         this.warn_section(data, ": ignoring duplicate defaults section");
1788                         return;
1789                 }
1790
1791                 let defs = this.parse_options(data, {
1792                         input: [ "policy", "drop" ],
1793                         output: [ "policy", "drop" ],
1794                         forward: [ "policy", "drop" ],
1795
1796                         drop_invalid: [ "bool" ],
1797                         tcp_reject_code: [ "reject_code", "tcp-reset" ],
1798                         any_reject_code: [ "reject_code", "port-unreachable" ],
1799
1800                         syn_flood: [ "bool" ],
1801                         synflood_protect: [ "bool" ],
1802                         synflood_rate: [ "limit", "25/second" ],
1803                         synflood_burst: [ "int", "50" ],
1804
1805                         tcp_syncookies: [ "bool", "1" ],
1806                         tcp_ecn: [ "int" ],
1807                         tcp_window_scaling: [ "bool", "1" ],
1808
1809                         accept_redirects: [ "bool" ],
1810                         accept_source_route: [ "bool" ],
1811
1812                         auto_helper: [ "bool", "1" ],
1813                         custom_chains: [ "bool", null, UNSUPPORTED ],
1814                         disable_ipv6: [ "bool", null, UNSUPPORTED ],
1815                         flow_offloading: [ "bool", "0" ],
1816                         flow_offloading_hw: [ "bool", "0" ]
1817                 });
1818
1819                 if (defs.synflood_protect === null)
1820                         defs.synflood_protect = defs.syn_flood;
1821
1822                 delete defs.syn_flood;
1823
1824                 this.state.defaults = defs;
1825         },
1826
1827         parse_zone: function(data) {
1828                 let zone = this.parse_options(data, {
1829                         enabled: [ "bool", "1" ],
1830
1831                         name: [ "string", null, REQUIRED ],
1832                         family: [ "family" ],
1833
1834                         network: [ "device", null, PARSE_LIST ],
1835                         device: [ "device", null, PARSE_LIST ],
1836                         subnet: [ "network", null, PARSE_LIST ],
1837
1838                         input: [ "policy", this.state.defaults ? this.state.defaults.input : "drop" ],
1839                         output: [ "policy", this.state.defaults ? this.state.defaults.output : "drop" ],
1840                         forward: [ "policy", this.state.defaults ? this.state.defaults.forward : "drop" ],
1841
1842                         masq: [ "bool" ],
1843                         masq_allow_invalid: [ "bool" ],
1844                         masq_src: [ "network", null, PARSE_LIST ],
1845                         masq_dest: [ "network", null, PARSE_LIST ],
1846
1847                         masq6: [ "bool" ],
1848
1849                         extra: [ "string", null, UNSUPPORTED ],
1850                         extra_src: [ "string", null, UNSUPPORTED ],
1851                         extra_dest: [ "string", null, UNSUPPORTED ],
1852
1853                         mtu_fix: [ "bool" ],
1854                         custom_chains: [ "bool", null, UNSUPPORTED ],
1855
1856                         log: [ "int" ],
1857                         log_limit: [ "limit", null, UNSUPPORTED ],
1858
1859                         auto_helper: [ "bool", "1" ],
1860                         helper: [ "cthelper", null, PARSE_LIST ],
1861
1862                         counter: [ "bool", "1" ]
1863                 });
1864
1865                 if (zone === false) {
1866                         this.warn_section(data, "skipped due to invalid options");
1867                         return;
1868                 }
1869                 else if (!zone.enabled) {
1870                         this.warn_section(data, "is disabled, ignoring section");
1871                         return;
1872                 }
1873                 else if (zone.helper && !zone.helper.available) {
1874                         this.warn_section(data, `uses unavailable ct helper '${zone.helper.name}', ignoring section`);
1875                         return;
1876                 }
1877
1878                 if (zone.mtu_fix && this.kernel < 0x040a0000) {
1879                         this.warn_section(data, "option 'mtu_fix' requires kernel 4.10 or later");
1880                         return;
1881                 }
1882
1883                 if (this.state.defaults?.auto_helper === false)
1884                         zone.auto_helper = false;
1885
1886                 let match_devices = [];
1887                 let related_physdevs = [];
1888                 let related_subnets = [];
1889                 let related_ubus_networks = [];
1890                 let match_subnets, masq_src_subnets, masq_dest_subnets;
1891
1892                 for (let name, net in this.state.networks) {
1893                         if (net.zone === zone.name)
1894                                 push(related_ubus_networks, { invert: false, device: name });
1895                 }
1896
1897                 for (let e in [ ...to_array(zone.network), ...related_ubus_networks ]) {
1898                         if (exists(this.state.networks, e.device)) {
1899                                 let net = this.state.networks[e.device];
1900
1901                                 if (net.device) {
1902                                         push(match_devices, {
1903                                                 invert: e.invert,
1904                                                 device: net.device
1905                                         });
1906                                 }
1907
1908                                 if (net.physdev && !e.invert)
1909                                         push(related_physdevs, net.physdev);
1910
1911                                 push(related_subnets, ...(net.ipaddrs || []));
1912                         }
1913                 }
1914
1915                 push(match_devices, ...to_array(zone.device));
1916
1917                 match_subnets = subnets_split_af(zone.subnet);
1918                 masq_src_subnets = subnets_split_af(zone.masq_src);
1919                 masq_dest_subnets = subnets_split_af(zone.masq_dest);
1920
1921                 push(related_subnets, ...(match_subnets[0] || []), ...(match_subnets[1] || []));
1922
1923                 let match_rules = [];
1924
1925                 let add_rule = (family, devices, subnets, zone) => {
1926                         let r = {};
1927
1928                         r.family = family;
1929
1930                         r.devices_pos = null_if_empty(devices[0]);
1931                         r.devices_neg = null_if_empty(devices[1]);
1932                         r.devices_neg_wildcard = null_if_empty(devices[2]);
1933
1934                         r.subnets_pos = map(subnets[0], this.cidr);
1935                         r.subnets_neg = map(subnets[1], this.cidr);
1936                         r.subnets_masked = subnets[2];
1937
1938                         push(match_rules, r);
1939                 };
1940
1941                 let family = infer_family(zone.family, [
1942                         zone.helper, "ct helper",
1943                         match_subnets, "subnet list"
1944                 ]);
1945
1946                 if (type(family) == "string") {
1947                         this.warn_section(data, `${family}, skipping`);
1948                         return;
1949                 }
1950
1951                 // group non-inverted device matches into wildcard and non-wildcard ones
1952                 let devices = [], plain_devices = [], plain_invert_devices = [], wildcard_invert_devices = [];
1953
1954                 for (let device in match_devices) {
1955                         let m = match(device.device, /^([^+]*)(\+)?$/);
1956
1957                         if (!m) {
1958                                 this.warn_section(data, `skipping invalid wildcard pattern '${device.device}'`);
1959                                 continue;
1960                         }
1961
1962                         // filter `+` (match any device) since nftables does not support
1963                         // wildcard only matches
1964                         if (!device.invert && m[0] == '+')
1965                                 continue;
1966
1967                         // replace inverted `+` (match no device) with invalid pattern
1968                         if (device.invert && m[0] == '+') {
1969                                 device.device = '/never/';
1970                                 device.invert = false;
1971                         }
1972
1973                         // replace "name+" matches with "name*"
1974                         else if (m[2] == '+')
1975                                 device.device = m[1] + '*';
1976
1977                         device.wildcard = !!m[2];
1978
1979                         if (!device.invert && device.wildcard)
1980                                 push(devices, [ [ device.device ], plain_invert_devices, wildcard_invert_devices ]);
1981                         else if (!device.invert)
1982                                 push(plain_devices, device.device);
1983                         else if (device.wildcard)
1984                                 push(wildcard_invert_devices, device.device);
1985                         else
1986                                 push(plain_invert_devices, device.device);
1987                 }
1988
1989                 if (length(plain_devices))
1990                         push(devices, [
1991                                 plain_devices,
1992                                 plain_invert_devices,
1993                                 wildcard_invert_devices
1994                         ]);
1995                 else if (!length(devices))
1996                         push(devices, [
1997                                 null,
1998                                 plain_invert_devices,
1999                                 wildcard_invert_devices
2000                         ]);
2001
2002                 // emit zone jump rules for each device group
2003                 if (length(match_devices) || length(match_subnets[0]) || length(match_subnets[1])) {
2004                         for (let devgroup in devices) {
2005                                 // check if there's no AF specific bits, in this case we can do AF agnostic matching
2006                                 if (!family && !length(match_subnets[0]) && !length(match_subnets[1])) {
2007                                         add_rule(0, devgroup, [], zone);
2008                                 }
2009
2010                                 // we need to emit one or two AF specific rules
2011                                 else {
2012                                         if (!family || family == 4)
2013                                                 for (let subnets in subnets_group_by_masking(match_subnets[0]))
2014                                                         add_rule(4, devgroup, subnets, zone);
2015
2016                                         if (!family || family == 6)
2017                                                 for (let subnets in subnets_group_by_masking(match_subnets[1]))
2018                                                         add_rule(6, devgroup, subnets, zone);
2019                                 }
2020                         }
2021                 }
2022
2023                 zone.family = family;
2024
2025                 zone.match_rules = match_rules;
2026
2027                 zone.masq4_src_subnets = subnets_group_by_masking(masq_src_subnets[0]);
2028                 zone.masq4_dest_subnets = subnets_group_by_masking(masq_dest_subnets[0]);
2029
2030                 zone.masq6_src_subnets = subnets_group_by_masking(masq_src_subnets[1]);
2031                 zone.masq6_dest_subnets = subnets_group_by_masking(masq_dest_subnets[1]);
2032
2033                 zone.sflags = {};
2034                 zone.sflags[zone.input] = true;
2035
2036                 zone.dflags = {};
2037                 zone.dflags[zone.output] = true;
2038                 zone.dflags[zone.forward] = true;
2039
2040                 zone.match_devices = map(filter(match_devices, d => !d.invert), d => d.device);
2041                 zone.match_subnets = map(filter(related_subnets, s => !s.invert && s.bits != -1), this.cidr);
2042
2043                 zone.related_subnets = related_subnets;
2044                 zone.related_physdevs = related_physdevs;
2045
2046                 if (zone.masq || zone.masq6)
2047                         zone.dflags.snat = true;
2048
2049                 if ((zone.auto_helper && !(zone.masq || zone.masq6)) || length(zone.helper)) {
2050                         zone.dflags.helper = true;
2051
2052                         for (let helper in (length(zone.helper) ? zone.helper : this.state.helpers)) {
2053                                 if (!helper.available)
2054                                         continue;
2055
2056                                 for (let proto in helper.proto) {
2057                                         push(this.state.rules ||= [], {
2058                                                 chain: `helper_${zone.name}`,
2059                                                 family: helper.family,
2060                                                 name: helper.description || helper.name,
2061                                                 proto: proto,
2062                                                 src: zone,
2063                                                 dports_pos: [ this.port(helper.port) ],
2064                                                 target: "helper",
2065                                                 set_helper: helper
2066                                         });
2067                                 }
2068                         }
2069                 }
2070
2071                 push(this.state.zones ||= [], zone);
2072         },
2073
2074         parse_forwarding: function(data) {
2075                 let fwd = this.parse_options(data, {
2076                         enabled: [ "bool", "1" ],
2077
2078                         name: [ "string" ],
2079                         family: [ "family" ],
2080
2081                         src: [ "zone_ref", null, REQUIRED ],
2082                         dest: [ "zone_ref", null, REQUIRED ]
2083                 });
2084
2085                 if (fwd === false) {
2086                         this.warn_section(data, "skipped due to invalid options");
2087                         return;
2088                 }
2089                 else if (!fwd.enabled) {
2090                         this.warn_section(data, "is disabled, ignoring section");
2091                         return;
2092                 }
2093
2094                 let add_rule = (family, fwd) => {
2095                         let f = {
2096                                 ...fwd,
2097
2098                                 family: family,
2099                                 proto: { any: true }
2100                         };
2101
2102                         f.name ||= `Accept ${fwd.src.any ? "any" : fwd.src.zone.name} to ${fwd.dest.any ? "any" : fwd.dest.zone.name} ${family ? `${this.nfproto(family, true)} ` : ''}forwarding`;
2103                         f.chain = fwd.src.any ? "forward" : `forward_${fwd.src.zone.name}`;
2104
2105                         if (fwd.dest.any)
2106                                 f.target = "accept";
2107                         else
2108                                 f.jump_chain = `accept_to_${fwd.dest.zone.name}`;
2109
2110                         push(this.state.rules ||= [], f);
2111                 };
2112
2113
2114                 /* inherit family restrictions from related zones */
2115                 let family = infer_family(fwd.family, [
2116                         fwd.src?.zone, "source zone",
2117                         fwd.dest?.zone, "destination zone"
2118                 ]);
2119
2120                 if (type(family) == "string") {
2121                         this.warn_section(data, `${family}, skipping`);
2122                         return;
2123                 }
2124
2125                 add_rule(family, fwd);
2126
2127                 if (fwd.dest.zone)
2128                         fwd.dest.zone.dflags.accept = true;
2129         },
2130
2131         parse_rule: function(data) {
2132                 let rule = this.parse_options(data, {
2133                         enabled: [ "bool", "1" ],
2134
2135                         name: [ "string", this.section_id(data[".name"]) ],
2136                         _name: [ "string", null, DEPRECATED ],
2137                         family: [ "family" ],
2138
2139                         src: [ "zone_ref" ],
2140                         dest: [ "zone_ref" ],
2141
2142                         device: [ "device", null, NO_INVERT ],
2143                         direction: [ "direction" ],
2144
2145                         ipset: [ "setmatch" ],
2146                         helper: [ "cthelper" ],
2147                         set_helper: [ "cthelper", null, NO_INVERT ],
2148
2149                         proto: [ "protocol", "tcpudp", PARSE_LIST | FLATTEN_LIST ],
2150
2151                         src_ip: [ "network", null, PARSE_LIST ],
2152                         src_mac: [ "mac", null, PARSE_LIST ],
2153                         src_port: [ "port", null, PARSE_LIST ],
2154
2155                         dest_ip: [ "network", null, PARSE_LIST ],
2156                         dest_port: [ "port", null, PARSE_LIST ],
2157
2158                         icmp_type: [ "icmptype", null, PARSE_LIST ],
2159                         extra: [ "string", null, UNSUPPORTED ],
2160
2161                         limit: [ "limit" ],
2162                         limit_burst: [ "int" ],
2163
2164                         utc_time: [ "bool" ],
2165                         start_date: [ "date" ],
2166                         stop_date: [ "date" ],
2167                         start_time: [ "time" ],
2168                         stop_time: [ "time" ],
2169                         weekdays: [ "weekdays" ],
2170                         monthdays: [ "monthdays", null, UNSUPPORTED ],
2171
2172                         mark: [ "mark" ],
2173                         set_mark: [ "mark", null, NO_INVERT ],
2174                         set_xmark: [ "mark", null, NO_INVERT ],
2175
2176                         dscp: [ "dscp" ],
2177                         set_dscp: [ "dscp", null, NO_INVERT ],
2178
2179                         counter: [ "bool", "1" ],
2180
2181                         target: [ "target" ]
2182                 });
2183
2184                 if (rule === false) {
2185                         this.warn_section(data, "skipped due to invalid options");
2186                         return;
2187                 }
2188                 else if (!rule.enabled) {
2189                         this.warn_section(data, "is disabled, ignoring section");
2190                         return;
2191                 }
2192
2193                 if (rule.target in ["helper", "notrack"] && (!rule.src || !rule.src.zone)) {
2194                         this.warn_section(data, `must specify a source zone for target '${rule.target}'`);
2195                         return;
2196                 }
2197                 else if (rule.target == "dscp" && !rule.set_dscp) {
2198                         this.warn_section(data, "must specify option 'set_dscp' for target 'dscp'");
2199                         return;
2200                 }
2201                 else if (rule.target == "mark" && !rule.set_mark && !rule.set_xmark) {
2202                         this.warn_section(data, "must specify option 'set_mark' or 'set_xmark' for target 'mark'");
2203                         return;
2204                 }
2205                 else if (rule.target == "helper" && !rule.set_helper) {
2206                         this.warn_section(data, "must specify option 'set_helper' for target 'helper'");
2207                         return;
2208                 }
2209                 else if (rule.device?.any) {
2210                         this.warn_section(data, "must not specify '*' as device");
2211                         return;
2212                 }
2213
2214                 let ipset;
2215
2216                 if (rule.ipset) {
2217                         ipset = filter(this.state.ipsets, s => (s.name == rule.ipset.name))[0];
2218
2219                         if (!ipset) {
2220                                 this.warn_section(data, `references unknown set '${rule.ipset.name}'`);
2221                                 return;
2222                         }
2223
2224                         if (('inet_service' in ipset.types) && !ensure_tcpudp(rule.proto)) {
2225                                 this.warn_section(data, "references named set with port match but no UDP/TCP protocol, ignoring section");
2226                                 return;
2227                         }
2228                 }
2229
2230                 let need_src_action_chain = (rule) => (rule.src?.zone?.log && rule.target != "accept");
2231
2232                 let add_rule = (family, proto, saddrs, daddrs, sports, dports, icmptypes, icmpcodes, ipset, rule) => {
2233                         let r = {
2234                                 ...rule,
2235
2236                                 family: family,
2237                                 proto: proto,
2238                                 has_addrs: !!(saddrs[0] || saddrs[1] || saddrs[2] || daddrs[0] || daddrs[1] || daddrs[2]),
2239                                 has_ports: !!(length(sports) || length(dports)),
2240                                 saddrs_pos: map(saddrs[0], this.cidr),
2241                                 saddrs_neg: map(saddrs[1], this.cidr),
2242                                 saddrs_masked: saddrs[2],
2243                                 daddrs_pos: map(daddrs[0], this.cidr),
2244                                 daddrs_neg: map(daddrs[1], this.cidr),
2245                                 daddrs_masked: daddrs[2],
2246                                 sports_pos: map(filter_pos(sports), this.port),
2247                                 sports_neg: map(filter_neg(sports), this.port),
2248                                 dports_pos: map(filter_pos(dports), this.port),
2249                                 dports_neg: map(filter_neg(dports), this.port),
2250                                 smacs_pos: map(filter_pos(rule.src_mac), m => m.mac),
2251                                 smacs_neg: map(filter_neg(rule.src_mac), m => m.mac),
2252                                 icmp_types: map(icmptypes, i => (family == 4 ? i.type : i.type6)),
2253                                 icmp_codes: map(icmpcodes, ic => `${(family == 4) ? ic.type : ic.type6} . ${(family == 4) ? ic.code_min : ic.code6_min}`)
2254                         };
2255
2256                         if (!length(r.icmp_types))
2257                                 delete r.icmp_types;
2258
2259                         if (!length(r.icmp_codes))
2260                                 delete r.icmp_codes;
2261
2262                         if (r.set_mark) {
2263                                 r.set_xmark = {
2264                                         invert: r.set_mark.invert,
2265                                         mark:   r.set_mark.mark,
2266                                         mask:   r.set_mark.mark | r.set_mark.mask
2267                                 };
2268
2269                                 delete r.set_mark;
2270                         }
2271
2272                         let set_types = map_setmatch(ipset, rule.ipset, proto.name);
2273
2274                         if (set_types !== set_types) {
2275                                 this.warn_section(data, "destination MAC address matching not supported");
2276                                 return;
2277                         } else if (set_types) {
2278                                 r.ipset = { ...r.ipset, fields: set_types };
2279                         }
2280
2281                         if (r.target == "notrack") {
2282                                 r.chain = `notrack_${r.src.zone.name}`;
2283                                 r.src.zone.dflags.notrack = true;
2284                         }
2285                         else if (r.target == "helper") {
2286                                 r.chain = `helper_${r.src.zone.name}`;
2287                                 r.src.zone.dflags.helper = true;
2288                         }
2289                         else if (r.target == "mark" || r.target == "dscp") {
2290                                 if ((r.src?.any && r.dest?.any) || (r.src?.zone && r.dest?.zone))
2291                                         r.chain = "mangle_forward";
2292                                 else if (r.src?.any && r.dest?.zone)
2293                                         r.chain = "mangle_postrouting";
2294                                 else if (r.src?.zone && r.dest?.any)
2295                                         r.chain = "mangle_prerouting";
2296                                 else if (r.src && !r.dest)
2297                                         r.chain = "mangle_input";
2298                                 else
2299                                         r.chain = "mangle_output";
2300
2301                                 if (r.src?.zone) {
2302                                         r.src.zone.dflags[r.target] = true;
2303                                         r.iifnames = null_if_empty(r.src.zone.match_devices);
2304                                 }
2305
2306                                 if (r.dest?.zone) {
2307                                         r.dest.zone.dflags[r.target] = true;
2308                                         r.oifnames = null_if_empty(r.dest.zone.match_devices);
2309                                 }
2310                         }
2311                         else {
2312                                 r.chain = "output";
2313
2314                                 if (r.src) {
2315                                         if (!r.src.any)
2316                                                 r.chain = `${r.dest ? "forward" : "input"}_${r.src.zone.name}`;
2317                                         else
2318                                                 r.chain = r.dest ? "forward" : "input";
2319                                 }
2320
2321                                 if (r.dest && !r.src) {
2322                                         if (!r.dest.any)
2323                                                 r.chain = sprintf("output_%s", r.dest.zone.name);
2324                                         else
2325                                                 r.chain = "output";
2326                                 }
2327
2328                                 if (r.dest && !r.dest.any) {
2329                                         r.jump_chain = `${r.target}_to_${r.dest.zone.name}`;
2330                                         r.dest.zone.dflags[r.target] = true;
2331                                 }
2332                                 else if (need_src_action_chain(r)) {
2333                                         r.jump_chain = `${r.target}_from_${r.src.zone.name}`;
2334                                         r.src.zone.sflags[r.target] = true;
2335                                 }
2336                                 else if (r.target == "reject")
2337                                         r.jump_chain = "handle_reject";
2338                         }
2339
2340                         if (r.device)
2341                                 r[r.direction ? "oifnames" : "iifnames"] = [ r.device.device ];
2342
2343                         push(this.state.rules ||= [], r);
2344                 };
2345
2346                 for (let proto in rule.proto) {
2347                         let sip, dip, sports, dports, itypes4, itypes6;
2348                         let family = rule.family;
2349
2350                         switch (proto.name) {
2351                         case "icmp":
2352                                 itypes4 = filter(rule.icmp_type || [], family_is_ipv4);
2353                                 itypes6 = filter(rule.icmp_type || [], family_is_ipv6);
2354                                 break;
2355
2356                         case "ipv6-icmp":
2357                                 family = 6;
2358                                 itypes6 = filter(rule.icmp_type || [], family_is_ipv6);
2359                                 break;
2360
2361                         case "tcp":
2362                         case "udp":
2363                                 sports = rule.src_port;
2364                                 dports = rule.dest_port;
2365                                 break;
2366                         }
2367
2368                         sip = subnets_split_af(rule.src_ip);
2369                         dip = subnets_split_af(rule.dest_ip);
2370
2371                         family = infer_family(family, [
2372                                 ipset, "set match",
2373                                 sip, "source IP",
2374                                 dip, "destination IP",
2375                                 rule.src?.zone, "source zone",
2376                                 rule.dest?.zone, "destination zone",
2377                                 rule.helper, "helper match",
2378                                 rule.set_helper, "helper to set"
2379                         ]);
2380
2381                         if (type(family) == "string") {
2382                                 this.warn_section(data, `${family}, skipping`);
2383                                 continue;
2384                         }
2385
2386                         let has_ipv4_specifics = (length(sip[0]) || length(dip[0]) || length(itypes4) || rule.dscp !== null);
2387                         let has_ipv6_specifics = (length(sip[1]) || length(dip[1]) || length(itypes6) || rule.dscp !== null);
2388
2389                         /* if no family was configured, infer target family from IP addresses */
2390                         if (family === null) {
2391                                 if (has_ipv4_specifics && !has_ipv6_specifics)
2392                                         family = 4;
2393                                 else if (has_ipv6_specifics && !has_ipv4_specifics)
2394                                         family = 6;
2395                                 else
2396                                         family = 0;
2397                         }
2398
2399                         /* check if there's no AF specific bits, in this case we can do an AF agnostic rule */
2400                         if (!family && rule.target != "dscp" && !has_ipv4_specifics && !has_ipv6_specifics) {
2401                                 add_rule(0, proto, [], [], sports, dports, null, null, null, rule);
2402                         }
2403
2404                         /* we need to emit one or two AF specific rules */
2405                         else {
2406                                 if (family == 0 || family == 4) {
2407                                         let icmp_types = filter(itypes4, i => (i.code_min == 0 && i.code_max == 0xFF));
2408                                         let icmp_codes = filter(itypes4, i => (i.code_min != 0 || i.code_max != 0xFF));
2409
2410                                         for (let saddrs in subnets_group_by_masking(sip[0])) {
2411                                                 for (let daddrs in subnets_group_by_masking(dip[0])) {
2412                                                         if (length(icmp_types) || (!length(icmp_types) && !length(icmp_codes)))
2413                                                                 add_rule(4, proto, saddrs, daddrs, sports, dports, icmp_types, null, ipset, rule);
2414
2415                                                         if (length(icmp_codes))
2416                                                                 add_rule(4, proto, saddrs, daddrs, sports, dports, null, icmp_codes, ipset, rule);
2417                                                 }
2418                                         }
2419                                 }
2420
2421                                 if (family == 0 || family == 6) {
2422                                         let icmp_types = filter(itypes6, i => (i.code_min == 0 && i.code_max == 0xFF));
2423                                         let icmp_codes = filter(itypes6, i => (i.code_min != 0 || i.code_max != 0xFF));
2424
2425                                         for (let saddrs in subnets_group_by_masking(sip[1])) {
2426                                                 for (let daddrs in subnets_group_by_masking(dip[1])) {
2427                                                         if (length(icmp_types) || (!length(icmp_types) && !length(icmp_codes)))
2428                                                                 add_rule(6, proto, saddrs, daddrs, sports, dports, icmp_types, null, ipset, rule);
2429
2430                                                         if (length(icmp_codes))
2431                                                                 add_rule(6, proto, saddrs, daddrs, sports, dports, null, icmp_codes, ipset, rule);
2432                                                 }
2433                                         }
2434                                 }
2435                         }
2436                 }
2437         },
2438
2439         parse_redirect: function(data) {
2440                 let redir = this.parse_options(data, {
2441                         enabled: [ "bool", "1" ],
2442
2443                         name: [ "string", this.section_id(data[".name"]) ],
2444                         _name: [ "string", null, DEPRECATED ],
2445                         family: [ "family" ],
2446
2447                         src: [ "zone_ref" ],
2448                         dest: [ "zone_ref" ],
2449
2450                         ipset: [ "setmatch" ],
2451                         helper: [ "cthelper", null, NO_INVERT ],
2452
2453                         proto: [ "protocol", "tcpudp", PARSE_LIST | FLATTEN_LIST ],
2454
2455                         src_ip: [ "network" ],
2456                         src_mac: [ "mac", null, PARSE_LIST ],
2457                         src_port: [ "port" ],
2458
2459                         src_dip: [ "network" ],
2460                         src_dport: [ "port" ],
2461
2462                         dest_ip: [ "network" ],
2463                         dest_port: [ "port" ],
2464
2465                         extra: [ "string", null, UNSUPPORTED ],
2466
2467                         limit: [ "limit" ],
2468                         limit_burst: [ "int" ],
2469
2470                         utc_time: [ "bool" ],
2471                         start_date: [ "date" ],
2472                         stop_date: [ "date" ],
2473                         start_time: [ "time" ],
2474                         stop_time: [ "time" ],
2475                         weekdays: [ "weekdays" ],
2476                         monthdays: [ "monthdays", null, UNSUPPORTED ],
2477
2478                         mark: [ "mark" ],
2479
2480                         reflection: [ "bool", "1" ],
2481                         reflection_src: [ "reflection_source", "internal" ],
2482
2483                         reflection_zone: [ "zone_ref", null, PARSE_LIST ],
2484
2485                         counter: [ "bool", "1" ],
2486
2487                         target: [ "target", "dnat" ]
2488                 });
2489
2490                 if (redir === false) {
2491                         this.warn_section(data, "skipped due to invalid options");
2492                         return;
2493                 }
2494                 else if (!redir.enabled) {
2495                         this.warn_section(data, "is disabled, ignoring section");
2496                         return;
2497                 }
2498
2499                 if (!(redir.target in ["dnat", "snat"])) {
2500                         this.warn_section(data, "has invalid target specified, defaulting to dnat");
2501                         redir.target = "dnat";
2502                 }
2503
2504                 let ipset;
2505
2506                 if (redir.ipset) {
2507                         ipset = filter(this.state.ipsets, s => (s.name == redir.ipset.name))[0];
2508
2509                         if (!ipset) {
2510                                 this.warn_section(data, `references unknown set '${redir.ipset.name}'`);
2511                                 return;
2512                         }
2513
2514                         if (('inet_service' in ipset.types) && !ensure_tcpudp(redir.proto)) {
2515                                 this.warn_section(data, "references named set with port match but no UDP/TCP protocol, ignoring section");
2516                                 return;
2517                         }
2518                 }
2519
2520                 let resolve_dest = (redir) => {
2521                         for (let zone in this.state.zones) {
2522                                 for (let zone_addr in zone.related_subnets) {
2523                                         for (let dest_addr in redir.dest_ip.addrs) {
2524                                                 if (dest_addr.family != zone_addr.family)
2525                                                         continue;
2526
2527                                                 let a = apply_mask(dest_addr.addr, zone_addr.mask);
2528                                                 let b = apply_mask(zone_addr.addr, zone_addr.mask);
2529
2530                                                 if (a != b)
2531                                                         continue;
2532
2533                                                 redir.dest = {
2534                                                         any: false,
2535                                                         zone: zone
2536                                                 };
2537
2538                                                 return true;
2539                                         }
2540                                 }
2541                         }
2542
2543                         return false;
2544                 };
2545
2546                 if (redir.target == "dnat") {
2547                         if (!redir.src)
2548                                 return this.warn_section(data, "has no source specified");
2549                         else if (redir.src.any)
2550                                 return this.warn_section(data, "must not have source '*' for dnat target");
2551                         else if (redir.dest_ip && redir.dest_ip.invert)
2552                                 return this.warn_section(data, "must not specify a negated 'dest_ip' value");
2553                         else if (redir.dest_ip && length(filter(redir.dest_ip.addrs, a => a.bits == -1)))
2554                                 return this.warn_section(data, "must not use non-contiguous masks in 'dest_ip'");
2555
2556                         if (!redir.dest && redir.dest_ip && resolve_dest(redir))
2557                                 this.warn_section(data, `does not specify a destination, assuming '${redir.dest.zone.name}'`);
2558
2559                         if (!redir.dest_port)
2560                                 redir.dest_port = redir.src_dport;
2561
2562                         if (redir.reflection && redir.dest?.zone && redir.src.zone.masq) {
2563                                 redir.dest.zone.dflags.accept = true;
2564                                 redir.dest.zone.dflags.dnat = true;
2565                                 redir.dest.zone.dflags.snat = true;
2566                         }
2567
2568                         if (redir.helper)
2569                                 redir.src.zone.dflags.helper = true;
2570
2571                         redir.src.zone.dflags[redir.target] = true;
2572                 }
2573                 else {
2574                         if (!redir.dest)
2575                                 return this.warn_section(data, "has no destination specified");
2576                         else if (redir.dest.any)
2577                                 return this.warn_section(data, "must not have destination '*' for snat target");
2578                         else if (!redir.src_dip)
2579                                 return this.warn_section(data, "has no 'src_dip' option specified");
2580                         else if (redir.src_dip.invert)
2581                                 return this.warn_section(data, "must not specify a negated 'src_dip' value");
2582                         else if (length(filter(redir.src_dip.addrs, a => a.bits == -1)))
2583                                 return this.warn_section(data, "must not use non-contiguous masks in 'src_dip'");
2584                         else if (redir.src_mac)
2585                                 return this.warn_section(data, "must not use 'src_mac' option for snat target");
2586                         else if (redir.helper)
2587                                 return this.warn_section(data, "must not use 'helper' option for snat target");
2588
2589                         redir.dest.zone.dflags[redir.target] = true;
2590                 }
2591
2592
2593                 let add_rule = (family, proto, saddrs, daddrs, raddrs, sport, dport, rport, ipset, redir) => {
2594                         let r = {
2595                                 ...redir,
2596
2597                                 family: family,
2598                                 proto: proto,
2599                                 has_addrs: !!(saddrs[0] || saddrs[1] || saddrs[2] || daddrs[0] || daddrs[1] || daddrs[2]),
2600                                 has_ports: !!(sport || dport || rport),
2601                                 saddrs_pos: map(saddrs[0], this.cidr),
2602                                 saddrs_neg: map(saddrs[1], this.cidr),
2603                                 saddrs_masked: saddrs[2],
2604                                 daddrs_pos: map(daddrs[0], this.cidr),
2605                                 daddrs_neg: map(daddrs[1], this.cidr),
2606                                 daddrs_masked: daddrs[2],
2607                                 sports_pos: map(filter_pos(to_array(sport)), this.port),
2608                                 sports_neg: map(filter_neg(to_array(sport)), this.port),
2609                                 dports_pos: map(filter_pos(to_array(dport)), this.port),
2610                                 dports_neg: map(filter_neg(to_array(dport)), this.port),
2611                                 smacs_pos: map(filter_pos(redir.src_mac), m => m.mac),
2612                                 smacs_neg: map(filter_neg(redir.src_mac), m => m.mac),
2613
2614                                 raddr: raddrs ? raddrs[0] : null,
2615                                 rport: rport
2616                         };
2617
2618                         let set_types = map_setmatch(ipset, redir.ipset, proto.name);
2619
2620                         if (set_types !== set_types) {
2621                                 this.warn_section(data, "destination MAC address matching not supported");
2622                                 return;
2623                         } else if (set_types) {
2624                                 r.ipset = { ...r.ipset, fields: set_types };
2625                         }
2626
2627                         switch (r.target) {
2628                         case "dnat":
2629                                 r.chain = `dstnat_${r.src.zone.name}`;
2630                                 r.src.zone.dflags.dnat = true;
2631
2632                                 if (!r.raddr)
2633                                         r.target = "redirect";
2634
2635                                 break;
2636
2637                         case "snat":
2638                                 r.chain = `srcnat_${r.dest.zone.name}`;
2639                                 r.dest.zone.dflags.snat = true;
2640                                 break;
2641                         }
2642
2643                         push(this.state.redirects ||= [], r);
2644                 };
2645
2646                 let to_hostaddr = (a) => {
2647                         let bits = (a.family == 4) ? 32 : 128;
2648
2649                         return {
2650                                 family: a.family,
2651                                 addr: apply_mask(a.addr, bits),
2652                                 bits: bits
2653                         };
2654                 };
2655
2656                 for (let proto in redir.proto) {
2657                         let sip, dip, rip, iip, eip, refip, sport, dport, rport;
2658                         let family = redir.family;
2659
2660                         if (proto.name == "ipv6-icmp")
2661                                 family = 6;
2662
2663                         switch (redir.target) {
2664                         case "dnat":
2665                                 sip = subnets_split_af(redir.src_ip);
2666                                 dip = subnets_split_af(redir.src_dip);
2667                                 rip = subnets_split_af(redir.dest_ip);
2668
2669                                 switch (proto.name) {
2670                                 case "tcp":
2671                                 case "udp":
2672                                         sport = redir.src_port;
2673                                         dport = redir.src_dport;
2674                                         rport = redir.dest_port;
2675                                         break;
2676                                 }
2677
2678                                 break;
2679
2680                         case "snat":
2681                                 sip = subnets_split_af(redir.src_ip);
2682                                 dip = subnets_split_af(redir.dest_ip);
2683                                 rip = subnets_split_af(redir.src_dip);
2684
2685                                 switch (proto.name) {
2686                                 case "tcp":
2687                                 case "udp":
2688                                         sport = redir.src_port;
2689                                         dport = redir.dest_port;
2690                                         rport = redir.src_dport;
2691                                         break;
2692                                 }
2693
2694                                 break;
2695                         }
2696
2697                         family = infer_family(family, [
2698                                 ipset, "set match",
2699                                 sip, "source IP",
2700                                 dip, "destination IP",
2701                                 rip, "rewrite IP",
2702                                 redir.src?.zone, "source zone",
2703                                 redir.dest?.zone, "destination zone",
2704                                 redir.helper, "helper match"
2705                         ]);
2706
2707                         if (type(family) == "string") {
2708                                 this.warn_section(data, `${family}, skipping`);
2709                                 continue;
2710                         }
2711
2712                         /* build reflection rules */
2713                         if (redir.target == "dnat" && redir.reflection &&
2714                             (length(rip[0]) || length(rip[1])) && redir.src?.zone && redir.dest?.zone) {
2715                                 let refredir = {
2716                                         name: `${redir.name} (reflection)`,
2717
2718                                         helper: redir.helper,
2719
2720                                         // XXX: this likely makes no sense for reflection rules
2721                                         //src_mac: redir.src_mac,
2722
2723                                         limit: redir.limit,
2724                                         limit_burst: redir.limit_burst,
2725
2726                                         start_date: redir.start_date,
2727                                         stop_date: redir.stop_date,
2728                                         start_time: redir.start_time,
2729                                         stop_time: redir.stop_time,
2730                                         weekdays: redir.weekdays,
2731
2732                                         mark: redir.mark
2733                                 };
2734
2735                                 let eaddrs = length(dip) ? dip : subnets_split_af({ addrs: map(redir.src.zone.related_subnets, to_hostaddr) });
2736                                 let rzones = length(redir.reflection_zone) ? redir.reflection_zone : [ redir.dest ];
2737
2738                                 for (let rzone in rzones) {
2739                                         if (!is_family(rzone, family)) {
2740                                                 this.warn_section(data,
2741                                                         `is restricted to IPv${family} but referenced reflection zone is IPv${rzone.family} only, skipping`);
2742                                                 continue;
2743                                         }
2744
2745                                         let iaddrs = subnets_split_af({ addrs: rzone.zone.related_subnets });
2746                                         let refaddrs = (redir.reflection_src == "internal") ? iaddrs : eaddrs;
2747
2748                                         for (let i = 0; i <= 1; i++) {
2749                                                 if (redir.src.zone[i ? "masq6" : "masq"] && length(rip[i])) {
2750                                                         let snat_addr = refaddrs[i]?.[0];
2751
2752                                                         /* For internal reflection sources try to find a suitable candiate IP
2753                                                          * among the reflection zone subnets which is within the same subnet
2754                                                          * as the original DNAT destination. If we can't find any matching
2755                                                          * one then simply take the first candidate. */
2756                                                         if (redir.reflection_src == "internal") {
2757                                                                 for (let zone_addr in rzone.zone.related_subnets) {
2758                                                                         if (zone_addr.family != rip[i][0].family)
2759                                                                                 continue;
2760
2761                                                                         let r = apply_mask(rip[i][0].addr, zone_addr.mask);
2762                                                                         let a = apply_mask(zone_addr.addr, zone_addr.mask);
2763
2764                                                                         if (r != a)
2765                                                                                 continue;
2766
2767                                                                         snat_addr = zone_addr;
2768                                                                         break;
2769                                                                 }
2770                                                         }
2771
2772                                                         if (!snat_addr) {
2773                                                                 this.warn_section(data, `${redir.reflection_src || "external"} rewrite IP cannot be determined, disabling reflection`);
2774                                                         }
2775                                                         else if (!length(iaddrs[i])) {
2776                                                                 this.warn_section(data, "internal address range cannot be determined, disabling reflection");
2777                                                         }
2778                                                         else if (!length(eaddrs[i])) {
2779                                                                 this.warn_section(data, "external address range cannot be determined, disabling reflection");
2780                                                         }
2781                                                         else {
2782                                                                 refredir.src = rzone;
2783                                                                 refredir.dest = null;
2784                                                                 refredir.target = "dnat";
2785
2786                                                                 for (let saddrs in subnets_group_by_masking(iaddrs[i]))
2787                                                                         for (let daddrs in subnets_group_by_masking(eaddrs[i]))
2788                                                                                 add_rule(i ? 6 : 4, proto, saddrs, daddrs, rip[i], sport, dport, rport, null, refredir);
2789
2790                                                                 refredir.src = null;
2791                                                                 refredir.dest = rzone;
2792                                                                 refredir.target = "snat";
2793
2794                                                                 for (let daddrs in subnets_group_by_masking(rip[i]))
2795                                                                         for (let saddrs in subnets_group_by_masking(iaddrs[i]))
2796                                                                                 add_rule(i ? 6 : 4, proto, saddrs, daddrs, [ to_hostaddr(snat_addr) ], null, rport, null, null, refredir);
2797                                                         }
2798                                                 }
2799                                         }
2800                                 }
2801                         }
2802
2803                         if (length(rip[0]) > 1 || length(rip[1]) > 1)
2804                                 this.warn_section(data, "specifies multiple rewrite addresses, using only first one");
2805
2806                         let has_ip4_addr = length(sip[0]) || length(dip[0]) || length(rip[0]),
2807                             has_ip6_addr = length(sip[1]) || length(dip[1]) || length(rip[1]),
2808                             has_any_addr = has_ip4_addr || has_ip6_addr;
2809
2810                         /* check if there's no AF specific bits, in this case we can do an AF agnostic rule */
2811                         if (!family && !has_any_addr) {
2812                                 /* for backwards compatibility, treat unspecified family as IPv4 unless user explicitly requested any (0) */
2813                                 if (family == null)
2814                                         family = 4;
2815
2816                                 add_rule(family, proto, [], [], null, sport, dport, rport, null, redir);
2817                         }
2818
2819                         /* we need to emit one or two AF specific rules */
2820                         else {
2821                                 if ((!family || family == 4) && (!has_any_addr || has_ip4_addr)) {
2822                                         for (let saddrs in subnets_group_by_masking(sip[0]))
2823                                                 for (let daddrs in subnets_group_by_masking(dip[0]))
2824                                                         add_rule(4, proto, saddrs, daddrs, rip[0], sport, dport, rport, ipset, redir);
2825                                 }
2826
2827                                 if ((!family || family == 6) && (!has_any_addr || has_ip6_addr)) {
2828                                         for (let saddrs in subnets_group_by_masking(sip[1]))
2829                                                 for (let daddrs in subnets_group_by_masking(dip[1]))
2830                                                         add_rule(6, proto, saddrs, daddrs, rip[1], sport, dport, rport, ipset, redir);
2831                                 }
2832                         }
2833                 }
2834         },
2835
2836         parse_nat: function(data) {
2837                 let snat = this.parse_options(data, {
2838                         enabled: [ "bool", "1" ],
2839
2840                         name: [ "string", this.section_id(data[".name"]) ],
2841                         family: [ "family" ],
2842
2843                         src: [ "zone_ref" ],
2844                         device: [ "string" ],
2845
2846                         ipset: [ "setmatch", null, UNSUPPORTED ],
2847
2848                         proto: [ "protocol", "all", PARSE_LIST | FLATTEN_LIST ],
2849
2850                         src_ip: [ "network" ],
2851                         src_port: [ "port" ],
2852
2853                         snat_ip: [ "network", null, NO_INVERT ],
2854                         snat_port: [ "port", null, NO_INVERT ],
2855
2856                         dest_ip: [ "network" ],
2857                         dest_port: [ "port" ],
2858
2859                         extra: [ "string", null, UNSUPPORTED ],
2860
2861                         limit: [ "limit" ],
2862                         limit_burst: [ "int" ],
2863
2864                         connlimit_ports: [ "bool" ],
2865
2866                         utc_time: [ "bool" ],
2867                         start_date: [ "date" ],
2868                         stop_date: [ "date" ],
2869                         start_time: [ "time" ],
2870                         stop_time: [ "time" ],
2871                         weekdays: [ "weekdays" ],
2872                         monthdays: [ "monthdays", null, UNSUPPORTED ],
2873
2874                         mark: [ "mark" ],
2875
2876                         target: [ "target", "masquerade" ]
2877                 });
2878
2879                 if (snat === false) {
2880                         this.warn_section(data, "skipped due to invalid options");
2881                         return;
2882                 }
2883                 else if (!snat.enabled) {
2884                         this.warn_section(data, "is disabled, ignoring section");
2885                         return;
2886                 }
2887
2888                 if (!(snat.target in ["accept", "snat", "masquerade"])) {
2889                         this.warn_section(data, "has invalid target specified, defaulting to masquerade");
2890                         snat.target = "masquerade";
2891                 }
2892
2893                 if (snat.target == "snat" && !snat.snat_ip && !snat.snat_port) {
2894                         this.warn_section(data, "needs either 'snat_ip' or 'snat_port' for target snat, ignoring section");
2895                         return;
2896                 }
2897                 else if (snat.target != "snat" && snat.snat_ip) {
2898                         this.warn_section(data, "must not use 'snat_ip' for non-snat target, ignoring section");
2899                         return;
2900                 }
2901                 else if (snat.target != "snat" && snat.snat_port) {
2902                         this.warn_section(data, "must not use 'snat_port' for non-snat target, ignoring section");
2903                         return;
2904                 }
2905
2906                 if ((snat.snat_port || snat.src_port || snat.dest_port) && !ensure_tcpudp(snat.proto)) {
2907                         this.warn_section(data, "specifies ports but no UDP/TCP protocol, ignoring section");
2908                         return;
2909                 }
2910
2911                 if (snat.snat_ip && length(filter(snat.snat_ip.addrs, a => a.bits == -1 || a.invert))) {
2912                         this.warn_section(data, "must not use inversion or non-contiguous masks in 'snat_ip', ignoring section");
2913                         return;
2914                 }
2915
2916                 let add_rule = (family, proto, saddrs, daddrs, raddrs, sport, dport, rport, snat) => {
2917                         let n = {
2918                                 ...snat,
2919
2920                                 family: family,
2921                                 proto: proto,
2922                                 has_addrs: !!(saddrs[0] || saddrs[1] || saddrs[2] || daddrs[0] || daddrs[1] || daddrs[2]),
2923                                 has_ports: !!(sport || dport),
2924                                 saddrs_pos: map(saddrs[0], this.cidr),
2925                                 saddrs_neg: map(saddrs[1], this.cidr),
2926                                 saddrs_masked: saddrs[2],
2927                                 daddrs_pos: map(daddrs[0], this.cidr),
2928                                 daddrs_neg: map(daddrs[1], this.cidr),
2929                                 daddrs_masked: daddrs[2],
2930                                 sports_pos: map(filter_pos(to_array(sport)), this.port),
2931                                 sports_neg: map(filter_neg(to_array(sport)), this.port),
2932                                 dports_pos: map(filter_pos(to_array(dport)), this.port),
2933                                 dports_neg: map(filter_neg(to_array(dport)), this.port),
2934
2935                                 raddr: raddrs ? raddrs[0] : null,
2936                                 rport: rport,
2937
2938                                 chain: snat.src?.zone ? `srcnat_${snat.src.zone.name}` : "srcnat"
2939                         };
2940
2941                         push(this.state.redirects ||= [], n);
2942                 };
2943
2944                 for (let proto in snat.proto) {
2945                         let sip, dip, rip, sport, dport, rport;
2946                         let family = snat.family;
2947
2948                         sip = subnets_split_af(snat.src_ip);
2949                         dip = subnets_split_af(snat.dest_ip);
2950                         rip = subnets_split_af(snat.snat_ip);
2951
2952                         switch (proto.name) {
2953                         case "tcp":
2954                         case "udp":
2955                                 sport = snat.src_port;
2956                                 dport = snat.dest_port;
2957                                 rport = snat.snat_port;
2958                                 break;
2959                         }
2960
2961                         if (length(rip[0]) > 1 || length(rip[1]) > 1)
2962                                 this.warn_section(data, "specifies multiple rewrite addresses, using only first one");
2963
2964                         family = infer_family(family, [
2965                                 sip, "source IP",
2966                                 dip, "destination IP",
2967                                 rip, "rewrite IP",
2968                                 snat.src?.zone, "source zone"
2969                         ]);
2970
2971                         if (type(family) == "string") {
2972                                 this.warn_section(data, `${family}, skipping`);
2973                                 continue;
2974                         }
2975
2976                         if (snat.src?.zone)
2977                                 snat.src.zone.dflags.snat = true;
2978
2979                         /* if no family was configured, infer target family from IP addresses */
2980                         if (family === null) {
2981                                 if ((length(sip[0]) || length(dip[0]) || length(rip[0])) && !length(sip[1]) && !length(dip[1]) && !length(rip[1]))
2982                                         family = 4;
2983                                 else if ((length(sip[1]) || length(dip[1]) || length(rip[1])) && !length(sip[0]) && !length(dip[0]) && !length(rip[0]))
2984                                         family = 6;
2985                                 else
2986                                         family = 4; /* default to IPv4 only for backwards compatibility, unless an explict family any was configured */
2987                         }
2988
2989                         /* check if there's no AF specific bits, in this case we can do an AF agnostic rule */
2990                         if (!family && !length(sip[0]) && !length(sip[1]) && !length(dip[0]) && !length(dip[1]) && !length(rip[0]) && !length(rip[1])) {
2991                                 add_rule(0, proto, [], [], null, sport, dport, rport, snat);
2992                         }
2993
2994                         /* we need to emit one or two AF specific rules */
2995                         else {
2996                                 if (family == 0 || family == 4)
2997                                         for (let saddr in subnets_group_by_masking(sip[0]))
2998                                                 for (let daddr in subnets_group_by_masking(dip[0]))
2999                                                         add_rule(4, proto, saddr, daddr, rip[0], sport, dport, rport, snat);
3000
3001                                 if (family == 0 || family == 6)
3002                                         for (let saddr in subnets_group_by_masking(sip[1]))
3003                                                 for (let daddr in subnets_group_by_masking(dip[1]))
3004                                                         add_rule(6, proto, saddr, daddr, rip[1], sport, dport, rport, snat);
3005                         }
3006                 }
3007         },
3008
3009         parse_ipset: function(data) {
3010                 let ipset = this.parse_options(data, {
3011                         enabled: [ "bool", "1" ],
3012                         reload_set: [ "bool" ],
3013                         counters: [ "bool" ],
3014                         comment: [ "bool" ],
3015
3016                         name: [ "string", null, REQUIRED ],
3017                         family: [ "family", "4" ],
3018
3019                         storage: [ "string", null, UNSUPPORTED ],
3020                         match: [ "ipsettype", null, PARSE_LIST ],
3021
3022                         iprange: [ "string", null, UNSUPPORTED ],
3023                         portrange: [ "string", null, UNSUPPORTED ],
3024
3025                         netmask: [ "int", null, UNSUPPORTED ],
3026                         maxelem: [ "int" ],
3027                         hashsize: [ "int", null, UNSUPPORTED ],
3028                         timeout: [ "int", "-1" ],
3029
3030                         external: [ "string", null, UNSUPPORTED ],
3031
3032                         entry: [ "string", null, PARSE_LIST ],
3033                         loadfile: [ "string" ]
3034                 });
3035
3036                 if (ipset === false) {
3037                         this.warn_section(data, "skipped due to invalid options");
3038                         return;
3039                 }
3040                 else if (!ipset.enabled) {
3041                         this.warn_section(data, "is disabled, ignoring section");
3042                         return;
3043                 }
3044
3045                 if (ipset.family == 0) {
3046                         this.warn_section(data, "must not specify family 'any'");
3047                         return;
3048                 }
3049                 else if (!length(ipset.match)) {
3050                         this.warn_section(data, "has no datatypes assigned");
3051                         return;
3052                 }
3053
3054                 let dirs = map(ipset.match, m => m[0]),
3055                     types = map(ipset.match, m => m[1]),
3056                     interval = false;
3057
3058                 if ("set" in types) {
3059                         this.warn_section(data, "match type 'set' is not supported");
3060                         return;
3061                 }
3062
3063                 if ("net" in types) {
3064                         if (this.kernel < 0x05060000) {
3065                                 this.warn_section(data, "match type 'net' requires kernel 5.6 or later");
3066                                 return;
3067                         }
3068
3069                         interval = true;
3070                 }
3071
3072                 let s = {
3073                         ...ipset,
3074
3075                         fw4types: types,
3076
3077                         types: map(types, (t) => {
3078                                 switch (t) {
3079                                 case 'ip':
3080                                 case 'net':
3081                                         return (ipset.family == 4) ? 'ipv4_addr' : 'ipv6_addr';
3082
3083                                 case 'mac':
3084                                         return 'ether_addr';
3085
3086                                 case 'port':
3087                                         return 'inet_service';
3088                                 }
3089                         }),
3090
3091                         directions: dirs,
3092                         interval: interval
3093                 };
3094
3095                 s.entries = filter(map(ipset.entry, (e) => {
3096                         let v = this.parse_ipsetentry(e, s);
3097
3098                         if (!v)
3099                                 this.warn_section(data, `ignoring invalid ipset entry '${e}'`);
3100
3101                         return v;
3102                 }), (e) => (e != null));
3103
3104                 push(this.state.ipsets ||= [], s);
3105         }
3106 };