1 /* $OpenBSD: pfvar.h,v 1.254 2007/07/13 09:17:48 markus Exp $ */
4 * Copyright (c) 2004 The DragonFly Project. All rights reserved.
6 * Copyright (c) 2001 Daniel Hartmeier
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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.
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.
38 #include <sys/param.h>
39 #include <sys/types.h>
40 #include <sys/limits.h>
41 #include <sys/ioccom.h>
42 #include <sys/queue.h>
46 #include <net/radix.h>
47 #include <net/if_clone.h>
48 #include <netinet/in.h>
49 #include <netinet/in_pcb.h>
52 #include <vm/vm_zone.h>
57 * If we include <netipsec/keydb.h>, we need _KERNEL definition.
58 * This makes pfctl compilation difficult.
60 union sockaddr_union {
62 struct sockaddr_in sin;
63 struct sockaddr_in6 sin6;
66 #include <netinet/tcp_fsm.h>
71 extern struct lwkt_token pf_token;
73 #define PF_TCPS_PROXY_SRC ((TCP_NSTATES)+0)
74 #define PF_TCPS_PROXY_DST ((TCP_NSTATES)+1)
77 #define RTLABEL_LEN 32
78 #define IFG_ALL "all" /* group contains all interfaces */
79 #define BPF_DIRECTION_OUT (1<<1)
82 #define ALTQ_IS_ENABLED(ifq) ((ifq)->altq_flags & ALTQF_ENABLED)
85 #define PF_MD5_DIGEST_LENGTH 16
86 #ifdef MD5_DIGEST_LENGTH
87 #if PF_MD5_DIGEST_LENGTH != MD5_DIGEST_LENGTH
92 enum { PF_INOUT, PF_IN, PF_OUT };
93 enum { PF_LAN_EXT, PF_EXT_GWY, PF_ID };
94 enum { PF_PASS, PF_DROP, PF_SCRUB, PF_NOSCRUB, PF_NAT, PF_NONAT,
95 PF_BINAT, PF_NOBINAT, PF_RDR, PF_NORDR, PF_SYNPROXY_DROP };
96 enum { PF_RULESET_SCRUB, PF_RULESET_FILTER, PF_RULESET_NAT,
97 PF_RULESET_BINAT, PF_RULESET_RDR, PF_RULESET_MAX };
98 enum { PF_OP_NONE, PF_OP_IRG, PF_OP_EQ, PF_OP_NE, PF_OP_LT,
99 PF_OP_LE, PF_OP_GT, PF_OP_GE, PF_OP_XRG, PF_OP_RRG };
100 enum { PF_DEBUG_NONE, PF_DEBUG_URGENT, PF_DEBUG_MISC, PF_DEBUG_NOISY };
101 enum { PF_CHANGE_NONE, PF_CHANGE_ADD_HEAD, PF_CHANGE_ADD_TAIL,
102 PF_CHANGE_ADD_BEFORE, PF_CHANGE_ADD_AFTER,
103 PF_CHANGE_REMOVE, PF_CHANGE_GET_TICKET };
104 enum { PF_GET_NONE, PF_GET_CLR_CNTR };
107 * Note about PFTM_*: real indices into pf_rule.timeout[] come before
108 * PFTM_MAX, special cases afterwards. See pf_state_expires().
110 enum { PFTM_TCP_FIRST_PACKET, PFTM_TCP_OPENING, PFTM_TCP_ESTABLISHED,
111 PFTM_TCP_CLOSING, PFTM_TCP_FIN_WAIT, PFTM_TCP_CLOSED,
112 PFTM_UDP_FIRST_PACKET, PFTM_UDP_SINGLE, PFTM_UDP_MULTIPLE,
113 PFTM_ICMP_FIRST_PACKET, PFTM_ICMP_ERROR_REPLY,
114 PFTM_OTHER_FIRST_PACKET, PFTM_OTHER_SINGLE,
115 PFTM_OTHER_MULTIPLE, PFTM_FRAG, PFTM_INTERVAL,
116 PFTM_ADAPTIVE_START, PFTM_ADAPTIVE_END, PFTM_SRC_NODE,
117 PFTM_TS_DIFF, PFTM_MAX, PFTM_PURGE, PFTM_UNLINKED,
120 /* PFTM default values */
121 #define PFTM_TCP_FIRST_PACKET_VAL 120 /* First TCP packet */
122 #define PFTM_TCP_OPENING_VAL 30 /* No response yet */
123 #define PFTM_TCP_ESTABLISHED_VAL 24*60*60/* Established */
124 #define PFTM_TCP_CLOSING_VAL 15 * 60 /* Half closed */
125 #define PFTM_TCP_FIN_WAIT_VAL 45 /* Got both FINs */
126 #define PFTM_TCP_CLOSED_VAL 90 /* Got a RST */
127 #define PFTM_UDP_FIRST_PACKET_VAL 60 /* First UDP packet */
128 #define PFTM_UDP_SINGLE_VAL 30 /* Unidirectional */
129 #define PFTM_UDP_MULTIPLE_VAL 60 /* Bidirectional */
130 #define PFTM_ICMP_FIRST_PACKET_VAL 20 /* First ICMP packet */
131 #define PFTM_ICMP_ERROR_REPLY_VAL 10 /* Got error response */
132 #define PFTM_OTHER_FIRST_PACKET_VAL 60 /* First packet */
133 #define PFTM_OTHER_SINGLE_VAL 30 /* Unidirectional */
134 #define PFTM_OTHER_MULTIPLE_VAL 60 /* Bidirectional */
135 #define PFTM_FRAG_VAL 30 /* Fragment expire */
136 #define PFTM_INTERVAL_VAL 10 /* Expire interval */
137 #define PFTM_SRC_NODE_VAL 0 /* Source tracking */
138 #define PFTM_TS_DIFF_VAL 30 /* Allowed TS diff */
140 enum { PF_NOPFROUTE, PF_FASTROUTE, PF_ROUTETO, PF_DUPTO, PF_REPLYTO };
141 enum { PF_LIMIT_STATES, PF_LIMIT_SRC_NODES, PF_LIMIT_FRAGS,
142 PF_LIMIT_TABLES, PF_LIMIT_TABLE_ENTRIES, PF_LIMIT_MAX };
143 #define PF_POOL_IDMASK 0x0f
144 enum { PF_POOL_NONE, PF_POOL_BITMASK, PF_POOL_RANDOM,
145 PF_POOL_SRCHASH, PF_POOL_ROUNDROBIN };
146 enum { PF_ADDR_ADDRMASK, PF_ADDR_NOROUTE, PF_ADDR_DYNIFTL,
147 PF_ADDR_TABLE, PF_ADDR_RTLABEL, PF_ADDR_URPFFAILED };
148 #define PF_POOL_TYPEMASK 0x0f
149 #define PF_POOL_STICKYADDR 0x20
150 #define PF_WSCALE_FLAG 0x80
151 #define PF_WSCALE_MASK 0x0f
154 #define PF_LOG_ALL 0x02
155 #define PF_LOG_SOCKET_LOOKUP 0x04
164 } pfa; /* 128-bit address */
167 #define addr8 pfa.addr8
168 #define addr16 pfa.addr16
169 #define addr32 pfa.addr32
172 #define PF_TABLE_NAME_SIZE 32
174 #define PFI_AFLAG_NETWORK 0x01
175 #define PFI_AFLAG_BROADCAST 0x02
176 #define PFI_AFLAG_PEER 0x04
177 #define PFI_AFLAG_MODEMASK 0x07
178 #define PFI_AFLAG_NOALIAS 0x08
180 struct pf_addr_wrap {
186 char ifname[IFNAMSIZ];
187 char tblname[PF_TABLE_NAME_SIZE];
188 char rtlabelname[RTLABEL_LEN];
192 struct pfi_dynaddr *dyn;
193 struct pfr_ktable *tbl;
197 u_int8_t type; /* PF_ADDR_* */
198 u_int8_t iflags; /* PFI_AFLAG_* */
204 TAILQ_ENTRY(pfi_dynaddr) entry;
205 struct pf_addr pfid_addr4;
206 struct pf_addr pfid_mask4;
207 struct pf_addr pfid_addr6;
208 struct pf_addr pfid_mask6;
209 struct pfr_ktable *pfid_kt;
210 struct pfi_kif *pfid_kif;
211 void *pfid_hook_cookie;
212 int pfid_net; /* mask or 128 */
213 int pfid_acnt4; /* address count IPv4 */
214 int pfid_acnt6; /* address count IPv6 */
215 sa_family_t pfid_af; /* rule af */
216 u_int8_t pfid_iflags; /* PFI_AFLAG_* */
220 * Address manipulation macros
223 /* XXX correct values for zinit? */
224 #define ZONE_CREATE(var, type, desc) \
225 var = zinit(desc, sizeof(type), 1, ZONE_DESTROYABLE, 1); \
226 if (var == NULL) break
227 #define ZONE_DESTROY(a) zdestroy(a)
229 #define pool_get(p, f) zalloc(*(p))
230 #define pool_put(p, o) zfree(*(p), (o))
232 #define NTOHS(x) (x) = ntohs((__uint16_t)(x))
233 #define HTONS(x) (x) = htons((__uint16_t)(x))
238 #define PFLOG_MODVER 1
239 #define PFSYNC_MODVER 1
241 #define PFLOG_MINVER 1
242 #define PFLOG_PREFVER PFLOG_MODVER
243 #define PFLOG_MAXVER 1
244 #define PFSYNC_MINVER 1
245 #define PFSYNC_PREFVER PFSYNC_MODVER
246 #define PFSYNC_MAXVER 1
248 /* prototyped for pf_subr.c */
250 TAILQ_ENTRY(hook_desc) hd_list;
251 void (*hd_fn)(void *);
254 TAILQ_HEAD(hook_desc_head, hook_desc);
256 void *hook_establish(struct hook_desc_head *, int, void (*)(void *), void *);
257 void hook_disestablish(struct hook_desc_head *, void *);
258 void dohooks(struct hook_desc_head *, int);
260 #define HOOK_REMOVE 0x01
261 #define HOOK_FREE 0x02
271 #define PF_INET6_ONLY
277 #define PF_INET_INET6
283 #define PF_INET_INET6
287 /* Both IPv4 and IPv6 */
290 #define PF_AEQ(a, b, c) \
291 ((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \
292 ((a)->addr32[3] == (b)->addr32[3] && \
293 (a)->addr32[2] == (b)->addr32[2] && \
294 (a)->addr32[1] == (b)->addr32[1] && \
295 (a)->addr32[0] == (b)->addr32[0])) \
297 #define PF_ANEQ(a, b, c) \
298 ((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \
299 ((a)->addr32[3] != (b)->addr32[3] || \
300 (a)->addr32[2] != (b)->addr32[2] || \
301 (a)->addr32[1] != (b)->addr32[1] || \
302 (a)->addr32[0] != (b)->addr32[0])) \
304 #define PF_AZERO(a, c) \
305 ((c == AF_INET && !(a)->addr32[0]) || \
306 (!(a)->addr32[0] && !(a)->addr32[1] && \
307 !(a)->addr32[2] && !(a)->addr32[3] )) \
309 #define PF_MATCHA(n, a, m, b, f) \
310 pf_match_addr(n, a, m, b, f)
312 #define PF_ACPY(a, b, f) \
315 #define PF_AINC(a, f) \
318 #define PF_POOLMASK(a, b, c, d, f) \
319 pf_poolmask(a, b, c, d, f)
327 #define PF_AEQ(a, b, c) \
328 ((a)->addr32[3] == (b)->addr32[3] && \
329 (a)->addr32[2] == (b)->addr32[2] && \
330 (a)->addr32[1] == (b)->addr32[1] && \
331 (a)->addr32[0] == (b)->addr32[0]) \
333 #define PF_ANEQ(a, b, c) \
334 ((a)->addr32[3] != (b)->addr32[3] || \
335 (a)->addr32[2] != (b)->addr32[2] || \
336 (a)->addr32[1] != (b)->addr32[1] || \
337 (a)->addr32[0] != (b)->addr32[0]) \
339 #define PF_AZERO(a, c) \
340 (!(a)->addr32[0] && \
345 #define PF_MATCHA(n, a, m, b, f) \
346 pf_match_addr(n, a, m, b, f)
348 #define PF_ACPY(a, b, f) \
351 #define PF_AINC(a, f) \
354 #define PF_POOLMASK(a, b, c, d, f) \
355 pf_poolmask(a, b, c, d, f)
362 #define PF_AEQ(a, b, c) \
363 ((a)->addr32[0] == (b)->addr32[0])
365 #define PF_ANEQ(a, b, c) \
366 ((a)->addr32[0] != (b)->addr32[0])
368 #define PF_AZERO(a, c) \
371 #define PF_MATCHA(n, a, m, b, f) \
372 pf_match_addr(n, a, m, b, f)
374 #define PF_ACPY(a, b, f) \
375 (a)->v4.s_addr = (b)->v4.s_addr
377 #define PF_AINC(a, f) \
379 (a)->addr32[0] = htonl(ntohl((a)->addr32[0]) + 1); \
382 #define PF_POOLMASK(a, b, c, d, f) \
384 (a)->addr32[0] = ((b)->addr32[0] & (c)->addr32[0]) | \
385 (((c)->addr32[0] ^ 0xffffffff ) & (d)->addr32[0]); \
388 #endif /* PF_INET_ONLY */
389 #endif /* PF_INET6_ONLY */
390 #endif /* PF_INET_INET6 */
392 #define PF_MISMATCHAW(aw, x, af, neg, ifp) \
394 (((aw)->type == PF_ADDR_NOROUTE && \
395 pf_routable((x), (af), NULL)) || \
396 (((aw)->type == PF_ADDR_URPFFAILED && (ifp) != NULL && \
397 pf_routable((x), (af), (ifp))) || \
398 ((aw)->type == PF_ADDR_RTLABEL && \
399 !pf_rtlabel_match((x), (af), (aw))) || \
400 ((aw)->type == PF_ADDR_TABLE && \
401 !pfr_match_addr((aw)->p.tbl, (x), (af))) || \
402 ((aw)->type == PF_ADDR_DYNIFTL && \
403 !pfi_match_addr((aw)->p.dyn, (x), (af))) || \
404 ((aw)->type == PF_ADDR_ADDRMASK && \
405 !PF_AZERO(&(aw)->v.a.mask, (af)) && \
406 !PF_MATCHA(0, &(aw)->v.a.addr, \
407 &(aw)->v.a.mask, (x), (af))))) != \
422 struct pf_rule_addr {
423 struct pf_addr_wrap addr;
430 struct pf_addr_wrap addr;
431 TAILQ_ENTRY(pf_pooladdr) entries;
432 char ifname[IFNAMSIZ];
436 TAILQ_HEAD(pf_palist, pf_pooladdr);
438 struct pf_poolhashkey {
443 } pfk; /* 128-bit hash key */
444 #define key8 pfk.key8
445 #define key16 pfk.key16
446 #define key32 pfk.key32
450 struct pf_palist list;
451 struct pf_pooladdr *cur;
452 struct pf_poolhashkey key;
453 struct pf_addr counter;
455 u_int16_t proxy_port[2];
461 /* A packed Operating System description for fingerprinting */
462 typedef u_int32_t pf_osfp_t;
463 #define PF_OSFP_ANY ((pf_osfp_t)0)
464 #define PF_OSFP_UNKNOWN ((pf_osfp_t)-1)
465 #define PF_OSFP_NOMATCH ((pf_osfp_t)-2)
467 struct pf_osfp_entry {
468 SLIST_ENTRY(pf_osfp_entry) fp_entry;
471 #define PF_OSFP_EXPANDED 0x001 /* expanded entry */
472 #define PF_OSFP_GENERIC 0x002 /* generic signature */
473 #define PF_OSFP_NODETAIL 0x004 /* no p0f details */
474 #define PF_OSFP_LEN 32
475 char fp_class_nm[PF_OSFP_LEN];
476 char fp_version_nm[PF_OSFP_LEN];
477 char fp_subtype_nm[PF_OSFP_LEN];
479 #define PF_OSFP_ENTRY_EQ(a, b) \
480 ((a)->fp_os == (b)->fp_os && \
481 memcmp((a)->fp_class_nm, (b)->fp_class_nm, PF_OSFP_LEN) == 0 && \
482 memcmp((a)->fp_version_nm, (b)->fp_version_nm, PF_OSFP_LEN) == 0 && \
483 memcmp((a)->fp_subtype_nm, (b)->fp_subtype_nm, PF_OSFP_LEN) == 0)
485 /* handle pf_osfp_t packing */
486 #define _FP_RESERVED_BIT 1 /* For the special negative #defines */
487 #define _FP_UNUSED_BITS 1
488 #define _FP_CLASS_BITS 10 /* OS Class (Windows, Linux) */
489 #define _FP_VERSION_BITS 10 /* OS version (95, 98, NT, 2.4.54, 3.2) */
490 #define _FP_SUBTYPE_BITS 10 /* patch level (NT SP4, SP3, ECN patch) */
491 #define PF_OSFP_UNPACK(osfp, class, version, subtype) do { \
492 (class) = ((osfp) >> (_FP_VERSION_BITS+_FP_SUBTYPE_BITS)) & \
493 ((1 << _FP_CLASS_BITS) - 1); \
494 (version) = ((osfp) >> _FP_SUBTYPE_BITS) & \
495 ((1 << _FP_VERSION_BITS) - 1);\
496 (subtype) = (osfp) & ((1 << _FP_SUBTYPE_BITS) - 1); \
498 #define PF_OSFP_PACK(osfp, class, version, subtype) do { \
499 (osfp) = ((class) & ((1 << _FP_CLASS_BITS) - 1)) << (_FP_VERSION_BITS \
500 + _FP_SUBTYPE_BITS); \
501 (osfp) |= ((version) & ((1 << _FP_VERSION_BITS) - 1)) << \
503 (osfp) |= (subtype) & ((1 << _FP_SUBTYPE_BITS) - 1); \
506 /* the fingerprint of an OSes TCP SYN packet */
507 typedef u_int64_t pf_tcpopts_t;
508 struct pf_os_fingerprint {
509 SLIST_HEAD(pf_osfp_enlist, pf_osfp_entry) fp_oses; /* list of matches */
510 pf_tcpopts_t fp_tcpopts; /* packed TCP options */
511 u_int16_t fp_wsize; /* TCP window size */
512 u_int16_t fp_psize; /* ip->ip_len */
513 u_int16_t fp_mss; /* TCP MSS */
515 #define PF_OSFP_WSIZE_MOD 0x0001 /* Window modulus */
516 #define PF_OSFP_WSIZE_DC 0x0002 /* Window don't care */
517 #define PF_OSFP_WSIZE_MSS 0x0004 /* Window multiple of MSS */
518 #define PF_OSFP_WSIZE_MTU 0x0008 /* Window multiple of MTU */
519 #define PF_OSFP_PSIZE_MOD 0x0010 /* packet size modulus */
520 #define PF_OSFP_PSIZE_DC 0x0020 /* packet size don't care */
521 #define PF_OSFP_WSCALE 0x0040 /* TCP window scaling */
522 #define PF_OSFP_WSCALE_MOD 0x0080 /* TCP window scale modulus */
523 #define PF_OSFP_WSCALE_DC 0x0100 /* TCP window scale dont-care */
524 #define PF_OSFP_MSS 0x0200 /* TCP MSS */
525 #define PF_OSFP_MSS_MOD 0x0400 /* TCP MSS modulus */
526 #define PF_OSFP_MSS_DC 0x0800 /* TCP MSS dont-care */
527 #define PF_OSFP_DF 0x1000 /* IPv4 don't fragment bit */
528 #define PF_OSFP_TS0 0x2000 /* Zero timestamp */
529 #define PF_OSFP_INET6 0x4000 /* IPv6 */
530 u_int8_t fp_optcnt; /* TCP option count */
531 u_int8_t fp_wscale; /* TCP window scaling */
532 u_int8_t fp_ttl; /* IPv4 TTL */
533 #define PF_OSFP_MAXTTL_OFFSET 40
534 /* TCP options packing */
535 #define PF_OSFP_TCPOPT_NOP 0x0 /* TCP NOP option */
536 #define PF_OSFP_TCPOPT_WSCALE 0x1 /* TCP window scaling option */
537 #define PF_OSFP_TCPOPT_MSS 0x2 /* TCP max segment size opt */
538 #define PF_OSFP_TCPOPT_SACK 0x3 /* TCP SACK OK option */
539 #define PF_OSFP_TCPOPT_TS 0x4 /* TCP timestamp option */
540 #define PF_OSFP_TCPOPT_BITS 3 /* bits used by each option */
541 #define PF_OSFP_MAX_OPTS \
542 (sizeof(((struct pf_os_fingerprint *)0)->fp_tcpopts) * 8) \
543 / PF_OSFP_TCPOPT_BITS
545 SLIST_ENTRY(pf_os_fingerprint) fp_next;
548 struct pf_osfp_ioctl {
549 struct pf_osfp_entry fp_os;
550 pf_tcpopts_t fp_tcpopts; /* packed TCP options */
551 u_int16_t fp_wsize; /* TCP window size */
552 u_int16_t fp_psize; /* ip->ip_len */
553 u_int16_t fp_mss; /* TCP MSS */
555 u_int8_t fp_optcnt; /* TCP option count */
556 u_int8_t fp_wscale; /* TCP window scaling */
557 u_int8_t fp_ttl; /* IPv4 TTL */
559 int fp_getnum; /* DIOCOSFPGET number */
568 #define PF_ANCHOR_NAME_SIZE 64
571 struct pf_rule_addr src;
572 struct pf_rule_addr dst;
573 #define PF_SKIP_IFP 0
574 #define PF_SKIP_DIR 1
576 #define PF_SKIP_PROTO 3
577 #define PF_SKIP_SRC_ADDR 4
578 #define PF_SKIP_SRC_PORT 5
579 #define PF_SKIP_DST_ADDR 6
580 #define PF_SKIP_DST_PORT 7
581 #define PF_SKIP_COUNT 8
582 union pf_rule_ptr skip[PF_SKIP_COUNT];
583 #define PF_RULE_LABEL_SIZE 64
584 char label[PF_RULE_LABEL_SIZE];
585 #define PF_QNAME_SIZE 64
586 char ifname[IFNAMSIZ];
587 char qname[PF_QNAME_SIZE];
588 char pqname[PF_QNAME_SIZE];
589 #define PF_TAG_NAME_SIZE 64
590 char tagname[PF_TAG_NAME_SIZE];
591 char match_tagname[PF_TAG_NAME_SIZE];
593 char overload_tblname[PF_TABLE_NAME_SIZE];
595 TAILQ_ENTRY(pf_rule) entries;
596 struct pf_pool rpool;
598 u_int64_t evaluations;
599 u_int64_t packets[2];
603 struct pf_anchor *anchor;
604 struct pfr_ktable *overload_tbl;
606 pf_osfp_t os_fingerprint;
609 u_int32_t timeout[PFTM_MAX];
611 u_int32_t max_states;
613 u_int32_t max_src_nodes;
614 u_int32_t max_src_states;
615 u_int32_t max_src_conn;
628 u_int16_t return_icmp;
629 u_int16_t return_icmp6;
634 struct pf_rule_uid uid;
635 struct pf_rule_gid gid;
644 u_int8_t match_tag_not;
647 #define PF_STATE_NORMAL 0x1
648 #define PF_STATE_MODULATE 0x2
649 #define PF_STATE_SYNPROXY 0x3
662 u_int8_t anchor_relative;
663 u_int8_t anchor_wildcard;
665 #define PF_FLUSH 0x01
666 #define PF_FLUSH_GLOBAL 0x02
669 #define PF_PICKUPS_UNSPECIFIED 0
670 #define PF_PICKUPS_DISABLED 1
671 #define PF_PICKUPS_HASHONLY 2
672 #define PF_PICKUPS_ENABLED 3
673 u_int8_t pickup_mode;
674 u_int8_t unused01; /* available for use */
678 #define PFRULE_DROP 0x0000
679 #define PFRULE_RETURNRST 0x0001
680 #define PFRULE_FRAGMENT 0x0002
681 #define PFRULE_RETURNICMP 0x0004
682 #define PFRULE_RETURN 0x0008
683 #define PFRULE_NOSYNC 0x0010
684 #define PFRULE_SRCTRACK 0x0020 /* track source states */
685 #define PFRULE_RULESRCTRACK 0x0040 /* per rule */
688 #define PFRULE_NODF 0x0100
689 #define PFRULE_FRAGCROP 0x0200 /* non-buffering frag cache */
690 #define PFRULE_FRAGDROP 0x0400 /* drop funny fragments */
691 #define PFRULE_RANDOMID 0x0800
692 #define PFRULE_REASSEMBLE_TCP 0x1000
694 /* rule flags again */
695 #define PFRULE_IFBOUND 0x00010000 /* if-bound */
697 #define PFSTATE_HIWAT 10000 /* default state table size */
698 #define PFSTATE_ADAPT_START 6000 /* default adaptive timeout start */
699 #define PFSTATE_ADAPT_END 12000 /* default adaptive timeout end */
702 struct pf_threshold {
704 #define PF_THRESHOLD_MULT 1000
705 #define PF_THRESHOLD_MAX 0xffffffff / PF_THRESHOLD_MULT
712 RB_ENTRY(pf_src_node) entry;
714 struct pf_addr raddr;
715 union pf_rule_ptr rule;
718 u_int64_t packets[2];
721 struct pf_threshold conn_rate;
728 #define PFSNODE_HIWAT 10000 /* default source node table size */
730 struct pf_state_scrub {
731 struct timeval pfss_last; /* time received last packet */
732 u_int32_t pfss_tsecr; /* last echoed timestamp */
733 u_int32_t pfss_tsval; /* largest timestamp */
734 u_int32_t pfss_tsval0; /* original timestamp */
735 u_int16_t pfss_flags;
736 #define PFSS_TIMESTAMP 0x0001 /* modulate timestamp */
737 #define PFSS_PAWS 0x0010 /* stricter PAWS checks */
738 #define PFSS_PAWS_IDLED 0x0020 /* was idle too long. no PAWS */
739 #define PFSS_DATA_TS 0x0040 /* timestamp on data packets */
740 #define PFSS_DATA_NOTS 0x0080 /* no timestamp on data packets */
741 u_int8_t pfss_ttl; /* stashed TTL */
743 u_int32_t pfss_ts_mod; /* timestamp modulation */
746 struct pf_state_host {
752 struct pf_state_peer {
753 u_int32_t seqlo; /* Max sequence number sent */
754 u_int32_t seqhi; /* Max the other end ACKd + win */
755 u_int32_t seqdiff; /* Sequence number modulator */
756 u_int16_t max_win; /* largest window (pre scaling) */
757 u_int8_t state; /* active state level */
758 u_int8_t wscale; /* window scaling factor */
759 u_int16_t mss; /* Maximum segment size option */
760 u_int8_t tcp_est; /* Did we reach TCPS_ESTABLISHED */
761 struct pf_state_scrub *scrub; /* state is scrubbed */
765 TAILQ_HEAD(pf_state_queue, pf_state);
767 /* keep synced with struct pf_state_key, used in RB_FIND */
768 struct pf_state_key_cmp {
769 struct pf_state_host lan;
770 struct pf_state_host gwy;
771 struct pf_state_host ext;
778 TAILQ_HEAD(pf_statelist, pf_state);
780 struct pf_state_key {
781 struct pf_state_host lan;
782 struct pf_state_host gwy;
783 struct pf_state_host ext;
789 RB_ENTRY(pf_state_key) entry_lan_ext;
790 RB_ENTRY(pf_state_key) entry_ext_gwy;
791 struct pf_statelist states;
792 u_short refcnt; /* same size as if_index */
796 /* keep synced with struct pf_state, used in RB_FIND */
797 struct pf_state_cmp {
808 TAILQ_ENTRY(pf_state) entry_list;
809 TAILQ_ENTRY(pf_state) next;
810 RB_ENTRY(pf_state) entry_id;
811 struct pf_state_peer src;
812 struct pf_state_peer dst;
813 union pf_rule_ptr rule;
814 union pf_rule_ptr anchor;
815 union pf_rule_ptr nat_rule;
816 struct pf_addr rt_addr;
817 struct pf_state_key *state_key;
819 struct pfi_kif *rt_kif;
820 struct pf_src_node *src_node;
821 struct pf_src_node *nat_src_node;
822 u_int64_t packets[2];
827 u_int32_t pfsync_time;
833 u_int8_t pickup_mode;
834 #define PFSTATE_NOSYNC 0x01
835 #define PFSTATE_FROMSYNC 0x02
836 #define PFSTATE_STALE 0x04
840 * Unified state structures for pulling states out of the kernel
841 * used by pfsync(4) and the pf(4) ioctl.
843 struct pfsync_state_scrub {
844 u_int16_t pfss_flags;
845 u_int8_t pfss_ttl; /* stashed TTL */
846 #define PFSYNC_SCRUB_FLAG_VALID 0x01
848 u_int32_t pfss_ts_mod; /* timestamp modulation */
851 struct pfsync_state_host {
857 struct pfsync_state_peer {
858 struct pfsync_state_scrub scrub; /* state is scrubbed */
859 u_int32_t seqlo; /* Max sequence number sent */
860 u_int32_t seqhi; /* Max the other end ACKd + win */
861 u_int32_t seqdiff; /* Sequence number modulator */
862 u_int16_t max_win; /* largest window (pre scaling) */
863 u_int16_t mss; /* Maximum segment size option */
864 u_int8_t state; /* active state level */
865 u_int8_t wscale; /* window scaling factor */
869 struct pfsync_state {
871 char ifname[IFNAMSIZ];
872 struct pfsync_state_host lan;
873 struct pfsync_state_host gwy;
874 struct pfsync_state_host ext;
875 struct pfsync_state_peer src;
876 struct pfsync_state_peer dst;
877 struct pf_addr rt_addr;
883 u_int32_t packets[2][2];
884 u_int32_t bytes[2][2];
896 #define PFSYNC_FLAG_COMPRESS 0x01
897 #define PFSYNC_FLAG_STALE 0x02
898 #define PFSYNC_FLAG_SRCNODE 0x04
899 #define PFSYNC_FLAG_NATSRCNODE 0x08
900 #define PFSTATE_GOT_SYN_MASK (PFSTATE_GOT_SYN1|PFSTATE_GOT_SYN2)
901 #define PFSTATE_GOT_SYN1 0x04 /* got SYN in one direction */
902 #define PFSTATE_GOT_SYN2 0x08 /* got SYN in the other direction */
904 /* for copies to/from userland via pf_ioctl() */
905 #define pf_state_peer_to_pfsync(s,d) do { \
906 (d)->seqlo = (s)->seqlo; \
907 (d)->seqhi = (s)->seqhi; \
908 (d)->seqdiff = (s)->seqdiff; \
909 (d)->max_win = (s)->max_win; \
910 (d)->mss = (s)->mss; \
911 (d)->state = (s)->state; \
912 (d)->wscale = (s)->wscale; \
914 (d)->scrub.pfss_flags = \
915 (s)->scrub->pfss_flags & PFSS_TIMESTAMP; \
916 (d)->scrub.pfss_ttl = (s)->scrub->pfss_ttl; \
917 (d)->scrub.pfss_ts_mod = (s)->scrub->pfss_ts_mod; \
918 (d)->scrub.scrub_flag = PFSYNC_SCRUB_FLAG_VALID; \
922 #define pf_state_peer_from_pfsync(s,d) do { \
923 (d)->seqlo = (s)->seqlo; \
924 (d)->seqhi = (s)->seqhi; \
925 (d)->seqdiff = (s)->seqdiff; \
926 (d)->max_win = (s)->max_win; \
927 (d)->mss = ntohs((s)->mss); \
928 (d)->state = (s)->state; \
929 (d)->wscale = (s)->wscale; \
930 if ((s)->scrub.scrub_flag == PFSYNC_SCRUB_FLAG_VALID && \
931 (d)->scrub != NULL) { \
932 (d)->scrub->pfss_flags = \
933 ntohs((s)->scrub.pfss_flags) & PFSS_TIMESTAMP; \
934 (d)->scrub->pfss_ttl = (s)->scrub.pfss_ttl; \
935 (d)->scrub->pfss_ts_mod = (s)->scrub.pfss_ts_mod; \
939 #define pf_state_counter_to_pfsync(s,d) do { \
940 d[0] = (s>>32)&0xffffffff; \
941 d[1] = s&0xffffffff; \
944 #define pf_state_counter_from_pfsync(s) \
945 (((u_int64_t)(s[0])<<32) | (u_int64_t)(s[1]))
949 TAILQ_HEAD(pf_rulequeue, pf_rule);
955 struct pf_rulequeue queues[2];
957 struct pf_rulequeue *ptr;
958 struct pf_rule **ptr_array;
963 } rules[PF_RULESET_MAX];
964 struct pf_anchor *anchor;
970 RB_HEAD(pf_anchor_global, pf_anchor);
971 RB_HEAD(pf_anchor_node, pf_anchor);
973 RB_ENTRY(pf_anchor) entry_global;
974 RB_ENTRY(pf_anchor) entry_node;
975 struct pf_anchor *parent;
976 struct pf_anchor_node children;
977 char name[PF_ANCHOR_NAME_SIZE];
978 char path[MAXPATHLEN];
979 struct pf_ruleset ruleset;
980 int refcnt; /* anchor rules */
983 RB_PROTOTYPE(pf_anchor_global, pf_anchor, entry_global, pf_anchor_compare);
984 RB_PROTOTYPE(pf_anchor_node, pf_anchor, entry_node, pf_anchor_compare);
986 #define PF_RESERVED_ANCHOR "_pf"
988 #define PFR_TFLAG_PERSIST 0x00000001
989 #define PFR_TFLAG_CONST 0x00000002
990 #define PFR_TFLAG_ACTIVE 0x00000004
991 #define PFR_TFLAG_INACTIVE 0x00000008
992 #define PFR_TFLAG_REFERENCED 0x00000010
993 #define PFR_TFLAG_REFDANCHOR 0x00000020
994 #define PFR_TFLAG_USRMASK 0x00000003
995 #define PFR_TFLAG_SETMASK 0x0000003C
996 #define PFR_TFLAG_ALLMASK 0x0000003F
999 char pfrt_anchor[MAXPATHLEN];
1000 char pfrt_name[PF_TABLE_NAME_SIZE];
1001 u_int32_t pfrt_flags;
1002 u_int8_t pfrt_fback;
1005 enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
1006 PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
1007 PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_MAX };
1011 struct in_addr _pfra_ip4addr;
1012 struct in6_addr _pfra_ip6addr;
1017 u_int8_t pfra_fback;
1019 #define pfra_ip4addr pfra_u._pfra_ip4addr
1020 #define pfra_ip6addr pfra_u._pfra_ip6addr
1022 enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
1023 enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
1024 #define PFR_OP_XPASS PFR_OP_ADDR_MAX
1027 struct pfr_addr pfras_a;
1028 u_int64_t pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1029 u_int64_t pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1033 enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
1036 struct pfr_table pfrts_t;
1037 u_int64_t pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1038 u_int64_t pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1039 u_int64_t pfrts_match;
1040 u_int64_t pfrts_nomatch;
1043 int pfrts_refcnt[PFR_REFCNT_MAX];
1045 #define pfrts_name pfrts_t.pfrt_name
1046 #define pfrts_flags pfrts_t.pfrt_flags
1048 SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
1050 struct radix_node pfrke_node[2];
1051 union sockaddr_union pfrke_sa;
1052 u_int64_t pfrke_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1053 u_int64_t pfrke_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1054 SLIST_ENTRY(pfr_kentry) pfrke_workq;
1059 u_int8_t pfrke_mark;
1060 u_int8_t pfrke_intrpool;
1063 SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
1064 RB_HEAD(pfr_ktablehead, pfr_ktable);
1066 struct pfr_tstats pfrkt_ts;
1067 RB_ENTRY(pfr_ktable) pfrkt_tree;
1068 SLIST_ENTRY(pfr_ktable) pfrkt_workq;
1069 struct radix_node_head *pfrkt_ip4;
1070 struct radix_node_head *pfrkt_ip6;
1071 struct pfr_ktable *pfrkt_shadow;
1072 struct pfr_ktable *pfrkt_root;
1073 struct pf_ruleset *pfrkt_rs;
1077 #define pfrkt_t pfrkt_ts.pfrts_t
1078 #define pfrkt_name pfrkt_t.pfrt_name
1079 #define pfrkt_anchor pfrkt_t.pfrt_anchor
1080 #define pfrkt_ruleset pfrkt_t.pfrt_ruleset
1081 #define pfrkt_flags pfrkt_t.pfrt_flags
1082 #define pfrkt_cnt pfrkt_ts.pfrts_cnt
1083 #define pfrkt_refcnt pfrkt_ts.pfrts_refcnt
1084 #define pfrkt_packets pfrkt_ts.pfrts_packets
1085 #define pfrkt_bytes pfrkt_ts.pfrts_bytes
1086 #define pfrkt_match pfrkt_ts.pfrts_match
1087 #define pfrkt_nomatch pfrkt_ts.pfrts_nomatch
1088 #define pfrkt_tzero pfrkt_ts.pfrts_tzero
1090 RB_HEAD(pf_state_tree_lan_ext, pf_state_key);
1091 RB_PROTOTYPE(pf_state_tree_lan_ext, pf_state_key,
1092 entry_lan_ext, pf_state_compare_lan_ext);
1094 RB_HEAD(pf_state_tree_ext_gwy, pf_state_key);
1095 RB_PROTOTYPE(pf_state_tree_ext_gwy, pf_state_key,
1096 entry_ext_gwy, pf_state_compare_ext_gwy);
1099 char pfif_name[IFNAMSIZ];
1100 u_int64_t pfif_packets[2][2][2];
1101 u_int64_t pfif_bytes[2][2][2];
1102 u_int64_t pfif_addcnt;
1103 u_int64_t pfif_delcnt;
1110 TAILQ_HEAD(pfi_grouphead, pfi_kif);
1111 TAILQ_HEAD(pfi_statehead, pfi_kif);
1112 RB_HEAD(pfi_ifhead, pfi_kif);
1115 extern struct pf_state_tree_lan_ext pf_statetbl_lan_ext;
1116 extern struct pf_state_tree_ext_gwy pf_statetbl_ext_gwy;
1118 /* keep synced with pfi_kif, used in RB_FIND */
1119 struct pfi_kif_cmp {
1120 char pfik_ifname[IFNAMSIZ];
1124 struct pfi_if pfik_if;
1125 RB_ENTRY(pfi_kif) pfik_tree;
1126 u_int64_t pfik_packets[2][2][2];
1127 u_int64_t pfik_bytes[2][2][2];
1128 u_int32_t pfik_tzero;
1130 struct hook_desc_head *pfik_ah_head;
1131 void *pfik_ah_cookie;
1132 struct pfi_kif *pfik_parent;
1133 struct ifnet *pfik_ifp;
1134 struct ifg_group *pfik_group;
1137 TAILQ_HEAD(, pfi_dynaddr) pfik_dynaddrs;
1139 #define pfik_name pfik_if.pfif_name
1140 #define pfik_packets pfik_if.pfif_packets
1141 #define pfik_bytes pfik_if.pfif_bytes
1142 #define pfik_tzero pfik_if.pfif_tzero
1143 #define pfik_flags pfik_if.pfif_flags
1144 #define pfik_addcnt pfik_if.pfif_addcnt
1145 #define pfik_delcnt pfik_if.pfif_delcnt
1146 #define pfik_states pfik_if.pfif_states
1147 #define pfik_rules pfik_if.pfif_rules
1155 #define PFI_IFLAG_GROUP 0x0001 /* group of interfaces */
1156 #define PFI_IFLAG_INSTANCE 0x0002 /* single instance */
1157 #define PFI_IFLAG_CLONABLE 0x0010 /* clonable group */
1158 #define PFI_IFLAG_DYNAMIC 0x0020 /* dynamic group */
1159 #define PFI_IFLAG_SKIP 0x0100 /* skip filtering on interface */
1160 #define PFI_IFLAG_PLACEHOLDER 0x8000 /* placeholder group/interface */
1169 u_int64_t tot_len; /* Make Mickey money */
1175 struct icmp6_hdr *icmp6;
1179 struct pf_addr baddr; /* address before translation */
1180 struct pf_addr naddr; /* address after translation */
1181 struct pf_rule *nat_rule; /* nat/rdr rule applied to packet */
1182 struct pf_addr *src;
1183 struct pf_addr *dst;
1187 u_int32_t p_len; /* total length of payload */
1188 u_int16_t flags; /* Let SCRUB trigger behavior in
1189 * state code. Easier than tags */
1190 #define PFDESC_TCP_NORM 0x0001 /* TCP shall be statefully scrubbed */
1191 #define PFDESC_IP_REAS 0x0002 /* IP frags would've been reassembled */
1197 /* flags for RDR options */
1198 #define PF_DPORT_RANGE 0x01 /* Dest port uses range */
1199 #define PF_RPORT_RANGE 0x02 /* RDR'ed port uses range */
1201 /* Reasons code for passing/dropping a packet */
1202 #define PFRES_MATCH 0 /* Explicit match of a rule */
1203 #define PFRES_BADOFF 1 /* Bad offset for pull_hdr */
1204 #define PFRES_FRAG 2 /* Dropping following fragment */
1205 #define PFRES_SHORT 3 /* Dropping short packet */
1206 #define PFRES_NORM 4 /* Dropping by normalizer */
1207 #define PFRES_MEMORY 5 /* Dropped due to lacking mem */
1208 #define PFRES_TS 6 /* Bad TCP Timestamp (RFC1323) */
1209 #define PFRES_CONGEST 7 /* Congestion (of ipintrq) */
1210 #define PFRES_IPOPTIONS 8 /* IP option */
1211 #define PFRES_PROTCKSUM 9 /* Protocol checksum invalid */
1212 #define PFRES_BADSTATE 10 /* State mismatch */
1213 #define PFRES_STATEINS 11 /* State insertion failure */
1214 #define PFRES_MAXSTATES 12 /* State limit */
1215 #define PFRES_SRCLIMIT 13 /* Source node/conn limit */
1216 #define PFRES_SYNPROXY 14 /* SYN proxy */
1217 #define PFRES_MAX 15 /* total+1 */
1219 #define PFRES_NAMES { \
1238 /* Counters for other things we want to keep track of */
1239 #define LCNT_STATES 0 /* states */
1240 #define LCNT_SRCSTATES 1 /* max-src-states */
1241 #define LCNT_SRCNODES 2 /* max-src-nodes */
1242 #define LCNT_SRCCONN 3 /* max-src-conn */
1243 #define LCNT_SRCCONNRATE 4 /* max-src-conn-rate */
1244 #define LCNT_OVERLOAD_TABLE 5 /* entry added to overload table */
1245 #define LCNT_OVERLOAD_FLUSH 6 /* state entries flushed */
1246 #define LCNT_MAX 7 /* total+1 */
1248 #define LCNT_NAMES { \
1249 "max states per rule", \
1253 "max-src-conn-rate", \
1254 "overload table insertion", \
1255 "overload flush states", \
1259 /* UDP state enumeration */
1260 #define PFUDPS_NO_TRAFFIC 0
1261 #define PFUDPS_SINGLE 1
1262 #define PFUDPS_MULTIPLE 2
1264 #define PFUDPS_NSTATES 3 /* number of state levels */
1266 #define PFUDPS_NAMES { \
1273 /* Other protocol state enumeration */
1274 #define PFOTHERS_NO_TRAFFIC 0
1275 #define PFOTHERS_SINGLE 1
1276 #define PFOTHERS_MULTIPLE 2
1278 #define PFOTHERS_NSTATES 3 /* number of state levels */
1280 #define PFOTHERS_NAMES { \
1287 #define FCNT_STATE_SEARCH 0
1288 #define FCNT_STATE_INSERT 1
1289 #define FCNT_STATE_REMOVALS 2
1292 #define SCNT_SRC_NODE_SEARCH 0
1293 #define SCNT_SRC_NODE_INSERT 1
1294 #define SCNT_SRC_NODE_REMOVALS 2
1297 #define ACTION_SET(a, x) \
1303 #define REASON_SET(a, x) \
1307 if (x < PFRES_MAX) \
1308 pf_status.counters[x]++; \
1312 u_int64_t counters[PFRES_MAX];
1313 u_int64_t lcounters[LCNT_MAX]; /* limit counters */
1314 u_int64_t fcounters[FCNT_MAX];
1315 u_int64_t scounters[SCNT_MAX];
1316 u_int64_t pcounters[2][2][3];
1317 u_int64_t bcounters[2][2];
1321 u_int32_t src_nodes;
1325 char ifname[IFNAMSIZ];
1326 u_int8_t pf_chksum[PF_MD5_DIGEST_LENGTH];
1346 /* real-time service curve */
1347 u_int rtsc_m1; /* slope of the 1st segment in bps */
1348 u_int rtsc_d; /* the x-projection of m1 in msec */
1349 u_int rtsc_m2; /* slope of the 2nd segment in bps */
1350 /* link-sharing service curve */
1354 /* upper-limit service curve */
1362 * XXX this needs some work
1365 u_int nbuckets; /* hash buckets */
1366 u_int hogs_m1; /* hog detection bandwidth */
1369 /* link-sharing service curve */
1376 char ifname[IFNAMSIZ];
1378 void *altq_disc; /* discipline-specific state */
1379 TAILQ_ENTRY(pf_altq) entries;
1381 /* scheduler spec */
1382 u_int8_t scheduler; /* scheduler type */
1383 u_int16_t tbrsize; /* tokenbucket regulator size */
1384 u_int32_t ifbandwidth; /* interface bandwidth */
1387 char qname[PF_QNAME_SIZE]; /* queue name */
1388 char parent[PF_QNAME_SIZE]; /* parent name */
1389 u_int32_t parent_qid; /* parent queue id */
1390 u_int32_t bandwidth; /* queue bandwidth */
1391 u_int8_t priority; /* priority */
1392 u_int16_t qlimit; /* queue size limit */
1393 u_int16_t flags; /* misc flags */
1395 struct cbq_opts cbq_opts;
1396 struct priq_opts priq_opts;
1397 struct hfsc_opts hfsc_opts;
1398 struct fairq_opts fairq_opts;
1401 u_int32_t qid; /* return value */
1404 #define PF_TAG_GENERATED 0x01
1405 #define PF_TAG_FRAGCACHE 0x02
1406 #define PF_TAG_TRANSLATE_LOCALHOST 0x04
1407 #define PF_TAG_STATE_HASHED 0x08
1410 u_int16_t tag; /* tag id */
1414 TAILQ_ENTRY(pf_tagname) entries;
1415 char name[PF_TAG_NAME_SIZE];
1420 #define PFFRAG_FRENT_HIWAT 5000 /* Number of fragment entries */
1421 #define PFFRAG_FRAG_HIWAT 1000 /* Number of fragmented packets */
1422 #define PFFRAG_FRCENT_HIWAT 50000 /* Number of fragment cache entries */
1423 #define PFFRAG_FRCACHE_HIWAT 10000 /* Number of fragment descriptors */
1425 #define PFR_KTABLE_HIWAT 1000 /* Number of tables */
1426 #define PFR_KENTRY_HIWAT 200000 /* Number of table entries */
1427 #define PFR_KENTRY_HIWAT_SMALL 100000 /* Number of table entries (tiny hosts) */
1430 * ioctl parameter structures
1433 struct pfioc_pooladdr {
1441 char anchor[MAXPATHLEN];
1442 struct pf_pooladdr addr;
1448 u_int32_t pool_ticket;
1450 char anchor[MAXPATHLEN];
1451 char anchor_call[MAXPATHLEN];
1452 struct pf_rule rule;
1455 struct pfioc_natlook {
1456 struct pf_addr saddr;
1457 struct pf_addr daddr;
1458 struct pf_addr rsaddr;
1459 struct pf_addr rdaddr;
1469 struct pfioc_state {
1474 struct pfioc_src_node_kill {
1475 /* XXX returns the number of src nodes killed in psnk_af */
1476 sa_family_t psnk_af;
1477 struct pf_rule_addr psnk_src;
1478 struct pf_rule_addr psnk_dst;
1481 struct pfioc_state_kill {
1482 /* XXX returns the number of states killed in psk_af */
1485 struct pf_rule_addr psk_src;
1486 struct pf_rule_addr psk_dst;
1487 char psk_ifname[IFNAMSIZ];
1490 struct pfioc_states {
1494 struct pfsync_state *psu_states;
1496 #define ps_buf ps_u.psu_buf
1497 #define ps_states ps_u.psu_states
1500 struct pfioc_src_nodes {
1504 struct pf_src_node *psu_src_nodes;
1506 #define psn_buf psn_u.psu_buf
1507 #define psn_src_nodes psn_u.psu_src_nodes
1511 char ifname[IFNAMSIZ];
1519 struct pfioc_limit {
1528 struct pf_altq altq;
1531 struct pfioc_qstats {
1539 struct pfioc_anchor {
1541 char name[PF_ANCHOR_NAME_SIZE];
1544 struct pfioc_ruleset {
1546 char path[MAXPATHLEN];
1547 char name[PF_ANCHOR_NAME_SIZE];
1550 #define PF_RULESET_ALTQ (PF_RULESET_MAX)
1551 #define PF_RULESET_TABLE (PF_RULESET_MAX+1)
1552 struct pfioc_trans {
1553 int size; /* number of elements */
1554 int esize; /* size of each element in bytes */
1555 struct pfioc_trans_e {
1557 char anchor[MAXPATHLEN];
1562 #define PFR_FLAG_ATOMIC 0x00000001
1563 #define PFR_FLAG_DUMMY 0x00000002
1564 #define PFR_FLAG_FEEDBACK 0x00000004
1565 #define PFR_FLAG_CLSTATS 0x00000008
1566 #define PFR_FLAG_ADDRSTOO 0x00000010
1567 #define PFR_FLAG_REPLACE 0x00000020
1568 #define PFR_FLAG_ALLRSETS 0x00000040
1569 #define PFR_FLAG_ALLMASK 0x0000007F
1571 #define PFR_FLAG_USERIOCTL 0x10000000
1574 struct pfioc_table {
1575 struct pfr_table pfrio_table;
1584 u_int32_t pfrio_ticket;
1586 #define pfrio_exists pfrio_nadd
1587 #define pfrio_nzero pfrio_nadd
1588 #define pfrio_nmatch pfrio_nadd
1589 #define pfrio_naddr pfrio_size2
1590 #define pfrio_setflag pfrio_size2
1591 #define pfrio_clrflag pfrio_nadd
1593 struct pfioc_iface {
1594 char pfiio_name[IFNAMSIZ];
1607 #define DIOCSTART _IO ('D', 1)
1608 #define DIOCSTOP _IO ('D', 2)
1609 #define DIOCBEGINRULES _IOWR('D', 3, struct pfioc_rule)
1610 #define DIOCADDRULE _IOWR('D', 4, struct pfioc_rule)
1611 #define DIOCCOMMITRULES _IOWR('D', 5, struct pfioc_rule)
1612 #define DIOCGETRULES _IOWR('D', 6, struct pfioc_rule)
1613 #define DIOCGETRULE _IOWR('D', 7, struct pfioc_rule)
1614 /* XXX cut 8 - 17 */
1615 #define DIOCCLRSTATES _IOWR('D', 18, struct pfioc_state_kill)
1616 #define DIOCGETSTATE _IOWR('D', 19, struct pfioc_state)
1617 #define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_if)
1618 #define DIOCGETSTATUS _IOWR('D', 21, struct pf_status)
1619 #define DIOCCLRSTATUS _IO ('D', 22)
1620 #define DIOCNATLOOK _IOWR('D', 23, struct pfioc_natlook)
1621 #define DIOCSETDEBUG _IOWR('D', 24, u_int32_t)
1622 #define DIOCGETSTATES _IOWR('D', 25, struct pfioc_states)
1623 #define DIOCCHANGERULE _IOWR('D', 26, struct pfioc_rule)
1624 /* XXX cut 26 - 28 */
1625 #define DIOCSETTIMEOUT _IOWR('D', 29, struct pfioc_tm)
1626 #define DIOCGETTIMEOUT _IOWR('D', 30, struct pfioc_tm)
1627 #define DIOCADDSTATE _IOWR('D', 37, struct pfioc_state)
1628 #define DIOCCLRRULECTRS _IO ('D', 38)
1629 #define DIOCGETLIMIT _IOWR('D', 39, struct pfioc_limit)
1630 #define DIOCSETLIMIT _IOWR('D', 40, struct pfioc_limit)
1631 #define DIOCKILLSTATES _IOWR('D', 41, struct pfioc_state_kill)
1632 #define DIOCSTARTALTQ _IO ('D', 42)
1633 #define DIOCSTOPALTQ _IO ('D', 43)
1634 #define DIOCBEGINALTQS _IOWR('D', 44, u_int32_t)
1635 #define DIOCADDALTQ _IOWR('D', 45, struct pfioc_altq)
1636 #define DIOCCOMMITALTQS _IOWR('D', 46, u_int32_t)
1637 #define DIOCGETALTQS _IOWR('D', 47, struct pfioc_altq)
1638 #define DIOCGETALTQ _IOWR('D', 48, struct pfioc_altq)
1639 #define DIOCCHANGEALTQ _IOWR('D', 49, struct pfioc_altq)
1640 #define DIOCGETQSTATS _IOWR('D', 50, struct pfioc_qstats)
1641 #define DIOCBEGINADDRS _IOWR('D', 51, struct pfioc_pooladdr)
1642 #define DIOCADDADDR _IOWR('D', 52, struct pfioc_pooladdr)
1643 #define DIOCGETADDRS _IOWR('D', 53, struct pfioc_pooladdr)
1644 #define DIOCGETADDR _IOWR('D', 54, struct pfioc_pooladdr)
1645 #define DIOCCHANGEADDR _IOWR('D', 55, struct pfioc_pooladdr)
1646 #define DIOCGETRULESETS _IOWR('D', 58, struct pfioc_ruleset)
1647 #define DIOCGETRULESET _IOWR('D', 59, struct pfioc_ruleset)
1648 #define DIOCRCLRTABLES _IOWR('D', 60, struct pfioc_table)
1649 #define DIOCRADDTABLES _IOWR('D', 61, struct pfioc_table)
1650 #define DIOCRDELTABLES _IOWR('D', 62, struct pfioc_table)
1651 #define DIOCRGETTABLES _IOWR('D', 63, struct pfioc_table)
1652 #define DIOCRGETTSTATS _IOWR('D', 64, struct pfioc_table)
1653 #define DIOCRCLRTSTATS _IOWR('D', 65, struct pfioc_table)
1654 #define DIOCRCLRADDRS _IOWR('D', 66, struct pfioc_table)
1655 #define DIOCRADDADDRS _IOWR('D', 67, struct pfioc_table)
1656 #define DIOCRDELADDRS _IOWR('D', 68, struct pfioc_table)
1657 #define DIOCRSETADDRS _IOWR('D', 69, struct pfioc_table)
1658 #define DIOCRGETADDRS _IOWR('D', 70, struct pfioc_table)
1659 #define DIOCRGETASTATS _IOWR('D', 71, struct pfioc_table)
1660 #define DIOCRCLRASTATS _IOWR('D', 72, struct pfioc_table)
1661 #define DIOCRTSTADDRS _IOWR('D', 73, struct pfioc_table)
1662 #define DIOCRSETTFLAGS _IOWR('D', 74, struct pfioc_table)
1663 #define DIOCRINABEGIN _IOWR('D', 75, struct pfioc_table)
1664 #define DIOCRINACOMMIT _IOWR('D', 76, struct pfioc_table)
1665 #define DIOCRINADEFINE _IOWR('D', 77, struct pfioc_table)
1666 #define DIOCOSFPFLUSH _IO('D', 78)
1667 #define DIOCOSFPADD _IOWR('D', 79, struct pf_osfp_ioctl)
1668 #define DIOCOSFPGET _IOWR('D', 80, struct pf_osfp_ioctl)
1669 #define DIOCXBEGIN _IOWR('D', 81, struct pfioc_trans)
1670 #define DIOCXCOMMIT _IOWR('D', 82, struct pfioc_trans)
1671 #define DIOCXROLLBACK _IOWR('D', 83, struct pfioc_trans)
1672 #define DIOCGETSRCNODES _IOWR('D', 84, struct pfioc_src_nodes)
1673 #define DIOCCLRSRCNODES _IO('D', 85)
1674 #define DIOCSETHOSTID _IOWR('D', 86, u_int32_t)
1675 #define DIOCIGETIFACES _IOWR('D', 87, struct pfioc_iface)
1676 #define DIOCICLRISTATS _IOWR('D', 88, struct pfioc_iface)
1677 #define DIOCSETIFFLAG _IOWR('D', 89, struct pfioc_iface)
1678 #define DIOCCLRIFFLAG _IOWR('D', 90, struct pfioc_iface)
1679 #define DIOCKILLSRCNODES _IOWR('D', 91, struct pfioc_src_node_kill)
1681 char ifname[IFNAMSIZ];
1684 #define DIOCGIFSPEED _IOWR('D', 89, struct pf_ifspeed)
1687 RB_HEAD(pf_src_tree, pf_src_node);
1688 RB_PROTOTYPE(pf_src_tree, pf_src_node, entry, pf_src_compare);
1689 extern struct pf_src_tree tree_src_tracking;
1691 RB_HEAD(pf_state_tree_id, pf_state);
1692 RB_PROTOTYPE(pf_state_tree_id, pf_state,
1693 entry_id, pf_state_compare_id);
1694 extern struct pf_state_tree_id tree_id;
1695 extern struct pf_state_queue state_list;
1697 TAILQ_HEAD(pf_poolqueue, pf_pool);
1698 extern struct pf_poolqueue pf_pools[2];
1699 TAILQ_HEAD(pf_altqqueue, pf_altq);
1700 extern struct pf_altqqueue pf_altqs[2];
1701 extern struct pf_palist pf_pabuf;
1703 extern u_int32_t ticket_altqs_active;
1704 extern u_int32_t ticket_altqs_inactive;
1705 extern int altqs_inactive_open;
1706 extern u_int32_t ticket_pabuf;
1707 extern struct pf_altqqueue *pf_altqs_active;
1708 extern struct pf_altqqueue *pf_altqs_inactive;
1709 extern struct pf_poolqueue *pf_pools_active;
1710 extern struct pf_poolqueue *pf_pools_inactive;
1711 extern int pf_tbladdr_setup(struct pf_ruleset *,
1712 struct pf_addr_wrap *);
1713 extern void pf_tbladdr_remove(struct pf_addr_wrap *);
1714 extern void pf_tbladdr_copyout(struct pf_addr_wrap *);
1715 extern void pf_calc_skip_steps(struct pf_rulequeue *);
1716 extern vm_zone_t pf_src_tree_pl, pf_rule_pl;
1717 extern vm_zone_t pf_state_pl, pf_state_key_pl, pf_altq_pl,
1719 extern vm_zone_t pfr_ktable_pl, pfr_kentry_pl;
1720 extern vm_zone_t pfr_kentry_pl2;
1721 extern vm_zone_t pf_cache_pl, pf_cent_pl;
1722 extern vm_zone_t pf_state_scrub_pl;
1723 extern vm_zone_t pfi_addr_pl;
1724 extern void pf_purge_thread(void *);
1725 extern int pf_purge_expired_src_nodes(int);
1726 extern int pf_purge_expired_states(u_int32_t, int);
1727 extern void pf_unlink_state(struct pf_state *);
1728 extern void pf_free_state(struct pf_state *);
1729 extern int pf_insert_state(struct pfi_kif *,
1731 extern int pf_insert_src_node(struct pf_src_node **,
1732 struct pf_rule *, struct pf_addr *,
1734 void pf_src_tree_remove_state(struct pf_state *);
1735 u_int32_t pf_state_hash(struct pf_state_key *sk);
1736 extern struct pf_state *pf_find_state_byid(struct pf_state_cmp *);
1737 extern struct pf_state *pf_find_state_all(struct pf_state_key_cmp *,
1739 extern void pf_print_state(struct pf_state *);
1740 extern void pf_print_flags(u_int8_t);
1741 extern u_int16_t pf_cksum_fixup(u_int16_t, u_int16_t, u_int16_t,
1744 extern struct ifnet *sync_ifp;
1745 extern struct pf_rule pf_default_rule;
1746 extern void pf_addrcpy(struct pf_addr *, struct pf_addr *,
1748 void pf_rm_rule(struct pf_rulequeue *,
1752 int pf_test(int, struct ifnet *, struct mbuf **, struct ether_header *, struct inpcb *);
1756 int pf_test6(int, struct ifnet *, struct mbuf **, struct ether_header *, struct inpcb *);
1757 void pf_poolmask(struct pf_addr *, struct pf_addr*,
1758 struct pf_addr *, struct pf_addr *, u_int8_t);
1759 void pf_addr_inc(struct pf_addr *, sa_family_t);
1762 u_int32_t pf_new_isn(struct pf_state_key *); /* From FreeBSD */
1763 void *pf_pull_hdr(struct mbuf *, int, void *, int, u_short *, u_short *,
1765 void pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
1766 int pflog_packet(struct pfi_kif *, struct mbuf *, sa_family_t, u_int8_t,
1767 u_int8_t, struct pf_rule *, struct pf_rule *, struct pf_ruleset *,
1769 int pf_match_addr(u_int8_t, struct pf_addr *, struct pf_addr *,
1770 struct pf_addr *, sa_family_t);
1771 int pf_match(u_int8_t, u_int32_t, u_int32_t, u_int32_t);
1772 int pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
1773 int pf_match_uid(u_int8_t, uid_t, uid_t, uid_t);
1774 int pf_match_gid(u_int8_t, gid_t, gid_t, gid_t);
1776 void pf_normalize_init(void);
1777 int pf_normalize_ip(struct mbuf **, int, struct pfi_kif *, u_short *,
1779 int pf_normalize_ip6(struct mbuf **, int, struct pfi_kif *, u_short *,
1781 int pf_normalize_tcp(int, struct pfi_kif *, struct mbuf *, int, int, void *,
1783 void pf_normalize_tcp_cleanup(struct pf_state *);
1784 int pf_normalize_tcp_init(struct mbuf *, int, struct pf_pdesc *,
1785 struct tcphdr *, struct pf_state_peer *, struct pf_state_peer *);
1786 int pf_normalize_tcp_stateful(struct mbuf *, int, struct pf_pdesc *,
1787 u_short *, struct tcphdr *, struct pf_state *,
1788 struct pf_state_peer *, struct pf_state_peer *, int *);
1790 pf_state_expires(const struct pf_state *);
1791 void pf_purge_expired_fragments(void);
1792 int pf_routable(struct pf_addr *addr, sa_family_t af, struct pfi_kif *);
1793 int pf_rtlabel_match(struct pf_addr *, sa_family_t, struct pf_addr_wrap *);
1794 int pf_socket_lookup(int, struct pf_pdesc *);
1795 struct pf_state_key *
1796 pf_alloc_state_key(struct pf_state *);
1797 void pfr_initialize(void);
1798 int pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
1799 void pfr_update_stats(struct pfr_ktable *, struct pf_addr *, sa_family_t,
1800 u_int64_t, int, int, int);
1801 int pfr_pool_get(struct pfr_ktable *, int *, struct pf_addr *,
1802 struct pf_addr **, struct pf_addr **, sa_family_t);
1803 void pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
1805 pfr_attach_table(struct pf_ruleset *, char *);
1806 void pfr_detach_table(struct pfr_ktable *);
1807 int pfr_clr_tables(struct pfr_table *, int *, int);
1808 int pfr_add_tables(struct pfr_table *, int, int *, int);
1809 int pfr_del_tables(struct pfr_table *, int, int *, int);
1810 int pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
1811 int pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
1812 int pfr_clr_tstats(struct pfr_table *, int, int *, int);
1813 int pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
1814 int pfr_clr_addrs(struct pfr_table *, int *, int);
1815 int pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *, long);
1816 int pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1818 int pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1820 int pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1821 int *, int *, int *, int, u_int32_t);
1822 int pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
1823 int pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
1824 int pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
1826 int pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1828 int pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
1829 int pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
1830 int pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
1831 int pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
1832 int *, u_int32_t, int);
1834 extern struct pfi_kif *pfi_all;
1836 void pfi_initialize(void);
1837 struct pfi_kif *pfi_kif_get(const char *);
1838 void pfi_cleanup(void);
1839 void pfi_attach_clone(struct if_clone *);
1840 void pfi_kif_ref(struct pfi_kif *, enum pfi_kif_refs);
1841 void pfi_kif_unref(struct pfi_kif *, enum pfi_kif_refs);
1842 int pfi_kif_match(struct pfi_kif *, struct pfi_kif *);
1843 void pfi_attach_ifnet(struct ifnet *);
1844 void pfi_detach_ifnet(struct ifnet *);
1845 struct pfi_kif *pfi_lookup_create(const char *);
1846 struct pfi_kif *pfi_lookup_if(const char *);
1847 void pfi_attach_ifgroup(struct ifg_group *);
1848 void pfi_detach_ifgroup(struct ifg_group *);
1849 void pfi_group_change(const char *);
1850 int pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
1852 int pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
1853 void pfi_dynaddr_remove(struct pf_addr_wrap *);
1854 void pfi_dynaddr_copyout(struct pf_addr_wrap *);
1855 void pfi_fill_oldstatus(struct pf_status *);
1856 int pfi_clr_istats(const char *);
1857 int pfi_get_ifaces(const char *, struct pfi_kif *, int *);
1858 int pfi_set_flags(const char *, int);
1859 int pfi_clear_flags(const char *, int);
1861 u_int16_t pf_tagname2tag(char *);
1862 void pf_tag2tagname(u_int16_t, char *);
1863 void pf_tag_ref(u_int16_t);
1864 void pf_tag_unref(u_int16_t);
1865 int pf_tag_packet(struct mbuf *, int, int);
1866 u_int32_t pf_qname2qid(char *);
1867 void pf_qid2qname(u_int32_t, char *);
1868 void pf_qid_unref(u_int32_t);
1870 extern struct pf_status pf_status;
1871 extern vm_zone_t pf_frent_pl, pf_frag_pl;
1872 extern struct lock pf_consistency_lock;
1874 struct pf_pool_limit {
1878 extern struct pf_pool_limit pf_pool_limits[PF_LIMIT_MAX];
1881 LIST_ENTRY(pf_frent) fr_next;
1887 LIST_ENTRY(pf_frcache) fr_next;
1892 struct pf_fragment {
1893 RB_ENTRY(pf_fragment) fr_entry;
1894 TAILQ_ENTRY(pf_fragment) frag_next;
1895 struct in_addr fr_src;
1896 struct in_addr fr_dst;
1897 u_int8_t fr_p; /* protocol of this fragment */
1898 u_int8_t fr_flags; /* status flags */
1899 u_int16_t fr_id; /* fragment id for reassemble */
1900 u_int16_t fr_max; /* fragment data max */
1901 u_int32_t fr_timeout;
1902 #define fr_queue fr_u.fru_queue
1903 #define fr_cache fr_u.fru_cache
1905 LIST_HEAD(pf_fragq, pf_frent) fru_queue; /* buffering */
1906 LIST_HEAD(pf_cacheq, pf_frcache) fru_cache; /* non-buf */
1910 #endif /* _KERNEL */
1912 extern struct pf_anchor_global pf_anchors;
1913 extern struct pf_anchor pf_main_anchor;
1914 #define pf_main_ruleset pf_main_anchor.ruleset
1916 /* these ruleset functions can be linked into userland programs (pfctl) */
1917 int pf_get_ruleset_number(u_int8_t);
1918 void pf_init_ruleset(struct pf_ruleset *);
1919 int pf_anchor_setup(struct pf_rule *,
1920 const struct pf_ruleset *, const char *);
1921 int pf_anchor_copyout(const struct pf_ruleset *,
1922 const struct pf_rule *, struct pfioc_rule *);
1923 void pf_anchor_remove(struct pf_rule *);
1924 void pf_remove_if_empty_ruleset(struct pf_ruleset *);
1925 struct pf_anchor *pf_find_anchor(const char *);
1926 struct pf_ruleset *pf_find_ruleset(const char *);
1927 struct pf_ruleset *pf_find_or_create_ruleset(const char *);
1928 void pf_rs_initialize(void);
1930 /* The fingerprint functions can be linked into userland programs (tcpdump) */
1931 int pf_osfp_add(struct pf_osfp_ioctl *);
1933 struct pf_osfp_enlist *
1934 pf_osfp_fingerprint(struct pf_pdesc *, struct mbuf *, int,
1935 const struct tcphdr *);
1936 #endif /* _KERNEL */
1937 struct pf_osfp_enlist *
1938 pf_osfp_fingerprint_hdr(const struct ip *, const struct ip6_hdr *,
1939 const struct tcphdr *);
1940 void pf_osfp_flush(void);
1941 int pf_osfp_get(struct pf_osfp_ioctl *);
1942 int pf_osfp_initialize(void);
1943 void pf_osfp_cleanup(void);
1944 int pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
1945 struct pf_os_fingerprint *
1946 pf_osfp_validate(void);
1949 #endif /* _NET_PFVAR_H_ */