xref: /freebsd/sys/netpfil/pf/pf.h (revision a0409676120c1e558d0ade943019934e0f15118d)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2001 Daniel Hartmeier
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  *    - Redistributions of source code must retain the above copyright
12  *      notice, this list of conditions and the following disclaimer.
13  *    - Redistributions in binary form must reproduce the above
14  *      copyright notice, this list of conditions and the following
15  *      disclaimer in the documentation and/or other materials provided
16  *      with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
22  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
24  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
28  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  *
31  *	$OpenBSD: pfvar.h,v 1.282 2009/01/29 15:12:28 pyr Exp $
32  *	$FreeBSD$
33  */
34 
35 #ifndef	_NET_PF_H_
36 #define	_NET_PF_H_
37 
38 #include <sys/tree.h>
39 
40 #define	PF_TCPS_PROXY_SRC	((TCP_NSTATES)+0)
41 #define	PF_TCPS_PROXY_DST	((TCP_NSTATES)+1)
42 
43 #define	PF_MD5_DIGEST_LENGTH	16
44 #ifdef MD5_DIGEST_LENGTH
45 #if PF_MD5_DIGEST_LENGTH != MD5_DIGEST_LENGTH
46 #error
47 #endif
48 #endif
49 
50 enum	{ PF_INOUT, PF_IN, PF_OUT };
51 enum	{ PF_PASS, PF_DROP, PF_SCRUB, PF_NOSCRUB, PF_NAT, PF_NONAT,
52 	  PF_BINAT, PF_NOBINAT, PF_RDR, PF_NORDR, PF_SYNPROXY_DROP, PF_DEFER };
53 enum	{ PF_RULESET_SCRUB, PF_RULESET_FILTER, PF_RULESET_NAT,
54 	  PF_RULESET_BINAT, PF_RULESET_RDR, PF_RULESET_MAX };
55 enum	{ PF_OP_NONE, PF_OP_IRG, PF_OP_EQ, PF_OP_NE, PF_OP_LT,
56 	  PF_OP_LE, PF_OP_GT, PF_OP_GE, PF_OP_XRG, PF_OP_RRG };
57 enum	{ PF_DEBUG_NONE, PF_DEBUG_URGENT, PF_DEBUG_MISC, PF_DEBUG_NOISY };
58 enum	{ PF_CHANGE_NONE, PF_CHANGE_ADD_HEAD, PF_CHANGE_ADD_TAIL,
59 	  PF_CHANGE_ADD_BEFORE, PF_CHANGE_ADD_AFTER,
60 	  PF_CHANGE_REMOVE, PF_CHANGE_GET_TICKET };
61 enum	{ PF_GET_NONE, PF_GET_CLR_CNTR };
62 enum	{ PF_SK_WIRE, PF_SK_STACK, PF_SK_BOTH };
63 
64 /*
65  * Note about PFTM_*: real indices into pf_rule.timeout[] come before
66  * PFTM_MAX, special cases afterwards. See pf_state_expires().
67  */
68 enum	{ PFTM_TCP_FIRST_PACKET, PFTM_TCP_OPENING, PFTM_TCP_ESTABLISHED,
69 	  PFTM_TCP_CLOSING, PFTM_TCP_FIN_WAIT, PFTM_TCP_CLOSED,
70 	  PFTM_UDP_FIRST_PACKET, PFTM_UDP_SINGLE, PFTM_UDP_MULTIPLE,
71 	  PFTM_ICMP_FIRST_PACKET, PFTM_ICMP_ERROR_REPLY,
72 	  PFTM_OTHER_FIRST_PACKET, PFTM_OTHER_SINGLE,
73 	  PFTM_OTHER_MULTIPLE, PFTM_FRAG, PFTM_INTERVAL,
74 	  PFTM_ADAPTIVE_START, PFTM_ADAPTIVE_END, PFTM_SRC_NODE,
75 	  PFTM_TS_DIFF, PFTM_MAX, PFTM_PURGE, PFTM_UNLINKED };
76 
77 /* PFTM default values */
78 #define PFTM_TCP_FIRST_PACKET_VAL	120	/* First TCP packet */
79 #define PFTM_TCP_OPENING_VAL		30	/* No response yet */
80 #define PFTM_TCP_ESTABLISHED_VAL	24*60*60/* Established */
81 #define PFTM_TCP_CLOSING_VAL		15 * 60	/* Half closed */
82 #define PFTM_TCP_FIN_WAIT_VAL		45	/* Got both FINs */
83 #define PFTM_TCP_CLOSED_VAL		90	/* Got a RST */
84 #define PFTM_UDP_FIRST_PACKET_VAL	60	/* First UDP packet */
85 #define PFTM_UDP_SINGLE_VAL		30	/* Unidirectional */
86 #define PFTM_UDP_MULTIPLE_VAL		60	/* Bidirectional */
87 #define PFTM_ICMP_FIRST_PACKET_VAL	20	/* First ICMP packet */
88 #define PFTM_ICMP_ERROR_REPLY_VAL	10	/* Got error response */
89 #define PFTM_OTHER_FIRST_PACKET_VAL	60	/* First packet */
90 #define PFTM_OTHER_SINGLE_VAL		30	/* Unidirectional */
91 #define PFTM_OTHER_MULTIPLE_VAL		60	/* Bidirectional */
92 #define PFTM_FRAG_VAL			30	/* Fragment expire */
93 #define PFTM_INTERVAL_VAL		10	/* Expire interval */
94 #define PFTM_SRC_NODE_VAL		0	/* Source tracking */
95 #define PFTM_TS_DIFF_VAL		30	/* Allowed TS diff */
96 
97 enum	{ PF_NOPFROUTE, PF_FASTROUTE, PF_ROUTETO, PF_DUPTO, PF_REPLYTO };
98 enum	{ PF_LIMIT_STATES, PF_LIMIT_SRC_NODES, PF_LIMIT_FRAGS,
99 	  PF_LIMIT_TABLE_ENTRIES, PF_LIMIT_MAX };
100 #define PF_POOL_IDMASK		0x0f
101 enum	{ PF_POOL_NONE, PF_POOL_BITMASK, PF_POOL_RANDOM,
102 	  PF_POOL_SRCHASH, PF_POOL_ROUNDROBIN };
103 enum	{ PF_ADDR_ADDRMASK, PF_ADDR_NOROUTE, PF_ADDR_DYNIFTL,
104 	  PF_ADDR_TABLE, PF_ADDR_URPFFAILED,
105 	  PF_ADDR_RANGE };
106 #define PF_POOL_TYPEMASK	0x0f
107 #define PF_POOL_STICKYADDR	0x20
108 #define	PF_WSCALE_FLAG		0x80
109 #define	PF_WSCALE_MASK		0x0f
110 
111 #define	PF_LOG			0x01
112 #define	PF_LOG_ALL		0x02
113 #define	PF_LOG_SOCKET_LOOKUP	0x04
114 
115 /* Reasons code for passing/dropping a packet */
116 #define PFRES_MATCH	0		/* Explicit match of a rule */
117 #define PFRES_BADOFF	1		/* Bad offset for pull_hdr */
118 #define PFRES_FRAG	2		/* Dropping following fragment */
119 #define PFRES_SHORT	3		/* Dropping short packet */
120 #define PFRES_NORM	4		/* Dropping by normalizer */
121 #define PFRES_MEMORY	5		/* Dropped due to lacking mem */
122 #define PFRES_TS	6		/* Bad TCP Timestamp (RFC1323) */
123 #define PFRES_CONGEST	7		/* Congestion (of ipintrq) */
124 #define PFRES_IPOPTIONS 8		/* IP option */
125 #define PFRES_PROTCKSUM 9		/* Protocol checksum invalid */
126 #define PFRES_BADSTATE	10		/* State mismatch */
127 #define PFRES_STATEINS	11		/* State insertion failure */
128 #define PFRES_MAXSTATES	12		/* State limit */
129 #define PFRES_SRCLIMIT	13		/* Source node/conn limit */
130 #define PFRES_SYNPROXY	14		/* SYN proxy */
131 #define PFRES_MAPFAILED	15		/* pf_map_addr() failed */
132 #define PFRES_MAX	16		/* total+1 */
133 
134 #define PFRES_NAMES { \
135 	"match", \
136 	"bad-offset", \
137 	"fragment", \
138 	"short", \
139 	"normalize", \
140 	"memory", \
141 	"bad-timestamp", \
142 	"congestion", \
143 	"ip-option", \
144 	"proto-cksum", \
145 	"state-mismatch", \
146 	"state-insert", \
147 	"state-limit", \
148 	"src-limit", \
149 	"synproxy", \
150 	"map-failed", \
151 	NULL \
152 }
153 
154 /* Counters for other things we want to keep track of */
155 #define LCNT_STATES		0	/* states */
156 #define LCNT_SRCSTATES		1	/* max-src-states */
157 #define LCNT_SRCNODES		2	/* max-src-nodes */
158 #define LCNT_SRCCONN		3	/* max-src-conn */
159 #define LCNT_SRCCONNRATE	4	/* max-src-conn-rate */
160 #define LCNT_OVERLOAD_TABLE	5	/* entry added to overload table */
161 #define LCNT_OVERLOAD_FLUSH	6	/* state entries flushed */
162 #define LCNT_MAX		7	/* total+1 */
163 
164 #define LCNT_NAMES { \
165 	"max states per rule", \
166 	"max-src-states", \
167 	"max-src-nodes", \
168 	"max-src-conn", \
169 	"max-src-conn-rate", \
170 	"overload table insertion", \
171 	"overload flush states", \
172 	NULL \
173 }
174 
175 /* state operation counters */
176 #define FCNT_STATE_SEARCH	0
177 #define FCNT_STATE_INSERT	1
178 #define FCNT_STATE_REMOVALS	2
179 #define FCNT_MAX		3
180 
181 /* src_node operation counters */
182 #define SCNT_SRC_NODE_SEARCH	0
183 #define SCNT_SRC_NODE_INSERT	1
184 #define SCNT_SRC_NODE_REMOVALS	2
185 #define SCNT_MAX		3
186 
187 #define	PF_TABLE_NAME_SIZE	32
188 #define	PF_QNAME_SIZE		64
189 
190 struct pf_rule;
191 
192 /* keep synced with pfi_kif, used in RB_FIND */
193 struct pfi_kif_cmp {
194 	char				 pfik_name[IFNAMSIZ];
195 };
196 
197 struct pfi_kif {
198 	char				 pfik_name[IFNAMSIZ];
199 	union {
200 		RB_ENTRY(pfi_kif)	 _pfik_tree;
201 		LIST_ENTRY(pfi_kif)	 _pfik_list;
202 	} _pfik_glue;
203 #define	pfik_tree	_pfik_glue._pfik_tree
204 #define	pfik_list	_pfik_glue._pfik_list
205 	u_int64_t			 pfik_packets[2][2][2];
206 	u_int64_t			 pfik_bytes[2][2][2];
207 	u_int32_t			 pfik_tzero;
208 	u_int				 pfik_flags;
209 	struct ifnet			*pfik_ifp;
210 	struct ifg_group		*pfik_group;
211 	u_int				 pfik_rulerefs;
212 	TAILQ_HEAD(, pfi_dynaddr)	 pfik_dynaddrs;
213 };
214 
215 struct pf_status {
216 	uint64_t	counters[PFRES_MAX];
217 	uint64_t	lcounters[LCNT_MAX];
218 	uint64_t	fcounters[FCNT_MAX];
219 	uint64_t	scounters[SCNT_MAX];
220 	uint64_t	pcounters[2][2][3];
221 	uint64_t	bcounters[2][2];
222 	uint32_t	running;
223 	uint32_t	states;
224 	uint32_t	src_nodes;
225 	uint32_t	since;
226 	uint32_t	debug;
227 	uint32_t	hostid;
228 	char		ifname[IFNAMSIZ];
229 	uint8_t		pf_chksum[PF_MD5_DIGEST_LENGTH];
230 };
231 
232 struct pf_addr {
233 	union {
234 		struct in_addr		v4;
235 		struct in6_addr		v6;
236 		u_int8_t		addr8[16];
237 		u_int16_t		addr16[8];
238 		u_int32_t		addr32[4];
239 	} pfa;		    /* 128-bit address */
240 #define v4	pfa.v4
241 #define v6	pfa.v6
242 #define addr8	pfa.addr8
243 #define addr16	pfa.addr16
244 #define addr32	pfa.addr32
245 };
246 
247 #define PFI_AFLAG_NETWORK	0x01
248 #define PFI_AFLAG_BROADCAST	0x02
249 #define PFI_AFLAG_PEER		0x04
250 #define PFI_AFLAG_MODEMASK	0x07
251 #define PFI_AFLAG_NOALIAS	0x08
252 
253 struct pf_addr_wrap {
254 	union {
255 		struct {
256 			struct pf_addr		 addr;
257 			struct pf_addr		 mask;
258 		}			 a;
259 		char			 ifname[IFNAMSIZ];
260 		char			 tblname[PF_TABLE_NAME_SIZE];
261 	}			 v;
262 	union {
263 		struct pfi_dynaddr	*dyn;
264 		struct pfr_ktable	*tbl;
265 		int			 dyncnt;
266 		int			 tblcnt;
267 	}			 p;
268 	u_int8_t		 type;		/* PF_ADDR_* */
269 	u_int8_t		 iflags;	/* PFI_AFLAG_* */
270 };
271 
272 union pf_rule_ptr {
273 	struct pf_rule		*ptr;
274 	u_int32_t		 nr;
275 };
276 
277 struct pf_rule_uid {
278 	uid_t		 uid[2];
279 	u_int8_t	 op;
280 };
281 
282 struct pf_rule_gid {
283 	uid_t		 gid[2];
284 	u_int8_t	 op;
285 };
286 
287 struct pf_rule_addr {
288 	struct pf_addr_wrap	 addr;
289 	u_int16_t		 port[2];
290 	u_int8_t		 neg;
291 	u_int8_t		 port_op;
292 };
293 
294 struct pf_pooladdr {
295 	struct pf_addr_wrap		 addr;
296 	TAILQ_ENTRY(pf_pooladdr)	 entries;
297 	char				 ifname[IFNAMSIZ];
298 	struct pfi_kif			*kif;
299 };
300 
301 TAILQ_HEAD(pf_palist, pf_pooladdr);
302 
303 struct pf_poolhashkey {
304 	union {
305 		u_int8_t		key8[16];
306 		u_int16_t		key16[8];
307 		u_int32_t		key32[4];
308 	} pfk;		    /* 128-bit hash key */
309 #define key8	pfk.key8
310 #define key16	pfk.key16
311 #define key32	pfk.key32
312 };
313 
314 struct pf_pool {
315 	struct pf_palist	 list;
316 	struct pf_pooladdr	*cur;
317 	struct pf_poolhashkey	 key;
318 	struct pf_addr		 counter;
319 	int			 tblidx;
320 	u_int16_t		 proxy_port[2];
321 	u_int8_t		 opts;
322 };
323 
324 /* A packed Operating System description for fingerprinting */
325 typedef u_int32_t pf_osfp_t;
326 #define PF_OSFP_ANY	((pf_osfp_t)0)
327 #define PF_OSFP_UNKNOWN	((pf_osfp_t)-1)
328 #define PF_OSFP_NOMATCH	((pf_osfp_t)-2)
329 
330 struct pf_osfp_entry {
331 	SLIST_ENTRY(pf_osfp_entry) fp_entry;
332 	pf_osfp_t		fp_os;
333 	int			fp_enflags;
334 #define PF_OSFP_EXPANDED	0x001		/* expanded entry */
335 #define PF_OSFP_GENERIC		0x002		/* generic signature */
336 #define PF_OSFP_NODETAIL	0x004		/* no p0f details */
337 #define PF_OSFP_LEN	32
338 	char			fp_class_nm[PF_OSFP_LEN];
339 	char			fp_version_nm[PF_OSFP_LEN];
340 	char			fp_subtype_nm[PF_OSFP_LEN];
341 };
342 #define PF_OSFP_ENTRY_EQ(a, b) \
343     ((a)->fp_os == (b)->fp_os && \
344     memcmp((a)->fp_class_nm, (b)->fp_class_nm, PF_OSFP_LEN) == 0 && \
345     memcmp((a)->fp_version_nm, (b)->fp_version_nm, PF_OSFP_LEN) == 0 && \
346     memcmp((a)->fp_subtype_nm, (b)->fp_subtype_nm, PF_OSFP_LEN) == 0)
347 
348 /* handle pf_osfp_t packing */
349 #define _FP_RESERVED_BIT	1  /* For the special negative #defines */
350 #define _FP_UNUSED_BITS		1
351 #define _FP_CLASS_BITS		10 /* OS Class (Windows, Linux) */
352 #define _FP_VERSION_BITS	10 /* OS version (95, 98, NT, 2.4.54, 3.2) */
353 #define _FP_SUBTYPE_BITS	10 /* patch level (NT SP4, SP3, ECN patch) */
354 #define PF_OSFP_UNPACK(osfp, class, version, subtype) do { \
355 	(class) = ((osfp) >> (_FP_VERSION_BITS+_FP_SUBTYPE_BITS)) & \
356 	    ((1 << _FP_CLASS_BITS) - 1); \
357 	(version) = ((osfp) >> _FP_SUBTYPE_BITS) & \
358 	    ((1 << _FP_VERSION_BITS) - 1);\
359 	(subtype) = (osfp) & ((1 << _FP_SUBTYPE_BITS) - 1); \
360 } while(0)
361 #define PF_OSFP_PACK(osfp, class, version, subtype) do { \
362 	(osfp) = ((class) & ((1 << _FP_CLASS_BITS) - 1)) << (_FP_VERSION_BITS \
363 	    + _FP_SUBTYPE_BITS); \
364 	(osfp) |= ((version) & ((1 << _FP_VERSION_BITS) - 1)) << \
365 	    _FP_SUBTYPE_BITS; \
366 	(osfp) |= (subtype) & ((1 << _FP_SUBTYPE_BITS) - 1); \
367 } while(0)
368 
369 /* the fingerprint of an OSes TCP SYN packet */
370 typedef u_int64_t	pf_tcpopts_t;
371 struct pf_os_fingerprint {
372 	SLIST_HEAD(pf_osfp_enlist, pf_osfp_entry) fp_oses; /* list of matches */
373 	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
374 	u_int16_t		fp_wsize;	/* TCP window size */
375 	u_int16_t		fp_psize;	/* ip->ip_len */
376 	u_int16_t		fp_mss;		/* TCP MSS */
377 	u_int16_t		fp_flags;
378 #define PF_OSFP_WSIZE_MOD	0x0001		/* Window modulus */
379 #define PF_OSFP_WSIZE_DC	0x0002		/* Window don't care */
380 #define PF_OSFP_WSIZE_MSS	0x0004		/* Window multiple of MSS */
381 #define PF_OSFP_WSIZE_MTU	0x0008		/* Window multiple of MTU */
382 #define PF_OSFP_PSIZE_MOD	0x0010		/* packet size modulus */
383 #define PF_OSFP_PSIZE_DC	0x0020		/* packet size don't care */
384 #define PF_OSFP_WSCALE		0x0040		/* TCP window scaling */
385 #define PF_OSFP_WSCALE_MOD	0x0080		/* TCP window scale modulus */
386 #define PF_OSFP_WSCALE_DC	0x0100		/* TCP window scale dont-care */
387 #define PF_OSFP_MSS		0x0200		/* TCP MSS */
388 #define PF_OSFP_MSS_MOD		0x0400		/* TCP MSS modulus */
389 #define PF_OSFP_MSS_DC		0x0800		/* TCP MSS dont-care */
390 #define PF_OSFP_DF		0x1000		/* IPv4 don't fragment bit */
391 #define PF_OSFP_TS0		0x2000		/* Zero timestamp */
392 #define PF_OSFP_INET6		0x4000		/* IPv6 */
393 	u_int8_t		fp_optcnt;	/* TCP option count */
394 	u_int8_t		fp_wscale;	/* TCP window scaling */
395 	u_int8_t		fp_ttl;		/* IPv4 TTL */
396 #define PF_OSFP_MAXTTL_OFFSET	40
397 /* TCP options packing */
398 #define PF_OSFP_TCPOPT_NOP	0x0		/* TCP NOP option */
399 #define PF_OSFP_TCPOPT_WSCALE	0x1		/* TCP window scaling option */
400 #define PF_OSFP_TCPOPT_MSS	0x2		/* TCP max segment size opt */
401 #define PF_OSFP_TCPOPT_SACK	0x3		/* TCP SACK OK option */
402 #define PF_OSFP_TCPOPT_TS	0x4		/* TCP timestamp option */
403 #define PF_OSFP_TCPOPT_BITS	3		/* bits used by each option */
404 #define PF_OSFP_MAX_OPTS \
405     (sizeof(((struct pf_os_fingerprint *)0)->fp_tcpopts) * 8) \
406     / PF_OSFP_TCPOPT_BITS
407 
408 	SLIST_ENTRY(pf_os_fingerprint)	fp_next;
409 };
410 
411 struct pf_osfp_ioctl {
412 	struct pf_osfp_entry	fp_os;
413 	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
414 	u_int16_t		fp_wsize;	/* TCP window size */
415 	u_int16_t		fp_psize;	/* ip->ip_len */
416 	u_int16_t		fp_mss;		/* TCP MSS */
417 	u_int16_t		fp_flags;
418 	u_int8_t		fp_optcnt;	/* TCP option count */
419 	u_int8_t		fp_wscale;	/* TCP window scaling */
420 	u_int8_t		fp_ttl;		/* IPv4 TTL */
421 
422 	int			fp_getnum;	/* DIOCOSFPGET number */
423 };
424 
425 #define	PF_ANCHOR_NAME_SIZE	 64
426 
427 struct pf_rule {
428 	struct pf_rule_addr	 src;
429 	struct pf_rule_addr	 dst;
430 #define PF_SKIP_IFP		0
431 #define PF_SKIP_DIR		1
432 #define PF_SKIP_AF		2
433 #define PF_SKIP_PROTO		3
434 #define PF_SKIP_SRC_ADDR	4
435 #define PF_SKIP_SRC_PORT	5
436 #define PF_SKIP_DST_ADDR	6
437 #define PF_SKIP_DST_PORT	7
438 #define PF_SKIP_COUNT		8
439 	union pf_rule_ptr	 skip[PF_SKIP_COUNT];
440 #define PF_RULE_LABEL_SIZE	 64
441 	char			 label[PF_RULE_LABEL_SIZE];
442 	char			 ifname[IFNAMSIZ];
443 	char			 qname[PF_QNAME_SIZE];
444 	char			 pqname[PF_QNAME_SIZE];
445 #define	PF_TAG_NAME_SIZE	 64
446 	char			 tagname[PF_TAG_NAME_SIZE];
447 	char			 match_tagname[PF_TAG_NAME_SIZE];
448 
449 	char			 overload_tblname[PF_TABLE_NAME_SIZE];
450 
451 	TAILQ_ENTRY(pf_rule)	 entries;
452 	struct pf_pool		 rpool;
453 
454 	u_int64_t		 evaluations;
455 	u_int64_t		 packets[2];
456 	u_int64_t		 bytes[2];
457 
458 	struct pfi_kif		*kif;
459 	struct pf_anchor	*anchor;
460 	struct pfr_ktable	*overload_tbl;
461 
462 	pf_osfp_t		 os_fingerprint;
463 
464 	int			 rtableid;
465 	u_int32_t		 timeout[PFTM_MAX];
466 	u_int32_t		 max_states;
467 	u_int32_t		 max_src_nodes;
468 	u_int32_t		 max_src_states;
469 	u_int32_t		 max_src_conn;
470 	struct {
471 		u_int32_t		limit;
472 		u_int32_t		seconds;
473 	}			 max_src_conn_rate;
474 	u_int32_t		 qid;
475 	u_int32_t		 pqid;
476 	u_int32_t		 rt_listid;
477 	u_int32_t		 nr;
478 	u_int32_t		 prob;
479 	uid_t			 cuid;
480 	pid_t			 cpid;
481 
482 	counter_u64_t		 states_cur;
483 	counter_u64_t		 states_tot;
484 	counter_u64_t		 src_nodes;
485 
486 	u_int16_t		 return_icmp;
487 	u_int16_t		 return_icmp6;
488 	u_int16_t		 max_mss;
489 	u_int16_t		 tag;
490 	u_int16_t		 match_tag;
491 	u_int16_t		 scrub_flags;
492 
493 	struct pf_rule_uid	 uid;
494 	struct pf_rule_gid	 gid;
495 
496 	u_int32_t		 rule_flag;
497 	u_int8_t		 action;
498 	u_int8_t		 direction;
499 	u_int8_t		 log;
500 	u_int8_t		 logif;
501 	u_int8_t		 quick;
502 	u_int8_t		 ifnot;
503 	u_int8_t		 match_tag_not;
504 	u_int8_t		 natpass;
505 
506 #define PF_STATE_NORMAL		0x1
507 #define PF_STATE_MODULATE	0x2
508 #define PF_STATE_SYNPROXY	0x3
509 	u_int8_t		 keep_state;
510 	sa_family_t		 af;
511 	u_int8_t		 proto;
512 	u_int8_t		 type;
513 	u_int8_t		 code;
514 	u_int8_t		 flags;
515 	u_int8_t		 flagset;
516 	u_int8_t		 min_ttl;
517 	u_int8_t		 allow_opts;
518 	u_int8_t		 rt;
519 	u_int8_t		 return_ttl;
520 	u_int8_t		 tos;
521 	u_int8_t		 set_tos;
522 	u_int8_t		 anchor_relative;
523 	u_int8_t		 anchor_wildcard;
524 
525 #define PF_FLUSH		0x01
526 #define PF_FLUSH_GLOBAL		0x02
527 	u_int8_t		 flush;
528 #define PF_PRIO_ZERO		0xff		/* match "prio 0" packets */
529 #define PF_PRIO_MAX		7
530 	u_int8_t		 prio;
531 	u_int8_t		 set_prio[2];
532 
533 	struct {
534 		struct pf_addr		addr;
535 		u_int16_t		port;
536 	}			divert;
537 
538 	uint64_t		 u_states_cur;
539 	uint64_t		 u_states_tot;
540 	uint64_t		 u_src_nodes;
541 };
542 
543 /* rule flags */
544 #define	PFRULE_DROP		0x0000
545 #define	PFRULE_RETURNRST	0x0001
546 #define	PFRULE_FRAGMENT		0x0002
547 #define	PFRULE_RETURNICMP	0x0004
548 #define	PFRULE_RETURN		0x0008
549 #define	PFRULE_NOSYNC		0x0010
550 #define PFRULE_SRCTRACK		0x0020  /* track source states */
551 #define PFRULE_RULESRCTRACK	0x0040  /* per rule */
552 #define	PFRULE_REFS		0x0080	/* rule has references */
553 
554 /* scrub flags */
555 #define	PFRULE_NODF		0x0100
556 #define PFRULE_RANDOMID		0x0800
557 #define PFRULE_REASSEMBLE_TCP	0x1000
558 #define PFRULE_SET_TOS		0x2000
559 
560 /* rule flags again */
561 #define PFRULE_IFBOUND		0x00010000	/* if-bound */
562 #define PFRULE_STATESLOPPY	0x00020000	/* sloppy state tracking */
563 
564 #define PFSTATE_HIWAT		100000	/* default state table size */
565 #define PFSTATE_ADAPT_START	60000	/* default adaptive timeout start */
566 #define PFSTATE_ADAPT_END	120000	/* default adaptive timeout end */
567 
568 
569 struct pf_threshold {
570 	u_int32_t	limit;
571 #define	PF_THRESHOLD_MULT	1000
572 #define PF_THRESHOLD_MAX	0xffffffff / PF_THRESHOLD_MULT
573 	u_int32_t	seconds;
574 	u_int32_t	count;
575 	u_int32_t	last;
576 };
577 
578 struct pf_src_node {
579 	LIST_ENTRY(pf_src_node) entry;
580 	struct pf_addr	 addr;
581 	struct pf_addr	 raddr;
582 	union pf_rule_ptr rule;
583 	struct pfi_kif	*kif;
584 	u_int64_t	 bytes[2];
585 	u_int64_t	 packets[2];
586 	u_int32_t	 states;
587 	u_int32_t	 conn;
588 	struct pf_threshold	conn_rate;
589 	u_int32_t	 creation;
590 	u_int32_t	 expire;
591 	sa_family_t	 af;
592 	u_int8_t	 ruletype;
593 };
594 
595 #define PFSNODE_HIWAT		10000	/* default source node table size */
596 
597 TAILQ_HEAD(pf_rulequeue, pf_rule);
598 
599 struct pf_anchor;
600 
601 struct pf_ruleset {
602 	struct {
603 		struct pf_rulequeue	 queues[2];
604 		struct {
605 			struct pf_rulequeue	*ptr;
606 			struct pf_rule		**ptr_array;
607 			u_int32_t		 rcount;
608 			u_int32_t		 ticket;
609 			int			 open;
610 		}			 active, inactive;
611 	}			 rules[PF_RULESET_MAX];
612 	struct pf_anchor	*anchor;
613 	u_int32_t		 tticket;
614 	int			 tables;
615 	int			 topen;
616 };
617 
618 RB_HEAD(pf_anchor_global, pf_anchor);
619 RB_HEAD(pf_anchor_node, pf_anchor);
620 struct pf_anchor {
621 	RB_ENTRY(pf_anchor)	 entry_global;
622 	RB_ENTRY(pf_anchor)	 entry_node;
623 	struct pf_anchor	*parent;
624 	struct pf_anchor_node	 children;
625 	char			 name[PF_ANCHOR_NAME_SIZE];
626 	char			 path[MAXPATHLEN];
627 	struct pf_ruleset	 ruleset;
628 	int			 refcnt;	/* anchor rules */
629 	int			 match;	/* XXX: used for pfctl black magic */
630 };
631 RB_PROTOTYPE(pf_anchor_global, pf_anchor, entry_global, pf_anchor_compare);
632 RB_PROTOTYPE(pf_anchor_node, pf_anchor, entry_node, pf_anchor_compare);
633 
634 /* these ruleset functions can be linked into userland programs (pfctl) */
635 int			 pf_get_ruleset_number(u_int8_t);
636 void			 pf_init_ruleset(struct pf_ruleset *);
637 int			 pf_anchor_setup(struct pf_rule *,
638 			    const struct pf_ruleset *, const char *);
639 void			 pf_remove_if_empty_ruleset(struct pf_ruleset *);
640 struct pf_ruleset	*pf_find_ruleset(const char *);
641 struct pf_ruleset	*pf_find_or_create_ruleset(const char *);
642 
643 #endif	/* _NET_PF_H_ */
644