2 * firewall3 - 3rd OpenWrt UCI firewall implementation
4 * Copyright (C) 2013 Jo-Philipp Wich <jo@mein.io>
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.
22 const struct fw3_option fw3_rule_opts[] = {
23 FW3_OPT("enabled", bool, rule, enabled),
25 FW3_OPT("name", string, rule, name),
26 FW3_OPT("family", family, rule, family),
28 FW3_OPT("src", device, rule, src),
29 FW3_OPT("dest", device, rule, dest),
31 FW3_OPT("device", string, rule, device),
32 FW3_OPT("direction", direction, rule, direction_out),
34 FW3_OPT("ipset", setmatch, rule, ipset),
36 FW3_LIST("proto", protocol, rule, proto),
38 FW3_LIST("src_ip", network, rule, ip_src),
39 FW3_LIST("src_mac", mac, rule, mac_src),
40 FW3_LIST("src_port", port, rule, port_src),
42 FW3_LIST("dest_ip", network, rule, ip_dest),
43 FW3_LIST("dest_port", port, rule, port_dest),
45 FW3_LIST("icmp_type", icmptype, rule, icmp_type),
46 FW3_OPT("extra", string, rule, extra),
48 FW3_OPT("limit", limit, rule, limit),
49 FW3_OPT("limit_burst", int, rule, limit.burst),
51 FW3_OPT("utc_time", bool, rule, time.utc),
52 FW3_OPT("start_date", date, rule, time.datestart),
53 FW3_OPT("stop_date", date, rule, time.datestop),
54 FW3_OPT("start_time", time, rule, time.timestart),
55 FW3_OPT("stop_time", time, rule, time.timestop),
56 FW3_OPT("weekdays", weekdays, rule, time.weekdays),
57 FW3_OPT("monthdays", monthdays, rule, time.monthdays),
59 FW3_OPT("mark", mark, rule, mark),
60 FW3_OPT("set_mark", mark, rule, set_mark),
61 FW3_OPT("set_xmark", mark, rule, set_xmark),
63 FW3_OPT("target", target, rule, target),
70 need_src_action_chain(struct fw3_rule *r)
72 return (r->_src && r->_src->log && (r->target > FW3_FLAG_ACCEPT));
75 static struct fw3_rule*
76 alloc_rule(struct fw3_state *state)
78 struct fw3_rule *rule = calloc(1, sizeof(*rule));
81 INIT_LIST_HEAD(&rule->proto);
83 INIT_LIST_HEAD(&rule->ip_src);
84 INIT_LIST_HEAD(&rule->mac_src);
85 INIT_LIST_HEAD(&rule->port_src);
87 INIT_LIST_HEAD(&rule->ip_dest);
88 INIT_LIST_HEAD(&rule->port_dest);
90 INIT_LIST_HEAD(&rule->icmp_type);
92 list_add_tail(&rule->list, &state->rules);
99 #define warn_rule(r, e, fmt, ...) \
102 warn_elem(e, fmt, ##__VA_ARGS__); \
104 warn("Warning: ubus rule (%s) " fmt, \
105 (r && r->name) ? r->name : "?", ##__VA_ARGS__); \
109 check_rule(struct fw3_state *state, struct fw3_rule *r, struct uci_element *e)
114 if (r->src.invert || r->dest.invert)
116 warn_rule(r, e, "must not have inverted 'src' or 'dest' options");
119 else if (r->src.set && !r->src.any &&
120 !(r->_src = fw3_lookup_zone(state, r->src.name)))
122 warn_rule(r, e, "refers to not existing zone '%s'", r->src.name);
125 else if (r->dest.set && !r->dest.any &&
126 !(r->_dest = fw3_lookup_zone(state, r->dest.name)))
128 warn_rule(r, e, "refers to not existing zone '%s'", r->dest.name);
131 else if (r->ipset.set && state->disable_ipsets)
133 warn_rule(r, e, "skipped due to disabled ipset support");
136 else if (r->ipset.set &&
137 !(r->ipset.ptr = fw3_lookup_ipset(state, r->ipset.name)))
139 warn_rule(r, e, "refers to unknown ipset '%s'", r->ipset.name);
143 if (!r->_src && r->target == FW3_FLAG_NOTRACK)
145 warn_rule(r, e, "is set to target NOTRACK but has no source assigned");
149 if (!r->set_mark.set && !r->set_xmark.set &&
150 r->target == FW3_FLAG_MARK)
152 warn_rule(r, e, "is set to target MARK but specifies neither "
153 "'set_mark' nor 'set_xmark' option");
157 if (r->_dest && r->target == FW3_FLAG_MARK)
159 warn_rule(r, e, "must not specify 'dest' for MARK target");
163 if (r->set_mark.invert || r->set_xmark.invert)
165 warn_rule(r, e, "must not have inverted 'set_mark' or 'set_xmark'");
169 if (!r->_src && !r->_dest && !r->src.any && !r->dest.any)
171 warn_rule(r, e, "has neither a source nor a destination zone assigned "
172 "- assuming an output r");
175 if (list_empty(&r->proto))
177 warn_rule(r, e, "does not specify a protocol, assuming TCP+UDP");
178 fw3_parse_protocol(&r->proto, "tcpudp", true);
181 if (r->target == FW3_FLAG_UNSPEC)
183 warn_rule(r, e, "has no target specified, defaulting to REJECT");
184 r->target = FW3_FLAG_REJECT;
186 else if (r->target > FW3_FLAG_MARK)
188 warn_rule(r, e, "has invalid target specified, defaulting to REJECT");
189 r->target = FW3_FLAG_REJECT;
192 /* NB: r family... */
195 fw3_setbit(r->_dest->flags[0], r->target);
196 fw3_setbit(r->_dest->flags[1], r->target);
198 else if (need_src_action_chain(r))
200 fw3_setbit(r->_src->flags[0], fw3_to_src_target(r->target));
201 fw3_setbit(r->_src->flags[1], fw3_to_src_target(r->target));
208 fw3_load_rules(struct fw3_state *state, struct uci_package *p,
211 struct uci_section *s;
212 struct uci_element *e;
213 struct fw3_rule *rule;
214 struct blob_attr *entry, *opt;
217 INIT_LIST_HEAD(&state->rules);
219 blob_for_each_attr(entry, a, rem) {
220 const char *type = NULL;
221 const char *name = "ubus rule";
222 blobmsg_for_each_attr(opt, entry, orem)
223 if (!strcmp(blobmsg_name(opt), "type"))
224 type = blobmsg_get_string(opt);
225 else if (!strcmp(blobmsg_name(opt), "name"))
226 name = blobmsg_get_string(opt);
228 if (!type || strcmp(type, "rule"))
231 if (!(rule = alloc_rule(state)))
234 if (!fw3_parse_blob_options(rule, fw3_rule_opts, entry, name))
236 warn_rule(rule, NULL, "skipped due to invalid options\n");
241 if (!check_rule(state, rule, NULL))
245 uci_foreach_element(&p->sections, e)
247 s = uci_to_section(e);
249 if (strcmp(s->type, "rule"))
252 if (!(rule = alloc_rule(state)))
255 if (!fw3_parse_options(rule, fw3_rule_opts, s))
257 warn_elem(e, "skipped due to invalid options");
262 if (!check_rule(state, rule, e))
269 append_chain(struct fw3_ipt_rule *r, struct fw3_rule *rule)
273 snprintf(chain, sizeof(chain), "OUTPUT");
275 if (rule->target == FW3_FLAG_NOTRACK)
277 snprintf(chain, sizeof(chain), "zone_%s_notrack", rule->src.name);
279 else if (rule->target == FW3_FLAG_MARK && (rule->_src || rule->src.any))
281 snprintf(chain, sizeof(chain), "PREROUTING");
290 snprintf(chain, sizeof(chain), "zone_%s_forward",
293 snprintf(chain, sizeof(chain), "zone_%s_input",
299 snprintf(chain, sizeof(chain), "FORWARD");
301 snprintf(chain, sizeof(chain), "INPUT");
305 if (rule->dest.set && !rule->src.set)
308 snprintf(chain, sizeof(chain), "OUTPUT");
310 snprintf(chain, sizeof(chain), "zone_%s_output",
315 fw3_ipt_rule_append(r, chain);
318 static void set_target(struct fw3_ipt_rule *r, struct fw3_rule *rule)
321 struct fw3_mark *mark;
322 char buf[sizeof("0xFFFFFFFF/0xFFFFFFFF\0")];
327 name = rule->set_mark.set ? "--set-mark" : "--set-xmark";
328 mark = rule->set_mark.set ? &rule->set_mark : &rule->set_xmark;
329 sprintf(buf, "0x%x/0x%x", mark->mark, mark->mask);
331 fw3_ipt_rule_target(r, "MARK");
332 fw3_ipt_rule_addarg(r, false, name, buf);
335 case FW3_FLAG_NOTRACK:
336 fw3_ipt_rule_target(r, "CT");
337 fw3_ipt_rule_addarg(r, false, "--notrack", NULL);
340 case FW3_FLAG_ACCEPT:
342 name = fw3_flag_names[rule->target];
346 name = fw3_flag_names[FW3_FLAG_REJECT];
350 if (rule->dest.set && !rule->dest.any)
351 fw3_ipt_rule_target(r, "zone_%s_dest_%s", rule->dest.name, name);
352 else if (need_src_action_chain(rule))
353 fw3_ipt_rule_target(r, "zone_%s_src_%s", rule->src.name, name);
354 else if (strcmp(name, "REJECT"))
355 fw3_ipt_rule_target(r, name);
357 fw3_ipt_rule_target(r, "reject");
361 set_comment(struct fw3_ipt_rule *r, const char *name, int num)
364 fw3_ipt_rule_comment(r, name);
366 fw3_ipt_rule_comment(r, "@rule[%u]", num);
370 print_rule(struct fw3_ipt_handle *handle, struct fw3_state *state,
371 struct fw3_rule *rule, int num, struct fw3_protocol *proto,
372 struct fw3_address *sip, struct fw3_address *dip,
373 struct fw3_port *sport, struct fw3_port *dport,
374 struct fw3_mac *mac, struct fw3_icmptype *icmptype)
376 struct fw3_ipt_rule *r;
378 if (!fw3_is_family(sip, handle->family) ||
379 !fw3_is_family(dip, handle->family))
381 if ((sip && !sip->resolved) || (dip && !dip->resolved))
382 info(" ! Skipping due to different family of ip address");
387 if (proto->protocol == 58 && handle->family == FW3_FAMILY_V4)
389 info(" ! Skipping due to different family of protocol");
393 r = fw3_ipt_rule_create(handle, proto, NULL, NULL, sip, dip);
394 fw3_ipt_rule_sport_dport(r, sport, dport);
395 fw3_ipt_rule_device(r, rule->device, rule->direction_out);
396 fw3_ipt_rule_icmptype(r, icmptype);
397 fw3_ipt_rule_mac(r, mac);
398 fw3_ipt_rule_ipset(r, &rule->ipset);
399 fw3_ipt_rule_limit(r, &rule->limit);
400 fw3_ipt_rule_time(r, &rule->time);
401 fw3_ipt_rule_mark(r, &rule->mark);
403 fw3_ipt_rule_extra(r, rule->extra);
404 set_comment(r, rule->name, num);
405 append_chain(r, rule);
409 expand_rule(struct fw3_ipt_handle *handle, struct fw3_state *state,
410 struct fw3_rule *rule, int num)
412 struct fw3_protocol *proto;
413 struct fw3_address *sip;
414 struct fw3_address *dip;
415 struct fw3_port *sport;
416 struct fw3_port *dport;
418 struct fw3_icmptype *icmptype;
420 struct list_head *sports = NULL;
421 struct list_head *dports = NULL;
422 struct list_head *icmptypes = NULL;
424 struct list_head empty;
425 INIT_LIST_HEAD(&empty);
427 if (!fw3_is_family(rule, handle->family))
430 if ((rule->target == FW3_FLAG_NOTRACK && handle->table != FW3_TABLE_RAW) ||
431 (rule->target == FW3_FLAG_MARK && handle->table != FW3_TABLE_MANGLE) ||
432 (rule->target < FW3_FLAG_NOTRACK && handle->table != FW3_TABLE_FILTER))
436 info(" * Rule '%s'", rule->name);
438 info(" * Rule #%u", num);
440 if (!fw3_is_family(rule->_src, handle->family) ||
441 !fw3_is_family(rule->_dest, handle->family))
443 info(" ! Skipping due to different family of zone");
449 if (!fw3_is_family(rule->ipset.ptr, handle->family))
451 info(" ! Skipping due to different family in ipset");
455 if (!fw3_check_ipset(rule->ipset.ptr))
457 info(" ! Skipping due to missing ipset '%s'",
458 rule->ipset.ptr->external
459 ? rule->ipset.ptr->external : rule->ipset.ptr->name);
463 set(rule->ipset.ptr->flags, handle->family, handle->family);
466 list_for_each_entry(proto, &rule->proto, list)
468 /* icmp / ipv6-icmp */
469 if (proto->protocol == 1 || proto->protocol == 58)
473 icmptypes = &rule->icmp_type;
477 sports = &rule->port_src;
478 dports = &rule->port_dest;
482 fw3_foreach(sip, &rule->ip_src)
483 fw3_foreach(dip, &rule->ip_dest)
484 fw3_foreach(sport, sports)
485 fw3_foreach(dport, dports)
486 fw3_foreach(mac, &rule->mac_src)
487 fw3_foreach(icmptype, icmptypes)
488 print_rule(handle, state, rule, num, proto, sip, dip,
489 sport, dport, mac, icmptype);
494 fw3_print_rules(struct fw3_ipt_handle *handle, struct fw3_state *state)
497 struct fw3_rule *rule;
499 list_for_each_entry(rule, &state->rules, list)
500 expand_rule(handle, state, rule, num++);