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