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