firewall3: replace warn_rule() by warn_section()
[project/firewall3.git] / rules.c
1 /*
2  * firewall3 - 3rd OpenWrt UCI firewall implementation
3  *
4  *   Copyright (C) 2013 Jo-Philipp Wich <jo@mein.io>
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 "rules.h"
20
21
22 const struct fw3_option fw3_rule_opts[] = {
23         FW3_OPT("enabled",             bool,      rule,     enabled),
24
25         FW3_OPT("name",                string,    rule,     name),
26         FW3_OPT("family",              family,    rule,     family),
27
28         FW3_OPT("src",                 device,    rule,     src),
29         FW3_OPT("dest",                device,    rule,     dest),
30
31         FW3_OPT("device",              string,    rule,     device),
32         FW3_OPT("direction",           direction, rule,     direction_out),
33
34         FW3_OPT("ipset",               setmatch,  rule,     ipset),
35
36         FW3_LIST("proto",              protocol,  rule,     proto),
37
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),
41
42         FW3_LIST("dest_ip",            network,   rule,     ip_dest),
43         FW3_LIST("dest_port",          port,      rule,     port_dest),
44
45         FW3_LIST("icmp_type",          icmptype,  rule,     icmp_type),
46         FW3_OPT("extra",               string,    rule,     extra),
47
48         FW3_OPT("limit",               limit,     rule,     limit),
49         FW3_OPT("limit_burst",         int,       rule,     limit.burst),
50
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),
58
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),
62
63         FW3_OPT("target",              target,    rule,     target),
64
65         { }
66 };
67
68
69 static bool
70 need_src_action_chain(struct fw3_rule *r)
71 {
72         return (r->_src && r->_src->log && (r->target > FW3_FLAG_ACCEPT));
73 }
74
75 static struct fw3_rule*
76 alloc_rule(struct fw3_state *state)
77 {
78         struct fw3_rule *rule = calloc(1, sizeof(*rule));
79
80         if (rule) {
81                 INIT_LIST_HEAD(&rule->proto);
82
83                 INIT_LIST_HEAD(&rule->ip_src);
84                 INIT_LIST_HEAD(&rule->mac_src);
85                 INIT_LIST_HEAD(&rule->port_src);
86
87                 INIT_LIST_HEAD(&rule->ip_dest);
88                 INIT_LIST_HEAD(&rule->port_dest);
89
90                 INIT_LIST_HEAD(&rule->icmp_type);
91
92                 list_add_tail(&rule->list, &state->rules);
93                 rule->enabled = true;
94         }
95
96         return rule;
97 }
98
99 static bool
100 check_rule(struct fw3_state *state, struct fw3_rule *r, struct uci_element *e)
101 {
102         if (!r->enabled)
103                 return false;
104
105         if (r->src.invert || r->dest.invert)
106         {
107                 warn_section("rule", r, e, "must not have inverted 'src' or 'dest' options");
108                 return false;
109         }
110         else if (r->src.set && !r->src.any &&
111                  !(r->_src = fw3_lookup_zone(state, r->src.name)))
112         {
113                 warn_section("rule", r, e, "refers to not existing zone '%s'", r->src.name);
114                 return false;
115         }
116         else if (r->dest.set && !r->dest.any &&
117                  !(r->_dest = fw3_lookup_zone(state, r->dest.name)))
118         {
119                 warn_section("rule", r, e, "refers to not existing zone '%s'", r->dest.name);
120                 return false;
121         }
122         else if (r->ipset.set && state->disable_ipsets)
123         {
124                 warn_section("rule", r, e, "skipped due to disabled ipset support");
125                 return false;
126         }
127         else if (r->ipset.set &&
128                  !(r->ipset.ptr = fw3_lookup_ipset(state, r->ipset.name)))
129         {
130                 warn_section("rule", r, e, "refers to unknown ipset '%s'", r->ipset.name);
131                 return false;
132         }
133
134         if (!r->_src && r->target == FW3_FLAG_NOTRACK)
135         {
136                 warn_section("rule", r, e, "is set to target NOTRACK but has no source assigned");
137                 return false;
138         }
139
140         if (!r->set_mark.set && !r->set_xmark.set &&
141             r->target == FW3_FLAG_MARK)
142         {
143                 warn_section("rule", r, e, "is set to target MARK but specifies neither "
144                                 "'set_mark' nor 'set_xmark' option");
145                 return false;
146         }
147
148         if (r->_dest && r->target == FW3_FLAG_MARK)
149         {
150                 warn_section("rule", r, e, "must not specify 'dest' for MARK target");
151                 return false;
152         }
153
154         if (r->set_mark.invert || r->set_xmark.invert)
155         {
156                 warn_section("rule", r, e, "must not have inverted 'set_mark' or 'set_xmark'");
157                 return false;
158         }
159
160         if (!r->_src && !r->_dest && !r->src.any && !r->dest.any)
161         {
162                 warn_section("rule", r, e, "has neither a source nor a destination zone assigned "
163                                 "- assuming an output r");
164         }
165
166         if (list_empty(&r->proto))
167         {
168                 warn_section("rule", r, e, "does not specify a protocol, assuming TCP+UDP");
169                 fw3_parse_protocol(&r->proto, "tcpudp", true);
170         }
171
172         if (r->target == FW3_FLAG_UNSPEC)
173         {
174                 warn_section("rule", r, e, "has no target specified, defaulting to REJECT");
175                 r->target = FW3_FLAG_REJECT;
176         }
177         else if (r->target > FW3_FLAG_MARK)
178         {
179                 warn_section("rule", r, e, "has invalid target specified, defaulting to REJECT");
180                 r->target = FW3_FLAG_REJECT;
181         }
182
183         /* NB: r family... */
184         if (r->_dest)
185         {
186                 fw3_setbit(r->_dest->flags[0], r->target);
187                 fw3_setbit(r->_dest->flags[1], r->target);
188         }
189         else if (need_src_action_chain(r))
190         {
191                 fw3_setbit(r->_src->flags[0], fw3_to_src_target(r->target));
192                 fw3_setbit(r->_src->flags[1], fw3_to_src_target(r->target));
193         }
194
195         return true;
196 }
197
198 void
199 fw3_load_rules(struct fw3_state *state, struct uci_package *p,
200                 struct blob_attr *a)
201 {
202         struct uci_section *s;
203         struct uci_element *e;
204         struct fw3_rule *rule;
205         struct blob_attr *entry, *opt;
206         unsigned rem, orem;
207
208         INIT_LIST_HEAD(&state->rules);
209
210         blob_for_each_attr(entry, a, rem) {
211                 const char *type = NULL;
212                 const char *name = "ubus rule";
213                 blobmsg_for_each_attr(opt, entry, orem)
214                         if (!strcmp(blobmsg_name(opt), "type"))
215                                 type = blobmsg_get_string(opt);
216                         else if (!strcmp(blobmsg_name(opt), "name"))
217                                 name = blobmsg_get_string(opt);
218
219                 if (!type || strcmp(type, "rule"))
220                         continue;
221
222                 if (!(rule = alloc_rule(state)))
223                         continue;
224
225                 if (!fw3_parse_blob_options(rule, fw3_rule_opts, entry, name))
226                 {
227                         warn_section("rule", rule, NULL, "skipped due to invalid options");
228                         fw3_free_rule(rule);
229                         continue;
230                 }
231
232                 if (!check_rule(state, rule, NULL))
233                         fw3_free_rule(rule);
234         }
235
236         uci_foreach_element(&p->sections, e)
237         {
238                 s = uci_to_section(e);
239
240                 if (strcmp(s->type, "rule"))
241                         continue;
242
243                 if (!(rule = alloc_rule(state)))
244                         continue;
245
246                 if (!fw3_parse_options(rule, fw3_rule_opts, s))
247                 {
248                         warn_elem(e, "skipped due to invalid options");
249                         fw3_free_rule(rule);
250                         continue;
251                 }
252
253                 if (!check_rule(state, rule, e))
254                         fw3_free_rule(rule);
255         }
256 }
257
258
259 static void
260 append_chain(struct fw3_ipt_rule *r, struct fw3_rule *rule)
261 {
262         char chain[32];
263
264         snprintf(chain, sizeof(chain), "OUTPUT");
265
266         if (rule->target == FW3_FLAG_NOTRACK)
267         {
268                 snprintf(chain, sizeof(chain), "zone_%s_notrack", rule->src.name);
269         }
270         else if (rule->target == FW3_FLAG_MARK && (rule->_src || rule->src.any))
271         {
272                 snprintf(chain, sizeof(chain), "PREROUTING");
273         }
274         else
275         {
276                 if (rule->src.set)
277                 {
278                         if (!rule->src.any)
279                         {
280                                 if (rule->dest.set)
281                                         snprintf(chain, sizeof(chain), "zone_%s_forward",
282                                                  rule->src.name);
283                                 else
284                                         snprintf(chain, sizeof(chain), "zone_%s_input",
285                                                  rule->src.name);
286                         }
287                         else
288                         {
289                                 if (rule->dest.set)
290                                         snprintf(chain, sizeof(chain), "FORWARD");
291                                 else
292                                         snprintf(chain, sizeof(chain), "INPUT");
293                         }
294                 }
295
296                 if (rule->dest.set && !rule->src.set)
297                 {
298                         if (rule->dest.any)
299                                 snprintf(chain, sizeof(chain), "OUTPUT");
300                         else
301                                 snprintf(chain, sizeof(chain), "zone_%s_output",
302                                          rule->dest.name);
303                 }
304         }
305
306         fw3_ipt_rule_append(r, chain);
307 }
308
309 static void set_target(struct fw3_ipt_rule *r, struct fw3_rule *rule)
310 {
311         const char *name;
312         struct fw3_mark *mark;
313         char buf[sizeof("0xFFFFFFFF/0xFFFFFFFF\0")];
314
315         switch(rule->target)
316         {
317         case FW3_FLAG_MARK:
318                 name = rule->set_mark.set ? "--set-mark" : "--set-xmark";
319                 mark = rule->set_mark.set ? &rule->set_mark : &rule->set_xmark;
320                 sprintf(buf, "0x%x/0x%x", mark->mark, mark->mask);
321
322                 fw3_ipt_rule_target(r, "MARK");
323                 fw3_ipt_rule_addarg(r, false, name, buf);
324                 return;
325
326         case FW3_FLAG_NOTRACK:
327                 fw3_ipt_rule_target(r, "CT");
328                 fw3_ipt_rule_addarg(r, false, "--notrack", NULL);
329                 return;
330
331         case FW3_FLAG_ACCEPT:
332         case FW3_FLAG_DROP:
333                 name = fw3_flag_names[rule->target];
334                 break;
335
336         default:
337                 name = fw3_flag_names[FW3_FLAG_REJECT];
338                 break;
339         }
340
341         if (rule->dest.set && !rule->dest.any)
342                 fw3_ipt_rule_target(r, "zone_%s_dest_%s", rule->dest.name, name);
343         else if (need_src_action_chain(rule))
344                 fw3_ipt_rule_target(r, "zone_%s_src_%s", rule->src.name, name);
345         else if (strcmp(name, "REJECT"))
346                 fw3_ipt_rule_target(r, name);
347         else
348                 fw3_ipt_rule_target(r, "reject");
349 }
350
351 static void
352 set_comment(struct fw3_ipt_rule *r, const char *name, int num)
353 {
354         if (name)
355                 fw3_ipt_rule_comment(r, name);
356         else
357                 fw3_ipt_rule_comment(r, "@rule[%u]", num);
358 }
359
360 static void
361 print_rule(struct fw3_ipt_handle *handle, struct fw3_state *state,
362            struct fw3_rule *rule, int num, struct fw3_protocol *proto,
363            struct fw3_address *sip, struct fw3_address *dip,
364            struct fw3_port *sport, struct fw3_port *dport,
365            struct fw3_mac *mac, struct fw3_icmptype *icmptype)
366 {
367         struct fw3_ipt_rule *r;
368
369         if (!fw3_is_family(sip, handle->family) ||
370             !fw3_is_family(dip, handle->family))
371         {
372                 if ((sip && !sip->resolved) || (dip && !dip->resolved))
373                         info("     ! Skipping due to different family of ip address");
374
375                 return;
376         }
377
378         if (proto->protocol == 58 && handle->family == FW3_FAMILY_V4)
379         {
380                 info("     ! Skipping due to different family of protocol");
381                 return;
382         }
383
384         r = fw3_ipt_rule_create(handle, proto, NULL, NULL, sip, dip);
385         fw3_ipt_rule_sport_dport(r, sport, dport);
386         fw3_ipt_rule_device(r, rule->device, rule->direction_out);
387         fw3_ipt_rule_icmptype(r, icmptype);
388         fw3_ipt_rule_mac(r, mac);
389         fw3_ipt_rule_ipset(r, &rule->ipset);
390         fw3_ipt_rule_limit(r, &rule->limit);
391         fw3_ipt_rule_time(r, &rule->time);
392         fw3_ipt_rule_mark(r, &rule->mark);
393         set_target(r, rule);
394         fw3_ipt_rule_extra(r, rule->extra);
395         set_comment(r, rule->name, num);
396         append_chain(r, rule);
397 }
398
399 static void
400 expand_rule(struct fw3_ipt_handle *handle, struct fw3_state *state,
401             struct fw3_rule *rule, int num)
402 {
403         struct fw3_protocol *proto;
404         struct fw3_address *sip;
405         struct fw3_address *dip;
406         struct fw3_port *sport;
407         struct fw3_port *dport;
408         struct fw3_mac *mac;
409         struct fw3_icmptype *icmptype;
410
411         struct list_head *sports = NULL;
412         struct list_head *dports = NULL;
413         struct list_head *icmptypes = NULL;
414
415         struct list_head empty;
416         INIT_LIST_HEAD(&empty);
417
418         if (!fw3_is_family(rule, handle->family))
419                 return;
420
421         if ((rule->target == FW3_FLAG_NOTRACK && handle->table != FW3_TABLE_RAW) ||
422             (rule->target == FW3_FLAG_MARK && handle->table != FW3_TABLE_MANGLE) ||
423                 (rule->target < FW3_FLAG_NOTRACK && handle->table != FW3_TABLE_FILTER))
424                 return;
425
426         if (rule->name)
427                 info("   * Rule '%s'", rule->name);
428         else
429                 info("   * Rule #%u", num);
430
431         if (!fw3_is_family(rule->_src, handle->family) ||
432             !fw3_is_family(rule->_dest, handle->family))
433         {
434                 info("     ! Skipping due to different family of zone");
435                 return;
436         }
437
438         if (rule->ipset.ptr)
439         {
440                 if (!fw3_is_family(rule->ipset.ptr, handle->family))
441                 {
442                         info("     ! Skipping due to different family in ipset");
443                         return;
444                 }
445
446                 if (!fw3_check_ipset(rule->ipset.ptr))
447                 {
448                         info("     ! Skipping due to missing ipset '%s'",
449                              rule->ipset.ptr->external
450                                         ? rule->ipset.ptr->external : rule->ipset.ptr->name);
451                         return;
452                 }
453
454                 set(rule->ipset.ptr->flags, handle->family, handle->family);
455         }
456
457         list_for_each_entry(proto, &rule->proto, list)
458         {
459                 /* icmp / ipv6-icmp */
460                 if (proto->protocol == 1 || proto->protocol == 58)
461                 {
462                         sports = &empty;
463                         dports = &empty;
464                         icmptypes = &rule->icmp_type;
465                 }
466                 else
467                 {
468                         sports = &rule->port_src;
469                         dports = &rule->port_dest;
470                         icmptypes = &empty;
471                 }
472
473                 fw3_foreach(sip, &rule->ip_src)
474                 fw3_foreach(dip, &rule->ip_dest)
475                 fw3_foreach(sport, sports)
476                 fw3_foreach(dport, dports)
477                 fw3_foreach(mac, &rule->mac_src)
478                 fw3_foreach(icmptype, icmptypes)
479                         print_rule(handle, state, rule, num, proto, sip, dip,
480                                    sport, dport, mac, icmptype);
481         }
482 }
483
484 void
485 fw3_print_rules(struct fw3_ipt_handle *handle, struct fw3_state *state)
486 {
487         int num = 0;
488         struct fw3_rule *rule;
489
490         list_for_each_entry(rule, &state->rules, list)
491                 expand_rule(handle, state, rule, num++);
492 }