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