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