1/* $OpenBSD: pfvar.h,v 1.548 2026/02/05 03:26:00 dlg Exp $ */
2
3/*
4 * Copyright (c) 2001 Daniel Hartmeier
5 * Copyright (c) 2002 - 2013 Henning Brauer <henning@openbsd.org>
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * - Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * - Redistributions in binary form must reproduce the above
15 * copyright notice, this list of conditions and the following
16 * disclaimer in the documentation and/or other materials provided
17 * with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 */
33
34#ifndef _NET_PFVAR_H_
35#define _NET_PFVAR_H_
36
37#include <sys/queue.h>
38#include <sys/tree.h>
39#include <sys/syslimits.h>
40#include <sys/refcnt.h>
41#include <sys/timeout.h>
42
43#include <netinet/in.h>
44
45#include <net/radix.h>
46#include <net/route.h>
47
48struct ip;
49struct ip6_hdr;
50struct mbuf_list;
51
52#define PF_TCPS_PROXY_SRC ((TCP_NSTATES)+0)
53#define PF_TCPS_PROXY_DST ((TCP_NSTATES)+1)
54
55#define PF_MD5_DIGEST_LENGTH 16
56#ifdef MD5_DIGEST_LENGTH
57#if PF_MD5_DIGEST_LENGTH != MD5_DIGEST_LENGTH
58#error md5 digest length mismatch
59#endif
60#endif
61
62typedef struct refcnt pf_refcnt_t;
63#define PF_REF_INIT(_x) refcnt_init(&(_x))
64#define PF_REF_TAKE(_x) refcnt_take(&(_x))
65#define PF_REF_RELE(_x) refcnt_rele(&(_x))
66
67enum { PF_INOUT, PF_IN, PF_OUT, PF_FWD };
68enum { PF_PASS, PF_DROP, PF_SCRUB, PF_NOSCRUB, PF_NAT, PF_NONAT,
69 PF_BINAT, PF_NOBINAT, PF_RDR, PF_NORDR, PF_SYNPROXY_DROP, PF_DEFER,
70 PF_MATCH, PF_DIVERT, PF_RT, PF_AFRT };
71enum { PF_TRANS_RULESET, PF_TRANS_TABLE };
72enum { PF_OP_NONE, PF_OP_IRG, PF_OP_EQ, PF_OP_NE, PF_OP_LT,
73 PF_OP_LE, PF_OP_GT, PF_OP_GE, PF_OP_XRG, PF_OP_RRG };
74enum { PF_CHANGE_NONE, PF_CHANGE_ADD_HEAD, PF_CHANGE_ADD_TAIL,
75 PF_CHANGE_ADD_BEFORE, PF_CHANGE_ADD_AFTER,
76 PF_CHANGE_REMOVE, PF_CHANGE_GET_TICKET };
77enum { PF_GET_NONE, PF_GET_CLR_CNTR };
78enum { PF_SK_WIRE, PF_SK_STACK, PF_SK_BOTH };
79enum { PF_PEER_SRC, PF_PEER_DST, PF_PEER_BOTH };
80
81/*
82 * Note about PFTM_*: real indices into pf_rule.timeout[] come before
83 * PFTM_MAX, special cases afterwards. See pf_state_expires().
84 */
85enum { PFTM_TCP_FIRST_PACKET, PFTM_TCP_OPENING, PFTM_TCP_ESTABLISHED,
86 PFTM_TCP_CLOSING, PFTM_TCP_FIN_WAIT, PFTM_TCP_CLOSED,
87 PFTM_UDP_FIRST_PACKET, PFTM_UDP_SINGLE, PFTM_UDP_MULTIPLE,
88 PFTM_ICMP_FIRST_PACKET, PFTM_ICMP_ERROR_REPLY,
89 PFTM_OTHER_FIRST_PACKET, PFTM_OTHER_SINGLE,
90 PFTM_OTHER_MULTIPLE, PFTM_FRAG, PFTM_INTERVAL,
91 PFTM_ADAPTIVE_START, PFTM_ADAPTIVE_END, PFTM_SRC_NODE,
92 PFTM_TS_DIFF, PFTM_MAX, PFTM_PURGE, PFTM_UNLINKED };
93
94/* PFTM default values */
95#define PFTM_TCP_FIRST_PACKET_VAL 120 /* First TCP packet */
96#define PFTM_TCP_OPENING_VAL 30 /* No response yet */
97#define PFTM_TCP_ESTABLISHED_VAL 24*60*60/* Established */
98#define PFTM_TCP_CLOSING_VAL 15 * 60 /* Half closed */
99#define PFTM_TCP_FIN_WAIT_VAL 45 /* Got both FINs */
100#define PFTM_TCP_CLOSED_VAL 90 /* Got a RST */
101#define PFTM_UDP_FIRST_PACKET_VAL 60 /* First UDP packet */
102#define PFTM_UDP_SINGLE_VAL 30 /* Unidirectional */
103#define PFTM_UDP_MULTIPLE_VAL 60 /* Bidirectional */
104#define PFTM_ICMP_FIRST_PACKET_VAL 20 /* First ICMP packet */
105#define PFTM_ICMP_ERROR_REPLY_VAL 10 /* Got error response */
106#define PFTM_OTHER_FIRST_PACKET_VAL 60 /* First packet */
107#define PFTM_OTHER_SINGLE_VAL 30 /* Unidirectional */
108#define PFTM_OTHER_MULTIPLE_VAL 60 /* Bidirectional */
109#define PFTM_FRAG_VAL 60 /* Fragment expire */
110#define PFTM_INTERVAL_VAL 10 /* Expire interval */
111#define PFTM_SRC_NODE_VAL 0 /* Source tracking */
112#define PFTM_TS_DIFF_VAL 30 /* Allowed TS diff */
113
114/*
115 * For each connection (combination of proto,src,dst,af) the number
116 * of fragments is limited. Over the PFTM_FRAG interval the average
117 * rate must be less than PF_FRAG_STALE fragments per second.
118 * Otherwise older fragments are considered stale and are dropped.
119 */
120#define PF_FRAG_STALE 200
121
122/*
123 * Limit the length of the fragment queue traversal. Remember
124 * search entry points based on the fragment offset.
125 */
126#define PF_FRAG_ENTRY_POINTS 16
127
128/*
129 * The number of entries in the fragment queue must be limited
130 * to avoid DoS by linear searching. Instead of a global limit,
131 * use a limit per entry point. For large packets these sum up.
132 */
133#define PF_FRAG_ENTRY_LIMIT 64
134
135enum { PF_NOPFROUTE, PF_ROUTETO, PF_DUPTO, PF_REPLYTO };
136enum { PF_LIMIT_STATES, PF_LIMIT_SRC_NODES, PF_LIMIT_FRAGS,
137 PF_LIMIT_TABLES, PF_LIMIT_TABLE_ENTRIES, PF_LIMIT_PKTDELAY_PKTS,
138 PF_LIMIT_ANCHORS, PF_LIMIT_MAX };
139#define PF_POOL_IDMASK 0x0f
140enum { PF_POOL_NONE, PF_POOL_BITMASK, PF_POOL_RANDOM,
141 PF_POOL_SRCHASH, PF_POOL_ROUNDROBIN, PF_POOL_LEASTSTATES };
142enum { PF_ADDR_ADDRMASK, PF_ADDR_NOROUTE, PF_ADDR_DYNIFTL,
143 PF_ADDR_TABLE, PF_ADDR_RTLABEL, PF_ADDR_URPFFAILED,
144 PF_ADDR_RANGE, PF_ADDR_NONE };
145#define PF_POOL_TYPEMASK 0x0f
146#define PF_POOL_STICKYADDR 0x20
147#define PF_WSCALE_FLAG 0x80
148#define PF_WSCALE_MASK 0x0f
149
150#define PF_POOL_DYNTYPE(_o) \
151 ((((_o) & PF_POOL_TYPEMASK) == PF_POOL_ROUNDROBIN) || \
152 (((_o) & PF_POOL_TYPEMASK) == PF_POOL_LEASTSTATES) || \
153 (((_o) & PF_POOL_TYPEMASK) == PF_POOL_RANDOM) || \
154 (((_o) & PF_POOL_TYPEMASK) == PF_POOL_SRCHASH))
155
156#define PF_LOG 0x01
157#define PF_LOG_ALL 0x02
158#define PF_LOG_USER 0x04
159#define PF_LOG_FORCE 0x08
160#define PF_LOG_MATCHES 0x10
161
162struct pf_addr {
163 union {
164 struct in_addr v4;
165 struct in6_addr v6;
166 u_int8_t addr8[16];
167 u_int16_t addr16[8];
168 u_int32_t addr32[4];
169 } pfa; /* 128-bit address */
170#define v4 pfa.v4
171#define v6 pfa.v6
172#define addr8 pfa.addr8
173#define addr16 pfa.addr16
174#define addr32 pfa.addr32
175};
176
177#define PF_TABLE_NAME_SIZE 32
178
179#define PFI_AFLAG_NETWORK 0x01
180#define PFI_AFLAG_BROADCAST 0x02
181#define PFI_AFLAG_PEER 0x04
182#define PFI_AFLAG_MODEMASK 0x07
183#define PFI_AFLAG_NOALIAS 0x08
184
185struct pf_addr_wrap {
186 union {
187 struct {
188 struct pf_addr addr;
189 struct pf_addr mask;
190 } a;
191 char ifname[IFNAMSIZ];
192 char tblname[PF_TABLE_NAME_SIZE];
193 char rtlabelname[RTLABEL_LEN];
194 u_int32_t rtlabel;
195 } v;
196 union {
197 struct pfi_dynaddr *dyn;
198 struct pfr_ktable *tbl;
199 int dyncnt;
200 int tblcnt;
201 } p;
202 u_int8_t type; /* PF_ADDR_* */
203 u_int8_t iflags; /* PFI_AFLAG_* */
204};
205
206#ifdef _KERNEL
207struct pfi_dynaddr {
208 TAILQ_ENTRY(pfi_dynaddr) entry;
209 struct pf_addr pfid_addr4;
210 struct pf_addr pfid_mask4;
211 struct pf_addr pfid_addr6;
212 struct pf_addr pfid_mask6;
213 struct pfr_ktable *pfid_kt;
214 struct pfi_kif *pfid_kif;
215 void *pfid_hook_cookie;
216 int pfid_net; /* mask or 128 */
217 int pfid_acnt4; /* address count IPv4 */
218 int pfid_acnt6; /* address count IPv6 */
219 sa_family_t pfid_af; /* rule af */
220 u_int8_t pfid_iflags; /* PFI_AFLAG_* */
221};
222#endif /* _KERNEL */
223
224
225/*
226 * Logging macros
227 */
228
229#ifndef PF_DEBUGNAME
230#define PF_DEBUGNAME "pf: "
231#endif
232
233#ifdef _KERNEL
234#define DPFPRINTF(n, format, x...) \
235 do { \
236 if (pf_status.debug >= (n)) { \
237 log(n, PF_DEBUGNAME); \
238 addlog(format, ##x); \
239 addlog("\n"); \
240 } \
241 } while (0)
242#else
243#ifdef PFDEBUG
244#define DPFPRINTF(n, format, x...) \
245 do { \
246 fprintf(stderr, format, ##x); \
247 fprintf(stderr, "\n"); \
248 } while (0)
249#else
250#define DPFPRINTF(n, format, x...) ((void)0)
251#endif /* PFDEBUG */
252#endif /* _KERNEL */
253
254
255/*
256 * Address manipulation macros
257 */
258
259#define PF_AEQ(a, b, c) \
260 ((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \
261 (c == AF_INET6 && \
262 (a)->addr32[3] == (b)->addr32[3] && \
263 (a)->addr32[2] == (b)->addr32[2] && \
264 (a)->addr32[1] == (b)->addr32[1] && \
265 (a)->addr32[0] == (b)->addr32[0])) \
266
267#define PF_ANEQ(a, b, c) \
268 ((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \
269 (c == AF_INET6 && \
270 ((a)->addr32[3] != (b)->addr32[3] || \
271 (a)->addr32[2] != (b)->addr32[2] || \
272 (a)->addr32[1] != (b)->addr32[1] || \
273 (a)->addr32[0] != (b)->addr32[0]))) \
274
275#define PF_AZERO(a, c) \
276 ((c == AF_INET && !(a)->addr32[0]) || \
277 (c == AF_INET6 && \
278 !(a)->addr32[0] && !(a)->addr32[1] && \
279 !(a)->addr32[2] && !(a)->addr32[3] )) \
280
281#define PF_MISMATCHAW(aw, x, af, neg, ifp, rtid) \
282 ( \
283 (((aw)->type == PF_ADDR_NOROUTE && \
284 pf_routable((x), (af), NULL, (rtid))) || \
285 (((aw)->type == PF_ADDR_URPFFAILED && (ifp) != NULL && \
286 pf_routable((x), (af), (ifp), (rtid))) || \
287 ((aw)->type == PF_ADDR_RTLABEL && \
288 !pf_rtlabel_match((x), (af), (aw), (rtid))) || \
289 ((aw)->type == PF_ADDR_TABLE && \
290 !pfr_match_addr((aw)->p.tbl, (x), (af))) || \
291 ((aw)->type == PF_ADDR_DYNIFTL && \
292 !pfi_match_addr((aw)->p.dyn, (x), (af))) || \
293 ((aw)->type == PF_ADDR_RANGE && \
294 !pf_match_addr_range(&(aw)->v.a.addr, \
295 &(aw)->v.a.mask, (x), (af))) || \
296 ((aw)->type == PF_ADDR_ADDRMASK && \
297 !PF_AZERO(&(aw)->v.a.mask, (af)) && \
298 !pf_match_addr(0, &(aw)->v.a.addr, \
299 &(aw)->v.a.mask, (x), (af))))) != \
300 (neg) \
301 )
302
303struct pf_rule_uid {
304 uid_t uid[2];
305 u_int8_t op;
306};
307
308struct pf_rule_gid {
309 uid_t gid[2];
310 u_int8_t op;
311};
312
313struct pf_rule_addr {
314 struct pf_addr_wrap addr;
315 u_int16_t port[2];
316 u_int8_t neg;
317 u_int8_t port_op;
318 u_int16_t weight;
319};
320
321struct pf_threshold {
322 u_int32_t limit;
323#define PF_THRESHOLD_MULT 1000
324#define PF_THRESHOLD_MAX 0xffffffff / PF_THRESHOLD_MULT
325 u_int32_t seconds;
326 u_int32_t count;
327 u_int32_t last;
328};
329
330struct pf_poolhashkey {
331 union {
332 u_int8_t key8[16];
333 u_int16_t key16[8];
334 u_int32_t key32[4];
335 } pfk; /* 128-bit hash key */
336#define key8 pfk.key8
337#define key16 pfk.key16
338#define key32 pfk.key32
339};
340
341struct pf_pool {
342 struct pf_addr_wrap addr;
343 struct pf_poolhashkey key;
344 struct pf_addr counter;
345 char ifname[IFNAMSIZ];
346 struct pfi_kif *kif;
347 int tblidx;
348 u_int64_t states;
349 int curweight;
350 u_int16_t weight;
351 u_int16_t proxy_port[2];
352 u_int8_t port_op;
353 u_int8_t opts;
354};
355
356/* A packed Operating System description for fingerprinting */
357typedef u_int32_t pf_osfp_t;
358#define PF_OSFP_ANY ((pf_osfp_t)0)
359#define PF_OSFP_UNKNOWN ((pf_osfp_t)-1)
360#define PF_OSFP_NOMATCH ((pf_osfp_t)-2)
361
362struct pf_osfp_entry {
363 SLIST_ENTRY(pf_osfp_entry) fp_entry;
364 pf_osfp_t fp_os;
365 int fp_enflags;
366#define PF_OSFP_EXPANDED 0x001 /* expanded entry */
367#define PF_OSFP_GENERIC 0x002 /* generic signature */
368#define PF_OSFP_NODETAIL 0x004 /* no p0f details */
369#define PF_OSFP_LEN 32
370 u_char fp_class_nm[PF_OSFP_LEN];
371 u_char fp_version_nm[PF_OSFP_LEN];
372 u_char fp_subtype_nm[PF_OSFP_LEN];
373};
374#define PF_OSFP_ENTRY_EQ(a, b) \
375 ((a)->fp_os == (b)->fp_os && \
376 memcmp((a)->fp_class_nm, (b)->fp_class_nm, PF_OSFP_LEN) == 0 && \
377 memcmp((a)->fp_version_nm, (b)->fp_version_nm, PF_OSFP_LEN) == 0 && \
378 memcmp((a)->fp_subtype_nm, (b)->fp_subtype_nm, PF_OSFP_LEN) == 0)
379
380/* handle pf_osfp_t packing */
381#define _FP_RESERVED_BIT 1 /* For the special negative #defines */
382#define _FP_UNUSED_BITS 1
383#define _FP_CLASS_BITS 10 /* OS Class (Windows, Linux) */
384#define _FP_VERSION_BITS 10 /* OS version (95, 98, NT, 2.4.54, 3.2) */
385#define _FP_SUBTYPE_BITS 10 /* patch level (NT SP4, SP3, ECN patch) */
386#define PF_OSFP_UNPACK(osfp, class, version, subtype) do { \
387 (class) = ((osfp) >> (_FP_VERSION_BITS+_FP_SUBTYPE_BITS)) & \
388 ((1 << _FP_CLASS_BITS) - 1); \
389 (version) = ((osfp) >> _FP_SUBTYPE_BITS) & \
390 ((1 << _FP_VERSION_BITS) - 1);\
391 (subtype) = (osfp) & ((1 << _FP_SUBTYPE_BITS) - 1); \
392} while(0)
393#define PF_OSFP_PACK(osfp, class, version, subtype) do { \
394 (osfp) = ((class) & ((1 << _FP_CLASS_BITS) - 1)) << (_FP_VERSION_BITS \
395 + _FP_SUBTYPE_BITS); \
396 (osfp) |= ((version) & ((1 << _FP_VERSION_BITS) - 1)) << \
397 _FP_SUBTYPE_BITS; \
398 (osfp) |= (subtype) & ((1 << _FP_SUBTYPE_BITS) - 1); \
399} while(0)
400
401/* the fingerprint of an OSes TCP SYN packet */
402typedef u_int64_t pf_tcpopts_t;
403struct pf_os_fingerprint {
404 SLIST_HEAD(pf_osfp_enlist, pf_osfp_entry) fp_oses; /* list of matches */
405 pf_tcpopts_t fp_tcpopts; /* packed TCP options */
406 u_int16_t fp_wsize; /* TCP window size */
407 u_int16_t fp_psize; /* ip->ip_len */
408 u_int16_t fp_mss; /* TCP MSS */
409 u_int16_t fp_flags;
410#define PF_OSFP_WSIZE_MOD 0x0001 /* Window modulus */
411#define PF_OSFP_WSIZE_DC 0x0002 /* Window don't care */
412#define PF_OSFP_WSIZE_MSS 0x0004 /* Window multiple of MSS */
413#define PF_OSFP_WSIZE_MTU 0x0008 /* Window multiple of MTU */
414#define PF_OSFP_PSIZE_MOD 0x0010 /* packet size modulus */
415#define PF_OSFP_PSIZE_DC 0x0020 /* packet size don't care */
416#define PF_OSFP_WSCALE 0x0040 /* TCP window scaling */
417#define PF_OSFP_WSCALE_MOD 0x0080 /* TCP window scale modulus */
418#define PF_OSFP_WSCALE_DC 0x0100 /* TCP window scale dont-care */
419#define PF_OSFP_MSS 0x0200 /* TCP MSS */
420#define PF_OSFP_MSS_MOD 0x0400 /* TCP MSS modulus */
421#define PF_OSFP_MSS_DC 0x0800 /* TCP MSS dont-care */
422#define PF_OSFP_DF 0x1000 /* IPv4 don't fragment bit */
423#define PF_OSFP_TS0 0x2000 /* Zero timestamp */
424#define PF_OSFP_INET6 0x4000 /* IPv6 */
425 u_int8_t fp_optcnt; /* TCP option count */
426 u_int8_t fp_wscale; /* TCP window scaling */
427 u_int8_t fp_ttl; /* IPv4 TTL */
428#define PF_OSFP_MAXTTL_OFFSET 40
429/* TCP options packing */
430#define PF_OSFP_TCPOPT_NOP 0x0 /* TCP NOP option */
431#define PF_OSFP_TCPOPT_WSCALE 0x1 /* TCP window scaling option */
432#define PF_OSFP_TCPOPT_MSS 0x2 /* TCP max segment size opt */
433#define PF_OSFP_TCPOPT_SACK 0x3 /* TCP SACK OK option */
434#define PF_OSFP_TCPOPT_TS 0x4 /* TCP timestamp option */
435#define PF_OSFP_TCPOPT_BITS 3 /* bits used by each option */
436#define PF_OSFP_MAX_OPTS \
437 (sizeof(((struct pf_os_fingerprint *)0)->fp_tcpopts) * 8) \
438 / PF_OSFP_TCPOPT_BITS
439
440 SLIST_ENTRY(pf_os_fingerprint) fp_next;
441};
442
443struct pf_osfp_ioctl {
444 struct pf_osfp_entry fp_os;
445 pf_tcpopts_t fp_tcpopts; /* packed TCP options */
446 u_int16_t fp_wsize; /* TCP window size */
447 u_int16_t fp_psize; /* ip->ip_len */
448 u_int16_t fp_mss; /* TCP MSS */
449 u_int16_t fp_flags;
450 u_int8_t fp_optcnt; /* TCP option count */
451 u_int8_t fp_wscale; /* TCP window scaling */
452 u_int8_t fp_ttl; /* IPv4 TTL */
453
454 int fp_getnum; /* DIOCOSFPGET number */
455};
456
457struct pf_rule_actions {
458 int rtableid;
459 u_int16_t qid;
460 u_int16_t pqid;
461 u_int16_t max_mss;
462 u_int16_t flags;
463 u_int16_t delay;
464 u_int8_t log;
465 u_int8_t set_tos;
466 u_int8_t min_ttl;
467 u_int8_t set_prio[2];
468 u_int8_t pad[1];
469};
470
471union pf_rule_ptr {
472 struct pf_rule *ptr;
473 u_int32_t nr;
474};
475
476#define PF_ANCHOR_STACK_MAX 64
477#define PF_ANCHOR_NAME_SIZE 64
478#define PF_ANCHOR_MAXPATH (PATH_MAX - PF_ANCHOR_NAME_SIZE - 1)
479#define PF_ANCHOR_HIWAT 512
480#define PF_OPTIMIZER_TABLE_PFX "__automatic_"
481
482enum {
483 PF_LIMITER_NOMATCH,
484 PF_LIMITER_BLOCK
485};
486
487#define PF_LIMITER_DEFAULT PF_LIMITER_BLOCK
488
489struct pf_rule {
490 struct pf_rule_addr src;
491 struct pf_rule_addr dst;
492#define PF_SKIP_IFP 0
493#define PF_SKIP_DIR 1
494#define PF_SKIP_RDOM 2
495#define PF_SKIP_AF 3
496#define PF_SKIP_PROTO 4
497#define PF_SKIP_SRC_ADDR 5
498#define PF_SKIP_DST_ADDR 6
499#define PF_SKIP_SRC_PORT 7
500#define PF_SKIP_DST_PORT 8
501#define PF_SKIP_COUNT 9
502 union pf_rule_ptr skip[PF_SKIP_COUNT];
503#define PF_RULE_LABEL_SIZE 64
504 char label[PF_RULE_LABEL_SIZE];
505#define PF_QNAME_SIZE 64
506 char ifname[IFNAMSIZ];
507 char rcv_ifname[IFNAMSIZ];
508 char qname[PF_QNAME_SIZE];
509 char pqname[PF_QNAME_SIZE];
510#define PF_TAG_NAME_SIZE 64
511 char tagname[PF_TAG_NAME_SIZE];
512 char match_tagname[PF_TAG_NAME_SIZE];
513
514 char overload_tblname[PF_TABLE_NAME_SIZE];
515
516 TAILQ_ENTRY(pf_rule) entries;
517 struct pf_pool nat;
518 struct pf_pool rdr;
519 struct pf_pool route;
520 struct pf_threshold pktrate;
521
522 u_int64_t evaluations;
523 u_int64_t packets[2];
524 u_int64_t bytes[2];
525
526 struct pfi_kif *kif;
527 struct pfi_kif *rcv_kif;
528 struct pf_anchor *anchor;
529 struct pfr_ktable *overload_tbl;
530
531 pf_osfp_t os_fingerprint;
532
533 int rtableid;
534 int onrdomain;
535 u_int32_t timeout[PFTM_MAX];
536 u_int32_t states_cur;
537 u_int32_t states_tot;
538 u_int32_t max_states;
539 u_int32_t src_nodes;
540 u_int32_t max_src_nodes;
541 u_int32_t max_src_states;
542 u_int32_t max_src_conn;
543 struct {
544 u_int32_t limit;
545 u_int32_t seconds;
546 } max_src_conn_rate;
547 u_int32_t qid;
548 u_int32_t pqid;
549 u_int32_t rt_listid;
550 u_int32_t nr;
551 u_int32_t prob;
552 uid_t cuid;
553 pid_t cpid;
554
555 u_int16_t return_icmp;
556 u_int16_t return_icmp6;
557 u_int16_t max_mss;
558 u_int16_t tag;
559 u_int16_t match_tag;
560 u_int16_t scrub_flags;
561 u_int16_t delay;
562
563 struct pf_rule_uid uid;
564 struct pf_rule_gid gid;
565
566 u_int32_t rule_flag;
567 u_int8_t action;
568 u_int8_t direction;
569 u_int8_t log;
570 u_int8_t logif;
571 u_int8_t quick;
572 u_int8_t ifnot;
573 u_int8_t match_tag_not;
574
575#define PF_STATE_NORMAL 0x1
576#define PF_STATE_MODULATE 0x2
577#define PF_STATE_SYNPROXY 0x3
578 u_int8_t keep_state;
579 sa_family_t af;
580 u_int8_t proto;
581 u_int16_t type; /* aux. value 256 is legit */
582 u_int16_t code; /* aux. value 256 is legit */
583 u_int8_t flags;
584 u_int8_t flagset;
585 u_int8_t min_ttl;
586 u_int8_t allow_opts;
587 u_int8_t rt;
588 u_int8_t return_ttl;
589 u_int8_t tos;
590 u_int8_t set_tos;
591 u_int8_t anchor_relative;
592 u_int8_t anchor_wildcard;
593
594#define PF_FLUSH 0x01
595#define PF_FLUSH_GLOBAL 0x02
596 u_int8_t flush;
597 u_int8_t prio;
598 u_int8_t set_prio[2];
599 sa_family_t naf;
600 u_int8_t rcvifnot;
601 struct {
602 u_int8_t id;
603 int limiter_action;
604 } statelim;
605 struct {
606 u_int8_t id;
607 int limiter_action;
608 } sourcelim;
609
610 struct {
611 struct pf_addr addr;
612 u_int16_t port;
613 u_int8_t type;
614 } divert;
615
616 time_t exptime;
617};
618
619/* rule flags */
620#define PFRULE_DROP 0x0000
621#define PFRULE_RETURNRST 0x0001
622#define PFRULE_FRAGMENT 0x0002
623#define PFRULE_RETURNICMP 0x0004
624#define PFRULE_RETURN 0x0008
625#define PFRULE_NOSYNC 0x0010
626#define PFRULE_SRCTRACK 0x0020 /* track source states */
627#define PFRULE_RULESRCTRACK 0x0040 /* per rule */
628#define PFRULE_SETDELAY 0x0080
629
630/* rule flags again */
631#define PFRULE_IFBOUND 0x00010000 /* if-bound */
632#define PFRULE_STATESLOPPY 0x00020000 /* sloppy state tracking */
633#define PFRULE_PFLOW 0x00040000
634#define PFRULE_ONCE 0x00100000 /* one shot rule */
635#define PFRULE_AFTO 0x00200000 /* af-to rule */
636#define PFRULE_EXPIRED 0x00400000 /* one shot rule hit by pkt */
637
638#define PFSTATE_HIWAT 100000 /* default state table size */
639#define PFSTATE_ADAPT_START 60000 /* default adaptive timeout start */
640#define PFSTATE_ADAPT_END 120000 /* default adaptive timeout end */
641#define PF_PKTDELAY_MAXPKTS 10000 /* max # of pkts held in delay queue */
642
643struct pf_rule_item {
644 SLIST_ENTRY(pf_rule_item) entry;
645 struct pf_rule *r;
646};
647
648SLIST_HEAD(pf_rule_slist, pf_rule_item);
649
650enum pf_sn_types { PF_SN_NONE, PF_SN_NAT, PF_SN_RDR, PF_SN_ROUTE, PF_SN_MAX };
651
652struct pf_src_node {
653 RB_ENTRY(pf_src_node) entry;
654 struct pf_addr addr;
655 struct pf_addr raddr;
656 union pf_rule_ptr rule;
657 struct pfi_kif *kif;
658 u_int64_t bytes[2];
659 u_int64_t packets[2];
660 u_int32_t states;
661 u_int32_t conn;
662 struct pf_threshold conn_rate;
663 int32_t creation;
664 int32_t expire;
665 sa_family_t af;
666 sa_family_t naf;
667 u_int8_t type;
668};
669
670struct pf_sn_item {
671 SLIST_ENTRY(pf_sn_item) next;
672 struct pf_src_node *sn;
673};
674
675SLIST_HEAD(pf_sn_head, pf_sn_item);
676
677#define PFSNODE_HIWAT 10000 /* default source node table size */
678
679struct pf_state_scrub {
680 struct timeval pfss_last; /* time received last packet */
681 u_int32_t pfss_tsecr; /* last echoed timestamp */
682 u_int32_t pfss_tsval; /* largest timestamp */
683 u_int32_t pfss_tsval0; /* original timestamp */
684 u_int16_t pfss_flags;
685#define PFSS_TIMESTAMP 0x0001 /* modulate timestamp */
686#define PFSS_PAWS 0x0010 /* stricter PAWS checks */
687#define PFSS_PAWS_IDLED 0x0020 /* was idle too long. no PAWS */
688#define PFSS_DATA_TS 0x0040 /* timestamp on data packets */
689#define PFSS_DATA_NOTS 0x0080 /* no timestamp on data packets */
690 u_int8_t pfss_ttl; /* stashed TTL */
691 u_int8_t pad;
692 u_int32_t pfss_ts_mod; /* timestamp modulation */
693};
694
695struct pf_state_host {
696 struct pf_addr addr;
697 u_int16_t port;
698 u_int16_t pad;
699};
700
701struct pf_state_peer {
702 struct pf_state_scrub *scrub; /* state is scrubbed */
703 u_int32_t seqlo; /* Max sequence number sent */
704 u_int32_t seqhi; /* Max the other end ACKd + win */
705 u_int32_t seqdiff; /* Sequence number modulator */
706 u_int16_t max_win; /* largest window (pre scaling) */
707 u_int16_t mss; /* Maximum segment size option */
708 u_int8_t state; /* active state level */
709 u_int8_t wscale; /* window scaling factor */
710 u_int8_t tcp_est; /* Did we reach TCPS_ESTABLISHED */
711 u_int8_t pad[1];
712};
713
714TAILQ_HEAD(pf_state_queue, pf_state);
715
716/* keep synced with struct pf_state_key, used in RB_FIND */
717struct pf_state_key_cmp {
718 struct pf_addr addr[2];
719 u_int16_t port[2];
720 u_int16_t rdomain;
721 u_int16_t hash;
722 sa_family_t af;
723 u_int8_t proto;
724};
725
726/* keep synced with struct pf_state, used in RB_FIND */
727struct pf_state_cmp {
728 u_int64_t id;
729 u_int32_t creatorid;
730 u_int8_t direction;
731 u_int8_t pad[3];
732};
733
734/* struct pf_state.state_flags */
735#define PFSTATE_ALLOWOPTS 0x0001
736#define PFSTATE_SLOPPY 0x0002
737#define PFSTATE_PFLOW 0x0004
738#define PFSTATE_NOSYNC 0x0008
739#define PFSTATE_ACK 0x0010
740#define PFSTATE_NODF 0x0020
741#define PFSTATE_SETTOS 0x0040
742#define PFSTATE_RANDOMID 0x0080
743#define PFSTATE_SCRUB_TCP 0x0100
744#define PFSTATE_SETPRIO 0x0200
745#define PFSTATE_INP_UNLINKED 0x0400
746#define PFSTATE_SCRUBMASK (PFSTATE_NODF|PFSTATE_RANDOMID|PFSTATE_SCRUB_TCP)
747#define PFSTATE_SETMASK (PFSTATE_SETTOS|PFSTATE_SETPRIO)
748
749/*
750 * Unified state structures for pulling states out of the kernel
751 * used by pfsync(4) and the pf(4) ioctl.
752 */
753struct pfsync_state_scrub {
754 u_int16_t pfss_flags;
755 u_int8_t pfss_ttl; /* stashed TTL */
756#define PFSYNC_SCRUB_FLAG_VALID 0x01
757 u_int8_t scrub_flag;
758 u_int32_t pfss_ts_mod; /* timestamp modulation */
759} __packed;
760
761struct pfsync_state_peer {
762 struct pfsync_state_scrub scrub; /* state is scrubbed */
763 u_int32_t seqlo; /* Max sequence number sent */
764 u_int32_t seqhi; /* Max the other end ACKd + win */
765 u_int32_t seqdiff; /* Sequence number modulator */
766 u_int16_t max_win; /* largest window (pre scaling) */
767 u_int16_t mss; /* Maximum segment size option */
768 u_int8_t state; /* active state level */
769 u_int8_t wscale; /* window scaling factor */
770 u_int8_t pad[6];
771} __packed;
772
773struct pfsync_state_key {
774 struct pf_addr addr[2];
775 u_int16_t port[2];
776 u_int16_t rdomain;
777 sa_family_t af;
778 u_int8_t pad;
779};
780
781struct pfsync_state {
782 u_int64_t id;
783 char ifname[IFNAMSIZ];
784 struct pfsync_state_key key[2];
785 struct pfsync_state_peer src;
786 struct pfsync_state_peer dst;
787 struct pf_addr rt_addr;
788 u_int32_t rule;
789 u_int32_t anchor;
790 u_int32_t nat_rule;
791 u_int32_t creation;
792 u_int32_t expire;
793 u_int32_t packets[2][2];
794 u_int32_t bytes[2][2];
795 u_int32_t creatorid;
796 int32_t rtableid[2];
797 u_int16_t max_mss;
798 sa_family_t af;
799 u_int8_t proto;
800 u_int8_t direction;
801 u_int8_t log;
802 u_int8_t rt;
803 u_int8_t timeout;
804 u_int8_t sync_flags;
805 u_int8_t updates;
806 u_int8_t min_ttl;
807 u_int8_t set_tos;
808 u_int16_t state_flags;
809 u_int8_t set_prio[2];
810} __packed;
811
812#define PFSYNC_FLAG_SRCNODE 0x04
813#define PFSYNC_FLAG_NATSRCNODE 0x08
814
815#define pf_state_counter_hton(s,d) do { \
816 d[0] = htonl((s>>32)&0xffffffff); \
817 d[1] = htonl(s&0xffffffff); \
818} while (0)
819
820#define pf_state_counter_from_pfsync(s) \
821 (((u_int64_t)(s[0])<<32) | (u_int64_t)(s[1]))
822
823#define pf_state_counter_ntoh(s,d) do { \
824 d = ntohl(s[0]); \
825 d = d<<32; \
826 d += ntohl(s[1]); \
827} while (0)
828
829TAILQ_HEAD(pf_rulequeue, pf_rule);
830
831struct pf_anchor;
832
833struct pf_ruleset {
834 struct {
835 struct pf_rulequeue queues[2];
836 struct {
837 struct pf_rulequeue *ptr;
838 u_int32_t rcount;
839 u_int32_t version;
840 int open;
841 } active, inactive;
842 } rules;
843 struct pf_anchor *anchor;
844 u_int32_t tticket;
845 int tables;
846 int topen;
847};
848
849RB_HEAD(pf_anchor_global, pf_anchor);
850RB_HEAD(pf_anchor_node, pf_anchor);
851struct pf_anchor {
852 RB_ENTRY(pf_anchor) entry_global;
853 RB_ENTRY(pf_anchor) entry_node;
854 struct pf_anchor *parent;
855 struct pf_anchor_node children;
856 char name[PF_ANCHOR_NAME_SIZE];
857 char path[PATH_MAX];
858 struct pf_ruleset ruleset;
859 int refcnt; /* anchor rules */
860 int match;
861 struct refcnt ref; /* for transactions */
862};
863RB_PROTOTYPE(pf_anchor_global, pf_anchor, entry_global, pf_anchor_compare)
864RB_PROTOTYPE(pf_anchor_node, pf_anchor, entry_node, pf_anchor_compare)
865
866#define PF_RESERVED_ANCHOR "_pf"
867
868#define PFR_TFLAG_PERSIST 0x00000001
869#define PFR_TFLAG_CONST 0x00000002
870#define PFR_TFLAG_ACTIVE 0x00000004
871#define PFR_TFLAG_INACTIVE 0x00000008
872#define PFR_TFLAG_REFERENCED 0x00000010
873#define PFR_TFLAG_REFDANCHOR 0x00000020
874#define PFR_TFLAG_COUNTERS 0x00000040
875/* Adjust masks below when adding flags. */
876#define PFR_TFLAG_USRMASK 0x00000043
877#define PFR_TFLAG_SETMASK 0x0000003C
878#define PFR_TFLAG_ALLMASK 0x0000007F
879
880struct pfr_table {
881 char pfrt_anchor[PATH_MAX];
882 char pfrt_name[PF_TABLE_NAME_SIZE];
883 u_int32_t pfrt_flags;
884 u_int8_t pfrt_fback;
885};
886
887enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
888 PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
889 PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_NOCOUNT, PFR_FB_MAX };
890
891struct pfr_addr {
892 union {
893 struct in_addr _pfra_ip4addr;
894 struct in6_addr _pfra_ip6addr;
895 } pfra_u;
896 char pfra_ifname[IFNAMSIZ];
897 u_int32_t pfra_states;
898 u_int16_t pfra_weight;
899 u_int8_t pfra_af;
900 u_int8_t pfra_net;
901 u_int8_t pfra_not;
902 u_int8_t pfra_fback;
903 u_int8_t pfra_type;
904 u_int8_t pad[7];
905};
906#define pfra_ip4addr pfra_u._pfra_ip4addr
907#define pfra_ip6addr pfra_u._pfra_ip6addr
908
909enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
910enum { PFR_OP_BLOCK, PFR_OP_MATCH, PFR_OP_PASS, PFR_OP_ADDR_MAX,
911 PFR_OP_TABLE_MAX };
912#define PFR_OP_XPASS PFR_OP_ADDR_MAX
913
914struct pfr_astats {
915 struct pfr_addr pfras_a;
916 u_int64_t pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
917 u_int64_t pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
918 time_t pfras_tzero;
919};
920
921enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
922
923struct pfr_tstats {
924 struct pfr_table pfrts_t;
925 u_int64_t pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
926 u_int64_t pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
927 u_int64_t pfrts_match;
928 u_int64_t pfrts_nomatch;
929 time_t pfrts_tzero;
930 int pfrts_cnt;
931 int pfrts_refcnt[PFR_REFCNT_MAX];
932};
933#define pfrts_name pfrts_t.pfrt_name
934#define pfrts_flags pfrts_t.pfrt_flags
935
936struct pfr_kcounters {
937 u_int64_t pfrkc_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
938 u_int64_t pfrkc_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
939 u_int64_t states;
940};
941
942/*
943 * XXX ip_ipsp.h's sockaddr_union should be converted to sockaddr *
944 * passing with correct sa_len, then a good approach for cleaning this
945 * will become more clear.
946 */
947union pfsockaddr_union {
948 struct sockaddr sa;
949 struct sockaddr_in sin;
950 struct sockaddr_in6 sin6;
951};
952
953SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
954struct _pfr_kentry {
955 struct radix_node _pfrke_node[2];
956 union pfsockaddr_union _pfrke_sa;
957 SLIST_ENTRY(pfr_kentry) _pfrke_workq;
958 SLIST_ENTRY(pfr_kentry) _pfrke_ioq;
959 struct pfr_kcounters *_pfrke_counters;
960 time_t _pfrke_tzero;
961 u_int8_t _pfrke_af;
962 u_int8_t _pfrke_net;
963 u_int8_t _pfrke_flags;
964 u_int8_t _pfrke_type;
965 u_int8_t _pfrke_fb;
966};
967#define PFRKE_FLAG_NOT 0x01
968#define PFRKE_FLAG_MARK 0x02
969
970/* pfrke_type */
971enum { PFRKE_PLAIN, PFRKE_ROUTE, PFRKE_COST, PFRKE_MAX };
972
973struct pfr_kentry {
974 union {
975 struct _pfr_kentry _ke;
976 } u;
977};
978#define pfrke_node u._ke._pfrke_node
979#define pfrke_sa u._ke._pfrke_sa
980#define pfrke_workq u._ke._pfrke_workq
981#define pfrke_ioq u._ke._pfrke_ioq
982#define pfrke_counters u._ke._pfrke_counters
983#define pfrke_tzero u._ke._pfrke_tzero
984#define pfrke_af u._ke._pfrke_af
985#define pfrke_net u._ke._pfrke_net
986#define pfrke_flags u._ke._pfrke_flags
987#define pfrke_type u._ke._pfrke_type
988#define pfrke_fb u._ke._pfrke_fb
989
990struct pfr_kentry_route {
991 union {
992 struct _pfr_kentry _ke;
993 } u;
994
995 struct pfi_kif *kif;
996 char ifname[IFNAMSIZ];
997};
998
999struct pfr_kentry_cost {
1000 union {
1001 struct _pfr_kentry _ke;
1002 } u;
1003
1004 struct pfi_kif *kif;
1005 char ifname[IFNAMSIZ];
1006 /* Above overlaps with pfr_kentry route */
1007
1008 u_int16_t weight;
1009};
1010
1011struct pfr_kentry_all {
1012 union {
1013 struct _pfr_kentry _ke;
1014 struct pfr_kentry_route kr;
1015 struct pfr_kentry_cost kc;
1016 } u;
1017};
1018#define pfrke_rkif u.kr.kif
1019#define pfrke_rifname u.kr.ifname
1020
1021SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
1022RB_HEAD(pfr_ktablehead, pfr_ktable);
1023struct pfr_ktable {
1024 struct pfr_tstats pfrkt_ts;
1025 RB_ENTRY(pfr_ktable) pfrkt_tree;
1026 SLIST_ENTRY(pfr_ktable) pfrkt_workq;
1027 struct radix_node_head *pfrkt_ip4;
1028 struct radix_node_head *pfrkt_ip6;
1029 struct pfr_ktable *pfrkt_shadow;
1030 struct pfr_ktable *pfrkt_root;
1031 struct pf_ruleset *pfrkt_rs;
1032 long pfrkt_larg;
1033 int pfrkt_nflags;
1034 u_int64_t pfrkt_refcntcost;
1035 u_int16_t pfrkt_gcdweight;
1036 u_int16_t pfrkt_maxweight;
1037};
1038#define pfrkt_t pfrkt_ts.pfrts_t
1039#define pfrkt_name pfrkt_t.pfrt_name
1040#define pfrkt_anchor pfrkt_t.pfrt_anchor
1041#define pfrkt_ruleset pfrkt_t.pfrt_ruleset
1042#define pfrkt_flags pfrkt_t.pfrt_flags
1043#define pfrkt_cnt pfrkt_ts.pfrts_cnt
1044#define pfrkt_refcnt pfrkt_ts.pfrts_refcnt
1045#define pfrkt_packets pfrkt_ts.pfrts_packets
1046#define pfrkt_bytes pfrkt_ts.pfrts_bytes
1047#define pfrkt_match pfrkt_ts.pfrts_match
1048#define pfrkt_nomatch pfrkt_ts.pfrts_nomatch
1049#define pfrkt_tzero pfrkt_ts.pfrts_tzero
1050
1051RB_HEAD(pfi_ifhead, pfi_kif);
1052
1053/* state tables */
1054extern struct pf_state_tree pf_statetbl;
1055
1056/* keep synced with pfi_kif, used in RB_FIND */
1057struct pfi_kif_cmp {
1058 char pfik_name[IFNAMSIZ];
1059};
1060
1061struct ifnet;
1062struct ifg_group;
1063
1064struct pfi_kif {
1065 char pfik_name[IFNAMSIZ];
1066 RB_ENTRY(pfi_kif) pfik_tree;
1067 u_int64_t pfik_packets[2][2][2];
1068 u_int64_t pfik_bytes[2][2][2];
1069 time_t pfik_tzero;
1070 int pfik_flags;
1071 int pfik_flags_new;
1072 void *pfik_ah_cookie;
1073 struct ifnet *pfik_ifp;
1074 struct ifg_group *pfik_group;
1075 int pfik_states;
1076 int pfik_rules;
1077 int pfik_routes;
1078 int pfik_srcnodes;
1079 int pfik_flagrefs;
1080 TAILQ_HEAD(, pfi_dynaddr) pfik_dynaddrs;
1081};
1082
1083enum pfi_kif_refs {
1084 PFI_KIF_REF_NONE,
1085 PFI_KIF_REF_STATE,
1086 PFI_KIF_REF_RULE,
1087 PFI_KIF_REF_ROUTE,
1088 PFI_KIF_REF_SRCNODE,
1089 PFI_KIF_REF_FLAG
1090};
1091
1092#define PFI_IFLAG_SKIP 0x0100 /* skip filtering on interface */
1093#define PFI_IFLAG_ANY 0x0200 /* match any non-loopback interface */
1094
1095/* flags for RDR options */
1096#define PF_DPORT_RANGE 0x01 /* Dest port uses range */
1097#define PF_RPORT_RANGE 0x02 /* RDR'ed port uses range */
1098
1099/* Reasons code for passing/dropping a packet */
1100#define PFRES_MATCH 0 /* Explicit match of a rule */
1101#define PFRES_BADOFF 1 /* Bad offset for pull_hdr */
1102#define PFRES_FRAG 2 /* Dropping following fragment */
1103#define PFRES_SHORT 3 /* Dropping short packet */
1104#define PFRES_NORM 4 /* Dropping by normalizer */
1105#define PFRES_MEMORY 5 /* Dropped due to lacking mem */
1106#define PFRES_TS 6 /* Bad TCP Timestamp (RFC1323) */
1107#define PFRES_CONGEST 7 /* Congestion */
1108#define PFRES_IPOPTIONS 8 /* IP option */
1109#define PFRES_PROTCKSUM 9 /* Protocol checksum invalid */
1110#define PFRES_BADSTATE 10 /* State mismatch */
1111#define PFRES_STATEINS 11 /* State insertion failure */
1112#define PFRES_MAXSTATES 12 /* State limit */
1113#define PFRES_SRCLIMIT 13 /* Source node/conn limit */
1114#define PFRES_SYNPROXY 14 /* SYN proxy */
1115#define PFRES_TRANSLATE 15 /* No translation address available */
1116#define PFRES_NOROUTE 16 /* No route found for PBR action */
1117#define PFRES_MAX 17 /* total+1 */
1118
1119#define PFRES_NAMES { \
1120 "match", \
1121 "bad-offset", \
1122 "fragment", \
1123 "short", \
1124 "normalize", \
1125 "memory", \
1126 "bad-timestamp", \
1127 "congestion", \
1128 "ip-option", \
1129 "proto-cksum", \
1130 "state-mismatch", \
1131 "state-insert", \
1132 "state-limit", \
1133 "src-limit", \
1134 "synproxy", \
1135 "translate", \
1136 "no-route", \
1137 NULL \
1138}
1139
1140/* Counters for other things we want to keep track of */
1141#define LCNT_STATES 0 /* states */
1142#define LCNT_SRCSTATES 1 /* max-src-states */
1143#define LCNT_SRCNODES 2 /* max-src-nodes */
1144#define LCNT_SRCCONN 3 /* max-src-conn */
1145#define LCNT_SRCCONNRATE 4 /* max-src-conn-rate */
1146#define LCNT_OVERLOAD_TABLE 5 /* entry added to overload table */
1147#define LCNT_OVERLOAD_FLUSH 6 /* state entries flushed */
1148#define LCNT_SYNFLOODS 7 /* synfloods detected */
1149#define LCNT_SYNCOOKIES_SENT 8 /* syncookies sent */
1150#define LCNT_SYNCOOKIES_VALID 9 /* syncookies validated */
1151#define LCNT_MAX 10 /* total+1 */
1152
1153#define LCNT_NAMES { \
1154 "max states per rule", \
1155 "max-src-states", \
1156 "max-src-nodes", \
1157 "max-src-conn", \
1158 "max-src-conn-rate", \
1159 "overload table insertion", \
1160 "overload flush states", \
1161 "synfloods detected", \
1162 "syncookies sent", \
1163 "syncookies validated", \
1164 NULL \
1165}
1166
1167/* UDP state enumeration */
1168#define PFUDPS_NO_TRAFFIC 0
1169#define PFUDPS_SINGLE 1
1170#define PFUDPS_MULTIPLE 2
1171
1172#define PFUDPS_NSTATES 3 /* number of state levels */
1173
1174#define PFUDPS_NAMES { \
1175 "NO_TRAFFIC", \
1176 "SINGLE", \
1177 "MULTIPLE", \
1178 NULL \
1179}
1180
1181/* Other protocol state enumeration */
1182#define PFOTHERS_NO_TRAFFIC 0
1183#define PFOTHERS_SINGLE 1
1184#define PFOTHERS_MULTIPLE 2
1185
1186#define PFOTHERS_NSTATES 3 /* number of state levels */
1187
1188#define PFOTHERS_NAMES { \
1189 "NO_TRAFFIC", \
1190 "SINGLE", \
1191 "MULTIPLE", \
1192 NULL \
1193}
1194
1195#define FCNT_STATE_SEARCH 0
1196#define FCNT_STATE_INSERT 1
1197#define FCNT_STATE_REMOVALS 2
1198#define FCNT_MAX 3
1199
1200#define SCNT_SRC_NODE_SEARCH 0
1201#define SCNT_SRC_NODE_INSERT 1
1202#define SCNT_SRC_NODE_REMOVALS 2
1203#define SCNT_MAX 3
1204
1205#define NCNT_FRAG_SEARCH 0
1206#define NCNT_FRAG_INSERT 1
1207#define NCNT_FRAG_REMOVALS 2
1208#define NCNT_MAX 3
1209
1210#define REASON_SET(a, x) \
1211 do { \
1212 if ((void *)(a) != NULL) { \
1213 *(a) = (x); \
1214 if (x < PFRES_MAX) \
1215 pf_status.counters[x]++; \
1216 } \
1217 } while (0)
1218
1219struct pf_status {
1220 u_int64_t counters[PFRES_MAX];
1221 u_int64_t lcounters[LCNT_MAX]; /* limit counters */
1222 u_int64_t fcounters[FCNT_MAX];
1223 u_int64_t scounters[SCNT_MAX];
1224 u_int64_t ncounters[NCNT_MAX];
1225 u_int64_t pcounters[2][2][3];
1226 u_int64_t bcounters[2][2];
1227 u_int64_t stateid;
1228 u_int64_t syncookies_inflight[2]; /* unACKed SYNcookies */
1229 time_t since;
1230 u_int32_t running;
1231 u_int32_t states;
1232 u_int32_t states_halfopen;
1233 u_int32_t src_nodes;
1234 u_int32_t fragments;
1235 u_int32_t debug;
1236 u_int32_t hostid;
1237 u_int32_t reass; /* reassembly */
1238 u_int8_t syncookies_active;
1239 u_int8_t syncookies_mode; /* never/always/adaptive */
1240 u_int8_t pad[2];
1241 char ifname[IFNAMSIZ];
1242 u_int8_t pf_chksum[PF_MD5_DIGEST_LENGTH];
1243};
1244
1245#define PF_REASS_ENABLED 0x01
1246#define PF_REASS_NODF 0x02
1247
1248#define PF_SYNCOOKIES_NEVER 0
1249#define PF_SYNCOOKIES_ALWAYS 1
1250#define PF_SYNCOOKIES_ADAPTIVE 2
1251#define PF_SYNCOOKIES_MODE_MAX PF_SYNCOOKIES_ADAPTIVE
1252
1253#define PF_SYNCOOKIES_HIWATPCT 25
1254#define PF_SYNCOOKIES_LOWATPCT PF_SYNCOOKIES_HIWATPCT/2
1255
1256#define PF_PRIO_ZERO 0xff /* match "prio 0" packets */
1257
1258struct pf_queue_bwspec {
1259 uint64_t absolute;
1260 u_int percent;
1261};
1262
1263struct pf_queue_scspec {
1264 struct pf_queue_bwspec m1;
1265 struct pf_queue_bwspec m2;
1266 u_int d;
1267};
1268
1269struct pf_queue_fqspec {
1270 u_int flows;
1271 u_int quantum;
1272 u_int target;
1273 u_int interval;
1274};
1275
1276struct pf_queuespec {
1277 TAILQ_ENTRY(pf_queuespec) entries;
1278 char qname[PF_QNAME_SIZE];
1279 char parent[PF_QNAME_SIZE];
1280 char ifname[IFNAMSIZ];
1281 struct pf_queue_scspec realtime;
1282 struct pf_queue_scspec linkshare;
1283 struct pf_queue_scspec upperlimit;
1284 struct pf_queue_fqspec flowqueue;
1285 struct pfi_kif *kif;
1286 u_int flags;
1287 u_int qlimit;
1288 u_int32_t qid;
1289 u_int32_t parent_qid;
1290};
1291
1292#define PFQS_FLOWQUEUE 0x0001
1293#define PFQS_ROOTCLASS 0x0002
1294#define PFQS_DEFAULT 0x1000 /* maps to HFSC_DEFAULTCLASS */
1295
1296struct priq_opts {
1297 int flags;
1298};
1299
1300struct hfsc_opts {
1301 /* real-time service curve */
1302 u_int rtsc_m1; /* slope of the 1st segment in bps */
1303 u_int rtsc_d; /* the x-projection of m1 in msec */
1304 u_int rtsc_m2; /* slope of the 2nd segment in bps */
1305 /* link-sharing service curve */
1306 u_int lssc_m1;
1307 u_int lssc_d;
1308 u_int lssc_m2;
1309 /* upper-limit service curve */
1310 u_int ulsc_m1;
1311 u_int ulsc_d;
1312 u_int ulsc_m2;
1313 int flags;
1314};
1315
1316struct pfq_ops {
1317 void * (*pfq_alloc)(struct ifnet *);
1318 int (*pfq_addqueue)(void *, struct pf_queuespec *);
1319 void (*pfq_free)(void *);
1320 int (*pfq_qstats)(struct pf_queuespec *, void *, int *);
1321 /* Queue manager ops */
1322 unsigned int (*pfq_qlength)(void *);
1323 struct mbuf * (*pfq_enqueue)(void *, struct mbuf *);
1324 struct mbuf * (*pfq_deq_begin)(void *, void **, struct mbuf_list *);
1325 void (*pfq_deq_commit)(void *, struct mbuf *, void *);
1326 void (*pfq_purge)(void *, struct mbuf_list *);
1327};
1328
1329struct pf_tagname {
1330 TAILQ_ENTRY(pf_tagname) entries;
1331 char name[PF_TAG_NAME_SIZE];
1332 u_int16_t tag;
1333 int ref;
1334};
1335
1336struct pf_divert {
1337 struct pf_addr addr;
1338 u_int16_t port;
1339 u_int16_t rdomain;
1340 u_int8_t type;
1341};
1342
1343enum pf_divert_types {
1344 PF_DIVERT_NONE,
1345 PF_DIVERT_TO,
1346 PF_DIVERT_REPLY,
1347 PF_DIVERT_PACKET
1348};
1349
1350struct pf_pktdelay {
1351 struct timeout to;
1352 struct mbuf *m;
1353 u_int ifidx;
1354};
1355
1356/* Fragment entries reference mbuf clusters, so base the default on that. */
1357#define PFFRAG_FRENT_HIWAT (NMBCLUSTERS / 16) /* Number of entries */
1358#define PFFRAG_FRAG_HIWAT (NMBCLUSTERS / 32) /* Number of packets */
1359
1360#define PFR_KTABLE_HIWAT 1000 /* Number of tables */
1361#define PFR_KENTRY_HIWAT 200000 /* Number of table entries */
1362#define PFR_KENTRY_HIWAT_SMALL 100000 /* Number of entries for tiny hosts */
1363
1364/*
1365 * ioctl parameter structures
1366 */
1367
1368struct pfioc_rule {
1369 u_int32_t action;
1370 u_int32_t ticket;
1371 u_int32_t nr;
1372 char anchor[PATH_MAX];
1373 char anchor_call[PATH_MAX];
1374 struct pf_rule rule;
1375};
1376
1377struct pfioc_natlook {
1378 struct pf_addr saddr;
1379 struct pf_addr daddr;
1380 struct pf_addr rsaddr;
1381 struct pf_addr rdaddr;
1382 u_int16_t rdomain;
1383 u_int16_t rrdomain;
1384 u_int16_t sport;
1385 u_int16_t dport;
1386 u_int16_t rsport;
1387 u_int16_t rdport;
1388 sa_family_t af;
1389 u_int8_t proto;
1390 u_int8_t direction;
1391};
1392
1393struct pfioc_state {
1394 struct pfsync_state state;
1395};
1396
1397struct pfioc_src_node_kill {
1398 sa_family_t psnk_af;
1399 struct pf_rule_addr psnk_src;
1400 struct pf_rule_addr psnk_dst;
1401 u_int psnk_killed;
1402};
1403
1404struct pfioc_state_kill {
1405 struct pf_state_cmp psk_pfcmp;
1406 sa_family_t psk_af;
1407 int psk_proto;
1408 struct pf_rule_addr psk_src;
1409 struct pf_rule_addr psk_dst;
1410 char psk_ifname[IFNAMSIZ];
1411 char psk_label[PF_RULE_LABEL_SIZE];
1412 u_int psk_killed;
1413 u_int16_t psk_rdomain;
1414};
1415
1416struct pfioc_states {
1417 size_t ps_len;
1418 union {
1419 caddr_t psu_buf;
1420 struct pfsync_state *psu_states;
1421 } ps_u;
1422#define ps_buf ps_u.psu_buf
1423#define ps_states ps_u.psu_states
1424};
1425
1426struct pfioc_src_nodes {
1427 size_t psn_len;
1428 union {
1429 caddr_t psu_buf;
1430 struct pf_src_node *psu_src_nodes;
1431 } psn_u;
1432#define psn_buf psn_u.psu_buf
1433#define psn_src_nodes psn_u.psu_src_nodes
1434};
1435
1436struct pfioc_tm {
1437 int timeout;
1438 int seconds;
1439};
1440
1441struct pfioc_limit {
1442 int index;
1443 unsigned limit;
1444};
1445
1446struct pfioc_ruleset {
1447 u_int32_t nr;
1448 char path[PATH_MAX];
1449 char name[PF_ANCHOR_NAME_SIZE];
1450};
1451
1452struct pfioc_trans {
1453 int size; /* number of elements */
1454 int esize; /* size of each element in bytes */
1455 struct pfioc_trans_e {
1456 int type;
1457 char anchor[PATH_MAX];
1458 u_int32_t ticket;
1459 } *array;
1460};
1461
1462struct pfioc_queue {
1463 u_int32_t ticket;
1464 u_int nr;
1465 struct pf_queuespec queue;
1466};
1467
1468struct pfioc_qstats {
1469 u_int32_t ticket;
1470 u_int32_t nr;
1471 struct pf_queuespec queue;
1472 void *buf;
1473 int nbytes;
1474};
1475
1476#define PFR_FLAG_DUMMY 0x00000002
1477#define PFR_FLAG_FEEDBACK 0x00000004
1478#define PFR_FLAG_CLSTATS 0x00000008
1479#define PFR_FLAG_ADDRSTOO 0x00000010
1480#define PFR_FLAG_REPLACE 0x00000020
1481#define PFR_FLAG_ALLRSETS 0x00000040
1482#define PFR_FLAG_ALLMASK 0x0000007F
1483#ifdef _KERNEL
1484#define PFR_FLAG_USERIOCTL 0x10000000
1485#endif
1486
1487struct pfioc_table {
1488 struct pfr_table pfrio_table;
1489 void *pfrio_buffer;
1490 int pfrio_esize;
1491 int pfrio_size;
1492 int pfrio_size2;
1493 int pfrio_nadd;
1494 int pfrio_ndel;
1495 int pfrio_nchange;
1496 int pfrio_flags;
1497 u_int32_t pfrio_ticket;
1498};
1499#define pfrio_exists pfrio_nadd
1500#define pfrio_nzero pfrio_nadd
1501#define pfrio_nmatch pfrio_nadd
1502#define pfrio_naddr pfrio_size2
1503#define pfrio_setflag pfrio_size2
1504#define pfrio_clrflag pfrio_nadd
1505
1506struct pfioc_iface {
1507 char pfiio_name[IFNAMSIZ];
1508 void *pfiio_buffer;
1509 int pfiio_esize;
1510 int pfiio_size;
1511 int pfiio_nzero;
1512 int pfiio_flags;
1513};
1514
1515struct pfioc_synflwats {
1516 u_int32_t hiwat;
1517 u_int32_t lowat;
1518};
1519
1520#define PF_STATELIM_NAME_LEN 16 /* kstat istr */
1521#define PF_STATELIM_DESCR_LEN 64
1522
1523struct pfioc_statelim {
1524 u_int32_t ticket;
1525
1526 char name[PF_STATELIM_NAME_LEN];
1527 uint32_t id;
1528#define PF_STATELIM_ID_NONE 0
1529#define PF_STATELIM_ID_MIN 1
1530#define PF_STATELIM_ID_MAX 255 /* fits in pf_state uint8_t */
1531
1532 /* limit on the total number of states */
1533 unsigned int limit;
1534#define PF_STATELIM_LIMIT_MIN 1
1535#define PF_STATELIM_LIMIT_MAX (1 << 24) /* pf is pretty scalable */
1536
1537 /* rate limit on the creation of states */
1538 struct {
1539 unsigned int limit;
1540 unsigned int seconds;
1541 } rate;
1542
1543 char description[PF_STATELIM_DESCR_LEN];
1544
1545 /* kernel state for GET ioctls */
1546 unsigned int inuse; /* gauge */
1547 uint64_t admitted; /* counter */
1548 uint64_t hardlimited; /* counter */
1549 uint64_t ratelimited; /* counter */
1550};
1551
1552#define PF_SOURCELIM_NAME_LEN 16 /* kstat istr */
1553#define PF_SOURCELIM_DESCR_LEN 64
1554
1555struct pfioc_sourcelim {
1556 u_int32_t ticket;
1557
1558 char name[PF_SOURCELIM_NAME_LEN];
1559 uint32_t id;
1560#define PF_SOURCELIM_ID_NONE 0
1561#define PF_SOURCELIM_ID_MIN 1
1562#define PF_SOURCELIM_ID_MAX 255 /* fits in pf_state uint8_t */
1563
1564 /* limit on the total number of address entries */
1565 unsigned int entries;
1566
1567 /* limit on the number of states per address entry */
1568 unsigned int limit;
1569
1570 /* rate limit on the creation of states by an address entry */
1571 struct {
1572 unsigned int limit;
1573 unsigned int seconds;
1574 } rate;
1575
1576 /*
1577 * when the number of states on an entry exceeds hwm, add
1578 * the address to the specified table. when the number of
1579 * states goes below lwm, remove it from the table.
1580 */
1581 char overload_tblname[PF_TABLE_NAME_SIZE];
1582 unsigned int overload_hwm;
1583 unsigned int overload_lwm;
1584
1585 /*
1586 * mask addresses before they're used for entries. /64s
1587 * everywhere for inet6 makes it easy to use too much memory.
1588 */
1589 unsigned int inet_prefix;
1590 unsigned int inet6_prefix;
1591
1592 char description[PF_SOURCELIM_DESCR_LEN];
1593
1594 /* kernel state for GET ioctls */
1595 unsigned int nentries; /* gauge */
1596 unsigned int inuse; /* gauge */
1597
1598 uint64_t addrallocs; /* counter */
1599 uint64_t addrnomem; /* counter */
1600 uint64_t admitted; /* counter */
1601 uint64_t addrlimited; /* counter */
1602 uint64_t hardlimited; /* counter */
1603 uint64_t ratelimited; /* counter */
1604};
1605
1606struct pfioc_source_entry {
1607 sa_family_t af;
1608 unsigned int rdomain;
1609 struct pf_addr addr;
1610
1611 /* stats */
1612
1613 unsigned int inuse; /* gauge */
1614 uint64_t admitted; /* counter */
1615 uint64_t hardlimited; /* counter */
1616 uint64_t ratelimited; /* counter */
1617};
1618
1619struct pfioc_source {
1620 char name[PF_SOURCELIM_NAME_LEN];
1621 uint32_t id;
1622
1623 /* copied from the parent source limiter */
1624
1625 unsigned int inet_prefix;
1626 unsigned int inet6_prefix;
1627 unsigned int limit;
1628
1629 /* source entries */
1630 size_t entry_size; /* sizeof(struct pfioc_source_entry) */
1631
1632 struct pfioc_source_entry *key;
1633 struct pfioc_source_entry *entries;
1634 size_t entrieslen; /* bytes */
1635};
1636
1637struct pfioc_source_kill {
1638 char name[PF_SOURCELIM_NAME_LEN];
1639 uint32_t id;
1640 unsigned int rdomain;
1641 sa_family_t af;
1642 struct pf_addr addr;
1643
1644 unsigned int rmstates; /* kill the states too? */
1645};
1646
1647/*
1648 * ioctl operations
1649 */
1650
1651#define DIOCSTART _IO ('D', 1)
1652#define DIOCSTOP _IO ('D', 2)
1653#define DIOCADDRULE _IOWR('D', 4, struct pfioc_rule)
1654#define DIOCGETRULES _IOWR('D', 6, struct pfioc_rule)
1655#define DIOCGETRULE _IOWR('D', 7, struct pfioc_rule)
1656/* cut 8 - 17 */
1657#define DIOCCLRSTATES _IOWR('D', 18, struct pfioc_state_kill)
1658#define DIOCGETSTATE _IOWR('D', 19, struct pfioc_state)
1659#define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_iface)
1660#define DIOCGETSTATUS _IOWR('D', 21, struct pf_status)
1661#define DIOCCLRSTATUS _IOWR('D', 22, struct pfioc_iface)
1662#define DIOCNATLOOK _IOWR('D', 23, struct pfioc_natlook)
1663#define DIOCSETDEBUG _IOWR('D', 24, u_int32_t)
1664#define DIOCGETSTATES _IOWR('D', 25, struct pfioc_states)
1665#define DIOCCHANGERULE _IOWR('D', 26, struct pfioc_rule)
1666/* cut 27 - 28 */
1667#define DIOCSETTIMEOUT _IOWR('D', 29, struct pfioc_tm)
1668#define DIOCGETTIMEOUT _IOWR('D', 30, struct pfioc_tm)
1669#define DIOCADDSTATE _IOWR('D', 37, struct pfioc_state)
1670/* cut 38 */
1671#define DIOCGETLIMIT _IOWR('D', 39, struct pfioc_limit)
1672#define DIOCSETLIMIT _IOWR('D', 40, struct pfioc_limit)
1673#define DIOCKILLSTATES _IOWR('D', 41, struct pfioc_state_kill)
1674/* cut 42 - 57 */
1675#define DIOCGETRULESETS _IOWR('D', 58, struct pfioc_ruleset)
1676#define DIOCGETRULESET _IOWR('D', 59, struct pfioc_ruleset)
1677#define DIOCRCLRTABLES _IOWR('D', 60, struct pfioc_table)
1678#define DIOCRADDTABLES _IOWR('D', 61, struct pfioc_table)
1679#define DIOCRDELTABLES _IOWR('D', 62, struct pfioc_table)
1680#define DIOCRGETTABLES _IOWR('D', 63, struct pfioc_table)
1681#define DIOCRGETTSTATS _IOWR('D', 64, struct pfioc_table)
1682#define DIOCRCLRTSTATS _IOWR('D', 65, struct pfioc_table)
1683#define DIOCRCLRADDRS _IOWR('D', 66, struct pfioc_table)
1684#define DIOCRADDADDRS _IOWR('D', 67, struct pfioc_table)
1685#define DIOCRDELADDRS _IOWR('D', 68, struct pfioc_table)
1686#define DIOCRSETADDRS _IOWR('D', 69, struct pfioc_table)
1687#define DIOCRGETADDRS _IOWR('D', 70, struct pfioc_table)
1688#define DIOCRGETASTATS _IOWR('D', 71, struct pfioc_table)
1689#define DIOCRCLRASTATS _IOWR('D', 72, struct pfioc_table)
1690#define DIOCRTSTADDRS _IOWR('D', 73, struct pfioc_table)
1691#define DIOCRSETTFLAGS _IOWR('D', 74, struct pfioc_table)
1692#define DIOCRINADEFINE _IOWR('D', 77, struct pfioc_table)
1693#define DIOCOSFPFLUSH _IO('D', 78)
1694#define DIOCOSFPADD _IOWR('D', 79, struct pf_osfp_ioctl)
1695#define DIOCOSFPGET _IOWR('D', 80, struct pf_osfp_ioctl)
1696#define DIOCXBEGIN _IOWR('D', 81, struct pfioc_trans)
1697#define DIOCXCOMMIT _IOWR('D', 82, struct pfioc_trans)
1698#define DIOCXROLLBACK _IOWR('D', 83, struct pfioc_trans)
1699#define DIOCGETSRCNODES _IOWR('D', 84, struct pfioc_src_nodes)
1700#define DIOCCLRSRCNODES _IO('D', 85)
1701#define DIOCSETHOSTID _IOWR('D', 86, u_int32_t)
1702#define DIOCIGETIFACES _IOWR('D', 87, struct pfioc_iface)
1703#define DIOCSETIFFLAG _IOWR('D', 89, struct pfioc_iface)
1704#define DIOCCLRIFFLAG _IOWR('D', 90, struct pfioc_iface)
1705#define DIOCKILLSRCNODES _IOWR('D', 91, struct pfioc_src_node_kill)
1706#define DIOCSETREASS _IOWR('D', 92, u_int32_t)
1707#define DIOCADDQUEUE _IOWR('D', 93, struct pfioc_queue)
1708#define DIOCGETQUEUES _IOWR('D', 94, struct pfioc_queue)
1709#define DIOCGETQUEUE _IOWR('D', 95, struct pfioc_queue)
1710#define DIOCGETQSTATS _IOWR('D', 96, struct pfioc_qstats)
1711#define DIOCSETSYNFLWATS _IOWR('D', 97, struct pfioc_synflwats)
1712#define DIOCSETSYNCOOKIES _IOWR('D', 98, u_int8_t)
1713#define DIOCGETSYNFLWATS _IOWR('D', 99, struct pfioc_synflwats)
1714#define DIOCXEND _IOWR('D', 100, u_int32_t)
1715#define DIOCADDSTATELIM _IOW('D', 101, struct pfioc_statelim)
1716#define DIOCADDSOURCELIM _IOW('D', 102, struct pfioc_sourcelim)
1717#define DIOCGETSTATELIM _IOWR('D', 103, struct pfioc_statelim)
1718#define DIOCGETSOURCELIM _IOWR('D', 104, struct pfioc_sourcelim)
1719#define DIOCGETSOURCE _IOWR('D', 105, struct pfioc_source)
1720#define DIOCGETNSTATELIM _IOWR('D', 106, struct pfioc_statelim)
1721#define DIOCGETNSOURCELIM _IOWR('D', 107, struct pfioc_sourcelim)
1722#define DIOCGETNSOURCE _IOWR('D', 108, struct pfioc_source)
1723#define DIOCCLRSOURCE _IOWR('D', 109, struct pfioc_source_kill)
1724
1725#ifdef _KERNEL
1726
1727struct pf_pdesc;
1728
1729RB_HEAD(pf_src_tree, pf_src_node);
1730RB_PROTOTYPE(pf_src_tree, pf_src_node, entry, pf_src_compare);
1731extern struct pf_src_tree tree_src_tracking;
1732
1733extern struct pf_state_list pf_state_list;
1734
1735TAILQ_HEAD(pf_queuehead, pf_queuespec);
1736extern struct pf_queuehead pf_queues[2];
1737extern struct pf_queuehead *pf_queues_active, *pf_queues_inactive;
1738
1739extern struct pool pf_src_tree_pl, pf_sn_item_pl, pf_rule_pl;
1740extern struct pool pf_state_pl, pf_state_key_pl, pf_state_item_pl,
1741 pf_rule_item_pl, pf_queue_pl,
1742 pf_pktdelay_pl, pf_anchor_pl;
1743extern struct pool pf_state_scrub_pl;
1744extern struct pf_rule pf_default_rule;
1745
1746extern int pf_tbladdr_setup(struct pf_ruleset *,
1747 struct pf_addr_wrap *, int);
1748extern void pf_tbladdr_remove(struct pf_addr_wrap *);
1749extern void pf_tbladdr_copyout(struct pf_addr_wrap *);
1750extern void pf_calc_skip_steps(struct pf_rulequeue *);
1751extern void pf_purge_expired_src_nodes(void);
1752extern void pf_remove_state(struct pf_state *);
1753extern void pf_remove_divert_state(struct inpcb *);
1754extern void pf_free_state(struct pf_state *);
1755int pf_insert_src_node(struct pf_src_node **,
1756 struct pf_rule *, enum pf_sn_types,
1757 sa_family_t, struct pf_addr *,
1758 struct pf_addr *, struct pfi_kif *);
1759void pf_remove_src_node(struct pf_src_node *);
1760struct pf_src_node *pf_get_src_node(struct pf_state *,
1761 enum pf_sn_types);
1762void pf_src_tree_remove_state(struct pf_state *);
1763void pf_state_rm_src_node(struct pf_state *,
1764 struct pf_src_node *);
1765
1766extern struct pf_state *pf_find_state_byid(struct pf_state_cmp *);
1767extern struct pf_state *pf_find_state_all(struct pf_state_key_cmp *,
1768 u_int, int *);
1769extern void pf_state_export(struct pfsync_state *,
1770 struct pf_state *);
1771int pf_state_import(const struct pfsync_state *,
1772 int);
1773int pf_state_alloc_scrub_memory(
1774 const struct pfsync_state_peer *,
1775 struct pf_state_peer *);
1776extern void pf_print_state(struct pf_state *);
1777extern void pf_print_flags(u_int8_t);
1778extern void pf_addrcpy(struct pf_addr *, struct pf_addr *,
1779 sa_family_t);
1780extern void pf_cksum_fixup(u_int16_t *, u_int16_t,
1781 u_int16_t, u_int8_t);
1782void pf_rm_rule(struct pf_rulequeue *,
1783 struct pf_rule *);
1784struct pf_divert *pf_find_divert(struct mbuf *);
1785int pf_setup_pdesc(struct pf_pdesc *, sa_family_t,
1786 int, struct pfi_kif *, struct mbuf *,
1787 u_short *);
1788
1789int pf_test(sa_family_t, int, struct ifnet *, struct mbuf **);
1790
1791void pf_poolmask(struct pf_addr *, struct pf_addr*,
1792 struct pf_addr *, struct pf_addr *, sa_family_t);
1793void pf_addr_inc(struct pf_addr *, sa_family_t);
1794
1795void *pf_pull_hdr(struct mbuf *, int, void *, int, u_short *, sa_family_t);
1796#define PF_HI (true)
1797#define PF_LO (!PF_HI)
1798#define PF_ALGNMNT(off) (((off) % 2) == 0 ? PF_HI : PF_LO)
1799int pf_patch_8(struct pf_pdesc *, u_int8_t *, u_int8_t, bool);
1800int pf_patch_16(struct pf_pdesc *, u_int16_t *, u_int16_t);
1801int pf_patch_16_unaligned(struct pf_pdesc *, void *, u_int16_t, bool);
1802int pf_patch_32(struct pf_pdesc *, u_int32_t *, u_int32_t);
1803int pf_patch_32_unaligned(struct pf_pdesc *, void *, u_int32_t, bool);
1804int pflog_packet(struct pf_pdesc *, u_int8_t, struct pf_rule *,
1805 struct pf_rule *, struct pf_ruleset *, struct pf_rule *);
1806int pf_match_addr(u_int8_t, struct pf_addr *, struct pf_addr *,
1807 struct pf_addr *, sa_family_t);
1808int pf_match_addr_range(struct pf_addr *, struct pf_addr *,
1809 struct pf_addr *, sa_family_t);
1810int pf_match(u_int8_t, u_int32_t, u_int32_t, u_int32_t);
1811int pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
1812int pf_match_uid(u_int8_t, uid_t, uid_t, uid_t);
1813int pf_match_gid(u_int8_t, gid_t, gid_t, gid_t);
1814
1815struct pf_state_scrub *
1816 pf_state_scrub_get(void);
1817void pf_state_scrub_put(struct pf_state_scrub *);
1818
1819int pf_refragment6(struct mbuf **, struct m_tag *mtag,
1820 struct sockaddr_in6 *, struct ifnet *, struct rtentry *);
1821void pf_normalize_init(void);
1822int pf_normalize_ip(struct pf_pdesc *, u_short *);
1823int pf_normalize_ip6(struct pf_pdesc *, u_short *);
1824int pf_normalize_tcp(struct pf_pdesc *);
1825void pf_normalize_tcp_cleanup(struct pf_state *);
1826int pf_normalize_tcp_init(struct pf_pdesc *, struct pf_state_peer *);
1827int pf_normalize_tcp_alloc(struct pf_state_peer *);
1828int pf_normalize_tcp_stateful(struct pf_pdesc *, u_short *,
1829 struct pf_state *, struct pf_state_peer *, struct pf_state_peer *,
1830 int *);
1831int pf_normalize_mss(struct pf_pdesc *, u_int16_t);
1832void pf_scrub(struct mbuf *, u_int16_t, sa_family_t, u_int8_t, u_int8_t);
1833void pf_purge_expired_fragments(void);
1834int pf_routable(struct pf_addr *addr, sa_family_t af, struct pfi_kif *,
1835 int);
1836int pf_rtlabel_match(struct pf_addr *, sa_family_t, struct pf_addr_wrap *,
1837 int);
1838int pf_socket_lookup(struct pf_pdesc *);
1839struct pf_state_key *pf_alloc_state_key(int);
1840int pf_ouraddr(struct mbuf *);
1841void pf_pkt_addr_changed(struct mbuf *);
1842struct inpcb *pf_inp_lookup(struct mbuf *);
1843void pf_inp_link(struct mbuf *, struct inpcb *);
1844void pf_inp_unlink(struct inpcb *);
1845int pf_translate(struct pf_pdesc *, struct pf_addr *, u_int16_t,
1846 struct pf_addr *, u_int16_t, u_int16_t, int);
1847int pf_translate_af(struct pf_pdesc *);
1848void pf_route(struct pf_pdesc *, struct pf_state *);
1849void pf_route6(struct pf_pdesc *, struct pf_state *);
1850void pf_init_threshold(struct pf_threshold *, u_int32_t, u_int32_t);
1851int pf_delay_pkt(struct mbuf *, u_int);
1852
1853void pfr_initialize(void);
1854int pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
1855void pfr_update_stats(struct pfr_ktable *, struct pf_addr *,
1856 struct pf_pdesc *, int, int);
1857int pfr_pool_get(struct pf_pool *, struct pf_addr **,
1858 struct pf_addr **, sa_family_t);
1859int pfr_states_increase(struct pfr_ktable *, struct pf_addr *, int);
1860int pfr_states_decrease(struct pfr_ktable *, struct pf_addr *, int);
1861struct pfr_kentry *
1862 pfr_kentry_byaddr(struct pfr_ktable *, struct pf_addr *, sa_family_t,
1863 int);
1864void pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
1865struct pfr_ktable *
1866 pfr_attach_table(struct pf_ruleset *, char *, int);
1867void pfr_detach_table(struct pfr_ktable *);
1868int pfr_clr_tables(struct pfr_table *, int *, int);
1869int pfr_add_tables(struct pfr_table *, int, int *, int);
1870int pfr_del_tables(struct pfr_table *, int, int *, int);
1871int pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
1872int pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
1873int pfr_clr_tstats(struct pfr_table *, int, int *, int);
1874int pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
1875int pfr_clr_addrs(struct pfr_table *, int *, int);
1876int pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *, time_t);
1877int pfr_remove_kentry(struct pfr_ktable *, struct pfr_addr *);
1878
1879int pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1880 int);
1881int pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1882 int);
1883int pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1884 int *, int *, int *, int, u_int32_t);
1885int pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
1886int pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
1887int pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
1888 int);
1889int pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1890 int);
1891int pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
1892int pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
1893int pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
1894int pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
1895 int *, u_int32_t, int);
1896struct pfr_ktable
1897 *pfr_ktable_select_active(struct pfr_ktable *);
1898
1899extern struct pfi_kif *pfi_all;
1900
1901void pfi_initialize(void);
1902struct pfi_kif *pfi_kif_alloc(const char *, int);
1903void pfi_kif_free(struct pfi_kif *);
1904struct pfi_kif *pfi_kif_find(const char *);
1905struct pfi_kif *pfi_kif_get(const char *, struct pfi_kif **);
1906void pfi_kif_ref(struct pfi_kif *, enum pfi_kif_refs);
1907void pfi_kif_unref(struct pfi_kif *, enum pfi_kif_refs);
1908int pfi_kif_match(struct pfi_kif *, struct pfi_kif *);
1909void pfi_attach_ifnet(struct ifnet *);
1910void pfi_detach_ifnet(struct ifnet *);
1911void pfi_attach_ifgroup(struct ifg_group *);
1912void pfi_detach_ifgroup(struct ifg_group *);
1913void pfi_group_addmember(const char *);
1914void pfi_group_delmember(const char *);
1915int pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
1916 sa_family_t);
1917int pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t, int);
1918void pfi_dynaddr_remove(struct pf_addr_wrap *);
1919void pfi_dynaddr_copyout(struct pf_addr_wrap *);
1920void pfi_update_status(const char *, struct pf_status *);
1921void pfi_get_ifaces(const char *, struct pfi_kif *, int *);
1922int pfi_set_flags(const char *, int);
1923int pfi_clear_flags(const char *, int);
1924void pfi_xcommit(void);
1925
1926int pf_match_tag(struct mbuf *, struct pf_rule *, int *);
1927u_int16_t pf_tagname2tag(char *, int);
1928void pf_tag2tagname(u_int16_t, char *);
1929void pf_tag_ref(u_int16_t);
1930void pf_tag_unref(u_int16_t);
1931void pf_tag_packet(struct mbuf *, int, int);
1932int pf_addr_compare(const struct pf_addr *,
1933 const struct pf_addr *, sa_family_t);
1934
1935const struct pfq_ops
1936 *pf_queue_manager(struct pf_queuespec *);
1937
1938extern struct pf_status pf_status;
1939extern struct pool pf_frent_pl, pf_frag_pl;
1940
1941/*
1942 * Protection/ownership of pf_pool_limit:
1943 * I immutable after pfattach()
1944 * p pf_lock
1945 */
1946
1947struct pf_pool_limit {
1948 void *pp; /* [I] */
1949 unsigned limit; /* [p] */
1950 unsigned limit_new; /* [p] */
1951};
1952extern struct pf_pool_limit pf_pool_limits[PF_LIMIT_MAX];
1953
1954#endif /* _KERNEL */
1955
1956extern struct pf_anchor_global pf_anchors;
1957extern struct pf_anchor pf_main_anchor;
1958#define pf_main_ruleset pf_main_anchor.ruleset
1959
1960struct tcphdr;
1961
1962/* these ruleset functions can be linked into userland programs (pfctl) */
1963void pf_init_ruleset(struct pf_ruleset *);
1964int pf_anchor_setup(struct pf_rule *,
1965 const struct pf_ruleset *, const char *);
1966int pf_anchor_copyout(const struct pf_ruleset *,
1967 const struct pf_rule *, struct pfioc_rule *);
1968void pf_remove_anchor(struct pf_rule *);
1969void pf_remove_if_empty_ruleset(struct pf_ruleset *);
1970struct pf_anchor *pf_find_anchor(const char *);
1971struct pf_ruleset *pf_find_ruleset(const char *);
1972struct pf_ruleset *pf_get_leaf_ruleset(char *, char **);
1973struct pf_anchor *pf_create_anchor(struct pf_anchor *, const char *);
1974struct pf_ruleset *pf_find_or_create_ruleset(const char *);
1975void pf_anchor_rele(struct pf_anchor *);
1976struct pf_anchor *pf_anchor_take(struct pf_anchor *);
1977
1978/* The fingerprint functions can be linked into userland programs (tcpdump) */
1979int pf_osfp_add(struct pf_osfp_ioctl *);
1980#ifdef _KERNEL
1981struct pf_osfp_enlist *
1982 pf_osfp_fingerprint(struct pf_pdesc *);
1983#endif /* _KERNEL */
1984struct pf_osfp_enlist *
1985 pf_osfp_fingerprint_hdr(const struct ip *, const struct ip6_hdr *,
1986 const struct tcphdr *);
1987void pf_osfp_flush(void);
1988int pf_osfp_get(struct pf_osfp_ioctl *);
1989void pf_osfp_initialize(void);
1990int pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
1991struct pf_os_fingerprint *
1992 pf_osfp_validate(void);
1993
1994#ifdef _KERNEL
1995void pf_print_host(struct pf_addr *, u_int16_t,
1996 sa_family_t);
1997int pf_get_transaddr(struct pf_rule *, struct pf_pdesc *,
1998 struct pf_src_node **, struct pf_rule **);
1999int pf_map_addr(sa_family_t, struct pf_rule *,
2000 struct pf_addr *, struct pf_addr *,
2001 struct pf_addr *, struct pf_src_node **,
2002 struct pf_pool *, enum pf_sn_types);
2003int pf_postprocess_addr(struct pf_state *);
2004
2005void pf_mbuf_link_state_key(struct mbuf *,
2006 struct pf_state_key *);
2007void pf_mbuf_unlink_state_key(struct mbuf *);
2008void pf_mbuf_link_inpcb(struct mbuf *, struct inpcb *);
2009void pf_mbuf_unlink_inpcb(struct mbuf *);
2010
2011u_int8_t* pf_find_tcpopt(u_int8_t *, u_int8_t *, size_t,
2012 u_int8_t, u_int8_t);
2013u_int8_t pf_get_wscale(struct pf_pdesc *);
2014u_int16_t pf_get_mss(struct pf_pdesc *, uint16_t);
2015struct mbuf * pf_build_tcp(const struct pf_rule *, sa_family_t,
2016 const struct pf_addr *, const struct pf_addr *,
2017 u_int16_t, u_int16_t, u_int32_t, u_int32_t,
2018 u_int8_t, u_int16_t, u_int16_t, u_int8_t, int,
2019 u_int16_t, u_int, u_int, u_short *);
2020void pf_send_tcp(const struct pf_rule *, sa_family_t,
2021 const struct pf_addr *, const struct pf_addr *,
2022 u_int16_t, u_int16_t, u_int32_t, u_int32_t,
2023 u_int8_t, u_int16_t, u_int16_t, u_int8_t, int,
2024 u_int16_t, u_int, u_short *);
2025void pf_syncookies_init(void);
2026int pf_syncookies_setmode(u_int8_t);
2027int pf_syncookies_setwats(u_int32_t, u_int32_t);
2028int pf_syncookies_getwats(struct pfioc_synflwats *);
2029int pf_synflood_check(struct pf_pdesc *);
2030void pf_syncookie_send(struct pf_pdesc *, u_short *);
2031u_int8_t pf_syncookie_validate(struct pf_pdesc *);
2032struct mbuf * pf_syncookie_recreate_syn(struct pf_pdesc *,
2033 u_short *);
2034#endif /* _KERNEL */
2035
2036#endif /* _NET_PFVAR_H_ */