FreeBSD/Linux Kernel Cross Reference
sys/netinet/ip_fw.h
1 /*-
2 * Copyright (c) 2002-2009 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: releng/8.3/sys/netinet/ip_fw.h 230575 2012-01-26 10:33:19Z ae $
26 */
27
28 #ifndef _IPFW2_H
29 #define _IPFW2_H
30
31 /*
32 * The default rule number. By the design of ip_fw, the default rule
33 * is the last one, so its number can also serve as the highest number
34 * allowed for a rule. The ip_fw code relies on both meanings of this
35 * constant.
36 */
37 #define IPFW_DEFAULT_RULE 65535
38
39 /*
40 * The number of ipfw tables. The maximum allowed table number is the
41 * (IPFW_TABLES_MAX - 1).
42 */
43 #define IPFW_TABLES_MAX 128
44
45 /*
46 * Most commands (queue, pipe, tag, untag, limit...) can have a 16-bit
47 * argument between 1 and 65534. The value 0 is unused, the value
48 * 65535 (IP_FW_TABLEARG) is used to represent 'tablearg', i.e. the
49 * can be 1..65534, or 65535 to indicate the use of a 'tablearg'
50 * result of the most recent table() lookup.
51 * Note that 16bit is only a historical limit, resulting from
52 * the use of a 16-bit fields for that value. In reality, we can have
53 * 2^32 pipes, queues, tag values and so on, and use 0 as a tablearg.
54 */
55 #define IPFW_ARG_MIN 1
56 #define IPFW_ARG_MAX 65534
57 #define IP_FW_TABLEARG 65535 /* XXX should use 0 */
58
59 /*
60 * Number of entries in the call stack of the call/return commands.
61 * Call stack currently is an uint16_t array with rule numbers.
62 */
63 #define IPFW_CALLSTACK_SIZE 16
64
65 /*
66 * The kernel representation of ipfw rules is made of a list of
67 * 'instructions' (for all practical purposes equivalent to BPF
68 * instructions), which specify which fields of the packet
69 * (or its metadata) should be analysed.
70 *
71 * Each instruction is stored in a structure which begins with
72 * "ipfw_insn", and can contain extra fields depending on the
73 * instruction type (listed below).
74 * Note that the code is written so that individual instructions
75 * have a size which is a multiple of 32 bits. This means that, if
76 * such structures contain pointers or other 64-bit entities,
77 * (there is just one instance now) they may end up unaligned on
78 * 64-bit architectures, so the must be handled with care.
79 *
80 * "enum ipfw_opcodes" are the opcodes supported. We can have up
81 * to 256 different opcodes. When adding new opcodes, they should
82 * be appended to the end of the opcode list before O_LAST_OPCODE,
83 * this will prevent the ABI from being broken, otherwise users
84 * will have to recompile ipfw(8) when they update the kernel.
85 */
86
87 enum ipfw_opcodes { /* arguments (4 byte each) */
88 O_NOP,
89
90 O_IP_SRC, /* u32 = IP */
91 O_IP_SRC_MASK, /* ip = IP/mask */
92 O_IP_SRC_ME, /* none */
93 O_IP_SRC_SET, /* u32=base, arg1=len, bitmap */
94
95 O_IP_DST, /* u32 = IP */
96 O_IP_DST_MASK, /* ip = IP/mask */
97 O_IP_DST_ME, /* none */
98 O_IP_DST_SET, /* u32=base, arg1=len, bitmap */
99
100 O_IP_SRCPORT, /* (n)port list:mask 4 byte ea */
101 O_IP_DSTPORT, /* (n)port list:mask 4 byte ea */
102 O_PROTO, /* arg1=protocol */
103
104 O_MACADDR2, /* 2 mac addr:mask */
105 O_MAC_TYPE, /* same as srcport */
106
107 O_LAYER2, /* none */
108 O_IN, /* none */
109 O_FRAG, /* none */
110
111 O_RECV, /* none */
112 O_XMIT, /* none */
113 O_VIA, /* none */
114
115 O_IPOPT, /* arg1 = 2*u8 bitmap */
116 O_IPLEN, /* arg1 = len */
117 O_IPID, /* arg1 = id */
118
119 O_IPTOS, /* arg1 = id */
120 O_IPPRECEDENCE, /* arg1 = precedence << 5 */
121 O_IPTTL, /* arg1 = TTL */
122
123 O_IPVER, /* arg1 = version */
124 O_UID, /* u32 = id */
125 O_GID, /* u32 = id */
126 O_ESTAB, /* none (tcp established) */
127 O_TCPFLAGS, /* arg1 = 2*u8 bitmap */
128 O_TCPWIN, /* arg1 = desired win */
129 O_TCPSEQ, /* u32 = desired seq. */
130 O_TCPACK, /* u32 = desired seq. */
131 O_ICMPTYPE, /* u32 = icmp bitmap */
132 O_TCPOPTS, /* arg1 = 2*u8 bitmap */
133
134 O_VERREVPATH, /* none */
135 O_VERSRCREACH, /* none */
136
137 O_PROBE_STATE, /* none */
138 O_KEEP_STATE, /* none */
139 O_LIMIT, /* ipfw_insn_limit */
140 O_LIMIT_PARENT, /* dyn_type, not an opcode. */
141
142 /*
143 * These are really 'actions'.
144 */
145
146 O_LOG, /* ipfw_insn_log */
147 O_PROB, /* u32 = match probability */
148
149 O_CHECK_STATE, /* none */
150 O_ACCEPT, /* none */
151 O_DENY, /* none */
152 O_REJECT, /* arg1=icmp arg (same as deny) */
153 O_COUNT, /* none */
154 O_SKIPTO, /* arg1=next rule number */
155 O_PIPE, /* arg1=pipe number */
156 O_QUEUE, /* arg1=queue number */
157 O_DIVERT, /* arg1=port number */
158 O_TEE, /* arg1=port number */
159 O_FORWARD_IP, /* fwd sockaddr */
160 O_FORWARD_MAC, /* fwd mac */
161 O_NAT, /* nope */
162 O_REASS, /* none */
163
164 /*
165 * More opcodes.
166 */
167 O_IPSEC, /* has ipsec history */
168 O_IP_SRC_LOOKUP, /* arg1=table number, u32=value */
169 O_IP_DST_LOOKUP, /* arg1=table number, u32=value */
170 O_ANTISPOOF, /* none */
171 O_JAIL, /* u32 = id */
172 O_ALTQ, /* u32 = altq classif. qid */
173 O_DIVERTED, /* arg1=bitmap (1:loop, 2:out) */
174 O_TCPDATALEN, /* arg1 = tcp data len */
175 O_IP6_SRC, /* address without mask */
176 O_IP6_SRC_ME, /* my addresses */
177 O_IP6_SRC_MASK, /* address with the mask */
178 O_IP6_DST,
179 O_IP6_DST_ME,
180 O_IP6_DST_MASK,
181 O_FLOW6ID, /* for flow id tag in the ipv6 pkt */
182 O_ICMP6TYPE, /* icmp6 packet type filtering */
183 O_EXT_HDR, /* filtering for ipv6 extension header */
184 O_IP6,
185
186 /*
187 * actions for ng_ipfw
188 */
189 O_NETGRAPH, /* send to ng_ipfw */
190 O_NGTEE, /* copy to ng_ipfw */
191
192 O_IP4,
193
194 O_UNREACH6, /* arg1=icmpv6 code arg (deny) */
195
196 O_TAG, /* arg1=tag number */
197 O_TAGGED, /* arg1=tag number */
198
199 O_SETFIB, /* arg1=FIB number */
200 O_FIB, /* arg1=FIB desired fib number */
201
202 O_CALLRETURN, /* arg1=called rule number */
203
204 O_LAST_OPCODE /* not an opcode! */
205 };
206
207 /*
208 * The extension header are filtered only for presence using a bit
209 * vector with a flag for each header.
210 */
211 #define EXT_FRAGMENT 0x1
212 #define EXT_HOPOPTS 0x2
213 #define EXT_ROUTING 0x4
214 #define EXT_AH 0x8
215 #define EXT_ESP 0x10
216 #define EXT_DSTOPTS 0x20
217 #define EXT_RTHDR0 0x40
218 #define EXT_RTHDR2 0x80
219
220 /*
221 * Template for instructions.
222 *
223 * ipfw_insn is used for all instructions which require no operands,
224 * a single 16-bit value (arg1), or a couple of 8-bit values.
225 *
226 * For other instructions which require different/larger arguments
227 * we have derived structures, ipfw_insn_*.
228 *
229 * The size of the instruction (in 32-bit words) is in the low
230 * 6 bits of "len". The 2 remaining bits are used to implement
231 * NOT and OR on individual instructions. Given a type, you can
232 * compute the length to be put in "len" using F_INSN_SIZE(t)
233 *
234 * F_NOT negates the match result of the instruction.
235 *
236 * F_OR is used to build or blocks. By default, instructions
237 * are evaluated as part of a logical AND. An "or" block
238 * { X or Y or Z } contains F_OR set in all but the last
239 * instruction of the block. A match will cause the code
240 * to skip past the last instruction of the block.
241 *
242 * NOTA BENE: in a couple of places we assume that
243 * sizeof(ipfw_insn) == sizeof(u_int32_t)
244 * this needs to be fixed.
245 *
246 */
247 typedef struct _ipfw_insn { /* template for instructions */
248 u_int8_t opcode;
249 u_int8_t len; /* number of 32-bit words */
250 #define F_NOT 0x80
251 #define F_OR 0x40
252 #define F_LEN_MASK 0x3f
253 #define F_LEN(cmd) ((cmd)->len & F_LEN_MASK)
254
255 u_int16_t arg1;
256 } ipfw_insn;
257
258 /*
259 * The F_INSN_SIZE(type) computes the size, in 4-byte words, of
260 * a given type.
261 */
262 #define F_INSN_SIZE(t) ((sizeof (t))/sizeof(u_int32_t))
263
264 /*
265 * This is used to store an array of 16-bit entries (ports etc.)
266 */
267 typedef struct _ipfw_insn_u16 {
268 ipfw_insn o;
269 u_int16_t ports[2]; /* there may be more */
270 } ipfw_insn_u16;
271
272 /*
273 * This is used to store an array of 32-bit entries
274 * (uid, single IPv4 addresses etc.)
275 */
276 typedef struct _ipfw_insn_u32 {
277 ipfw_insn o;
278 u_int32_t d[1]; /* one or more */
279 } ipfw_insn_u32;
280
281 /*
282 * This is used to store IP addr-mask pairs.
283 */
284 typedef struct _ipfw_insn_ip {
285 ipfw_insn o;
286 struct in_addr addr;
287 struct in_addr mask;
288 } ipfw_insn_ip;
289
290 /*
291 * This is used to forward to a given address (ip).
292 */
293 typedef struct _ipfw_insn_sa {
294 ipfw_insn o;
295 struct sockaddr_in sa;
296 } ipfw_insn_sa;
297
298 /*
299 * This is used for MAC addr-mask pairs.
300 */
301 typedef struct _ipfw_insn_mac {
302 ipfw_insn o;
303 u_char addr[12]; /* dst[6] + src[6] */
304 u_char mask[12]; /* dst[6] + src[6] */
305 } ipfw_insn_mac;
306
307 /*
308 * This is used for interface match rules (recv xx, xmit xx).
309 */
310 typedef struct _ipfw_insn_if {
311 ipfw_insn o;
312 union {
313 struct in_addr ip;
314 int glob;
315 } p;
316 char name[IFNAMSIZ];
317 } ipfw_insn_if;
318
319 /*
320 * This is used for storing an altq queue id number.
321 */
322 typedef struct _ipfw_insn_altq {
323 ipfw_insn o;
324 u_int32_t qid;
325 } ipfw_insn_altq;
326
327 /*
328 * This is used for limit rules.
329 */
330 typedef struct _ipfw_insn_limit {
331 ipfw_insn o;
332 u_int8_t _pad;
333 u_int8_t limit_mask; /* combination of DYN_* below */
334 #define DYN_SRC_ADDR 0x1
335 #define DYN_SRC_PORT 0x2
336 #define DYN_DST_ADDR 0x4
337 #define DYN_DST_PORT 0x8
338
339 u_int16_t conn_limit;
340 } ipfw_insn_limit;
341
342 /*
343 * This is used for log instructions.
344 */
345 typedef struct _ipfw_insn_log {
346 ipfw_insn o;
347 u_int32_t max_log; /* how many do we log -- 0 = all */
348 u_int32_t log_left; /* how many left to log */
349 } ipfw_insn_log;
350
351 /*
352 * Data structures required by both ipfw(8) and ipfw(4) but not part of the
353 * management API are protected by IPFW_INTERNAL.
354 */
355 #ifdef IPFW_INTERNAL
356 /* Server pool support (LSNAT). */
357 struct cfg_spool {
358 LIST_ENTRY(cfg_spool) _next; /* chain of spool instances */
359 struct in_addr addr;
360 u_short port;
361 };
362 #endif
363
364 /* Redirect modes id. */
365 #define REDIR_ADDR 0x01
366 #define REDIR_PORT 0x02
367 #define REDIR_PROTO 0x04
368
369 #ifdef IPFW_INTERNAL
370 /* Nat redirect configuration. */
371 struct cfg_redir {
372 LIST_ENTRY(cfg_redir) _next; /* chain of redir instances */
373 u_int16_t mode; /* type of redirect mode */
374 struct in_addr laddr; /* local ip address */
375 struct in_addr paddr; /* public ip address */
376 struct in_addr raddr; /* remote ip address */
377 u_short lport; /* local port */
378 u_short pport; /* public port */
379 u_short rport; /* remote port */
380 u_short pport_cnt; /* number of public ports */
381 u_short rport_cnt; /* number of remote ports */
382 int proto; /* protocol: tcp/udp */
383 struct alias_link **alink;
384 /* num of entry in spool chain */
385 u_int16_t spool_cnt;
386 /* chain of spool instances */
387 LIST_HEAD(spool_chain, cfg_spool) spool_chain;
388 };
389 #endif
390
391 #ifdef IPFW_INTERNAL
392 /* Nat configuration data struct. */
393 struct cfg_nat {
394 /* chain of nat instances */
395 LIST_ENTRY(cfg_nat) _next;
396 int id; /* nat id */
397 struct in_addr ip; /* nat ip address */
398 char if_name[IF_NAMESIZE]; /* interface name */
399 int mode; /* aliasing mode */
400 struct libalias *lib; /* libalias instance */
401 /* number of entry in spool chain */
402 int redir_cnt;
403 /* chain of redir instances */
404 LIST_HEAD(redir_chain, cfg_redir) redir_chain;
405 };
406 #endif
407
408 #define SOF_NAT sizeof(struct cfg_nat)
409 #define SOF_REDIR sizeof(struct cfg_redir)
410 #define SOF_SPOOL sizeof(struct cfg_spool)
411
412 /* Nat command. */
413 typedef struct _ipfw_insn_nat {
414 ipfw_insn o;
415 struct cfg_nat *nat;
416 } ipfw_insn_nat;
417
418 /* Apply ipv6 mask on ipv6 addr */
419 #define APPLY_MASK(addr,mask) \
420 (addr)->__u6_addr.__u6_addr32[0] &= (mask)->__u6_addr.__u6_addr32[0]; \
421 (addr)->__u6_addr.__u6_addr32[1] &= (mask)->__u6_addr.__u6_addr32[1]; \
422 (addr)->__u6_addr.__u6_addr32[2] &= (mask)->__u6_addr.__u6_addr32[2]; \
423 (addr)->__u6_addr.__u6_addr32[3] &= (mask)->__u6_addr.__u6_addr32[3];
424
425 /* Structure for ipv6 */
426 typedef struct _ipfw_insn_ip6 {
427 ipfw_insn o;
428 struct in6_addr addr6;
429 struct in6_addr mask6;
430 } ipfw_insn_ip6;
431
432 /* Used to support icmp6 types */
433 typedef struct _ipfw_insn_icmp6 {
434 ipfw_insn o;
435 uint32_t d[7]; /* XXX This number si related to the netinet/icmp6.h
436 * define ICMP6_MAXTYPE
437 * as follows: n = ICMP6_MAXTYPE/32 + 1
438 * Actually is 203
439 */
440 } ipfw_insn_icmp6;
441
442 /*
443 * Here we have the structure representing an ipfw rule.
444 *
445 * It starts with a general area (with link fields and counters)
446 * followed by an array of one or more instructions, which the code
447 * accesses as an array of 32-bit values.
448 *
449 * Given a rule pointer r:
450 *
451 * r->cmd is the start of the first instruction.
452 * ACTION_PTR(r) is the start of the first action (things to do
453 * once a rule matched).
454 *
455 * When assembling instruction, remember the following:
456 *
457 * + if a rule has a "keep-state" (or "limit") option, then the
458 * first instruction (at r->cmd) MUST BE an O_PROBE_STATE
459 * + if a rule has a "log" option, then the first action
460 * (at ACTION_PTR(r)) MUST be O_LOG
461 * + if a rule has an "altq" option, it comes after "log"
462 * + if a rule has an O_TAG option, it comes after "log" and "altq"
463 *
464 * NOTE: we use a simple linked list of rules because we never need
465 * to delete a rule without scanning the list. We do not use
466 * queue(3) macros for portability and readability.
467 */
468
469 struct ip_fw {
470 struct ip_fw *x_next; /* linked list of rules */
471 struct ip_fw *next_rule; /* ptr to next [skipto] rule */
472 /* 'next_rule' is used to pass up 'set_disable' status */
473
474 uint16_t act_ofs; /* offset of action in 32-bit units */
475 uint16_t cmd_len; /* # of 32-bit words in cmd */
476 uint16_t rulenum; /* rule number */
477 uint8_t set; /* rule set (0..31) */
478 #define RESVD_SET 31 /* set for default and persistent rules */
479 uint8_t _pad; /* padding */
480 uint32_t id; /* rule id */
481
482 /* These fields are present in all rules. */
483 uint64_t pcnt; /* Packet counter */
484 uint64_t bcnt; /* Byte counter */
485 uint32_t timestamp; /* tv_sec of last match */
486
487 ipfw_insn cmd[1]; /* storage for commands */
488 };
489
490 #define ACTION_PTR(rule) \
491 (ipfw_insn *)( (u_int32_t *)((rule)->cmd) + ((rule)->act_ofs) )
492
493 #define RULESIZE(rule) (sizeof(struct ip_fw) + \
494 ((struct ip_fw *)(rule))->cmd_len * 4 - 4)
495
496 #if 1 // should be moved to in.h
497 /*
498 * This structure is used as a flow mask and a flow id for various
499 * parts of the code.
500 * addr_type is used in userland and kernel to mark the address type.
501 * fib is used in the kernel to record the fib in use.
502 * _flags is used in the kernel to store tcp flags for dynamic rules.
503 */
504 struct ipfw_flow_id {
505 uint32_t dst_ip;
506 uint32_t src_ip;
507 uint16_t dst_port;
508 uint16_t src_port;
509 uint8_t fib;
510 uint8_t proto;
511 uint8_t _flags; /* protocol-specific flags */
512 uint8_t addr_type; /* 4=ip4, 6=ip6, 1=ether ? */
513 struct in6_addr dst_ip6;
514 struct in6_addr src_ip6;
515 uint32_t flow_id6;
516 uint32_t extra; /* queue/pipe or frag_id */
517 };
518 #endif
519
520 #define IS_IP6_FLOW_ID(id) ((id)->addr_type == 6)
521
522 /*
523 * Dynamic ipfw rule.
524 */
525 typedef struct _ipfw_dyn_rule ipfw_dyn_rule;
526
527 struct _ipfw_dyn_rule {
528 ipfw_dyn_rule *next; /* linked list of rules. */
529 struct ip_fw *rule; /* pointer to rule */
530 /* 'rule' is used to pass up the rule number (from the parent) */
531
532 ipfw_dyn_rule *parent; /* pointer to parent rule */
533 u_int64_t pcnt; /* packet match counter */
534 u_int64_t bcnt; /* byte match counter */
535 struct ipfw_flow_id id; /* (masked) flow id */
536 u_int32_t expire; /* expire time */
537 u_int32_t bucket; /* which bucket in hash table */
538 u_int32_t state; /* state of this rule (typically a
539 * combination of TCP flags)
540 */
541 u_int32_t ack_fwd; /* most recent ACKs in forward */
542 u_int32_t ack_rev; /* and reverse directions (used */
543 /* to generate keepalives) */
544 u_int16_t dyn_type; /* rule type */
545 u_int16_t count; /* refcount */
546 };
547
548 /*
549 * Definitions for IP option names.
550 */
551 #define IP_FW_IPOPT_LSRR 0x01
552 #define IP_FW_IPOPT_SSRR 0x02
553 #define IP_FW_IPOPT_RR 0x04
554 #define IP_FW_IPOPT_TS 0x08
555
556 /*
557 * Definitions for TCP option names.
558 */
559 #define IP_FW_TCPOPT_MSS 0x01
560 #define IP_FW_TCPOPT_WINDOW 0x02
561 #define IP_FW_TCPOPT_SACK 0x04
562 #define IP_FW_TCPOPT_TS 0x08
563 #define IP_FW_TCPOPT_CC 0x10
564
565 #define ICMP_REJECT_RST 0x100 /* fake ICMP code (send a TCP RST) */
566 #define ICMP6_UNREACH_RST 0x100 /* fake ICMPv6 code (send a TCP RST) */
567
568 /*
569 * These are used for lookup tables.
570 */
571 typedef struct _ipfw_table_entry {
572 in_addr_t addr; /* network address */
573 u_int32_t value; /* value */
574 u_int16_t tbl; /* table number */
575 u_int8_t masklen; /* mask length */
576 } ipfw_table_entry;
577
578 typedef struct _ipfw_table {
579 u_int32_t size; /* size of entries in bytes */
580 u_int32_t cnt; /* # of entries */
581 u_int16_t tbl; /* table number */
582 ipfw_table_entry ent[0]; /* entries */
583 } ipfw_table;
584
585 #endif /* _IPFW2_H */
Cache object: cac13f7f50f06db1e73e8ec13db18fbe
|