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