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_target
  65 {
  66         FW3_TARGET_UNSPEC        = 0,
  67         FW3_TARGET_ACCEPT        = 6,
  68         FW3_TARGET_REJECT        = 7,
  69         FW3_TARGET_DROP          = 8,
  70         FW3_TARGET_NOTRACK       = 9,
  71         FW3_TARGET_DNAT          = 10,
  72         FW3_TARGET_SNAT          = 11,
  73         FW3_TARGET_CUSTOM_CNS_V4 = 12,
  74         FW3_TARGET_CUSTOM_CNS_V6 = 13,
  75 };
  76
  77 enum fw3_default
  78 {
  79         FW3_DEFAULT_UNSPEC        = 0,
  80         FW3_DEFAULT_CUSTOM_CHAINS = 14,
  81         FW3_DEFAULT_SYN_FLOOD     = 15,
  82         FW3_DEFAULT_MTU_FIX       = 16,
  83         FW3_DEFAULT_DROP_INVALID  = 17,
  84 };
  85
  86 extern const char *fw3_flag_names[FW3_DEFAULT_DROP_INVALID + 1];
  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 struct fw3_ipset_datatype
 122 {
 123         struct list_head list;
 124         enum fw3_ipset_type type;
 125         bool dest;
 126 };
 127
 128 struct fw3_device
 129 {
 130         struct list_head list;
 131
 132         bool set;
 133         bool any;
 134         bool invert;
 135         char name[32];
 136 };
 137
 138 struct fw3_address
 139 {
 140         struct list_head list;
 141
 142         bool set;
 143         bool range;
 144         bool invert;
 145         enum fw3_family family;
 146         int mask;
 147         union {
 148                 struct in_addr v4;
 149                 struct in6_addr v6;
 150                 struct ether_addr mac;
 151         } address;
 152         union {
 153                 struct in_addr v4;
 154                 struct in6_addr v6;
 155                 struct ether_addr mac;
 156         } address2;
 157 };
 158
 159 struct fw3_mac
 160 {
 161         struct list_head list;
 162
 163         bool set;
 164         bool invert;
 165         struct ether_addr mac;
 166 };
 167
 168 struct fw3_protocol
 169 {
 170         struct list_head list;
 171
 172         bool any;
 173         bool invert;
 174         uint32_t protocol;
 175 };
 176
 177 struct fw3_port
 178 {
 179         struct list_head list;
 180
 181         bool set;
 182         bool invert;
 183         uint16_t port_min;
 184         uint16_t port_max;
 185 };
 186
 187 struct fw3_icmptype
 188 {
 189         struct list_head list;
 190
 191         bool invert;
 192         enum fw3_family family;
 193         uint8_t type;
 194         uint8_t code_min;
 195         uint8_t code_max;
 196         uint8_t type6;
 197         uint8_t code6_min;
 198         uint8_t code6_max;
 199 };
 200
 201 struct fw3_limit
 202 {
 203         bool invert;
 204         int rate;
 205         int burst;
 206         enum fw3_limit_unit unit;
 207 };
 208
 209 struct fw3_time
 210 {
 211         bool utc;
 212         struct tm datestart;
 213         struct tm datestop;
 214         uint32_t timestart;
 215         uint32_t timestop;
 216         uint32_t monthdays; /* bit 0 is invert + 1 .. 31 */
 217         uint8_t weekdays;   /* bit 0 is invert + 1 .. 7 */
 218 };
 219
 220 struct fw3_defaults
 221 {
 222         enum fw3_target policy_input;
 223         enum fw3_target policy_output;
 224         enum fw3_target policy_forward;
 225
 226         bool drop_invalid;
 227
 228         bool syn_flood;
 229         struct fw3_limit syn_flood_rate;
 230
 231         bool tcp_syncookies;
 232         bool tcp_ecn;
 233         bool tcp_window_scaling;
 234
 235         bool accept_redirects;
 236         bool accept_source_route;
 237
 238         bool custom_chains;
 239
 240         bool disable_ipv6;
 241
 242         uint32_t flags;
 243 };
 244
 245 struct fw3_zone
 246 {
 247         struct list_head list;
 248         struct list_head running_list;
 249
 250         bool enabled;
 251         const char *name;
 252
 253         enum fw3_family family;
 254
 255         enum fw3_target policy_input;
 256         enum fw3_target policy_output;
 257         enum fw3_target policy_forward;
 258
 259         struct list_head networks;
 260         struct list_head devices;
 261         struct list_head subnets;
 262
 263         const char *extra_src;
 264         const char *extra_dest;
 265
 266         bool masq;
 267         struct list_head masq_src;
 268         struct list_head masq_dest;
 269
 270         bool conntrack;
 271         bool mtu_fix;
 272
 273         bool log;
 274         struct fw3_limit log_limit;
 275
 276         bool custom_chains;
 277
 278         uint32_t src_flags;
 279         uint32_t dst_flags;
 280
 281         uint32_t running_src_flags;
 282         uint32_t running_dst_flags;
 283 };
 284
 285 struct fw3_rule
 286 {
 287         struct list_head list;
 288
 289         bool enabled;
 290         const char *name;
 291
 292         enum fw3_family family;
 293
 294         struct fw3_zone *_src;
 295         struct fw3_zone *_dest;
 296
 297         struct fw3_device src;
 298         struct fw3_device dest;
 299
 300         struct fw3_ipset *_ipset;
 301         struct fw3_device ipset;
 302
 303         struct list_head proto;
 304
 305         struct list_head ip_src;
 306         struct list_head mac_src;
 307         struct list_head port_src;
 308
 309         struct list_head ip_dest;
 310         struct list_head port_dest;
 311
 312         struct list_head icmp_type;
 313
 314         struct fw3_limit limit;
 315         struct fw3_time time;
 316
 317         enum fw3_target target;
 318
 319         const char *extra;
 320 };
 321
 322 struct fw3_redirect
 323 {
 324         struct list_head list;
 325
 326         bool enabled;
 327         const char *name;
 328
 329         enum fw3_family family;
 330
 331         struct fw3_zone *_src;
 332         struct fw3_zone *_dest;
 333
 334         struct fw3_device src;
 335         struct fw3_device dest;
 336
 337         struct fw3_ipset *_ipset;
 338         struct fw3_device ipset;
 339
 340         struct list_head proto;
 341
 342         struct fw3_address ip_src;
 343         struct list_head mac_src;
 344         struct fw3_port port_src;
 345
 346         struct fw3_address ip_dest;
 347         struct fw3_port port_dest;
 348
 349         struct fw3_address ip_redir;
 350         struct fw3_port port_redir;
 351
 352         struct fw3_time time;
 353
 354         enum fw3_target target;
 355
 356         const char *extra;
 357
 358         bool reflection;
 359 };
 360
 361 struct fw3_forward
 362 {
 363         struct list_head list;
 364
 365         bool enabled;
 366         const char *name;
 367
 368         enum fw3_family family;
 369
 370         struct fw3_zone *_src;
 371         struct fw3_zone *_dest;
 372
 373         struct fw3_device src;
 374         struct fw3_device dest;
 375 };
 376
 377 struct fw3_ipset
 378 {
 379         struct list_head list;
 380         struct list_head running_list;
 381
 382         bool enabled;
 383         const char *name;
 384         enum fw3_family family;
 385
 386         enum fw3_ipset_method method;
 387         struct list_head datatypes;
 388
 389         struct fw3_address iprange;
 390         struct fw3_port portrange;
 391
 392         int netmask;
 393         int maxelem;
 394         int hashsize;
 395
 396         int timeout;
 397
 398         const char *external;
 399
 400         uint32_t flags;
 401 };
 402
 403 struct fw3_include
 404 {
 405         struct list_head list;
 406         struct list_head running_list;
 407
 408         bool enabled;
 409         const char *name;
 410         enum fw3_family family;
 411
 412         const char *path;
 413         enum fw3_include_type type;
 414 };
 415
 416 struct fw3_state
 417 {
 418         struct uci_context *uci;
 419         struct fw3_defaults defaults;
 420         struct list_head zones;
 421         struct list_head rules;
 422         struct list_head redirects;
 423         struct list_head forwards;
 424         struct list_head ipsets;
 425         struct list_head includes;
 426
 427         struct fw3_defaults running_defaults;
 428         struct list_head running_zones;
 429         struct list_head running_ipsets;
 430
 431         bool disable_ipsets;
 432         bool statefile;
 433 };
 434
 435
 436 struct fw3_option
 437 {
 438         const char *name;
 439         bool (*parse)(void *, const char *);
 440         uintptr_t offset;
 441         size_t elem_size;
 442 };
 443
 444 #define FW3_OPT(name, parse, structure, member) \
 445         { name, fw3_parse_##parse, offsetof(struct fw3_##structure, member) }
 446
 447 #define FW3_LIST(name, parse, structure, member) \
 448         { name, fw3_parse_##parse, offsetof(struct fw3_##structure, member), \
 449           sizeof(struct fw3_##structure) }
 450
 451
 452 bool fw3_parse_bool(void *ptr, const char *val);
 453 bool fw3_parse_int(void *ptr, const char *val);
 454 bool fw3_parse_string(void *ptr, const char *val);
 455 bool fw3_parse_target(void *ptr, const char *val);
 456 bool fw3_parse_limit(void *ptr, const char *val);
 457 bool fw3_parse_device(void *ptr, const char *val);
 458 bool fw3_parse_address(void *ptr, const char *val);
 459 bool fw3_parse_mac(void *ptr, const char *val);
 460 bool fw3_parse_port(void *ptr, const char *val);
 461 bool fw3_parse_family(void *ptr, const char *val);
 462 bool fw3_parse_icmptype(void *ptr, const char *val);
 463 bool fw3_parse_protocol(void *ptr, const char *val);
 464
 465 bool fw3_parse_ipset_method(void *ptr, const char *val);
 466 bool fw3_parse_ipset_datatype(void *ptr, const char *val);
 467
 468 bool fw3_parse_include_type(void *ptr, const char *val);
 469
 470 bool fw3_parse_date(void *ptr, const char *val);
 471 bool fw3_parse_time(void *ptr, const char *val);
 472 bool fw3_parse_weekdays(void *ptr, const char *val);
 473 bool fw3_parse_monthdays(void *ptr, const char *val);
 474
 475 void fw3_parse_options(void *s, const struct fw3_option *opts,
 476                        struct uci_section *section);
 477
 478 void fw3_format_in_out(struct fw3_device *in, struct fw3_device *out);
 479 void fw3_format_src_dest(struct fw3_address *src, struct fw3_address *dest);
 480 void fw3_format_sport_dport(struct fw3_port *sp, struct fw3_port *dp);
 481 void fw3_format_mac(struct fw3_mac *mac);
 482 void fw3_format_protocol(struct fw3_protocol *proto, enum fw3_family family);
 483 void fw3_format_icmptype(struct fw3_icmptype *icmp, enum fw3_family family);
 484 void fw3_format_limit(struct fw3_limit *limit);
 485 void fw3_format_ipset(struct fw3_ipset *ipset, bool invert);
 486 void fw3_format_time(struct fw3_time *time);
 487
 488 void __fw3_format_comment(const char *comment, ...);
 489 #define fw3_format_comment(...) __fw3_format_comment(__VA_ARGS__, NULL)
 490
 491 void fw3_format_extra(const char *extra);
 492
 493 #endif