xref: /freebsd/sys/netpfil/pf/pf.h (revision 029532e77b92d0c74976e3e3fc79a0ca5e0e3dc0)
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, PF_AFRT, PF_RT };
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			60	/* 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_ANCHORS, PF_LIMIT_ETH_ANCHORS,
124 	  PF_LIMIT_MAX };
125 #define PF_POOL_IDMASK		0x0f
126 enum	{ PF_POOL_NONE, PF_POOL_BITMASK, PF_POOL_RANDOM,
127 	  PF_POOL_SRCHASH, PF_POOL_ROUNDROBIN };
128 enum	{ PF_ADDR_ADDRMASK, PF_ADDR_NOROUTE, PF_ADDR_DYNIFTL,
129 	  PF_ADDR_TABLE, PF_ADDR_URPFFAILED,
130 	  PF_ADDR_RANGE, PF_ADDR_NONE };
131 #define PF_POOL_TYPEMASK	0x0f
132 #define PF_POOL_STICKYADDR	0x20
133 #define PF_POOL_ENDPI		0x40
134 #define	PF_WSCALE_FLAG		0x80
135 #define	PF_WSCALE_MASK		0x0f
136 
137 #define PF_POOL_DYNTYPE(_o)					\
138 	((((_o) & PF_POOL_TYPEMASK) == PF_POOL_ROUNDROBIN) ||	\
139 	(((_o) & PF_POOL_TYPEMASK) == PF_POOL_RANDOM) ||	\
140 	(((_o) & PF_POOL_TYPEMASK) == PF_POOL_SRCHASH))
141 
142 #define	PF_LOG			0x01
143 #define	PF_LOG_ALL		0x02
144 #define	PF_LOG_USER		0x04
145 #define	PF_LOG_FORCE		0x08
146 #define	PF_LOG_MATCHES		0x10
147 
148 /* Reasons code for passing/dropping a packet */
149 #define PFRES_MATCH	0		/* Explicit match of a rule */
150 #define PFRES_BADOFF	1		/* Bad offset for pull_hdr */
151 #define PFRES_FRAG	2		/* Dropping following fragment */
152 #define PFRES_SHORT	3		/* Dropping short packet */
153 #define PFRES_NORM	4		/* Dropping by normalizer */
154 #define PFRES_MEMORY	5		/* Dropped due to lacking mem */
155 #define PFRES_TS	6		/* Bad TCP Timestamp (RFC1323) */
156 #define PFRES_CONGEST	7		/* Congestion (of ipintrq) */
157 #define PFRES_IPOPTIONS 8		/* IP option */
158 #define PFRES_PROTCKSUM 9		/* Protocol checksum invalid */
159 #define PFRES_BADSTATE	10		/* State mismatch */
160 #define PFRES_STATEINS	11		/* State insertion failure */
161 #define PFRES_MAXSTATES	12		/* State limit */
162 #define PFRES_SRCLIMIT	13		/* Source node/conn limit */
163 #define PFRES_SYNPROXY	14		/* SYN proxy */
164 #define PFRES_MAPFAILED	15		/* pf_map_addr() failed */
165 #define PFRES_TRANSLATE	16		/* No translation address available */
166 #define PFRES_MAX	17		/* total+1 */
167 
168 #define PFRES_NAMES { \
169 	"match", \
170 	"bad-offset", \
171 	"fragment", \
172 	"short", \
173 	"normalize", \
174 	"memory", \
175 	"bad-timestamp", \
176 	"congestion", \
177 	"ip-option", \
178 	"proto-cksum", \
179 	"state-mismatch", \
180 	"state-insert", \
181 	"state-limit", \
182 	"src-limit", \
183 	"synproxy", \
184 	"map-failed", \
185 	"translate", \
186 	NULL \
187 }
188 
189 /* Counters for other things we want to keep track of */
190 #define LCNT_STATES		0	/* states */
191 #define LCNT_SRCSTATES		1	/* max-src-states */
192 #define LCNT_SRCNODES		2	/* max-src-nodes */
193 #define LCNT_SRCCONN		3	/* max-src-conn */
194 #define LCNT_SRCCONNRATE	4	/* max-src-conn-rate */
195 #define LCNT_OVERLOAD_TABLE	5	/* entry added to overload table */
196 #define LCNT_OVERLOAD_FLUSH	6	/* state entries flushed */
197 #define LCNT_MAX		7	/* total+1 */
198 /* Only available via the nvlist-based API */
199 #define KLCNT_SYNFLOODS		7	/* synfloods detected */
200 #define KLCNT_SYNCOOKIES_SENT	8	/* syncookies sent */
201 #define KLCNT_SYNCOOKIES_VALID	9	/* syncookies validated */
202 #define KLCNT_MAX		10	/* total+1 */
203 
204 #define LCNT_NAMES { \
205 	"max states per rule", \
206 	"max-src-states", \
207 	"max-src-nodes", \
208 	"max-src-conn", \
209 	"max-src-conn-rate", \
210 	"overload table insertion", \
211 	"overload flush states", \
212 	NULL \
213 }
214 #define KLCNT_NAMES { \
215 	"max states per rule", \
216 	"max-src-states", \
217 	"max-src-nodes", \
218 	"max-src-conn", \
219 	"max-src-conn-rate", \
220 	"overload table insertion", \
221 	"overload flush states", \
222 	"synfloods detected", \
223 	"syncookies sent", \
224 	"syncookies validated", \
225 	NULL \
226 }
227 
228 /* state operation counters */
229 #define FCNT_STATE_SEARCH	0
230 #define FCNT_STATE_INSERT	1
231 #define FCNT_STATE_REMOVALS	2
232 #define FCNT_MAX		3
233 
234 #ifdef _KERNEL
235 #define FCNT_NAMES { \
236 	"searches", \
237 	"inserts", \
238 	"removals", \
239 	NULL \
240 }
241 #endif
242 
243 /* src_node operation counters */
244 #define SCNT_SRC_NODE_SEARCH	0
245 #define SCNT_SRC_NODE_INSERT	1
246 #define SCNT_SRC_NODE_REMOVALS	2
247 #define SCNT_MAX		3
248 
249 #define	PF_TABLE_NAME_SIZE	32
250 #define	PF_QNAME_SIZE		64
251 
252 struct pfioc_nv {
253 	void            *data;
254 	size_t           len;   /* The length of the nvlist data. */
255 	size_t           size;  /* The total size of the data buffer. */
256 };
257 
258 struct pf_rule;
259 
260 /* keep synced with pfi_kif, used in RB_FIND */
261 struct pfi_kif_cmp {
262 	char				 pfik_name[IFNAMSIZ];
263 };
264 
265 struct pfi_kif {
266 	char				 pfik_name[IFNAMSIZ];
267 	union {
268 		RB_ENTRY(pfi_kif)	 pfik_tree;
269 		LIST_ENTRY(pfi_kif)	 pfik_list;
270 	};
271 	u_int64_t			 pfik_packets[2][2][2];
272 	u_int64_t			 pfik_bytes[2][2][2];
273 	u_int32_t			 pfik_tzero;
274 	u_int				 pfik_flags;
275 	struct ifnet			*pfik_ifp;
276 	struct ifg_group		*pfik_group;
277 	u_int				 pfik_rulerefs;
278 	TAILQ_HEAD(, pfi_dynaddr)	 pfik_dynaddrs;
279 };
280 
281 struct pf_status {
282 	uint64_t	counters[PFRES_MAX];
283 	uint64_t	lcounters[LCNT_MAX];
284 	uint64_t	fcounters[FCNT_MAX];
285 	uint64_t	scounters[SCNT_MAX];
286 	uint64_t	pcounters[2][2][3];
287 	uint64_t	bcounters[2][2];
288 	uint32_t	running;
289 	uint32_t	states;
290 	uint32_t	src_nodes;
291 	uint32_t	since;
292 	uint32_t	debug;
293 	uint32_t	hostid;
294 	char		ifname[IFNAMSIZ];
295 	uint8_t		pf_chksum[PF_MD5_DIGEST_LENGTH];
296 };
297 
298 #define PF_REASS_ENABLED	0x01
299 #define PF_REASS_NODF		0x02
300 
301 struct pf_addr {
302 	union {
303 		struct in_addr		v4;
304 		struct in6_addr		v6;
305 		u_int8_t		addr8[16];
306 		u_int16_t		addr16[8];
307 		u_int32_t		addr32[4];
308 	};		    /* 128-bit address */
309 };
310 
311 #define PFI_AFLAG_NETWORK	0x01
312 #define PFI_AFLAG_BROADCAST	0x02
313 #define PFI_AFLAG_PEER		0x04
314 #define PFI_AFLAG_MODEMASK	0x07
315 #define PFI_AFLAG_NOALIAS	0x08
316 
317 struct pf_addr_wrap {
318 	union {
319 		struct {
320 			struct pf_addr		 addr;
321 			struct pf_addr		 mask;
322 		}			 a;
323 		char			 ifname[IFNAMSIZ];
324 		char			 tblname[PF_TABLE_NAME_SIZE];
325 	}			 v;
326 	union {
327 		struct pfi_dynaddr	*dyn;
328 		struct pfr_ktable	*tbl;
329 		int			 dyncnt;
330 		int			 tblcnt;
331 	}			 p;
332 	u_int8_t		 type;		/* PF_ADDR_* */
333 	u_int8_t		 iflags;	/* PFI_AFLAG_* */
334 };
335 
336 union pf_rule_ptr {
337 	struct pf_rule		*ptr;
338 	u_int32_t		 nr;
339 };
340 
341 struct pf_rule_uid {
342 	uid_t		 uid[2];
343 	u_int8_t	 op;
344 };
345 
346 struct pf_rule_gid {
347 	uid_t		 gid[2];
348 	u_int8_t	 op;
349 };
350 
351 struct pf_rule_addr {
352 	struct pf_addr_wrap	 addr;
353 	u_int16_t		 port[2];
354 	u_int8_t		 neg;
355 	u_int8_t		 port_op;
356 };
357 
358 struct pf_pooladdr {
359 	struct pf_addr_wrap		 addr;
360 	TAILQ_ENTRY(pf_pooladdr)	 entries;
361 	char				 ifname[IFNAMSIZ];
362 	struct pfi_kif			*kif;
363 };
364 
365 TAILQ_HEAD(pf_palist, pf_pooladdr);
366 
367 struct pf_poolhashkey {
368 	union {
369 		u_int8_t		key8[16];
370 		u_int16_t		key16[8];
371 		u_int32_t		key32[4];
372 	};		    /* 128-bit hash key */
373 };
374 
375 struct pf_mape_portset {
376 	u_int8_t		offset;
377 	u_int8_t		psidlen;
378 	u_int16_t		psid;
379 };
380 
381 struct pf_pool {
382 	struct pf_palist	 list;
383 	struct pf_pooladdr	*cur;
384 	struct pf_poolhashkey	 key;
385 	struct pf_addr		 counter;
386 	int			 tblidx;
387 	u_int16_t		 proxy_port[2];
388 	u_int8_t		 opts;
389 };
390 
391 /* A packed Operating System description for fingerprinting */
392 typedef u_int32_t pf_osfp_t;
393 #define PF_OSFP_ANY	((pf_osfp_t)0)
394 #define PF_OSFP_UNKNOWN	((pf_osfp_t)-1)
395 #define PF_OSFP_NOMATCH	((pf_osfp_t)-2)
396 
397 struct pf_osfp_entry {
398 	SLIST_ENTRY(pf_osfp_entry) fp_entry;
399 	pf_osfp_t		fp_os;
400 	int			fp_enflags;
401 #define PF_OSFP_EXPANDED	0x001		/* expanded entry */
402 #define PF_OSFP_GENERIC		0x002		/* generic signature */
403 #define PF_OSFP_NODETAIL	0x004		/* no p0f details */
404 #define PF_OSFP_LEN	32
405 	char			fp_class_nm[PF_OSFP_LEN];
406 	char			fp_version_nm[PF_OSFP_LEN];
407 	char			fp_subtype_nm[PF_OSFP_LEN];
408 };
409 #define PF_OSFP_ENTRY_EQ(a, b) \
410     ((a)->fp_os == (b)->fp_os && \
411     memcmp((a)->fp_class_nm, (b)->fp_class_nm, PF_OSFP_LEN) == 0 && \
412     memcmp((a)->fp_version_nm, (b)->fp_version_nm, PF_OSFP_LEN) == 0 && \
413     memcmp((a)->fp_subtype_nm, (b)->fp_subtype_nm, PF_OSFP_LEN) == 0)
414 
415 /* handle pf_osfp_t packing */
416 #define _FP_RESERVED_BIT	1  /* For the special negative #defines */
417 #define _FP_UNUSED_BITS		1
418 #define _FP_CLASS_BITS		10 /* OS Class (Windows, Linux) */
419 #define _FP_VERSION_BITS	10 /* OS version (95, 98, NT, 2.4.54, 3.2) */
420 #define _FP_SUBTYPE_BITS	10 /* patch level (NT SP4, SP3, ECN patch) */
421 #define PF_OSFP_UNPACK(osfp, class, version, subtype) do { \
422 	(class) = ((osfp) >> (_FP_VERSION_BITS+_FP_SUBTYPE_BITS)) & \
423 	    ((1 << _FP_CLASS_BITS) - 1); \
424 	(version) = ((osfp) >> _FP_SUBTYPE_BITS) & \
425 	    ((1 << _FP_VERSION_BITS) - 1);\
426 	(subtype) = (osfp) & ((1 << _FP_SUBTYPE_BITS) - 1); \
427 } while(0)
428 #define PF_OSFP_PACK(osfp, class, version, subtype) do { \
429 	(osfp) = ((class) & ((1 << _FP_CLASS_BITS) - 1)) << (_FP_VERSION_BITS \
430 	    + _FP_SUBTYPE_BITS); \
431 	(osfp) |= ((version) & ((1 << _FP_VERSION_BITS) - 1)) << \
432 	    _FP_SUBTYPE_BITS; \
433 	(osfp) |= (subtype) & ((1 << _FP_SUBTYPE_BITS) - 1); \
434 } while(0)
435 
436 /* the fingerprint of an OSes TCP SYN packet */
437 typedef u_int64_t	pf_tcpopts_t;
438 struct pf_os_fingerprint {
439 	SLIST_HEAD(pf_osfp_enlist, pf_osfp_entry) fp_oses; /* list of matches */
440 	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
441 	u_int16_t		fp_wsize;	/* TCP window size */
442 	u_int16_t		fp_psize;	/* ip->ip_len */
443 	u_int16_t		fp_mss;		/* TCP MSS */
444 	u_int16_t		fp_flags;
445 #define PF_OSFP_WSIZE_MOD	0x0001		/* Window modulus */
446 #define PF_OSFP_WSIZE_DC	0x0002		/* Window don't care */
447 #define PF_OSFP_WSIZE_MSS	0x0004		/* Window multiple of MSS */
448 #define PF_OSFP_WSIZE_MTU	0x0008		/* Window multiple of MTU */
449 #define PF_OSFP_PSIZE_MOD	0x0010		/* packet size modulus */
450 #define PF_OSFP_PSIZE_DC	0x0020		/* packet size don't care */
451 #define PF_OSFP_WSCALE		0x0040		/* TCP window scaling */
452 #define PF_OSFP_WSCALE_MOD	0x0080		/* TCP window scale modulus */
453 #define PF_OSFP_WSCALE_DC	0x0100		/* TCP window scale dont-care */
454 #define PF_OSFP_MSS		0x0200		/* TCP MSS */
455 #define PF_OSFP_MSS_MOD		0x0400		/* TCP MSS modulus */
456 #define PF_OSFP_MSS_DC		0x0800		/* TCP MSS dont-care */
457 #define PF_OSFP_DF		0x1000		/* IPv4 don't fragment bit */
458 #define PF_OSFP_TS0		0x2000		/* Zero timestamp */
459 #define PF_OSFP_INET6		0x4000		/* IPv6 */
460 	u_int8_t		fp_optcnt;	/* TCP option count */
461 	u_int8_t		fp_wscale;	/* TCP window scaling */
462 	u_int8_t		fp_ttl;		/* IPv4 TTL */
463 #define PF_OSFP_MAXTTL_OFFSET	40
464 /* TCP options packing */
465 #define PF_OSFP_TCPOPT_NOP	0x0		/* TCP NOP option */
466 #define PF_OSFP_TCPOPT_WSCALE	0x1		/* TCP window scaling option */
467 #define PF_OSFP_TCPOPT_MSS	0x2		/* TCP max segment size opt */
468 #define PF_OSFP_TCPOPT_SACK	0x3		/* TCP SACK OK option */
469 #define PF_OSFP_TCPOPT_TS	0x4		/* TCP timestamp option */
470 #define PF_OSFP_TCPOPT_BITS	3		/* bits used by each option */
471 #define PF_OSFP_MAX_OPTS \
472     (sizeof(((struct pf_os_fingerprint *)0)->fp_tcpopts) * 8) \
473     / PF_OSFP_TCPOPT_BITS
474 
475 	SLIST_ENTRY(pf_os_fingerprint)	fp_next;
476 };
477 
478 struct pf_osfp_ioctl {
479 	struct pf_osfp_entry	fp_os;
480 	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
481 	u_int16_t		fp_wsize;	/* TCP window size */
482 	u_int16_t		fp_psize;	/* ip->ip_len */
483 	u_int16_t		fp_mss;		/* TCP MSS */
484 	u_int16_t		fp_flags;
485 	u_int8_t		fp_optcnt;	/* TCP option count */
486 	u_int8_t		fp_wscale;	/* TCP window scaling */
487 	u_int8_t		fp_ttl;		/* IPv4 TTL */
488 
489 	int			fp_getnum;	/* DIOCOSFPGET number */
490 };
491 
492 #define	PF_ANCHOR_NAME_SIZE	 64
493 #define	PF_ANCHOR_MAXPATH	(MAXPATHLEN - PF_ANCHOR_NAME_SIZE - 1)
494 #define	PF_ANCHOR_HIWAT		512
495 #define	PF_OPTIMIZER_TABLE_PFX	"__automatic_"
496 
497 struct pf_rule {
498 	struct pf_rule_addr	 src;
499 	struct pf_rule_addr	 dst;
500 #define PF_SKIP_IFP		0
501 #define PF_SKIP_DIR		1
502 #define PF_SKIP_AF		2
503 #define PF_SKIP_PROTO		3
504 #define PF_SKIP_SRC_ADDR	4
505 #define PF_SKIP_DST_ADDR	5
506 #define PF_SKIP_SRC_PORT	6
507 #define PF_SKIP_DST_PORT	7
508 #define PF_SKIP_COUNT		8
509 	union pf_rule_ptr	 skip[PF_SKIP_COUNT];
510 #define PF_RULE_LABEL_SIZE	 64
511 #define PF_RULE_MAX_LABEL_COUNT	 5
512 	char			 label[PF_RULE_LABEL_SIZE];
513 	char			 ifname[IFNAMSIZ];
514 	char			 qname[PF_QNAME_SIZE];
515 	char			 pqname[PF_QNAME_SIZE];
516 #define	PF_TAG_NAME_SIZE	 64
517 	char			 tagname[PF_TAG_NAME_SIZE];
518 	char			 match_tagname[PF_TAG_NAME_SIZE];
519 
520 	char			 overload_tblname[PF_TABLE_NAME_SIZE];
521 
522 	TAILQ_ENTRY(pf_rule)	 entries;
523 	struct pf_pool		 rpool;
524 
525 	u_int64_t		 evaluations;
526 	u_int64_t		 packets[2];
527 	u_int64_t		 bytes[2];
528 
529 	struct pfi_kif		*kif;
530 	struct pf_anchor	*anchor;
531 	struct pfr_ktable	*overload_tbl;
532 
533 	pf_osfp_t		 os_fingerprint;
534 
535 	int			 rtableid;
536 	u_int32_t		 timeout[PFTM_OLD_MAX];
537 	u_int32_t		 max_states;
538 	u_int32_t		 max_src_nodes;
539 	u_int32_t		 max_src_states;
540 	u_int32_t		 max_src_conn;
541 	struct {
542 		u_int32_t		limit;
543 		u_int32_t		seconds;
544 	}			 max_src_conn_rate;
545 	u_int32_t		 qid;
546 	u_int32_t		 pqid;
547 	u_int32_t		 rt_listid;
548 	u_int32_t		 nr;
549 	u_int32_t		 prob;
550 	uid_t			 cuid;
551 	pid_t			 cpid;
552 
553 	counter_u64_t		 states_cur;
554 	counter_u64_t		 states_tot;
555 	counter_u64_t		 src_nodes;
556 
557 	u_int16_t		 return_icmp;
558 	u_int16_t		 return_icmp6;
559 	u_int16_t		 max_mss;
560 	u_int16_t		 tag;
561 	u_int16_t		 match_tag;
562 	u_int16_t		 scrub_flags;
563 
564 	struct pf_rule_uid	 uid;
565 	struct pf_rule_gid	 gid;
566 
567 	u_int32_t		 rule_flag;
568 	u_int8_t		 action;
569 	u_int8_t		 direction;
570 	u_int8_t		 log;
571 	u_int8_t		 logif;
572 	u_int8_t		 quick;
573 	u_int8_t		 ifnot;
574 	u_int8_t		 match_tag_not;
575 	u_int8_t		 natpass;
576 
577 #define PF_STATE_NORMAL		0x1
578 #define PF_STATE_MODULATE	0x2
579 #define PF_STATE_SYNPROXY	0x3
580 	u_int8_t		 keep_state;
581 	sa_family_t		 af;
582 	u_int8_t		 proto;
583 	u_int8_t		 type;
584 	u_int8_t		 code;
585 	u_int8_t		 flags;
586 	u_int8_t		 flagset;
587 	u_int8_t		 min_ttl;
588 	u_int8_t		 allow_opts;
589 	u_int8_t		 rt;
590 	u_int8_t		 return_ttl;
591 	u_int8_t		 tos;
592 	u_int8_t		 set_tos;
593 	u_int8_t		 anchor_relative;
594 	u_int8_t		 anchor_wildcard;
595 
596 #define PF_FLUSH		0x01
597 #define PF_FLUSH_GLOBAL		0x02
598 	u_int8_t		 flush;
599 #define PF_PRIO_ZERO		0xff		/* match "prio 0" packets */
600 #define PF_PRIO_MAX		7
601 	u_int8_t		 prio;
602 	u_int8_t		 set_prio[2];
603 
604 	struct {
605 		struct pf_addr		addr;
606 		u_int16_t		port;
607 	}			divert;
608 
609 	uint64_t		 u_states_cur;
610 	uint64_t		 u_states_tot;
611 	uint64_t		 u_src_nodes;
612 };
613 
614 /* pf_krule->rule_flag and old-style scrub flags */
615 #define	PFRULE_DROP		0x00000000
616 #define	PFRULE_RETURNRST	0x00000001
617 #define	PFRULE_FRAGMENT		0x00000002
618 #define	PFRULE_RETURNICMP	0x00000004
619 #define	PFRULE_RETURN		0x00000008
620 #define	PFRULE_NOSYNC		0x00000010
621 #define	PFRULE_SRCTRACK		0x00000020  /* track source states */
622 #define	PFRULE_RULESRCTRACK	0x00000040  /* per rule */
623 #define	PFRULE_NODF		0x00000100
624 #define	PFRULE_FRAGMENT_NOREASS	0x00000200
625 #define	PFRULE_RANDOMID		0x00000800
626 #define	PFRULE_REASSEMBLE_TCP	0x00001000
627 #define	PFRULE_SET_TOS		0x00002000
628 #define	PFRULE_IFBOUND		0x00010000 /* if-bound */
629 #define	PFRULE_STATESLOPPY	0x00020000 /* sloppy state tracking */
630 #define	PFRULE_PFLOW		0x00040000
631 #define	PFRULE_ALLOW_RELATED	0x00080000
632 #define	PFRULE_AFTO		0x00200000  /* af-to rule */
633 
634 #ifdef _KERNEL
635 #define	PFRULE_REFS		0x0080	/* rule has references */
636 #endif
637 
638 /* pf_rule_actions->dnflags */
639 #define	PFRULE_DN_IS_PIPE	0x0040
640 #define	PFRULE_DN_IS_QUEUE	0x0080
641 
642 /* pf_state->state_flags, pf_rule_actions->flags, pf_krule->scrub_flags */
643 #define	PFSTATE_ALLOWOPTS	0x0001
644 #define	PFSTATE_SLOPPY		0x0002
645 #define	PFSTATE_PFLOW		0x0004
646 #define	PFSTATE_NOSYNC		0x0008
647 #define	PFSTATE_ACK		0x0010
648 #define	PFSTATE_NODF		0x0020
649 #define	PFSTATE_SETTOS		0x0040
650 #define	PFSTATE_RANDOMID	0x0080
651 #define	PFSTATE_SCRUB_TCP	0x0100
652 #define	PFSTATE_SETPRIO		0x0200
653 /* was	PFSTATE_INP_UNLINKED	0x0400 */
654 /* FreeBSD-specific flags are added from the end to keep space for porting
655  * flags from OpenBSD */
656 #define	PFSTATE_DN_IS_PIPE	0x4000
657 #define	PFSTATE_DN_IS_QUEUE	0x8000
658 #define	PFSTATE_SCRUBMASK (PFSTATE_NODF|PFSTATE_RANDOMID|PFSTATE_SCRUB_TCP)
659 #define	PFSTATE_SETMASK   (PFSTATE_SETTOS|PFSTATE_SETPRIO)
660 
661 /* pfctl_state->src_node_flags */
662 #define PFSTATE_SRC_NODE_LIMIT		0x01
663 #define PFSTATE_SRC_NODE_NAT		0x02
664 #define PFSTATE_SRC_NODE_ROUTE		0x04
665 #define PFSTATE_SRC_NODE_LIMIT_GLOBAL	0x10
666 
667 #define PFSTATE_HIWAT		100000	/* default state table size */
668 #define PFSTATE_ADAPT_START	60000	/* default adaptive timeout start */
669 #define PFSTATE_ADAPT_END	120000	/* default adaptive timeout end */
670 
671 
672 struct pf_threshold {
673 	u_int32_t	limit;
674 #define	PF_THRESHOLD_MULT	1000
675 #define PF_THRESHOLD_MAX	0xffffffff / PF_THRESHOLD_MULT
676 	u_int32_t	seconds;
677 	u_int32_t	count;
678 	u_int32_t	last;
679 };
680 
681 struct pf_src_node {
682 	LIST_ENTRY(pf_src_node) entry;
683 	struct pf_addr	 addr;
684 	struct pf_addr	 raddr;
685 	union pf_rule_ptr rule;
686 	struct pfi_kif	*kif;
687 	u_int64_t	 bytes[2];
688 	u_int64_t	 packets[2];
689 	u_int32_t	 states;
690 	u_int32_t	 conn;
691 	struct pf_threshold	conn_rate;
692 	u_int32_t	 creation;
693 	u_int32_t	 expire;
694 	sa_family_t	 af;
695 	sa_family_t	 naf;
696 	u_int8_t	 ruletype;
697 };
698 
699 #define PFSNODE_HIWAT		10000	/* default source node table size */
700 
701 TAILQ_HEAD(pf_rulequeue, pf_rule);
702 
703 struct pf_anchor;
704 
705 struct pf_ruleset {
706 	struct {
707 		struct pf_rulequeue	 queues[2];
708 		struct {
709 			struct pf_rulequeue	*ptr;
710 			struct pf_rule		**ptr_array;
711 			u_int32_t		 rcount;
712 			u_int32_t		 ticket;
713 			int			 open;
714 		}			 active, inactive;
715 	}			 rules[PF_RULESET_MAX];
716 	struct pf_anchor	*anchor;
717 	u_int32_t		 tticket;
718 	int			 tables;
719 	int			 topen;
720 };
721 
722 RB_HEAD(pf_anchor_global, pf_anchor);
723 RB_HEAD(pf_anchor_node, pf_anchor);
724 struct pf_anchor {
725 	RB_ENTRY(pf_anchor)	 entry_global;
726 	RB_ENTRY(pf_anchor)	 entry_node;
727 	struct pf_anchor	*parent;
728 	struct pf_anchor_node	 children;
729 	char			 name[PF_ANCHOR_NAME_SIZE];
730 	char			 path[MAXPATHLEN];
731 	struct pf_ruleset	 ruleset;
732 	int			 refcnt;	/* anchor rules */
733 	int			 match;	/* XXX: used for pfctl black magic */
734 };
735 RB_PROTOTYPE(pf_anchor_global, pf_anchor, entry_global, pf_anchor_compare);
736 RB_PROTOTYPE(pf_anchor_node, pf_anchor, entry_node, pf_anchor_compare);
737 
738 int	 pf_get_ruleset_number(u_int8_t);
739 
740 #endif	/* _NET_PF_H_ */
741