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