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