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 fw3_ubus_zone_devices(zone);
204 if (list_empty(&zone->networks) && list_empty(&zone->devices) &&
205 list_empty(&zone->subnets) && !zone->extra_src)
207 warn_elem(e, "has no device, network, subnet or extra options");
210 check_policy(e, &zone->policy_input, defs->policy_input, "input");
211 check_policy(e, &zone->policy_output, defs->policy_output, "output");
212 check_policy(e, &zone->policy_forward, defs->policy_forward, "forward");
214 resolve_networks(e, zone);
218 setbit(zone->flags[0], FW3_FLAG_SNAT);
219 zone->conntrack = true;
222 if (zone->custom_chains)
224 setbit(zone->flags[0], FW3_FLAG_SNAT);
225 setbit(zone->flags[0], FW3_FLAG_DNAT);
228 setbit(zone->flags[0], fw3_to_src_target(zone->policy_input));
229 setbit(zone->flags[0], fw3_to_src_target(zone->policy_forward));
230 setbit(zone->flags[0], zone->policy_output);
232 setbit(zone->flags[1], fw3_to_src_target(zone->policy_input));
233 setbit(zone->flags[1], fw3_to_src_target(zone->policy_forward));
234 setbit(zone->flags[1], zone->policy_output);
236 list_add_tail(&zone->list, &state->zones);
242 print_zone_chain(struct fw3_ipt_handle *handle, struct fw3_state *state,
243 bool reload, struct fw3_zone *zone)
246 struct fw3_ipt_rule *r;
247 const struct fw3_chain_spec *c;
249 const char *flt_chains[] = {
252 "forward", "forwarding",
255 const char *nat_chains[] = {
256 "prerouting", "prerouting",
257 "postrouting", "postrouting",
260 if (!fw3_is_family(zone, handle->family))
263 info(" * Zone '%s'", zone->name);
265 set(zone->flags, handle->family, handle->table);
267 if (zone->custom_chains)
268 set(zone->flags, handle->family, FW3_FLAG_CUSTOM_CHAINS);
270 if (!zone->conntrack && !state->defaults.drop_invalid)
271 set(zone->flags, handle->family, FW3_FLAG_NOTRACK);
273 for (c = zone_chains; c->format; c++)
275 /* don't touch user chains on selective stop */
276 if (reload && c->flag == FW3_FLAG_CUSTOM_CHAINS)
279 if (!fw3_is_family(c, handle->family))
282 if (c->table != handle->table)
286 !hasbit(zone->flags[handle->family == FW3_FAMILY_V6], c->flag))
289 fw3_ipt_create_chain(handle, c->format, zone->name);
292 if (zone->custom_chains)
294 if (handle->table == FW3_TABLE_FILTER)
296 for (i = 0; i < sizeof(flt_chains)/sizeof(flt_chains[0]); i += 2)
298 r = fw3_ipt_rule_new(handle);
299 fw3_ipt_rule_comment(r, "user chain for %s", flt_chains[i+1]);
300 fw3_ipt_rule_target(r, "%s_%s_rule", flt_chains[i+1], zone->name);
301 fw3_ipt_rule_append(r, "zone_%s_%s", zone->name, flt_chains[i]);
304 else if (handle->table == FW3_TABLE_NAT)
306 for (i = 0; i < sizeof(nat_chains)/sizeof(nat_chains[0]); i += 2)
308 r = fw3_ipt_rule_new(handle);
309 fw3_ipt_rule_comment(r, "user chain for %s", nat_chains[i+1]);
310 fw3_ipt_rule_target(r, "%s_%s_rule", nat_chains[i+1], zone->name);
311 fw3_ipt_rule_append(r, "zone_%s_%s", zone->name, nat_chains[i]);
316 set(zone->flags, handle->family, handle->table);
320 print_interface_rule(struct fw3_ipt_handle *handle, struct fw3_state *state,
321 bool reload, struct fw3_zone *zone,
322 struct fw3_device *dev, struct fw3_address *sub)
324 struct fw3_protocol tcp = { .protocol = 6 };
325 struct fw3_ipt_rule *r;
332 const char *chains[] = {
338 #define jump_target(t) \
339 ((t == FW3_FLAG_REJECT) ? "reject" : fw3_flag_names[t])
341 if (handle->table == FW3_TABLE_FILTER)
343 for (t = FW3_FLAG_ACCEPT; t <= FW3_FLAG_DROP; t++)
345 if (has(zone->flags, handle->family, fw3_to_src_target(t)))
347 r = fw3_ipt_rule_create(handle, NULL, dev, NULL, sub, NULL);
348 fw3_ipt_rule_target(r, jump_target(t));
349 fw3_ipt_rule_extra(r, zone->extra_src);
350 fw3_ipt_rule_replace(r, "zone_%s_src_%s", zone->name,
354 if (has(zone->flags, handle->family, t))
356 r = fw3_ipt_rule_create(handle, NULL, NULL, dev, NULL, sub);
357 fw3_ipt_rule_target(r, jump_target(t));
358 fw3_ipt_rule_extra(r, zone->extra_dest);
359 fw3_ipt_rule_replace(r, "zone_%s_dest_%s", zone->name,
364 for (i = 0; i < sizeof(chains)/sizeof(chains[0]); i++)
366 if (*chains[i] == 'o')
367 r = fw3_ipt_rule_create(handle, NULL, NULL, dev, NULL, sub);
369 r = fw3_ipt_rule_create(handle, NULL, dev, NULL, sub, NULL);
371 fw3_ipt_rule_target(r, "zone_%s_%s", zone->name, chains[i]);
373 if (*chains[i] == 'o')
374 fw3_ipt_rule_extra(r, zone->extra_dest);
376 fw3_ipt_rule_extra(r, zone->extra_src);
378 fw3_ipt_rule_replace(r, "delegate_%s", chains[i]);
381 else if (handle->table == FW3_TABLE_NAT)
383 if (has(zone->flags, handle->family, FW3_FLAG_DNAT))
385 r = fw3_ipt_rule_create(handle, NULL, dev, NULL, sub, NULL);
386 fw3_ipt_rule_target(r, "zone_%s_prerouting", zone->name);
387 fw3_ipt_rule_extra(r, zone->extra_src);
388 fw3_ipt_rule_replace(r, "delegate_prerouting");
391 if (has(zone->flags, handle->family, FW3_FLAG_SNAT))
393 r = fw3_ipt_rule_create(handle, NULL, NULL, dev, NULL, sub);
394 fw3_ipt_rule_target(r, "zone_%s_postrouting", zone->name);
395 fw3_ipt_rule_extra(r, zone->extra_dest);
396 fw3_ipt_rule_replace(r, "delegate_postrouting");
399 else if (handle->table == FW3_TABLE_MANGLE)
405 snprintf(buf, sizeof(buf) - 1, "MSSFIX(%s): ", zone->name);
407 r = fw3_ipt_rule_create(handle, &tcp, NULL, dev, NULL, sub);
408 fw3_ipt_rule_addarg(r, false, "--tcp-flags", "SYN,RST");
409 fw3_ipt_rule_addarg(r, false, "SYN", NULL);
410 fw3_ipt_rule_limit(r, &zone->log_limit);
411 fw3_ipt_rule_comment(r, "%s (mtu_fix logging)", zone->name);
412 fw3_ipt_rule_target(r, "LOG");
413 fw3_ipt_rule_addarg(r, false, "--log-prefix", buf);
414 fw3_ipt_rule_replace(r, "mssfix");
417 r = fw3_ipt_rule_create(handle, &tcp, NULL, dev, NULL, sub);
418 fw3_ipt_rule_addarg(r, false, "--tcp-flags", "SYN,RST");
419 fw3_ipt_rule_addarg(r, false, "SYN", NULL);
420 fw3_ipt_rule_comment(r, "%s (mtu_fix)", zone->name);
421 fw3_ipt_rule_target(r, "TCPMSS");
422 fw3_ipt_rule_addarg(r, false, "--clamp-mss-to-pmtu", NULL);
423 fw3_ipt_rule_replace(r, "mssfix");
426 else if (handle->table == FW3_TABLE_RAW)
428 if (has(zone->flags, handle->family, FW3_FLAG_NOTRACK))
430 r = fw3_ipt_rule_create(handle, NULL, dev, NULL, sub, NULL);
431 fw3_ipt_rule_target(r, "zone_%s_notrack", zone->name);
432 fw3_ipt_rule_extra(r, zone->extra_src);
433 fw3_ipt_rule_replace(r, "delegate_notrack");
439 print_interface_rules(struct fw3_ipt_handle *handle, struct fw3_state *state,
440 bool reload, struct fw3_zone *zone)
442 struct fw3_device *dev;
443 struct fw3_address *sub;
445 fw3_foreach(dev, &zone->devices)
446 fw3_foreach(sub, &zone->subnets)
448 if (!fw3_is_family(sub, handle->family))
454 print_interface_rule(handle, state, reload, zone, dev, sub);
459 print_zone_rule(struct fw3_ipt_handle *handle, struct fw3_state *state,
460 bool reload, struct fw3_zone *zone)
462 bool disable_notrack = state->defaults.drop_invalid;
463 struct fw3_address *msrc;
464 struct fw3_address *mdest;
465 struct fw3_ipt_rule *r;
470 if (!fw3_is_family(zone, handle->family))
473 switch (handle->table)
475 case FW3_TABLE_FILTER:
476 r = fw3_ipt_rule_new(handle);
477 fw3_ipt_rule_target(r, "zone_%s_src_%s", zone->name,
478 fw3_flag_names[zone->policy_input]);
479 fw3_ipt_rule_append(r, "zone_%s_input", zone->name);
481 r = fw3_ipt_rule_new(handle);
482 fw3_ipt_rule_target(r, "zone_%s_src_%s", zone->name,
483 fw3_flag_names[zone->policy_forward]);
484 fw3_ipt_rule_append(r, "zone_%s_forward", zone->name);
486 r = fw3_ipt_rule_new(handle);
487 fw3_ipt_rule_target(r, "zone_%s_dest_%s", zone->name,
488 fw3_flag_names[zone->policy_output]);
489 fw3_ipt_rule_append(r, "zone_%s_output", zone->name);
493 for (t = FW3_FLAG_REJECT; t <= FW3_FLAG_DROP; t++)
495 if (has(zone->flags, handle->family, fw3_to_src_target(t)))
497 r = fw3_ipt_rule_new(handle);
499 snprintf(buf, sizeof(buf) - 1, "%s(src %s)",
500 fw3_flag_names[t], zone->name);
502 fw3_ipt_rule_limit(r, &zone->log_limit);
503 fw3_ipt_rule_target(r, "LOG");
504 fw3_ipt_rule_addarg(r, false, "--log-prefix", buf);
505 fw3_ipt_rule_append(r, "zone_%s_src_%s",
506 zone->name, fw3_flag_names[t]);
509 if (has(zone->flags, handle->family, t))
511 r = fw3_ipt_rule_new(handle);
513 snprintf(buf, sizeof(buf) - 1, "%s(dest %s)",
514 fw3_flag_names[t], zone->name);
516 fw3_ipt_rule_limit(r, &zone->log_limit);
517 fw3_ipt_rule_target(r, "LOG");
518 fw3_ipt_rule_addarg(r, false, "--log-prefix", buf);
519 fw3_ipt_rule_append(r, "zone_%s_dest_%s",
520 zone->name, fw3_flag_names[t]);
527 if (zone->masq && handle->family == FW3_FAMILY_V4)
529 fw3_foreach(msrc, &zone->masq_src)
530 fw3_foreach(mdest, &zone->masq_dest)
532 if (!fw3_is_family(msrc, handle->family) ||
533 !fw3_is_family(mdest, handle->family))
536 r = fw3_ipt_rule_new(handle);
537 fw3_ipt_rule_src_dest(r, msrc, mdest);
538 fw3_ipt_rule_target(r, "MASQUERADE");
539 fw3_ipt_rule_append(r, "zone_%s_postrouting", zone->name);
545 if (!zone->conntrack && !disable_notrack)
547 r = fw3_ipt_rule_new(handle);
548 fw3_ipt_rule_target(r, "CT");
549 fw3_ipt_rule_addarg(r, false, "--notrack", NULL);
550 fw3_ipt_rule_append(r, "zone_%s_notrack", zone->name);
554 case FW3_TABLE_MANGLE:
558 print_interface_rules(handle, state, reload, zone);
562 fw3_print_zone_chains(struct fw3_ipt_handle *handle, struct fw3_state *state,
565 struct fw3_zone *zone;
567 list_for_each_entry(zone, &state->zones, list)
568 print_zone_chain(handle, state, reload, zone);
572 fw3_print_zone_rules(struct fw3_ipt_handle *handle, struct fw3_state *state,
575 struct fw3_zone *zone;
577 list_for_each_entry(zone, &state->zones, list)
578 print_zone_rule(handle, state, reload, zone);
582 fw3_flush_zones(struct fw3_ipt_handle *handle, struct fw3_state *state,
585 struct fw3_zone *z, *tmp;
586 const struct fw3_chain_spec *c;
589 list_for_each_entry_safe(z, tmp, &state->zones, list)
591 if (!has(z->flags, handle->family, handle->table))
594 for (c = zone_chains; c->format; c++)
596 /* don't touch user chains on selective stop */
597 if (reload && c->flag == FW3_FLAG_CUSTOM_CHAINS)
600 if (!fw3_is_family(c, handle->family))
603 if (c->table != handle->table)
606 if (c->flag && !has(z->flags, handle->family, c->flag))
609 snprintf(chain, sizeof(chain), c->format, z->name);
610 fw3_ipt_flush_chain(handle, chain);
612 /* keep certain basic chains that do not depend on any settings to
613 avoid purging unrelated user rules pointing to them */
614 if (reload && !c->flag)
617 fw3_ipt_delete_chain(handle, chain);
620 del(z->flags, handle->family, handle->table);
625 fw3_hotplug_zones(struct fw3_state *state, bool add)
628 struct fw3_device *d;
630 list_for_each_entry(z, &state->zones, list)
632 if (add != hasbit(z->flags[0], FW3_FLAG_HOTPLUG))
634 list_for_each_entry(d, &z->devices, list)
635 fw3_hotplug(add, z, d);
638 setbit(z->flags[0], FW3_FLAG_HOTPLUG);
640 delbit(z->flags[0], FW3_FLAG_HOTPLUG);
646 fw3_lookup_zone(struct fw3_state *state, const char *name)
650 if (list_empty(&state->zones))
653 list_for_each_entry(z, &state->zones, list)
655 if (strcmp(z->name, name))
665 fw3_resolve_zone_addresses(struct fw3_zone *zone)
667 struct fw3_device *net;
668 struct fw3_address *addr, *tmp;
669 struct list_head *addrs, *all;
671 all = malloc(sizeof(*all));
676 memset(all, 0, sizeof(*all));
679 list_for_each_entry(net, &zone->networks, list)
681 addrs = fw3_ubus_address(net->name);
686 list_for_each_entry_safe(addr, tmp, addrs, list)
688 list_del(&addr->list);
689 list_add_tail(&addr->list, all);
695 list_for_each_entry(addr, &zone->subnets, list)
697 tmp = malloc(sizeof(*tmp));
702 memcpy(tmp, addr, sizeof(*tmp));
703 list_add_tail(&tmp->list, all);