2 * Copyright (c) 2002-2009 Luigi Rizzo, Universita` di Pisa
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
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.
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
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
37 #define IPFW_DEFAULT_RULE 65535
40 * The number of ipfw tables. The maximum allowed table number is the
41 * (IPFW_TABLES_MAX - 1).
43 #define IPFW_TABLES_MAX 128
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.
55 #define IPFW_ARG_MIN 1
56 #define IPFW_ARG_MAX 65534
57 #define IP_FW_TABLEARG 65535 /* XXX should use 0 */
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.
63 #define IPFW_CALLSTACK_SIZE 16
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.
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.
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.
87 enum ipfw_opcodes { /* arguments (4 byte each) */
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 */
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 */
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 */
104 O_MACADDR2, /* 2 mac addr:mask */
105 O_MAC_TYPE, /* same as srcport */
115 O_IPOPT, /* arg1 = 2*u8 bitmap */
116 O_IPLEN, /* arg1 = len */
117 O_IPID, /* arg1 = id */
119 O_IPTOS, /* arg1 = id */
120 O_IPPRECEDENCE, /* arg1 = precedence << 5 */
121 O_IPTTL, /* arg1 = TTL */
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 */
134 O_VERREVPATH, /* none */
135 O_VERSRCREACH, /* none */
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. */
143 * These are really 'actions'.
146 O_LOG, /* ipfw_insn_log */
147 O_PROB, /* u32 = match probability */
149 O_CHECK_STATE, /* none */
152 O_REJECT, /* arg1=icmp arg (same as deny) */
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 */
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 */
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 */
187 * actions for ng_ipfw
189 O_NETGRAPH, /* send to ng_ipfw */
190 O_NGTEE, /* copy to ng_ipfw */
194 O_UNREACH6, /* arg1=icmpv6 code arg (deny) */
196 O_TAG, /* arg1=tag number */
197 O_TAGGED, /* arg1=tag number */
199 O_SETFIB, /* arg1=FIB number */
200 O_FIB, /* arg1=FIB desired fib number */
202 O_SOCKARG, /* socket argument */
204 O_CALLRETURN, /* arg1=called rule number */
206 O_LAST_OPCODE /* not an opcode! */
211 * The extension header are filtered only for presence using a bit
212 * vector with a flag for each header.
214 #define EXT_FRAGMENT 0x1
215 #define EXT_HOPOPTS 0x2
216 #define EXT_ROUTING 0x4
219 #define EXT_DSTOPTS 0x20
220 #define EXT_RTHDR0 0x40
221 #define EXT_RTHDR2 0x80
224 * Template for instructions.
226 * ipfw_insn is used for all instructions which require no operands,
227 * a single 16-bit value (arg1), or a couple of 8-bit values.
229 * For other instructions which require different/larger arguments
230 * we have derived structures, ipfw_insn_*.
232 * The size of the instruction (in 32-bit words) is in the low
233 * 6 bits of "len". The 2 remaining bits are used to implement
234 * NOT and OR on individual instructions. Given a type, you can
235 * compute the length to be put in "len" using F_INSN_SIZE(t)
237 * F_NOT negates the match result of the instruction.
239 * F_OR is used to build or blocks. By default, instructions
240 * are evaluated as part of a logical AND. An "or" block
241 * { X or Y or Z } contains F_OR set in all but the last
242 * instruction of the block. A match will cause the code
243 * to skip past the last instruction of the block.
245 * NOTA BENE: in a couple of places we assume that
246 * sizeof(ipfw_insn) == sizeof(u_int32_t)
247 * this needs to be fixed.
250 typedef struct _ipfw_insn { /* template for instructions */
252 u_int8_t len; /* number of 32-bit words */
255 #define F_LEN_MASK 0x3f
256 #define F_LEN(cmd) ((cmd)->len & F_LEN_MASK)
262 * The F_INSN_SIZE(type) computes the size, in 4-byte words, of
265 #define F_INSN_SIZE(t) ((sizeof (t))/sizeof(u_int32_t))
268 * This is used to store an array of 16-bit entries (ports etc.)
270 typedef struct _ipfw_insn_u16 {
272 u_int16_t ports[2]; /* there may be more */
276 * This is used to store an array of 32-bit entries
277 * (uid, single IPv4 addresses etc.)
279 typedef struct _ipfw_insn_u32 {
281 u_int32_t d[1]; /* one or more */
285 * This is used to store IP addr-mask pairs.
287 typedef struct _ipfw_insn_ip {
294 * This is used to forward to a given address (ip).
296 typedef struct _ipfw_insn_sa {
298 struct sockaddr_in sa;
302 * This is used for MAC addr-mask pairs.
304 typedef struct _ipfw_insn_mac {
306 u_char addr[12]; /* dst[6] + src[6] */
307 u_char mask[12]; /* dst[6] + src[6] */
311 * This is used for interface match rules (recv xx, xmit xx).
313 typedef struct _ipfw_insn_if {
323 * This is used for storing an altq queue id number.
325 typedef struct _ipfw_insn_altq {
331 * This is used for limit rules.
333 typedef struct _ipfw_insn_limit {
336 u_int8_t limit_mask; /* combination of DYN_* below */
337 #define DYN_SRC_ADDR 0x1
338 #define DYN_SRC_PORT 0x2
339 #define DYN_DST_ADDR 0x4
340 #define DYN_DST_PORT 0x8
342 u_int16_t conn_limit;
346 * This is used for log instructions.
348 typedef struct _ipfw_insn_log {
350 u_int32_t max_log; /* how many do we log -- 0 = all */
351 u_int32_t log_left; /* how many left to log */
355 * Data structures required by both ipfw(8) and ipfw(4) but not part of the
356 * management API are protected by IPFW_INTERNAL.
359 /* Server pool support (LSNAT). */
361 LIST_ENTRY(cfg_spool) _next; /* chain of spool instances */
367 /* Redirect modes id. */
368 #define REDIR_ADDR 0x01
369 #define REDIR_PORT 0x02
370 #define REDIR_PROTO 0x04
373 /* Nat redirect configuration. */
375 LIST_ENTRY(cfg_redir) _next; /* chain of redir instances */
376 u_int16_t mode; /* type of redirect mode */
377 struct in_addr laddr; /* local ip address */
378 struct in_addr paddr; /* public ip address */
379 struct in_addr raddr; /* remote ip address */
380 u_short lport; /* local port */
381 u_short pport; /* public port */
382 u_short rport; /* remote port */
383 u_short pport_cnt; /* number of public ports */
384 u_short rport_cnt; /* number of remote ports */
385 int proto; /* protocol: tcp/udp */
386 struct alias_link **alink;
387 /* num of entry in spool chain */
389 /* chain of spool instances */
390 LIST_HEAD(spool_chain, cfg_spool) spool_chain;
395 /* Nat configuration data struct. */
397 /* chain of nat instances */
398 LIST_ENTRY(cfg_nat) _next;
400 struct in_addr ip; /* nat ip address */
401 char if_name[IF_NAMESIZE]; /* interface name */
402 int mode; /* aliasing mode */
403 struct libalias *lib; /* libalias instance */
404 /* number of entry in spool chain */
406 /* chain of redir instances */
407 LIST_HEAD(redir_chain, cfg_redir) redir_chain;
411 #define SOF_NAT sizeof(struct cfg_nat)
412 #define SOF_REDIR sizeof(struct cfg_redir)
413 #define SOF_SPOOL sizeof(struct cfg_spool)
416 typedef struct _ipfw_insn_nat {
421 /* Apply ipv6 mask on ipv6 addr */
422 #define APPLY_MASK(addr,mask) \
423 (addr)->__u6_addr.__u6_addr32[0] &= (mask)->__u6_addr.__u6_addr32[0]; \
424 (addr)->__u6_addr.__u6_addr32[1] &= (mask)->__u6_addr.__u6_addr32[1]; \
425 (addr)->__u6_addr.__u6_addr32[2] &= (mask)->__u6_addr.__u6_addr32[2]; \
426 (addr)->__u6_addr.__u6_addr32[3] &= (mask)->__u6_addr.__u6_addr32[3];
428 /* Structure for ipv6 */
429 typedef struct _ipfw_insn_ip6 {
431 struct in6_addr addr6;
432 struct in6_addr mask6;
435 /* Used to support icmp6 types */
436 typedef struct _ipfw_insn_icmp6 {
438 uint32_t d[7]; /* XXX This number si related to the netinet/icmp6.h
439 * define ICMP6_MAXTYPE
440 * as follows: n = ICMP6_MAXTYPE/32 + 1
446 * Here we have the structure representing an ipfw rule.
448 * It starts with a general area (with link fields and counters)
449 * followed by an array of one or more instructions, which the code
450 * accesses as an array of 32-bit values.
452 * Given a rule pointer r:
454 * r->cmd is the start of the first instruction.
455 * ACTION_PTR(r) is the start of the first action (things to do
456 * once a rule matched).
458 * When assembling instruction, remember the following:
460 * + if a rule has a "keep-state" (or "limit") option, then the
461 * first instruction (at r->cmd) MUST BE an O_PROBE_STATE
462 * + if a rule has a "log" option, then the first action
463 * (at ACTION_PTR(r)) MUST be O_LOG
464 * + if a rule has an "altq" option, it comes after "log"
465 * + if a rule has an O_TAG option, it comes after "log" and "altq"
467 * NOTE: we use a simple linked list of rules because we never need
468 * to delete a rule without scanning the list. We do not use
469 * queue(3) macros for portability and readability.
473 struct ip_fw *x_next; /* linked list of rules */
474 struct ip_fw *next_rule; /* ptr to next [skipto] rule */
475 /* 'next_rule' is used to pass up 'set_disable' status */
477 uint16_t act_ofs; /* offset of action in 32-bit units */
478 uint16_t cmd_len; /* # of 32-bit words in cmd */
479 uint16_t rulenum; /* rule number */
480 uint8_t set; /* rule set (0..31) */
481 #define RESVD_SET 31 /* set for default and persistent rules */
482 uint8_t _pad; /* padding */
483 uint32_t id; /* rule id */
485 /* These fields are present in all rules. */
486 uint64_t pcnt; /* Packet counter */
487 uint64_t bcnt; /* Byte counter */
488 uint32_t timestamp; /* tv_sec of last match */
490 ipfw_insn cmd[1]; /* storage for commands */
493 #define ACTION_PTR(rule) \
494 (ipfw_insn *)( (u_int32_t *)((rule)->cmd) + ((rule)->act_ofs) )
496 #define RULESIZE(rule) (sizeof(struct ip_fw) + \
497 ((struct ip_fw *)(rule))->cmd_len * 4 - 4)
499 #if 1 // should be moved to in.h
501 * This structure is used as a flow mask and a flow id for various
503 * addr_type is used in userland and kernel to mark the address type.
504 * fib is used in the kernel to record the fib in use.
505 * _flags is used in the kernel to store tcp flags for dynamic rules.
507 struct ipfw_flow_id {
514 uint8_t _flags; /* protocol-specific flags */
515 uint8_t addr_type; /* 4=ip4, 6=ip6, 1=ether ? */
516 struct in6_addr dst_ip6;
517 struct in6_addr src_ip6;
519 uint32_t extra; /* queue/pipe or frag_id */
523 #define IS_IP6_FLOW_ID(id) ((id)->addr_type == 6)
528 typedef struct _ipfw_dyn_rule ipfw_dyn_rule;
530 struct _ipfw_dyn_rule {
531 ipfw_dyn_rule *next; /* linked list of rules. */
532 struct ip_fw *rule; /* pointer to rule */
533 /* 'rule' is used to pass up the rule number (from the parent) */
535 ipfw_dyn_rule *parent; /* pointer to parent rule */
536 u_int64_t pcnt; /* packet match counter */
537 u_int64_t bcnt; /* byte match counter */
538 struct ipfw_flow_id id; /* (masked) flow id */
539 u_int32_t expire; /* expire time */
540 u_int32_t bucket; /* which bucket in hash table */
541 u_int32_t state; /* state of this rule (typically a
542 * combination of TCP flags)
544 u_int32_t ack_fwd; /* most recent ACKs in forward */
545 u_int32_t ack_rev; /* and reverse directions (used */
546 /* to generate keepalives) */
547 u_int16_t dyn_type; /* rule type */
548 u_int16_t count; /* refcount */
552 * Definitions for IP option names.
554 #define IP_FW_IPOPT_LSRR 0x01
555 #define IP_FW_IPOPT_SSRR 0x02
556 #define IP_FW_IPOPT_RR 0x04
557 #define IP_FW_IPOPT_TS 0x08
560 * Definitions for TCP option names.
562 #define IP_FW_TCPOPT_MSS 0x01
563 #define IP_FW_TCPOPT_WINDOW 0x02
564 #define IP_FW_TCPOPT_SACK 0x04
565 #define IP_FW_TCPOPT_TS 0x08
566 #define IP_FW_TCPOPT_CC 0x10
568 #define ICMP_REJECT_RST 0x100 /* fake ICMP code (send a TCP RST) */
569 #define ICMP6_UNREACH_RST 0x100 /* fake ICMPv6 code (send a TCP RST) */
572 * These are used for lookup tables.
574 typedef struct _ipfw_table_entry {
575 in_addr_t addr; /* network address */
576 u_int32_t value; /* value */
577 u_int16_t tbl; /* table number */
578 u_int8_t masklen; /* mask length */
581 typedef struct _ipfw_table {
582 u_int32_t size; /* size of entries in bytes */
583 u_int32_t cnt; /* # of entries */
584 u_int16_t tbl; /* table number */
585 ipfw_table_entry ent[0]; /* entries */
588 #endif /* _IPFW2_H */