b2b4a25cf6f17bb5ec748823dbfee54e0c4cc7ea
[dragonfly.git] / sys / net / ipfw / ip_fw2.h
1 /*
2  * Copyright (c) 2002 Luigi Rizzo, Universita` di Pisa
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23  * SUCH DAMAGE.
24  *
25  * $FreeBSD: src/sys/netinet/ip_fw2.h,v 1.1.2.2 2002/08/16 11:03:11 luigi Exp $
26  */
27
28 #ifndef _IPFW2_H
29 #define _IPFW2_H
30
31 /*
32  * The kernel representation of ipfw rules is made of a list of
33  * 'instructions' (for all practical purposes equivalent to BPF
34  * instructions), which specify which fields of the packet
35  * (or its metatada) should be analysed.
36  *
37  * Each instruction is stored in a structure which begins with
38  * "ipfw_insn", and can contain extra fields depending on the
39  * instruction type (listed below).
40  *
41  * "enum ipfw_opcodes" are the opcodes supported. We can have up
42  * to 256 different opcodes.
43  */
44
45 enum ipfw_opcodes {             /* arguments (4 byte each)      */
46         O_NOP,
47
48         O_IP_SRC,               /* u32 = IP                     */
49         O_IP_SRC_MASK,          /* ip = IP/mask                 */
50         O_IP_SRC_ME,            /* none                         */
51         O_IP_SRC_SET,           /* u32=base, arg1=len, bitmap   */
52
53         O_IP_DST,               /* u32 = IP                     */
54         O_IP_DST_MASK,          /* ip = IP/mask                 */
55         O_IP_DST_ME,            /* none                         */
56         O_IP_DST_SET,           /* u32=base, arg1=len, bitmap   */
57
58         O_IP_SRCPORT,           /* (n)port list:mask 4 byte ea  */
59         O_IP_DSTPORT,           /* (n)port list:mask 4 byte ea  */
60         O_PROTO,                /* arg1=protocol                */
61
62         O_MACADDR2,             /* 2 mac addr:mask              */
63         O_MAC_TYPE,             /* same as srcport              */
64
65         O_LAYER2,               /* none                         */
66         O_IN,                   /* none                         */
67         O_FRAG,                 /* none                         */
68
69         O_RECV,                 /* none                         */
70         O_XMIT,                 /* none                         */
71         O_VIA,                  /* none                         */
72
73         O_IPOPT,                /* arg1 = 2*u8 bitmap           */
74         O_IPLEN,                /* arg1 = len                   */
75         O_IPID,                 /* arg1 = id                    */
76
77         O_IPTOS,                /* arg1 = id                    */
78         O_IPPRECEDENCE,         /* arg1 = precedence << 5       */
79         O_IPTTL,                /* arg1 = TTL                   */
80
81         O_IPVER,                /* arg1 = version               */
82         O_UID,                  /* u32 = id                     */
83         O_GID,                  /* u32 = id                     */
84         O_ESTAB,                /* none (tcp established)       */
85         O_TCPFLAGS,             /* arg1 = 2*u8 bitmap           */
86         O_TCPWIN,               /* arg1 = desired win           */
87         O_TCPSEQ,               /* u32 = desired seq.           */
88         O_TCPACK,               /* u32 = desired seq.           */
89         O_ICMPTYPE,             /* u32 = icmp bitmap            */
90         O_TCPOPTS,              /* arg1 = 2*u8 bitmap           */
91
92         O_PROBE_STATE,          /* none                         */
93         O_KEEP_STATE,           /* none                         */
94         O_LIMIT,                /* ipfw_insn_limit              */
95         O_LIMIT_PARENT,         /* dyn_type, not an opcode.     */
96
97         /* Actions. */
98         O_LOG,                  /* ipfw_insn_log                */
99         O_PROB,                 /* u32 = match probability      */
100         O_CHECK_STATE,          /* none                         */
101         O_ACCEPT,               /* none                         */
102         O_DENY,                 /* none                         */
103         O_REJECT,               /* arg1=icmp arg (same as deny) */
104         O_COUNT,                /* none                         */
105         O_SKIPTO,               /* arg1=next rule number        */
106         O_PIPE,                 /* arg1=pipe number             */
107         O_QUEUE,                /* arg1=queue number            */
108         O_DIVERT,               /* arg1=port number             */
109         O_TEE,                  /* arg1=port number             */
110         O_FORWARD_IP,           /* fwd sockaddr                 */
111         O_FORWARD_MAC,          /* fwd mac                      */
112
113         /* Table based filters. */
114         O_IP_SRC_TABLE,         /* arg1 = tableid               */
115         O_IP_DST_TABLE,         /* arg1 = tableid               */
116
117         /* Action. */
118         O_DEFRAG,               /* none                         */
119
120         O_LAST_OPCODE           /* not an opcode!               */
121 };
122
123 /*
124  * Template for instructions.
125  *
126  * ipfw_insn is used for all instructions which require no operands,
127  * a single 16-bit value (arg1), or a couple of 8-bit values.
128  *
129  * For other instructions which require different/larger arguments
130  * we have derived structures, ipfw_insn_*.
131  *
132  * The size of the instruction (in 32-bit words) is in the low
133  * 6 bits of "len". The 2 remaining bits are used to implement
134  * NOT and OR on individual instructions. Given a type, you can
135  * compute the length to be put in "len" using F_INSN_SIZE(t)
136  *
137  * F_NOT        negates the match result of the instruction.
138  *
139  * F_OR         is used to build or blocks. By default, instructions
140  *              are evaluated as part of a logical AND. An "or" block
141  *              { X or Y or Z } contains F_OR set in all but the last
142  *              instruction of the block. A match will cause the code
143  *              to skip past the last instruction of the block.
144  *
145  * NOTA BENE: in a couple of places we assume that
146  *      sizeof(ipfw_insn) == sizeof(uint32_t)
147  * this needs to be fixed.
148  *
149  */
150 typedef struct  _ipfw_insn {    /* template for instructions */
151         enum ipfw_opcodes       opcode:8;
152         uint8_t         len;    /* numer of 32-byte words */
153 #define F_NOT           0x80
154 #define F_OR            0x40
155 #define F_LEN_MASK      0x3f
156 #define F_LEN(cmd)      ((cmd)->len & F_LEN_MASK)
157
158         uint16_t        arg1;
159 } ipfw_insn;
160
161 /*
162  * The F_INSN_SIZE(type) computes the size, in 4-byte words, of
163  * a given type.
164  */
165 #define F_INSN_SIZE(t)  ((sizeof (t))/sizeof(uint32_t))
166
167 /*
168  * This is used to store an array of 16-bit entries (ports etc.)
169  */
170 typedef struct  _ipfw_insn_u16 {
171         ipfw_insn o;
172         uint16_t ports[2];      /* there may be more */
173 } ipfw_insn_u16;
174
175 /*
176  * This is used to store an array of 32-bit entries
177  * (uid, single IPv4 addresses etc.)
178  */
179 typedef struct  _ipfw_insn_u32 {
180         ipfw_insn o;
181         uint32_t d[1];  /* one or more */
182 } ipfw_insn_u32;
183
184 /*
185  * This is used to store IP addr-mask pairs.
186  */
187 typedef struct  _ipfw_insn_ip {
188         ipfw_insn o;
189         struct in_addr  addr;
190         struct in_addr  mask;
191 } ipfw_insn_ip;
192
193 /*
194  * This is used to forward to a given address (ip)
195  */
196 typedef struct  _ipfw_insn_sa {
197         ipfw_insn o;
198         struct sockaddr_in sa;
199 } ipfw_insn_sa;
200
201 /*
202  * This is used for MAC addr-mask pairs.
203  */
204 typedef struct  _ipfw_insn_mac {
205         ipfw_insn o;
206         u_char addr[12];        /* dst[6] + src[6] */
207         u_char mask[12];        /* dst[6] + src[6] */
208 } ipfw_insn_mac;
209
210 /*
211  * This is used for interface match rules (recv xx, xmit xx)
212  */
213 typedef struct  _ipfw_insn_if {
214         ipfw_insn o;
215         union {
216                 struct in_addr ip;
217                 int glob;
218         } p;
219         char name[IFNAMSIZ];
220 } ipfw_insn_if;
221
222 /*
223  * This is used for pipe and queue actions, which need to store
224  * a single pointer (which can have different size on different
225  * architectures.
226  */
227 typedef struct  _ipfw_insn_pipe {
228         ipfw_insn       o;
229         void            *pipe_ptr;
230 } ipfw_insn_pipe;
231
232 /*
233  * This is used for limit rules.
234  */
235 typedef struct  _ipfw_insn_limit {
236         ipfw_insn o;
237         uint8_t _pad;
238         uint8_t limit_mask;     /* combination of DYN_* below   */
239 #define DYN_SRC_ADDR    0x1
240 #define DYN_SRC_PORT    0x2
241 #define DYN_DST_ADDR    0x4
242 #define DYN_DST_PORT    0x8
243
244         uint16_t conn_limit;
245 } ipfw_insn_limit;
246
247 /*
248  * This is used for log instructions
249  */
250 typedef struct  _ipfw_insn_log {
251         ipfw_insn o;
252         uint32_t max_log;       /* how many do we log -- 0 = all */
253         uint32_t log_left;      /* how many left to log         */
254 } ipfw_insn_log;
255
256 #ifdef _KERNEL
257
258 /*
259  * Here we have the structure representing an ipfw rule.
260  *
261  * It starts with a general area (with link fields and counters)
262  * followed by an array of one or more instructions, which the code
263  * accesses as an array of 32-bit values.
264  *
265  * Given a rule pointer  r:
266  *
267  *  r->cmd              is the start of the first instruction.
268  *  ACTION_PTR(r)       is the start of the first action (things to do
269  *                      once a rule matched).
270  *
271  * When assembling instruction, remember the following:
272  *
273  *  + if a rule has a "keep-state" (or "limit") option, then the
274  *      first instruction (at r->cmd) MUST BE an O_PROBE_STATE
275  *  + if a rule has a "log" option, then the first action
276  *      (at ACTION_PTR(r)) MUST be O_LOG
277  *
278  * NOTE: we use a simple linked list of rules because we never need
279  *      to delete a rule without scanning the list. We do not use
280  *      queue(3) macros for portability and readability.
281  */
282
283 struct ip_fw {
284         struct ip_fw    *next;          /* linked list of rules         */
285         struct ip_fw    *next_rule;     /* ptr to next [skipto] rule    */
286         uint16_t        act_ofs;        /* offset of action in 32-bit units */
287         uint16_t        cmd_len;        /* # of 32-bit words in cmd     */
288         uint16_t        rulenum;        /* rule number                  */
289         uint8_t         set;            /* rule set (0..31)             */
290         uint8_t         usr_flags;      /* IPFW_USR_F_                  */
291
292         /* These fields are present in all rules.                       */
293         uint64_t        pcnt;           /* Packet counter               */
294         uint64_t        bcnt;           /* Byte counter                 */
295         uint32_t        timestamp;      /* tv_sec of last match         */
296
297         int             cpuid;          /* owner cpu                    */
298         struct ip_fw    *sibling;       /* clone on next cpu            */
299
300         struct ip_fw    **cross_rules;  /* cross referenced rules       */
301         uint64_t        cross_refs;     /* cross references             */
302
303         uint32_t        refcnt;         /* Ref count for transit pkts   */
304         uint32_t        rule_flags;     /* IPFW_RULE_F_                 */
305         uintptr_t       track_ruleid;   /* ruleid for src/dst tracks    */
306
307         ipfw_insn       cmd[1];         /* storage for commands         */
308 };
309
310 #define IPFW_RULE_F_INVALID     0x1
311 /* unused                       0x2 */
312 #define IPFW_RULE_F_GENSTATE    0x4
313 #define IPFW_RULE_F_GENTRACK    0x8
314 #define IPFW_RULE_F_CROSSREF    0x10
315
316 #define RULESIZE(rule)  (sizeof(struct ip_fw) + (rule)->cmd_len * 4 - 4)
317
318 /*
319  * This structure is used as a flow mask and a flow id for various
320  * parts of the code.
321  */
322 struct ipfw_flow_id {
323         uint32_t        dst_ip;
324         uint32_t        src_ip;
325         uint16_t        dst_port;
326         uint16_t        src_port;
327         uint8_t         proto;
328         uint8_t         flags;  /* protocol-specific flags */
329 };
330
331 /*
332  * Main firewall chains definitions and global var's definitions.
333  */
334
335 /* ipfw_chk/ip_fw_chk_ptr return values */
336 #define IP_FW_PASS      0
337 #define IP_FW_DENY      1
338 #define IP_FW_DIVERT    2
339 #define IP_FW_TEE       3
340 #define IP_FW_DUMMYNET  4
341 #define IP_FW_CONTINUE  5
342
343 /*
344  * arguments for calling ipfw_chk() and dummynet_io(). We put them
345  * all into a structure because this way it is easier and more
346  * efficient to pass variables around and extend the interface.
347  */
348 struct ip_fw_args {
349         struct mbuf     *m;             /* the mbuf chain               */
350         struct ifnet    *oif;           /* output interface             */
351         struct ip_fw    *rule;          /* matching rule                */
352         struct ether_header *eh;        /* for bridged packets          */
353
354         struct ipfw_flow_id f_id;       /* grabbed from IP header       */
355         uint8_t         cont;
356
357         /*
358          * Depend on the return value of ipfw_chk/ip_fw_chk_ptr
359          * 'cookie' field may save following information:
360          *
361          * IP_FW_TEE or IP_FW_DIVERT
362          *   The divert port number
363          *
364          * IP_FW_DUMMYNET
365          *   The pipe or queue number
366          */
367         uint32_t        cookie;
368 };
369
370 /*
371  * Function definitions.
372  */
373 int     ip_fw_sockopt(struct sockopt *);
374
375 /* Firewall hooks */
376 struct sockopt;
377 struct dn_flow_set;
378
379 typedef int     ip_fw_chk_t(struct ip_fw_args *);
380 typedef int     ip_fw_ctl_t(struct sockopt *);
381 typedef struct mbuf
382                 *ip_fw_dn_io_t(struct mbuf *, int, int, struct ip_fw_args *);
383
384 extern ip_fw_chk_t      *ip_fw_chk_ptr;
385 extern ip_fw_ctl_t      *ip_fw_ctl_ptr;
386 extern ip_fw_dn_io_t    *ip_fw_dn_io_ptr;
387
388 extern int fw_one_pass;
389 extern int fw_enable;
390
391 extern int ip_fw_loaded;
392 #define IPFW_LOADED     (ip_fw_loaded)
393
394 #endif /* _KERNEL */
395
396 #define ACTION_PTR(rule)        \
397         (ipfw_insn *)((uint32_t *)((rule)->cmd) + ((rule)->act_ofs))
398
399 struct ipfw_ioc_rule {
400         uint16_t        act_ofs;        /* offset of action in 32-bit units */
401         uint16_t        cmd_len;        /* # of 32-bit words in cmd     */
402         uint16_t        rulenum;        /* rule number                  */
403         uint8_t         set;            /* rule set (0..31)             */
404         uint8_t         usr_flags;      /* IPFW_USR_F_                  */
405
406         /* Rule set information */
407         uint32_t        set_disable;    /* disabled rule sets           */
408         uint32_t        static_count;   /* # of static rules            */
409         uint32_t        static_len;     /* total length of static rules */
410
411         /* Statistics */
412         uint64_t        pcnt;           /* Packet counter               */
413         uint64_t        bcnt;           /* Byte counter                 */
414         uint32_t        timestamp;      /* tv_sec of last match         */
415
416         uint8_t         reserved[16];
417
418         ipfw_insn       cmd[1];         /* storage for commands         */
419 };
420
421 #define IPFW_USR_F_NORULE       0x01
422
423 #define IPFW_RULE_SIZE_MAX      255     /* unit: uint32_t */
424
425 #define IOC_RULESIZE(rule)      \
426         (sizeof(struct ipfw_ioc_rule) + (rule)->cmd_len * 4 - 4)
427
428 struct ipfw_ioc_flowid {
429         uint16_t        type;   /* ETHERTYPE_ */
430         uint16_t        pad;
431         union {
432                 struct {
433                         uint32_t dst_ip;
434                         uint32_t src_ip;
435                         uint16_t dst_port;
436                         uint16_t src_port;
437                         uint8_t proto;
438                 } ip;
439                 uint8_t pad[64];
440         } u;
441 };
442
443 struct ipfw_ioc_state {
444         uint32_t        expire;         /* expire time                  */
445         uint64_t        pcnt;           /* packet match counter         */
446         uint64_t        bcnt;           /* byte match counter           */
447
448         uint16_t        dyn_type;       /* rule type                    */
449         uint16_t        count;          /* refcount                     */
450
451         uint16_t        rulenum;
452         uint16_t        pad;
453
454         int             cpu;            /* reserved                     */
455
456         struct ipfw_ioc_flowid id;      /* (masked) flow id             */
457         uint8_t         reserved[16];
458 };
459
460 /*
461  * Definitions for IP option names.
462  */
463 #define IP_FW_IPOPT_LSRR        0x01
464 #define IP_FW_IPOPT_SSRR        0x02
465 #define IP_FW_IPOPT_RR          0x04
466 #define IP_FW_IPOPT_TS          0x08
467
468 /*
469  * Definitions for TCP option names.
470  */
471 #define IP_FW_TCPOPT_MSS        0x01
472 #define IP_FW_TCPOPT_WINDOW     0x02
473 #define IP_FW_TCPOPT_SACK       0x04
474 #define IP_FW_TCPOPT_TS         0x08
475 #define IP_FW_TCPOPT_CC         0x10
476
477 #define ICMP_REJECT_RST         0x100   /* fake ICMP code (send a TCP RST) */
478
479 /*
480  * IP_FW_TBL_CREATE, tableid >= 0.
481  * IP_FW_TBL_FLUSH, tableid >= 0.
482  * IP_FW_TBL_FLUSH, tableid < 0, flush all tables.
483  * IP_FW_TBL_DESTROY, tableid >= 0.
484  * IP_FW_TBL_ZERO, tableid >= 0.
485  * IP_FW_TBL_ZERO, tableid < 0, zero all tables' counters.
486  */
487 struct ipfw_ioc_table {
488         int             tableid;
489 };
490
491 struct ipfw_ioc_tblent {
492         struct sockaddr_in key;
493         struct sockaddr_in netmask;
494         u_long          use;
495         time_t          last_used;
496         long            unused[2];
497 };
498
499 /*
500  * IP_FW_TBL_GET, tableid < 0, list of all tables.
501  */
502 struct ipfw_ioc_tbllist {
503         int             tableid;        /* MUST be the first field */
504         int             tablecnt;
505         uint16_t        tables[];
506 };
507
508 /*
509  * IP_FW_TBL_GET, tableid >= 0, entries in the table.
510  * IP_FW_TBL_ADD, tableid >= 0, entcnt == 1.
511  * IP_FW_TBL_DEL, tableid >= 0, entcnt == 1.
512  */
513 struct ipfw_ioc_tblcont {
514         int             tableid;        /* MUST be the first field */
515         int             entcnt;
516         struct ipfw_ioc_tblent ent[1];
517 };
518
519 /*
520  * IP_FW_TBL_EXPIRE, tableid < 0, expire all tables.
521  * IP_FW_TBL_EXPIRE, tableid >= 0.
522  */
523 struct ipfw_ioc_tblexp {
524         int             tableid;
525         int             expcnt;
526         time_t          expire;
527         u_long          unused1[2];
528 };
529
530 #endif /* _IPFW2_H */