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