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