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