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