1/* $FreeBSD: head/sys/contrib/pf/net/pfvar.h 130933 2004-06-22 20:13:25Z brooks $ */
2/* $OpenBSD: pfvar.h,v 1.187 2004/03/22 04:54:18 mcbride 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/types.h>
38#include <sys/queue.h>
39#include <sys/tree.h>
40
41#include <net/radix.h>
42#ifdef __FreeBSD__
43#include <net/if_clone.h>
44#include <vm/uma.h>
45#else
46#include <netinet/ip_ipsp.h>
47#endif
48
49#ifdef __FreeBSD__
50#include <netinet/in.h>
51/*
52 * XXX
53 * If we include <netipsec/keydb.h>, we need _KERNEL definition.
54 * This makes pfctl compilation difficult.
55 */
56union sockaddr_union {
57 struct sockaddr sa;
58 struct sockaddr_in sin;
59 struct sockaddr_in6 sin6;
60};
61#endif
62
63#include <netinet/tcp_fsm.h>
64
65struct ip;
66
67#define PF_TCPS_PROXY_SRC ((TCP_NSTATES)+0)
68#define PF_TCPS_PROXY_DST ((TCP_NSTATES)+1)
69
70enum { PF_INOUT, PF_IN, PF_OUT };
71enum { PF_LAN_EXT, PF_EXT_GWY, PF_ID };
72enum { PF_PASS, PF_DROP, PF_SCRUB, PF_NAT, PF_NONAT,
73 PF_BINAT, PF_NOBINAT, PF_RDR, PF_NORDR, PF_SYNPROXY_DROP };
74enum { PF_RULESET_SCRUB, PF_RULESET_FILTER, PF_RULESET_NAT,
75 PF_RULESET_BINAT, PF_RULESET_RDR, PF_RULESET_MAX };
76enum { PF_OP_NONE, PF_OP_IRG, PF_OP_EQ, PF_OP_NE, PF_OP_LT,
77 PF_OP_LE, PF_OP_GT, PF_OP_GE, PF_OP_XRG, PF_OP_RRG };
78enum { PF_DEBUG_NONE, PF_DEBUG_URGENT, PF_DEBUG_MISC, PF_DEBUG_NOISY };
79enum { PF_CHANGE_NONE, PF_CHANGE_ADD_HEAD, PF_CHANGE_ADD_TAIL,
80 PF_CHANGE_ADD_BEFORE, PF_CHANGE_ADD_AFTER,
81 PF_CHANGE_REMOVE, PF_CHANGE_GET_TICKET };
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_MAX, PFTM_PURGE, PFTM_UNTIL_PACKET };
94enum { PF_NOPFROUTE, PF_FASTROUTE, PF_ROUTETO, PF_DUPTO, PF_REPLYTO };
95enum { PF_LIMIT_STATES, PF_LIMIT_SRC_NODES, PF_LIMIT_FRAGS, PF_LIMIT_MAX };
96#define PF_POOL_IDMASK 0x0f
97enum { PF_POOL_NONE, PF_POOL_BITMASK, PF_POOL_RANDOM,
98 PF_POOL_SRCHASH, PF_POOL_ROUNDROBIN };
99enum { PF_ADDR_ADDRMASK, PF_ADDR_NOROUTE, PF_ADDR_DYNIFTL,
100 PF_ADDR_TABLE };
101#define PF_POOL_TYPEMASK 0x0f
102#define PF_POOL_STICKYADDR 0x20
103#define PF_WSCALE_FLAG 0x80
104#define PF_WSCALE_MASK 0x0f
105
106struct pf_addr {
107 union {
108 struct in_addr v4;
109 struct in6_addr v6;
110 u_int8_t addr8[16];
111 u_int16_t addr16[8];
112 u_int32_t addr32[4];
113 } pfa; /* 128-bit address */
114#define v4 pfa.v4
115#define v6 pfa.v6
116#define addr8 pfa.addr8
117#define addr16 pfa.addr16
118#define addr32 pfa.addr32
119};
120
121#define PF_TABLE_NAME_SIZE 32
122
123#define PFI_AFLAG_NETWORK 0x01
124#define PFI_AFLAG_BROADCAST 0x02
125#define PFI_AFLAG_PEER 0x04
126#define PFI_AFLAG_MODEMASK 0x07
127#define PFI_AFLAG_NOALIAS 0x08
128
129struct pf_addr_wrap {
130 union {
131 struct {
132 struct pf_addr addr;
133 struct pf_addr mask;
134 } a;
135 char ifname[IFNAMSIZ];
136 char tblname[PF_TABLE_NAME_SIZE];
137 } v;
138 union {
139 struct pfi_dynaddr *dyn;
140 struct pfr_ktable *tbl;
141 int dyncnt;
142 int tblcnt;
143 } p;
144 u_int8_t type; /* PF_ADDR_* */
145 u_int8_t iflags; /* PFI_AFLAG_* */
146};
147
148#ifdef _KERNEL
149
150struct pfi_dynaddr {
151 struct pf_addr pfid_addr4;
152 struct pf_addr pfid_mask4;
153 struct pf_addr pfid_addr6;
154 struct pf_addr pfid_mask6;
155 struct pfr_ktable *pfid_kt;
156 struct pfi_kif *pfid_kif;
157 void *pfid_hook_cookie;
158 int pfid_net; /* optional mask, or 128 */
159 int pfid_acnt4; /* address count, IPv4 */
160 int pfid_acnt6; /* address count, IPv6 */
161 sa_family_t pfid_af; /* rule address family */
162 u_int8_t pfid_iflags; /* PFI_AFLAG_* */
163};
164
165/*
166 * Address manipulation macros
167 */
168
169#ifdef __FreeBSD__
170#define splsoftnet() splnet()
171
172#define HTONL(x) (x) = htonl((__uint32_t)(x))
173#define HTONS(x) (x) = htons((__uint16_t)(x))
174#define NTOHL(x) (x) = ntohl((__uint32_t)(x))
175#define NTOHS(x) (x) = ntohs((__uint16_t)(x))
176
177#define PF_NAME "pf"
178
179#define PR_NOWAIT M_NOWAIT
180#define pool_get(p, f) uma_zalloc(*(p), (f))
181#define pool_put(p, o) uma_zfree(*(p), (o))
182
183#define UMA_CREATE(var, type, desc) \
184 var = uma_zcreate(desc, sizeof(type), \
185 NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0); \
186 if (var == NULL) break
187#define UMA_DESTROY(var) \
188 if(var) uma_zdestroy(var)
189
190extern struct mtx pf_task_mtx;
191
192#define PF_ASSERT(h) mtx_assert(&pf_task_mtx, (h))
193
194#define PF_LOCK() do { \
195 PF_ASSERT(MA_NOTOWNED); \
196 mtx_lock(&pf_task_mtx); \
197} while(0)
198#define PF_UNLOCK() do { \
199 PF_ASSERT(MA_OWNED); \
200 mtx_unlock(&pf_task_mtx); \
201} while(0)
202
203#define PF_COPYIN(uaddr, kaddr, len, r) do { \
204 PF_UNLOCK(); \
205 r = copyin((uaddr), (kaddr), (len)); \
206 PF_LOCK(); \
207} while(0)
208
209#define PF_COPYOUT(kaddr, uaddr, len, r) do { \
210 PF_UNLOCK(); \
211 r = copyout((kaddr), (uaddr), (len)); \
212 PF_LOCK(); \
213} while(0)
214
215extern void init_pf_mutex(void);
216extern void destroy_pf_mutex(void);
217
218#define PF_MODVER 1
219#define PFLOG_MODVER 1
220#define PFSYNC_MODVER 1
221
222#define PFLOG_MINVER 1
223#define PFLOG_PREFVER PFLOG_MODVER
224#define PFLOG_MAXVER 1
225#define PFSYNC_MINVER 1
226#define PFSYNC_PREFVER PFSYNC_MODVER
227#define PFSYNC_MAXVER 1
228
229/* prototyped for pf_subr.c */
230struct hook_desc {
231 TAILQ_ENTRY(hook_desc) hd_list;
232 void (*hd_fn)(void *);
233 void *hd_arg;
234};
235TAILQ_HEAD(hook_desc_head, hook_desc);
236
237void *hook_establish(struct hook_desc_head *, int, void (*)(void *), void *);
238void hook_disestablish(struct hook_desc_head *, void *);
239void dohooks(struct hook_desc_head *, int);
240
241#define HOOK_REMOVE 0x01
242#define HOOK_FREE 0x02
243#endif /* __FreeBSD__ */
244
245#ifdef INET
246#ifndef INET6
247#define PF_INET_ONLY
248#endif /* ! INET6 */
249#endif /* INET */
250
251#ifdef INET6
252#ifndef INET
253#define PF_INET6_ONLY
254#endif /* ! INET */
255#endif /* INET6 */
256
257#ifdef INET
258#ifdef INET6
259#define PF_INET_INET6
260#endif /* INET6 */
261#endif /* INET */
262
263#else
264
265#define PF_INET_INET6
266
267#endif /* _KERNEL */
268
269/* Both IPv4 and IPv6 */
270#ifdef PF_INET_INET6
271
272#define PF_AEQ(a, b, c) \
273 ((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \
274 ((a)->addr32[3] == (b)->addr32[3] && \
275 (a)->addr32[2] == (b)->addr32[2] && \
276 (a)->addr32[1] == (b)->addr32[1] && \
277 (a)->addr32[0] == (b)->addr32[0])) \
278
279#define PF_ANEQ(a, b, c) \
280 ((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \
281 ((a)->addr32[3] != (b)->addr32[3] || \
282 (a)->addr32[2] != (b)->addr32[2] || \
283 (a)->addr32[1] != (b)->addr32[1] || \
284 (a)->addr32[0] != (b)->addr32[0])) \
285
286#define PF_AZERO(a, c) \
287 ((c == AF_INET && !(a)->addr32[0]) || \
288 (!(a)->addr32[0] && !(a)->addr32[1] && \
289 !(a)->addr32[2] && !(a)->addr32[3] )) \
290
291#define PF_MATCHA(n, a, m, b, f) \
292 pf_match_addr(n, a, m, b, f)
293
294#define PF_ACPY(a, b, f) \
295 pf_addrcpy(a, b, f)
296
297#define PF_AINC(a, f) \
298 pf_addr_inc(a, f)
299
300#define PF_POOLMASK(a, b, c, d, f) \
301 pf_poolmask(a, b, c, d, f)
302
303#else
304
305/* Just IPv6 */
306
307#ifdef PF_INET6_ONLY
308
309#define PF_AEQ(a, b, c) \
310 ((a)->addr32[3] == (b)->addr32[3] && \
311 (a)->addr32[2] == (b)->addr32[2] && \
312 (a)->addr32[1] == (b)->addr32[1] && \
313 (a)->addr32[0] == (b)->addr32[0]) \
314
315#define PF_ANEQ(a, b, c) \
316 ((a)->addr32[3] != (b)->addr32[3] || \
317 (a)->addr32[2] != (b)->addr32[2] || \
318 (a)->addr32[1] != (b)->addr32[1] || \
319 (a)->addr32[0] != (b)->addr32[0]) \
320
321#define PF_AZERO(a, c) \
322 (!(a)->addr32[0] && \
323 !(a)->addr32[1] && \
324 !(a)->addr32[2] && \
325 !(a)->addr32[3] ) \
326
327#define PF_MATCHA(n, a, m, b, f) \
328 pf_match_addr(n, a, m, b, f)
329
330#define PF_ACPY(a, b, f) \
331 pf_addrcpy(a, b, f)
332
333#define PF_AINC(a, f) \
334 pf_addr_inc(a, f)
335
336#define PF_POOLMASK(a, b, c, d, f) \
337 pf_poolmask(a, b, c, d, f)
338
339#else
340
341/* Just IPv4 */
342#ifdef PF_INET_ONLY
343
344#define PF_AEQ(a, b, c) \
345 ((a)->addr32[0] == (b)->addr32[0])
346
347#define PF_ANEQ(a, b, c) \
348 ((a)->addr32[0] != (b)->addr32[0])
349
350#define PF_AZERO(a, c) \
351 (!(a)->addr32[0])
352
353#define PF_MATCHA(n, a, m, b, f) \
354 pf_match_addr(n, a, m, b, f)
355
356#define PF_ACPY(a, b, f) \
357 (a)->v4.s_addr = (b)->v4.s_addr
358
359#define PF_AINC(a, f) \
360 do { \
361 (a)->addr32[0] = htonl(ntohl((a)->addr32[0]) + 1); \
362 } while (0)
363
364#define PF_POOLMASK(a, b, c, d, f) \
365 do { \
366 (a)->addr32[0] = ((b)->addr32[0] & (c)->addr32[0]) | \
367 (((c)->addr32[0] ^ 0xffffffff ) & (d)->addr32[0]); \
368 } while (0)
369
370#endif /* PF_INET_ONLY */
371#endif /* PF_INET6_ONLY */
372#endif /* PF_INET_INET6 */
373
374#define PF_MISMATCHAW(aw, x, af, not) \
375 ( \
376 (((aw)->type == PF_ADDR_NOROUTE && \
377 pf_routable((x), (af))) || \
378 ((aw)->type == PF_ADDR_TABLE && \
379 !pfr_match_addr((aw)->p.tbl, (x), (af))) || \
380 ((aw)->type == PF_ADDR_DYNIFTL && \
381 !pfi_match_addr((aw)->p.dyn, (x), (af))) || \
382 ((aw)->type == PF_ADDR_ADDRMASK && \
383 !PF_AZERO(&(aw)->v.a.mask, (af)) && \
384 !PF_MATCHA(0, &(aw)->v.a.addr, \
385 &(aw)->v.a.mask, (x), (af)))) != \
386 (not) \
387 )
388
389struct pf_rule_uid {
390 uid_t uid[2];
391 u_int8_t op;
392};
393
394struct pf_rule_gid {
395 uid_t gid[2];
396 u_int8_t op;
397};
398
399struct pf_rule_addr {
400 struct pf_addr_wrap addr;
401 u_int16_t port[2];
402 u_int8_t not;
403 u_int8_t port_op;
404};
405
406struct pf_pooladdr {
407 struct pf_addr_wrap addr;
408 TAILQ_ENTRY(pf_pooladdr) entries;
409 char ifname[IFNAMSIZ];
410 struct pfi_kif *kif;
411};
412
413TAILQ_HEAD(pf_palist, pf_pooladdr);
414
415struct pf_poolhashkey {
416 union {
417 u_int8_t key8[16];
418 u_int16_t key16[8];
419 u_int32_t key32[4];
420 } pfk; /* 128-bit hash key */
421#define key8 pfk.key8
422#define key16 pfk.key16
423#define key32 pfk.key32
424};
425
426struct pf_pool {
427 struct pf_palist list;
428 struct pf_pooladdr *cur;
429 struct pf_poolhashkey key;
430 struct pf_addr counter;
431 int tblidx;
432 u_int16_t proxy_port[2];
433 u_int8_t port_op;
434 u_int8_t opts;
435};
436
437
438/* A packed Operating System description for fingerprinting */
439typedef u_int32_t pf_osfp_t;
440#define PF_OSFP_ANY ((pf_osfp_t)0)
441#define PF_OSFP_UNKNOWN ((pf_osfp_t)-1)
442#define PF_OSFP_NOMATCH ((pf_osfp_t)-2)
443
444struct pf_osfp_entry {
445 SLIST_ENTRY(pf_osfp_entry) fp_entry;
446 pf_osfp_t fp_os;
447 int fp_enflags;
448#define PF_OSFP_EXPANDED 0x001 /* expanded entry */
449#define PF_OSFP_GENERIC 0x002 /* generic signature */
450#define PF_OSFP_NODETAIL 0x004 /* no p0f details */
451#define PF_OSFP_LEN 32
452 char fp_class_nm[PF_OSFP_LEN];
453 char fp_version_nm[PF_OSFP_LEN];
454 char fp_subtype_nm[PF_OSFP_LEN];
455};
456#define PF_OSFP_ENTRY_EQ(a, b) \
457 ((a)->fp_os == (b)->fp_os && \
458 memcmp((a)->fp_class_nm, (b)->fp_class_nm, PF_OSFP_LEN) == 0 && \
459 memcmp((a)->fp_version_nm, (b)->fp_version_nm, PF_OSFP_LEN) == 0 && \
460 memcmp((a)->fp_subtype_nm, (b)->fp_subtype_nm, PF_OSFP_LEN) == 0)
461
462/* handle pf_osfp_t packing */
463#define _FP_RESERVED_BIT 1 /* For the special negative #defines */
464#define _FP_UNUSED_BITS 1
465#define _FP_CLASS_BITS 10 /* OS Class (Windows, Linux) */
466#define _FP_VERSION_BITS 10 /* OS version (95, 98, NT, 2.4.54, 3.2) */
467#define _FP_SUBTYPE_BITS 10 /* patch level (NT SP4, SP3, ECN patch) */
468#define PF_OSFP_UNPACK(osfp, class, version, subtype) do { \
469 (class) = ((osfp) >> (_FP_VERSION_BITS+_FP_SUBTYPE_BITS)) & \
470 ((1 << _FP_CLASS_BITS) - 1); \
471 (version) = ((osfp) >> _FP_SUBTYPE_BITS) & \
472 ((1 << _FP_VERSION_BITS) - 1);\
473 (subtype) = (osfp) & ((1 << _FP_SUBTYPE_BITS) - 1); \
474} while(0)
475#define PF_OSFP_PACK(osfp, class, version, subtype) do { \
476 (osfp) = ((class) & ((1 << _FP_CLASS_BITS) - 1)) << (_FP_VERSION_BITS \
477 + _FP_SUBTYPE_BITS); \
478 (osfp) |= ((version) & ((1 << _FP_VERSION_BITS) - 1)) << \
479 _FP_SUBTYPE_BITS; \
480 (osfp) |= (subtype) & ((1 << _FP_SUBTYPE_BITS) - 1); \
481} while(0)
482
483/* the fingerprint of an OSes TCP SYN packet */
484typedef u_int64_t pf_tcpopts_t;
485struct pf_os_fingerprint {
486 SLIST_HEAD(pf_osfp_enlist, pf_osfp_entry) fp_oses; /* list of matches */
487 pf_tcpopts_t fp_tcpopts; /* packed TCP options */
488 u_int16_t fp_wsize; /* TCP window size */
489 u_int16_t fp_psize; /* ip->ip_len */
490 u_int16_t fp_mss; /* TCP MSS */
491 u_int16_t fp_flags;
492#define PF_OSFP_WSIZE_MOD 0x0001 /* Window modulus */
493#define PF_OSFP_WSIZE_DC 0x0002 /* Window don't care */
494#define PF_OSFP_WSIZE_MSS 0x0004 /* Window multiple of MSS */
495#define PF_OSFP_WSIZE_MTU 0x0008 /* Window multiple of MTU */
496#define PF_OSFP_PSIZE_MOD 0x0010 /* packet size modulus */
497#define PF_OSFP_PSIZE_DC 0x0020 /* packet size don't care */
498#define PF_OSFP_WSCALE 0x0040 /* TCP window scaling */
499#define PF_OSFP_WSCALE_MOD 0x0080 /* TCP window scale modulus */
500#define PF_OSFP_WSCALE_DC 0x0100 /* TCP window scale dont-care */
501#define PF_OSFP_MSS 0x0200 /* TCP MSS */
502#define PF_OSFP_MSS_MOD 0x0400 /* TCP MSS modulus */
503#define PF_OSFP_MSS_DC 0x0800 /* TCP MSS dont-care */
504#define PF_OSFP_DF 0x1000 /* IPv4 don't fragment bit */
505#define PF_OSFP_TS0 0x2000 /* Zero timestamp */
506 u_int8_t fp_optcnt; /* TCP option count */
507 u_int8_t fp_wscale; /* TCP window scaling */
508 u_int8_t fp_ttl; /* IPv4 TTL */
509#define PF_OSFP_MAXTTL_OFFSET 40
510/* TCP options packing */
511#define PF_OSFP_TCPOPT_NOP 0x0 /* TCP NOP option */
512#define PF_OSFP_TCPOPT_WSCALE 0x1 /* TCP window scaling option */
513#define PF_OSFP_TCPOPT_MSS 0x2 /* TCP max segment size opt */
514#define PF_OSFP_TCPOPT_SACK 0x3 /* TCP SACK OK option */
515#define PF_OSFP_TCPOPT_TS 0x4 /* TCP timestamp option */
516#define PF_OSFP_TCPOPT_BITS 3 /* bits used by each option */
517#define PF_OSFP_MAX_OPTS \
518 (sizeof(((struct pf_os_fingerprint *)0)->fp_tcpopts) * 8) \
519 / PF_OSFP_TCPOPT_BITS
520
521 SLIST_ENTRY(pf_os_fingerprint) fp_next;
522};
523
524struct pf_osfp_ioctl {
525 struct pf_osfp_entry fp_os;
526 pf_tcpopts_t fp_tcpopts; /* packed TCP options */
527 u_int16_t fp_wsize; /* TCP window size */
528 u_int16_t fp_psize; /* ip->ip_len */
529 u_int16_t fp_mss; /* TCP MSS */
530 u_int16_t fp_flags;
531 u_int8_t fp_optcnt; /* TCP option count */
532 u_int8_t fp_wscale; /* TCP window scaling */
533 u_int8_t fp_ttl; /* IPv4 TTL */
534
535 int fp_getnum; /* DIOCOSFPGET number */
536};
537
538
539union pf_rule_ptr {
540 struct pf_rule *ptr;
541 u_int32_t nr;
542};
543
544struct pf_rule {
545 struct pf_rule_addr src;
546 struct pf_rule_addr dst;
547#define PF_SKIP_IFP 0
548#define PF_SKIP_DIR 1
549#define PF_SKIP_AF 2
550#define PF_SKIP_PROTO 3
551#define PF_SKIP_SRC_ADDR 4
552#define PF_SKIP_SRC_PORT 5
553#define PF_SKIP_DST_ADDR 6
554#define PF_SKIP_DST_PORT 7
555#define PF_SKIP_COUNT 8
556 union pf_rule_ptr skip[PF_SKIP_COUNT];
557#define PF_RULE_LABEL_SIZE 64
558 char label[PF_RULE_LABEL_SIZE];
559#define PF_QNAME_SIZE 16
560 char ifname[IFNAMSIZ];
561 char qname[PF_QNAME_SIZE];
562 char pqname[PF_QNAME_SIZE];
563#define PF_ANCHOR_NAME_SIZE 16
564 char anchorname[PF_ANCHOR_NAME_SIZE];
565#define PF_TAG_NAME_SIZE 16
566 char tagname[PF_TAG_NAME_SIZE];
567 char match_tagname[PF_TAG_NAME_SIZE];
568
569 TAILQ_ENTRY(pf_rule) entries;
570 struct pf_pool rpool;
571
572 u_int64_t evaluations;
573 u_int64_t packets;
574 u_int64_t bytes;
575
576 struct pfi_kif *kif;
577 struct pf_anchor *anchor;
578
579 pf_osfp_t os_fingerprint;
580
581 u_int32_t timeout[PFTM_MAX];
582 u_int32_t states;
583 u_int32_t max_states;
584 u_int32_t src_nodes;
585 u_int32_t max_src_nodes;
586 u_int32_t max_src_states;
587 u_int32_t qid;
588 u_int32_t pqid;
589 u_int32_t rt_listid;
590 u_int32_t nr;
591
592 u_int16_t return_icmp;
593 u_int16_t return_icmp6;
594 u_int16_t max_mss;
595 u_int16_t tag;
596 u_int16_t match_tag;
597
598 struct pf_rule_uid uid;
599 struct pf_rule_gid gid;
600
601 u_int32_t rule_flag;
602 u_int8_t action;
603 u_int8_t direction;
604 u_int8_t log;
605 u_int8_t quick;
606 u_int8_t ifnot;
607 u_int8_t match_tag_not;
608 u_int8_t natpass;
609
610#define PF_STATE_NORMAL 0x1
611#define PF_STATE_MODULATE 0x2
612#define PF_STATE_SYNPROXY 0x3
613 u_int8_t keep_state;
614 sa_family_t af;
615 u_int8_t proto;
616 u_int8_t type;
617 u_int8_t code;
618 u_int8_t flags;
619 u_int8_t flagset;
620 u_int8_t min_ttl;
621 u_int8_t allow_opts;
622 u_int8_t rt;
623 u_int8_t return_ttl;
624 u_int8_t tos;
625};
626
627/* rule flags */
628#define PFRULE_DROP 0x0000
629#define PFRULE_RETURNRST 0x0001
630#define PFRULE_FRAGMENT 0x0002
631#define PFRULE_RETURNICMP 0x0004
632#define PFRULE_RETURN 0x0008
633#define PFRULE_NOSYNC 0x0010
634#define PFRULE_SRCTRACK 0x0020 /* track source states */
635#define PFRULE_RULESRCTRACK 0x0040 /* per rule */
636
637/* scrub flags */
638#define PFRULE_NODF 0x0100
639#define PFRULE_FRAGCROP 0x0200 /* non-buffering frag cache */
640#define PFRULE_FRAGDROP 0x0400 /* drop funny fragments */
641#define PFRULE_RANDOMID 0x0800
642#define PFRULE_REASSEMBLE_TCP 0x1000
643
644/* rule flags again */
645#define PFRULE_IFBOUND 0x00010000 /* if-bound */
646#define PFRULE_GRBOUND 0x00020000 /* group-bound */
647
648#define PFSTATE_HIWAT 10000 /* default state table size */
649
650struct pf_src_node {
651 RB_ENTRY(pf_src_node) entry;
652 struct pf_addr addr;
653 struct pf_addr raddr;
654 union pf_rule_ptr rule;
655 struct pfi_kif *kif;
656 u_int32_t bytes;
657 u_int32_t packets;
658 u_int32_t states;
659 u_int32_t creation;
660 u_int32_t expire;
661 sa_family_t af;
662 u_int8_t ruletype;
663};
664
665#define PFSNODE_HIWAT 10000 /* default source node table size */
666
667struct pf_state_scrub {
668 u_int16_t pfss_flags;
669#define PFSS_TIMESTAMP 0x0001 /* modulate timestamp */
670 u_int8_t pfss_ttl; /* stashed TTL */
671 u_int8_t pad;
672 u_int32_t pfss_ts_mod; /* timestamp modulation */
673};
674
675struct pf_state_host {
676 struct pf_addr addr;
677 u_int16_t port;
678 u_int16_t pad;
679};
680
681struct pf_state_peer {
682 u_int32_t seqlo; /* Max sequence number sent */
683 u_int32_t seqhi; /* Max the other end ACKd + win */
684 u_int32_t seqdiff; /* Sequence number modulator */
685 u_int16_t max_win; /* largest window (pre scaling) */
686 u_int8_t state; /* active state level */
687 u_int8_t wscale; /* window scaling factor */
688 u_int16_t mss; /* Maximum segment size option */
689 struct pf_state_scrub *scrub; /* state is scrubbed */
690};
691
692TAILQ_HEAD(pf_state_queue, pf_state);
693
694struct pf_state {
695 u_int64_t id;
696 union {
697 struct {
698 RB_ENTRY(pf_state) entry_lan_ext;
699 RB_ENTRY(pf_state) entry_ext_gwy;
700 RB_ENTRY(pf_state) entry_id;
701 TAILQ_ENTRY(pf_state) entry_updates;
702 struct pfi_kif *kif;
703 } s;
704 char ifname[IFNAMSIZ];
705 } u;
706 struct pf_state_host lan;
707 struct pf_state_host gwy;
708 struct pf_state_host ext;
709 struct pf_state_peer src;
710 struct pf_state_peer dst;
711 union pf_rule_ptr rule;
712 union pf_rule_ptr anchor;
713 union pf_rule_ptr nat_rule;
714 struct pf_addr rt_addr;
715 struct pfi_kif *rt_kif;
716 struct pf_src_node *src_node;
717 struct pf_src_node *nat_src_node;
718 u_int32_t creation;
719 u_int32_t expire;
720 u_int32_t pfsync_time;
721 u_int32_t packets[2];
722 u_int32_t bytes[2];
723 u_int32_t creatorid;
724 sa_family_t af;
725 u_int8_t proto;
726 u_int8_t direction;
727 u_int8_t log;
728 u_int8_t allow_opts;
729 u_int8_t timeout;
730 u_int8_t sync_flags;
731#define PFSTATE_NOSYNC 0x01
732#define PFSTATE_FROMSYNC 0x02
733 u_int8_t pad;
734};
735
736TAILQ_HEAD(pf_rulequeue, pf_rule);
737
738struct pf_anchor;
739
740struct pf_ruleset {
741 TAILQ_ENTRY(pf_ruleset) entries;
742#define PF_RULESET_NAME_SIZE 16
743 char name[PF_RULESET_NAME_SIZE];
744 struct {
745 struct pf_rulequeue queues[2];
746 struct {
747 struct pf_rulequeue *ptr;
748 u_int32_t ticket;
749 int open;
750 } active, inactive;
751 } rules[PF_RULESET_MAX];
752 struct pf_anchor *anchor;
753 u_int32_t tticket;
754 int tables;
755 int topen;
756};
757
758TAILQ_HEAD(pf_rulesetqueue, pf_ruleset);
759
760struct pf_anchor {
761 TAILQ_ENTRY(pf_anchor) entries;
762 char name[PF_ANCHOR_NAME_SIZE];
763 struct pf_rulesetqueue rulesets;
764 int tables;
765};
766
767TAILQ_HEAD(pf_anchorqueue, pf_anchor);
768
769#define PF_RESERVED_ANCHOR "_pf"
770#define PF_INTERFACE_RULESET "_if"
771
772#define PFR_TFLAG_PERSIST 0x00000001
773#define PFR_TFLAG_CONST 0x00000002
774#define PFR_TFLAG_ACTIVE 0x00000004
775#define PFR_TFLAG_INACTIVE 0x00000008
776#define PFR_TFLAG_REFERENCED 0x00000010
777#define PFR_TFLAG_REFDANCHOR 0x00000020
778#define PFR_TFLAG_USRMASK 0x00000003
779#define PFR_TFLAG_SETMASK 0x0000003C
780#define PFR_TFLAG_ALLMASK 0x0000003F
781
782struct pfr_table {
783 char pfrt_anchor[PF_ANCHOR_NAME_SIZE];
784 char pfrt_ruleset[PF_RULESET_NAME_SIZE];
785 char pfrt_name[PF_TABLE_NAME_SIZE];
786 u_int32_t pfrt_flags;
787 u_int8_t pfrt_fback;
788};
789
790enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
791 PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
792 PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_MAX };
793
794struct pfr_addr {
795 union {
796 struct in_addr _pfra_ip4addr;
797 struct in6_addr _pfra_ip6addr;
798 } pfra_u;
799 u_int8_t pfra_af;
800 u_int8_t pfra_net;
801 u_int8_t pfra_not;
802 u_int8_t pfra_fback;
803};
804#define pfra_ip4addr pfra_u._pfra_ip4addr
805#define pfra_ip6addr pfra_u._pfra_ip6addr
806
807enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
808enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
809#define PFR_OP_XPASS PFR_OP_ADDR_MAX
810
811struct pfr_astats {
812 struct pfr_addr pfras_a;
813 u_int64_t pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
814 u_int64_t pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
815 long pfras_tzero;
816};
817
818enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
819
820struct pfr_tstats {
821 struct pfr_table pfrts_t;
822 u_int64_t pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
823 u_int64_t pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
824 u_int64_t pfrts_match;
825 u_int64_t pfrts_nomatch;
826 long pfrts_tzero;
827 int pfrts_cnt;
828 int pfrts_refcnt[PFR_REFCNT_MAX];
829};
830#define pfrts_name pfrts_t.pfrt_name
831#define pfrts_flags pfrts_t.pfrt_flags
832
833SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
834struct pfr_kentry {
835 struct radix_node pfrke_node[2];
836 union sockaddr_union pfrke_sa;
837 u_int64_t pfrke_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
838 u_int64_t pfrke_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
839 SLIST_ENTRY(pfr_kentry) pfrke_workq;
840 long pfrke_tzero;
841 u_int8_t pfrke_af;
842 u_int8_t pfrke_net;
843 u_int8_t pfrke_not;
844 u_int8_t pfrke_mark;
845};
846
847SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
848RB_HEAD(pfr_ktablehead, pfr_ktable);
849struct pfr_ktable {
850 struct pfr_tstats pfrkt_ts;
851 RB_ENTRY(pfr_ktable) pfrkt_tree;
852 SLIST_ENTRY(pfr_ktable) pfrkt_workq;
853 struct radix_node_head *pfrkt_ip4;
854 struct radix_node_head *pfrkt_ip6;
855 struct pfr_ktable *pfrkt_shadow;
856 struct pfr_ktable *pfrkt_root;
857 struct pf_ruleset *pfrkt_rs;
858 long pfrkt_larg;
859 int pfrkt_nflags;
860};
861#define pfrkt_t pfrkt_ts.pfrts_t
862#define pfrkt_name pfrkt_t.pfrt_name
863#define pfrkt_anchor pfrkt_t.pfrt_anchor
864#define pfrkt_ruleset pfrkt_t.pfrt_ruleset
865#define pfrkt_flags pfrkt_t.pfrt_flags
866#define pfrkt_cnt pfrkt_ts.pfrts_cnt
867#define pfrkt_refcnt pfrkt_ts.pfrts_refcnt
868#define pfrkt_packets pfrkt_ts.pfrts_packets
869#define pfrkt_bytes pfrkt_ts.pfrts_bytes
870#define pfrkt_match pfrkt_ts.pfrts_match
871#define pfrkt_nomatch pfrkt_ts.pfrts_nomatch
872#define pfrkt_tzero pfrkt_ts.pfrts_tzero
873
874RB_HEAD(pf_state_tree_lan_ext, pf_state);
875RB_PROTOTYPE(pf_state_tree_lan_ext, pf_state,
876 u.s.entry_lan_ext, pf_state_compare_lan_ext);
877
878RB_HEAD(pf_state_tree_ext_gwy, pf_state);
879RB_PROTOTYPE(pf_state_tree_ext_gwy, pf_state,
880 u.s.entry_ext_gwy, pf_state_compare_ext_gwy);
881
882struct pfi_if {
883 char pfif_name[IFNAMSIZ];
884 u_int64_t pfif_packets[2][2][2];
885 u_int64_t pfif_bytes[2][2][2];
886 u_int64_t pfif_addcnt;
887 u_int64_t pfif_delcnt;
888 long pfif_tzero;
889 int pfif_states;
890 int pfif_rules;
891 int pfif_flags;
892};
893
894TAILQ_HEAD(pfi_grouphead, pfi_kif);
895TAILQ_HEAD(pfi_statehead, pfi_kif);
896RB_HEAD(pfi_ifhead, pfi_kif);
897struct pfi_kif {
898 struct pfi_if pfik_if;
899 RB_ENTRY(pfi_kif) pfik_tree;
900 struct pf_state_tree_lan_ext pfik_lan_ext;
901 struct pf_state_tree_ext_gwy pfik_ext_gwy;
902 struct pfi_grouphead pfik_grouphead;
903 TAILQ_ENTRY(pfi_kif) pfik_instances;
904 TAILQ_ENTRY(pfi_kif) pfik_w_states;
905 struct hook_desc_head *pfik_ah_head;
906 void *pfik_ah_cookie;
907 struct pfi_kif *pfik_parent;
908 struct ifnet *pfik_ifp;
909 int pfik_states;
910 int pfik_rules;
911};
912#define pfik_name pfik_if.pfif_name
913#define pfik_packets pfik_if.pfif_packets
914#define pfik_bytes pfik_if.pfif_bytes
915#define pfik_tzero pfik_if.pfif_tzero
916#define pfik_flags pfik_if.pfif_flags
917#define pfik_addcnt pfik_if.pfif_addcnt
918#define pfik_delcnt pfik_if.pfif_delcnt
919#define pfik_states pfik_if.pfif_states
920#define pfik_rules pfik_if.pfif_rules
921
922#define PFI_IFLAG_GROUP 0x0001 /* group of interfaces */
923#define PFI_IFLAG_INSTANCE 0x0002 /* single instance */
924#define PFI_IFLAG_CLONABLE 0x0010 /* clonable group */
925#define PFI_IFLAG_DYNAMIC 0x0020 /* dynamic group */
926#define PFI_IFLAG_ATTACHED 0x0040 /* interface attached */
927#define PFI_IFLAG_PLACEHOLDER 0x8000 /* placeholder group/interface */
928
929struct pf_pdesc {
930 u_int64_t tot_len; /* Make Mickey money */
931 union {
932 struct tcphdr *tcp;
933 struct udphdr *udp;
934 struct icmp *icmp;
935#ifdef INET6
936 struct icmp6_hdr *icmp6;
937#endif /* INET6 */
938 void *any;
939 } hdr;
940 struct pf_addr baddr; /* address before translation */
941 struct pf_addr naddr; /* address after translation */
942 struct pf_rule *nat_rule; /* nat/rdr rule applied to packet */
943 struct pf_addr *src;
944 struct pf_addr *dst;
945 u_int16_t *ip_sum;
946 u_int32_t p_len; /* total length of payload */
947 u_int16_t flags; /* Let SCRUB trigger behavior in
948 * state code. Easier than tags */
949#define PFDESC_TCP_NORM 0x0001 /* TCP shall be statefully scrubbed */
950 sa_family_t af;
951 u_int8_t proto;
952 u_int8_t tos;
953};
954
955/* flags for RDR options */
956#define PF_DPORT_RANGE 0x01 /* Dest port uses range */
957#define PF_RPORT_RANGE 0x02 /* RDR'ed port uses range */
958
959/* Reasons code for passing/dropping a packet */
960#define PFRES_MATCH 0 /* Explicit match of a rule */
961#define PFRES_BADOFF 1 /* Bad offset for pull_hdr */
962#define PFRES_FRAG 2 /* Dropping following fragment */
963#define PFRES_SHORT 3 /* Dropping short packet */
964#define PFRES_NORM 4 /* Dropping by normalizer */
965#define PFRES_MEMORY 5 /* Dropped due to lacking mem */
966#define PFRES_MAX 6 /* total+1 */
967
968#define PFRES_NAMES { \
969 "match", \
970 "bad-offset", \
971 "fragment", \
972 "short", \
973 "normalize", \
974 "memory", \
975 NULL \
976}
977
978/* UDP state enumeration */
979#define PFUDPS_NO_TRAFFIC 0
980#define PFUDPS_SINGLE 1
981#define PFUDPS_MULTIPLE 2
982
983#define PFUDPS_NSTATES 3 /* number of state levels */
984
985#define PFUDPS_NAMES { \
986 "NO_TRAFFIC", \
987 "SINGLE", \
988 "MULTIPLE", \
989 NULL \
990}
991
992/* Other protocol state enumeration */
993#define PFOTHERS_NO_TRAFFIC 0
994#define PFOTHERS_SINGLE 1
995#define PFOTHERS_MULTIPLE 2
996
997#define PFOTHERS_NSTATES 3 /* number of state levels */
998
999#define PFOTHERS_NAMES { \
1000 "NO_TRAFFIC", \
1001 "SINGLE", \
1002 "MULTIPLE", \
1003 NULL \
1004}
1005
1006#define FCNT_STATE_SEARCH 0
1007#define FCNT_STATE_INSERT 1
1008#define FCNT_STATE_REMOVALS 2
1009#define FCNT_MAX 3
1010
1011#define SCNT_SRC_NODE_SEARCH 0
1012#define SCNT_SRC_NODE_INSERT 1
1013#define SCNT_SRC_NODE_REMOVALS 2
1014#define SCNT_MAX 3
1015
1016#define ACTION_SET(a, x) \
1017 do { \
1018 if ((a) != NULL) \
1019 *(a) = (x); \
1020 } while (0)
1021
1022#define REASON_SET(a, x) \
1023 do { \
1024 if ((a) != NULL) \
1025 *(a) = (x); \
1026 if (x < PFRES_MAX) \
1027 pf_status.counters[x]++; \
1028 } while (0)
1029
1030struct pf_status {
1031 u_int64_t counters[PFRES_MAX];
1032 u_int64_t fcounters[FCNT_MAX];
1033 u_int64_t scounters[SCNT_MAX];
1034 u_int64_t pcounters[2][2][3];
1035 u_int64_t bcounters[2][2];
1036 u_int64_t stateid;
1037 u_int32_t running;
1038 u_int32_t states;
1039 u_int32_t src_nodes;
1040 u_int32_t since;
1041 u_int32_t debug;
1042 u_int32_t hostid;
1043 char ifname[IFNAMSIZ];
1044};
1045
1046struct cbq_opts {
1047 u_int minburst;
1048 u_int maxburst;
1049 u_int pktsize;
1050 u_int maxpktsize;
1051 u_int ns_per_byte;
1052 u_int maxidle;
1053 int minidle;
1054 u_int offtime;
1055 int flags;
1056};
1057
1058struct priq_opts {
1059 int flags;
1060};
1061
1062struct hfsc_opts {
1063 /* real-time service curve */
1064 u_int rtsc_m1; /* slope of the 1st segment in bps */
1065 u_int rtsc_d; /* the x-projection of m1 in msec */
1066 u_int rtsc_m2; /* slope of the 2nd segment in bps */
1067 /* link-sharing service curve */
1068 u_int lssc_m1;
1069 u_int lssc_d;
1070 u_int lssc_m2;
1071 /* upper-limit service curve */
1072 u_int ulsc_m1;
1073 u_int ulsc_d;
1074 u_int ulsc_m2;
1075 int flags;
1076};
1077
1078struct pf_altq {
1079 char ifname[IFNAMSIZ];
1080
1081 void *altq_disc; /* discipline-specific state */
1082 TAILQ_ENTRY(pf_altq) entries;
1083
1084 /* scheduler spec */
1085 u_int8_t scheduler; /* scheduler type */
1086 u_int16_t tbrsize; /* tokenbucket regulator size */
1087 u_int32_t ifbandwidth; /* interface bandwidth */
1088
1089 /* queue spec */
1090 char qname[PF_QNAME_SIZE]; /* queue name */
1091 char parent[PF_QNAME_SIZE]; /* parent name */
1092 u_int32_t parent_qid; /* parent queue id */
1093 u_int32_t bandwidth; /* queue bandwidth */
1094 u_int8_t priority; /* priority */
1095 u_int16_t qlimit; /* queue size limit */
1096 u_int16_t flags; /* misc flags */
1097 union {
1098 struct cbq_opts cbq_opts;
1099 struct priq_opts priq_opts;
1100 struct hfsc_opts hfsc_opts;
1101 } pq_u;
1102
1103 u_int32_t qid; /* return value */
1104};
1105
1106struct pf_tag {
1107 u_int16_t tag; /* tag id */
1108};
1109
1110struct pf_tagname {
1111 TAILQ_ENTRY(pf_tagname) entries;
1112 char name[PF_TAG_NAME_SIZE];
1113 u_int16_t tag;
1114 int ref;
1115};
1116
1117#define PFFRAG_FRENT_HIWAT 5000 /* Number of fragment entries */
1118#define PFFRAG_FRAG_HIWAT 1000 /* Number of fragmented packets */
1119#define PFFRAG_FRCENT_HIWAT 50000 /* Number of fragment cache entries */
1120#define PFFRAG_FRCACHE_HIWAT 10000 /* Number of fragment descriptors */
1121
1122/*
1123 * ioctl parameter structures
1124 */
1125
1126struct pfioc_pooladdr {
1127 u_int32_t action;
1128 u_int32_t ticket;
1129 u_int32_t nr;
1130 u_int32_t r_num;
1131 u_int8_t r_action;
1132 u_int8_t r_last;
1133 u_int8_t af;
1134 char anchor[PF_ANCHOR_NAME_SIZE];
1135 char ruleset[PF_RULESET_NAME_SIZE];
1136 struct pf_pooladdr addr;
1137};
1138
1139struct pfioc_rule {
1140 u_int32_t action;
1141 u_int32_t ticket;
1142 u_int32_t pool_ticket;
1143 u_int32_t nr;
1144 char anchor[PF_ANCHOR_NAME_SIZE];
1145 char ruleset[PF_RULESET_NAME_SIZE];
1146 struct pf_rule rule;
1147};
1148
1149struct pfioc_natlook {
1150 struct pf_addr saddr;
1151 struct pf_addr daddr;
1152 struct pf_addr rsaddr;
1153 struct pf_addr rdaddr;
1154 u_int16_t sport;
1155 u_int16_t dport;
1156 u_int16_t rsport;
1157 u_int16_t rdport;
1158 sa_family_t af;
1159 u_int8_t proto;
1160 u_int8_t direction;
1161};
1162
1163struct pfioc_state {
1164 u_int32_t nr;
1165 struct pf_state state;
1166};
1167
1168struct pfioc_state_kill {
1169 /* XXX returns the number of states killed in psk_af */
1170 sa_family_t psk_af;
1171 int psk_proto;
1172 struct pf_rule_addr psk_src;
1173 struct pf_rule_addr psk_dst;
1174 char psk_ifname[IFNAMSIZ];
1175};
1176
1177struct pfioc_states {
1178 int ps_len;
1179 union {
1180 caddr_t psu_buf;
1181 struct pf_state *psu_states;
1182 } ps_u;
1183#define ps_buf ps_u.psu_buf
1184#define ps_states ps_u.psu_states
1185};
1186
1187struct pfioc_src_nodes {
1188 int psn_len;
1189 union {
1190 caddr_t psu_buf;
1191 struct pf_src_node *psu_src_nodes;
1192 } psn_u;
1193#define psn_buf psn_u.psu_buf
1194#define psn_src_nodes psn_u.psu_src_nodes
1195};
1196
1197struct pfioc_if {
1198 char ifname[IFNAMSIZ];
1199};
1200
1201struct pfioc_tm {
1202 int timeout;
1203 int seconds;
1204};
1205
1206struct pfioc_limit {
1207 int index;
1208 unsigned limit;
1209};
1210
1211struct pfioc_altq {
1212 u_int32_t action;
1213 u_int32_t ticket;
1214 u_int32_t nr;
1215 struct pf_altq altq;
1216};
1217
1218struct pfioc_qstats {
1219 u_int32_t ticket;
1220 u_int32_t nr;
1221 void *buf;
1222 int nbytes;
1223 u_int8_t scheduler;
1224};
1225
1226struct pfioc_anchor {
1227 u_int32_t nr;
1228 char name[PF_ANCHOR_NAME_SIZE];
1229};
1230
1231struct pfioc_ruleset {
1232 u_int32_t nr;
1233 char anchor[PF_ANCHOR_NAME_SIZE];
1234 char name[PF_RULESET_NAME_SIZE];
1235};
1236
1237#define PF_RULESET_ALTQ (PF_RULESET_MAX)
1238#define PF_RULESET_TABLE (PF_RULESET_MAX+1)
1239struct pfioc_trans {
1240 int size; /* number of elements */
1241 int esize; /* size of each element in bytes */
1242 struct pfioc_trans_e {
1243 int rs_num;
1244 char anchor[PF_ANCHOR_NAME_SIZE];
1245 char ruleset[PF_RULESET_NAME_SIZE];
1246 u_int32_t ticket;
1247 } *array;
1248};
1249
1250#define PFR_FLAG_ATOMIC 0x00000001
1251#define PFR_FLAG_DUMMY 0x00000002
1252#define PFR_FLAG_FEEDBACK 0x00000004
1253#define PFR_FLAG_CLSTATS 0x00000008
1254#define PFR_FLAG_ADDRSTOO 0x00000010
1255#define PFR_FLAG_REPLACE 0x00000020
1256#define PFR_FLAG_ALLRSETS 0x00000040
1257#define PFR_FLAG_ALLMASK 0x0000007F
1258#ifdef _KERNEL
1259#define PFR_FLAG_USERIOCTL 0x10000000
1260#endif
1261
1262struct pfioc_table {
1263 struct pfr_table pfrio_table;
1264 void *pfrio_buffer;
1265 int pfrio_esize;
1266 int pfrio_size;
1267 int pfrio_size2;
1268 int pfrio_nadd;
1269 int pfrio_ndel;
1270 int pfrio_nchange;
1271 int pfrio_flags;
1272 u_int32_t pfrio_ticket;
1273};
1274#define pfrio_exists pfrio_nadd
1275#define pfrio_nzero pfrio_nadd
1276#define pfrio_nmatch pfrio_nadd
1277#define pfrio_naddr pfrio_size2
1278#define pfrio_setflag pfrio_size2
1279#define pfrio_clrflag pfrio_nadd
1280
1281
1282#define PFI_FLAG_GROUP 0x0001 /* gets groups of interfaces */
1283#define PFI_FLAG_INSTANCE 0x0002 /* gets single interfaces */
1284#define PFI_FLAG_ALLMASK 0x0003
1285
1286struct pfioc_iface {
1287 char pfiio_name[IFNAMSIZ];
1288 void *pfiio_buffer;
1289 int pfiio_esize;
1290 int pfiio_size;
1291 int pfiio_nzero;
1292 int pfiio_flags;
1293};
1294
1295
1296/*
1297 * ioctl operations
1298 */
1299
1300#define DIOCSTART _IO ('D', 1)
1301#define DIOCSTOP _IO ('D', 2)
1302#define DIOCBEGINRULES _IOWR('D', 3, struct pfioc_rule)
1303#define DIOCADDRULE _IOWR('D', 4, struct pfioc_rule)
1304#define DIOCCOMMITRULES _IOWR('D', 5, struct pfioc_rule)
1305#define DIOCGETRULES _IOWR('D', 6, struct pfioc_rule)
1306#define DIOCGETRULE _IOWR('D', 7, struct pfioc_rule)
1307/* XXX cut 8 - 17 */
1308#define DIOCCLRSTATES _IOWR('D', 18, struct pfioc_state_kill)
1309#define DIOCGETSTATE _IOWR('D', 19, struct pfioc_state)
1310#define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_if)
1311#define DIOCGETSTATUS _IOWR('D', 21, struct pf_status)
1312#define DIOCCLRSTATUS _IO ('D', 22)
1313#define DIOCNATLOOK _IOWR('D', 23, struct pfioc_natlook)
1314#define DIOCSETDEBUG _IOWR('D', 24, u_int32_t)
1315#define DIOCGETSTATES _IOWR('D', 25, struct pfioc_states)
1316#define DIOCCHANGERULE _IOWR('D', 26, struct pfioc_rule)
1317/* XXX cut 26 - 28 */
1318#define DIOCSETTIMEOUT _IOWR('D', 29, struct pfioc_tm)
1319#define DIOCGETTIMEOUT _IOWR('D', 30, struct pfioc_tm)
1320#define DIOCADDSTATE _IOWR('D', 37, struct pfioc_state)
1321#define DIOCCLRRULECTRS _IO ('D', 38)
1322#define DIOCGETLIMIT _IOWR('D', 39, struct pfioc_limit)
1323#define DIOCSETLIMIT _IOWR('D', 40, struct pfioc_limit)
1324#define DIOCKILLSTATES _IOWR('D', 41, struct pfioc_state_kill)
1325#define DIOCSTARTALTQ _IO ('D', 42)
1326#define DIOCSTOPALTQ _IO ('D', 43)
1327#define DIOCBEGINALTQS _IOWR('D', 44, u_int32_t)
1328#define DIOCADDALTQ _IOWR('D', 45, struct pfioc_altq)
1329#define DIOCCOMMITALTQS _IOWR('D', 46, u_int32_t)
1330#define DIOCGETALTQS _IOWR('D', 47, struct pfioc_altq)
1331#define DIOCGETALTQ _IOWR('D', 48, struct pfioc_altq)
1332#define DIOCCHANGEALTQ _IOWR('D', 49, struct pfioc_altq)
1333#define DIOCGETQSTATS _IOWR('D', 50, struct pfioc_qstats)
1334#define DIOCBEGINADDRS _IOWR('D', 51, struct pfioc_pooladdr)
1335#define DIOCADDADDR _IOWR('D', 52, struct pfioc_pooladdr)
1336#define DIOCGETADDRS _IOWR('D', 53, struct pfioc_pooladdr)
1337#define DIOCGETADDR _IOWR('D', 54, struct pfioc_pooladdr)
1338#define DIOCCHANGEADDR _IOWR('D', 55, struct pfioc_pooladdr)
1339#define DIOCGETANCHORS _IOWR('D', 56, struct pfioc_anchor)
1340#define DIOCGETANCHOR _IOWR('D', 57, struct pfioc_anchor)
1341#define DIOCGETRULESETS _IOWR('D', 58, struct pfioc_ruleset)
1342#define DIOCGETRULESET _IOWR('D', 59, struct pfioc_ruleset)
1343#define DIOCRCLRTABLES _IOWR('D', 60, struct pfioc_table)
1344#define DIOCRADDTABLES _IOWR('D', 61, struct pfioc_table)
1345#define DIOCRDELTABLES _IOWR('D', 62, struct pfioc_table)
1346#define DIOCRGETTABLES _IOWR('D', 63, struct pfioc_table)
1347#define DIOCRGETTSTATS _IOWR('D', 64, struct pfioc_table)
1348#define DIOCRCLRTSTATS _IOWR('D', 65, struct pfioc_table)
1349#define DIOCRCLRADDRS _IOWR('D', 66, struct pfioc_table)
1350#define DIOCRADDADDRS _IOWR('D', 67, struct pfioc_table)
1351#define DIOCRDELADDRS _IOWR('D', 68, struct pfioc_table)
1352#define DIOCRSETADDRS _IOWR('D', 69, struct pfioc_table)
1353#define DIOCRGETADDRS _IOWR('D', 70, struct pfioc_table)
1354#define DIOCRGETASTATS _IOWR('D', 71, struct pfioc_table)
1355#define DIOCRCLRASTATS _IOWR('D', 72, struct pfioc_table)
1356#define DIOCRTSTADDRS _IOWR('D', 73, struct pfioc_table)
1357#define DIOCRSETTFLAGS _IOWR('D', 74, struct pfioc_table)
1358#define DIOCRINABEGIN _IOWR('D', 75, struct pfioc_table)
1359#define DIOCRINACOMMIT _IOWR('D', 76, struct pfioc_table)
1360#define DIOCRINADEFINE _IOWR('D', 77, struct pfioc_table)
1361#define DIOCOSFPFLUSH _IO('D', 78)
1362#define DIOCOSFPADD _IOWR('D', 79, struct pf_osfp_ioctl)
1363#define DIOCOSFPGET _IOWR('D', 80, struct pf_osfp_ioctl)
1364#define DIOCXBEGIN _IOWR('D', 81, struct pfioc_trans)
1365#define DIOCXCOMMIT _IOWR('D', 82, struct pfioc_trans)
1366#define DIOCXROLLBACK _IOWR('D', 83, struct pfioc_trans)
1367#define DIOCGETSRCNODES _IOWR('D', 84, struct pfioc_src_nodes)
1368#define DIOCCLRSRCNODES _IO('D', 85)
1369#define DIOCSETHOSTID _IOWR('D', 86, u_int32_t)
1370#define DIOCIGETIFACES _IOWR('D', 87, struct pfioc_iface)
1371#define DIOCICLRISTATS _IOWR('D', 88, struct pfioc_iface)
1372#ifdef __FreeBSD__
1373struct pf_ifspeed {
1374 char ifname[IFNAMSIZ];
1375 u_int32_t baudrate;
1376};
1377#define DIOCGIFSPEED _IOWR('D', 89, struct pf_ifspeed)
1378#endif
1379
1380#ifdef _KERNEL
1381RB_HEAD(pf_src_tree, pf_src_node);
1382RB_PROTOTYPE(pf_src_tree, pf_src_node, entry, pf_src_compare);
1383extern struct pf_src_tree tree_src_tracking;
1384
1385RB_HEAD(pf_state_tree_id, pf_state);
1386RB_PROTOTYPE(pf_state_tree_id, pf_state,
1387 entry_id, pf_state_compare_id);
1388extern struct pf_state_tree_id tree_id;
1389extern struct pf_state_queue state_updates;
1390
1391extern struct pf_anchorqueue pf_anchors;
1392extern struct pf_ruleset pf_main_ruleset;
1393TAILQ_HEAD(pf_poolqueue, pf_pool);
1394extern struct pf_poolqueue pf_pools[2];
1395TAILQ_HEAD(pf_altqqueue, pf_altq);
1396extern struct pf_altqqueue pf_altqs[2];
1397extern struct pf_palist pf_pabuf;
1398extern struct pfi_kif **pfi_index2kif;
1399
1400extern u_int32_t ticket_altqs_active;
1401extern u_int32_t ticket_altqs_inactive;
1402extern int altqs_inactive_open;
1403extern u_int32_t ticket_pabuf;
1404extern struct pf_altqqueue *pf_altqs_active;
1405extern struct pf_altqqueue *pf_altqs_inactive;
1406extern struct pf_poolqueue *pf_pools_active;
1407extern struct pf_poolqueue *pf_pools_inactive;
1408extern int pf_tbladdr_setup(struct pf_ruleset *,
1409 struct pf_addr_wrap *);
1410extern void pf_tbladdr_remove(struct pf_addr_wrap *);
1411extern void pf_tbladdr_copyout(struct pf_addr_wrap *);
1412extern void pf_calc_skip_steps(struct pf_rulequeue *);
1413extern void pf_update_anchor_rules(void);
1414#ifdef __FreeBSD__
1415extern uma_zone_t pf_src_tree_pl, pf_rule_pl;
1416extern uma_zone_t pf_state_pl, pf_altq_pl, pf_pooladdr_pl;
1417extern uma_zone_t pfr_ktable_pl, pfr_kentry_pl;
1418extern uma_zone_t pf_cache_pl, pf_cent_pl;
1419extern uma_zone_t pf_state_scrub_pl;
1420extern uma_zone_t pfi_addr_pl;
1421#else
1422extern struct pool pf_src_tree_pl, pf_rule_pl;
1423extern struct pool pf_state_pl, pf_altq_pl, pf_pooladdr_pl;
1424extern struct pool pf_state_scrub_pl;
1425#endif
1426extern void pf_purge_timeout(void *);
1427extern void pf_purge_expired_src_nodes(void);
1428extern void pf_purge_expired_states(void);
1429extern int pf_insert_state(struct pfi_kif *,
1430 struct pf_state *);
1431extern int pf_insert_src_node(struct pf_src_node **,
1432 struct pf_rule *, struct pf_addr *,
1433 sa_family_t);
1434void pf_src_tree_remove_state(struct pf_state *);
1435extern struct pf_state *pf_find_state_byid(struct pf_state *);
1436extern struct pf_state *pf_find_state_all(struct pf_state *key,
1437 u_int8_t tree, int *more);
1438extern struct pf_anchor *pf_find_anchor(const char *);
1439extern struct pf_ruleset *pf_find_ruleset(char *, char *);
1440extern struct pf_ruleset *pf_find_or_create_ruleset(
1441 char[PF_ANCHOR_NAME_SIZE],
1442 char[PF_RULESET_NAME_SIZE]);
1443extern void pf_remove_if_empty_ruleset(
1444 struct pf_ruleset *);
1445
1446extern struct ifnet *sync_ifp;
1447extern struct pf_rule pf_default_rule;
1448extern void pf_addrcpy(struct pf_addr *, struct pf_addr *,
1449 u_int8_t);
1450void pf_rm_rule(struct pf_rulequeue *,
1451 struct pf_rule *);
1452
1453#ifdef INET
1454int pf_test(int, struct ifnet *, struct mbuf **);
1455#endif /* INET */
1456
1457#ifdef INET6
1458int pf_test6(int, struct ifnet *, struct mbuf **);
1459void pf_poolmask(struct pf_addr *, struct pf_addr*,
1460 struct pf_addr *, struct pf_addr *, u_int8_t);
1461void pf_addr_inc(struct pf_addr *, sa_family_t);
1462#endif /* INET6 */
1463
1464void *pf_pull_hdr(struct mbuf *, int, void *, int, u_short *, u_short *,
1465 sa_family_t);
1466void pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
1467int pflog_packet(struct pfi_kif *, struct mbuf *, sa_family_t, u_int8_t,
1468 u_int8_t, struct pf_rule *, struct pf_rule *, struct pf_ruleset *);
1469int pf_match_addr(u_int8_t, struct pf_addr *, struct pf_addr *,
1470 struct pf_addr *, sa_family_t);
1471int pf_match(u_int8_t, u_int32_t, u_int32_t, u_int32_t);
1472int pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
1473int pf_match_uid(u_int8_t, uid_t, uid_t, uid_t);
1474int pf_match_gid(u_int8_t, gid_t, gid_t, gid_t);
1475
1476void pf_normalize_init(void);
1477int pf_normalize_ip(struct mbuf **, int, struct pfi_kif *, u_short *);
1478int pf_normalize_ip6(struct mbuf **, int, struct pfi_kif *, u_short *);
1479int pf_normalize_tcp(int, struct pfi_kif *, struct mbuf *, int, int, void *,
1480 struct pf_pdesc *);
1481void pf_normalize_tcp_cleanup(struct pf_state *);
1482int pf_normalize_tcp_init(struct mbuf *, int, struct pf_pdesc *,
1483 struct tcphdr *, struct pf_state_peer *, struct pf_state_peer *);
1484int pf_normalize_tcp_stateful(struct mbuf *, int, struct pf_pdesc *,
1485 u_short *, struct tcphdr *, struct pf_state_peer *,
1486 struct pf_state_peer *, int *);
1487u_int32_t
1488 pf_state_expires(const struct pf_state *);
1489void pf_purge_expired_fragments(void);
1490int pf_routable(struct pf_addr *addr, sa_family_t af);
1491void pfr_initialize(void);
1492int pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
1493void pfr_update_stats(struct pfr_ktable *, struct pf_addr *, sa_family_t,
1494 u_int64_t, int, int, int);
1495int pfr_pool_get(struct pfr_ktable *, int *, struct pf_addr *,
1496 struct pf_addr **, struct pf_addr **, sa_family_t);
1497void pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
1498struct pfr_ktable *
1499 pfr_attach_table(struct pf_ruleset *, char *);
1500void pfr_detach_table(struct pfr_ktable *);
1501int pfr_clr_tables(struct pfr_table *, int *, int);
1502int pfr_add_tables(struct pfr_table *, int, int *, int);
1503int pfr_del_tables(struct pfr_table *, int, int *, int);
1504int pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
1505int pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
1506int pfr_clr_tstats(struct pfr_table *, int, int *, int);
1507int pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
1508int pfr_clr_addrs(struct pfr_table *, int *, int);
1509int pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1510 int);
1511int pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1512 int);
1513int pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1514 int *, int *, int *, int);
1515int pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
1516int pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
1517int pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
1518 int);
1519int pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1520 int);
1521int pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
1522int pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
1523int pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
1524int pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
1525 int *, u_int32_t, int);
1526
1527void pfi_initialize(void);
1528#ifdef __FreeBSD__
1529void pfi_cleanup(void);
1530#endif
1531void pfi_attach_clone(struct if_clone *);
1532void pfi_attach_ifnet(struct ifnet *);
1533void pfi_detach_ifnet(struct ifnet *);
1534struct pfi_kif *pfi_lookup_create(const char *);
1535struct pfi_kif *pfi_lookup_if(const char *);
1536int pfi_maybe_destroy(struct pfi_kif *);
1537struct pfi_kif *pfi_attach_rule(const char *);
1538void pfi_detach_rule(struct pfi_kif *);
1539void pfi_attach_state(struct pfi_kif *);
1540void pfi_detach_state(struct pfi_kif *);
1541int pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
1542void pfi_dynaddr_copyout(struct pf_addr_wrap *);
1543void pfi_dynaddr_remove(struct pf_addr_wrap *);
1544void pfi_fill_oldstatus(struct pf_status *);
1545int pfi_clr_istats(const char *, int *, int);
1546int pfi_get_ifaces(const char *, struct pfi_if *, int *, int);
1547int pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
1548 sa_family_t);
1549
1550extern struct pfi_statehead pfi_statehead;
1551
1552u_int16_t pf_tagname2tag(char *);
1553void pf_tag2tagname(u_int16_t, char *);
1554void pf_tag_unref(u_int16_t);
1555int pf_tag_packet(struct mbuf *, struct pf_tag *, int);
1556u_int32_t pf_qname2qid(char *);
1557void pf_qid2qname(u_int32_t, char *);
1558void pf_qid_unref(u_int32_t);
1559
1560extern struct pf_status pf_status;
1561
1562#ifdef __FreeBSD__
1563extern uma_zone_t pf_frent_pl, pf_frag_pl;
1564#else
1565extern struct pool pf_frent_pl, pf_frag_pl;
1566#endif
1567
1568struct pf_pool_limit {
1569 void *pp;
1570 unsigned limit;
1571};
1572extern struct pf_pool_limit pf_pool_limits[PF_LIMIT_MAX];
1573
1574#ifdef __FreeBSD__
1575struct pf_frent {
1576 LIST_ENTRY(pf_frent) fr_next;
1577 struct ip *fr_ip;
1578 struct mbuf *fr_m;
1579};
1580
1581struct pf_frcache {
1582 LIST_ENTRY(pf_frcache) fr_next;
1583 uint16_t fr_off;
1584 uint16_t fr_end;
1585};
1586
1587struct pf_fragment {
1588 RB_ENTRY(pf_fragment) fr_entry;
1589 TAILQ_ENTRY(pf_fragment) frag_next;
1590 struct in_addr fr_src;
1591 struct in_addr fr_dst;
1592 u_int8_t fr_p; /* protocol of this fragment */
1593 u_int8_t fr_flags; /* status flags */
1594 u_int16_t fr_id; /* fragment id for reassemble */
1595 u_int16_t fr_max; /* fragment data max */
1596 u_int32_t fr_timeout;
1597#define fr_queue fr_u.fru_queue
1598#define fr_cache fr_u.fru_cache
1599 union {
1600 LIST_HEAD(pf_fragq, pf_frent) fru_queue; /* buffering */
1601 LIST_HEAD(pf_cacheq, pf_frcache) fru_cache; /* non-buf */
1602 } fr_u;
1603};
1604#endif /* (__FreeBSD__) */
1605
1606#endif /* _KERNEL */
1607
1608/* The fingerprint functions can be linked into userland programs (tcpdump) */
1609int pf_osfp_add(struct pf_osfp_ioctl *);
1610#ifdef _KERNEL
1611struct pf_osfp_enlist *
1612 pf_osfp_fingerprint(struct pf_pdesc *, struct mbuf *, int,
1613 const struct tcphdr *);
1614#endif /* _KERNEL */
1615struct pf_osfp_enlist *
1616 pf_osfp_fingerprint_hdr(const struct ip *, const struct tcphdr *);
1617void pf_osfp_flush(void);
1618int pf_osfp_get(struct pf_osfp_ioctl *);
1619#ifdef __FreeBSD__
1620int pf_osfp_initialize(void);
1621void pf_osfp_cleanup(void);
1622#else
1623void pf_osfp_initialize(void);
1624#endif
1625int pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
1626struct pf_os_fingerprint *
1627 pf_osfp_validate(void);
1628
1629
1630#endif /* _NET_PFVAR_H_ */
2/* $OpenBSD: pfvar.h,v 1.187 2004/03/22 04:54:18 mcbride 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/types.h>
38#include <sys/queue.h>
39#include <sys/tree.h>
40
41#include <net/radix.h>
42#ifdef __FreeBSD__
43#include <net/if_clone.h>
44#include <vm/uma.h>
45#else
46#include <netinet/ip_ipsp.h>
47#endif
48
49#ifdef __FreeBSD__
50#include <netinet/in.h>
51/*
52 * XXX
53 * If we include <netipsec/keydb.h>, we need _KERNEL definition.
54 * This makes pfctl compilation difficult.
55 */
56union sockaddr_union {
57 struct sockaddr sa;
58 struct sockaddr_in sin;
59 struct sockaddr_in6 sin6;
60};
61#endif
62
63#include <netinet/tcp_fsm.h>
64
65struct ip;
66
67#define PF_TCPS_PROXY_SRC ((TCP_NSTATES)+0)
68#define PF_TCPS_PROXY_DST ((TCP_NSTATES)+1)
69
70enum { PF_INOUT, PF_IN, PF_OUT };
71enum { PF_LAN_EXT, PF_EXT_GWY, PF_ID };
72enum { PF_PASS, PF_DROP, PF_SCRUB, PF_NAT, PF_NONAT,
73 PF_BINAT, PF_NOBINAT, PF_RDR, PF_NORDR, PF_SYNPROXY_DROP };
74enum { PF_RULESET_SCRUB, PF_RULESET_FILTER, PF_RULESET_NAT,
75 PF_RULESET_BINAT, PF_RULESET_RDR, PF_RULESET_MAX };
76enum { PF_OP_NONE, PF_OP_IRG, PF_OP_EQ, PF_OP_NE, PF_OP_LT,
77 PF_OP_LE, PF_OP_GT, PF_OP_GE, PF_OP_XRG, PF_OP_RRG };
78enum { PF_DEBUG_NONE, PF_DEBUG_URGENT, PF_DEBUG_MISC, PF_DEBUG_NOISY };
79enum { PF_CHANGE_NONE, PF_CHANGE_ADD_HEAD, PF_CHANGE_ADD_TAIL,
80 PF_CHANGE_ADD_BEFORE, PF_CHANGE_ADD_AFTER,
81 PF_CHANGE_REMOVE, PF_CHANGE_GET_TICKET };
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_MAX, PFTM_PURGE, PFTM_UNTIL_PACKET };
94enum { PF_NOPFROUTE, PF_FASTROUTE, PF_ROUTETO, PF_DUPTO, PF_REPLYTO };
95enum { PF_LIMIT_STATES, PF_LIMIT_SRC_NODES, PF_LIMIT_FRAGS, PF_LIMIT_MAX };
96#define PF_POOL_IDMASK 0x0f
97enum { PF_POOL_NONE, PF_POOL_BITMASK, PF_POOL_RANDOM,
98 PF_POOL_SRCHASH, PF_POOL_ROUNDROBIN };
99enum { PF_ADDR_ADDRMASK, PF_ADDR_NOROUTE, PF_ADDR_DYNIFTL,
100 PF_ADDR_TABLE };
101#define PF_POOL_TYPEMASK 0x0f
102#define PF_POOL_STICKYADDR 0x20
103#define PF_WSCALE_FLAG 0x80
104#define PF_WSCALE_MASK 0x0f
105
106struct pf_addr {
107 union {
108 struct in_addr v4;
109 struct in6_addr v6;
110 u_int8_t addr8[16];
111 u_int16_t addr16[8];
112 u_int32_t addr32[4];
113 } pfa; /* 128-bit address */
114#define v4 pfa.v4
115#define v6 pfa.v6
116#define addr8 pfa.addr8
117#define addr16 pfa.addr16
118#define addr32 pfa.addr32
119};
120
121#define PF_TABLE_NAME_SIZE 32
122
123#define PFI_AFLAG_NETWORK 0x01
124#define PFI_AFLAG_BROADCAST 0x02
125#define PFI_AFLAG_PEER 0x04
126#define PFI_AFLAG_MODEMASK 0x07
127#define PFI_AFLAG_NOALIAS 0x08
128
129struct pf_addr_wrap {
130 union {
131 struct {
132 struct pf_addr addr;
133 struct pf_addr mask;
134 } a;
135 char ifname[IFNAMSIZ];
136 char tblname[PF_TABLE_NAME_SIZE];
137 } v;
138 union {
139 struct pfi_dynaddr *dyn;
140 struct pfr_ktable *tbl;
141 int dyncnt;
142 int tblcnt;
143 } p;
144 u_int8_t type; /* PF_ADDR_* */
145 u_int8_t iflags; /* PFI_AFLAG_* */
146};
147
148#ifdef _KERNEL
149
150struct pfi_dynaddr {
151 struct pf_addr pfid_addr4;
152 struct pf_addr pfid_mask4;
153 struct pf_addr pfid_addr6;
154 struct pf_addr pfid_mask6;
155 struct pfr_ktable *pfid_kt;
156 struct pfi_kif *pfid_kif;
157 void *pfid_hook_cookie;
158 int pfid_net; /* optional mask, or 128 */
159 int pfid_acnt4; /* address count, IPv4 */
160 int pfid_acnt6; /* address count, IPv6 */
161 sa_family_t pfid_af; /* rule address family */
162 u_int8_t pfid_iflags; /* PFI_AFLAG_* */
163};
164
165/*
166 * Address manipulation macros
167 */
168
169#ifdef __FreeBSD__
170#define splsoftnet() splnet()
171
172#define HTONL(x) (x) = htonl((__uint32_t)(x))
173#define HTONS(x) (x) = htons((__uint16_t)(x))
174#define NTOHL(x) (x) = ntohl((__uint32_t)(x))
175#define NTOHS(x) (x) = ntohs((__uint16_t)(x))
176
177#define PF_NAME "pf"
178
179#define PR_NOWAIT M_NOWAIT
180#define pool_get(p, f) uma_zalloc(*(p), (f))
181#define pool_put(p, o) uma_zfree(*(p), (o))
182
183#define UMA_CREATE(var, type, desc) \
184 var = uma_zcreate(desc, sizeof(type), \
185 NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0); \
186 if (var == NULL) break
187#define UMA_DESTROY(var) \
188 if(var) uma_zdestroy(var)
189
190extern struct mtx pf_task_mtx;
191
192#define PF_ASSERT(h) mtx_assert(&pf_task_mtx, (h))
193
194#define PF_LOCK() do { \
195 PF_ASSERT(MA_NOTOWNED); \
196 mtx_lock(&pf_task_mtx); \
197} while(0)
198#define PF_UNLOCK() do { \
199 PF_ASSERT(MA_OWNED); \
200 mtx_unlock(&pf_task_mtx); \
201} while(0)
202
203#define PF_COPYIN(uaddr, kaddr, len, r) do { \
204 PF_UNLOCK(); \
205 r = copyin((uaddr), (kaddr), (len)); \
206 PF_LOCK(); \
207} while(0)
208
209#define PF_COPYOUT(kaddr, uaddr, len, r) do { \
210 PF_UNLOCK(); \
211 r = copyout((kaddr), (uaddr), (len)); \
212 PF_LOCK(); \
213} while(0)
214
215extern void init_pf_mutex(void);
216extern void destroy_pf_mutex(void);
217
218#define PF_MODVER 1
219#define PFLOG_MODVER 1
220#define PFSYNC_MODVER 1
221
222#define PFLOG_MINVER 1
223#define PFLOG_PREFVER PFLOG_MODVER
224#define PFLOG_MAXVER 1
225#define PFSYNC_MINVER 1
226#define PFSYNC_PREFVER PFSYNC_MODVER
227#define PFSYNC_MAXVER 1
228
229/* prototyped for pf_subr.c */
230struct hook_desc {
231 TAILQ_ENTRY(hook_desc) hd_list;
232 void (*hd_fn)(void *);
233 void *hd_arg;
234};
235TAILQ_HEAD(hook_desc_head, hook_desc);
236
237void *hook_establish(struct hook_desc_head *, int, void (*)(void *), void *);
238void hook_disestablish(struct hook_desc_head *, void *);
239void dohooks(struct hook_desc_head *, int);
240
241#define HOOK_REMOVE 0x01
242#define HOOK_FREE 0x02
243#endif /* __FreeBSD__ */
244
245#ifdef INET
246#ifndef INET6
247#define PF_INET_ONLY
248#endif /* ! INET6 */
249#endif /* INET */
250
251#ifdef INET6
252#ifndef INET
253#define PF_INET6_ONLY
254#endif /* ! INET */
255#endif /* INET6 */
256
257#ifdef INET
258#ifdef INET6
259#define PF_INET_INET6
260#endif /* INET6 */
261#endif /* INET */
262
263#else
264
265#define PF_INET_INET6
266
267#endif /* _KERNEL */
268
269/* Both IPv4 and IPv6 */
270#ifdef PF_INET_INET6
271
272#define PF_AEQ(a, b, c) \
273 ((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \
274 ((a)->addr32[3] == (b)->addr32[3] && \
275 (a)->addr32[2] == (b)->addr32[2] && \
276 (a)->addr32[1] == (b)->addr32[1] && \
277 (a)->addr32[0] == (b)->addr32[0])) \
278
279#define PF_ANEQ(a, b, c) \
280 ((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \
281 ((a)->addr32[3] != (b)->addr32[3] || \
282 (a)->addr32[2] != (b)->addr32[2] || \
283 (a)->addr32[1] != (b)->addr32[1] || \
284 (a)->addr32[0] != (b)->addr32[0])) \
285
286#define PF_AZERO(a, c) \
287 ((c == AF_INET && !(a)->addr32[0]) || \
288 (!(a)->addr32[0] && !(a)->addr32[1] && \
289 !(a)->addr32[2] && !(a)->addr32[3] )) \
290
291#define PF_MATCHA(n, a, m, b, f) \
292 pf_match_addr(n, a, m, b, f)
293
294#define PF_ACPY(a, b, f) \
295 pf_addrcpy(a, b, f)
296
297#define PF_AINC(a, f) \
298 pf_addr_inc(a, f)
299
300#define PF_POOLMASK(a, b, c, d, f) \
301 pf_poolmask(a, b, c, d, f)
302
303#else
304
305/* Just IPv6 */
306
307#ifdef PF_INET6_ONLY
308
309#define PF_AEQ(a, b, c) \
310 ((a)->addr32[3] == (b)->addr32[3] && \
311 (a)->addr32[2] == (b)->addr32[2] && \
312 (a)->addr32[1] == (b)->addr32[1] && \
313 (a)->addr32[0] == (b)->addr32[0]) \
314
315#define PF_ANEQ(a, b, c) \
316 ((a)->addr32[3] != (b)->addr32[3] || \
317 (a)->addr32[2] != (b)->addr32[2] || \
318 (a)->addr32[1] != (b)->addr32[1] || \
319 (a)->addr32[0] != (b)->addr32[0]) \
320
321#define PF_AZERO(a, c) \
322 (!(a)->addr32[0] && \
323 !(a)->addr32[1] && \
324 !(a)->addr32[2] && \
325 !(a)->addr32[3] ) \
326
327#define PF_MATCHA(n, a, m, b, f) \
328 pf_match_addr(n, a, m, b, f)
329
330#define PF_ACPY(a, b, f) \
331 pf_addrcpy(a, b, f)
332
333#define PF_AINC(a, f) \
334 pf_addr_inc(a, f)
335
336#define PF_POOLMASK(a, b, c, d, f) \
337 pf_poolmask(a, b, c, d, f)
338
339#else
340
341/* Just IPv4 */
342#ifdef PF_INET_ONLY
343
344#define PF_AEQ(a, b, c) \
345 ((a)->addr32[0] == (b)->addr32[0])
346
347#define PF_ANEQ(a, b, c) \
348 ((a)->addr32[0] != (b)->addr32[0])
349
350#define PF_AZERO(a, c) \
351 (!(a)->addr32[0])
352
353#define PF_MATCHA(n, a, m, b, f) \
354 pf_match_addr(n, a, m, b, f)
355
356#define PF_ACPY(a, b, f) \
357 (a)->v4.s_addr = (b)->v4.s_addr
358
359#define PF_AINC(a, f) \
360 do { \
361 (a)->addr32[0] = htonl(ntohl((a)->addr32[0]) + 1); \
362 } while (0)
363
364#define PF_POOLMASK(a, b, c, d, f) \
365 do { \
366 (a)->addr32[0] = ((b)->addr32[0] & (c)->addr32[0]) | \
367 (((c)->addr32[0] ^ 0xffffffff ) & (d)->addr32[0]); \
368 } while (0)
369
370#endif /* PF_INET_ONLY */
371#endif /* PF_INET6_ONLY */
372#endif /* PF_INET_INET6 */
373
374#define PF_MISMATCHAW(aw, x, af, not) \
375 ( \
376 (((aw)->type == PF_ADDR_NOROUTE && \
377 pf_routable((x), (af))) || \
378 ((aw)->type == PF_ADDR_TABLE && \
379 !pfr_match_addr((aw)->p.tbl, (x), (af))) || \
380 ((aw)->type == PF_ADDR_DYNIFTL && \
381 !pfi_match_addr((aw)->p.dyn, (x), (af))) || \
382 ((aw)->type == PF_ADDR_ADDRMASK && \
383 !PF_AZERO(&(aw)->v.a.mask, (af)) && \
384 !PF_MATCHA(0, &(aw)->v.a.addr, \
385 &(aw)->v.a.mask, (x), (af)))) != \
386 (not) \
387 )
388
389struct pf_rule_uid {
390 uid_t uid[2];
391 u_int8_t op;
392};
393
394struct pf_rule_gid {
395 uid_t gid[2];
396 u_int8_t op;
397};
398
399struct pf_rule_addr {
400 struct pf_addr_wrap addr;
401 u_int16_t port[2];
402 u_int8_t not;
403 u_int8_t port_op;
404};
405
406struct pf_pooladdr {
407 struct pf_addr_wrap addr;
408 TAILQ_ENTRY(pf_pooladdr) entries;
409 char ifname[IFNAMSIZ];
410 struct pfi_kif *kif;
411};
412
413TAILQ_HEAD(pf_palist, pf_pooladdr);
414
415struct pf_poolhashkey {
416 union {
417 u_int8_t key8[16];
418 u_int16_t key16[8];
419 u_int32_t key32[4];
420 } pfk; /* 128-bit hash key */
421#define key8 pfk.key8
422#define key16 pfk.key16
423#define key32 pfk.key32
424};
425
426struct pf_pool {
427 struct pf_palist list;
428 struct pf_pooladdr *cur;
429 struct pf_poolhashkey key;
430 struct pf_addr counter;
431 int tblidx;
432 u_int16_t proxy_port[2];
433 u_int8_t port_op;
434 u_int8_t opts;
435};
436
437
438/* A packed Operating System description for fingerprinting */
439typedef u_int32_t pf_osfp_t;
440#define PF_OSFP_ANY ((pf_osfp_t)0)
441#define PF_OSFP_UNKNOWN ((pf_osfp_t)-1)
442#define PF_OSFP_NOMATCH ((pf_osfp_t)-2)
443
444struct pf_osfp_entry {
445 SLIST_ENTRY(pf_osfp_entry) fp_entry;
446 pf_osfp_t fp_os;
447 int fp_enflags;
448#define PF_OSFP_EXPANDED 0x001 /* expanded entry */
449#define PF_OSFP_GENERIC 0x002 /* generic signature */
450#define PF_OSFP_NODETAIL 0x004 /* no p0f details */
451#define PF_OSFP_LEN 32
452 char fp_class_nm[PF_OSFP_LEN];
453 char fp_version_nm[PF_OSFP_LEN];
454 char fp_subtype_nm[PF_OSFP_LEN];
455};
456#define PF_OSFP_ENTRY_EQ(a, b) \
457 ((a)->fp_os == (b)->fp_os && \
458 memcmp((a)->fp_class_nm, (b)->fp_class_nm, PF_OSFP_LEN) == 0 && \
459 memcmp((a)->fp_version_nm, (b)->fp_version_nm, PF_OSFP_LEN) == 0 && \
460 memcmp((a)->fp_subtype_nm, (b)->fp_subtype_nm, PF_OSFP_LEN) == 0)
461
462/* handle pf_osfp_t packing */
463#define _FP_RESERVED_BIT 1 /* For the special negative #defines */
464#define _FP_UNUSED_BITS 1
465#define _FP_CLASS_BITS 10 /* OS Class (Windows, Linux) */
466#define _FP_VERSION_BITS 10 /* OS version (95, 98, NT, 2.4.54, 3.2) */
467#define _FP_SUBTYPE_BITS 10 /* patch level (NT SP4, SP3, ECN patch) */
468#define PF_OSFP_UNPACK(osfp, class, version, subtype) do { \
469 (class) = ((osfp) >> (_FP_VERSION_BITS+_FP_SUBTYPE_BITS)) & \
470 ((1 << _FP_CLASS_BITS) - 1); \
471 (version) = ((osfp) >> _FP_SUBTYPE_BITS) & \
472 ((1 << _FP_VERSION_BITS) - 1);\
473 (subtype) = (osfp) & ((1 << _FP_SUBTYPE_BITS) - 1); \
474} while(0)
475#define PF_OSFP_PACK(osfp, class, version, subtype) do { \
476 (osfp) = ((class) & ((1 << _FP_CLASS_BITS) - 1)) << (_FP_VERSION_BITS \
477 + _FP_SUBTYPE_BITS); \
478 (osfp) |= ((version) & ((1 << _FP_VERSION_BITS) - 1)) << \
479 _FP_SUBTYPE_BITS; \
480 (osfp) |= (subtype) & ((1 << _FP_SUBTYPE_BITS) - 1); \
481} while(0)
482
483/* the fingerprint of an OSes TCP SYN packet */
484typedef u_int64_t pf_tcpopts_t;
485struct pf_os_fingerprint {
486 SLIST_HEAD(pf_osfp_enlist, pf_osfp_entry) fp_oses; /* list of matches */
487 pf_tcpopts_t fp_tcpopts; /* packed TCP options */
488 u_int16_t fp_wsize; /* TCP window size */
489 u_int16_t fp_psize; /* ip->ip_len */
490 u_int16_t fp_mss; /* TCP MSS */
491 u_int16_t fp_flags;
492#define PF_OSFP_WSIZE_MOD 0x0001 /* Window modulus */
493#define PF_OSFP_WSIZE_DC 0x0002 /* Window don't care */
494#define PF_OSFP_WSIZE_MSS 0x0004 /* Window multiple of MSS */
495#define PF_OSFP_WSIZE_MTU 0x0008 /* Window multiple of MTU */
496#define PF_OSFP_PSIZE_MOD 0x0010 /* packet size modulus */
497#define PF_OSFP_PSIZE_DC 0x0020 /* packet size don't care */
498#define PF_OSFP_WSCALE 0x0040 /* TCP window scaling */
499#define PF_OSFP_WSCALE_MOD 0x0080 /* TCP window scale modulus */
500#define PF_OSFP_WSCALE_DC 0x0100 /* TCP window scale dont-care */
501#define PF_OSFP_MSS 0x0200 /* TCP MSS */
502#define PF_OSFP_MSS_MOD 0x0400 /* TCP MSS modulus */
503#define PF_OSFP_MSS_DC 0x0800 /* TCP MSS dont-care */
504#define PF_OSFP_DF 0x1000 /* IPv4 don't fragment bit */
505#define PF_OSFP_TS0 0x2000 /* Zero timestamp */
506 u_int8_t fp_optcnt; /* TCP option count */
507 u_int8_t fp_wscale; /* TCP window scaling */
508 u_int8_t fp_ttl; /* IPv4 TTL */
509#define PF_OSFP_MAXTTL_OFFSET 40
510/* TCP options packing */
511#define PF_OSFP_TCPOPT_NOP 0x0 /* TCP NOP option */
512#define PF_OSFP_TCPOPT_WSCALE 0x1 /* TCP window scaling option */
513#define PF_OSFP_TCPOPT_MSS 0x2 /* TCP max segment size opt */
514#define PF_OSFP_TCPOPT_SACK 0x3 /* TCP SACK OK option */
515#define PF_OSFP_TCPOPT_TS 0x4 /* TCP timestamp option */
516#define PF_OSFP_TCPOPT_BITS 3 /* bits used by each option */
517#define PF_OSFP_MAX_OPTS \
518 (sizeof(((struct pf_os_fingerprint *)0)->fp_tcpopts) * 8) \
519 / PF_OSFP_TCPOPT_BITS
520
521 SLIST_ENTRY(pf_os_fingerprint) fp_next;
522};
523
524struct pf_osfp_ioctl {
525 struct pf_osfp_entry fp_os;
526 pf_tcpopts_t fp_tcpopts; /* packed TCP options */
527 u_int16_t fp_wsize; /* TCP window size */
528 u_int16_t fp_psize; /* ip->ip_len */
529 u_int16_t fp_mss; /* TCP MSS */
530 u_int16_t fp_flags;
531 u_int8_t fp_optcnt; /* TCP option count */
532 u_int8_t fp_wscale; /* TCP window scaling */
533 u_int8_t fp_ttl; /* IPv4 TTL */
534
535 int fp_getnum; /* DIOCOSFPGET number */
536};
537
538
539union pf_rule_ptr {
540 struct pf_rule *ptr;
541 u_int32_t nr;
542};
543
544struct pf_rule {
545 struct pf_rule_addr src;
546 struct pf_rule_addr dst;
547#define PF_SKIP_IFP 0
548#define PF_SKIP_DIR 1
549#define PF_SKIP_AF 2
550#define PF_SKIP_PROTO 3
551#define PF_SKIP_SRC_ADDR 4
552#define PF_SKIP_SRC_PORT 5
553#define PF_SKIP_DST_ADDR 6
554#define PF_SKIP_DST_PORT 7
555#define PF_SKIP_COUNT 8
556 union pf_rule_ptr skip[PF_SKIP_COUNT];
557#define PF_RULE_LABEL_SIZE 64
558 char label[PF_RULE_LABEL_SIZE];
559#define PF_QNAME_SIZE 16
560 char ifname[IFNAMSIZ];
561 char qname[PF_QNAME_SIZE];
562 char pqname[PF_QNAME_SIZE];
563#define PF_ANCHOR_NAME_SIZE 16
564 char anchorname[PF_ANCHOR_NAME_SIZE];
565#define PF_TAG_NAME_SIZE 16
566 char tagname[PF_TAG_NAME_SIZE];
567 char match_tagname[PF_TAG_NAME_SIZE];
568
569 TAILQ_ENTRY(pf_rule) entries;
570 struct pf_pool rpool;
571
572 u_int64_t evaluations;
573 u_int64_t packets;
574 u_int64_t bytes;
575
576 struct pfi_kif *kif;
577 struct pf_anchor *anchor;
578
579 pf_osfp_t os_fingerprint;
580
581 u_int32_t timeout[PFTM_MAX];
582 u_int32_t states;
583 u_int32_t max_states;
584 u_int32_t src_nodes;
585 u_int32_t max_src_nodes;
586 u_int32_t max_src_states;
587 u_int32_t qid;
588 u_int32_t pqid;
589 u_int32_t rt_listid;
590 u_int32_t nr;
591
592 u_int16_t return_icmp;
593 u_int16_t return_icmp6;
594 u_int16_t max_mss;
595 u_int16_t tag;
596 u_int16_t match_tag;
597
598 struct pf_rule_uid uid;
599 struct pf_rule_gid gid;
600
601 u_int32_t rule_flag;
602 u_int8_t action;
603 u_int8_t direction;
604 u_int8_t log;
605 u_int8_t quick;
606 u_int8_t ifnot;
607 u_int8_t match_tag_not;
608 u_int8_t natpass;
609
610#define PF_STATE_NORMAL 0x1
611#define PF_STATE_MODULATE 0x2
612#define PF_STATE_SYNPROXY 0x3
613 u_int8_t keep_state;
614 sa_family_t af;
615 u_int8_t proto;
616 u_int8_t type;
617 u_int8_t code;
618 u_int8_t flags;
619 u_int8_t flagset;
620 u_int8_t min_ttl;
621 u_int8_t allow_opts;
622 u_int8_t rt;
623 u_int8_t return_ttl;
624 u_int8_t tos;
625};
626
627/* rule flags */
628#define PFRULE_DROP 0x0000
629#define PFRULE_RETURNRST 0x0001
630#define PFRULE_FRAGMENT 0x0002
631#define PFRULE_RETURNICMP 0x0004
632#define PFRULE_RETURN 0x0008
633#define PFRULE_NOSYNC 0x0010
634#define PFRULE_SRCTRACK 0x0020 /* track source states */
635#define PFRULE_RULESRCTRACK 0x0040 /* per rule */
636
637/* scrub flags */
638#define PFRULE_NODF 0x0100
639#define PFRULE_FRAGCROP 0x0200 /* non-buffering frag cache */
640#define PFRULE_FRAGDROP 0x0400 /* drop funny fragments */
641#define PFRULE_RANDOMID 0x0800
642#define PFRULE_REASSEMBLE_TCP 0x1000
643
644/* rule flags again */
645#define PFRULE_IFBOUND 0x00010000 /* if-bound */
646#define PFRULE_GRBOUND 0x00020000 /* group-bound */
647
648#define PFSTATE_HIWAT 10000 /* default state table size */
649
650struct pf_src_node {
651 RB_ENTRY(pf_src_node) entry;
652 struct pf_addr addr;
653 struct pf_addr raddr;
654 union pf_rule_ptr rule;
655 struct pfi_kif *kif;
656 u_int32_t bytes;
657 u_int32_t packets;
658 u_int32_t states;
659 u_int32_t creation;
660 u_int32_t expire;
661 sa_family_t af;
662 u_int8_t ruletype;
663};
664
665#define PFSNODE_HIWAT 10000 /* default source node table size */
666
667struct pf_state_scrub {
668 u_int16_t pfss_flags;
669#define PFSS_TIMESTAMP 0x0001 /* modulate timestamp */
670 u_int8_t pfss_ttl; /* stashed TTL */
671 u_int8_t pad;
672 u_int32_t pfss_ts_mod; /* timestamp modulation */
673};
674
675struct pf_state_host {
676 struct pf_addr addr;
677 u_int16_t port;
678 u_int16_t pad;
679};
680
681struct pf_state_peer {
682 u_int32_t seqlo; /* Max sequence number sent */
683 u_int32_t seqhi; /* Max the other end ACKd + win */
684 u_int32_t seqdiff; /* Sequence number modulator */
685 u_int16_t max_win; /* largest window (pre scaling) */
686 u_int8_t state; /* active state level */
687 u_int8_t wscale; /* window scaling factor */
688 u_int16_t mss; /* Maximum segment size option */
689 struct pf_state_scrub *scrub; /* state is scrubbed */
690};
691
692TAILQ_HEAD(pf_state_queue, pf_state);
693
694struct pf_state {
695 u_int64_t id;
696 union {
697 struct {
698 RB_ENTRY(pf_state) entry_lan_ext;
699 RB_ENTRY(pf_state) entry_ext_gwy;
700 RB_ENTRY(pf_state) entry_id;
701 TAILQ_ENTRY(pf_state) entry_updates;
702 struct pfi_kif *kif;
703 } s;
704 char ifname[IFNAMSIZ];
705 } u;
706 struct pf_state_host lan;
707 struct pf_state_host gwy;
708 struct pf_state_host ext;
709 struct pf_state_peer src;
710 struct pf_state_peer dst;
711 union pf_rule_ptr rule;
712 union pf_rule_ptr anchor;
713 union pf_rule_ptr nat_rule;
714 struct pf_addr rt_addr;
715 struct pfi_kif *rt_kif;
716 struct pf_src_node *src_node;
717 struct pf_src_node *nat_src_node;
718 u_int32_t creation;
719 u_int32_t expire;
720 u_int32_t pfsync_time;
721 u_int32_t packets[2];
722 u_int32_t bytes[2];
723 u_int32_t creatorid;
724 sa_family_t af;
725 u_int8_t proto;
726 u_int8_t direction;
727 u_int8_t log;
728 u_int8_t allow_opts;
729 u_int8_t timeout;
730 u_int8_t sync_flags;
731#define PFSTATE_NOSYNC 0x01
732#define PFSTATE_FROMSYNC 0x02
733 u_int8_t pad;
734};
735
736TAILQ_HEAD(pf_rulequeue, pf_rule);
737
738struct pf_anchor;
739
740struct pf_ruleset {
741 TAILQ_ENTRY(pf_ruleset) entries;
742#define PF_RULESET_NAME_SIZE 16
743 char name[PF_RULESET_NAME_SIZE];
744 struct {
745 struct pf_rulequeue queues[2];
746 struct {
747 struct pf_rulequeue *ptr;
748 u_int32_t ticket;
749 int open;
750 } active, inactive;
751 } rules[PF_RULESET_MAX];
752 struct pf_anchor *anchor;
753 u_int32_t tticket;
754 int tables;
755 int topen;
756};
757
758TAILQ_HEAD(pf_rulesetqueue, pf_ruleset);
759
760struct pf_anchor {
761 TAILQ_ENTRY(pf_anchor) entries;
762 char name[PF_ANCHOR_NAME_SIZE];
763 struct pf_rulesetqueue rulesets;
764 int tables;
765};
766
767TAILQ_HEAD(pf_anchorqueue, pf_anchor);
768
769#define PF_RESERVED_ANCHOR "_pf"
770#define PF_INTERFACE_RULESET "_if"
771
772#define PFR_TFLAG_PERSIST 0x00000001
773#define PFR_TFLAG_CONST 0x00000002
774#define PFR_TFLAG_ACTIVE 0x00000004
775#define PFR_TFLAG_INACTIVE 0x00000008
776#define PFR_TFLAG_REFERENCED 0x00000010
777#define PFR_TFLAG_REFDANCHOR 0x00000020
778#define PFR_TFLAG_USRMASK 0x00000003
779#define PFR_TFLAG_SETMASK 0x0000003C
780#define PFR_TFLAG_ALLMASK 0x0000003F
781
782struct pfr_table {
783 char pfrt_anchor[PF_ANCHOR_NAME_SIZE];
784 char pfrt_ruleset[PF_RULESET_NAME_SIZE];
785 char pfrt_name[PF_TABLE_NAME_SIZE];
786 u_int32_t pfrt_flags;
787 u_int8_t pfrt_fback;
788};
789
790enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
791 PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
792 PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_MAX };
793
794struct pfr_addr {
795 union {
796 struct in_addr _pfra_ip4addr;
797 struct in6_addr _pfra_ip6addr;
798 } pfra_u;
799 u_int8_t pfra_af;
800 u_int8_t pfra_net;
801 u_int8_t pfra_not;
802 u_int8_t pfra_fback;
803};
804#define pfra_ip4addr pfra_u._pfra_ip4addr
805#define pfra_ip6addr pfra_u._pfra_ip6addr
806
807enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
808enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
809#define PFR_OP_XPASS PFR_OP_ADDR_MAX
810
811struct pfr_astats {
812 struct pfr_addr pfras_a;
813 u_int64_t pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
814 u_int64_t pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
815 long pfras_tzero;
816};
817
818enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
819
820struct pfr_tstats {
821 struct pfr_table pfrts_t;
822 u_int64_t pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
823 u_int64_t pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
824 u_int64_t pfrts_match;
825 u_int64_t pfrts_nomatch;
826 long pfrts_tzero;
827 int pfrts_cnt;
828 int pfrts_refcnt[PFR_REFCNT_MAX];
829};
830#define pfrts_name pfrts_t.pfrt_name
831#define pfrts_flags pfrts_t.pfrt_flags
832
833SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
834struct pfr_kentry {
835 struct radix_node pfrke_node[2];
836 union sockaddr_union pfrke_sa;
837 u_int64_t pfrke_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
838 u_int64_t pfrke_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
839 SLIST_ENTRY(pfr_kentry) pfrke_workq;
840 long pfrke_tzero;
841 u_int8_t pfrke_af;
842 u_int8_t pfrke_net;
843 u_int8_t pfrke_not;
844 u_int8_t pfrke_mark;
845};
846
847SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
848RB_HEAD(pfr_ktablehead, pfr_ktable);
849struct pfr_ktable {
850 struct pfr_tstats pfrkt_ts;
851 RB_ENTRY(pfr_ktable) pfrkt_tree;
852 SLIST_ENTRY(pfr_ktable) pfrkt_workq;
853 struct radix_node_head *pfrkt_ip4;
854 struct radix_node_head *pfrkt_ip6;
855 struct pfr_ktable *pfrkt_shadow;
856 struct pfr_ktable *pfrkt_root;
857 struct pf_ruleset *pfrkt_rs;
858 long pfrkt_larg;
859 int pfrkt_nflags;
860};
861#define pfrkt_t pfrkt_ts.pfrts_t
862#define pfrkt_name pfrkt_t.pfrt_name
863#define pfrkt_anchor pfrkt_t.pfrt_anchor
864#define pfrkt_ruleset pfrkt_t.pfrt_ruleset
865#define pfrkt_flags pfrkt_t.pfrt_flags
866#define pfrkt_cnt pfrkt_ts.pfrts_cnt
867#define pfrkt_refcnt pfrkt_ts.pfrts_refcnt
868#define pfrkt_packets pfrkt_ts.pfrts_packets
869#define pfrkt_bytes pfrkt_ts.pfrts_bytes
870#define pfrkt_match pfrkt_ts.pfrts_match
871#define pfrkt_nomatch pfrkt_ts.pfrts_nomatch
872#define pfrkt_tzero pfrkt_ts.pfrts_tzero
873
874RB_HEAD(pf_state_tree_lan_ext, pf_state);
875RB_PROTOTYPE(pf_state_tree_lan_ext, pf_state,
876 u.s.entry_lan_ext, pf_state_compare_lan_ext);
877
878RB_HEAD(pf_state_tree_ext_gwy, pf_state);
879RB_PROTOTYPE(pf_state_tree_ext_gwy, pf_state,
880 u.s.entry_ext_gwy, pf_state_compare_ext_gwy);
881
882struct pfi_if {
883 char pfif_name[IFNAMSIZ];
884 u_int64_t pfif_packets[2][2][2];
885 u_int64_t pfif_bytes[2][2][2];
886 u_int64_t pfif_addcnt;
887 u_int64_t pfif_delcnt;
888 long pfif_tzero;
889 int pfif_states;
890 int pfif_rules;
891 int pfif_flags;
892};
893
894TAILQ_HEAD(pfi_grouphead, pfi_kif);
895TAILQ_HEAD(pfi_statehead, pfi_kif);
896RB_HEAD(pfi_ifhead, pfi_kif);
897struct pfi_kif {
898 struct pfi_if pfik_if;
899 RB_ENTRY(pfi_kif) pfik_tree;
900 struct pf_state_tree_lan_ext pfik_lan_ext;
901 struct pf_state_tree_ext_gwy pfik_ext_gwy;
902 struct pfi_grouphead pfik_grouphead;
903 TAILQ_ENTRY(pfi_kif) pfik_instances;
904 TAILQ_ENTRY(pfi_kif) pfik_w_states;
905 struct hook_desc_head *pfik_ah_head;
906 void *pfik_ah_cookie;
907 struct pfi_kif *pfik_parent;
908 struct ifnet *pfik_ifp;
909 int pfik_states;
910 int pfik_rules;
911};
912#define pfik_name pfik_if.pfif_name
913#define pfik_packets pfik_if.pfif_packets
914#define pfik_bytes pfik_if.pfif_bytes
915#define pfik_tzero pfik_if.pfif_tzero
916#define pfik_flags pfik_if.pfif_flags
917#define pfik_addcnt pfik_if.pfif_addcnt
918#define pfik_delcnt pfik_if.pfif_delcnt
919#define pfik_states pfik_if.pfif_states
920#define pfik_rules pfik_if.pfif_rules
921
922#define PFI_IFLAG_GROUP 0x0001 /* group of interfaces */
923#define PFI_IFLAG_INSTANCE 0x0002 /* single instance */
924#define PFI_IFLAG_CLONABLE 0x0010 /* clonable group */
925#define PFI_IFLAG_DYNAMIC 0x0020 /* dynamic group */
926#define PFI_IFLAG_ATTACHED 0x0040 /* interface attached */
927#define PFI_IFLAG_PLACEHOLDER 0x8000 /* placeholder group/interface */
928
929struct pf_pdesc {
930 u_int64_t tot_len; /* Make Mickey money */
931 union {
932 struct tcphdr *tcp;
933 struct udphdr *udp;
934 struct icmp *icmp;
935#ifdef INET6
936 struct icmp6_hdr *icmp6;
937#endif /* INET6 */
938 void *any;
939 } hdr;
940 struct pf_addr baddr; /* address before translation */
941 struct pf_addr naddr; /* address after translation */
942 struct pf_rule *nat_rule; /* nat/rdr rule applied to packet */
943 struct pf_addr *src;
944 struct pf_addr *dst;
945 u_int16_t *ip_sum;
946 u_int32_t p_len; /* total length of payload */
947 u_int16_t flags; /* Let SCRUB trigger behavior in
948 * state code. Easier than tags */
949#define PFDESC_TCP_NORM 0x0001 /* TCP shall be statefully scrubbed */
950 sa_family_t af;
951 u_int8_t proto;
952 u_int8_t tos;
953};
954
955/* flags for RDR options */
956#define PF_DPORT_RANGE 0x01 /* Dest port uses range */
957#define PF_RPORT_RANGE 0x02 /* RDR'ed port uses range */
958
959/* Reasons code for passing/dropping a packet */
960#define PFRES_MATCH 0 /* Explicit match of a rule */
961#define PFRES_BADOFF 1 /* Bad offset for pull_hdr */
962#define PFRES_FRAG 2 /* Dropping following fragment */
963#define PFRES_SHORT 3 /* Dropping short packet */
964#define PFRES_NORM 4 /* Dropping by normalizer */
965#define PFRES_MEMORY 5 /* Dropped due to lacking mem */
966#define PFRES_MAX 6 /* total+1 */
967
968#define PFRES_NAMES { \
969 "match", \
970 "bad-offset", \
971 "fragment", \
972 "short", \
973 "normalize", \
974 "memory", \
975 NULL \
976}
977
978/* UDP state enumeration */
979#define PFUDPS_NO_TRAFFIC 0
980#define PFUDPS_SINGLE 1
981#define PFUDPS_MULTIPLE 2
982
983#define PFUDPS_NSTATES 3 /* number of state levels */
984
985#define PFUDPS_NAMES { \
986 "NO_TRAFFIC", \
987 "SINGLE", \
988 "MULTIPLE", \
989 NULL \
990}
991
992/* Other protocol state enumeration */
993#define PFOTHERS_NO_TRAFFIC 0
994#define PFOTHERS_SINGLE 1
995#define PFOTHERS_MULTIPLE 2
996
997#define PFOTHERS_NSTATES 3 /* number of state levels */
998
999#define PFOTHERS_NAMES { \
1000 "NO_TRAFFIC", \
1001 "SINGLE", \
1002 "MULTIPLE", \
1003 NULL \
1004}
1005
1006#define FCNT_STATE_SEARCH 0
1007#define FCNT_STATE_INSERT 1
1008#define FCNT_STATE_REMOVALS 2
1009#define FCNT_MAX 3
1010
1011#define SCNT_SRC_NODE_SEARCH 0
1012#define SCNT_SRC_NODE_INSERT 1
1013#define SCNT_SRC_NODE_REMOVALS 2
1014#define SCNT_MAX 3
1015
1016#define ACTION_SET(a, x) \
1017 do { \
1018 if ((a) != NULL) \
1019 *(a) = (x); \
1020 } while (0)
1021
1022#define REASON_SET(a, x) \
1023 do { \
1024 if ((a) != NULL) \
1025 *(a) = (x); \
1026 if (x < PFRES_MAX) \
1027 pf_status.counters[x]++; \
1028 } while (0)
1029
1030struct pf_status {
1031 u_int64_t counters[PFRES_MAX];
1032 u_int64_t fcounters[FCNT_MAX];
1033 u_int64_t scounters[SCNT_MAX];
1034 u_int64_t pcounters[2][2][3];
1035 u_int64_t bcounters[2][2];
1036 u_int64_t stateid;
1037 u_int32_t running;
1038 u_int32_t states;
1039 u_int32_t src_nodes;
1040 u_int32_t since;
1041 u_int32_t debug;
1042 u_int32_t hostid;
1043 char ifname[IFNAMSIZ];
1044};
1045
1046struct cbq_opts {
1047 u_int minburst;
1048 u_int maxburst;
1049 u_int pktsize;
1050 u_int maxpktsize;
1051 u_int ns_per_byte;
1052 u_int maxidle;
1053 int minidle;
1054 u_int offtime;
1055 int flags;
1056};
1057
1058struct priq_opts {
1059 int flags;
1060};
1061
1062struct hfsc_opts {
1063 /* real-time service curve */
1064 u_int rtsc_m1; /* slope of the 1st segment in bps */
1065 u_int rtsc_d; /* the x-projection of m1 in msec */
1066 u_int rtsc_m2; /* slope of the 2nd segment in bps */
1067 /* link-sharing service curve */
1068 u_int lssc_m1;
1069 u_int lssc_d;
1070 u_int lssc_m2;
1071 /* upper-limit service curve */
1072 u_int ulsc_m1;
1073 u_int ulsc_d;
1074 u_int ulsc_m2;
1075 int flags;
1076};
1077
1078struct pf_altq {
1079 char ifname[IFNAMSIZ];
1080
1081 void *altq_disc; /* discipline-specific state */
1082 TAILQ_ENTRY(pf_altq) entries;
1083
1084 /* scheduler spec */
1085 u_int8_t scheduler; /* scheduler type */
1086 u_int16_t tbrsize; /* tokenbucket regulator size */
1087 u_int32_t ifbandwidth; /* interface bandwidth */
1088
1089 /* queue spec */
1090 char qname[PF_QNAME_SIZE]; /* queue name */
1091 char parent[PF_QNAME_SIZE]; /* parent name */
1092 u_int32_t parent_qid; /* parent queue id */
1093 u_int32_t bandwidth; /* queue bandwidth */
1094 u_int8_t priority; /* priority */
1095 u_int16_t qlimit; /* queue size limit */
1096 u_int16_t flags; /* misc flags */
1097 union {
1098 struct cbq_opts cbq_opts;
1099 struct priq_opts priq_opts;
1100 struct hfsc_opts hfsc_opts;
1101 } pq_u;
1102
1103 u_int32_t qid; /* return value */
1104};
1105
1106struct pf_tag {
1107 u_int16_t tag; /* tag id */
1108};
1109
1110struct pf_tagname {
1111 TAILQ_ENTRY(pf_tagname) entries;
1112 char name[PF_TAG_NAME_SIZE];
1113 u_int16_t tag;
1114 int ref;
1115};
1116
1117#define PFFRAG_FRENT_HIWAT 5000 /* Number of fragment entries */
1118#define PFFRAG_FRAG_HIWAT 1000 /* Number of fragmented packets */
1119#define PFFRAG_FRCENT_HIWAT 50000 /* Number of fragment cache entries */
1120#define PFFRAG_FRCACHE_HIWAT 10000 /* Number of fragment descriptors */
1121
1122/*
1123 * ioctl parameter structures
1124 */
1125
1126struct pfioc_pooladdr {
1127 u_int32_t action;
1128 u_int32_t ticket;
1129 u_int32_t nr;
1130 u_int32_t r_num;
1131 u_int8_t r_action;
1132 u_int8_t r_last;
1133 u_int8_t af;
1134 char anchor[PF_ANCHOR_NAME_SIZE];
1135 char ruleset[PF_RULESET_NAME_SIZE];
1136 struct pf_pooladdr addr;
1137};
1138
1139struct pfioc_rule {
1140 u_int32_t action;
1141 u_int32_t ticket;
1142 u_int32_t pool_ticket;
1143 u_int32_t nr;
1144 char anchor[PF_ANCHOR_NAME_SIZE];
1145 char ruleset[PF_RULESET_NAME_SIZE];
1146 struct pf_rule rule;
1147};
1148
1149struct pfioc_natlook {
1150 struct pf_addr saddr;
1151 struct pf_addr daddr;
1152 struct pf_addr rsaddr;
1153 struct pf_addr rdaddr;
1154 u_int16_t sport;
1155 u_int16_t dport;
1156 u_int16_t rsport;
1157 u_int16_t rdport;
1158 sa_family_t af;
1159 u_int8_t proto;
1160 u_int8_t direction;
1161};
1162
1163struct pfioc_state {
1164 u_int32_t nr;
1165 struct pf_state state;
1166};
1167
1168struct pfioc_state_kill {
1169 /* XXX returns the number of states killed in psk_af */
1170 sa_family_t psk_af;
1171 int psk_proto;
1172 struct pf_rule_addr psk_src;
1173 struct pf_rule_addr psk_dst;
1174 char psk_ifname[IFNAMSIZ];
1175};
1176
1177struct pfioc_states {
1178 int ps_len;
1179 union {
1180 caddr_t psu_buf;
1181 struct pf_state *psu_states;
1182 } ps_u;
1183#define ps_buf ps_u.psu_buf
1184#define ps_states ps_u.psu_states
1185};
1186
1187struct pfioc_src_nodes {
1188 int psn_len;
1189 union {
1190 caddr_t psu_buf;
1191 struct pf_src_node *psu_src_nodes;
1192 } psn_u;
1193#define psn_buf psn_u.psu_buf
1194#define psn_src_nodes psn_u.psu_src_nodes
1195};
1196
1197struct pfioc_if {
1198 char ifname[IFNAMSIZ];
1199};
1200
1201struct pfioc_tm {
1202 int timeout;
1203 int seconds;
1204};
1205
1206struct pfioc_limit {
1207 int index;
1208 unsigned limit;
1209};
1210
1211struct pfioc_altq {
1212 u_int32_t action;
1213 u_int32_t ticket;
1214 u_int32_t nr;
1215 struct pf_altq altq;
1216};
1217
1218struct pfioc_qstats {
1219 u_int32_t ticket;
1220 u_int32_t nr;
1221 void *buf;
1222 int nbytes;
1223 u_int8_t scheduler;
1224};
1225
1226struct pfioc_anchor {
1227 u_int32_t nr;
1228 char name[PF_ANCHOR_NAME_SIZE];
1229};
1230
1231struct pfioc_ruleset {
1232 u_int32_t nr;
1233 char anchor[PF_ANCHOR_NAME_SIZE];
1234 char name[PF_RULESET_NAME_SIZE];
1235};
1236
1237#define PF_RULESET_ALTQ (PF_RULESET_MAX)
1238#define PF_RULESET_TABLE (PF_RULESET_MAX+1)
1239struct pfioc_trans {
1240 int size; /* number of elements */
1241 int esize; /* size of each element in bytes */
1242 struct pfioc_trans_e {
1243 int rs_num;
1244 char anchor[PF_ANCHOR_NAME_SIZE];
1245 char ruleset[PF_RULESET_NAME_SIZE];
1246 u_int32_t ticket;
1247 } *array;
1248};
1249
1250#define PFR_FLAG_ATOMIC 0x00000001
1251#define PFR_FLAG_DUMMY 0x00000002
1252#define PFR_FLAG_FEEDBACK 0x00000004
1253#define PFR_FLAG_CLSTATS 0x00000008
1254#define PFR_FLAG_ADDRSTOO 0x00000010
1255#define PFR_FLAG_REPLACE 0x00000020
1256#define PFR_FLAG_ALLRSETS 0x00000040
1257#define PFR_FLAG_ALLMASK 0x0000007F
1258#ifdef _KERNEL
1259#define PFR_FLAG_USERIOCTL 0x10000000
1260#endif
1261
1262struct pfioc_table {
1263 struct pfr_table pfrio_table;
1264 void *pfrio_buffer;
1265 int pfrio_esize;
1266 int pfrio_size;
1267 int pfrio_size2;
1268 int pfrio_nadd;
1269 int pfrio_ndel;
1270 int pfrio_nchange;
1271 int pfrio_flags;
1272 u_int32_t pfrio_ticket;
1273};
1274#define pfrio_exists pfrio_nadd
1275#define pfrio_nzero pfrio_nadd
1276#define pfrio_nmatch pfrio_nadd
1277#define pfrio_naddr pfrio_size2
1278#define pfrio_setflag pfrio_size2
1279#define pfrio_clrflag pfrio_nadd
1280
1281
1282#define PFI_FLAG_GROUP 0x0001 /* gets groups of interfaces */
1283#define PFI_FLAG_INSTANCE 0x0002 /* gets single interfaces */
1284#define PFI_FLAG_ALLMASK 0x0003
1285
1286struct pfioc_iface {
1287 char pfiio_name[IFNAMSIZ];
1288 void *pfiio_buffer;
1289 int pfiio_esize;
1290 int pfiio_size;
1291 int pfiio_nzero;
1292 int pfiio_flags;
1293};
1294
1295
1296/*
1297 * ioctl operations
1298 */
1299
1300#define DIOCSTART _IO ('D', 1)
1301#define DIOCSTOP _IO ('D', 2)
1302#define DIOCBEGINRULES _IOWR('D', 3, struct pfioc_rule)
1303#define DIOCADDRULE _IOWR('D', 4, struct pfioc_rule)
1304#define DIOCCOMMITRULES _IOWR('D', 5, struct pfioc_rule)
1305#define DIOCGETRULES _IOWR('D', 6, struct pfioc_rule)
1306#define DIOCGETRULE _IOWR('D', 7, struct pfioc_rule)
1307/* XXX cut 8 - 17 */
1308#define DIOCCLRSTATES _IOWR('D', 18, struct pfioc_state_kill)
1309#define DIOCGETSTATE _IOWR('D', 19, struct pfioc_state)
1310#define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_if)
1311#define DIOCGETSTATUS _IOWR('D', 21, struct pf_status)
1312#define DIOCCLRSTATUS _IO ('D', 22)
1313#define DIOCNATLOOK _IOWR('D', 23, struct pfioc_natlook)
1314#define DIOCSETDEBUG _IOWR('D', 24, u_int32_t)
1315#define DIOCGETSTATES _IOWR('D', 25, struct pfioc_states)
1316#define DIOCCHANGERULE _IOWR('D', 26, struct pfioc_rule)
1317/* XXX cut 26 - 28 */
1318#define DIOCSETTIMEOUT _IOWR('D', 29, struct pfioc_tm)
1319#define DIOCGETTIMEOUT _IOWR('D', 30, struct pfioc_tm)
1320#define DIOCADDSTATE _IOWR('D', 37, struct pfioc_state)
1321#define DIOCCLRRULECTRS _IO ('D', 38)
1322#define DIOCGETLIMIT _IOWR('D', 39, struct pfioc_limit)
1323#define DIOCSETLIMIT _IOWR('D', 40, struct pfioc_limit)
1324#define DIOCKILLSTATES _IOWR('D', 41, struct pfioc_state_kill)
1325#define DIOCSTARTALTQ _IO ('D', 42)
1326#define DIOCSTOPALTQ _IO ('D', 43)
1327#define DIOCBEGINALTQS _IOWR('D', 44, u_int32_t)
1328#define DIOCADDALTQ _IOWR('D', 45, struct pfioc_altq)
1329#define DIOCCOMMITALTQS _IOWR('D', 46, u_int32_t)
1330#define DIOCGETALTQS _IOWR('D', 47, struct pfioc_altq)
1331#define DIOCGETALTQ _IOWR('D', 48, struct pfioc_altq)
1332#define DIOCCHANGEALTQ _IOWR('D', 49, struct pfioc_altq)
1333#define DIOCGETQSTATS _IOWR('D', 50, struct pfioc_qstats)
1334#define DIOCBEGINADDRS _IOWR('D', 51, struct pfioc_pooladdr)
1335#define DIOCADDADDR _IOWR('D', 52, struct pfioc_pooladdr)
1336#define DIOCGETADDRS _IOWR('D', 53, struct pfioc_pooladdr)
1337#define DIOCGETADDR _IOWR('D', 54, struct pfioc_pooladdr)
1338#define DIOCCHANGEADDR _IOWR('D', 55, struct pfioc_pooladdr)
1339#define DIOCGETANCHORS _IOWR('D', 56, struct pfioc_anchor)
1340#define DIOCGETANCHOR _IOWR('D', 57, struct pfioc_anchor)
1341#define DIOCGETRULESETS _IOWR('D', 58, struct pfioc_ruleset)
1342#define DIOCGETRULESET _IOWR('D', 59, struct pfioc_ruleset)
1343#define DIOCRCLRTABLES _IOWR('D', 60, struct pfioc_table)
1344#define DIOCRADDTABLES _IOWR('D', 61, struct pfioc_table)
1345#define DIOCRDELTABLES _IOWR('D', 62, struct pfioc_table)
1346#define DIOCRGETTABLES _IOWR('D', 63, struct pfioc_table)
1347#define DIOCRGETTSTATS _IOWR('D', 64, struct pfioc_table)
1348#define DIOCRCLRTSTATS _IOWR('D', 65, struct pfioc_table)
1349#define DIOCRCLRADDRS _IOWR('D', 66, struct pfioc_table)
1350#define DIOCRADDADDRS _IOWR('D', 67, struct pfioc_table)
1351#define DIOCRDELADDRS _IOWR('D', 68, struct pfioc_table)
1352#define DIOCRSETADDRS _IOWR('D', 69, struct pfioc_table)
1353#define DIOCRGETADDRS _IOWR('D', 70, struct pfioc_table)
1354#define DIOCRGETASTATS _IOWR('D', 71, struct pfioc_table)
1355#define DIOCRCLRASTATS _IOWR('D', 72, struct pfioc_table)
1356#define DIOCRTSTADDRS _IOWR('D', 73, struct pfioc_table)
1357#define DIOCRSETTFLAGS _IOWR('D', 74, struct pfioc_table)
1358#define DIOCRINABEGIN _IOWR('D', 75, struct pfioc_table)
1359#define DIOCRINACOMMIT _IOWR('D', 76, struct pfioc_table)
1360#define DIOCRINADEFINE _IOWR('D', 77, struct pfioc_table)
1361#define DIOCOSFPFLUSH _IO('D', 78)
1362#define DIOCOSFPADD _IOWR('D', 79, struct pf_osfp_ioctl)
1363#define DIOCOSFPGET _IOWR('D', 80, struct pf_osfp_ioctl)
1364#define DIOCXBEGIN _IOWR('D', 81, struct pfioc_trans)
1365#define DIOCXCOMMIT _IOWR('D', 82, struct pfioc_trans)
1366#define DIOCXROLLBACK _IOWR('D', 83, struct pfioc_trans)
1367#define DIOCGETSRCNODES _IOWR('D', 84, struct pfioc_src_nodes)
1368#define DIOCCLRSRCNODES _IO('D', 85)
1369#define DIOCSETHOSTID _IOWR('D', 86, u_int32_t)
1370#define DIOCIGETIFACES _IOWR('D', 87, struct pfioc_iface)
1371#define DIOCICLRISTATS _IOWR('D', 88, struct pfioc_iface)
1372#ifdef __FreeBSD__
1373struct pf_ifspeed {
1374 char ifname[IFNAMSIZ];
1375 u_int32_t baudrate;
1376};
1377#define DIOCGIFSPEED _IOWR('D', 89, struct pf_ifspeed)
1378#endif
1379
1380#ifdef _KERNEL
1381RB_HEAD(pf_src_tree, pf_src_node);
1382RB_PROTOTYPE(pf_src_tree, pf_src_node, entry, pf_src_compare);
1383extern struct pf_src_tree tree_src_tracking;
1384
1385RB_HEAD(pf_state_tree_id, pf_state);
1386RB_PROTOTYPE(pf_state_tree_id, pf_state,
1387 entry_id, pf_state_compare_id);
1388extern struct pf_state_tree_id tree_id;
1389extern struct pf_state_queue state_updates;
1390
1391extern struct pf_anchorqueue pf_anchors;
1392extern struct pf_ruleset pf_main_ruleset;
1393TAILQ_HEAD(pf_poolqueue, pf_pool);
1394extern struct pf_poolqueue pf_pools[2];
1395TAILQ_HEAD(pf_altqqueue, pf_altq);
1396extern struct pf_altqqueue pf_altqs[2];
1397extern struct pf_palist pf_pabuf;
1398extern struct pfi_kif **pfi_index2kif;
1399
1400extern u_int32_t ticket_altqs_active;
1401extern u_int32_t ticket_altqs_inactive;
1402extern int altqs_inactive_open;
1403extern u_int32_t ticket_pabuf;
1404extern struct pf_altqqueue *pf_altqs_active;
1405extern struct pf_altqqueue *pf_altqs_inactive;
1406extern struct pf_poolqueue *pf_pools_active;
1407extern struct pf_poolqueue *pf_pools_inactive;
1408extern int pf_tbladdr_setup(struct pf_ruleset *,
1409 struct pf_addr_wrap *);
1410extern void pf_tbladdr_remove(struct pf_addr_wrap *);
1411extern void pf_tbladdr_copyout(struct pf_addr_wrap *);
1412extern void pf_calc_skip_steps(struct pf_rulequeue *);
1413extern void pf_update_anchor_rules(void);
1414#ifdef __FreeBSD__
1415extern uma_zone_t pf_src_tree_pl, pf_rule_pl;
1416extern uma_zone_t pf_state_pl, pf_altq_pl, pf_pooladdr_pl;
1417extern uma_zone_t pfr_ktable_pl, pfr_kentry_pl;
1418extern uma_zone_t pf_cache_pl, pf_cent_pl;
1419extern uma_zone_t pf_state_scrub_pl;
1420extern uma_zone_t pfi_addr_pl;
1421#else
1422extern struct pool pf_src_tree_pl, pf_rule_pl;
1423extern struct pool pf_state_pl, pf_altq_pl, pf_pooladdr_pl;
1424extern struct pool pf_state_scrub_pl;
1425#endif
1426extern void pf_purge_timeout(void *);
1427extern void pf_purge_expired_src_nodes(void);
1428extern void pf_purge_expired_states(void);
1429extern int pf_insert_state(struct pfi_kif *,
1430 struct pf_state *);
1431extern int pf_insert_src_node(struct pf_src_node **,
1432 struct pf_rule *, struct pf_addr *,
1433 sa_family_t);
1434void pf_src_tree_remove_state(struct pf_state *);
1435extern struct pf_state *pf_find_state_byid(struct pf_state *);
1436extern struct pf_state *pf_find_state_all(struct pf_state *key,
1437 u_int8_t tree, int *more);
1438extern struct pf_anchor *pf_find_anchor(const char *);
1439extern struct pf_ruleset *pf_find_ruleset(char *, char *);
1440extern struct pf_ruleset *pf_find_or_create_ruleset(
1441 char[PF_ANCHOR_NAME_SIZE],
1442 char[PF_RULESET_NAME_SIZE]);
1443extern void pf_remove_if_empty_ruleset(
1444 struct pf_ruleset *);
1445
1446extern struct ifnet *sync_ifp;
1447extern struct pf_rule pf_default_rule;
1448extern void pf_addrcpy(struct pf_addr *, struct pf_addr *,
1449 u_int8_t);
1450void pf_rm_rule(struct pf_rulequeue *,
1451 struct pf_rule *);
1452
1453#ifdef INET
1454int pf_test(int, struct ifnet *, struct mbuf **);
1455#endif /* INET */
1456
1457#ifdef INET6
1458int pf_test6(int, struct ifnet *, struct mbuf **);
1459void pf_poolmask(struct pf_addr *, struct pf_addr*,
1460 struct pf_addr *, struct pf_addr *, u_int8_t);
1461void pf_addr_inc(struct pf_addr *, sa_family_t);
1462#endif /* INET6 */
1463
1464void *pf_pull_hdr(struct mbuf *, int, void *, int, u_short *, u_short *,
1465 sa_family_t);
1466void pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
1467int pflog_packet(struct pfi_kif *, struct mbuf *, sa_family_t, u_int8_t,
1468 u_int8_t, struct pf_rule *, struct pf_rule *, struct pf_ruleset *);
1469int pf_match_addr(u_int8_t, struct pf_addr *, struct pf_addr *,
1470 struct pf_addr *, sa_family_t);
1471int pf_match(u_int8_t, u_int32_t, u_int32_t, u_int32_t);
1472int pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
1473int pf_match_uid(u_int8_t, uid_t, uid_t, uid_t);
1474int pf_match_gid(u_int8_t, gid_t, gid_t, gid_t);
1475
1476void pf_normalize_init(void);
1477int pf_normalize_ip(struct mbuf **, int, struct pfi_kif *, u_short *);
1478int pf_normalize_ip6(struct mbuf **, int, struct pfi_kif *, u_short *);
1479int pf_normalize_tcp(int, struct pfi_kif *, struct mbuf *, int, int, void *,
1480 struct pf_pdesc *);
1481void pf_normalize_tcp_cleanup(struct pf_state *);
1482int pf_normalize_tcp_init(struct mbuf *, int, struct pf_pdesc *,
1483 struct tcphdr *, struct pf_state_peer *, struct pf_state_peer *);
1484int pf_normalize_tcp_stateful(struct mbuf *, int, struct pf_pdesc *,
1485 u_short *, struct tcphdr *, struct pf_state_peer *,
1486 struct pf_state_peer *, int *);
1487u_int32_t
1488 pf_state_expires(const struct pf_state *);
1489void pf_purge_expired_fragments(void);
1490int pf_routable(struct pf_addr *addr, sa_family_t af);
1491void pfr_initialize(void);
1492int pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
1493void pfr_update_stats(struct pfr_ktable *, struct pf_addr *, sa_family_t,
1494 u_int64_t, int, int, int);
1495int pfr_pool_get(struct pfr_ktable *, int *, struct pf_addr *,
1496 struct pf_addr **, struct pf_addr **, sa_family_t);
1497void pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
1498struct pfr_ktable *
1499 pfr_attach_table(struct pf_ruleset *, char *);
1500void pfr_detach_table(struct pfr_ktable *);
1501int pfr_clr_tables(struct pfr_table *, int *, int);
1502int pfr_add_tables(struct pfr_table *, int, int *, int);
1503int pfr_del_tables(struct pfr_table *, int, int *, int);
1504int pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
1505int pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
1506int pfr_clr_tstats(struct pfr_table *, int, int *, int);
1507int pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
1508int pfr_clr_addrs(struct pfr_table *, int *, int);
1509int pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1510 int);
1511int pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1512 int);
1513int pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1514 int *, int *, int *, int);
1515int pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
1516int pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
1517int pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
1518 int);
1519int pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1520 int);
1521int pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
1522int pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
1523int pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
1524int pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
1525 int *, u_int32_t, int);
1526
1527void pfi_initialize(void);
1528#ifdef __FreeBSD__
1529void pfi_cleanup(void);
1530#endif
1531void pfi_attach_clone(struct if_clone *);
1532void pfi_attach_ifnet(struct ifnet *);
1533void pfi_detach_ifnet(struct ifnet *);
1534struct pfi_kif *pfi_lookup_create(const char *);
1535struct pfi_kif *pfi_lookup_if(const char *);
1536int pfi_maybe_destroy(struct pfi_kif *);
1537struct pfi_kif *pfi_attach_rule(const char *);
1538void pfi_detach_rule(struct pfi_kif *);
1539void pfi_attach_state(struct pfi_kif *);
1540void pfi_detach_state(struct pfi_kif *);
1541int pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
1542void pfi_dynaddr_copyout(struct pf_addr_wrap *);
1543void pfi_dynaddr_remove(struct pf_addr_wrap *);
1544void pfi_fill_oldstatus(struct pf_status *);
1545int pfi_clr_istats(const char *, int *, int);
1546int pfi_get_ifaces(const char *, struct pfi_if *, int *, int);
1547int pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
1548 sa_family_t);
1549
1550extern struct pfi_statehead pfi_statehead;
1551
1552u_int16_t pf_tagname2tag(char *);
1553void pf_tag2tagname(u_int16_t, char *);
1554void pf_tag_unref(u_int16_t);
1555int pf_tag_packet(struct mbuf *, struct pf_tag *, int);
1556u_int32_t pf_qname2qid(char *);
1557void pf_qid2qname(u_int32_t, char *);
1558void pf_qid_unref(u_int32_t);
1559
1560extern struct pf_status pf_status;
1561
1562#ifdef __FreeBSD__
1563extern uma_zone_t pf_frent_pl, pf_frag_pl;
1564#else
1565extern struct pool pf_frent_pl, pf_frag_pl;
1566#endif
1567
1568struct pf_pool_limit {
1569 void *pp;
1570 unsigned limit;
1571};
1572extern struct pf_pool_limit pf_pool_limits[PF_LIMIT_MAX];
1573
1574#ifdef __FreeBSD__
1575struct pf_frent {
1576 LIST_ENTRY(pf_frent) fr_next;
1577 struct ip *fr_ip;
1578 struct mbuf *fr_m;
1579};
1580
1581struct pf_frcache {
1582 LIST_ENTRY(pf_frcache) fr_next;
1583 uint16_t fr_off;
1584 uint16_t fr_end;
1585};
1586
1587struct pf_fragment {
1588 RB_ENTRY(pf_fragment) fr_entry;
1589 TAILQ_ENTRY(pf_fragment) frag_next;
1590 struct in_addr fr_src;
1591 struct in_addr fr_dst;
1592 u_int8_t fr_p; /* protocol of this fragment */
1593 u_int8_t fr_flags; /* status flags */
1594 u_int16_t fr_id; /* fragment id for reassemble */
1595 u_int16_t fr_max; /* fragment data max */
1596 u_int32_t fr_timeout;
1597#define fr_queue fr_u.fru_queue
1598#define fr_cache fr_u.fru_cache
1599 union {
1600 LIST_HEAD(pf_fragq, pf_frent) fru_queue; /* buffering */
1601 LIST_HEAD(pf_cacheq, pf_frcache) fru_cache; /* non-buf */
1602 } fr_u;
1603};
1604#endif /* (__FreeBSD__) */
1605
1606#endif /* _KERNEL */
1607
1608/* The fingerprint functions can be linked into userland programs (tcpdump) */
1609int pf_osfp_add(struct pf_osfp_ioctl *);
1610#ifdef _KERNEL
1611struct pf_osfp_enlist *
1612 pf_osfp_fingerprint(struct pf_pdesc *, struct mbuf *, int,
1613 const struct tcphdr *);
1614#endif /* _KERNEL */
1615struct pf_osfp_enlist *
1616 pf_osfp_fingerprint_hdr(const struct ip *, const struct tcphdr *);
1617void pf_osfp_flush(void);
1618int pf_osfp_get(struct pf_osfp_ioctl *);
1619#ifdef __FreeBSD__
1620int pf_osfp_initialize(void);
1621void pf_osfp_cleanup(void);
1622#else
1623void pf_osfp_initialize(void);
1624#endif
1625int pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
1626struct pf_os_fingerprint *
1627 pf_osfp_validate(void);
1628
1629
1630#endif /* _NET_PFVAR_H_ */