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