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