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