options.h

   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 #ifndef __FW3_OPTIONS_H
  20 #define __FW3_OPTIONS_H
  21
  22
  23 #include <errno.h>
  24
  25 #include <stdlib.h>
  26 #include <stdarg.h>
  27 #include <stdbool.h>
  28
  29 #include <ctype.h>
  30 #include <string.h>
  31
  32 #include <netdb.h>
  33 #include <arpa/inet.h>
  34 #include <sys/socket.h>
  35 #include <netinet/in.h>
  36 #include <netinet/ether.h>
  37
  38 #include <time.h>
  39
  40 #include <uci.h>
  41
  42 #include <libubox/list.h>
  43 #include <libubox/utils.h>
  44
  45 #include "icmp_codes.h"
  46 #include "utils.h"
  47
  48
  49 enum fw3_table
  50 {
  51         FW3_TABLE_FILTER = 0,
  52         FW3_TABLE_NAT    = 1,
  53         FW3_TABLE_MANGLE = 2,
  54         FW3_TABLE_RAW    = 3,
  55 };
  56
  57 enum fw3_family
  58 {
  59         FW3_FAMILY_ANY = 0,
  60         FW3_FAMILY_V4  = 4,
  61         FW3_FAMILY_V6  = 5,
  62 };
  63
  64 enum fw3_flag
  65 {
  66         FW3_FLAG_UNSPEC        = 0,
  67         FW3_FLAG_ACCEPT        = 6,
  68         FW3_FLAG_REJECT        = 7,
  69         FW3_FLAG_DROP          = 8,
  70         FW3_FLAG_NOTRACK       = 9,
  71         FW3_FLAG_DNAT          = 10,
  72         FW3_FLAG_SNAT          = 11,
  73         FW3_FLAG_SRC_ACCEPT    = 12,
  74         FW3_FLAG_SRC_REJECT    = 13,
  75         FW3_FLAG_SRC_DROP      = 14,
  76         FW3_FLAG_CUSTOM_CHAINS = 15,
  77         FW3_FLAG_SYN_FLOOD     = 16,
  78         FW3_FLAG_MTU_FIX       = 17,
  79         FW3_FLAG_DROP_INVALID  = 18,
  80         FW3_FLAG_HOTPLUG       = 19,
  81         FW3_FLAG_DELETED       = 20,
  82
  83         __FW3_FLAG_MAX
  84 };
  85
  86 extern const char *fw3_flag_names[__FW3_FLAG_MAX];
  87
  88
  89 enum fw3_limit_unit
  90 {
  91         FW3_LIMIT_UNIT_SECOND = 0,
  92         FW3_LIMIT_UNIT_MINUTE = 1,
  93         FW3_LIMIT_UNIT_HOUR   = 2,
  94         FW3_LIMIT_UNIT_DAY    = 3,
  95 };
  96
  97 enum fw3_ipset_method
  98 {
  99         FW3_IPSET_METHOD_UNSPEC = 0,
 100         FW3_IPSET_METHOD_BITMAP = 1,
 101         FW3_IPSET_METHOD_HASH   = 2,
 102         FW3_IPSET_METHOD_LIST   = 3,
 103 };
 104
 105 enum fw3_ipset_type
 106 {
 107         FW3_IPSET_TYPE_UNSPEC = 0,
 108         FW3_IPSET_TYPE_IP     = 1,
 109         FW3_IPSET_TYPE_PORT   = 2,
 110         FW3_IPSET_TYPE_MAC    = 3,
 111         FW3_IPSET_TYPE_NET    = 4,
 112         FW3_IPSET_TYPE_SET    = 5,
 113 };
 114
 115 enum fw3_include_type
 116 {
 117         FW3_INC_TYPE_SCRIPT   = 0,
 118         FW3_INC_TYPE_RESTORE  = 1,
 119 };
 120
 121 enum fw3_reflection_source
 122 {
 123         FW3_REFLECTION_INTERNAL = 0,
 124         FW3_REFLECTION_EXTERNAL = 1,
 125 };
 126
 127 struct fw3_ipset_datatype
 128 {
 129         struct list_head list;
 130         enum fw3_ipset_type type;
 131         bool dest;
 132 };
 133
 134 struct fw3_device
 135 {
 136         struct list_head list;
 137
 138         bool set;
 139         bool any;
 140         bool invert;
 141         char name[32];
 142         struct fw3_device *network;
 143 };
 144
 145 struct fw3_address
 146 {
 147         struct list_head list;
 148
 149         bool set;
 150         bool range;
 151         bool invert;
 152         enum fw3_family family;
 153         int mask;
 154         union {
 155                 struct in_addr v4;
 156                 struct in6_addr v6;
 157                 struct ether_addr mac;
 158         } address;
 159         union {
 160                 struct in_addr v4;
 161                 struct in6_addr v6;
 162                 struct ether_addr mac;
 163         } address2;
 164 };
 165
 166 struct fw3_mac
 167 {
 168         struct list_head list;
 169
 170         bool set;
 171         bool invert;
 172         struct ether_addr mac;
 173 };
 174
 175 struct fw3_protocol
 176 {
 177         struct list_head list;
 178
 179         bool any;
 180         bool invert;
 181         uint32_t protocol;
 182 };
 183
 184 struct fw3_port
 185 {
 186         struct list_head list;
 187
 188         bool set;
 189         bool invert;
 190         uint16_t port_min;
 191         uint16_t port_max;
 192 };
 193
 194 struct fw3_icmptype
 195 {
 196         struct list_head list;
 197
 198         bool invert;
 199         enum fw3_family family;
 200         uint8_t type;
 201         uint8_t code_min;
 202         uint8_t code_max;
 203         uint8_t type6;
 204         uint8_t code6_min;
 205         uint8_t code6_max;
 206 };
 207
 208 struct fw3_limit
 209 {
 210         bool invert;
 211         int rate;
 212         int burst;
 213         enum fw3_limit_unit unit;
 214 };
 215
 216 struct fw3_time
 217 {
 218         bool utc;
 219         struct tm datestart;
 220         struct tm datestop;
 221         uint32_t timestart;
 222         uint32_t timestop;
 223         uint32_t monthdays; /* bit 0 is invert + 1 .. 31 */
 224         uint8_t weekdays;   /* bit 0 is invert + 1 .. 7 */
 225 };
 226
 227 struct fw3_defaults
 228 {
 229         enum fw3_flag policy_input;
 230         enum fw3_flag policy_output;
 231         enum fw3_flag policy_forward;
 232
 233         bool drop_invalid;
 234
 235         bool syn_flood;
 236         struct fw3_limit syn_flood_rate;
 237
 238         bool tcp_syncookies;
 239         bool tcp_ecn;
 240         bool tcp_window_scaling;
 241
 242         bool accept_redirects;
 243         bool accept_source_route;
 244
 245         bool custom_chains;
 246
 247         bool disable_ipv6;
 248
 249         uint32_t flags[2];
 250 };
 251
 252 struct fw3_zone
 253 {
 254         struct list_head list;
 255         struct list_head running_list;
 256
 257         bool enabled;
 258         const char *name;
 259
 260         enum fw3_family family;
 261
 262         enum fw3_flag policy_input;
 263         enum fw3_flag policy_output;
 264         enum fw3_flag policy_forward;
 265
 266         struct list_head networks;
 267         struct list_head devices;
 268         struct list_head subnets;
 269
 270         struct list_head running_networks;
 271         struct list_head running_devices;
 272
 273         const char *extra_src;
 274         const char *extra_dest;
 275
 276         bool masq;
 277         struct list_head masq_src;
 278         struct list_head masq_dest;
 279
 280         bool conntrack;
 281         bool mtu_fix;
 282
 283         bool log;
 284         struct fw3_limit log_limit;
 285
 286         bool custom_chains;
 287
 288         uint32_t flags[2];
 289 };
 290
 291 struct fw3_rule
 292 {
 293         struct list_head list;
 294
 295         bool enabled;
 296         const char *name;
 297
 298         enum fw3_family family;
 299
 300         struct fw3_zone *_src;
 301         struct fw3_zone *_dest;
 302
 303         struct fw3_device src;
 304         struct fw3_device dest;
 305
 306         struct fw3_ipset *_ipset;
 307         struct fw3_device ipset;
 308
 309         struct list_head proto;
 310
 311         struct list_head ip_src;
 312         struct list_head mac_src;
 313         struct list_head port_src;
 314
 315         struct list_head ip_dest;
 316         struct list_head port_dest;
 317
 318         struct list_head icmp_type;
 319
 320         struct fw3_limit limit;
 321         struct fw3_time time;
 322
 323         enum fw3_flag target;
 324
 325         const char *extra;
 326 };
 327
 328 struct fw3_redirect
 329 {
 330         struct list_head list;
 331
 332         bool enabled;
 333         const char *name;
 334
 335         enum fw3_family family;
 336
 337         struct fw3_zone *_src;
 338         struct fw3_zone *_dest;
 339
 340         struct fw3_device src;
 341         struct fw3_device dest;
 342
 343         struct fw3_ipset *_ipset;
 344         struct fw3_device ipset;
 345
 346         struct list_head proto;
 347
 348         struct fw3_address ip_src;
 349         struct list_head mac_src;
 350         struct fw3_port port_src;
 351
 352         struct fw3_address ip_dest;
 353         struct fw3_port port_dest;
 354
 355         struct fw3_address ip_redir;
 356         struct fw3_port port_redir;
 357
 358         struct fw3_time time;
 359
 360         enum fw3_flag target;
 361
 362         const char *extra;
 363
 364         bool reflection;
 365         enum fw3_reflection_source reflection_src;
 366 };
 367
 368 struct fw3_forward
 369 {
 370         struct list_head list;
 371
 372         bool enabled;
 373         const char *name;
 374
 375         enum fw3_family family;
 376
 377         struct fw3_zone *_src;
 378         struct fw3_zone *_dest;
 379
 380         struct fw3_device src;
 381         struct fw3_device dest;
 382 };
 383
 384 struct fw3_ipset
 385 {
 386         struct list_head list;
 387         struct list_head running_list;
 388
 389         bool enabled;
 390         const char *name;
 391         enum fw3_family family;
 392
 393         enum fw3_ipset_method method;
 394         struct list_head datatypes;
 395
 396         struct fw3_address iprange;
 397         struct fw3_port portrange;
 398
 399         int netmask;
 400         int maxelem;
 401         int hashsize;
 402
 403         int timeout;
 404
 405         const char *external;
 406
 407         uint32_t flags[2];
 408 };
 409
 410 struct fw3_include
 411 {
 412         struct list_head list;
 413         struct list_head running_list;
 414
 415         bool enabled;
 416         const char *name;
 417         enum fw3_family family;
 418
 419         const char *path;
 420         enum fw3_include_type type;
 421
 422         bool reload;
 423 };
 424
 425 struct fw3_state
 426 {
 427         struct uci_context *uci;
 428         struct fw3_defaults defaults;
 429         struct list_head zones;
 430         struct list_head rules;
 431         struct list_head redirects;
 432         struct list_head forwards;
 433         struct list_head ipsets;
 434         struct list_head includes;
 435
 436         struct list_head running_zones;
 437         struct list_head running_ipsets;
 438
 439         bool disable_ipsets;
 440         bool statefile;
 441 };
 442
 443
 444 struct fw3_option
 445 {
 446         const char *name;
 447         bool (*parse)(void *, const char *, bool);
 448         uintptr_t offset;
 449         size_t elem_size;
 450 };
 451
 452 #define FW3_OPT(name, parse, structure, member) \
 453         { name, fw3_parse_##parse, offsetof(struct fw3_##structure, member) }
 454
 455 #define FW3_LIST(name, parse, structure, member) \
 456         { name, fw3_parse_##parse, offsetof(struct fw3_##structure, member), \
 457           sizeof(struct fw3_##structure) }
 458
 459 bool fw3_parse_bool(void *ptr, const char *val, bool is_list);
 460 bool fw3_parse_int(void *ptr, const char *val, bool is_list);
 461 bool fw3_parse_string(void *ptr, const char *val, bool is_list);
 462 bool fw3_parse_target(void *ptr, const char *val, bool is_list);
 463 bool fw3_parse_limit(void *ptr, const char *val, bool is_list);
 464 bool fw3_parse_device(void *ptr, const char *val, bool is_list);
 465 bool fw3_parse_address(void *ptr, const char *val, bool is_list);
 466 bool fw3_parse_network(void *ptr, const char *val, bool is_list);
 467 bool fw3_parse_mac(void *ptr, const char *val, bool is_list);
 468 bool fw3_parse_port(void *ptr, const char *val, bool is_list);
 469 bool fw3_parse_family(void *ptr, const char *val, bool is_list);
 470 bool fw3_parse_icmptype(void *ptr, const char *val, bool is_list);
 471 bool fw3_parse_protocol(void *ptr, const char *val, bool is_list);
 472
 473 bool fw3_parse_ipset_method(void *ptr, const char *val, bool is_list);
 474 bool fw3_parse_ipset_datatype(void *ptr, const char *val, bool is_list);
 475
 476 bool fw3_parse_include_type(void *ptr, const char *val, bool is_list);
 477 bool fw3_parse_reflection_source(void *ptr, const char *val, bool is_list);
 478
 479 bool fw3_parse_date(void *ptr, const char *val, bool is_list);
 480 bool fw3_parse_time(void *ptr, const char *val, bool is_list);
 481 bool fw3_parse_weekdays(void *ptr, const char *val, bool is_list);
 482 bool fw3_parse_monthdays(void *ptr, const char *val, bool is_list);
 483
 484 void fw3_parse_options(void *s, const struct fw3_option *opts,
 485                        struct uci_section *section);
 486
 487 void fw3_format_in_out(struct fw3_device *in, struct fw3_device *out);
 488 void fw3_format_src_dest(struct fw3_address *src, struct fw3_address *dest);
 489 void fw3_format_sport_dport(struct fw3_port *sp, struct fw3_port *dp);
 490 void fw3_format_mac(struct fw3_mac *mac);
 491 void fw3_format_protocol(struct fw3_protocol *proto, enum fw3_family family);
 492 void fw3_format_icmptype(struct fw3_icmptype *icmp, enum fw3_family family);
 493 void fw3_format_limit(struct fw3_limit *limit);
 494 void fw3_format_ipset(struct fw3_ipset *ipset, bool invert);
 495 void fw3_format_time(struct fw3_time *time);
 496
 497 void __fw3_format_comment(const char *comment, ...);
 498 #define fw3_format_comment(...) __fw3_format_comment(__VA_ARGS__, NULL)
 499
 500 void fw3_format_extra(const char *extra);
 501
 502 #endif