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 * 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.
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).
41 * "enum ipfw_opcodes" are the opcodes supported. We can have up
42 * to 256 different opcodes.
45 enum ipfw_opcodes
{ /* arguments (4 byte each) */
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 */
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 */
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 */
62 O_MACADDR2
, /* 2 mac addr:mask */
63 O_MAC_TYPE
, /* same as srcport */
73 O_IPOPT
, /* arg1 = 2*u8 bitmap */
74 O_IPLEN
, /* arg1 = len */
75 O_IPID
, /* arg1 = id */
77 O_IPTOS
, /* arg1 = id */
78 O_IPPRECEDENCE
, /* arg1 = precedence << 5 */
79 O_IPTTL
, /* arg1 = TTL */
81 O_IPVER
, /* arg1 = version */
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 */
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. */
98 O_LOG
, /* ipfw_insn_log */
99 O_PROB
, /* u32 = match probability */
100 O_CHECK_STATE
, /* none */
103 O_REJECT
, /* arg1=icmp arg (same as deny) */
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 */
113 /* Table based filters. */
114 O_IP_SRC_TABLE
, /* arg1 = tableid */
115 O_IP_DST_TABLE
, /* arg1 = tableid */
123 O_LAST_OPCODE
/* not an opcode! */
127 * Template for instructions.
129 * ipfw_insn is used for all instructions which require no operands,
130 * a single 16-bit value (arg1), or a couple of 8-bit values.
132 * For other instructions which require different/larger arguments
133 * we have derived structures, ipfw_insn_*.
135 * The size of the instruction (in 32-bit words) is in the low
136 * 6 bits of "len". The 2 remaining bits are used to implement
137 * NOT and OR on individual instructions. Given a type, you can
138 * compute the length to be put in "len" using F_INSN_SIZE(t)
140 * F_NOT negates the match result of the instruction.
142 * F_OR is used to build or blocks. By default, instructions
143 * are evaluated as part of a logical AND. An "or" block
144 * { X or Y or Z } contains F_OR set in all but the last
145 * instruction of the block. A match will cause the code
146 * to skip past the last instruction of the block.
148 * NOTA BENE: in a couple of places we assume that
149 * sizeof(ipfw_insn) == sizeof(uint32_t)
150 * this needs to be fixed.
153 typedef struct _ipfw_insn
{ /* template for instructions */
154 enum ipfw_opcodes opcode
:8;
155 uint8_t len
; /* numer of 32-byte words */
158 #define F_LEN_MASK 0x3f
159 #define F_LEN(cmd) ((cmd)->len & F_LEN_MASK)
165 * The F_INSN_SIZE(type) computes the size, in 4-byte words, of
168 #define F_INSN_SIZE(t) ((sizeof (t))/sizeof(uint32_t))
171 * This is used to store an array of 16-bit entries (ports etc.)
173 typedef struct _ipfw_insn_u16
{
175 uint16_t ports
[2]; /* there may be more */
179 * This is used to store an array of 32-bit entries
180 * (uid, single IPv4 addresses etc.)
182 typedef struct _ipfw_insn_u32
{
184 uint32_t d
[1]; /* one or more */
188 * This is used to store IP addr-mask pairs.
190 typedef struct _ipfw_insn_ip
{
197 * This is used to forward to a given address (ip)
199 typedef struct _ipfw_insn_sa
{
201 struct sockaddr_in sa
;
205 * This is used for MAC addr-mask pairs.
207 typedef struct _ipfw_insn_mac
{
209 u_char addr
[12]; /* dst[6] + src[6] */
210 u_char mask
[12]; /* dst[6] + src[6] */
214 * This is used for interface match rules (recv xx, xmit xx)
216 typedef struct _ipfw_insn_if
{
226 * This is used for pipe and queue actions, which need to store
227 * a single pointer (which can have different size on different
230 typedef struct _ipfw_insn_pipe
{
236 * This is used for limit rules.
238 typedef struct _ipfw_insn_limit
{
241 uint8_t limit_mask
; /* combination of DYN_* below */
242 #define DYN_SRC_ADDR 0x1
243 #define DYN_SRC_PORT 0x2
244 #define DYN_DST_ADDR 0x4
245 #define DYN_DST_PORT 0x8
251 * This is used for log instructions
253 typedef struct _ipfw_insn_log
{
255 uint32_t max_log
; /* how many do we log -- 0 = all */
256 uint32_t log_left
; /* how many left to log */
262 * Here we have the structure representing an ipfw rule.
264 * It starts with a general area (with link fields and counters)
265 * followed by an array of one or more instructions, which the code
266 * accesses as an array of 32-bit values.
268 * Given a rule pointer r:
270 * r->cmd is the start of the first instruction.
271 * ACTION_PTR(r) is the start of the first action (things to do
272 * once a rule matched).
274 * When assembling instruction, remember the following:
276 * + if a rule has a "keep-state" (or "limit") option, then the
277 * first instruction (at r->cmd) MUST BE an O_PROBE_STATE
278 * + if a rule has a "log" option, then the first action
279 * (at ACTION_PTR(r)) MUST be O_LOG
281 * NOTE: we use a simple linked list of rules because we never need
282 * to delete a rule without scanning the list. We do not use
283 * queue(3) macros for portability and readability.
287 struct ip_fw
*next
; /* linked list of rules */
288 struct ip_fw
*next_rule
; /* ptr to next [skipto] rule */
289 uint16_t act_ofs
; /* offset of action in 32-bit units */
290 uint16_t cmd_len
; /* # of 32-bit words in cmd */
291 uint16_t rulenum
; /* rule number */
292 uint8_t set
; /* rule set (0..31) */
293 uint8_t usr_flags
; /* IPFW_USR_F_ */
295 /* These fields are present in all rules. */
296 uint64_t pcnt
; /* Packet counter */
297 uint64_t bcnt
; /* Byte counter */
298 uint32_t timestamp
; /* tv_sec of last match */
300 int cpuid
; /* owner cpu */
301 struct ip_fw
*sibling
; /* clone on next cpu */
303 struct ip_fw
**cross_rules
; /* cross referenced rules */
304 uint64_t cross_refs
; /* cross references */
306 uint32_t refcnt
; /* Ref count for transit pkts */
307 uint32_t rule_flags
; /* IPFW_RULE_F_ */
308 uintptr_t track_ruleid
; /* ruleid for src/dst tracks */
310 ipfw_insn cmd
[1]; /* storage for commands */
313 #define IPFW_RULE_F_INVALID 0x1
315 #define IPFW_RULE_F_GENSTATE 0x4
316 #define IPFW_RULE_F_GENTRACK 0x8
317 #define IPFW_RULE_F_CROSSREF 0x10
319 #define RULESIZE(rule) (sizeof(struct ip_fw) + (rule)->cmd_len * 4 - 4)
322 * This structure is used as a flow mask and a flow id for various
325 struct ipfw_flow_id
{
331 uint8_t flags
; /* protocol-specific flags */
335 * Main firewall chains definitions and global var's definitions.
338 /* ipfw_chk/ip_fw_chk_ptr return values */
341 #define IP_FW_DIVERT 2
343 #define IP_FW_DUMMYNET 4
344 #define IP_FW_CONTINUE 5
347 * arguments for calling ipfw_chk() and dummynet_io(). We put them
348 * all into a structure because this way it is easier and more
349 * efficient to pass variables around and extend the interface.
352 struct mbuf
*m
; /* the mbuf chain */
353 struct ifnet
*oif
; /* output interface */
354 struct ip_fw
*rule
; /* matching rule */
355 struct ether_header
*eh
; /* for bridged packets */
357 struct ipfw_flow_id f_id
; /* grabbed from IP header */
361 * Depend on the return value of ipfw_chk/ip_fw_chk_ptr
362 * 'cookie' field may save following information:
364 * IP_FW_TEE or IP_FW_DIVERT
365 * The divert port number
368 * The pipe or queue number
374 * Function definitions.
376 int ip_fw_sockopt(struct sockopt
*);
382 typedef int ip_fw_chk_t(struct ip_fw_args
*);
383 typedef int ip_fw_ctl_t(struct sockopt
*);
385 *ip_fw_dn_io_t(struct mbuf
*, int, int, struct ip_fw_args
*);
387 extern ip_fw_chk_t
*ip_fw_chk_ptr
;
388 extern ip_fw_ctl_t
*ip_fw_ctl_ptr
;
389 extern ip_fw_dn_io_t
*ip_fw_dn_io_ptr
;
391 extern int fw_one_pass
;
392 extern int fw_enable
;
394 extern int ip_fw_loaded
;
395 #define IPFW_LOADED (ip_fw_loaded)
399 #define ACTION_PTR(rule) \
400 (ipfw_insn *)((uint32_t *)((rule)->cmd) + ((rule)->act_ofs))
402 struct ipfw_ioc_rule
{
403 uint16_t act_ofs
; /* offset of action in 32-bit units */
404 uint16_t cmd_len
; /* # of 32-bit words in cmd */
405 uint16_t rulenum
; /* rule number */
406 uint8_t set
; /* rule set (0..31) */
407 uint8_t usr_flags
; /* IPFW_USR_F_ */
409 /* Rule set information */
410 uint32_t set_disable
; /* disabled rule sets */
411 uint32_t static_count
; /* # of static rules */
412 uint32_t static_len
; /* total length of static rules */
415 uint64_t pcnt
; /* Packet counter */
416 uint64_t bcnt
; /* Byte counter */
417 uint32_t timestamp
; /* tv_sec of last match */
419 uint8_t reserved
[16];
421 ipfw_insn cmd
[1]; /* storage for commands */
424 #define IPFW_USR_F_NORULE 0x01
426 #define IPFW_RULE_SIZE_MAX 255 /* unit: uint32_t */
428 #define IOC_RULESIZE(rule) \
429 (sizeof(struct ipfw_ioc_rule) + (rule)->cmd_len * 4 - 4)
431 struct ipfw_ioc_flowid
{
432 uint16_t type
; /* ETHERTYPE_ */
446 struct ipfw_ioc_state
{
447 uint32_t expire
; /* expire time */
448 uint64_t pcnt
; /* packet match counter */
449 uint64_t bcnt
; /* byte match counter */
451 uint16_t dyn_type
; /* rule type */
452 uint16_t count
; /* refcount */
457 int cpu
; /* reserved */
459 struct ipfw_ioc_flowid id
; /* (masked) flow id */
460 uint8_t reserved
[16];
464 * Definitions for IP option names.
466 #define IP_FW_IPOPT_LSRR 0x01
467 #define IP_FW_IPOPT_SSRR 0x02
468 #define IP_FW_IPOPT_RR 0x04
469 #define IP_FW_IPOPT_TS 0x08
472 * Definitions for TCP option names.
474 #define IP_FW_TCPOPT_MSS 0x01
475 #define IP_FW_TCPOPT_WINDOW 0x02
476 #define IP_FW_TCPOPT_SACK 0x04
477 #define IP_FW_TCPOPT_TS 0x08
478 #define IP_FW_TCPOPT_CC 0x10
480 #define ICMP_REJECT_RST 0x100 /* fake ICMP code (send a TCP RST) */
483 * IP_FW_TBL_CREATE, tableid >= 0.
484 * IP_FW_TBL_FLUSH, tableid >= 0.
485 * IP_FW_TBL_FLUSH, tableid < 0, flush all tables.
486 * IP_FW_TBL_DESTROY, tableid >= 0.
487 * IP_FW_TBL_ZERO, tableid >= 0.
488 * IP_FW_TBL_ZERO, tableid < 0, zero all tables' counters.
490 struct ipfw_ioc_table
{
494 struct ipfw_ioc_tblent
{
495 struct sockaddr_in key
;
496 struct sockaddr_in netmask
;
503 * IP_FW_TBL_GET, tableid < 0, list of all tables.
505 struct ipfw_ioc_tbllist
{
506 int tableid
; /* MUST be the first field */
512 * IP_FW_TBL_GET, tableid >= 0, entries in the table.
513 * IP_FW_TBL_ADD, tableid >= 0, entcnt == 1.
514 * IP_FW_TBL_DEL, tableid >= 0, entcnt == 1.
516 struct ipfw_ioc_tblcont
{
517 int tableid
; /* MUST be the first field */
519 struct ipfw_ioc_tblent ent
[1];
523 * IP_FW_TBL_EXPIRE, tableid < 0, expire all tables.
524 * IP_FW_TBL_EXPIRE, tableid >= 0.
526 struct ipfw_ioc_tblexp
{
533 #endif /* _IPFW2_H */