2 * Copyright (c) 2002 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
25 * $FreeBSD: src/sys/netinet/ip_fw2.h,v 1.1.2.2 2002/08/16 11:03:11 luigi Exp $
32 #include <net/netisr2.h>
36 * The kernel representation of ipfw rules is made of a list of
37 * 'instructions' (for all practical purposes equivalent to BPF
38 * instructions), which specify which fields of the packet
39 * (or its metatada) should be analysed.
41 * Each instruction is stored in a structure which begins with
42 * "ipfw_insn", and can contain extra fields depending on the
43 * instruction type (listed below).
45 * "enum ipfw_opcodes" are the opcodes supported. We can have up
46 * to 256 different opcodes.
49 enum ipfw_opcodes { /* arguments (4 byte each) */
52 O_IP_SRC, /* u32 = IP */
53 O_IP_SRC_MASK, /* ip = IP/mask */
54 O_IP_SRC_ME, /* none */
55 O_IP_SRC_SET, /* u32=base, arg1=len, bitmap */
57 O_IP_DST, /* u32 = IP */
58 O_IP_DST_MASK, /* ip = IP/mask */
59 O_IP_DST_ME, /* none */
60 O_IP_DST_SET, /* u32=base, arg1=len, bitmap */
62 O_IP_SRCPORT, /* (n)port list:mask 4 byte ea */
63 O_IP_DSTPORT, /* (n)port list:mask 4 byte ea */
64 O_PROTO, /* arg1=protocol */
66 O_MACADDR2, /* 2 mac addr:mask */
67 O_MAC_TYPE, /* same as srcport */
77 O_IPOPT, /* arg1 = 2*u8 bitmap */
78 O_IPLEN, /* arg1 = len */
79 O_IPID, /* arg1 = id */
81 O_IPTOS, /* arg1 = id */
82 O_IPPRECEDENCE, /* arg1 = precedence << 5 */
83 O_IPTTL, /* arg1 = TTL */
85 O_IPVER, /* arg1 = version */
88 O_ESTAB, /* none (tcp established) */
89 O_TCPFLAGS, /* arg1 = 2*u8 bitmap */
90 O_TCPWIN, /* arg1 = desired win */
91 O_TCPSEQ, /* u32 = desired seq. */
92 O_TCPACK, /* u32 = desired seq. */
93 O_ICMPTYPE, /* u32 = icmp bitmap */
94 O_TCPOPTS, /* arg1 = 2*u8 bitmap */
96 O_PROBE_STATE, /* none */
97 O_KEEP_STATE, /* none */
98 O_LIMIT, /* ipfw_insn_limit */
99 O_LIMIT_PARENT, /* dyn_type, not an opcode. */
101 * these are really 'actions', and must be last in the list.
104 O_LOG, /* ipfw_insn_log */
105 O_PROB, /* u32 = match probability */
107 O_CHECK_STATE, /* none */
110 O_REJECT, /* arg1=icmp arg (same as deny) */
112 O_SKIPTO, /* arg1=next rule number */
113 O_PIPE, /* arg1=pipe number */
114 O_QUEUE, /* arg1=queue number */
115 O_DIVERT, /* arg1=port number */
116 O_TEE, /* arg1=port number */
117 O_FORWARD_IP, /* fwd sockaddr */
118 O_FORWARD_MAC, /* fwd mac */
119 O_LAST_OPCODE /* not an opcode! */
123 * Template for instructions.
125 * ipfw_insn is used for all instructions which require no operands,
126 * a single 16-bit value (arg1), or a couple of 8-bit values.
128 * For other instructions which require different/larger arguments
129 * we have derived structures, ipfw_insn_*.
131 * The size of the instruction (in 32-bit words) is in the low
132 * 6 bits of "len". The 2 remaining bits are used to implement
133 * NOT and OR on individual instructions. Given a type, you can
134 * compute the length to be put in "len" using F_INSN_SIZE(t)
136 * F_NOT negates the match result of the instruction.
138 * F_OR is used to build or blocks. By default, instructions
139 * are evaluated as part of a logical AND. An "or" block
140 * { X or Y or Z } contains F_OR set in all but the last
141 * instruction of the block. A match will cause the code
142 * to skip past the last instruction of the block.
144 * NOTA BENE: in a couple of places we assume that
145 * sizeof(ipfw_insn) == sizeof(uint32_t)
146 * this needs to be fixed.
149 typedef struct _ipfw_insn { /* template for instructions */
150 enum ipfw_opcodes opcode:8;
151 uint8_t len; /* numer of 32-byte words */
154 #define F_LEN_MASK 0x3f
155 #define F_LEN(cmd) ((cmd)->len & F_LEN_MASK)
161 * The F_INSN_SIZE(type) computes the size, in 4-byte words, of
164 #define F_INSN_SIZE(t) ((sizeof (t))/sizeof(uint32_t))
167 * This is used to store an array of 16-bit entries (ports etc.)
169 typedef struct _ipfw_insn_u16 {
171 uint16_t ports[2]; /* there may be more */
175 * This is used to store an array of 32-bit entries
176 * (uid, single IPv4 addresses etc.)
178 typedef struct _ipfw_insn_u32 {
180 uint32_t d[1]; /* one or more */
184 * This is used to store IP addr-mask pairs.
186 typedef struct _ipfw_insn_ip {
193 * This is used to forward to a given address (ip)
195 typedef struct _ipfw_insn_sa {
197 struct sockaddr_in sa;
201 * This is used for MAC addr-mask pairs.
203 typedef struct _ipfw_insn_mac {
205 u_char addr[12]; /* dst[6] + src[6] */
206 u_char mask[12]; /* dst[6] + src[6] */
210 * This is used for interface match rules (recv xx, xmit xx)
212 typedef struct _ipfw_insn_if {
222 * This is used for pipe and queue actions, which need to store
223 * a single pointer (which can have different size on different
226 typedef struct _ipfw_insn_pipe {
232 * This is used for limit rules.
234 typedef struct _ipfw_insn_limit {
237 uint8_t limit_mask; /* combination of DYN_* below */
238 #define DYN_SRC_ADDR 0x1
239 #define DYN_SRC_PORT 0x2
240 #define DYN_DST_ADDR 0x4
241 #define DYN_DST_PORT 0x8
247 * This is used for log instructions
249 typedef struct _ipfw_insn_log {
251 uint32_t max_log; /* how many do we log -- 0 = all */
252 uint32_t log_left; /* how many left to log */
258 * Here we have the structure representing an ipfw rule.
260 * It starts with a general area (with link fields and counters)
261 * followed by an array of one or more instructions, which the code
262 * accesses as an array of 32-bit values.
264 * Given a rule pointer r:
266 * r->cmd is the start of the first instruction.
267 * ACTION_PTR(r) is the start of the first action (things to do
268 * once a rule matched).
270 * When assembling instruction, remember the following:
272 * + if a rule has a "keep-state" (or "limit") option, then the
273 * first instruction (at r->cmd) MUST BE an O_PROBE_STATE
274 * + if a rule has a "log" option, then the first action
275 * (at ACTION_PTR(r)) MUST be O_LOG
277 * NOTE: we use a simple linked list of rules because we never need
278 * to delete a rule without scanning the list. We do not use
279 * queue(3) macros for portability and readability.
283 struct ip_fw *next; /* linked list of rules */
284 struct ip_fw *next_rule; /* ptr to next [skipto] rule */
285 uint16_t act_ofs; /* offset of action in 32-bit units */
286 uint16_t cmd_len; /* # of 32-bit words in cmd */
287 uint16_t rulenum; /* rule number */
288 uint8_t set; /* rule set (0..31) */
289 uint8_t usr_flags; /* IPFW_USR_F_ */
291 /* These fields are present in all rules. */
292 uint64_t pcnt; /* Packet counter */
293 uint64_t bcnt; /* Byte counter */
294 uint32_t timestamp; /* tv_sec of last match */
296 struct ip_fw *sibling; /* clone on next cpu */
297 int cpuid; /* owner cpu */
299 uint32_t refcnt; /* Ref count for transit pkts */
300 uint32_t rule_flags; /* IPFW_RULE_F_ */
301 uintptr_t track_ruleid; /* ruleid for src/dst tracks */
303 ipfw_insn cmd[1]; /* storage for commands */
306 #define IPFW_RULE_F_INVALID 0x1
308 #define IPFW_RULE_F_GENSTATE 0x4
309 #define IPFW_RULE_F_GENTRACK 0x8
311 #define RULESIZE(rule) (sizeof(struct ip_fw) + (rule)->cmd_len * 4 - 4)
314 * This structure is used as a flow mask and a flow id for various
317 struct ipfw_flow_id {
323 uint8_t flags; /* protocol-specific flags */
327 * Main firewall chains definitions and global var's definitions.
330 /* ipfw_chk/ip_fw_chk_ptr return values */
333 #define IP_FW_DIVERT 2
335 #define IP_FW_DUMMYNET 4
338 * arguments for calling ipfw_chk() and dummynet_io(). We put them
339 * all into a structure because this way it is easier and more
340 * efficient to pass variables around and extend the interface.
343 struct mbuf *m; /* the mbuf chain */
344 struct ifnet *oif; /* output interface */
345 struct ip_fw *rule; /* matching rule */
346 struct ether_header *eh; /* for bridged packets */
348 struct ipfw_flow_id f_id; /* grabbed from IP header */
351 * Depend on the return value of ipfw_chk/ip_fw_chk_ptr
352 * 'cookie' field may save following information:
354 * IP_FW_TEE or IP_FW_DIVERT
355 * The divert port number
358 * The pipe or queue number
364 * Function definitions.
366 int ip_fw_sockopt(struct sockopt *);
372 typedef int ip_fw_chk_t(struct ip_fw_args *);
373 typedef int ip_fw_ctl_t(struct sockopt *);
374 typedef void ip_fw_dn_io_t(struct mbuf *, int, int, struct ip_fw_args *);
376 extern ip_fw_chk_t *ip_fw_chk_ptr;
377 extern ip_fw_ctl_t *ip_fw_ctl_ptr;
378 extern ip_fw_dn_io_t *ip_fw_dn_io_ptr;
380 extern int fw_one_pass;
381 extern int fw_enable;
383 extern int ip_fw_loaded;
384 #define IPFW_LOADED (ip_fw_loaded)
386 #define IPFW_CFGCPUID 0
387 #define IPFW_CFGPORT netisr_cpuport(IPFW_CFGCPUID)
388 #define IPFW_ASSERT_CFGPORT(msgport) \
389 KASSERT((msgport) == IPFW_CFGPORT, ("not IPFW CFGPORT"))
393 #define ACTION_PTR(rule) \
394 (ipfw_insn *)((uint32_t *)((rule)->cmd) + ((rule)->act_ofs))
396 struct ipfw_ioc_rule {
397 uint16_t act_ofs; /* offset of action in 32-bit units */
398 uint16_t cmd_len; /* # of 32-bit words in cmd */
399 uint16_t rulenum; /* rule number */
400 uint8_t set; /* rule set (0..31) */
401 uint8_t usr_flags; /* IPFW_USR_F_ */
403 /* Rule set information */
404 uint32_t set_disable; /* disabled rule sets */
405 uint32_t static_count; /* # of static rules */
406 uint32_t static_len; /* total length of static rules */
409 uint64_t pcnt; /* Packet counter */
410 uint64_t bcnt; /* Byte counter */
411 uint32_t timestamp; /* tv_sec of last match */
413 uint8_t reserved[16];
415 ipfw_insn cmd[1]; /* storage for commands */
418 #define IPFW_USR_F_NORULE 0x01
420 #define IPFW_RULE_SIZE_MAX 255 /* unit: uint32_t */
422 #define IOC_RULESIZE(rule) \
423 (sizeof(struct ipfw_ioc_rule) + (rule)->cmd_len * 4 - 4)
425 struct ipfw_ioc_flowid {
426 uint16_t type; /* ETHERTYPE_ */
440 struct ipfw_ioc_state {
441 uint32_t expire; /* expire time */
442 uint64_t pcnt; /* packet match counter */
443 uint64_t bcnt; /* byte match counter */
445 uint16_t dyn_type; /* rule type */
446 uint16_t count; /* refcount */
451 int cpu; /* reserved */
453 struct ipfw_ioc_flowid id; /* (masked) flow id */
454 uint8_t reserved[16];
458 * Definitions for IP option names.
460 #define IP_FW_IPOPT_LSRR 0x01
461 #define IP_FW_IPOPT_SSRR 0x02
462 #define IP_FW_IPOPT_RR 0x04
463 #define IP_FW_IPOPT_TS 0x08
466 * Definitions for TCP option names.
468 #define IP_FW_TCPOPT_MSS 0x01
469 #define IP_FW_TCPOPT_WINDOW 0x02
470 #define IP_FW_TCPOPT_SACK 0x04
471 #define IP_FW_TCPOPT_TS 0x08
472 #define IP_FW_TCPOPT_CC 0x10
474 #define ICMP_REJECT_RST 0x100 /* fake ICMP code (send a TCP RST) */
476 #endif /* _IPFW2_H */