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