xref: /freebsd/sys/netinet/ip_fw.h (revision 090e9752d7291db0c251a5576892e3bbbaea2479)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2002-2009 Luigi Rizzo, Universita` di Pisa
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  * $FreeBSD$
28  */
29 
30 #ifndef _IPFW2_H
31 #define _IPFW2_H
32 
33 /*
34  * The default rule number.  By the design of ip_fw, the default rule
35  * is the last one, so its number can also serve as the highest number
36  * allowed for a rule.  The ip_fw code relies on both meanings of this
37  * constant.
38  */
39 #define	IPFW_DEFAULT_RULE	65535
40 
41 #define	RESVD_SET		31	/*set for default and persistent rules*/
42 #define	IPFW_MAX_SETS		32	/* Number of sets supported by ipfw*/
43 
44 /*
45  * Compat values for old clients
46  */
47 #ifndef	_KERNEL
48 #define	IPFW_TABLES_MAX		65535
49 #define	IPFW_TABLES_DEFAULT	128
50 #endif
51 
52 /*
53  * Most commands (queue, pipe, tag, untag, limit...) can have a 16-bit
54  * argument between 1 and 65534. The value 0 (IP_FW_TARG) is used
55  * to represent 'tablearg' value, e.g.  indicate the use of a 'tablearg'
56  * result of the most recent table() lookup.
57  * Note that 16bit is only a historical limit, resulting from
58  * the use of a 16-bit fields for that value. In reality, we can have
59  * 2^32 pipes, queues, tag values and so on.
60  */
61 #define	IPFW_ARG_MIN		1
62 #define	IPFW_ARG_MAX		65534
63 #define IP_FW_TABLEARG		65535	/* Compat value for old clients */
64 #define	IP_FW_TARG		0	/* Current tablearg value */
65 #define	IP_FW_NAT44_GLOBAL	65535	/* arg1 value for "nat global" */
66 
67 /*
68  * Number of entries in the call stack of the call/return commands.
69  * Call stack currently is an uint16_t array with rule numbers.
70  */
71 #define	IPFW_CALLSTACK_SIZE	16
72 
73 /* IP_FW3 header/opcodes */
74 typedef struct _ip_fw3_opheader {
75 	uint16_t opcode;	/* Operation opcode */
76 	uint16_t version;	/* Opcode version */
77 	uint16_t reserved[2];	/* Align to 64-bit boundary */
78 } ip_fw3_opheader;
79 
80 /* IP_FW3 opcodes */
81 #define	IP_FW_TABLE_XADD	86	/* add entry */
82 #define	IP_FW_TABLE_XDEL	87	/* delete entry */
83 #define	IP_FW_TABLE_XGETSIZE	88	/* get table size (deprecated) */
84 #define	IP_FW_TABLE_XLIST	89	/* list table contents */
85 #define	IP_FW_TABLE_XDESTROY	90	/* destroy table */
86 #define	IP_FW_TABLES_XLIST	92	/* list all tables  */
87 #define	IP_FW_TABLE_XINFO	93	/* request info for one table */
88 #define	IP_FW_TABLE_XFLUSH	94	/* flush table data */
89 #define	IP_FW_TABLE_XCREATE	95	/* create new table  */
90 #define	IP_FW_TABLE_XMODIFY	96	/* modify existing table */
91 #define	IP_FW_XGET		97	/* Retrieve configuration */
92 #define	IP_FW_XADD		98	/* add rule */
93 #define	IP_FW_XDEL		99	/* del rule */
94 #define	IP_FW_XMOVE		100	/* move rules to different set  */
95 #define	IP_FW_XZERO		101	/* clear accounting */
96 #define	IP_FW_XRESETLOG		102	/* zero rules logs */
97 #define	IP_FW_SET_SWAP		103	/* Swap between 2 sets */
98 #define	IP_FW_SET_MOVE		104	/* Move one set to another one */
99 #define	IP_FW_SET_ENABLE	105	/* Enable/disable sets */
100 #define	IP_FW_TABLE_XFIND	106	/* finds an entry */
101 #define	IP_FW_XIFLIST		107	/* list tracked interfaces */
102 #define	IP_FW_TABLES_ALIST	108	/* list table algorithms */
103 #define	IP_FW_TABLE_XSWAP	109	/* swap two tables */
104 #define	IP_FW_TABLE_VLIST	110	/* dump table value hash */
105 
106 #define	IP_FW_NAT44_XCONFIG	111	/* Create/modify NAT44 instance */
107 #define	IP_FW_NAT44_DESTROY	112	/* Destroys NAT44 instance */
108 #define	IP_FW_NAT44_XGETCONFIG	113	/* Get NAT44 instance config */
109 #define	IP_FW_NAT44_LIST_NAT	114	/* List all NAT44 instances */
110 #define	IP_FW_NAT44_XGETLOG	115	/* Get log from NAT44 instance */
111 
112 #define	IP_FW_DUMP_SOPTCODES	116	/* Dump available sopts/versions */
113 #define	IP_FW_DUMP_SRVOBJECTS	117	/* Dump existing named objects */
114 
115 #define	IP_FW_NAT64STL_CREATE	130	/* Create stateless NAT64 instance */
116 #define	IP_FW_NAT64STL_DESTROY	131	/* Destroy stateless NAT64 instance */
117 #define	IP_FW_NAT64STL_CONFIG	132	/* Modify stateless NAT64 instance */
118 #define	IP_FW_NAT64STL_LIST	133	/* List stateless NAT64 instances */
119 #define	IP_FW_NAT64STL_STATS	134	/* Get NAT64STL instance statistics */
120 #define	IP_FW_NAT64STL_RESET_STATS 135	/* Reset NAT64STL instance statistics */
121 
122 #define	IP_FW_NAT64LSN_CREATE	140	/* Create stateful NAT64 instance */
123 #define	IP_FW_NAT64LSN_DESTROY	141	/* Destroy stateful NAT64 instance */
124 #define	IP_FW_NAT64LSN_CONFIG	142	/* Modify stateful NAT64 instance */
125 #define	IP_FW_NAT64LSN_LIST	143	/* List stateful NAT64 instances */
126 #define	IP_FW_NAT64LSN_STATS	144	/* Get NAT64LSN instance statistics */
127 #define	IP_FW_NAT64LSN_LIST_STATES 145	/* Get stateful NAT64 states */
128 #define	IP_FW_NAT64LSN_RESET_STATS 146	/* Reset NAT64LSN instance statistics */
129 
130 #define	IP_FW_NPTV6_CREATE	150	/* Create NPTv6 instance */
131 #define	IP_FW_NPTV6_DESTROY	151	/* Destroy NPTv6 instance */
132 #define	IP_FW_NPTV6_CONFIG	152	/* Modify NPTv6 instance */
133 #define	IP_FW_NPTV6_LIST	153	/* List NPTv6 instances */
134 #define	IP_FW_NPTV6_STATS	154	/* Get NPTv6 instance statistics */
135 #define	IP_FW_NPTV6_RESET_STATS	155	/* Reset NPTv6 instance statistics */
136 
137 #define	IP_FW_NAT64CLAT_CREATE	160	/* Create clat NAT64 instance */
138 #define	IP_FW_NAT64CLAT_DESTROY	161	/* Destroy clat NAT64 instance */
139 #define	IP_FW_NAT64CLAT_CONFIG	162	/* Modify clat NAT64 instance */
140 #define	IP_FW_NAT64CLAT_LIST	163	/* List clat NAT64 instances */
141 #define	IP_FW_NAT64CLAT_STATS	164	/* Get NAT64CLAT instance statistics */
142 #define	IP_FW_NAT64CLAT_RESET_STATS 165	/* Reset NAT64CLAT instance statistics */
143 
144 /*
145  * The kernel representation of ipfw rules is made of a list of
146  * 'instructions' (for all practical purposes equivalent to BPF
147  * instructions), which specify which fields of the packet
148  * (or its metadata) should be analysed.
149  *
150  * Each instruction is stored in a structure which begins with
151  * "ipfw_insn", and can contain extra fields depending on the
152  * instruction type (listed below).
153  * Note that the code is written so that individual instructions
154  * have a size which is a multiple of 32 bits. This means that, if
155  * such structures contain pointers or other 64-bit entities,
156  * (there is just one instance now) they may end up unaligned on
157  * 64-bit architectures, so the must be handled with care.
158  *
159  * "enum ipfw_opcodes" are the opcodes supported. We can have up
160  * to 256 different opcodes. When adding new opcodes, they should
161  * be appended to the end of the opcode list before O_LAST_OPCODE,
162  * this will prevent the ABI from being broken, otherwise users
163  * will have to recompile ipfw(8) when they update the kernel.
164  */
165 
166 enum ipfw_opcodes {		/* arguments (4 byte each)	*/
167 	O_NOP,
168 
169 	O_IP_SRC,		/* u32 = IP			*/
170 	O_IP_SRC_MASK,		/* ip = IP/mask			*/
171 	O_IP_SRC_ME,		/* none				*/
172 	O_IP_SRC_SET,		/* u32=base, arg1=len, bitmap	*/
173 
174 	O_IP_DST,		/* u32 = IP			*/
175 	O_IP_DST_MASK,		/* ip = IP/mask			*/
176 	O_IP_DST_ME,		/* none				*/
177 	O_IP_DST_SET,		/* u32=base, arg1=len, bitmap	*/
178 
179 	O_IP_SRCPORT,		/* (n)port list:mask 4 byte ea	*/
180 	O_IP_DSTPORT,		/* (n)port list:mask 4 byte ea	*/
181 	O_PROTO,		/* arg1=protocol		*/
182 
183 	O_MACADDR2,		/* 2 mac addr:mask		*/
184 	O_MAC_TYPE,		/* same as srcport		*/
185 
186 	O_LAYER2,		/* none				*/
187 	O_IN,			/* none				*/
188 	O_FRAG,			/* none				*/
189 
190 	O_RECV,			/* none				*/
191 	O_XMIT,			/* none				*/
192 	O_VIA,			/* none				*/
193 
194 	O_IPOPT,		/* arg1 = 2*u8 bitmap		*/
195 	O_IPLEN,		/* arg1 = len			*/
196 	O_IPID,			/* arg1 = id			*/
197 
198 	O_IPTOS,		/* arg1 = id			*/
199 	O_IPPRECEDENCE,		/* arg1 = precedence << 5	*/
200 	O_IPTTL,		/* arg1 = TTL			*/
201 
202 	O_IPVER,		/* arg1 = version		*/
203 	O_UID,			/* u32 = id			*/
204 	O_GID,			/* u32 = id			*/
205 	O_ESTAB,		/* none (tcp established)	*/
206 	O_TCPFLAGS,		/* arg1 = 2*u8 bitmap		*/
207 	O_TCPWIN,		/* arg1 = desired win		*/
208 	O_TCPSEQ,		/* u32 = desired seq.		*/
209 	O_TCPACK,		/* u32 = desired seq.		*/
210 	O_ICMPTYPE,		/* u32 = icmp bitmap		*/
211 	O_TCPOPTS,		/* arg1 = 2*u8 bitmap		*/
212 
213 	O_VERREVPATH,		/* none				*/
214 	O_VERSRCREACH,		/* none				*/
215 
216 	O_PROBE_STATE,		/* none				*/
217 	O_KEEP_STATE,		/* none				*/
218 	O_LIMIT,		/* ipfw_insn_limit		*/
219 	O_LIMIT_PARENT,		/* dyn_type, not an opcode.	*/
220 
221 	/*
222 	 * These are really 'actions'.
223 	 */
224 
225 	O_LOG,			/* ipfw_insn_log		*/
226 	O_PROB,			/* u32 = match probability	*/
227 
228 	O_CHECK_STATE,		/* none				*/
229 	O_ACCEPT,		/* none				*/
230 	O_DENY,			/* none 			*/
231 	O_REJECT,		/* arg1=icmp arg (same as deny)	*/
232 	O_COUNT,		/* none				*/
233 	O_SKIPTO,		/* arg1=next rule number	*/
234 	O_PIPE,			/* arg1=pipe number		*/
235 	O_QUEUE,		/* arg1=queue number		*/
236 	O_DIVERT,		/* arg1=port number		*/
237 	O_TEE,			/* arg1=port number		*/
238 	O_FORWARD_IP,		/* fwd sockaddr			*/
239 	O_FORWARD_MAC,		/* fwd mac			*/
240 	O_NAT,                  /* nope                         */
241 	O_REASS,                /* none                         */
242 
243 	/*
244 	 * More opcodes.
245 	 */
246 	O_IPSEC,		/* has ipsec history 		*/
247 	O_IP_SRC_LOOKUP,	/* arg1=table number, u32=value	*/
248 	O_IP_DST_LOOKUP,	/* arg1=table number, u32=value	*/
249 	O_ANTISPOOF,		/* none				*/
250 	O_JAIL,			/* u32 = id			*/
251 	O_ALTQ,			/* u32 = altq classif. qid	*/
252 	O_DIVERTED,		/* arg1=bitmap (1:loop, 2:out)	*/
253 	O_TCPDATALEN,		/* arg1 = tcp data len		*/
254 	O_IP6_SRC,		/* address without mask		*/
255 	O_IP6_SRC_ME,		/* my addresses			*/
256 	O_IP6_SRC_MASK,		/* address with the mask	*/
257 	O_IP6_DST,
258 	O_IP6_DST_ME,
259 	O_IP6_DST_MASK,
260 	O_FLOW6ID,		/* for flow id tag in the ipv6 pkt */
261 	O_ICMP6TYPE,		/* icmp6 packet type filtering	*/
262 	O_EXT_HDR,		/* filtering for ipv6 extension header */
263 	O_IP6,
264 
265 	/*
266 	 * actions for ng_ipfw
267 	 */
268 	O_NETGRAPH,		/* send to ng_ipfw		*/
269 	O_NGTEE,		/* copy to ng_ipfw		*/
270 
271 	O_IP4,
272 
273 	O_UNREACH6,		/* arg1=icmpv6 code arg (deny)  */
274 
275 	O_TAG,   		/* arg1=tag number */
276 	O_TAGGED,		/* arg1=tag number */
277 
278 	O_SETFIB,		/* arg1=FIB number */
279 	O_FIB,			/* arg1=FIB desired fib number */
280 
281 	O_SOCKARG,		/* socket argument */
282 
283 	O_CALLRETURN,		/* arg1=called rule number */
284 
285 	O_FORWARD_IP6,		/* fwd sockaddr_in6             */
286 
287 	O_DSCP,			/* 2 u32 = DSCP mask */
288 	O_SETDSCP,		/* arg1=DSCP value */
289 	O_IP_FLOW_LOOKUP,	/* arg1=table number, u32=value	*/
290 
291 	O_EXTERNAL_ACTION,	/* arg1=id of external action handler */
292 	O_EXTERNAL_INSTANCE,	/* arg1=id of eaction handler instance */
293 	O_EXTERNAL_DATA,	/* variable length data */
294 
295 	O_SKIP_ACTION,		/* none				*/
296 	O_TCPMSS,		/* arg1=MSS value */
297 
298 	O_MAC_SRC_LOOKUP,	/* arg1=table number, u32=value */
299 	O_MAC_DST_LOOKUP,	/* arg1=table number, u32=value */
300 
301 	O_SETMARK,		/* u32 = value */
302 	O_MARK,			/* 2 u32 = value, bitmask */
303 
304 	O_LAST_OPCODE		/* not an opcode!		*/
305 };
306 
307 /*
308  * Defines key types used by lookup instruction
309  */
310 enum ipfw_table_lookup_type {
311 	LOOKUP_DST_IP,
312 	LOOKUP_SRC_IP,
313 	LOOKUP_DST_PORT,
314 	LOOKUP_SRC_PORT,
315 	LOOKUP_UID,
316 	LOOKUP_JAIL,
317 	LOOKUP_DSCP,
318 	LOOKUP_DST_MAC,
319 	LOOKUP_SRC_MAC,
320 	LOOKUP_MARK,
321 };
322 
323 /*
324  * The extension header are filtered only for presence using a bit
325  * vector with a flag for each header.
326  */
327 #define EXT_FRAGMENT	0x1
328 #define EXT_HOPOPTS	0x2
329 #define EXT_ROUTING	0x4
330 #define EXT_AH		0x8
331 #define EXT_ESP		0x10
332 #define EXT_DSTOPTS	0x20
333 #define EXT_RTHDR0		0x40
334 #define EXT_RTHDR2		0x80
335 
336 /*
337  * Template for instructions.
338  *
339  * ipfw_insn is used for all instructions which require no operands,
340  * a single 16-bit value (arg1), or a couple of 8-bit values.
341  *
342  * For other instructions which require different/larger arguments
343  * we have derived structures, ipfw_insn_*.
344  *
345  * The size of the instruction (in 32-bit words) is in the low
346  * 6 bits of "len". The 2 remaining bits are used to implement
347  * NOT and OR on individual instructions. Given a type, you can
348  * compute the length to be put in "len" using F_INSN_SIZE(t)
349  *
350  * F_NOT	negates the match result of the instruction.
351  *
352  * F_OR		is used to build or blocks. By default, instructions
353  *		are evaluated as part of a logical AND. An "or" block
354  *		{ X or Y or Z } contains F_OR set in all but the last
355  *		instruction of the block. A match will cause the code
356  *		to skip past the last instruction of the block.
357  *
358  * NOTA BENE: in a couple of places we assume that
359  *	sizeof(ipfw_insn) == sizeof(u_int32_t)
360  * this needs to be fixed.
361  *
362  */
363 typedef struct	_ipfw_insn {	/* template for instructions */
364 	_Alignas(_Alignof(u_int32_t)) u_int8_t 	opcode;
365 	u_int8_t	len;	/* number of 32-bit words */
366 #define	F_NOT		0x80
367 #define	F_OR		0x40
368 #define	F_LEN_MASK	0x3f
369 #define	F_LEN(cmd)	((cmd)->len & F_LEN_MASK)
370 
371 	u_int16_t	arg1;
372 } ipfw_insn;
373 
374 /*
375  * The F_INSN_SIZE(type) computes the size, in 4-byte words, of
376  * a given type.
377  */
378 #define	F_INSN_SIZE(t)	((sizeof (t))/sizeof(u_int32_t))
379 
380 /*
381  * This is used to store an array of 16-bit entries (ports etc.)
382  */
383 typedef struct	_ipfw_insn_u16 {
384 	ipfw_insn o;
385 	u_int16_t ports[2];	/* there may be more */
386 } ipfw_insn_u16;
387 
388 /*
389  * This is used to store an array of 32-bit entries
390  * (uid, single IPv4 addresses etc.)
391  */
392 typedef struct	_ipfw_insn_u32 {
393 	ipfw_insn o;
394 	u_int32_t d[1];	/* one or more */
395 } ipfw_insn_u32;
396 
397 /*
398  * This is used to store IP addr-mask pairs.
399  */
400 typedef struct	_ipfw_insn_ip {
401 	ipfw_insn o;
402 	struct in_addr	addr;
403 	struct in_addr	mask;
404 } ipfw_insn_ip;
405 
406 /*
407  * This is used to forward to a given address (ip).
408  */
409 typedef struct  _ipfw_insn_sa {
410 	ipfw_insn o;
411 	struct sockaddr_in sa;
412 } ipfw_insn_sa;
413 
414 /*
415  * This is used to forward to a given address (ipv6).
416  */
417 typedef struct _ipfw_insn_sa6 {
418 	ipfw_insn o;
419 	struct sockaddr_in6 sa;
420 } ipfw_insn_sa6;
421 
422 /*
423  * This is used for MAC addr-mask pairs.
424  */
425 typedef struct	_ipfw_insn_mac {
426 	ipfw_insn o;
427 	u_char addr[12];	/* dst[6] + src[6] */
428 	u_char mask[12];	/* dst[6] + src[6] */
429 } ipfw_insn_mac;
430 
431 /*
432  * This is used for interface match rules (recv xx, xmit xx).
433  */
434 typedef struct	_ipfw_insn_if {
435 	ipfw_insn o;
436 	union {
437 		struct in_addr ip;
438 		int glob;
439 		uint16_t kidx;
440 	} p;
441 	char name[IFNAMSIZ];
442 } ipfw_insn_if;
443 
444 /*
445  * This is used for storing an altq queue id number.
446  */
447 typedef struct _ipfw_insn_altq {
448 	ipfw_insn	o;
449 	u_int32_t	qid;
450 } ipfw_insn_altq;
451 
452 /*
453  * This is used for limit rules.
454  */
455 typedef struct	_ipfw_insn_limit {
456 	ipfw_insn o;
457 	u_int8_t _pad;
458 	u_int8_t limit_mask;	/* combination of DYN_* below	*/
459 #define	DYN_SRC_ADDR	0x1
460 #define	DYN_SRC_PORT	0x2
461 #define	DYN_DST_ADDR	0x4
462 #define	DYN_DST_PORT	0x8
463 
464 	u_int16_t conn_limit;
465 } ipfw_insn_limit;
466 
467 /*
468  * This is used for log instructions.
469  */
470 typedef struct  _ipfw_insn_log {
471         ipfw_insn o;
472 	u_int32_t max_log;	/* how many do we log -- 0 = all */
473 	u_int32_t log_left;	/* how many left to log 	*/
474 } ipfw_insn_log;
475 
476 /* Legacy NAT structures, compat only */
477 #ifndef	_KERNEL
478 /*
479  * Data structures required by both ipfw(8) and ipfw(4) but not part of the
480  * management API are protected by IPFW_INTERNAL.
481  */
482 #ifdef IPFW_INTERNAL
483 /* Server pool support (LSNAT). */
484 struct cfg_spool {
485 	LIST_ENTRY(cfg_spool)   _next;          /* chain of spool instances */
486 	struct in_addr          addr;
487 	u_short                 port;
488 };
489 #endif
490 
491 /* Redirect modes id. */
492 #define REDIR_ADDR      0x01
493 #define REDIR_PORT      0x02
494 #define REDIR_PROTO     0x04
495 
496 #ifdef IPFW_INTERNAL
497 /* Nat redirect configuration. */
498 struct cfg_redir {
499 	LIST_ENTRY(cfg_redir)   _next;          /* chain of redir instances */
500 	u_int16_t               mode;           /* type of redirect mode */
501 	struct in_addr	        laddr;          /* local ip address */
502 	struct in_addr	        paddr;          /* public ip address */
503 	struct in_addr	        raddr;          /* remote ip address */
504 	u_short                 lport;          /* local port */
505 	u_short                 pport;          /* public port */
506 	u_short                 rport;          /* remote port  */
507 	u_short                 pport_cnt;      /* number of public ports */
508 	u_short                 rport_cnt;      /* number of remote ports */
509 	int                     proto;          /* protocol: tcp/udp */
510 	struct alias_link       **alink;
511 	/* num of entry in spool chain */
512 	u_int16_t               spool_cnt;
513 	/* chain of spool instances */
514 	LIST_HEAD(spool_chain, cfg_spool) spool_chain;
515 };
516 #endif
517 
518 #ifdef IPFW_INTERNAL
519 /* Nat configuration data struct. */
520 struct cfg_nat {
521 	/* chain of nat instances */
522 	LIST_ENTRY(cfg_nat)     _next;
523 	int                     id;                     /* nat id */
524 	struct in_addr          ip;                     /* nat ip address */
525 	char                    if_name[IF_NAMESIZE];   /* interface name */
526 	int                     mode;                   /* aliasing mode */
527 	struct libalias	        *lib;                   /* libalias instance */
528 	/* number of entry in spool chain */
529 	int                     redir_cnt;
530 	/* chain of redir instances */
531 	LIST_HEAD(redir_chain, cfg_redir) redir_chain;
532 };
533 #endif
534 
535 #define SOF_NAT         sizeof(struct cfg_nat)
536 #define SOF_REDIR       sizeof(struct cfg_redir)
537 #define SOF_SPOOL       sizeof(struct cfg_spool)
538 
539 #endif	/* ifndef _KERNEL */
540 
541 struct nat44_cfg_spool {
542 	struct in_addr	addr;
543 	uint16_t	port;
544 	uint16_t	spare;
545 };
546 #define NAT44_REDIR_ADDR	0x01
547 #define NAT44_REDIR_PORT	0x02
548 #define NAT44_REDIR_PROTO	0x04
549 
550 /* Nat redirect configuration. */
551 struct nat44_cfg_redir {
552 	struct in_addr	laddr;		/* local ip address */
553 	struct in_addr	paddr;		/* public ip address */
554 	struct in_addr	raddr;		/* remote ip address */
555 	uint16_t	lport;		/* local port */
556 	uint16_t	pport;		/* public port */
557 	uint16_t	rport;		/* remote port  */
558 	uint16_t	pport_cnt;	/* number of public ports */
559 	uint16_t	rport_cnt;	/* number of remote ports */
560 	uint16_t	mode;		/* type of redirect mode */
561 	uint16_t	spool_cnt;	/* num of entry in spool chain */
562 	uint16_t	spare;
563 	uint32_t	proto;		/* protocol: tcp/udp */
564 };
565 
566 /* Nat configuration data struct. */
567 struct nat44_cfg_nat {
568 	char		name[64];	/* nat name */
569 	char		if_name[64];	/* interface name */
570 	uint32_t	size;		/* structure size incl. redirs */
571 	struct in_addr	ip;		/* nat IPv4 address */
572 	uint32_t	mode;		/* aliasing mode */
573 	uint32_t	redir_cnt;	/* number of entry in spool chain */
574 	u_short		alias_port_lo;	/* low range for port aliasing */
575 	u_short		alias_port_hi;	/* high range for port aliasing */
576 };
577 
578 /* Nat command. */
579 typedef struct	_ipfw_insn_nat {
580  	ipfw_insn	o;
581  	struct cfg_nat *nat;
582 } ipfw_insn_nat;
583 
584 /* Apply ipv6 mask on ipv6 addr */
585 #define APPLY_MASK(addr,mask)	do {					\
586     (addr)->__u6_addr.__u6_addr32[0] &= (mask)->__u6_addr.__u6_addr32[0]; \
587     (addr)->__u6_addr.__u6_addr32[1] &= (mask)->__u6_addr.__u6_addr32[1]; \
588     (addr)->__u6_addr.__u6_addr32[2] &= (mask)->__u6_addr.__u6_addr32[2]; \
589     (addr)->__u6_addr.__u6_addr32[3] &= (mask)->__u6_addr.__u6_addr32[3]; \
590 } while (0)
591 
592 /* Structure for ipv6 */
593 typedef struct _ipfw_insn_ip6 {
594        ipfw_insn o;
595        struct in6_addr addr6;
596        struct in6_addr mask6;
597 } ipfw_insn_ip6;
598 
599 /* Used to support icmp6 types */
600 typedef struct _ipfw_insn_icmp6 {
601        ipfw_insn o;
602        uint32_t d[7]; /* XXX This number si related to the netinet/icmp6.h
603                        *     define ICMP6_MAXTYPE
604                        *     as follows: n = ICMP6_MAXTYPE/32 + 1
605                         *     Actually is 203
606                        */
607 } ipfw_insn_icmp6;
608 
609 /*
610  * Here we have the structure representing an ipfw rule.
611  *
612  * Layout:
613  * struct ip_fw_rule
614  * [ counter block, size = rule->cntr_len ]
615  * [ one or more instructions, size = rule->cmd_len * 4 ]
616  *
617  * It starts with a general area (with link fields).
618  * Counter block may be next (if rule->cntr_len > 0),
619  * followed by an array of one or more instructions, which the code
620  * accesses as an array of 32-bit values. rule->cmd_len represents
621  * the total instructions legth in u32 worrd, while act_ofs represents
622  * rule action offset in u32 words.
623  *
624  * When assembling instruction, remember the following:
625  *
626  *  + if a rule has a "keep-state" (or "limit") option, then the
627  *	first instruction (at r->cmd) MUST BE an O_PROBE_STATE
628  *  + if a rule has a "log" option, then the first action
629  *	(at ACTION_PTR(r)) MUST be O_LOG
630  *  + if a rule has an "altq" option, it comes after "log"
631  *  + if a rule has an O_TAG option, it comes after "log" and "altq"
632  *
633  *
634  * All structures (excluding instructions) are u64-aligned.
635  * Please keep this.
636  */
637 
638 struct ip_fw_rule {
639 	uint16_t	act_ofs;	/* offset of action in 32-bit units */
640 	uint16_t	cmd_len;	/* # of 32-bit words in cmd	*/
641 	uint16_t	spare;
642 	uint8_t		set;		/* rule set (0..31)		*/
643 	uint8_t		flags;		/* rule flags			*/
644 	uint32_t	rulenum;	/* rule number			*/
645 	uint32_t	id;		/* rule id			*/
646 
647 	ipfw_insn	cmd[1];		/* storage for commands		*/
648 };
649 #define	IPFW_RULE_NOOPT		0x01	/* Has no options in body	*/
650 #define	IPFW_RULE_JUSTOPTS	0x02	/* new format of rule body	*/
651 
652 /* Unaligned version */
653 
654 /* Base ipfw rule counter block. */
655 struct ip_fw_bcounter {
656 	uint16_t	size;		/* Size of counter block, bytes	*/
657 	uint8_t		flags;		/* flags for given block	*/
658 	uint8_t		spare;
659 	uint32_t	timestamp;	/* tv_sec of last match		*/
660 	uint64_t	pcnt;		/* Packet counter		*/
661 	uint64_t	bcnt;		/* Byte counter			*/
662 };
663 
664 #ifndef	_KERNEL
665 /*
666  * Legacy rule format
667  */
668 struct ip_fw {
669 	struct ip_fw	*x_next;	/* linked list of rules		*/
670 	struct ip_fw	*next_rule;	/* ptr to next [skipto] rule	*/
671 	/* 'next_rule' is used to pass up 'set_disable' status		*/
672 
673 	uint16_t	act_ofs;	/* offset of action in 32-bit units */
674 	uint16_t	cmd_len;	/* # of 32-bit words in cmd	*/
675 	uint16_t	rulenum;	/* rule number			*/
676 	uint8_t		set;		/* rule set (0..31)		*/
677 	uint8_t		_pad;		/* padding			*/
678 	uint32_t	id;		/* rule id */
679 
680 	/* These fields are present in all rules.			*/
681 	uint64_t	pcnt;		/* Packet counter		*/
682 	uint64_t	bcnt;		/* Byte counter			*/
683 	uint32_t	timestamp;	/* tv_sec of last match		*/
684 
685 	ipfw_insn	cmd[1];		/* storage for commands		*/
686 };
687 #endif
688 
689 #define ACTION_PTR(rule)				\
690 	(ipfw_insn *)( (u_int32_t *)((rule)->cmd) + ((rule)->act_ofs) )
691 
692 #define RULESIZE(rule)  (sizeof(*(rule)) + (rule)->cmd_len * 4 - 4)
693 
694 #if 1 // should be moved to in.h
695 /*
696  * This structure is used as a flow mask and a flow id for various
697  * parts of the code.
698  * addr_type is used in userland and kernel to mark the address type.
699  * fib is used in the kernel to record the fib in use.
700  * _flags is used in the kernel to store tcp flags for dynamic rules.
701  */
702 struct ipfw_flow_id {
703 	uint32_t	dst_ip;
704 	uint32_t	src_ip;
705 	uint16_t	dst_port;
706 	uint16_t	src_port;
707 	uint8_t		fib;	/* XXX: must be uint16_t */
708 	uint8_t		proto;
709 	uint8_t		_flags;	/* protocol-specific flags */
710 	uint8_t		addr_type; /* 4=ip4, 6=ip6, 1=ether ? */
711 	struct in6_addr dst_ip6;
712 	struct in6_addr src_ip6;
713 	uint32_t	flow_id6;
714 	uint32_t	extra; /* queue/pipe or frag_id */
715 };
716 #endif
717 
718 #define	IS_IP4_FLOW_ID(id)	((id)->addr_type == 4)
719 #define IS_IP6_FLOW_ID(id)	((id)->addr_type == 6)
720 
721 /*
722  * Dynamic ipfw rule.
723  */
724 typedef struct _ipfw_dyn_rule ipfw_dyn_rule;
725 
726 struct _ipfw_dyn_rule {
727 	ipfw_dyn_rule	*next;		/* linked list of rules.	*/
728 	struct ip_fw *rule;		/* pointer to rule		*/
729 	/* 'rule' is used to pass up the rule number (from the parent)	*/
730 
731 	ipfw_dyn_rule *parent;		/* pointer to parent rule	*/
732 	u_int64_t	pcnt;		/* packet match counter		*/
733 	u_int64_t	bcnt;		/* byte match counter		*/
734 	struct ipfw_flow_id id;		/* (masked) flow id		*/
735 	u_int32_t	expire;		/* expire time			*/
736 	u_int32_t	bucket;		/* which bucket in hash table	*/
737 	u_int32_t	state;		/* state of this rule (typically a
738 					 * combination of TCP flags)
739 					 */
740 #define	IPFW_DYN_ORPHANED	0x40000	/* state's parent rule was deleted */
741 	u_int32_t	ack_fwd;	/* most recent ACKs in forward	*/
742 	u_int32_t	ack_rev;	/* and reverse directions (used	*/
743 					/* to generate keepalives)	*/
744 	u_int16_t	dyn_type;	/* rule type			*/
745 	u_int16_t	count;		/* refcount			*/
746 	u_int16_t	kidx;		/* index of named object */
747 } __packed __aligned(8);
748 
749 /*
750  * Definitions for IP option names.
751  */
752 #define	IP_FW_IPOPT_LSRR	0x01
753 #define	IP_FW_IPOPT_SSRR	0x02
754 #define	IP_FW_IPOPT_RR		0x04
755 #define	IP_FW_IPOPT_TS		0x08
756 
757 /*
758  * Definitions for TCP option names.
759  */
760 #define	IP_FW_TCPOPT_MSS	0x01
761 #define	IP_FW_TCPOPT_WINDOW	0x02
762 #define	IP_FW_TCPOPT_SACK	0x04
763 #define	IP_FW_TCPOPT_TS		0x08
764 #define	IP_FW_TCPOPT_CC		0x10
765 
766 #define	ICMP_REJECT_RST		0x100	/* fake ICMP code (send a TCP RST) */
767 #define	ICMP6_UNREACH_RST	0x100	/* fake ICMPv6 code (send a TCP RST) */
768 #define	ICMP_REJECT_ABORT	0x101	/* fake ICMP code (send an SCTP ABORT) */
769 #define	ICMP6_UNREACH_ABORT	0x101	/* fake ICMPv6 code (send an SCTP ABORT) */
770 
771 /*
772  * These are used for lookup tables.
773  */
774 
775 #define	IPFW_TABLE_ADDR		1	/* Table for holding IPv4/IPv6 prefixes */
776 #define	IPFW_TABLE_INTERFACE	2	/* Table for holding interface names */
777 #define	IPFW_TABLE_NUMBER	3	/* Table for holding ports/uid/gid/etc */
778 #define	IPFW_TABLE_FLOW		4	/* Table for holding flow data */
779 #define	IPFW_TABLE_MAC		5	/* Table for holding mac address prefixes */
780 #define	IPFW_TABLE_MAXTYPE	5	/* Maximum valid number */
781 
782 #define	IPFW_TABLE_CIDR	IPFW_TABLE_ADDR	/* compat */
783 
784 /* Value types */
785 #define	IPFW_VTYPE_LEGACY	0xFFFFFFFF	/* All data is filled in */
786 #define	IPFW_VTYPE_SKIPTO	0x00000001	/* skipto/call/callreturn */
787 #define	IPFW_VTYPE_PIPE		0x00000002	/* pipe/queue */
788 #define	IPFW_VTYPE_FIB		0x00000004	/* setfib */
789 #define	IPFW_VTYPE_NAT		0x00000008	/* nat */
790 #define	IPFW_VTYPE_DSCP		0x00000010	/* dscp */
791 #define	IPFW_VTYPE_TAG		0x00000020	/* tag/untag */
792 #define	IPFW_VTYPE_DIVERT	0x00000040	/* divert/tee */
793 #define	IPFW_VTYPE_NETGRAPH	0x00000080	/* netgraph/ngtee */
794 #define	IPFW_VTYPE_LIMIT	0x00000100	/* limit */
795 #define	IPFW_VTYPE_NH4		0x00000200	/* IPv4 nexthop */
796 #define	IPFW_VTYPE_NH6		0x00000400	/* IPv6 nexthop */
797 #define	IPFW_VTYPE_MARK		0x00000800	/* [fw]mark */
798 
799 /* MAC/InfiniBand/etc address length */
800 #define	IPFW_MAX_L2_ADDR_LEN	20
801 
802 typedef struct	_ipfw_table_entry {
803 	in_addr_t	addr;		/* network address		*/
804 	u_int32_t	value;		/* value			*/
805 	u_int16_t	tbl;		/* table number			*/
806 	u_int8_t	masklen;	/* mask length			*/
807 } ipfw_table_entry;
808 
809 typedef struct	_ipfw_table_xentry {
810 	uint16_t	len;		/* Total entry length		*/
811 	uint8_t		type;		/* entry type			*/
812 	uint8_t		masklen;	/* mask length			*/
813 	uint16_t	tbl;		/* table number			*/
814 	uint16_t	flags;		/* record flags			*/
815 	uint32_t	value;		/* value			*/
816 	union {
817 		/* Longest field needs to be aligned by 4-byte boundary	*/
818 		struct in6_addr	addr6;	/* IPv6 address 		*/
819 		char	iface[IF_NAMESIZE];	/* interface name	*/
820 	} k;
821 } ipfw_table_xentry;
822 #define	IPFW_TCF_INET	0x01		/* CIDR flags: IPv4 record	*/
823 
824 typedef struct	_ipfw_table {
825 	u_int32_t	size;		/* size of entries in bytes	*/
826 	u_int32_t	cnt;		/* # of entries			*/
827 	u_int16_t	tbl;		/* table number			*/
828 	ipfw_table_entry ent[0];	/* entries			*/
829 } ipfw_table;
830 
831 typedef struct	_ipfw_xtable {
832 	ip_fw3_opheader	opheader;	/* IP_FW3 opcode */
833 	uint32_t	size;		/* size of entries in bytes	*/
834 	uint32_t	cnt;		/* # of entries			*/
835 	uint16_t	tbl;		/* table number			*/
836 	uint8_t		type;		/* table type			*/
837 	ipfw_table_xentry xent[0];	/* entries			*/
838 } ipfw_xtable;
839 
840 typedef struct  _ipfw_obj_tlv {
841 	uint16_t        type;		/* TLV type */
842 	uint16_t	flags;		/* TLV-specific flags		*/
843 	uint32_t        length;		/* Total length, aligned to u64	*/
844 } ipfw_obj_tlv;
845 #define	IPFW_TLV_TBL_NAME	1
846 #define	IPFW_TLV_TBLNAME_LIST	2
847 #define	IPFW_TLV_RULE_LIST	3
848 #define	IPFW_TLV_DYNSTATE_LIST	4
849 #define	IPFW_TLV_TBL_ENT	5
850 #define	IPFW_TLV_DYN_ENT	6
851 #define	IPFW_TLV_RULE_ENT	7
852 #define	IPFW_TLV_TBLENT_LIST	8
853 #define	IPFW_TLV_RANGE		9
854 #define	IPFW_TLV_EACTION	10
855 #define	IPFW_TLV_COUNTERS	11
856 #define	IPFW_TLV_OBJDATA	12
857 #define	IPFW_TLV_STATE_NAME	14
858 
859 #define	IPFW_TLV_EACTION_BASE	1000
860 #define	IPFW_TLV_EACTION_NAME(arg)	(IPFW_TLV_EACTION_BASE + (arg))
861 
862 typedef struct _ipfw_obj_data {
863 	ipfw_obj_tlv	head;
864 	void		*data[0];
865 } ipfw_obj_data;
866 
867 /* Object name TLV */
868 typedef struct _ipfw_obj_ntlv {
869 	ipfw_obj_tlv	head;		/* TLV header			*/
870 	uint16_t	idx;		/* Name index			*/
871 	uint8_t		set;		/* set, if applicable		*/
872 	uint8_t		type;		/* object type, if applicable	*/
873 	uint32_t	spare;		/* unused			*/
874 	char		name[64];	/* Null-terminated name		*/
875 } ipfw_obj_ntlv;
876 
877 /* IPv4/IPv6 L4 flow description */
878 struct tflow_entry {
879 	uint8_t		af;
880 	uint8_t		proto;
881 	uint16_t	spare;
882 	uint16_t	sport;
883 	uint16_t	dport;
884 	union {
885 		struct {
886 			struct in_addr	sip;
887 			struct in_addr	dip;
888 		} a4;
889 		struct {
890 			struct in6_addr	sip6;
891 			struct in6_addr	dip6;
892 		} a6;
893 	} a;
894 };
895 
896 /* 64-byte structure representing multi-field table value */
897 typedef struct _ipfw_table_value {
898 	uint32_t	tag;		/* O_TAG/O_TAGGED */
899 	uint32_t	pipe;		/* O_PIPE/O_QUEUE */
900 	uint16_t	divert;		/* O_DIVERT/O_TEE */
901 	uint16_t	skipto;		/* skipto, CALLRET */
902 	uint32_t	netgraph;	/* O_NETGRAPH/O_NGTEE */
903 	uint32_t	fib;		/* O_SETFIB */
904 	uint32_t	nat;		/* O_NAT */
905 	uint32_t	nh4;
906 	uint8_t		dscp;
907 	uint8_t		spare0;
908 	uint16_t	kidx;		/* value kernel index */
909 	struct in6_addr	nh6;
910 	uint32_t	limit;		/* O_LIMIT */
911 	uint32_t	zoneid;		/* scope zone id for nh6 */
912 	uint32_t	mark;		/* O_SETMARK/O_MARK */
913 	uint32_t	refcnt;		/* XXX 64-bit in kernel */
914 } ipfw_table_value;
915 
916 /* Table entry TLV */
917 typedef struct	_ipfw_obj_tentry {
918 	ipfw_obj_tlv	head;		/* TLV header			*/
919 	uint8_t		subtype;	/* subtype (IPv4,IPv6)		*/
920 	uint8_t		masklen;	/* mask length			*/
921 	uint8_t		result;		/* request result		*/
922 	uint8_t		spare0;
923 	uint16_t	idx;		/* Table name index		*/
924 	uint16_t	spare1;
925 	union {
926 		/* Longest field needs to be aligned by 8-byte boundary	*/
927 		struct in_addr		addr;		/* IPv4 address		*/
928 		uint32_t		key;		/* uid/gid/port		*/
929 		struct in6_addr		addr6;		/* IPv6 address 	*/
930 		char	iface[IF_NAMESIZE];		/* interface name	*/
931 		u_char	mac[IPFW_MAX_L2_ADDR_LEN];	/* MAC address		*/
932 		struct tflow_entry	flow;
933 	} k;
934 	union {
935 		ipfw_table_value	value;	/* value data */
936 		uint32_t		kidx;	/* value kernel index */
937 	} v;
938 } ipfw_obj_tentry;
939 #define	IPFW_TF_UPDATE	0x01		/* Update record if exists	*/
940 /* Container TLV */
941 #define	IPFW_CTF_ATOMIC	0x01		/* Perform atomic operation	*/
942 /* Operation results */
943 #define	IPFW_TR_IGNORED		0	/* Entry was ignored (rollback)	*/
944 #define	IPFW_TR_ADDED		1	/* Entry was successfully added	*/
945 #define	IPFW_TR_UPDATED		2	/* Entry was successfully updated*/
946 #define	IPFW_TR_DELETED		3	/* Entry was successfully deleted*/
947 #define	IPFW_TR_LIMIT		4	/* Entry was ignored (limit)	*/
948 #define	IPFW_TR_NOTFOUND	5	/* Entry was not found		*/
949 #define	IPFW_TR_EXISTS		6	/* Entry already exists		*/
950 #define	IPFW_TR_ERROR		7	/* Request has failed (unknown)	*/
951 
952 typedef struct _ipfw_obj_dyntlv {
953 	ipfw_obj_tlv	head;
954 	ipfw_dyn_rule	state;
955 } ipfw_obj_dyntlv;
956 #define	IPFW_DF_LAST	0x01		/* Last state in chain		*/
957 
958 /* Containter TLVs */
959 typedef struct _ipfw_obj_ctlv {
960 	ipfw_obj_tlv	head;		/* TLV header			*/
961 	uint32_t	count;		/* Number of sub-TLVs		*/
962 	uint16_t	objsize;	/* Single object size		*/
963 	uint8_t		version;	/* TLV version			*/
964 	uint8_t		flags;		/* TLV-specific flags		*/
965 } ipfw_obj_ctlv;
966 
967 /* Range TLV */
968 typedef struct _ipfw_range_tlv {
969 	ipfw_obj_tlv	head;		/* TLV header			*/
970 	uint32_t	flags;		/* Range flags			*/
971 	uint16_t	start_rule;	/* Range start			*/
972 	uint16_t	end_rule;	/* Range end			*/
973 	uint32_t	set;		/* Range set to match		 */
974 	uint32_t	new_set;	/* New set to move/swap to	*/
975 } ipfw_range_tlv;
976 #define	IPFW_RCFLAG_RANGE	0x01	/* rule range is set		*/
977 #define	IPFW_RCFLAG_ALL		0x02	/* match ALL rules		*/
978 #define	IPFW_RCFLAG_SET		0x04	/* match rules in given set	*/
979 #define	IPFW_RCFLAG_DYNAMIC	0x08	/* match only dynamic states	*/
980 /* User-settable flags */
981 #define	IPFW_RCFLAG_USER	(IPFW_RCFLAG_RANGE | IPFW_RCFLAG_ALL | \
982 	IPFW_RCFLAG_SET | IPFW_RCFLAG_DYNAMIC)
983 /* Internally used flags */
984 #define	IPFW_RCFLAG_DEFAULT	0x0100	/* Do not skip defaul rule	*/
985 
986 typedef struct _ipfw_ta_tinfo {
987 	uint32_t	flags;		/* Format flags			*/
988 	uint32_t	spare;
989 	uint8_t		taclass4;	/* algorithm class		*/
990 	uint8_t		spare4;
991 	uint16_t	itemsize4;	/* item size in runtime		*/
992 	uint32_t	size4;		/* runtime structure size	*/
993 	uint32_t	count4;		/* number of items in runtime	*/
994 	uint8_t		taclass6;	/* algorithm class		*/
995 	uint8_t		spare6;
996 	uint16_t	itemsize6;	/* item size in runtime		*/
997 	uint32_t	size6;		/* runtime structure size	*/
998 	uint32_t	count6;		/* number of items in runtime	*/
999 } ipfw_ta_tinfo;
1000 #define	IPFW_TACLASS_HASH	1	/* algo is based on hash	*/
1001 #define	IPFW_TACLASS_ARRAY	2	/* algo is based on array	*/
1002 #define	IPFW_TACLASS_RADIX	3	/* algo is based on radix tree	*/
1003 
1004 #define	IPFW_TATFLAGS_DATA	0x0001		/* Has data filled in	*/
1005 #define	IPFW_TATFLAGS_AFDATA	0x0002		/* Separate data per AF	*/
1006 #define	IPFW_TATFLAGS_AFITEM	0x0004		/* diff. items per AF	*/
1007 
1008 typedef struct _ipfw_xtable_info {
1009 	uint8_t		type;		/* table type (addr,iface,..)	*/
1010 	uint8_t		tflags;		/* type flags			*/
1011 	uint16_t	mflags;		/* modification flags		*/
1012 	uint16_t	flags;		/* generic table flags		*/
1013 	uint16_t	spare[3];
1014 	uint32_t	vmask;		/* bitmask with value types 	*/
1015 	uint32_t	set;		/* set table is in		*/
1016 	uint32_t	kidx;		/* kernel index			*/
1017 	uint32_t	refcnt;		/* number of references		*/
1018 	uint32_t	count;		/* Number of records		*/
1019 	uint32_t	size;		/* Total size of records(export)*/
1020 	uint32_t	limit;		/* Max number of records	*/
1021 	char		tablename[64];	/* table name */
1022 	char		algoname[64];	/* algorithm name		*/
1023 	ipfw_ta_tinfo	ta_info;	/* additional algo stats	*/
1024 } ipfw_xtable_info;
1025 /* Generic table flags */
1026 #define	IPFW_TGFLAGS_LOCKED	0x01	/* Tables is locked from changes*/
1027 /* Table type-specific flags */
1028 #define	IPFW_TFFLAG_SRCIP	0x01
1029 #define	IPFW_TFFLAG_DSTIP	0x02
1030 #define	IPFW_TFFLAG_SRCPORT	0x04
1031 #define	IPFW_TFFLAG_DSTPORT	0x08
1032 #define	IPFW_TFFLAG_PROTO	0x10
1033 /* Table modification flags */
1034 #define	IPFW_TMFLAGS_LIMIT	0x0002	/* Change limit value		*/
1035 #define	IPFW_TMFLAGS_LOCK	0x0004	/* Change table lock state	*/
1036 
1037 typedef struct _ipfw_iface_info {
1038 	char		ifname[64];	/* interface name		*/
1039 	uint32_t	ifindex;	/* interface index		*/
1040 	uint32_t	flags;		/* flags			*/
1041 	uint32_t	refcnt;		/* number of references		*/
1042 	uint32_t	gencnt;		/* number of changes		*/
1043 	uint64_t	spare;
1044 } ipfw_iface_info;
1045 #define	IPFW_IFFLAG_RESOLVED	0x01	/* Interface exists		*/
1046 
1047 typedef struct _ipfw_ta_info {
1048 	char		algoname[64];	/* algorithm name		*/
1049 	uint32_t	type;		/* lookup type			*/
1050 	uint32_t	flags;
1051 	uint32_t	refcnt;
1052 	uint32_t	spare0;
1053 	uint64_t	spare1;
1054 } ipfw_ta_info;
1055 
1056 typedef struct _ipfw_obj_header {
1057 	ip_fw3_opheader	opheader;	/* IP_FW3 opcode		*/
1058 	uint32_t	spare;
1059 	uint16_t	idx;		/* object name index		*/
1060 	uint8_t		objtype;	/* object type			*/
1061 	uint8_t		objsubtype;	/* object subtype		*/
1062 	ipfw_obj_ntlv	ntlv;		/* object name tlv		*/
1063 } ipfw_obj_header;
1064 
1065 typedef struct _ipfw_obj_lheader {
1066 	ip_fw3_opheader	opheader;	/* IP_FW3 opcode		*/
1067 	uint32_t	set_mask;	/* disabled set mask		*/
1068 	uint32_t	count;		/* Total objects count		*/
1069 	uint32_t	size;		/* Total size (incl. header)	*/
1070 	uint32_t	objsize;	/* Size of one object		*/
1071 } ipfw_obj_lheader;
1072 
1073 #define	IPFW_CFG_GET_STATIC	0x01
1074 #define	IPFW_CFG_GET_STATES	0x02
1075 #define	IPFW_CFG_GET_COUNTERS	0x04
1076 typedef struct _ipfw_cfg_lheader {
1077 	ip_fw3_opheader	opheader;	/* IP_FW3 opcode		*/
1078 	uint32_t	set_mask;	/* enabled set mask		*/
1079 	uint32_t	spare;
1080 	uint32_t	flags;		/* Request flags		*/
1081 	uint32_t	size;		/* neded buffer size		*/
1082 	uint32_t	start_rule;
1083 	uint32_t	end_rule;
1084 } ipfw_cfg_lheader;
1085 
1086 typedef struct _ipfw_range_header {
1087 	ip_fw3_opheader	opheader;	/* IP_FW3 opcode		*/
1088 	ipfw_range_tlv	range;
1089 } ipfw_range_header;
1090 
1091 typedef struct _ipfw_sopt_info {
1092 	uint16_t	opcode;
1093 	uint8_t		version;
1094 	uint8_t		dir;
1095 	uint8_t		spare;
1096 	uint64_t	refcnt;
1097 } ipfw_sopt_info;
1098 
1099 #endif /* _IPFW2_H */
1100