zones.c

   1 /*
   2  * firewall3 - 3rd OpenWrt UCI firewall implementation
   3  *
   4  *   Copyright (C) 2013 Jo-Philipp Wich <jow@openwrt.org>
   5  *
   6  * Permission to use, copy, modify, and/or distribute this software for any
   7  * purpose with or without fee is hereby granted, provided that the above
   8  * copyright notice and this permission notice appear in all copies.
   9  *
  10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  17  */
  18
  19 #include "zones.h"
  20 #include "ubus.h"
  21
  22
  23 #define C(f, tbl, tgt, fmt) \
  24         { FW3_FAMILY_##f, FW3_TABLE_##tbl, FW3_FLAG_##tgt, fmt }
  25
  26 static const struct fw3_rule_spec zone_chains[] = {
  27         C(ANY, FILTER, UNSPEC,        "zone_%1$s_input"),
  28         C(ANY, FILTER, UNSPEC,        "zone_%1$s_output"),
  29         C(ANY, FILTER, UNSPEC,        "zone_%1$s_forward"),
  30
  31         C(ANY, FILTER, SRC_ACCEPT,    "zone_%1$s_src_ACCEPT"),
  32         C(ANY, FILTER, SRC_REJECT,    "zone_%1$s_src_REJECT"),
  33         C(ANY, FILTER, SRC_DROP,      "zone_%1$s_src_DROP"),
  34
  35         C(ANY, FILTER, ACCEPT,        "zone_%1$s_dest_ACCEPT"),
  36         C(ANY, FILTER, REJECT,        "zone_%1$s_dest_REJECT"),
  37         C(ANY, FILTER, DROP,          "zone_%1$s_dest_DROP"),
  38
  39         C(V4,  NAT,    SNAT,          "zone_%1$s_postrouting"),
  40         C(V4,  NAT,    DNAT,          "zone_%1$s_prerouting"),
  41
  42         C(ANY, FILTER, CUSTOM_CHAINS, "input_%1$s_rule"),
  43         C(ANY, FILTER, CUSTOM_CHAINS, "output_%1$s_rule"),
  44         C(ANY, FILTER, CUSTOM_CHAINS, "forwarding_%1$s_rule"),
  45
  46         C(V4,  NAT,    CUSTOM_CHAINS, "prerouting_%1$s_rule"),
  47         C(V4,  NAT,    CUSTOM_CHAINS, "postrouting_%1$s_rule"),
  48
  49         { }
  50 };
  51
  52
  53 #define R(dir1, dir2) \
  54         "zone_%1$s_" #dir1 " -m comment --comment \"user chain for %1$s " \
  55         #dir2 "\" -j " #dir2 "_%1$s_rule"
  56
  57 static const struct fw3_rule_spec zone_rules[] = {
  58         C(ANY, FILTER, CUSTOM_CHAINS, R(input, input)),
  59         C(ANY, FILTER, CUSTOM_CHAINS, R(output, output)),
  60         C(ANY, FILTER, CUSTOM_CHAINS, R(forward, forwarding)),
  61
  62         C(V4,  NAT,    CUSTOM_CHAINS, R(prerouting, prerouting)),
  63         C(V4,  NAT,    CUSTOM_CHAINS, R(postrouting, postrouting)),
  64
  65         { }
  66 };
  67
  68 const struct fw3_option fw3_zone_opts[] = {
  69         FW3_OPT("enabled",             bool,     zone,     enabled),
  70
  71         FW3_OPT("name",                string,   zone,     name),
  72         FW3_OPT("family",              family,   zone,     family),
  73
  74         FW3_LIST("network",            device,   zone,     networks),
  75         FW3_LIST("device",             device,   zone,     devices),
  76         FW3_LIST("subnet",             address,  zone,     subnets),
  77
  78         FW3_OPT("input",               target,   zone,     policy_input),
  79         FW3_OPT("forward",             target,   zone,     policy_forward),
  80         FW3_OPT("output",              target,   zone,     policy_output),
  81
  82         FW3_OPT("masq",                bool,     zone,     masq),
  83         FW3_LIST("masq_src",           address,  zone,     masq_src),
  84         FW3_LIST("masq_dest",          address,  zone,     masq_dest),
  85
  86         FW3_OPT("extra",               string,   zone,     extra_src),
  87         FW3_OPT("extra_src",           string,   zone,     extra_src),
  88         FW3_OPT("extra_dest",          string,   zone,     extra_dest),
  89
  90         FW3_OPT("conntrack",           bool,     zone,     conntrack),
  91         FW3_OPT("mtu_fix",             bool,     zone,     mtu_fix),
  92         FW3_OPT("custom_chains",       bool,     zone,     custom_chains),
  93
  94         FW3_OPT("log",                 bool,     zone,     log),
  95         FW3_OPT("log_limit",           limit,    zone,     log_limit),
  96
  97         { }
  98 };
  99
 100
 101 static void
 102 check_policy(struct uci_element *e, enum fw3_flag *pol, enum fw3_flag def,
 103              const char *name)
 104 {
 105         if (*pol == FW3_FLAG_UNSPEC)
 106         {
 107                 warn_elem(e, "has no %s policy specified, using default", name);
 108                 *pol = def;
 109         }
 110         else if (*pol > FW3_FLAG_DROP)
 111         {
 112                 warn_elem(e, "has invalid %s policy, using default", name);
 113                 *pol = def;
 114         }
 115 }
 116
 117 static void
 118 resolve_networks(struct uci_element *e, struct fw3_zone *zone)
 119 {
 120         struct fw3_device *net, *tmp;
 121
 122         list_for_each_entry(net, &zone->networks, list)
 123         {
 124                 tmp = fw3_ubus_device(net->name);
 125
 126                 if (!tmp)
 127                 {
 128                         warn_elem(e, "cannot resolve device of network '%s'", net->name);
 129                         continue;
 130                 }
 131
 132                 tmp->network = net;
 133                 list_add_tail(&tmp->list, &zone->devices);
 134         }
 135 }
 136
 137 struct fw3_zone *
 138 fw3_alloc_zone(void)
 139 {
 140         struct fw3_zone *zone;
 141
 142         zone = malloc(sizeof(*zone));
 143
 144         if (!zone)
 145                 return NULL;
 146
 147         memset(zone, 0, sizeof(*zone));
 148
 149         INIT_LIST_HEAD(&zone->networks);
 150         INIT_LIST_HEAD(&zone->devices);
 151         INIT_LIST_HEAD(&zone->subnets);
 152         INIT_LIST_HEAD(&zone->masq_src);
 153         INIT_LIST_HEAD(&zone->masq_dest);
 154
 155         INIT_LIST_HEAD(&zone->running_networks);
 156         INIT_LIST_HEAD(&zone->running_devices);
 157
 158         zone->enabled = true;
 159         zone->custom_chains = true;
 160         zone->log_limit.rate = 10;
 161
 162         return zone;
 163 }
 164
 165 void
 166 fw3_load_zones(struct fw3_state *state, struct uci_package *p)
 167 {
 168         struct uci_section *s;
 169         struct uci_element *e;
 170         struct fw3_zone *zone;
 171         struct fw3_defaults *defs = &state->defaults;
 172
 173         INIT_LIST_HEAD(&state->zones);
 174
 175         uci_foreach_element(&p->sections, e)
 176         {
 177                 s = uci_to_section(e);
 178
 179                 if (strcmp(s->type, "zone"))
 180                         continue;
 181
 182                 zone = fw3_alloc_zone();
 183
 184                 if (!zone)
 185                         continue;
 186
 187                 fw3_parse_options(zone, fw3_zone_opts, s);
 188
 189                 if (!zone->enabled)
 190                 {
 191                         fw3_free_zone(zone);
 192                         continue;
 193                 }
 194
 195                 if (!zone->extra_dest)
 196                         zone->extra_dest = zone->extra_src;
 197
 198                 if (!defs->custom_chains && zone->custom_chains)
 199                         zone->custom_chains = false;
 200
 201                 if (!zone->name || !*zone->name)
 202                 {
 203                         warn_elem(e, "has no name - ignoring");
 204                         fw3_free_zone(zone);
 205                         continue;
 206                 }
 207
 208                 if (list_empty(&zone->networks) && list_empty(&zone->devices) &&
 209                     list_empty(&zone->subnets) && !zone->extra_src)
 210                 {
 211                         warn_elem(e, "has no device, network, subnet or extra options");
 212                 }
 213
 214                 check_policy(e, &zone->policy_input, defs->policy_input, "input");
 215                 check_policy(e, &zone->policy_output, defs->policy_output, "output");
 216                 check_policy(e, &zone->policy_forward, defs->policy_forward, "forward");
 217
 218                 resolve_networks(e, zone);
 219
 220                 if (zone->masq)
 221                 {
 222                         setbit(zone->flags[0], FW3_FLAG_SNAT);
 223                         zone->conntrack = true;
 224                 }
 225
 226                 if (zone->custom_chains)
 227                 {
 228                         setbit(zone->flags[0], FW3_FLAG_SNAT);
 229                         setbit(zone->flags[0], FW3_FLAG_DNAT);
 230                 }
 231
 232                 setbit(zone->flags[0], fw3_to_src_target(zone->policy_input));
 233                 setbit(zone->flags[0], zone->policy_output);
 234                 setbit(zone->flags[0], zone->policy_forward);
 235
 236                 setbit(zone->flags[1], fw3_to_src_target(zone->policy_input));
 237                 setbit(zone->flags[1], zone->policy_output);
 238                 setbit(zone->flags[1], zone->policy_forward);
 239
 240                 list_add_tail(&zone->list, &state->zones);
 241         }
 242 }
 243
 244
 245 static void
 246 print_zone_chain(enum fw3_table table, enum fw3_family family,
 247                  struct fw3_zone *zone, bool reload, struct fw3_state *state)
 248 {
 249         bool c, r;
 250         uint32_t custom_mask = ~0;
 251
 252         if (!fw3_is_family(zone, family))
 253                 return;
 254
 255         set(zone->flags, family, table);
 256
 257         /* Don't touch user chains on reload */
 258         if (reload)
 259                 delbit(custom_mask, FW3_FLAG_CUSTOM_CHAINS);
 260
 261         if (zone->custom_chains)
 262                 set(zone->flags, family, FW3_FLAG_CUSTOM_CHAINS);
 263
 264         if (!zone->conntrack && !state->defaults.drop_invalid)
 265                 set(zone->flags, family, FW3_FLAG_NOTRACK);
 266
 267         c = fw3_pr_rulespec(table, family, zone->flags, custom_mask, zone_chains,
 268                             ":%s - [0:0]\n", zone->name);
 269
 270         r = fw3_pr_rulespec(table, family, zone->flags, 0, zone_rules,
 271                             "-A %s\n", zone->name);
 272
 273         if (c || r)
 274         {
 275                 info("   * Zone '%s'", zone->name);
 276                 fw3_set_running(zone, &state->running_zones);
 277
 278                 set(zone->flags, family, table);
 279         }
 280 }
 281
 282 static void
 283 print_interface_rule(enum fw3_table table, enum fw3_family family,
 284                      struct fw3_zone *zone, struct fw3_device *dev,
 285                      struct fw3_address *sub, bool reload, bool disable_notrack)
 286 {
 287         enum fw3_flag t;
 288
 289 #define jump_target(t) \
 290         ((t == FW3_FLAG_REJECT) ? "reject" : fw3_flag_names[t])
 291
 292         if (table == FW3_TABLE_FILTER)
 293         {
 294                 for (t = FW3_FLAG_ACCEPT; t <= FW3_FLAG_DROP; t++)
 295                 {
 296                         if (has(zone->flags, family, fw3_to_src_target(t)))
 297                         {
 298                                 fw3_pr("-A zone_%s_src_%s", zone->name, fw3_flag_names[t]);
 299                                 fw3_format_in_out(dev, NULL);
 300                                 fw3_format_src_dest(sub, NULL);
 301                                 fw3_format_extra(zone->extra_src);
 302                                 fw3_pr(" -j %s\n", jump_target(t));
 303                         }
 304
 305                         if (has(zone->flags, family, t))
 306                         {
 307                                 fw3_pr("-A zone_%s_dest_%s", zone->name, fw3_flag_names[t]);
 308                                 fw3_format_in_out(NULL, dev);
 309                                 fw3_format_src_dest(NULL, sub);
 310                                 fw3_format_extra(zone->extra_dest);
 311                                 fw3_pr(" -j %s\n", jump_target(t));
 312                         }
 313                 }
 314
 315                 fw3_pr("-A delegate_input");
 316                 fw3_format_in_out(dev, NULL);
 317                 fw3_format_src_dest(sub, NULL);
 318                 fw3_format_extra(zone->extra_src);
 319                 fw3_pr(" -j zone_%s_input\n", zone->name);
 320
 321                 fw3_pr("-A delegate_forward");
 322                 fw3_format_in_out(dev, NULL);
 323                 fw3_format_src_dest(sub, NULL);
 324                 fw3_format_extra(zone->extra_src);
 325                 fw3_pr(" -j zone_%s_forward\n", zone->name);
 326
 327                 fw3_pr("-A delegate_output");
 328                 fw3_format_in_out(NULL, dev);
 329                 fw3_format_src_dest(NULL, sub);
 330                 fw3_format_extra(zone->extra_dest);
 331                 fw3_pr(" -j zone_%s_output\n", zone->name);
 332         }
 333         else if (table == FW3_TABLE_NAT)
 334         {
 335                 if (has(zone->flags, family, FW3_FLAG_DNAT))
 336                 {
 337                         fw3_pr("-A delegate_prerouting");
 338                         fw3_format_in_out(dev, NULL);
 339                         fw3_format_src_dest(sub, NULL);
 340                         fw3_format_extra(zone->extra_src);
 341                         fw3_pr(" -j zone_%s_prerouting\n", zone->name);
 342                 }
 343
 344                 if (has(zone->flags, family, FW3_FLAG_SNAT))
 345                 {
 346                         fw3_pr("-A delegate_postrouting");
 347                         fw3_format_in_out(NULL, dev);
 348                         fw3_format_src_dest(NULL, sub);
 349                         fw3_format_extra(zone->extra_dest);
 350                         fw3_pr(" -j zone_%s_postrouting\n", zone->name);
 351                 }
 352         }
 353         else if (table == FW3_TABLE_MANGLE)
 354         {
 355                 if (zone->mtu_fix)
 356                 {
 357                         if (zone->log)
 358                         {
 359                                 fw3_pr("-A mssfix");
 360                                 fw3_format_in_out(NULL, dev);
 361                                 fw3_format_src_dest(NULL, sub);
 362                                 fw3_pr(" -p tcp --tcp-flags SYN,RST SYN");
 363                                 fw3_format_limit(&zone->log_limit);
 364                                 fw3_format_comment(zone->name, " (mtu_fix logging)");
 365                                 fw3_pr(" -j LOG --log-prefix \"MSSFIX(%s): \"\n", zone->name);
 366                         }
 367
 368                         fw3_pr("-A mssfix");
 369                         fw3_format_in_out(NULL, dev);
 370                         fw3_format_src_dest(NULL, sub);
 371                         fw3_pr(" -p tcp --tcp-flags SYN,RST SYN");
 372                         fw3_format_comment(zone->name, " (mtu_fix)");
 373                         fw3_pr(" -j TCPMSS --clamp-mss-to-pmtu\n");
 374                 }
 375         }
 376         else if (table == FW3_TABLE_RAW)
 377         {
 378                 if (!zone->conntrack && !disable_notrack)
 379                 {
 380                         fw3_pr("-A notrack");
 381                         fw3_format_in_out(dev, NULL);
 382                         fw3_format_src_dest(sub, NULL);
 383                         fw3_format_extra(zone->extra_src);
 384                         fw3_format_comment(zone->name, " (notrack)");
 385                         fw3_pr(" -j CT --notrack\n", zone->name);
 386                 }
 387         }
 388 }
 389
 390 static void
 391 print_interface_rules(enum fw3_table table, enum fw3_family family,
 392                       struct fw3_zone *zone, bool reload, bool disable_notrack)
 393 {
 394         struct fw3_device *dev;
 395         struct fw3_address *sub;
 396
 397         fw3_foreach(dev, &zone->devices)
 398         fw3_foreach(sub, &zone->subnets)
 399         {
 400                 if (!fw3_is_family(sub, family))
 401                         continue;
 402
 403                 if (!dev && !sub)
 404                         continue;
 405
 406                 print_interface_rule(table, family, zone, dev, sub, reload, disable_notrack);
 407         }
 408 }
 409
 410 static void
 411 print_zone_rule(enum fw3_table table, enum fw3_family family,
 412                 struct fw3_zone *zone, bool reload, bool disable_notrack)
 413 {
 414         struct fw3_address *msrc;
 415         struct fw3_address *mdest;
 416
 417         enum fw3_flag t;
 418
 419         if (!fw3_is_family(zone, family))
 420                 return;
 421
 422         switch (table)
 423         {
 424         case FW3_TABLE_FILTER:
 425                 fw3_pr("-A zone_%s_input -j zone_%s_src_%s\n",
 426                            zone->name, zone->name, fw3_flag_names[zone->policy_input]);
 427
 428                 fw3_pr("-A zone_%s_forward -j zone_%s_dest_%s\n",
 429                            zone->name, zone->name, fw3_flag_names[zone->policy_forward]);
 430
 431                 fw3_pr("-A zone_%s_output -j zone_%s_dest_%s\n",
 432                            zone->name, zone->name, fw3_flag_names[zone->policy_output]);
 433
 434                 if (zone->log)
 435                 {
 436                         for (t = FW3_FLAG_REJECT; t <= FW3_FLAG_DROP; t++)
 437                         {
 438                                 if (has(zone->flags, family, fw3_to_src_target(t)))
 439                                 {
 440                                         fw3_pr("-A zone_%s_src_%s", zone->name, fw3_flag_names[t]);
 441                                         fw3_format_limit(&zone->log_limit);
 442                                         fw3_pr(" -j LOG --log-prefix \"%s(src %s)\"\n",
 443                                                    fw3_flag_names[t], zone->name);
 444                                 }
 445
 446                                 if (has(zone->flags, family, t))
 447                                 {
 448                                         fw3_pr("-A zone_%s_dest_%s", zone->name, fw3_flag_names[t]);
 449                                         fw3_format_limit(&zone->log_limit);
 450                                         fw3_pr(" -j LOG --log-prefix \"%s(dest %s)\"\n",
 451                                                    fw3_flag_names[t], zone->name);
 452                                 }
 453                         }
 454                 }
 455                 break;
 456
 457         case FW3_TABLE_NAT:
 458                 if (zone->masq && family == FW3_FAMILY_V4)
 459                 {
 460                         fw3_foreach(msrc, &zone->masq_src)
 461                         fw3_foreach(mdest, &zone->masq_dest)
 462                         {
 463                                 fw3_pr("-A zone_%s_postrouting ", zone->name);
 464                                 fw3_format_src_dest(msrc, mdest);
 465                                 fw3_pr("-j MASQUERADE\n");
 466                         }
 467                 }
 468                 break;
 469
 470         case FW3_TABLE_RAW:
 471         case FW3_TABLE_MANGLE:
 472                 break;
 473         }
 474
 475         print_interface_rules(table, family, zone, reload, disable_notrack);
 476 }
 477
 478 void
 479 fw3_print_zone_chains(enum fw3_table table, enum fw3_family family,
 480                       bool reload, struct fw3_state *state)
 481 {
 482         struct fw3_zone *zone;
 483
 484         list_for_each_entry(zone, &state->zones, list)
 485                 print_zone_chain(table, family, zone, reload, state);
 486 }
 487
 488 void
 489 fw3_print_zone_rules(enum fw3_table table, enum fw3_family family,
 490                      bool reload, struct fw3_state *state)
 491 {
 492         struct fw3_zone *zone;
 493
 494         list_for_each_entry(zone, &state->zones, list)
 495                 print_zone_rule(table, family, zone, reload, state->defaults.drop_invalid);
 496 }
 497
 498 void
 499 fw3_flush_zones(enum fw3_table table, enum fw3_family family,
 500                             bool pass2, bool reload, struct fw3_state *state)
 501 {
 502         struct fw3_zone *z, *tmp;
 503         uint32_t custom_mask = ~0;
 504
 505         /* don't touch user chains on selective stop */
 506         if (reload)
 507                 delbit(custom_mask, FW3_FLAG_CUSTOM_CHAINS);
 508
 509         list_for_each_entry_safe(z, tmp, &state->running_zones, running_list)
 510         {
 511                 if (!has(z->flags, family, table))
 512                         continue;
 513
 514                 fw3_pr_rulespec(table, family, z->flags, custom_mask, zone_chains,
 515                                 pass2 ? "-X %s\n" : "-F %s\n", z->name);
 516
 517                 if (pass2)
 518                 {
 519                         del(z->flags, family, table);
 520                 }
 521         }
 522 }
 523
 524 void
 525 fw3_hotplug_zones(bool add, struct fw3_state *state)
 526 {
 527         struct fw3_zone *z;
 528         struct fw3_device *d;
 529
 530         if (add)
 531         {
 532                 list_for_each_entry(z, &state->running_zones, running_list)
 533                 {
 534                         if (!hasbit(z->flags[0], FW3_FLAG_HOTPLUG))
 535                         {
 536                                 list_for_each_entry(d, &z->devices, list)
 537                                         fw3_hotplug(add, z, d);
 538
 539                                 setbit(z->flags[0], FW3_FLAG_HOTPLUG);
 540                         }
 541                 }
 542         }
 543         else
 544         {
 545                 list_for_each_entry(z, &state->running_zones, running_list)
 546                 {
 547                         if (hasbit(z->flags[0], FW3_FLAG_HOTPLUG))
 548                         {
 549                                 list_for_each_entry(d, &z->running_devices, list)
 550                                         fw3_hotplug(add, z, d);
 551
 552                                 delbit(z->flags[0], FW3_FLAG_HOTPLUG);
 553                         }
 554                 }
 555         }
 556 }
 557
 558 struct fw3_zone *
 559 fw3_lookup_zone(struct fw3_state *state, const char *name, bool running)
 560 {
 561         struct fw3_zone *z;
 562
 563         if (list_empty(&state->zones))
 564                 return NULL;
 565
 566         list_for_each_entry(z, &state->zones, list)
 567         {
 568                 if (strcmp(z->name, name))
 569                         continue;
 570
 571                 if (!running || z->running_list.next)
 572                         return z;
 573
 574                 break;
 575         }
 576
 577         return NULL;
 578 }
 579
 580 void
 581 fw3_free_zone(struct fw3_zone *zone)
 582 {
 583         struct fw3_device *dev, *tmp;
 584
 585         list_for_each_entry_safe(dev, tmp, &zone->running_devices, list)
 586         {
 587                 list_del(&dev->list);
 588                 free(dev);
 589         }
 590
 591         list_for_each_entry_safe(dev, tmp, &zone->running_networks, list)
 592         {
 593                 list_del(&dev->list);
 594                 free(dev);
 595         }
 596
 597         fw3_free_object(zone, fw3_zone_opts);
 598 }