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