options.h

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