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