2 * firewall3 - 3rd OpenWrt UCI firewall implementation
4 * Copyright (C) 2013 Jo-Philipp Wich <jow@openwrt.org>
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.
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.
23 #define C(f, tbl, tgt, fmt) \
24 { FW3_FAMILY_##f, FW3_TABLE_##tbl, FW3_FLAG_##tgt, fmt }
26 static const struct fw3_chain_spec zone_chains[] = {
27 C(ANY, FILTER, UNSPEC, "zone_%s_input"),
28 C(ANY, FILTER, UNSPEC, "zone_%s_output"),
29 C(ANY, FILTER, UNSPEC, "zone_%s_forward"),
31 C(ANY, FILTER, SRC_ACCEPT, "zone_%s_src_ACCEPT"),
32 C(ANY, FILTER, SRC_REJECT, "zone_%s_src_REJECT"),
33 C(ANY, FILTER, SRC_DROP, "zone_%s_src_DROP"),
35 C(ANY, FILTER, ACCEPT, "zone_%s_dest_ACCEPT"),
36 C(ANY, FILTER, REJECT, "zone_%s_dest_REJECT"),
37 C(ANY, FILTER, DROP, "zone_%s_dest_DROP"),
39 C(V4, NAT, SNAT, "zone_%s_postrouting"),
40 C(V4, NAT, DNAT, "zone_%s_prerouting"),
42 C(ANY, RAW, NOTRACK, "zone_%s_notrack"),
44 C(ANY, FILTER, CUSTOM_CHAINS, "input_%s_rule"),
45 C(ANY, FILTER, CUSTOM_CHAINS, "output_%s_rule"),
46 C(ANY, FILTER, CUSTOM_CHAINS, "forwarding_%s_rule"),
48 C(V4, NAT, CUSTOM_CHAINS, "prerouting_%s_rule"),
49 C(V4, NAT, CUSTOM_CHAINS, "postrouting_%s_rule"),
54 const struct fw3_option fw3_zone_opts[] = {
55 FW3_OPT("enabled", bool, zone, enabled),
57 FW3_OPT("name", string, zone, name),
58 FW3_OPT("family", family, zone, family),
60 FW3_LIST("network", device, zone, networks),
61 FW3_LIST("device", device, zone, devices),
62 FW3_LIST("subnet", network, zone, subnets),
64 FW3_OPT("input", target, zone, policy_input),
65 FW3_OPT("forward", target, zone, policy_forward),
66 FW3_OPT("output", target, zone, policy_output),
68 FW3_OPT("masq", bool, zone, masq),
69 FW3_LIST("masq_src", network, zone, masq_src),
70 FW3_LIST("masq_dest", network, zone, masq_dest),
72 FW3_OPT("extra", string, zone, extra_src),
73 FW3_OPT("extra_src", string, zone, extra_src),
74 FW3_OPT("extra_dest", string, zone, extra_dest),
76 FW3_OPT("conntrack", bool, zone, conntrack),
77 FW3_OPT("mtu_fix", bool, zone, mtu_fix),
78 FW3_OPT("custom_chains", bool, zone, custom_chains),
80 FW3_OPT("log", bool, zone, log),
81 FW3_OPT("log_limit", limit, zone, log_limit),
83 FW3_OPT("__flags_v4", int, zone, flags[0]),
84 FW3_OPT("__flags_v6", int, zone, flags[1]),
91 check_policy(struct uci_element *e, enum fw3_flag *pol, enum fw3_flag def,
94 if (*pol == FW3_FLAG_UNSPEC)
96 warn_elem(e, "has no %s policy specified, using default", name);
99 else if (*pol > FW3_FLAG_DROP)
101 warn_elem(e, "has invalid %s policy, using default", name);
107 resolve_networks(struct uci_element *e, struct fw3_zone *zone)
109 struct fw3_device *net, *tmp;
111 list_for_each_entry(net, &zone->networks, list)
113 tmp = fw3_ubus_device(net->name);
117 warn_elem(e, "cannot resolve device of network '%s'", net->name);
121 snprintf(tmp->network, sizeof(tmp->network), "%s", net->name);
122 list_add_tail(&tmp->list, &zone->devices);
129 struct fw3_zone *zone;
131 zone = malloc(sizeof(*zone));
136 memset(zone, 0, sizeof(*zone));
138 INIT_LIST_HEAD(&zone->networks);
139 INIT_LIST_HEAD(&zone->devices);
140 INIT_LIST_HEAD(&zone->subnets);
141 INIT_LIST_HEAD(&zone->masq_src);
142 INIT_LIST_HEAD(&zone->masq_dest);
144 zone->enabled = true;
145 zone->custom_chains = true;
146 zone->log_limit.rate = 10;
152 fw3_load_zones(struct fw3_state *state, struct uci_package *p)
154 struct uci_section *s;
155 struct uci_element *e;
156 struct fw3_zone *zone;
157 struct fw3_defaults *defs = &state->defaults;
159 INIT_LIST_HEAD(&state->zones);
161 uci_foreach_element(&p->sections, e)
163 s = uci_to_section(e);
165 if (strcmp(s->type, "zone"))
168 zone = fw3_alloc_zone();
173 fw3_parse_options(zone, fw3_zone_opts, s);
181 if (!zone->extra_dest)
182 zone->extra_dest = zone->extra_src;
184 if (!defs->custom_chains && zone->custom_chains)
185 zone->custom_chains = false;
187 if (!zone->name || !*zone->name)
189 warn_elem(e, "has no name - ignoring");
194 if (strlen(zone->name) > FW3_ZONE_MAXNAMELEN)
196 warn_elem(e, "must not have a name longer than %u characters",
197 FW3_ZONE_MAXNAMELEN);
202 if (list_empty(&zone->networks) && list_empty(&zone->devices) &&
203 list_empty(&zone->subnets) && !zone->extra_src)
205 warn_elem(e, "has no device, network, subnet or extra options");
208 check_policy(e, &zone->policy_input, defs->policy_input, "input");
209 check_policy(e, &zone->policy_output, defs->policy_output, "output");
210 check_policy(e, &zone->policy_forward, defs->policy_forward, "forward");
212 resolve_networks(e, zone);
216 setbit(zone->flags[0], FW3_FLAG_SNAT);
217 zone->conntrack = true;
220 if (zone->custom_chains)
222 setbit(zone->flags[0], FW3_FLAG_SNAT);
223 setbit(zone->flags[0], FW3_FLAG_DNAT);
226 setbit(zone->flags[0], fw3_to_src_target(zone->policy_input));
227 setbit(zone->flags[0], fw3_to_src_target(zone->policy_forward));
228 setbit(zone->flags[0], zone->policy_output);
230 setbit(zone->flags[1], fw3_to_src_target(zone->policy_input));
231 setbit(zone->flags[1], fw3_to_src_target(zone->policy_forward));
232 setbit(zone->flags[1], zone->policy_output);
234 list_add_tail(&zone->list, &state->zones);
240 print_zone_chain(struct fw3_ipt_handle *handle, struct fw3_state *state,
241 bool reload, struct fw3_zone *zone)
244 struct fw3_ipt_rule *r;
245 const struct fw3_chain_spec *c;
247 const char *flt_chains[] = {
250 "forward", "forwarding",
253 const char *nat_chains[] = {
254 "prerouting", "prerouting",
255 "postrouting", "postrouting",
258 if (!fw3_is_family(zone, handle->family))
261 info(" * Zone '%s'", zone->name);
263 set(zone->flags, handle->family, handle->table);
265 if (zone->custom_chains)
266 set(zone->flags, handle->family, FW3_FLAG_CUSTOM_CHAINS);
268 if (!zone->conntrack && !state->defaults.drop_invalid)
269 set(zone->flags, handle->family, FW3_FLAG_NOTRACK);
271 for (c = zone_chains; c->format; c++)
273 /* don't touch user chains on selective stop */
274 if (reload && c->flag == FW3_FLAG_CUSTOM_CHAINS)
277 if (!fw3_is_family(c, handle->family))
280 if (c->table != handle->table)
284 !hasbit(zone->flags[handle->family == FW3_FAMILY_V6], c->flag))
287 fw3_ipt_create_chain(handle, c->format, zone->name);
290 if (zone->custom_chains)
292 if (handle->table == FW3_TABLE_FILTER)
294 for (i = 0; i < sizeof(flt_chains)/sizeof(flt_chains[0]); i += 2)
296 r = fw3_ipt_rule_new(handle);
297 fw3_ipt_rule_comment(r, "user chain for %s", flt_chains[i+1]);
298 fw3_ipt_rule_target(r, "%s_%s_rule", flt_chains[i+1], zone->name);
299 fw3_ipt_rule_append(r, "zone_%s_%s", zone->name, flt_chains[i]);
302 else if (handle->table == FW3_TABLE_NAT)
304 for (i = 0; i < sizeof(nat_chains)/sizeof(nat_chains[0]); i += 2)
306 r = fw3_ipt_rule_new(handle);
307 fw3_ipt_rule_comment(r, "user chain for %s", nat_chains[i+1]);
308 fw3_ipt_rule_target(r, "%s_%s_rule", nat_chains[i+1], zone->name);
309 fw3_ipt_rule_append(r, "zone_%s_%s", zone->name, nat_chains[i]);
314 set(zone->flags, handle->family, handle->table);
318 print_interface_rule(struct fw3_ipt_handle *handle, struct fw3_state *state,
319 bool reload, struct fw3_zone *zone,
320 struct fw3_device *dev, struct fw3_address *sub)
322 struct fw3_protocol tcp = { .protocol = 6 };
323 struct fw3_ipt_rule *r;
330 const char *chains[] = {
336 #define jump_target(t) \
337 ((t == FW3_FLAG_REJECT) ? "reject" : fw3_flag_names[t])
339 if (handle->table == FW3_TABLE_FILTER)
341 for (t = FW3_FLAG_ACCEPT; t <= FW3_FLAG_DROP; t++)
343 if (has(zone->flags, handle->family, fw3_to_src_target(t)))
345 r = fw3_ipt_rule_create(handle, NULL, dev, NULL, sub, NULL);
346 fw3_ipt_rule_target(r, jump_target(t));
347 fw3_ipt_rule_extra(r, zone->extra_src);
348 fw3_ipt_rule_replace(r, "zone_%s_src_%s", zone->name,
352 if (has(zone->flags, handle->family, t))
354 r = fw3_ipt_rule_create(handle, NULL, NULL, dev, NULL, sub);
355 fw3_ipt_rule_target(r, jump_target(t));
356 fw3_ipt_rule_extra(r, zone->extra_dest);
357 fw3_ipt_rule_replace(r, "zone_%s_dest_%s", zone->name,
362 for (i = 0; i < sizeof(chains)/sizeof(chains[0]); i++)
364 if (*chains[i] == 'o')
365 r = fw3_ipt_rule_create(handle, NULL, NULL, dev, NULL, sub);
367 r = fw3_ipt_rule_create(handle, NULL, dev, NULL, sub, NULL);
369 fw3_ipt_rule_target(r, "zone_%s_%s", zone->name, chains[i]);
371 if (*chains[i] == 'o')
372 fw3_ipt_rule_extra(r, zone->extra_dest);
374 fw3_ipt_rule_extra(r, zone->extra_src);
376 fw3_ipt_rule_replace(r, "delegate_%s", chains[i]);
379 else if (handle->table == FW3_TABLE_NAT)
381 if (has(zone->flags, handle->family, FW3_FLAG_DNAT))
383 r = fw3_ipt_rule_create(handle, NULL, dev, NULL, sub, NULL);
384 fw3_ipt_rule_target(r, "zone_%s_prerouting", zone->name);
385 fw3_ipt_rule_extra(r, zone->extra_src);
386 fw3_ipt_rule_replace(r, "delegate_prerouting");
389 if (has(zone->flags, handle->family, FW3_FLAG_SNAT))
391 r = fw3_ipt_rule_create(handle, NULL, NULL, dev, NULL, sub);
392 fw3_ipt_rule_target(r, "zone_%s_postrouting", zone->name);
393 fw3_ipt_rule_extra(r, zone->extra_dest);
394 fw3_ipt_rule_replace(r, "delegate_postrouting");
397 else if (handle->table == FW3_TABLE_MANGLE)
403 snprintf(buf, sizeof(buf) - 1, "MSSFIX(%s): ", zone->name);
405 r = fw3_ipt_rule_create(handle, &tcp, NULL, dev, NULL, sub);
406 fw3_ipt_rule_addarg(r, false, "--tcp-flags", "SYN,RST");
407 fw3_ipt_rule_addarg(r, false, "SYN", NULL);
408 fw3_ipt_rule_limit(r, &zone->log_limit);
409 fw3_ipt_rule_comment(r, "%s (mtu_fix logging)", zone->name);
410 fw3_ipt_rule_target(r, "LOG");
411 fw3_ipt_rule_addarg(r, false, "--log-prefix", buf);
412 fw3_ipt_rule_replace(r, "mssfix");
415 r = fw3_ipt_rule_create(handle, &tcp, NULL, dev, NULL, sub);
416 fw3_ipt_rule_addarg(r, false, "--tcp-flags", "SYN,RST");
417 fw3_ipt_rule_addarg(r, false, "SYN", NULL);
418 fw3_ipt_rule_comment(r, "%s (mtu_fix)", zone->name);
419 fw3_ipt_rule_target(r, "TCPMSS");
420 fw3_ipt_rule_addarg(r, false, "--clamp-mss-to-pmtu", NULL);
421 fw3_ipt_rule_replace(r, "mssfix");
424 else if (handle->table == FW3_TABLE_RAW)
426 if (has(zone->flags, handle->family, FW3_FLAG_NOTRACK))
428 r = fw3_ipt_rule_create(handle, NULL, dev, NULL, sub, NULL);
429 fw3_ipt_rule_target(r, "zone_%s_notrack", zone->name);
430 fw3_ipt_rule_extra(r, zone->extra_src);
431 fw3_ipt_rule_replace(r, "delegate_notrack");
437 print_interface_rules(struct fw3_ipt_handle *handle, struct fw3_state *state,
438 bool reload, struct fw3_zone *zone)
440 struct fw3_device *dev;
441 struct fw3_address *sub;
443 fw3_foreach(dev, &zone->devices)
444 fw3_foreach(sub, &zone->subnets)
446 if (!fw3_is_family(sub, handle->family))
452 print_interface_rule(handle, state, reload, zone, dev, sub);
457 print_zone_rule(struct fw3_ipt_handle *handle, struct fw3_state *state,
458 bool reload, struct fw3_zone *zone)
460 bool disable_notrack = state->defaults.drop_invalid;
461 struct fw3_address *msrc;
462 struct fw3_address *mdest;
463 struct fw3_ipt_rule *r;
468 if (!fw3_is_family(zone, handle->family))
471 switch (handle->table)
473 case FW3_TABLE_FILTER:
474 r = fw3_ipt_rule_new(handle);
475 fw3_ipt_rule_target(r, "zone_%s_src_%s", zone->name,
476 fw3_flag_names[zone->policy_input]);
477 fw3_ipt_rule_append(r, "zone_%s_input", zone->name);
479 r = fw3_ipt_rule_new(handle);
480 fw3_ipt_rule_target(r, "zone_%s_src_%s", zone->name,
481 fw3_flag_names[zone->policy_forward]);
482 fw3_ipt_rule_append(r, "zone_%s_forward", zone->name);
484 r = fw3_ipt_rule_new(handle);
485 fw3_ipt_rule_target(r, "zone_%s_dest_%s", zone->name,
486 fw3_flag_names[zone->policy_output]);
487 fw3_ipt_rule_append(r, "zone_%s_output", zone->name);
491 for (t = FW3_FLAG_REJECT; t <= FW3_FLAG_DROP; t++)
493 if (has(zone->flags, handle->family, fw3_to_src_target(t)))
495 r = fw3_ipt_rule_new(handle);
497 snprintf(buf, sizeof(buf) - 1, "%s(src %s)",
498 fw3_flag_names[t], zone->name);
500 fw3_ipt_rule_limit(r, &zone->log_limit);
501 fw3_ipt_rule_target(r, "LOG");
502 fw3_ipt_rule_addarg(r, false, "--log-prefix", buf);
503 fw3_ipt_rule_append(r, "zone_%s_src_%s",
504 zone->name, fw3_flag_names[t]);
507 if (has(zone->flags, handle->family, t))
509 r = fw3_ipt_rule_new(handle);
511 snprintf(buf, sizeof(buf) - 1, "%s(dest %s)",
512 fw3_flag_names[t], zone->name);
514 fw3_ipt_rule_limit(r, &zone->log_limit);
515 fw3_ipt_rule_target(r, "LOG");
516 fw3_ipt_rule_addarg(r, false, "--log-prefix", buf);
517 fw3_ipt_rule_append(r, "zone_%s_dest_%s",
518 zone->name, fw3_flag_names[t]);
525 if (zone->masq && handle->family == FW3_FAMILY_V4)
527 fw3_foreach(msrc, &zone->masq_src)
528 fw3_foreach(mdest, &zone->masq_dest)
530 if (!fw3_is_family(msrc, handle->family) ||
531 !fw3_is_family(mdest, handle->family))
534 r = fw3_ipt_rule_new(handle);
535 fw3_ipt_rule_src_dest(r, msrc, mdest);
536 fw3_ipt_rule_target(r, "MASQUERADE");
537 fw3_ipt_rule_append(r, "zone_%s_postrouting", zone->name);
543 if (!zone->conntrack && !disable_notrack)
545 r = fw3_ipt_rule_new(handle);
546 fw3_ipt_rule_target(r, "CT");
547 fw3_ipt_rule_addarg(r, false, "--notrack", NULL);
548 fw3_ipt_rule_append(r, "zone_%s_notrack", zone->name);
552 case FW3_TABLE_MANGLE:
556 print_interface_rules(handle, state, reload, zone);
560 fw3_print_zone_chains(struct fw3_ipt_handle *handle, struct fw3_state *state,
563 struct fw3_zone *zone;
565 list_for_each_entry(zone, &state->zones, list)
566 print_zone_chain(handle, state, reload, zone);
570 fw3_print_zone_rules(struct fw3_ipt_handle *handle, struct fw3_state *state,
573 struct fw3_zone *zone;
575 list_for_each_entry(zone, &state->zones, list)
576 print_zone_rule(handle, state, reload, zone);
580 fw3_flush_zones(struct fw3_ipt_handle *handle, struct fw3_state *state,
583 struct fw3_zone *z, *tmp;
584 const struct fw3_chain_spec *c;
587 list_for_each_entry_safe(z, tmp, &state->zones, list)
589 if (!has(z->flags, handle->family, handle->table))
592 for (c = zone_chains; c->format; c++)
594 /* don't touch user chains on selective stop */
595 if (reload && c->flag == FW3_FLAG_CUSTOM_CHAINS)
598 if (!fw3_is_family(c, handle->family))
601 if (c->table != handle->table)
604 if (c->flag && !has(z->flags, handle->family, c->flag))
607 snprintf(chain, sizeof(chain), c->format, z->name);
608 fw3_ipt_flush_chain(handle, chain);
610 /* keep certain basic chains that do not depend on any settings to
611 avoid purging unrelated user rules pointing to them */
612 if (reload && !c->flag)
615 fw3_ipt_delete_chain(handle, chain);
618 del(z->flags, handle->family, handle->table);
623 fw3_hotplug_zones(struct fw3_state *state, bool add)
626 struct fw3_device *d;
628 list_for_each_entry(z, &state->zones, list)
630 if (add != hasbit(z->flags[0], FW3_FLAG_HOTPLUG))
632 list_for_each_entry(d, &z->devices, list)
633 fw3_hotplug(add, z, d);
636 setbit(z->flags[0], FW3_FLAG_HOTPLUG);
638 delbit(z->flags[0], FW3_FLAG_HOTPLUG);
644 fw3_lookup_zone(struct fw3_state *state, const char *name)
648 if (list_empty(&state->zones))
651 list_for_each_entry(z, &state->zones, list)
653 if (strcmp(z->name, name))
663 fw3_resolve_zone_addresses(struct fw3_zone *zone)
665 struct fw3_device *net;
666 struct fw3_address *addr, *tmp;
667 struct list_head *addrs, *all;
669 all = malloc(sizeof(*all));
674 memset(all, 0, sizeof(*all));
677 list_for_each_entry(net, &zone->networks, list)
679 addrs = fw3_ubus_address(net->name);
684 list_for_each_entry_safe(addr, tmp, addrs, list)
686 list_del(&addr->list);
687 list_add_tail(&addr->list, all);
693 list_for_each_entry(addr, &zone->subnets, list)
695 tmp = malloc(sizeof(*tmp));
700 memcpy(tmp, addr, sizeof(*tmp));
701 list_add_tail(&tmp->list, all);