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