xref: /openbsd-src/sys/net/pfvar.h (revision a28daedfc357b214be5c701aa8ba8adb29a7f1c2)
1 /*	$OpenBSD: pfvar.h,v 1.285 2009/04/06 12:05:55 henning Exp $ */
2 
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  */
32 
33 #ifndef _NET_PFVAR_H_
34 #define _NET_PFVAR_H_
35 
36 #include <sys/param.h>
37 #include <sys/types.h>
38 #include <sys/queue.h>
39 #include <sys/tree.h>
40 #include <sys/rwlock.h>
41 
42 #include <net/radix.h>
43 #include <net/route.h>
44 #include <netinet/ip_ipsp.h>
45 #include <netinet/tcp_fsm.h>
46 
47 struct ip;
48 struct ip6_hdr;
49 
50 #define	PF_TCPS_PROXY_SRC	((TCP_NSTATES)+0)
51 #define	PF_TCPS_PROXY_DST	((TCP_NSTATES)+1)
52 
53 #define	PF_MD5_DIGEST_LENGTH	16
54 #ifdef MD5_DIGEST_LENGTH
55 #if PF_MD5_DIGEST_LENGTH != MD5_DIGEST_LENGTH
56 #error
57 #endif
58 #endif
59 
60 enum	{ PF_INOUT, PF_IN, PF_OUT };
61 enum	{ PF_PASS, PF_DROP, PF_SCRUB, PF_NOSCRUB, PF_NAT, PF_NONAT,
62 	  PF_BINAT, PF_NOBINAT, PF_RDR, PF_NORDR, PF_SYNPROXY_DROP, PF_DEFER,
63 	  PF_MATCH };
64 enum	{ PF_RULESET_FILTER, PF_RULESET_NAT, PF_RULESET_BINAT,
65 	  PF_RULESET_RDR, PF_RULESET_MAX };
66 enum	{ PF_OP_NONE, PF_OP_IRG, PF_OP_EQ, PF_OP_NE, PF_OP_LT,
67 	  PF_OP_LE, PF_OP_GT, PF_OP_GE, PF_OP_XRG, PF_OP_RRG };
68 enum	{ PF_DEBUG_NONE, PF_DEBUG_URGENT, PF_DEBUG_MISC, PF_DEBUG_NOISY };
69 enum	{ PF_CHANGE_NONE, PF_CHANGE_ADD_HEAD, PF_CHANGE_ADD_TAIL,
70 	  PF_CHANGE_ADD_BEFORE, PF_CHANGE_ADD_AFTER,
71 	  PF_CHANGE_REMOVE, PF_CHANGE_GET_TICKET };
72 enum	{ PF_GET_NONE, PF_GET_CLR_CNTR };
73 enum	{ PF_SK_WIRE, PF_SK_STACK, PF_SK_BOTH };
74 
75 /*
76  * Note about PFTM_*: real indices into pf_rule.timeout[] come before
77  * PFTM_MAX, special cases afterwards. See pf_state_expires().
78  */
79 enum	{ PFTM_TCP_FIRST_PACKET, PFTM_TCP_OPENING, PFTM_TCP_ESTABLISHED,
80 	  PFTM_TCP_CLOSING, PFTM_TCP_FIN_WAIT, PFTM_TCP_CLOSED,
81 	  PFTM_UDP_FIRST_PACKET, PFTM_UDP_SINGLE, PFTM_UDP_MULTIPLE,
82 	  PFTM_ICMP_FIRST_PACKET, PFTM_ICMP_ERROR_REPLY,
83 	  PFTM_OTHER_FIRST_PACKET, PFTM_OTHER_SINGLE,
84 	  PFTM_OTHER_MULTIPLE, PFTM_FRAG, PFTM_INTERVAL,
85 	  PFTM_ADAPTIVE_START, PFTM_ADAPTIVE_END, PFTM_SRC_NODE,
86 	  PFTM_TS_DIFF, PFTM_MAX, PFTM_PURGE, PFTM_UNLINKED,
87 	  PFTM_UNTIL_PACKET };
88 
89 /* PFTM default values */
90 #define PFTM_TCP_FIRST_PACKET_VAL	120	/* First TCP packet */
91 #define PFTM_TCP_OPENING_VAL		30	/* No response yet */
92 #define PFTM_TCP_ESTABLISHED_VAL	24*60*60/* Established */
93 #define PFTM_TCP_CLOSING_VAL		15 * 60	/* Half closed */
94 #define PFTM_TCP_FIN_WAIT_VAL		45	/* Got both FINs */
95 #define PFTM_TCP_CLOSED_VAL		90	/* Got a RST */
96 #define PFTM_UDP_FIRST_PACKET_VAL	60	/* First UDP packet */
97 #define PFTM_UDP_SINGLE_VAL		30	/* Unidirectional */
98 #define PFTM_UDP_MULTIPLE_VAL		60	/* Bidirectional */
99 #define PFTM_ICMP_FIRST_PACKET_VAL	20	/* First ICMP packet */
100 #define PFTM_ICMP_ERROR_REPLY_VAL	10	/* Got error response */
101 #define PFTM_OTHER_FIRST_PACKET_VAL	60	/* First packet */
102 #define PFTM_OTHER_SINGLE_VAL		30	/* Unidirectional */
103 #define PFTM_OTHER_MULTIPLE_VAL		60	/* Bidirectional */
104 #define PFTM_FRAG_VAL			30	/* Fragment expire */
105 #define PFTM_INTERVAL_VAL		10	/* Expire interval */
106 #define PFTM_SRC_NODE_VAL		0	/* Source tracking */
107 #define PFTM_TS_DIFF_VAL		30	/* Allowed TS diff */
108 
109 enum	{ PF_NOPFROUTE, PF_FASTROUTE, PF_ROUTETO, PF_DUPTO, PF_REPLYTO };
110 enum	{ PF_LIMIT_STATES, PF_LIMIT_SRC_NODES, PF_LIMIT_FRAGS,
111 	  PF_LIMIT_TABLES, PF_LIMIT_TABLE_ENTRIES, PF_LIMIT_MAX };
112 #define PF_POOL_IDMASK		0x0f
113 enum	{ PF_POOL_NONE, PF_POOL_BITMASK, PF_POOL_RANDOM,
114 	  PF_POOL_SRCHASH, PF_POOL_ROUNDROBIN };
115 enum	{ PF_ADDR_ADDRMASK, PF_ADDR_NOROUTE, PF_ADDR_DYNIFTL,
116 	  PF_ADDR_TABLE, PF_ADDR_RTLABEL, PF_ADDR_URPFFAILED,
117 	  PF_ADDR_RANGE };
118 #define PF_POOL_TYPEMASK	0x0f
119 #define PF_POOL_STICKYADDR	0x20
120 #define	PF_WSCALE_FLAG		0x80
121 #define	PF_WSCALE_MASK		0x0f
122 
123 #define	PF_LOG			0x01
124 #define	PF_LOG_ALL		0x02
125 #define	PF_LOG_SOCKET_LOOKUP	0x04
126 #define	PF_LOG_FORCE		0x08
127 
128 struct pf_addr {
129 	union {
130 		struct in_addr		v4;
131 		struct in6_addr		v6;
132 		u_int8_t		addr8[16];
133 		u_int16_t		addr16[8];
134 		u_int32_t		addr32[4];
135 	} pfa;		    /* 128-bit address */
136 #define v4	pfa.v4
137 #define v6	pfa.v6
138 #define addr8	pfa.addr8
139 #define addr16	pfa.addr16
140 #define addr32	pfa.addr32
141 };
142 
143 #define	PF_TABLE_NAME_SIZE	 32
144 
145 #define PFI_AFLAG_NETWORK	0x01
146 #define PFI_AFLAG_BROADCAST	0x02
147 #define PFI_AFLAG_PEER		0x04
148 #define PFI_AFLAG_MODEMASK	0x07
149 #define PFI_AFLAG_NOALIAS	0x08
150 
151 struct pf_addr_wrap {
152 	union {
153 		struct {
154 			struct pf_addr		 addr;
155 			struct pf_addr		 mask;
156 		}			 a;
157 		char			 ifname[IFNAMSIZ];
158 		char			 tblname[PF_TABLE_NAME_SIZE];
159 		char			 rtlabelname[RTLABEL_LEN];
160 		u_int32_t		 rtlabel;
161 	}			 v;
162 	union {
163 		struct pfi_dynaddr	*dyn;
164 		struct pfr_ktable	*tbl;
165 		int			 dyncnt;
166 		int			 tblcnt;
167 	}			 p;
168 	u_int8_t		 type;		/* PF_ADDR_* */
169 	u_int8_t		 iflags;	/* PFI_AFLAG_* */
170 };
171 
172 #ifdef _KERNEL
173 
174 struct pfi_dynaddr {
175 	TAILQ_ENTRY(pfi_dynaddr)	 entry;
176 	struct pf_addr			 pfid_addr4;
177 	struct pf_addr			 pfid_mask4;
178 	struct pf_addr			 pfid_addr6;
179 	struct pf_addr			 pfid_mask6;
180 	struct pfr_ktable		*pfid_kt;
181 	struct pfi_kif			*pfid_kif;
182 	void				*pfid_hook_cookie;
183 	int				 pfid_net;	/* mask or 128 */
184 	int				 pfid_acnt4;	/* address count IPv4 */
185 	int				 pfid_acnt6;	/* address count IPv6 */
186 	sa_family_t			 pfid_af;	/* rule af */
187 	u_int8_t			 pfid_iflags;	/* PFI_AFLAG_* */
188 };
189 
190 /*
191  * Address manipulation macros
192  */
193 
194 #ifdef INET
195 #ifndef INET6
196 #define PF_INET_ONLY
197 #endif /* ! INET6 */
198 #endif /* INET */
199 
200 #ifdef INET6
201 #ifndef INET
202 #define PF_INET6_ONLY
203 #endif /* ! INET */
204 #endif /* INET6 */
205 
206 #ifdef INET
207 #ifdef INET6
208 #define PF_INET_INET6
209 #endif /* INET6 */
210 #endif /* INET */
211 
212 #else
213 
214 #define PF_INET_INET6
215 
216 #endif /* _KERNEL */
217 
218 /* Both IPv4 and IPv6 */
219 #ifdef PF_INET_INET6
220 
221 #define PF_AEQ(a, b, c) \
222 	((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \
223 	((a)->addr32[3] == (b)->addr32[3] && \
224 	(a)->addr32[2] == (b)->addr32[2] && \
225 	(a)->addr32[1] == (b)->addr32[1] && \
226 	(a)->addr32[0] == (b)->addr32[0])) \
227 
228 #define PF_ANEQ(a, b, c) \
229 	((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \
230 	((a)->addr32[3] != (b)->addr32[3] || \
231 	(a)->addr32[2] != (b)->addr32[2] || \
232 	(a)->addr32[1] != (b)->addr32[1] || \
233 	(a)->addr32[0] != (b)->addr32[0])) \
234 
235 #define PF_AZERO(a, c) \
236 	((c == AF_INET && !(a)->addr32[0]) || \
237 	(!(a)->addr32[0] && !(a)->addr32[1] && \
238 	!(a)->addr32[2] && !(a)->addr32[3] )) \
239 
240 #define PF_MATCHA(n, a, m, b, f) \
241 	pf_match_addr(n, a, m, b, f)
242 
243 #define PF_ACPY(a, b, f) \
244 	pf_addrcpy(a, b, f)
245 
246 #define PF_AINC(a, f) \
247 	pf_addr_inc(a, f)
248 
249 #define PF_POOLMASK(a, b, c, d, f) \
250 	pf_poolmask(a, b, c, d, f)
251 
252 #else
253 
254 /* Just IPv6 */
255 
256 #ifdef PF_INET6_ONLY
257 
258 #define PF_AEQ(a, b, c) \
259 	((a)->addr32[3] == (b)->addr32[3] && \
260 	(a)->addr32[2] == (b)->addr32[2] && \
261 	(a)->addr32[1] == (b)->addr32[1] && \
262 	(a)->addr32[0] == (b)->addr32[0]) \
263 
264 #define PF_ANEQ(a, b, c) \
265 	((a)->addr32[3] != (b)->addr32[3] || \
266 	(a)->addr32[2] != (b)->addr32[2] || \
267 	(a)->addr32[1] != (b)->addr32[1] || \
268 	(a)->addr32[0] != (b)->addr32[0]) \
269 
270 #define PF_AZERO(a, c) \
271 	(!(a)->addr32[0] && \
272 	!(a)->addr32[1] && \
273 	!(a)->addr32[2] && \
274 	!(a)->addr32[3] ) \
275 
276 #define PF_MATCHA(n, a, m, b, f) \
277 	pf_match_addr(n, a, m, b, f)
278 
279 #define PF_ACPY(a, b, f) \
280 	pf_addrcpy(a, b, f)
281 
282 #define PF_AINC(a, f) \
283 	pf_addr_inc(a, f)
284 
285 #define PF_POOLMASK(a, b, c, d, f) \
286 	pf_poolmask(a, b, c, d, f)
287 
288 #else
289 
290 /* Just IPv4 */
291 #ifdef PF_INET_ONLY
292 
293 #define PF_AEQ(a, b, c) \
294 	((a)->addr32[0] == (b)->addr32[0])
295 
296 #define PF_ANEQ(a, b, c) \
297 	((a)->addr32[0] != (b)->addr32[0])
298 
299 #define PF_AZERO(a, c) \
300 	(!(a)->addr32[0])
301 
302 #define PF_MATCHA(n, a, m, b, f) \
303 	pf_match_addr(n, a, m, b, f)
304 
305 #define PF_ACPY(a, b, f) \
306 	(a)->v4.s_addr = (b)->v4.s_addr
307 
308 #define PF_AINC(a, f) \
309 	do { \
310 		(a)->addr32[0] = htonl(ntohl((a)->addr32[0]) + 1); \
311 	} while (0)
312 
313 #define PF_POOLMASK(a, b, c, d, f) \
314 	do { \
315 		(a)->addr32[0] = ((b)->addr32[0] & (c)->addr32[0]) | \
316 		(((c)->addr32[0] ^ 0xffffffff ) & (d)->addr32[0]); \
317 	} while (0)
318 
319 #endif /* PF_INET_ONLY */
320 #endif /* PF_INET6_ONLY */
321 #endif /* PF_INET_INET6 */
322 
323 #define	PF_MISMATCHAW(aw, x, af, neg, ifp)				\
324 	(								\
325 		(((aw)->type == PF_ADDR_NOROUTE &&			\
326 		    pf_routable((x), (af), NULL)) ||			\
327 		(((aw)->type == PF_ADDR_URPFFAILED && (ifp) != NULL &&	\
328 		    pf_routable((x), (af), (ifp))) ||			\
329 		((aw)->type == PF_ADDR_RTLABEL &&			\
330 		    !pf_rtlabel_match((x), (af), (aw))) ||		\
331 		((aw)->type == PF_ADDR_TABLE &&				\
332 		    !pfr_match_addr((aw)->p.tbl, (x), (af))) ||		\
333 		((aw)->type == PF_ADDR_DYNIFTL &&			\
334 		    !pfi_match_addr((aw)->p.dyn, (x), (af))) ||		\
335 		((aw)->type == PF_ADDR_RANGE &&				\
336 		    !pf_match_addr_range(&(aw)->v.a.addr,		\
337 		    &(aw)->v.a.mask, (x), (af))) ||			\
338 		((aw)->type == PF_ADDR_ADDRMASK &&			\
339 		    !PF_AZERO(&(aw)->v.a.mask, (af)) &&			\
340 		    !PF_MATCHA(0, &(aw)->v.a.addr,			\
341 		    &(aw)->v.a.mask, (x), (af))))) !=			\
342 		(neg)							\
343 	)
344 
345 
346 struct pf_rule_uid {
347 	uid_t		 uid[2];
348 	u_int8_t	 op;
349 };
350 
351 struct pf_rule_gid {
352 	uid_t		 gid[2];
353 	u_int8_t	 op;
354 };
355 
356 struct pf_rule_addr {
357 	struct pf_addr_wrap	 addr;
358 	u_int16_t		 port[2];
359 	u_int8_t		 neg;
360 	u_int8_t		 port_op;
361 };
362 
363 struct pf_pooladdr {
364 	struct pf_addr_wrap		 addr;
365 	TAILQ_ENTRY(pf_pooladdr)	 entries;
366 	char				 ifname[IFNAMSIZ];
367 	struct pfi_kif			*kif;
368 };
369 
370 TAILQ_HEAD(pf_palist, pf_pooladdr);
371 
372 struct pf_poolhashkey {
373 	union {
374 		u_int8_t		key8[16];
375 		u_int16_t		key16[8];
376 		u_int32_t		key32[4];
377 	} pfk;		    /* 128-bit hash key */
378 #define key8	pfk.key8
379 #define key16	pfk.key16
380 #define key32	pfk.key32
381 };
382 
383 struct pf_pool {
384 	struct pf_palist	 list;
385 	struct pf_pooladdr	*cur;
386 	struct pf_poolhashkey	 key;
387 	struct pf_addr		 counter;
388 	int			 tblidx;
389 	u_int16_t		 proxy_port[2];
390 	u_int8_t		 port_op;
391 	u_int8_t		 opts;
392 };
393 
394 
395 /* A packed Operating System description for fingerprinting */
396 typedef u_int32_t pf_osfp_t;
397 #define PF_OSFP_ANY	((pf_osfp_t)0)
398 #define PF_OSFP_UNKNOWN	((pf_osfp_t)-1)
399 #define PF_OSFP_NOMATCH	((pf_osfp_t)-2)
400 
401 struct pf_osfp_entry {
402 	SLIST_ENTRY(pf_osfp_entry) fp_entry;
403 	pf_osfp_t		fp_os;
404 	int			fp_enflags;
405 #define PF_OSFP_EXPANDED	0x001		/* expanded entry */
406 #define PF_OSFP_GENERIC		0x002		/* generic signature */
407 #define PF_OSFP_NODETAIL	0x004		/* no p0f details */
408 #define PF_OSFP_LEN	32
409 	char			fp_class_nm[PF_OSFP_LEN];
410 	char			fp_version_nm[PF_OSFP_LEN];
411 	char			fp_subtype_nm[PF_OSFP_LEN];
412 };
413 #define PF_OSFP_ENTRY_EQ(a, b) \
414     ((a)->fp_os == (b)->fp_os && \
415     memcmp((a)->fp_class_nm, (b)->fp_class_nm, PF_OSFP_LEN) == 0 && \
416     memcmp((a)->fp_version_nm, (b)->fp_version_nm, PF_OSFP_LEN) == 0 && \
417     memcmp((a)->fp_subtype_nm, (b)->fp_subtype_nm, PF_OSFP_LEN) == 0)
418 
419 /* handle pf_osfp_t packing */
420 #define _FP_RESERVED_BIT	1  /* For the special negative #defines */
421 #define _FP_UNUSED_BITS		1
422 #define _FP_CLASS_BITS		10 /* OS Class (Windows, Linux) */
423 #define _FP_VERSION_BITS	10 /* OS version (95, 98, NT, 2.4.54, 3.2) */
424 #define _FP_SUBTYPE_BITS	10 /* patch level (NT SP4, SP3, ECN patch) */
425 #define PF_OSFP_UNPACK(osfp, class, version, subtype) do { \
426 	(class) = ((osfp) >> (_FP_VERSION_BITS+_FP_SUBTYPE_BITS)) & \
427 	    ((1 << _FP_CLASS_BITS) - 1); \
428 	(version) = ((osfp) >> _FP_SUBTYPE_BITS) & \
429 	    ((1 << _FP_VERSION_BITS) - 1);\
430 	(subtype) = (osfp) & ((1 << _FP_SUBTYPE_BITS) - 1); \
431 } while(0)
432 #define PF_OSFP_PACK(osfp, class, version, subtype) do { \
433 	(osfp) = ((class) & ((1 << _FP_CLASS_BITS) - 1)) << (_FP_VERSION_BITS \
434 	    + _FP_SUBTYPE_BITS); \
435 	(osfp) |= ((version) & ((1 << _FP_VERSION_BITS) - 1)) << \
436 	    _FP_SUBTYPE_BITS; \
437 	(osfp) |= (subtype) & ((1 << _FP_SUBTYPE_BITS) - 1); \
438 } while(0)
439 
440 /* the fingerprint of an OSes TCP SYN packet */
441 typedef u_int64_t	pf_tcpopts_t;
442 struct pf_os_fingerprint {
443 	SLIST_HEAD(pf_osfp_enlist, pf_osfp_entry) fp_oses; /* list of matches */
444 	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
445 	u_int16_t		fp_wsize;	/* TCP window size */
446 	u_int16_t		fp_psize;	/* ip->ip_len */
447 	u_int16_t		fp_mss;		/* TCP MSS */
448 	u_int16_t		fp_flags;
449 #define PF_OSFP_WSIZE_MOD	0x0001		/* Window modulus */
450 #define PF_OSFP_WSIZE_DC	0x0002		/* Window don't care */
451 #define PF_OSFP_WSIZE_MSS	0x0004		/* Window multiple of MSS */
452 #define PF_OSFP_WSIZE_MTU	0x0008		/* Window multiple of MTU */
453 #define PF_OSFP_PSIZE_MOD	0x0010		/* packet size modulus */
454 #define PF_OSFP_PSIZE_DC	0x0020		/* packet size don't care */
455 #define PF_OSFP_WSCALE		0x0040		/* TCP window scaling */
456 #define PF_OSFP_WSCALE_MOD	0x0080		/* TCP window scale modulus */
457 #define PF_OSFP_WSCALE_DC	0x0100		/* TCP window scale dont-care */
458 #define PF_OSFP_MSS		0x0200		/* TCP MSS */
459 #define PF_OSFP_MSS_MOD		0x0400		/* TCP MSS modulus */
460 #define PF_OSFP_MSS_DC		0x0800		/* TCP MSS dont-care */
461 #define PF_OSFP_DF		0x1000		/* IPv4 don't fragment bit */
462 #define PF_OSFP_TS0		0x2000		/* Zero timestamp */
463 #define PF_OSFP_INET6		0x4000		/* IPv6 */
464 	u_int8_t		fp_optcnt;	/* TCP option count */
465 	u_int8_t		fp_wscale;	/* TCP window scaling */
466 	u_int8_t		fp_ttl;		/* IPv4 TTL */
467 #define PF_OSFP_MAXTTL_OFFSET	40
468 /* TCP options packing */
469 #define PF_OSFP_TCPOPT_NOP	0x0		/* TCP NOP option */
470 #define PF_OSFP_TCPOPT_WSCALE	0x1		/* TCP window scaling option */
471 #define PF_OSFP_TCPOPT_MSS	0x2		/* TCP max segment size opt */
472 #define PF_OSFP_TCPOPT_SACK	0x3		/* TCP SACK OK option */
473 #define PF_OSFP_TCPOPT_TS	0x4		/* TCP timestamp option */
474 #define PF_OSFP_TCPOPT_BITS	3		/* bits used by each option */
475 #define PF_OSFP_MAX_OPTS \
476     (sizeof(((struct pf_os_fingerprint *)0)->fp_tcpopts) * 8) \
477     / PF_OSFP_TCPOPT_BITS
478 
479 	SLIST_ENTRY(pf_os_fingerprint)	fp_next;
480 };
481 
482 struct pf_osfp_ioctl {
483 	struct pf_osfp_entry	fp_os;
484 	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
485 	u_int16_t		fp_wsize;	/* TCP window size */
486 	u_int16_t		fp_psize;	/* ip->ip_len */
487 	u_int16_t		fp_mss;		/* TCP MSS */
488 	u_int16_t		fp_flags;
489 	u_int8_t		fp_optcnt;	/* TCP option count */
490 	u_int8_t		fp_wscale;	/* TCP window scaling */
491 	u_int8_t		fp_ttl;		/* IPv4 TTL */
492 
493 	int			fp_getnum;	/* DIOCOSFPGET number */
494 };
495 
496 struct pf_rule_actions {
497 	int		rtableid;
498 	u_int16_t	qid;
499 	u_int16_t	pqid;
500 	u_int16_t	max_mss;
501 	u_int8_t	log;
502 	u_int8_t	set_tos;
503 	u_int8_t	min_ttl;
504 	u_int8_t	flags;
505 	u_int8_t	pad[2];
506 };
507 
508 union pf_rule_ptr {
509 	struct pf_rule		*ptr;
510 	u_int32_t		 nr;
511 };
512 
513 #define	PF_ANCHOR_NAME_SIZE	 64
514 
515 struct pf_rule {
516 	struct pf_rule_addr	 src;
517 	struct pf_rule_addr	 dst;
518 #define PF_SKIP_IFP		0
519 #define PF_SKIP_DIR		1
520 #define PF_SKIP_AF		2
521 #define PF_SKIP_PROTO		3
522 #define PF_SKIP_SRC_ADDR	4
523 #define PF_SKIP_SRC_PORT	5
524 #define PF_SKIP_DST_ADDR	6
525 #define PF_SKIP_DST_PORT	7
526 #define PF_SKIP_COUNT		8
527 	union pf_rule_ptr	 skip[PF_SKIP_COUNT];
528 #define PF_RULE_LABEL_SIZE	 64
529 	char			 label[PF_RULE_LABEL_SIZE];
530 #define PF_QNAME_SIZE		 64
531 	char			 ifname[IFNAMSIZ];
532 	char			 qname[PF_QNAME_SIZE];
533 	char			 pqname[PF_QNAME_SIZE];
534 #define	PF_TAG_NAME_SIZE	 64
535 	char			 tagname[PF_TAG_NAME_SIZE];
536 	char			 match_tagname[PF_TAG_NAME_SIZE];
537 
538 	char			 overload_tblname[PF_TABLE_NAME_SIZE];
539 
540 	TAILQ_ENTRY(pf_rule)	 entries;
541 	struct pf_pool		 rpool;
542 
543 	u_int64_t		 evaluations;
544 	u_int64_t		 packets[2];
545 	u_int64_t		 bytes[2];
546 
547 	struct pfi_kif		*kif;
548 	struct pf_anchor	*anchor;
549 	struct pfr_ktable	*overload_tbl;
550 
551 	pf_osfp_t		 os_fingerprint;
552 
553 	int			 rtableid;
554 	u_int32_t		 timeout[PFTM_MAX];
555 	u_int32_t		 states_cur;
556 	u_int32_t		 states_tot;
557 	u_int32_t		 max_states;
558 	u_int32_t		 src_nodes;
559 	u_int32_t		 max_src_nodes;
560 	u_int32_t		 max_src_states;
561 	u_int32_t		 max_src_conn;
562 	struct {
563 		u_int32_t		limit;
564 		u_int32_t		seconds;
565 	}			 max_src_conn_rate;
566 	u_int32_t		 qid;
567 	u_int32_t		 pqid;
568 	u_int32_t		 rt_listid;
569 	u_int32_t		 nr;
570 	u_int32_t		 prob;
571 	uid_t			 cuid;
572 	pid_t			 cpid;
573 
574 	u_int16_t		 return_icmp;
575 	u_int16_t		 return_icmp6;
576 	u_int16_t		 max_mss;
577 	u_int16_t		 tag;
578 	u_int16_t		 match_tag;
579 
580 	struct pf_rule_uid	 uid;
581 	struct pf_rule_gid	 gid;
582 
583 	u_int32_t		 rule_flag;
584 	u_int8_t		 action;
585 	u_int8_t		 direction;
586 	u_int8_t		 log;
587 	u_int8_t		 logif;
588 	u_int8_t		 quick;
589 	u_int8_t		 ifnot;
590 	u_int8_t		 match_tag_not;
591 	u_int8_t		 natpass;
592 
593 #define PF_STATE_NORMAL		0x1
594 #define PF_STATE_MODULATE	0x2
595 #define PF_STATE_SYNPROXY	0x3
596 	u_int8_t		 keep_state;
597 	sa_family_t		 af;
598 	u_int8_t		 proto;
599 	u_int8_t		 type;
600 	u_int8_t		 code;
601 	u_int8_t		 flags;
602 	u_int8_t		 flagset;
603 	u_int8_t		 min_ttl;
604 	u_int8_t		 allow_opts;
605 	u_int8_t		 rt;
606 	u_int8_t		 return_ttl;
607 	u_int8_t		 tos;
608 	u_int8_t		 set_tos;
609 	u_int8_t		 anchor_relative;
610 	u_int8_t		 anchor_wildcard;
611 
612 #define PF_FLUSH		0x01
613 #define PF_FLUSH_GLOBAL		0x02
614 	u_int8_t		 flush;
615 	u_int8_t		 scrub_flags;
616 	u_int8_t		 pad2[3];
617 
618 	struct {
619 		struct pf_addr		addr;
620 		u_int16_t		port;
621 	}			divert;
622 };
623 
624 /* rule flags */
625 #define	PFRULE_DROP		0x0000
626 #define	PFRULE_RETURNRST	0x0001
627 #define	PFRULE_FRAGMENT		0x0002
628 #define	PFRULE_RETURNICMP	0x0004
629 #define	PFRULE_RETURN		0x0008
630 #define	PFRULE_NOSYNC		0x0010
631 #define PFRULE_SRCTRACK		0x0020  /* track source states */
632 #define PFRULE_RULESRCTRACK	0x0040  /* per rule */
633 
634 /* rule flags again */
635 #define PFRULE_IFBOUND		0x00010000	/* if-bound */
636 #define PFRULE_STATESLOPPY	0x00020000	/* sloppy state tracking */
637 #define PFRULE_PFLOW		0x00040000
638 
639 #define PFSTATE_HIWAT		10000	/* default state table size */
640 #define PFSTATE_ADAPT_START	6000	/* default adaptive timeout start */
641 #define PFSTATE_ADAPT_END	12000	/* default adaptive timeout end */
642 
643 
644 struct pf_threshold {
645 	u_int32_t	limit;
646 #define	PF_THRESHOLD_MULT	1000
647 #define PF_THRESHOLD_MAX	0xffffffff / PF_THRESHOLD_MULT
648 	u_int32_t	seconds;
649 	u_int32_t	count;
650 	u_int32_t	last;
651 };
652 
653 struct pf_rule_item {
654 	SLIST_ENTRY(pf_rule_item)	 entry;
655 	struct pf_rule			*r;
656 };
657 
658 SLIST_HEAD(pf_rule_slist, pf_rule_item);
659 
660 struct pf_src_node {
661 	RB_ENTRY(pf_src_node) entry;
662 	struct pf_addr	 addr;
663 	struct pf_addr	 raddr;
664 	union pf_rule_ptr rule;
665 	struct pfi_kif	*kif;
666 	u_int64_t	 bytes[2];
667 	u_int64_t	 packets[2];
668 	u_int32_t	 states;
669 	u_int32_t	 conn;
670 	struct pf_threshold	conn_rate;
671 	u_int32_t	 creation;
672 	u_int32_t	 expire;
673 	sa_family_t	 af;
674 	u_int8_t	 ruletype;
675 };
676 
677 #define PFSNODE_HIWAT		10000	/* default source node table size */
678 
679 struct pf_state_scrub {
680 	struct timeval	pfss_last;	/* time received last packet	*/
681 	u_int32_t	pfss_tsecr;	/* last echoed timestamp	*/
682 	u_int32_t	pfss_tsval;	/* largest timestamp		*/
683 	u_int32_t	pfss_tsval0;	/* original timestamp		*/
684 	u_int16_t	pfss_flags;
685 #define PFSS_TIMESTAMP	0x0001		/* modulate timestamp		*/
686 #define PFSS_PAWS	0x0010		/* stricter PAWS checks		*/
687 #define PFSS_PAWS_IDLED	0x0020		/* was idle too long.  no PAWS	*/
688 #define PFSS_DATA_TS	0x0040		/* timestamp on data packets	*/
689 #define PFSS_DATA_NOTS	0x0080		/* no timestamp on data packets	*/
690 	u_int8_t	pfss_ttl;	/* stashed TTL			*/
691 	u_int8_t	pad;
692 	u_int32_t	pfss_ts_mod;	/* timestamp modulation		*/
693 };
694 
695 struct pf_state_host {
696 	struct pf_addr	addr;
697 	u_int16_t	port;
698 	u_int16_t	pad;
699 };
700 
701 struct pf_state_peer {
702 	struct pf_state_scrub	*scrub;	/* state is scrubbed		*/
703 	u_int32_t	seqlo;		/* Max sequence number sent	*/
704 	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
705 	u_int32_t	seqdiff;	/* Sequence number modulator	*/
706 	u_int16_t	max_win;	/* largest window (pre scaling)	*/
707 	u_int16_t	mss;		/* Maximum segment size option	*/
708 	u_int8_t	state;		/* active state level		*/
709 	u_int8_t	wscale;		/* window scaling factor	*/
710 	u_int8_t	tcp_est;	/* Did we reach TCPS_ESTABLISHED */
711 	u_int8_t	pad[1];
712 };
713 
714 TAILQ_HEAD(pf_state_queue, pf_state);
715 
716 /* keep synced with struct pf_state_key, used in RB_FIND */
717 struct pf_state_key_cmp {
718 	struct pf_addr	 addr[2];
719 	u_int16_t	 port[2];
720 	sa_family_t	 af;
721 	u_int8_t	 proto;
722 	u_int8_t	 pad[2];
723 };
724 
725 struct pf_state_item {
726 	TAILQ_ENTRY(pf_state_item)	 entry;
727 	struct pf_state			*s;
728 };
729 
730 TAILQ_HEAD(pf_statelisthead, pf_state_item);
731 
732 struct pf_state_key {
733 	struct pf_addr	 addr[2];
734 	u_int16_t	 port[2];
735 	sa_family_t	 af;
736 	u_int8_t	 proto;
737 	u_int8_t	 pad[2];
738 
739 	RB_ENTRY(pf_state_key)	 entry;
740 	struct pf_statelisthead	 states;
741 	struct pf_state_key	*reverse;
742 	struct inpcb		*inp;
743 };
744 
745 /* keep synced with struct pf_state, used in RB_FIND */
746 struct pf_state_cmp {
747 	u_int64_t		 id;
748 	u_int32_t		 creatorid;
749 	u_int8_t		 direction;
750 	u_int8_t		 pad[3];
751 };
752 
753 struct pf_state {
754 	u_int64_t		 id;
755 	u_int32_t		 creatorid;
756 	u_int8_t		 direction;
757 	u_int8_t		 pad[3];
758 
759 	TAILQ_ENTRY(pf_state)	 sync_list;
760 	TAILQ_ENTRY(pf_state)	 entry_list;
761 	RB_ENTRY(pf_state)	 entry_id;
762 	struct pf_state_peer	 src;
763 	struct pf_state_peer	 dst;
764 	struct pf_rule_slist	 match_rules;
765 	union pf_rule_ptr	 rule;
766 	union pf_rule_ptr	 anchor;
767 	union pf_rule_ptr	 nat_rule;
768 	struct pf_addr		 rt_addr;
769 	struct pf_state_key	*key[2];	/* addresses stack and wire  */
770 	struct pfi_kif		*kif;
771 	struct pfi_kif		*rt_kif;
772 	struct pf_src_node	*src_node;
773 	struct pf_src_node	*nat_src_node;
774 	u_int64_t		 packets[2];
775 	u_int64_t		 bytes[2];
776 	u_int32_t		 creation;
777 	u_int32_t	 	 expire;
778 	u_int32_t		 pfsync_time;
779 	u_int16_t		 qid;
780 	u_int16_t		 pqid;
781 	u_int16_t		 tag;
782 	u_int16_t		 state_flags;
783 #define	PFSTATE_ALLOWOPTS	0x0001
784 #define	PFSTATE_SLOPPY		0x0002
785 #define	PFSTATE_PFLOW		0x0004
786 #define	PFSTATE_NOSYNC		0x0008
787 #define	PFSTATE_ACK		0x0010
788 #define	PFSTATE_NODF		0x0020
789 #define	PFSTATE_SETTOS		0x0040
790 #define	PFSTATE_RANDOMID	0x0080
791 #define	PFSTATE_SCRUB_TCP	0x0100
792 	u_int8_t		 log;
793 	u_int8_t		 timeout;
794 	u_int8_t		 sync_state; /* PFSYNC_S_x */
795 
796 	/* XXX */
797 	u_int8_t		 sync_updates;
798 
799 	int16_t			 rtableid;
800 	u_int8_t		 min_ttl;
801 	u_int8_t		 set_tos;
802 	u_int16_t		 max_mss;
803 };
804 
805 /*
806  * Unified state structures for pulling states out of the kernel
807  * used by pfsync(4) and the pf(4) ioctl.
808  */
809 struct pfsync_state_scrub {
810 	u_int16_t	pfss_flags;
811 	u_int8_t	pfss_ttl;	/* stashed TTL		*/
812 #define PFSYNC_SCRUB_FLAG_VALID		0x01
813 	u_int8_t	scrub_flag;
814 	u_int32_t	pfss_ts_mod;	/* timestamp modulation	*/
815 } __packed;
816 
817 struct pfsync_state_peer {
818 	struct pfsync_state_scrub scrub;	/* state is scrubbed	*/
819 	u_int32_t	seqlo;		/* Max sequence number sent	*/
820 	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
821 	u_int32_t	seqdiff;	/* Sequence number modulator	*/
822 	u_int16_t	max_win;	/* largest window (pre scaling)	*/
823 	u_int16_t	mss;		/* Maximum segment size option	*/
824 	u_int8_t	state;		/* active state level		*/
825 	u_int8_t	wscale;		/* window scaling factor	*/
826 	u_int8_t	pad[6];
827 } __packed;
828 
829 struct pfsync_state_key {
830 	struct pf_addr	 addr[2];
831 	u_int16_t	 port[2];
832 };
833 
834 struct pfsync_state {
835 	u_int32_t	 id[2];
836 	char		 ifname[IFNAMSIZ];
837 	struct pfsync_state_key	key[2];
838 	struct pfsync_state_peer src;
839 	struct pfsync_state_peer dst;
840 	struct pf_addr	 rt_addr;
841 	u_int32_t	 rule;
842 	u_int32_t	 anchor;
843 	u_int32_t	 nat_rule;
844 	u_int32_t	 creation;
845 	u_int32_t	 expire;
846 	u_int32_t	 packets[2][2];
847 	u_int32_t	 bytes[2][2];
848 	u_int32_t	 creatorid;
849 	sa_family_t	 af;
850 	u_int8_t	 proto;
851 	u_int8_t	 direction;
852 	u_int8_t	 log;
853 	u_int8_t	 state_flags;
854 	u_int8_t	 timeout;
855 	u_int8_t	 sync_flags;
856 	u_int8_t	 updates;
857 } __packed;
858 
859 #define PFSYNC_FLAG_SRCNODE	0x04
860 #define PFSYNC_FLAG_NATSRCNODE	0x08
861 
862 /* for copies to/from network byte order */
863 /* ioctl interface also uses network byte order */
864 #define pf_state_peer_hton(s,d) do {		\
865 	(d)->seqlo = htonl((s)->seqlo);		\
866 	(d)->seqhi = htonl((s)->seqhi);		\
867 	(d)->seqdiff = htonl((s)->seqdiff);	\
868 	(d)->max_win = htons((s)->max_win);	\
869 	(d)->mss = htons((s)->mss);		\
870 	(d)->state = (s)->state;		\
871 	(d)->wscale = (s)->wscale;		\
872 	if ((s)->scrub) {						\
873 		(d)->scrub.pfss_flags = 				\
874 		    htons((s)->scrub->pfss_flags & PFSS_TIMESTAMP);	\
875 		(d)->scrub.pfss_ttl = (s)->scrub->pfss_ttl;		\
876 		(d)->scrub.pfss_ts_mod = htonl((s)->scrub->pfss_ts_mod);\
877 		(d)->scrub.scrub_flag = PFSYNC_SCRUB_FLAG_VALID;	\
878 	}								\
879 } while (0)
880 
881 #define pf_state_peer_ntoh(s,d) do {		\
882 	(d)->seqlo = ntohl((s)->seqlo);		\
883 	(d)->seqhi = ntohl((s)->seqhi);		\
884 	(d)->seqdiff = ntohl((s)->seqdiff);	\
885 	(d)->max_win = ntohs((s)->max_win);	\
886 	(d)->mss = ntohs((s)->mss);		\
887 	(d)->state = (s)->state;		\
888 	(d)->wscale = (s)->wscale;		\
889 	if ((s)->scrub.scrub_flag == PFSYNC_SCRUB_FLAG_VALID && 	\
890 	    (d)->scrub != NULL) {					\
891 		(d)->scrub->pfss_flags =				\
892 		    ntohs((s)->scrub.pfss_flags) & PFSS_TIMESTAMP;	\
893 		(d)->scrub->pfss_ttl = (s)->scrub.pfss_ttl;		\
894 		(d)->scrub->pfss_ts_mod = ntohl((s)->scrub.pfss_ts_mod);\
895 	}								\
896 } while (0)
897 
898 #define pf_state_counter_hton(s,d) do {				\
899 	d[0] = htonl((s>>32)&0xffffffff);			\
900 	d[1] = htonl(s&0xffffffff);				\
901 } while (0)
902 
903 #define pf_state_counter_from_pfsync(s)				\
904 	(((u_int64_t)(s[0])<<32) | (u_int64_t)(s[1]))
905 
906 #define pf_state_counter_ntoh(s,d) do {				\
907 	d = ntohl(s[0]);					\
908 	d = d<<32;						\
909 	d += ntohl(s[1]);					\
910 } while (0)
911 
912 TAILQ_HEAD(pf_rulequeue, pf_rule);
913 
914 struct pf_anchor;
915 
916 struct pf_ruleset {
917 	struct {
918 		struct pf_rulequeue	 queues[2];
919 		struct {
920 			struct pf_rulequeue	*ptr;
921 			struct pf_rule		**ptr_array;
922 			u_int32_t		 rcount;
923 			u_int32_t		 ticket;
924 			int			 open;
925 		}			 active, inactive;
926 	}			 rules[PF_RULESET_MAX];
927 	struct pf_anchor	*anchor;
928 	u_int32_t		 tticket;
929 	int			 tables;
930 	int			 topen;
931 };
932 
933 RB_HEAD(pf_anchor_global, pf_anchor);
934 RB_HEAD(pf_anchor_node, pf_anchor);
935 struct pf_anchor {
936 	RB_ENTRY(pf_anchor)	 entry_global;
937 	RB_ENTRY(pf_anchor)	 entry_node;
938 	struct pf_anchor	*parent;
939 	struct pf_anchor_node	 children;
940 	char			 name[PF_ANCHOR_NAME_SIZE];
941 	char			 path[MAXPATHLEN];
942 	struct pf_ruleset	 ruleset;
943 	int			 refcnt;	/* anchor rules */
944 	int			 match;
945 };
946 RB_PROTOTYPE(pf_anchor_global, pf_anchor, entry_global, pf_anchor_compare);
947 RB_PROTOTYPE(pf_anchor_node, pf_anchor, entry_node, pf_anchor_compare);
948 
949 #define PF_RESERVED_ANCHOR	"_pf"
950 
951 #define PFR_TFLAG_PERSIST	0x00000001
952 #define PFR_TFLAG_CONST		0x00000002
953 #define PFR_TFLAG_ACTIVE	0x00000004
954 #define PFR_TFLAG_INACTIVE	0x00000008
955 #define PFR_TFLAG_REFERENCED	0x00000010
956 #define PFR_TFLAG_REFDANCHOR	0x00000020
957 #define PFR_TFLAG_COUNTERS	0x00000040
958 /* Adjust masks below when adding flags. */
959 #define PFR_TFLAG_USRMASK	0x00000043
960 #define PFR_TFLAG_SETMASK	0x0000003C
961 #define PFR_TFLAG_ALLMASK	0x0000007F
962 
963 struct pfr_table {
964 	char			 pfrt_anchor[MAXPATHLEN];
965 	char			 pfrt_name[PF_TABLE_NAME_SIZE];
966 	u_int32_t		 pfrt_flags;
967 	u_int8_t		 pfrt_fback;
968 };
969 
970 enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
971 	PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
972 	PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_NOCOUNT, PFR_FB_MAX };
973 
974 struct pfr_addr {
975 	union {
976 		struct in_addr	 _pfra_ip4addr;
977 		struct in6_addr	 _pfra_ip6addr;
978 	}		 pfra_u;
979 	u_int8_t	 pfra_af;
980 	u_int8_t	 pfra_net;
981 	u_int8_t	 pfra_not;
982 	u_int8_t	 pfra_fback;
983 };
984 #define	pfra_ip4addr	pfra_u._pfra_ip4addr
985 #define	pfra_ip6addr	pfra_u._pfra_ip6addr
986 
987 enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
988 enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
989 #define PFR_OP_XPASS	PFR_OP_ADDR_MAX
990 
991 struct pfr_astats {
992 	struct pfr_addr	 pfras_a;
993 	u_int64_t	 pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
994 	u_int64_t	 pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
995 	long		 pfras_tzero;
996 };
997 
998 enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
999 
1000 struct pfr_tstats {
1001 	struct pfr_table pfrts_t;
1002 	u_int64_t	 pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1003 	u_int64_t	 pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1004 	u_int64_t	 pfrts_match;
1005 	u_int64_t	 pfrts_nomatch;
1006 	long		 pfrts_tzero;
1007 	int		 pfrts_cnt;
1008 	int		 pfrts_refcnt[PFR_REFCNT_MAX];
1009 };
1010 #define	pfrts_name	pfrts_t.pfrt_name
1011 #define pfrts_flags	pfrts_t.pfrt_flags
1012 
1013 struct pfr_kcounters {
1014 	u_int64_t		 pfrkc_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1015 	u_int64_t		 pfrkc_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1016 };
1017 
1018 SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
1019 struct pfr_kentry {
1020 	struct radix_node	 pfrke_node[2];
1021 	union sockaddr_union	 pfrke_sa;
1022 	SLIST_ENTRY(pfr_kentry)	 pfrke_workq;
1023 	union {
1024 
1025 		struct pfr_kcounters		*pfrke_counters;
1026 #if 0
1027 		struct pfr_kroute		*pfrke_route;
1028 #endif
1029 	} u;
1030 	long			 pfrke_tzero;
1031 	u_int8_t		 pfrke_af;
1032 	u_int8_t		 pfrke_net;
1033 	u_int8_t		 pfrke_not;
1034 	u_int8_t		 pfrke_mark;
1035 };
1036 #define pfrke_counters	u.pfrke_counters
1037 #define pfrke_route	u.pfrke_route
1038 
1039 
1040 SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
1041 RB_HEAD(pfr_ktablehead, pfr_ktable);
1042 struct pfr_ktable {
1043 	struct pfr_tstats	 pfrkt_ts;
1044 	RB_ENTRY(pfr_ktable)	 pfrkt_tree;
1045 	SLIST_ENTRY(pfr_ktable)	 pfrkt_workq;
1046 	struct radix_node_head	*pfrkt_ip4;
1047 	struct radix_node_head	*pfrkt_ip6;
1048 	struct pfr_ktable	*pfrkt_shadow;
1049 	struct pfr_ktable	*pfrkt_root;
1050 	struct pf_ruleset	*pfrkt_rs;
1051 	long			 pfrkt_larg;
1052 	int			 pfrkt_nflags;
1053 };
1054 #define pfrkt_t		pfrkt_ts.pfrts_t
1055 #define pfrkt_name	pfrkt_t.pfrt_name
1056 #define pfrkt_anchor	pfrkt_t.pfrt_anchor
1057 #define pfrkt_ruleset	pfrkt_t.pfrt_ruleset
1058 #define pfrkt_flags	pfrkt_t.pfrt_flags
1059 #define pfrkt_cnt	pfrkt_ts.pfrts_cnt
1060 #define pfrkt_refcnt	pfrkt_ts.pfrts_refcnt
1061 #define pfrkt_packets	pfrkt_ts.pfrts_packets
1062 #define pfrkt_bytes	pfrkt_ts.pfrts_bytes
1063 #define pfrkt_match	pfrkt_ts.pfrts_match
1064 #define pfrkt_nomatch	pfrkt_ts.pfrts_nomatch
1065 #define pfrkt_tzero	pfrkt_ts.pfrts_tzero
1066 
1067 RB_HEAD(pf_state_tree, pf_state_key);
1068 RB_PROTOTYPE(pf_state_tree, pf_state_key, entry, pf_state_compare_key);
1069 
1070 RB_HEAD(pf_state_tree_ext_gwy, pf_state_key);
1071 RB_PROTOTYPE(pf_state_tree_ext_gwy, pf_state_key,
1072     entry_ext_gwy, pf_state_compare_ext_gwy);
1073 
1074 RB_HEAD(pfi_ifhead, pfi_kif);
1075 
1076 /* state tables */
1077 extern struct pf_state_tree	 pf_statetbl;
1078 
1079 /* keep synced with pfi_kif, used in RB_FIND */
1080 struct pfi_kif_cmp {
1081 	char				 pfik_name[IFNAMSIZ];
1082 };
1083 
1084 struct pfi_kif {
1085 	char				 pfik_name[IFNAMSIZ];
1086 	RB_ENTRY(pfi_kif)		 pfik_tree;
1087 	u_int64_t			 pfik_packets[2][2][2];
1088 	u_int64_t			 pfik_bytes[2][2][2];
1089 	u_int32_t			 pfik_tzero;
1090 	int				 pfik_flags;
1091 	int				 pfik_flags_new;
1092 	void				*pfik_ah_cookie;
1093 	struct ifnet			*pfik_ifp;
1094 	struct ifg_group		*pfik_group;
1095 	int				 pfik_states;
1096 	int				 pfik_rules;
1097 	TAILQ_HEAD(, pfi_dynaddr)	 pfik_dynaddrs;
1098 };
1099 
1100 enum pfi_kif_refs {
1101 	PFI_KIF_REF_NONE,
1102 	PFI_KIF_REF_STATE,
1103 	PFI_KIF_REF_RULE
1104 };
1105 
1106 #define PFI_IFLAG_SKIP		0x0100	/* skip filtering on interface */
1107 
1108 struct pf_pdesc {
1109 	struct {
1110 		int	 done;
1111 		uid_t	 uid;
1112 		gid_t	 gid;
1113 		pid_t	 pid;
1114 	}		 lookup;
1115 	u_int64_t	 tot_len;	/* Make Mickey money */
1116 	union {
1117 		struct tcphdr		*tcp;
1118 		struct udphdr		*udp;
1119 		struct icmp		*icmp;
1120 #ifdef INET6
1121 		struct icmp6_hdr	*icmp6;
1122 #endif /* INET6 */
1123 		void			*any;
1124 	} hdr;
1125 
1126 	struct pf_rule	*nat_rule;	/* nat/rdr rule applied to packet */
1127 	struct ether_header
1128 			*eh;
1129 	struct pf_addr	*src;		/* src address */
1130 	struct pf_addr	*dst;		/* dst address */
1131 	u_int16_t *sport;
1132 	u_int16_t *dport;
1133 
1134 	u_int32_t	 p_len;		/* total length of payload */
1135 
1136 	u_int16_t	*ip_sum;
1137 	u_int16_t	*proto_sum;
1138 	u_int16_t	 flags;
1139 #define PFDESC_IP_REAS	0x0002		/* IP frags would've been reassembled */
1140 	sa_family_t	 af;
1141 	u_int8_t	 proto;
1142 	u_int8_t	 tos;
1143 	u_int8_t	 dir;		/* direction */
1144 	u_int8_t	 sidx;		/* key index for source */
1145 	u_int8_t	 didx;		/* key index for destination */
1146 };
1147 
1148 /* flags for RDR options */
1149 #define PF_DPORT_RANGE	0x01		/* Dest port uses range */
1150 #define PF_RPORT_RANGE	0x02		/* RDR'ed port uses range */
1151 
1152 /* Reasons code for passing/dropping a packet */
1153 #define PFRES_MATCH	0		/* Explicit match of a rule */
1154 #define PFRES_BADOFF	1		/* Bad offset for pull_hdr */
1155 #define PFRES_FRAG	2		/* Dropping following fragment */
1156 #define PFRES_SHORT	3		/* Dropping short packet */
1157 #define PFRES_NORM	4		/* Dropping by normalizer */
1158 #define PFRES_MEMORY	5		/* Dropped due to lacking mem */
1159 #define PFRES_TS	6		/* Bad TCP Timestamp (RFC1323) */
1160 #define PFRES_CONGEST	7		/* Congestion (of ipintrq) */
1161 #define PFRES_IPOPTIONS 8		/* IP option */
1162 #define PFRES_PROTCKSUM 9		/* Protocol checksum invalid */
1163 #define PFRES_BADSTATE	10		/* State mismatch */
1164 #define PFRES_STATEINS	11		/* State insertion failure */
1165 #define PFRES_MAXSTATES	12		/* State limit */
1166 #define PFRES_SRCLIMIT	13		/* Source node/conn limit */
1167 #define PFRES_SYNPROXY	14		/* SYN proxy */
1168 #define PFRES_MAX	15		/* total+1 */
1169 
1170 #define PFRES_NAMES { \
1171 	"match", \
1172 	"bad-offset", \
1173 	"fragment", \
1174 	"short", \
1175 	"normalize", \
1176 	"memory", \
1177 	"bad-timestamp", \
1178 	"congestion", \
1179 	"ip-option", \
1180 	"proto-cksum", \
1181 	"state-mismatch", \
1182 	"state-insert", \
1183 	"state-limit", \
1184 	"src-limit", \
1185 	"synproxy", \
1186 	NULL \
1187 }
1188 
1189 /* Counters for other things we want to keep track of */
1190 #define LCNT_STATES		0	/* states */
1191 #define LCNT_SRCSTATES		1	/* max-src-states */
1192 #define LCNT_SRCNODES		2	/* max-src-nodes */
1193 #define LCNT_SRCCONN		3	/* max-src-conn */
1194 #define LCNT_SRCCONNRATE	4	/* max-src-conn-rate */
1195 #define LCNT_OVERLOAD_TABLE	5	/* entry added to overload table */
1196 #define LCNT_OVERLOAD_FLUSH	6	/* state entries flushed */
1197 #define LCNT_MAX		7	/* total+1 */
1198 
1199 #define LCNT_NAMES { \
1200 	"max states per rule", \
1201 	"max-src-states", \
1202 	"max-src-nodes", \
1203 	"max-src-conn", \
1204 	"max-src-conn-rate", \
1205 	"overload table insertion", \
1206 	"overload flush states", \
1207 	NULL \
1208 }
1209 
1210 /* UDP state enumeration */
1211 #define PFUDPS_NO_TRAFFIC	0
1212 #define PFUDPS_SINGLE		1
1213 #define PFUDPS_MULTIPLE		2
1214 
1215 #define PFUDPS_NSTATES		3	/* number of state levels */
1216 
1217 #define PFUDPS_NAMES { \
1218 	"NO_TRAFFIC", \
1219 	"SINGLE", \
1220 	"MULTIPLE", \
1221 	NULL \
1222 }
1223 
1224 /* Other protocol state enumeration */
1225 #define PFOTHERS_NO_TRAFFIC	0
1226 #define PFOTHERS_SINGLE		1
1227 #define PFOTHERS_MULTIPLE	2
1228 
1229 #define PFOTHERS_NSTATES	3	/* number of state levels */
1230 
1231 #define PFOTHERS_NAMES { \
1232 	"NO_TRAFFIC", \
1233 	"SINGLE", \
1234 	"MULTIPLE", \
1235 	NULL \
1236 }
1237 
1238 #define FCNT_STATE_SEARCH	0
1239 #define FCNT_STATE_INSERT	1
1240 #define FCNT_STATE_REMOVALS	2
1241 #define FCNT_MAX		3
1242 
1243 #define SCNT_SRC_NODE_SEARCH	0
1244 #define SCNT_SRC_NODE_INSERT	1
1245 #define SCNT_SRC_NODE_REMOVALS	2
1246 #define SCNT_MAX		3
1247 
1248 #define ACTION_SET(a, x) \
1249 	do { \
1250 		if ((a) != NULL) \
1251 			*(a) = (x); \
1252 	} while (0)
1253 
1254 #define REASON_SET(a, x) \
1255 	do { \
1256 		if ((a) != NULL) \
1257 			*(a) = (x); \
1258 		if (x < PFRES_MAX) \
1259 			pf_status.counters[x]++; \
1260 	} while (0)
1261 
1262 struct pf_status {
1263 	u_int64_t	counters[PFRES_MAX];
1264 	u_int64_t	lcounters[LCNT_MAX];	/* limit counters */
1265 	u_int64_t	fcounters[FCNT_MAX];
1266 	u_int64_t	scounters[SCNT_MAX];
1267 	u_int64_t	pcounters[2][2][3];
1268 	u_int64_t	bcounters[2][2];
1269 	u_int64_t	stateid;
1270 	u_int32_t	running;
1271 	u_int32_t	states;
1272 	u_int32_t	src_nodes;
1273 	u_int32_t	since;
1274 	u_int32_t	debug;
1275 	u_int32_t	hostid;
1276 	u_int32_t	reass;			/* reassembly */
1277 	char		ifname[IFNAMSIZ];
1278 	u_int8_t	pf_chksum[PF_MD5_DIGEST_LENGTH];
1279 };
1280 
1281 #define PF_REASS_ENABLED	0x01
1282 #define PF_REASS_NODF		0x02
1283 
1284 struct cbq_opts {
1285 	u_int		minburst;
1286 	u_int		maxburst;
1287 	u_int		pktsize;
1288 	u_int		maxpktsize;
1289 	u_int		ns_per_byte;
1290 	u_int		maxidle;
1291 	int		minidle;
1292 	u_int		offtime;
1293 	int		flags;
1294 };
1295 
1296 struct priq_opts {
1297 	int		flags;
1298 };
1299 
1300 struct hfsc_opts {
1301 	/* real-time service curve */
1302 	u_int		rtsc_m1;	/* slope of the 1st segment in bps */
1303 	u_int		rtsc_d;		/* the x-projection of m1 in msec */
1304 	u_int		rtsc_m2;	/* slope of the 2nd segment in bps */
1305 	/* link-sharing service curve */
1306 	u_int		lssc_m1;
1307 	u_int		lssc_d;
1308 	u_int		lssc_m2;
1309 	/* upper-limit service curve */
1310 	u_int		ulsc_m1;
1311 	u_int		ulsc_d;
1312 	u_int		ulsc_m2;
1313 	int		flags;
1314 };
1315 
1316 struct pf_altq {
1317 	char			 ifname[IFNAMSIZ];
1318 
1319 	void			*altq_disc;	/* discipline-specific state */
1320 	TAILQ_ENTRY(pf_altq)	 entries;
1321 
1322 	/* scheduler spec */
1323 	u_int8_t		 scheduler;	/* scheduler type */
1324 	u_int16_t		 tbrsize;	/* tokenbucket regulator size */
1325 	u_int32_t		 ifbandwidth;	/* interface bandwidth */
1326 
1327 	/* queue spec */
1328 	char			 qname[PF_QNAME_SIZE];	/* queue name */
1329 	char			 parent[PF_QNAME_SIZE];	/* parent name */
1330 	u_int32_t		 parent_qid;	/* parent queue id */
1331 	u_int32_t		 bandwidth;	/* queue bandwidth */
1332 	u_int8_t		 priority;	/* priority */
1333 	u_int16_t		 qlimit;	/* queue size limit */
1334 	u_int16_t		 flags;		/* misc flags */
1335 	union {
1336 		struct cbq_opts		 cbq_opts;
1337 		struct priq_opts	 priq_opts;
1338 		struct hfsc_opts	 hfsc_opts;
1339 	} pq_u;
1340 
1341 	u_int32_t		 qid;		/* return value */
1342 };
1343 
1344 struct pf_tagname {
1345 	TAILQ_ENTRY(pf_tagname)	entries;
1346 	char			name[PF_TAG_NAME_SIZE];
1347 	u_int16_t		tag;
1348 	int			ref;
1349 };
1350 
1351 struct pf_divert {
1352 	union {
1353 		struct in_addr	ipv4;
1354 		struct in6_addr	ipv6;
1355 	}		addr;
1356 	u_int16_t	port;
1357 };
1358 
1359 #define PFFRAG_FRENT_HIWAT	5000	/* Number of fragment entries */
1360 #define PFFRAG_FRAG_HIWAT	1000	/* Number of fragmented packets */
1361 #define PFFRAG_FRCENT_HIWAT	50000	/* Number of fragment cache entries */
1362 #define PFFRAG_FRCACHE_HIWAT	10000	/* Number of fragment descriptors */
1363 
1364 #define PFR_KTABLE_HIWAT	1000	/* Number of tables */
1365 #define PFR_KENTRY_HIWAT	200000	/* Number of table entries */
1366 #define PFR_KENTRY_HIWAT_SMALL	100000	/* Number of table entries (tiny hosts) */
1367 
1368 /*
1369  * ioctl parameter structures
1370  */
1371 
1372 struct pfioc_pooladdr {
1373 	u_int32_t		 action;
1374 	u_int32_t		 ticket;
1375 	u_int32_t		 nr;
1376 	u_int32_t		 r_num;
1377 	u_int8_t		 r_action;
1378 	u_int8_t		 r_last;
1379 	u_int8_t		 af;
1380 	char			 anchor[MAXPATHLEN];
1381 	struct pf_pooladdr	 addr;
1382 };
1383 
1384 struct pfioc_rule {
1385 	u_int32_t	 action;
1386 	u_int32_t	 ticket;
1387 	u_int32_t	 pool_ticket;
1388 	u_int32_t	 nr;
1389 	char		 anchor[MAXPATHLEN];
1390 	char		 anchor_call[MAXPATHLEN];
1391 	struct pf_rule	 rule;
1392 };
1393 
1394 struct pfioc_natlook {
1395 	struct pf_addr	 saddr;
1396 	struct pf_addr	 daddr;
1397 	struct pf_addr	 rsaddr;
1398 	struct pf_addr	 rdaddr;
1399 	u_int16_t	 sport;
1400 	u_int16_t	 dport;
1401 	u_int16_t	 rsport;
1402 	u_int16_t	 rdport;
1403 	sa_family_t	 af;
1404 	u_int8_t	 proto;
1405 	u_int8_t	 direction;
1406 };
1407 
1408 struct pfioc_state {
1409 	struct pfsync_state	state;
1410 };
1411 
1412 struct pfioc_src_node_kill {
1413 	sa_family_t psnk_af;
1414 	struct pf_rule_addr psnk_src;
1415 	struct pf_rule_addr psnk_dst;
1416 	u_int		    psnk_killed;
1417 };
1418 
1419 struct pfioc_state_kill {
1420 	struct pf_state_cmp	psk_pfcmp;
1421 	sa_family_t		psk_af;
1422 	int			psk_proto;
1423 	struct pf_rule_addr	psk_src;
1424 	struct pf_rule_addr	psk_dst;
1425 	char			psk_ifname[IFNAMSIZ];
1426 	char			psk_label[PF_RULE_LABEL_SIZE];
1427 	u_int			psk_killed;
1428 };
1429 
1430 struct pfioc_states {
1431 	int	ps_len;
1432 	union {
1433 		caddr_t			 psu_buf;
1434 		struct pfsync_state	*psu_states;
1435 	} ps_u;
1436 #define ps_buf		ps_u.psu_buf
1437 #define ps_states	ps_u.psu_states
1438 };
1439 
1440 struct pfioc_src_nodes {
1441 	int	psn_len;
1442 	union {
1443 		caddr_t		 psu_buf;
1444 		struct pf_src_node	*psu_src_nodes;
1445 	} psn_u;
1446 #define psn_buf		psn_u.psu_buf
1447 #define psn_src_nodes	psn_u.psu_src_nodes
1448 };
1449 
1450 struct pfioc_if {
1451 	char		 ifname[IFNAMSIZ];
1452 };
1453 
1454 struct pfioc_tm {
1455 	int		 timeout;
1456 	int		 seconds;
1457 };
1458 
1459 struct pfioc_limit {
1460 	int		 index;
1461 	unsigned	 limit;
1462 };
1463 
1464 struct pfioc_altq {
1465 	u_int32_t	 action;
1466 	u_int32_t	 ticket;
1467 	u_int32_t	 nr;
1468 	struct pf_altq	 altq;
1469 };
1470 
1471 struct pfioc_qstats {
1472 	u_int32_t	 ticket;
1473 	u_int32_t	 nr;
1474 	void		*buf;
1475 	int		 nbytes;
1476 	u_int8_t	 scheduler;
1477 };
1478 
1479 struct pfioc_ruleset {
1480 	u_int32_t	 nr;
1481 	char		 path[MAXPATHLEN];
1482 	char		 name[PF_ANCHOR_NAME_SIZE];
1483 };
1484 
1485 #define PF_RULESET_ALTQ		(PF_RULESET_MAX)
1486 #define PF_RULESET_TABLE	(PF_RULESET_MAX+1)
1487 struct pfioc_trans {
1488 	int		 size;	/* number of elements */
1489 	int		 esize; /* size of each element in bytes */
1490 	struct pfioc_trans_e {
1491 		int		rs_num;
1492 		char		anchor[MAXPATHLEN];
1493 		u_int32_t	ticket;
1494 	}		*array;
1495 };
1496 
1497 #define PFR_FLAG_ATOMIC		0x00000001
1498 #define PFR_FLAG_DUMMY		0x00000002
1499 #define PFR_FLAG_FEEDBACK	0x00000004
1500 #define PFR_FLAG_CLSTATS	0x00000008
1501 #define PFR_FLAG_ADDRSTOO	0x00000010
1502 #define PFR_FLAG_REPLACE	0x00000020
1503 #define PFR_FLAG_ALLRSETS	0x00000040
1504 #define PFR_FLAG_ALLMASK	0x0000007F
1505 #ifdef _KERNEL
1506 #define PFR_FLAG_USERIOCTL	0x10000000
1507 #endif
1508 
1509 struct pfioc_table {
1510 	struct pfr_table	 pfrio_table;
1511 	void			*pfrio_buffer;
1512 	int			 pfrio_esize;
1513 	int			 pfrio_size;
1514 	int			 pfrio_size2;
1515 	int			 pfrio_nadd;
1516 	int			 pfrio_ndel;
1517 	int			 pfrio_nchange;
1518 	int			 pfrio_flags;
1519 	u_int32_t		 pfrio_ticket;
1520 };
1521 #define	pfrio_exists	pfrio_nadd
1522 #define	pfrio_nzero	pfrio_nadd
1523 #define	pfrio_nmatch	pfrio_nadd
1524 #define pfrio_naddr	pfrio_size2
1525 #define pfrio_setflag	pfrio_size2
1526 #define pfrio_clrflag	pfrio_nadd
1527 
1528 struct pfioc_iface {
1529 	char	 pfiio_name[IFNAMSIZ];
1530 	void	*pfiio_buffer;
1531 	int	 pfiio_esize;
1532 	int	 pfiio_size;
1533 	int	 pfiio_nzero;
1534 	int	 pfiio_flags;
1535 };
1536 
1537 
1538 /*
1539  * ioctl operations
1540  */
1541 
1542 #define DIOCSTART	_IO  ('D',  1)
1543 #define DIOCSTOP	_IO  ('D',  2)
1544 #define DIOCADDRULE	_IOWR('D',  4, struct pfioc_rule)
1545 #define DIOCGETRULES	_IOWR('D',  6, struct pfioc_rule)
1546 #define DIOCGETRULE	_IOWR('D',  7, struct pfioc_rule)
1547 /* XXX cut 8 - 17 */
1548 #define DIOCCLRSTATES	_IOWR('D', 18, struct pfioc_state_kill)
1549 #define DIOCGETSTATE	_IOWR('D', 19, struct pfioc_state)
1550 #define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_if)
1551 #define DIOCGETSTATUS	_IOWR('D', 21, struct pf_status)
1552 #define DIOCCLRSTATUS	_IO  ('D', 22)
1553 #define DIOCNATLOOK	_IOWR('D', 23, struct pfioc_natlook)
1554 #define DIOCSETDEBUG	_IOWR('D', 24, u_int32_t)
1555 #define DIOCGETSTATES	_IOWR('D', 25, struct pfioc_states)
1556 #define DIOCCHANGERULE	_IOWR('D', 26, struct pfioc_rule)
1557 /* XXX cut 26 - 28 */
1558 #define DIOCSETTIMEOUT	_IOWR('D', 29, struct pfioc_tm)
1559 #define DIOCGETTIMEOUT	_IOWR('D', 30, struct pfioc_tm)
1560 #define DIOCADDSTATE	_IOWR('D', 37, struct pfioc_state)
1561 #define DIOCCLRRULECTRS	_IO  ('D', 38)
1562 #define DIOCGETLIMIT	_IOWR('D', 39, struct pfioc_limit)
1563 #define DIOCSETLIMIT	_IOWR('D', 40, struct pfioc_limit)
1564 #define DIOCKILLSTATES	_IOWR('D', 41, struct pfioc_state_kill)
1565 #define DIOCSTARTALTQ	_IO  ('D', 42)
1566 #define DIOCSTOPALTQ	_IO  ('D', 43)
1567 #define DIOCADDALTQ	_IOWR('D', 45, struct pfioc_altq)
1568 #define DIOCGETALTQS	_IOWR('D', 47, struct pfioc_altq)
1569 #define DIOCGETALTQ	_IOWR('D', 48, struct pfioc_altq)
1570 #define DIOCCHANGEALTQ	_IOWR('D', 49, struct pfioc_altq)
1571 #define DIOCGETQSTATS	_IOWR('D', 50, struct pfioc_qstats)
1572 #define DIOCBEGINADDRS	_IOWR('D', 51, struct pfioc_pooladdr)
1573 #define DIOCADDADDR	_IOWR('D', 52, struct pfioc_pooladdr)
1574 #define DIOCGETADDRS	_IOWR('D', 53, struct pfioc_pooladdr)
1575 #define DIOCGETADDR	_IOWR('D', 54, struct pfioc_pooladdr)
1576 #define DIOCCHANGEADDR	_IOWR('D', 55, struct pfioc_pooladdr)
1577 /* XXX cut 55 - 57 */
1578 #define	DIOCGETRULESETS	_IOWR('D', 58, struct pfioc_ruleset)
1579 #define	DIOCGETRULESET	_IOWR('D', 59, struct pfioc_ruleset)
1580 #define	DIOCRCLRTABLES	_IOWR('D', 60, struct pfioc_table)
1581 #define	DIOCRADDTABLES	_IOWR('D', 61, struct pfioc_table)
1582 #define	DIOCRDELTABLES	_IOWR('D', 62, struct pfioc_table)
1583 #define	DIOCRGETTABLES	_IOWR('D', 63, struct pfioc_table)
1584 #define	DIOCRGETTSTATS	_IOWR('D', 64, struct pfioc_table)
1585 #define DIOCRCLRTSTATS  _IOWR('D', 65, struct pfioc_table)
1586 #define	DIOCRCLRADDRS	_IOWR('D', 66, struct pfioc_table)
1587 #define	DIOCRADDADDRS	_IOWR('D', 67, struct pfioc_table)
1588 #define	DIOCRDELADDRS	_IOWR('D', 68, struct pfioc_table)
1589 #define	DIOCRSETADDRS	_IOWR('D', 69, struct pfioc_table)
1590 #define	DIOCRGETADDRS	_IOWR('D', 70, struct pfioc_table)
1591 #define	DIOCRGETASTATS	_IOWR('D', 71, struct pfioc_table)
1592 #define DIOCRCLRASTATS  _IOWR('D', 72, struct pfioc_table)
1593 #define	DIOCRTSTADDRS	_IOWR('D', 73, struct pfioc_table)
1594 #define	DIOCRSETTFLAGS	_IOWR('D', 74, struct pfioc_table)
1595 #define DIOCRINADEFINE	_IOWR('D', 77, struct pfioc_table)
1596 #define DIOCOSFPFLUSH	_IO('D', 78)
1597 #define DIOCOSFPADD	_IOWR('D', 79, struct pf_osfp_ioctl)
1598 #define DIOCOSFPGET	_IOWR('D', 80, struct pf_osfp_ioctl)
1599 #define DIOCXBEGIN      _IOWR('D', 81, struct pfioc_trans)
1600 #define DIOCXCOMMIT     _IOWR('D', 82, struct pfioc_trans)
1601 #define DIOCXROLLBACK   _IOWR('D', 83, struct pfioc_trans)
1602 #define DIOCGETSRCNODES	_IOWR('D', 84, struct pfioc_src_nodes)
1603 #define DIOCCLRSRCNODES	_IO('D', 85)
1604 #define DIOCSETHOSTID	_IOWR('D', 86, u_int32_t)
1605 #define DIOCIGETIFACES	_IOWR('D', 87, struct pfioc_iface)
1606 #define DIOCSETIFFLAG	_IOWR('D', 89, struct pfioc_iface)
1607 #define DIOCCLRIFFLAG	_IOWR('D', 90, struct pfioc_iface)
1608 #define DIOCKILLSRCNODES	_IOWR('D', 91, struct pfioc_src_node_kill)
1609 #define DIOCSETREASS	_IOWR('D', 92, u_int32_t)
1610 
1611 #ifdef _KERNEL
1612 RB_HEAD(pf_src_tree, pf_src_node);
1613 RB_PROTOTYPE(pf_src_tree, pf_src_node, entry, pf_src_compare);
1614 extern struct pf_src_tree tree_src_tracking;
1615 
1616 RB_HEAD(pf_state_tree_id, pf_state);
1617 RB_PROTOTYPE(pf_state_tree_id, pf_state,
1618     entry_id, pf_state_compare_id);
1619 extern struct pf_state_tree_id tree_id;
1620 extern struct pf_state_queue state_list;
1621 
1622 TAILQ_HEAD(pf_poolqueue, pf_pool);
1623 extern struct pf_poolqueue		  pf_pools[2];
1624 TAILQ_HEAD(pf_altqqueue, pf_altq);
1625 extern struct pf_altqqueue		  pf_altqs[2];
1626 extern struct pf_palist			  pf_pabuf;
1627 
1628 extern u_int32_t		 ticket_altqs_active;
1629 extern u_int32_t		 ticket_altqs_inactive;
1630 extern int			 altqs_inactive_open;
1631 extern u_int32_t		 ticket_pabuf;
1632 extern struct pf_altqqueue	*pf_altqs_active;
1633 extern struct pf_altqqueue	*pf_altqs_inactive;
1634 extern struct pf_poolqueue	*pf_pools_active;
1635 extern struct pf_poolqueue	*pf_pools_inactive;
1636 extern int			 pf_tbladdr_setup(struct pf_ruleset *,
1637 				    struct pf_addr_wrap *);
1638 extern void			 pf_tbladdr_remove(struct pf_addr_wrap *);
1639 extern void			 pf_tbladdr_copyout(struct pf_addr_wrap *);
1640 extern void			 pf_calc_skip_steps(struct pf_rulequeue *);
1641 extern struct pool		 pf_src_tree_pl, pf_rule_pl;
1642 extern struct pool		 pf_state_pl, pf_state_key_pl, pf_state_item_pl,
1643 				    pf_altq_pl, pf_pooladdr_pl, pf_rule_item_pl;
1644 extern struct pool		 pf_state_scrub_pl;
1645 extern void			 pf_purge_thread(void *);
1646 extern void			 pf_purge_expired_src_nodes(int);
1647 extern void			 pf_purge_expired_states(u_int32_t);
1648 extern void			 pf_unlink_state(struct pf_state *);
1649 extern void			 pf_free_state(struct pf_state *);
1650 extern int			 pf_state_insert(struct pfi_kif *,
1651 				    struct pf_state_key *,
1652 				    struct pf_state_key *,
1653 				    struct pf_state *);
1654 extern int			 pf_insert_src_node(struct pf_src_node **,
1655 				    struct pf_rule *, struct pf_addr *,
1656 				    sa_family_t);
1657 void				 pf_src_tree_remove_state(struct pf_state *);
1658 extern struct pf_state		*pf_find_state_byid(struct pf_state_cmp *);
1659 extern struct pf_state		*pf_find_state_all(struct pf_state_key_cmp *,
1660 				    u_int, int *);
1661 extern void			 pf_print_state(struct pf_state *);
1662 extern void			 pf_print_flags(u_int8_t);
1663 extern u_int16_t		 pf_cksum_fixup(u_int16_t, u_int16_t, u_int16_t,
1664 				    u_int8_t);
1665 
1666 extern struct ifnet		*sync_ifp;
1667 extern struct pf_rule		 pf_default_rule;
1668 extern void			 pf_addrcpy(struct pf_addr *, struct pf_addr *,
1669 				    u_int8_t);
1670 void				 pf_rm_rule(struct pf_rulequeue *,
1671 				    struct pf_rule *);
1672 struct pf_divert		*pf_find_divert(struct mbuf *);
1673 
1674 #ifdef INET
1675 int	pf_test(int, struct ifnet *, struct mbuf **, struct ether_header *);
1676 #endif /* INET */
1677 
1678 #ifdef INET6
1679 int	pf_test6(int, struct ifnet *, struct mbuf **, struct ether_header *);
1680 void	pf_poolmask(struct pf_addr *, struct pf_addr*,
1681 	    struct pf_addr *, struct pf_addr *, u_int8_t);
1682 void	pf_addr_inc(struct pf_addr *, sa_family_t);
1683 #endif /* INET6 */
1684 
1685 void   *pf_pull_hdr(struct mbuf *, int, void *, int, u_short *, u_short *,
1686 	    sa_family_t);
1687 void	pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
1688 int	pflog_packet(struct pfi_kif *, struct mbuf *, sa_family_t, u_int8_t,
1689 	    u_int8_t, struct pf_rule *, struct pf_rule *, struct pf_ruleset *,
1690 	    struct pf_pdesc *);
1691 void	pf_send_deferred_syn(struct pf_state *);
1692 int	pf_match_addr(u_int8_t, struct pf_addr *, struct pf_addr *,
1693 	    struct pf_addr *, sa_family_t);
1694 int	pf_match_addr_range(struct pf_addr *, struct pf_addr *,
1695 	    struct pf_addr *, sa_family_t);
1696 int	pf_match(u_int8_t, u_int32_t, u_int32_t, u_int32_t);
1697 int	pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
1698 int	pf_match_uid(u_int8_t, uid_t, uid_t, uid_t);
1699 int	pf_match_gid(u_int8_t, gid_t, gid_t, gid_t);
1700 
1701 void	pf_normalize_init(void);
1702 int	pf_normalize_ip(struct mbuf **, int, struct pfi_kif *, u_short *,
1703 	    struct pf_pdesc *);
1704 int	pf_normalize_ip6(struct mbuf **, int, struct pfi_kif *, u_short *,
1705 	    struct pf_pdesc *);
1706 int	pf_normalize_tcp(int, struct pfi_kif *, struct mbuf *, int, int, void *,
1707 	    struct pf_pdesc *);
1708 void	pf_normalize_tcp_cleanup(struct pf_state *);
1709 int	pf_normalize_tcp_init(struct mbuf *, int, struct pf_pdesc *,
1710 	    struct tcphdr *, struct pf_state_peer *, struct pf_state_peer *);
1711 int	pf_normalize_tcp_stateful(struct mbuf *, int, struct pf_pdesc *,
1712 	    u_short *, struct tcphdr *, struct pf_state *,
1713 	    struct pf_state_peer *, struct pf_state_peer *, int *);
1714 int	pf_normalize_mss(struct mbuf *, int, struct pf_pdesc *, u_int16_t);
1715 void	pf_scrub_ip(struct mbuf **, u_int8_t, u_int8_t, u_int8_t);
1716 void	pf_scrub_ip6(struct mbuf **, u_int8_t);
1717 u_int32_t
1718 	pf_state_expires(const struct pf_state *);
1719 void	pf_purge_expired_fragments(void);
1720 int	pf_routable(struct pf_addr *addr, sa_family_t af, struct pfi_kif *);
1721 int	pf_rtlabel_match(struct pf_addr *, sa_family_t, struct pf_addr_wrap *);
1722 int	pf_socket_lookup(int, struct pf_pdesc *);
1723 struct pf_state_key *pf_alloc_state_key(int);
1724 void	pf_pkt_addr_changed(struct mbuf *);
1725 int	pf_state_key_attach(struct pf_state_key *, struct pf_state *, int);
1726 void	pfr_initialize(void);
1727 int	pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
1728 void	pfr_update_stats(struct pfr_ktable *, struct pf_addr *, sa_family_t,
1729 	    u_int64_t, int, int, int);
1730 int	pfr_pool_get(struct pfr_ktable *, int *, struct pf_addr *,
1731 	    struct pf_addr **, struct pf_addr **, sa_family_t);
1732 void	pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
1733 struct pfr_ktable *
1734 	pfr_attach_table(struct pf_ruleset *, char *, int);
1735 void	pfr_detach_table(struct pfr_ktable *);
1736 int	pfr_clr_tables(struct pfr_table *, int *, int);
1737 int	pfr_add_tables(struct pfr_table *, int, int *, int);
1738 int	pfr_del_tables(struct pfr_table *, int, int *, int);
1739 int	pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
1740 int	pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
1741 int	pfr_clr_tstats(struct pfr_table *, int, int *, int);
1742 int	pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
1743 int	pfr_clr_addrs(struct pfr_table *, int *, int);
1744 int	pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *, long);
1745 int	pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1746 	    int);
1747 int	pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1748 	    int);
1749 int	pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1750 	    int *, int *, int *, int, u_int32_t);
1751 int	pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
1752 int	pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
1753 int	pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
1754 	    int);
1755 int	pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1756 	    int);
1757 int	pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
1758 int	pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
1759 int	pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
1760 int	pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
1761 	    int *, u_int32_t, int);
1762 
1763 extern struct pfi_kif		*pfi_all;
1764 
1765 void		 pfi_initialize(void);
1766 struct pfi_kif	*pfi_kif_get(const char *);
1767 void		 pfi_kif_ref(struct pfi_kif *, enum pfi_kif_refs);
1768 void		 pfi_kif_unref(struct pfi_kif *, enum pfi_kif_refs);
1769 int		 pfi_kif_match(struct pfi_kif *, struct pfi_kif *);
1770 void		 pfi_attach_ifnet(struct ifnet *);
1771 void		 pfi_detach_ifnet(struct ifnet *);
1772 void		 pfi_attach_ifgroup(struct ifg_group *);
1773 void		 pfi_detach_ifgroup(struct ifg_group *);
1774 void		 pfi_group_change(const char *);
1775 int		 pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
1776 		    sa_family_t);
1777 int		 pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
1778 void		 pfi_dynaddr_remove(struct pf_addr_wrap *);
1779 void		 pfi_dynaddr_copyout(struct pf_addr_wrap *);
1780 void		 pfi_update_status(const char *, struct pf_status *);
1781 int		 pfi_get_ifaces(const char *, struct pfi_kif *, int *);
1782 int		 pfi_set_flags(const char *, int);
1783 int		 pfi_clear_flags(const char *, int);
1784 void		 pfi_xcommit(void);
1785 
1786 int		 pf_match_tag(struct mbuf *, struct pf_rule *, int *);
1787 u_int16_t	 pf_tagname2tag(char *);
1788 void		 pf_tag2tagname(u_int16_t, char *);
1789 void		 pf_tag_ref(u_int16_t);
1790 void		 pf_tag_unref(u_int16_t);
1791 int		 pf_tag_packet(struct mbuf *, int, int);
1792 u_int32_t	 pf_qname2qid(char *);
1793 void		 pf_qid2qname(u_int32_t, char *);
1794 void		 pf_qid_unref(u_int32_t);
1795 
1796 extern struct pf_status	pf_status;
1797 extern struct pool	pf_frent_pl, pf_frag_pl;
1798 extern struct rwlock	pf_consistency_lock;
1799 
1800 struct pf_pool_limit {
1801 	void		*pp;
1802 	unsigned	 limit;
1803 	unsigned	 limit_new;
1804 };
1805 extern struct pf_pool_limit	pf_pool_limits[PF_LIMIT_MAX];
1806 
1807 #endif /* _KERNEL */
1808 
1809 extern struct pf_anchor_global  pf_anchors;
1810 extern struct pf_anchor        pf_main_anchor;
1811 #define pf_main_ruleset	pf_main_anchor.ruleset
1812 
1813 /* these ruleset functions can be linked into userland programs (pfctl) */
1814 int			 pf_get_ruleset_number(u_int8_t);
1815 void			 pf_init_ruleset(struct pf_ruleset *);
1816 int			 pf_anchor_setup(struct pf_rule *,
1817 			    const struct pf_ruleset *, const char *);
1818 int			 pf_anchor_copyout(const struct pf_ruleset *,
1819 			    const struct pf_rule *, struct pfioc_rule *);
1820 void			 pf_anchor_remove(struct pf_rule *);
1821 void			 pf_remove_if_empty_ruleset(struct pf_ruleset *);
1822 struct pf_anchor	*pf_find_anchor(const char *);
1823 struct pf_ruleset	*pf_find_ruleset(const char *);
1824 struct pf_ruleset	*pf_find_or_create_ruleset(const char *);
1825 void			 pf_rs_initialize(void);
1826 
1827 #ifdef _KERNEL
1828 int			 pf_anchor_copyout(const struct pf_ruleset *,
1829 			    const struct pf_rule *, struct pfioc_rule *);
1830 void			 pf_anchor_remove(struct pf_rule *);
1831 
1832 #endif /* _KERNEL */
1833 
1834 /* The fingerprint functions can be linked into userland programs (tcpdump) */
1835 int	pf_osfp_add(struct pf_osfp_ioctl *);
1836 #ifdef _KERNEL
1837 struct pf_osfp_enlist *
1838 	pf_osfp_fingerprint(struct pf_pdesc *, struct mbuf *, int,
1839 	    const struct tcphdr *);
1840 #endif /* _KERNEL */
1841 struct pf_osfp_enlist *
1842 	pf_osfp_fingerprint_hdr(const struct ip *, const struct ip6_hdr *,
1843 	    const struct tcphdr *);
1844 void	pf_osfp_flush(void);
1845 int	pf_osfp_get(struct pf_osfp_ioctl *);
1846 void	pf_osfp_initialize(void);
1847 int	pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
1848 struct pf_os_fingerprint *
1849 	pf_osfp_validate(void);
1850 
1851 #ifdef _KERNEL
1852 void			 pf_print_host(struct pf_addr *, u_int16_t, u_int8_t);
1853 
1854 void			 pf_step_into_anchor(int *, struct pf_ruleset **, int,
1855 			    struct pf_rule **, struct pf_rule **, int *);
1856 int			 pf_step_out_of_anchor(int *, struct pf_ruleset **,
1857 			     int, struct pf_rule **, struct pf_rule **,
1858 			     int *);
1859 
1860 int			 pf_map_addr(u_int8_t, struct pf_rule *,
1861 			    struct pf_addr *, struct pf_addr *,
1862 			    struct pf_addr *, struct pf_src_node **);
1863 struct pf_rule		*pf_get_translation(struct pf_pdesc *, struct mbuf *,
1864 			    int, int, struct pfi_kif *, struct pf_src_node **,
1865 			    struct pf_state_key **, struct pf_state_key **,
1866 			    struct pf_state_key **, struct pf_state_key **,
1867 			    struct pf_addr *, struct pf_addr *,
1868 			    u_int16_t, u_int16_t);
1869 
1870 int			 pf_state_key_setup(struct pf_pdesc *, struct pf_rule *,
1871 			    struct pf_state_key **, struct pf_state_key **,
1872 			    struct pf_state_key **, struct pf_state_key **,
1873 			    struct pf_addr *, struct pf_addr *,
1874 			    u_int16_t, u_int16_t);
1875 #endif /* _KERNEL */
1876 
1877 
1878 #endif /* _NET_PFVAR_H_ */
1879