1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2001 Daniel Hartmeier
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * - Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * - Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following
15 * disclaimer in the documentation and/or other materials provided
16 * with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
22 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
24 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
28 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 *
31 * $OpenBSD: pfvar.h,v 1.282 2009/01/29 15:12:28 pyr Exp $
32 */
33
34 #ifndef _NET_PFVAR_H_
35 #define _NET_PFVAR_H_
36
37 #include <sys/param.h>
38 #include <sys/queue.h>
39 #include <sys/counter.h>
40 #include <sys/cpuset.h>
41 #include <sys/epoch.h>
42 #include <sys/malloc.h>
43 #include <sys/nv.h>
44 #include <sys/refcount.h>
45 #include <sys/sdt.h>
46 #include <sys/sysctl.h>
47 #include <sys/smp.h>
48 #include <sys/lock.h>
49 #include <sys/rmlock.h>
50 #include <sys/tree.h>
51 #include <sys/seqc.h>
52 #include <vm/uma.h>
53
54 #include <net/if.h>
55 #include <net/ethernet.h>
56 #include <net/radix.h>
57 #include <netinet/in.h>
58 #ifdef _KERNEL
59 #include <netinet/ip.h>
60 #include <netinet/tcp.h>
61 #include <netinet/udp.h>
62 #include <netinet/sctp.h>
63 #include <netinet/ip_icmp.h>
64 #include <netinet/icmp6.h>
65 #endif
66
67 #include <netpfil/pf/pf.h>
68 #include <netpfil/pf/pf_altq.h>
69 #include <netpfil/pf/pf_mtag.h>
70
71 #ifdef _KERNEL
72
73 #define PF_PFIL_NOREFRAGMENT 0x80000000
74
75 #if defined(__arm__)
76 #define PF_WANT_32_TO_64_COUNTER
77 #endif
78
79 /*
80 * A hybrid of 32-bit and 64-bit counters which can be used on platforms where
81 * counter(9) is very expensive.
82 *
83 * As 32-bit counters are expected to overflow, a periodic job sums them up to
84 * a saved 64-bit state. Fetching the value still walks all CPUs to get the most
85 * current snapshot.
86 */
87 #ifdef PF_WANT_32_TO_64_COUNTER
88 struct pf_counter_u64_pcpu {
89 u_int32_t current;
90 u_int32_t snapshot;
91 };
92
93 struct pf_counter_u64 {
94 struct pf_counter_u64_pcpu *pfcu64_pcpu;
95 u_int64_t pfcu64_value;
96 seqc_t pfcu64_seqc;
97 };
98
99 static inline int
pf_counter_u64_init(struct pf_counter_u64 * pfcu64,int flags)100 pf_counter_u64_init(struct pf_counter_u64 *pfcu64, int flags)
101 {
102
103 pfcu64->pfcu64_value = 0;
104 pfcu64->pfcu64_seqc = 0;
105 pfcu64->pfcu64_pcpu = uma_zalloc_pcpu(pcpu_zone_8, flags | M_ZERO);
106 if (__predict_false(pfcu64->pfcu64_pcpu == NULL))
107 return (ENOMEM);
108 return (0);
109 }
110
111 static inline void
pf_counter_u64_deinit(struct pf_counter_u64 * pfcu64)112 pf_counter_u64_deinit(struct pf_counter_u64 *pfcu64)
113 {
114
115 uma_zfree_pcpu(pcpu_zone_8, pfcu64->pfcu64_pcpu);
116 }
117
118 static inline void
pf_counter_u64_critical_enter(void)119 pf_counter_u64_critical_enter(void)
120 {
121
122 critical_enter();
123 }
124
125 static inline void
pf_counter_u64_critical_exit(void)126 pf_counter_u64_critical_exit(void)
127 {
128
129 critical_exit();
130 }
131
132 static inline void
pf_counter_u64_rollup_protected(struct pf_counter_u64 * pfcu64,uint64_t n)133 pf_counter_u64_rollup_protected(struct pf_counter_u64 *pfcu64, uint64_t n)
134 {
135
136 MPASS(curthread->td_critnest > 0);
137 pfcu64->pfcu64_value += n;
138 }
139
140 static inline void
pf_counter_u64_add_protected(struct pf_counter_u64 * pfcu64,uint32_t n)141 pf_counter_u64_add_protected(struct pf_counter_u64 *pfcu64, uint32_t n)
142 {
143 struct pf_counter_u64_pcpu *pcpu;
144 u_int32_t val;
145
146 MPASS(curthread->td_critnest > 0);
147 pcpu = zpcpu_get(pfcu64->pfcu64_pcpu);
148 val = atomic_load_int(&pcpu->current);
149 atomic_store_int(&pcpu->current, val + n);
150 }
151
152 static inline void
pf_counter_u64_add(struct pf_counter_u64 * pfcu64,uint32_t n)153 pf_counter_u64_add(struct pf_counter_u64 *pfcu64, uint32_t n)
154 {
155
156 critical_enter();
157 pf_counter_u64_add_protected(pfcu64, n);
158 critical_exit();
159 }
160
161 static inline u_int64_t
pf_counter_u64_periodic(struct pf_counter_u64 * pfcu64)162 pf_counter_u64_periodic(struct pf_counter_u64 *pfcu64)
163 {
164 struct pf_counter_u64_pcpu *pcpu;
165 u_int64_t sum;
166 u_int32_t val;
167 int cpu;
168
169 MPASS(curthread->td_critnest > 0);
170 seqc_write_begin(&pfcu64->pfcu64_seqc);
171 sum = pfcu64->pfcu64_value;
172 CPU_FOREACH(cpu) {
173 pcpu = zpcpu_get_cpu(pfcu64->pfcu64_pcpu, cpu);
174 val = atomic_load_int(&pcpu->current);
175 sum += (uint32_t)(val - pcpu->snapshot);
176 pcpu->snapshot = val;
177 }
178 pfcu64->pfcu64_value = sum;
179 seqc_write_end(&pfcu64->pfcu64_seqc);
180 return (sum);
181 }
182
183 static inline u_int64_t
pf_counter_u64_fetch(const struct pf_counter_u64 * pfcu64)184 pf_counter_u64_fetch(const struct pf_counter_u64 *pfcu64)
185 {
186 struct pf_counter_u64_pcpu *pcpu;
187 u_int64_t sum;
188 seqc_t seqc;
189 int cpu;
190
191 for (;;) {
192 seqc = seqc_read(&pfcu64->pfcu64_seqc);
193 sum = 0;
194 CPU_FOREACH(cpu) {
195 pcpu = zpcpu_get_cpu(pfcu64->pfcu64_pcpu, cpu);
196 sum += (uint32_t)(atomic_load_int(&pcpu->current) -pcpu->snapshot);
197 }
198 sum += pfcu64->pfcu64_value;
199 if (seqc_consistent(&pfcu64->pfcu64_seqc, seqc))
200 break;
201 }
202 return (sum);
203 }
204
205 static inline void
pf_counter_u64_zero_protected(struct pf_counter_u64 * pfcu64)206 pf_counter_u64_zero_protected(struct pf_counter_u64 *pfcu64)
207 {
208 struct pf_counter_u64_pcpu *pcpu;
209 int cpu;
210
211 MPASS(curthread->td_critnest > 0);
212 seqc_write_begin(&pfcu64->pfcu64_seqc);
213 CPU_FOREACH(cpu) {
214 pcpu = zpcpu_get_cpu(pfcu64->pfcu64_pcpu, cpu);
215 pcpu->snapshot = atomic_load_int(&pcpu->current);
216 }
217 pfcu64->pfcu64_value = 0;
218 seqc_write_end(&pfcu64->pfcu64_seqc);
219 }
220
221 static inline void
pf_counter_u64_zero(struct pf_counter_u64 * pfcu64)222 pf_counter_u64_zero(struct pf_counter_u64 *pfcu64)
223 {
224
225 critical_enter();
226 pf_counter_u64_zero_protected(pfcu64);
227 critical_exit();
228 }
229 #else
230 struct pf_counter_u64 {
231 counter_u64_t counter;
232 };
233
234 static inline int
pf_counter_u64_init(struct pf_counter_u64 * pfcu64,int flags)235 pf_counter_u64_init(struct pf_counter_u64 *pfcu64, int flags)
236 {
237
238 pfcu64->counter = counter_u64_alloc(flags);
239 if (__predict_false(pfcu64->counter == NULL))
240 return (ENOMEM);
241 return (0);
242 }
243
244 static inline void
pf_counter_u64_deinit(struct pf_counter_u64 * pfcu64)245 pf_counter_u64_deinit(struct pf_counter_u64 *pfcu64)
246 {
247
248 counter_u64_free(pfcu64->counter);
249 }
250
251 static inline void
pf_counter_u64_critical_enter(void)252 pf_counter_u64_critical_enter(void)
253 {
254
255 }
256
257 static inline void
pf_counter_u64_critical_exit(void)258 pf_counter_u64_critical_exit(void)
259 {
260
261 }
262
263 static inline void
pf_counter_u64_rollup_protected(struct pf_counter_u64 * pfcu64,uint64_t n)264 pf_counter_u64_rollup_protected(struct pf_counter_u64 *pfcu64, uint64_t n)
265 {
266
267 counter_u64_add(pfcu64->counter, n);
268 }
269
270 static inline void
pf_counter_u64_add_protected(struct pf_counter_u64 * pfcu64,uint32_t n)271 pf_counter_u64_add_protected(struct pf_counter_u64 *pfcu64, uint32_t n)
272 {
273
274 counter_u64_add(pfcu64->counter, n);
275 }
276
277 static inline void
pf_counter_u64_add(struct pf_counter_u64 * pfcu64,uint32_t n)278 pf_counter_u64_add(struct pf_counter_u64 *pfcu64, uint32_t n)
279 {
280
281 pf_counter_u64_add_protected(pfcu64, n);
282 }
283
284 static inline u_int64_t
pf_counter_u64_fetch(const struct pf_counter_u64 * pfcu64)285 pf_counter_u64_fetch(const struct pf_counter_u64 *pfcu64)
286 {
287
288 return (counter_u64_fetch(pfcu64->counter));
289 }
290
291 static inline void
pf_counter_u64_zero_protected(struct pf_counter_u64 * pfcu64)292 pf_counter_u64_zero_protected(struct pf_counter_u64 *pfcu64)
293 {
294
295 counter_u64_zero(pfcu64->counter);
296 }
297
298 static inline void
pf_counter_u64_zero(struct pf_counter_u64 * pfcu64)299 pf_counter_u64_zero(struct pf_counter_u64 *pfcu64)
300 {
301
302 pf_counter_u64_zero_protected(pfcu64);
303 }
304 #endif
305
306 #define pf_get_timestamp(prule)({ \
307 uint32_t _ts = 0; \
308 uint32_t __ts; \
309 int cpu; \
310 CPU_FOREACH(cpu) { \
311 __ts = *zpcpu_get_cpu(prule->timestamp, cpu); \
312 if (__ts > _ts) \
313 _ts = __ts; \
314 } \
315 _ts; \
316 })
317
318 #define pf_update_timestamp(prule) \
319 do { \
320 critical_enter(); \
321 *zpcpu_get((prule)->timestamp) = time_second; \
322 critical_exit(); \
323 } while (0)
324
325 #define pf_timestamp_pcpu_zone (sizeof(time_t) == 4 ? pcpu_zone_4 : pcpu_zone_8)
326 _Static_assert(sizeof(time_t) == 4 || sizeof(time_t) == 8, "unexpected time_t size");
327
328 SYSCTL_DECL(_net_pf);
329 MALLOC_DECLARE(M_PF);
330 MALLOC_DECLARE(M_PFHASH);
331 MALLOC_DECLARE(M_PF_RULE_ITEM);
332
333 SDT_PROVIDER_DECLARE(pf);
334 SDT_PROBE_DECLARE(pf, , test, reason_set);
335 SDT_PROBE_DECLARE(pf, , log, log);
336
337 #define DPFPRINTF(n, fmt, x...) \
338 do { \
339 SDT_PROBE2(pf, , log, log, (n), fmt); \
340 if (V_pf_status.debug >= (n)) \
341 printf(fmt "\n", ##x); \
342 } while (0)
343
344 struct pfi_dynaddr {
345 TAILQ_ENTRY(pfi_dynaddr) entry;
346 struct pf_addr pfid_addr4;
347 struct pf_addr pfid_mask4;
348 struct pf_addr pfid_addr6;
349 struct pf_addr pfid_mask6;
350 struct pfr_ktable *pfid_kt;
351 struct pfi_kkif *pfid_kif;
352 int pfid_net; /* mask or 128 */
353 int pfid_acnt4; /* address count IPv4 */
354 int pfid_acnt6; /* address count IPv6 */
355 sa_family_t pfid_af; /* rule af */
356 u_int8_t pfid_iflags; /* PFI_AFLAG_* */
357 };
358
359 #define PF_NAME "pf"
360
361 #define PF_HASHROW_ASSERT(h) mtx_assert(&(h)->lock, MA_OWNED)
362 #define PF_HASHROW_LOCK(h) mtx_lock(&(h)->lock)
363 #define PF_HASHROW_UNLOCK(h) mtx_unlock(&(h)->lock)
364
365 #ifdef INVARIANTS
366 #define PF_STATE_LOCK(s) \
367 do { \
368 struct pf_kstate *_s = (s); \
369 struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH(_s)]; \
370 MPASS(_s->lock == &_ih->lock); \
371 mtx_lock(_s->lock); \
372 } while (0)
373 #define PF_STATE_UNLOCK(s) \
374 do { \
375 struct pf_kstate *_s = (s); \
376 struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH(_s)]; \
377 MPASS(_s->lock == &_ih->lock); \
378 mtx_unlock(_s->lock); \
379 } while (0)
380 #else
381 #define PF_STATE_LOCK(s) mtx_lock((s)->lock)
382 #define PF_STATE_UNLOCK(s) mtx_unlock((s)->lock)
383 #endif
384
385 #ifdef INVARIANTS
386 #define PF_STATE_LOCK_ASSERT(s) \
387 do { \
388 struct pf_kstate *_s = (s); \
389 struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH(_s)]; \
390 MPASS(_s->lock == &_ih->lock); \
391 PF_HASHROW_ASSERT(_ih); \
392 } while (0)
393 #else /* !INVARIANTS */
394 #define PF_STATE_LOCK_ASSERT(s) do {} while (0)
395 #endif /* INVARIANTS */
396
397 #ifdef INVARIANTS
398 #define PF_SRC_NODE_LOCK(sn) \
399 do { \
400 struct pf_ksrc_node *_sn = (sn); \
401 struct pf_srchash *_sh = &V_pf_srchash[ \
402 pf_hashsrc(&_sn->addr, _sn->af)]; \
403 MPASS(_sn->lock == &_sh->lock); \
404 mtx_lock(_sn->lock); \
405 } while (0)
406 #define PF_SRC_NODE_UNLOCK(sn) \
407 do { \
408 struct pf_ksrc_node *_sn = (sn); \
409 struct pf_srchash *_sh = &V_pf_srchash[ \
410 pf_hashsrc(&_sn->addr, _sn->af)]; \
411 MPASS(_sn->lock == &_sh->lock); \
412 mtx_unlock(_sn->lock); \
413 } while (0)
414 #else
415 #define PF_SRC_NODE_LOCK(sn) mtx_lock((sn)->lock)
416 #define PF_SRC_NODE_UNLOCK(sn) mtx_unlock((sn)->lock)
417 #endif
418
419 #ifdef INVARIANTS
420 #define PF_SRC_NODE_LOCK_ASSERT(sn) \
421 do { \
422 struct pf_ksrc_node *_sn = (sn); \
423 struct pf_srchash *_sh = &V_pf_srchash[ \
424 pf_hashsrc(&_sn->addr, _sn->af)]; \
425 MPASS(_sn->lock == &_sh->lock); \
426 PF_HASHROW_ASSERT(_sh); \
427 } while (0)
428 #else /* !INVARIANTS */
429 #define PF_SRC_NODE_LOCK_ASSERT(sn) do {} while (0)
430 #endif /* INVARIANTS */
431
432 extern struct mtx_padalign pf_unlnkdrules_mtx;
433 #define PF_UNLNKDRULES_LOCK() mtx_lock(&pf_unlnkdrules_mtx)
434 #define PF_UNLNKDRULES_UNLOCK() mtx_unlock(&pf_unlnkdrules_mtx)
435 #define PF_UNLNKDRULES_ASSERT() mtx_assert(&pf_unlnkdrules_mtx, MA_OWNED)
436
437 extern struct sx pf_config_lock;
438 #define PF_CONFIG_LOCK() sx_xlock(&pf_config_lock)
439 #define PF_CONFIG_UNLOCK() sx_xunlock(&pf_config_lock)
440 #define PF_CONFIG_ASSERT() sx_assert(&pf_config_lock, SA_XLOCKED)
441
442 VNET_DECLARE(struct rmlock, pf_rules_lock);
443 #define V_pf_rules_lock VNET(pf_rules_lock)
444
445 #define PF_RULES_RLOCK_TRACKER struct rm_priotracker _pf_rules_tracker
446 #define PF_RULES_RLOCK() rm_rlock(&V_pf_rules_lock, &_pf_rules_tracker)
447 #define PF_RULES_RUNLOCK() rm_runlock(&V_pf_rules_lock, &_pf_rules_tracker)
448 #define PF_RULES_WLOCK() rm_wlock(&V_pf_rules_lock)
449 #define PF_RULES_WUNLOCK() rm_wunlock(&V_pf_rules_lock)
450 #define PF_RULES_WOWNED() rm_wowned(&V_pf_rules_lock)
451 #define PF_RULES_ASSERT() rm_assert(&V_pf_rules_lock, RA_LOCKED)
452 #define PF_RULES_RASSERT() rm_assert(&V_pf_rules_lock, RA_RLOCKED)
453 #define PF_RULES_WASSERT() rm_assert(&V_pf_rules_lock, RA_WLOCKED)
454
455 extern struct mtx_padalign pf_table_stats_lock;
456 #define PF_TABLE_STATS_LOCK() mtx_lock(&pf_table_stats_lock)
457 #define PF_TABLE_STATS_UNLOCK() mtx_unlock(&pf_table_stats_lock)
458 #define PF_TABLE_STATS_OWNED() mtx_owned(&pf_table_stats_lock)
459 #define PF_TABLE_STATS_ASSERT() mtx_assert(&pf_table_stats_lock, MA_OWNED)
460
461 extern struct sx pf_end_lock;
462
463 #define PF_MODVER 1
464 #define PFLOG_MODVER 1
465 #define PFSYNC_MODVER 1
466
467 #define PFLOG_MINVER 1
468 #define PFLOG_PREFVER PFLOG_MODVER
469 #define PFLOG_MAXVER 1
470 #define PFSYNC_MINVER 1
471 #define PFSYNC_PREFVER PFSYNC_MODVER
472 #define PFSYNC_MAXVER 1
473
474 #ifdef INET
475 #ifndef INET6
476 #define PF_INET_ONLY
477 #endif /* ! INET6 */
478 #endif /* INET */
479
480 #ifdef INET6
481 #ifndef INET
482 #define PF_INET6_ONLY
483 #endif /* ! INET */
484 #endif /* INET6 */
485
486 #ifdef INET
487 #ifdef INET6
488 #define PF_INET_INET6
489 #endif /* INET6 */
490 #endif /* INET */
491
492 #else
493
494 #define PF_INET_INET6
495
496 #endif /* _KERNEL */
497
498 /* Both IPv4 and IPv6 */
499 #ifdef PF_INET_INET6
500
501 #define PF_AEQ(a, b, c) \
502 ((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \
503 (c == AF_INET6 && (a)->addr32[3] == (b)->addr32[3] && \
504 (a)->addr32[2] == (b)->addr32[2] && \
505 (a)->addr32[1] == (b)->addr32[1] && \
506 (a)->addr32[0] == (b)->addr32[0])) \
507
508 #define PF_ANEQ(a, b, c) \
509 ((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \
510 (c == AF_INET6 && ((a)->addr32[0] != (b)->addr32[0] || \
511 (a)->addr32[1] != (b)->addr32[1] || \
512 (a)->addr32[2] != (b)->addr32[2] || \
513 (a)->addr32[3] != (b)->addr32[3]))) \
514
515 #define PF_AZERO(a, c) \
516 ((c == AF_INET && !(a)->addr32[0]) || \
517 (c == AF_INET6 && !(a)->addr32[0] && !(a)->addr32[1] && \
518 !(a)->addr32[2] && !(a)->addr32[3] )) \
519
520 #else
521
522 /* Just IPv6 */
523
524 #ifdef PF_INET6_ONLY
525
526 #define PF_AEQ(a, b, c) \
527 ((a)->addr32[3] == (b)->addr32[3] && \
528 (a)->addr32[2] == (b)->addr32[2] && \
529 (a)->addr32[1] == (b)->addr32[1] && \
530 (a)->addr32[0] == (b)->addr32[0]) \
531
532 #define PF_ANEQ(a, b, c) \
533 ((a)->addr32[3] != (b)->addr32[3] || \
534 (a)->addr32[2] != (b)->addr32[2] || \
535 (a)->addr32[1] != (b)->addr32[1] || \
536 (a)->addr32[0] != (b)->addr32[0]) \
537
538 #define PF_AZERO(a, c) \
539 (!(a)->addr32[0] && \
540 !(a)->addr32[1] && \
541 !(a)->addr32[2] && \
542 !(a)->addr32[3] ) \
543
544 #else
545
546 /* Just IPv4 */
547 #ifdef PF_INET_ONLY
548
549 #define PF_AEQ(a, b, c) \
550 ((a)->addr32[0] == (b)->addr32[0])
551
552 #define PF_ANEQ(a, b, c) \
553 ((a)->addr32[0] != (b)->addr32[0])
554
555 #define PF_AZERO(a, c) \
556 (!(a)->addr32[0])
557
558 #endif /* PF_INET_ONLY */
559 #endif /* PF_INET6_ONLY */
560 #endif /* PF_INET_INET6 */
561
562 #ifdef _KERNEL
563
564 void unhandled_af(int) __dead2;
565
566 static void inline
pf_addrcpy(struct pf_addr * dst,const struct pf_addr * src,sa_family_t af)567 pf_addrcpy(struct pf_addr *dst, const struct pf_addr *src, sa_family_t af)
568 {
569 switch (af) {
570 #ifdef INET
571 case AF_INET:
572 memcpy(&dst->v4, &src->v4, sizeof(dst->v4));
573 break;
574 #endif /* INET */
575 #ifdef INET6
576 case AF_INET6:
577 memcpy(&dst->v6, &src->v6, sizeof(dst->v6));
578 break;
579 #endif /* INET6 */
580 default:
581 unhandled_af(af);
582 }
583 }
584 #endif
585
586 /*
587 * XXX callers not FIB-aware in our version of pf yet.
588 * OpenBSD fixed it later it seems, 2010/05/07 13:33:16 claudio.
589 */
590 #define PF_MISMATCHAW(aw, x, af, neg, ifp, rtid) \
591 ( \
592 (((aw)->type == PF_ADDR_NOROUTE && \
593 pf_routable((x), (af), NULL, (rtid))) || \
594 (((aw)->type == PF_ADDR_URPFFAILED && (ifp) != NULL && \
595 pf_routable((x), (af), (ifp), (rtid))) || \
596 ((aw)->type == PF_ADDR_TABLE && \
597 !pfr_match_addr((aw)->p.tbl, (x), (af))) || \
598 ((aw)->type == PF_ADDR_DYNIFTL && \
599 !pfi_match_addr((aw)->p.dyn, (x), (af))) || \
600 ((aw)->type == PF_ADDR_RANGE && \
601 !pf_match_addr_range(&(aw)->v.a.addr, \
602 &(aw)->v.a.mask, (x), (af))) || \
603 ((aw)->type == PF_ADDR_ADDRMASK && \
604 !PF_AZERO(&(aw)->v.a.mask, (af)) && \
605 !pf_match_addr(0, &(aw)->v.a.addr, \
606 &(aw)->v.a.mask, (x), (af))))) != \
607 (neg) \
608 )
609
610 #define PF_ALGNMNT(off) (((off) % 2) == 0)
611
612 /*
613 * At the moment there are no rules which have both NAT and RDR actions,
614 * apart from af-to rules, but those don't to source tracking for address
615 * translation. And the r->rdr pool is used for both NAT and RDR.
616 * So there is no PF_SN_RDR.
617 */
618 enum pf_sn_types { PF_SN_LIMIT, PF_SN_NAT, PF_SN_ROUTE, PF_SN_MAX };
619 typedef enum pf_sn_types pf_sn_types_t;
620 #define PF_SN_TYPE_NAMES { \
621 "limit source-track", \
622 "NAT/RDR sticky-address", \
623 "route sticky-address", \
624 NULL \
625 }
626
627 #ifdef _KERNEL
628
629 struct pf_kpooladdr {
630 struct pf_addr_wrap addr;
631 TAILQ_ENTRY(pf_kpooladdr) entries;
632 char ifname[IFNAMSIZ];
633 sa_family_t af;
634 struct pfi_kkif *kif;
635 };
636
637 TAILQ_HEAD(pf_kpalist, pf_kpooladdr);
638
639 struct pf_kpool {
640 struct mtx mtx;
641 struct pf_kpalist list;
642 struct pf_kpooladdr *cur;
643 struct pf_poolhashkey key;
644 struct pf_addr counter;
645 struct pf_mape_portset mape;
646 int tblidx;
647 u_int16_t proxy_port[2];
648 u_int8_t opts;
649 sa_family_t ipv6_nexthop_af;
650 };
651
652 struct pf_rule_actions {
653 struct pf_addr rt_addr;
654 struct pfi_kkif *rt_kif;
655 int32_t rtableid;
656 uint32_t flags;
657 uint16_t qid;
658 uint16_t pqid;
659 uint16_t max_mss;
660 uint16_t dnpipe;
661 uint16_t dnrpipe; /* Reverse direction pipe */
662 sa_family_t rt_af;
663 uint8_t log;
664 uint8_t set_tos;
665 uint8_t min_ttl;
666 uint8_t set_prio[2];
667 uint8_t rt;
668 uint8_t allow_opts;
669 uint16_t max_pkt_size;
670 };
671
672 union pf_keth_rule_ptr {
673 struct pf_keth_rule *ptr;
674 uint32_t nr;
675 };
676
677 struct pf_keth_rule_addr {
678 uint8_t addr[ETHER_ADDR_LEN];
679 uint8_t mask[ETHER_ADDR_LEN];
680 bool neg;
681 uint8_t isset;
682 };
683
684 struct pf_keth_anchor;
685
686 TAILQ_HEAD(pf_keth_ruleq, pf_keth_rule);
687
688 struct pf_keth_ruleset {
689 struct pf_keth_ruleq rules[2];
690 struct pf_keth_rules {
691 struct pf_keth_ruleq *rules;
692 int open;
693 uint32_t ticket;
694 } active, inactive;
695 struct vnet *vnet;
696 struct pf_keth_anchor *anchor;
697 };
698
699 RB_HEAD(pf_keth_anchor_global, pf_keth_anchor);
700 RB_HEAD(pf_keth_anchor_node, pf_keth_anchor);
701 struct pf_keth_anchor {
702 RB_ENTRY(pf_keth_anchor) entry_node;
703 RB_ENTRY(pf_keth_anchor) entry_global;
704 struct pf_keth_anchor *parent;
705 struct pf_keth_anchor_node children;
706 char name[PF_ANCHOR_NAME_SIZE];
707 char path[MAXPATHLEN];
708 struct pf_keth_ruleset ruleset;
709 int refcnt; /* anchor rules */
710 uint8_t anchor_relative;
711 uint8_t anchor_wildcard;
712 };
713 RB_PROTOTYPE(pf_keth_anchor_node, pf_keth_anchor, entry_node,
714 pf_keth_anchor_compare);
715 RB_PROTOTYPE(pf_keth_anchor_global, pf_keth_anchor, entry_global,
716 pf_keth_anchor_compare);
717
718 struct pf_keth_rule {
719 #define PFE_SKIP_IFP 0
720 #define PFE_SKIP_DIR 1
721 #define PFE_SKIP_PROTO 2
722 #define PFE_SKIP_SRC_ADDR 3
723 #define PFE_SKIP_DST_ADDR 4
724 #define PFE_SKIP_SRC_IP_ADDR 5
725 #define PFE_SKIP_DST_IP_ADDR 6
726 #define PFE_SKIP_COUNT 7
727 union pf_keth_rule_ptr skip[PFE_SKIP_COUNT];
728
729 TAILQ_ENTRY(pf_keth_rule) entries;
730
731 struct pf_keth_anchor *anchor;
732 u_int8_t anchor_relative;
733 u_int8_t anchor_wildcard;
734
735 uint32_t nr;
736
737 bool quick;
738
739 /* Filter */
740 char ifname[IFNAMSIZ];
741 struct pfi_kkif *kif;
742 bool ifnot;
743 uint8_t direction;
744 uint16_t proto;
745 struct pf_keth_rule_addr src, dst;
746 struct pf_rule_addr ipsrc, ipdst;
747 char match_tagname[PF_TAG_NAME_SIZE];
748 uint16_t match_tag;
749 bool match_tag_not;
750
751
752 /* Stats */
753 counter_u64_t evaluations;
754 counter_u64_t packets[2];
755 counter_u64_t bytes[2];
756 time_t *timestamp;
757
758 /* Action */
759 char qname[PF_QNAME_SIZE];
760 int qid;
761 char tagname[PF_TAG_NAME_SIZE];
762 uint16_t tag;
763 char bridge_to_name[IFNAMSIZ];
764 struct pfi_kkif *bridge_to;
765 uint8_t action;
766 uint16_t dnpipe;
767 uint32_t dnflags;
768
769 char label[PF_RULE_MAX_LABEL_COUNT][PF_RULE_LABEL_SIZE];
770 uint32_t ridentifier;
771 };
772
773 struct pf_kthreshold {
774 uint32_t limit;
775 uint32_t seconds;
776 struct counter_rate *cr;
777 };
778
779 RB_HEAD(pf_krule_global, pf_krule);
780 RB_PROTOTYPE(pf_krule_global, pf_krule, entry_global, pf_krule_compare);
781
782 struct pf_krule {
783 struct pf_rule_addr src;
784 struct pf_rule_addr dst;
785 struct pf_krule *skip[PF_SKIP_COUNT];
786 char label[PF_RULE_MAX_LABEL_COUNT][PF_RULE_LABEL_SIZE];
787 uint32_t ridentifier;
788 char ifname[IFNAMSIZ];
789 char rcv_ifname[IFNAMSIZ];
790 char qname[PF_QNAME_SIZE];
791 char pqname[PF_QNAME_SIZE];
792 char tagname[PF_TAG_NAME_SIZE];
793 char match_tagname[PF_TAG_NAME_SIZE];
794
795 char overload_tblname[PF_TABLE_NAME_SIZE];
796
797 TAILQ_ENTRY(pf_krule) entries;
798 struct pf_kpool nat;
799 struct pf_kpool rdr;
800 struct pf_kpool route;
801 struct pf_kthreshold pktrate;
802
803 struct pf_counter_u64 evaluations;
804 struct pf_counter_u64 packets[2];
805 struct pf_counter_u64 bytes[2];
806 time_t *timestamp;
807
808 struct pfi_kkif *kif;
809 struct pfi_kkif *rcv_kif;
810 struct pf_kanchor *anchor;
811 struct pfr_ktable *overload_tbl;
812
813 pf_osfp_t os_fingerprint;
814
815 int32_t rtableid;
816 u_int32_t timeout[PFTM_MAX];
817 u_int32_t max_states;
818 u_int32_t max_src_nodes;
819 u_int32_t max_src_states;
820 u_int32_t max_src_conn;
821 struct {
822 u_int32_t limit;
823 u_int32_t seconds;
824 } max_src_conn_rate;
825 uint16_t max_pkt_size;
826 u_int16_t qid;
827 u_int16_t pqid;
828 u_int16_t dnpipe;
829 u_int16_t dnrpipe;
830 u_int32_t free_flags;
831 u_int32_t nr;
832 u_int32_t prob;
833 uid_t cuid;
834 pid_t cpid;
835
836 counter_u64_t states_cur;
837 counter_u64_t states_tot;
838 counter_u64_t src_nodes[PF_SN_MAX];
839
840 u_int16_t return_icmp;
841 u_int16_t return_icmp6;
842 u_int16_t max_mss;
843 u_int16_t tag;
844 u_int16_t match_tag;
845 u_int16_t scrub_flags;
846
847 struct pf_rule_uid uid;
848 struct pf_rule_gid gid;
849
850 u_int32_t rule_flag;
851 uint32_t rule_ref;
852 u_int8_t action;
853 u_int8_t direction;
854 u_int8_t log;
855 u_int8_t logif;
856 u_int8_t quick;
857 u_int8_t ifnot;
858 u_int8_t match_tag_not;
859 u_int8_t natpass;
860
861 u_int8_t keep_state;
862 sa_family_t af;
863 u_int8_t proto;
864 uint16_t type;
865 uint16_t code;
866 u_int8_t flags;
867 u_int8_t flagset;
868 u_int8_t min_ttl;
869 u_int8_t allow_opts;
870 u_int8_t rt;
871 u_int8_t return_ttl;
872 u_int8_t tos;
873 u_int8_t set_tos;
874 u_int8_t anchor_relative;
875 u_int8_t anchor_wildcard;
876
877 u_int8_t flush;
878 u_int8_t prio;
879 u_int8_t set_prio[2];
880 sa_family_t naf;
881 u_int8_t rcvifnot;
882
883 struct {
884 struct pf_addr addr;
885 u_int16_t port;
886 } divert;
887 u_int8_t md5sum[PF_MD5_DIGEST_LENGTH];
888 RB_ENTRY(pf_krule) entry_global;
889
890 #ifdef PF_WANT_32_TO_64_COUNTER
891 LIST_ENTRY(pf_krule) allrulelist;
892 bool allrulelinked;
893 #endif
894 };
895
896 struct pf_krule_item {
897 SLIST_ENTRY(pf_krule_item) entry;
898 struct pf_krule *r;
899 };
900
901 SLIST_HEAD(pf_krule_slist, pf_krule_item);
902
903 struct pf_ksrc_node {
904 LIST_ENTRY(pf_ksrc_node) entry;
905 struct pf_addr addr;
906 struct pf_addr raddr;
907 struct pf_krule_slist match_rules;
908 struct pf_krule *rule;
909 struct pfi_kkif *rkif;
910 counter_u64_t bytes[2];
911 counter_u64_t packets[2];
912 u_int32_t states;
913 u_int32_t conn;
914 struct pf_kthreshold conn_rate;
915 u_int32_t creation;
916 u_int32_t expire;
917 sa_family_t af;
918 sa_family_t raf;
919 u_int8_t ruletype;
920 pf_sn_types_t type;
921 struct mtx *lock;
922 };
923 #endif
924
925 struct pf_state_scrub {
926 struct timeval pfss_last; /* time received last packet */
927 u_int32_t pfss_tsecr; /* last echoed timestamp */
928 u_int32_t pfss_tsval; /* largest timestamp */
929 u_int32_t pfss_tsval0; /* original timestamp */
930 u_int16_t pfss_flags;
931 #define PFSS_TIMESTAMP 0x0001 /* modulate timestamp */
932 #define PFSS_PAWS 0x0010 /* stricter PAWS checks */
933 #define PFSS_PAWS_IDLED 0x0020 /* was idle too long. no PAWS */
934 #define PFSS_DATA_TS 0x0040 /* timestamp on data packets */
935 #define PFSS_DATA_NOTS 0x0080 /* no timestamp on data packets */
936 u_int8_t pfss_ttl; /* stashed TTL */
937 u_int8_t pad;
938 union {
939 u_int32_t pfss_ts_mod; /* timestamp modulation */
940 u_int32_t pfss_v_tag; /* SCTP verification tag */
941 };
942 };
943
944 struct pf_state_host {
945 struct pf_addr addr;
946 u_int16_t port;
947 u_int16_t pad;
948 };
949
950 struct pf_state_peer {
951 struct pf_state_scrub *scrub; /* state is scrubbed */
952 u_int32_t seqlo; /* Max sequence number sent */
953 u_int32_t seqhi; /* Max the other end ACKd + win */
954 u_int32_t seqdiff; /* Sequence number modulator */
955 u_int16_t max_win; /* largest window (pre scaling) */
956 u_int16_t mss; /* Maximum segment size option */
957 u_int8_t state; /* active state level */
958 u_int8_t wscale; /* window scaling factor */
959 u_int8_t tcp_est; /* Did we reach TCPS_ESTABLISHED */
960 u_int8_t pad[1];
961 };
962
963 /* Keep synced with struct pf_udp_endpoint. */
964 struct pf_udp_endpoint_cmp {
965 struct pf_addr addr;
966 uint16_t port;
967 sa_family_t af;
968 uint8_t pad[1];
969 };
970
971 struct pf_udp_endpoint {
972 struct pf_addr addr;
973 uint16_t port;
974 sa_family_t af;
975 uint8_t pad[1];
976
977 struct pf_udp_mapping *mapping;
978 LIST_ENTRY(pf_udp_endpoint) entry;
979 };
980
981 struct pf_udp_mapping {
982 struct pf_udp_endpoint endpoints[2];
983 u_int refs;
984 };
985
986 /* Keep synced with struct pf_state_key. */
987 struct pf_state_key_cmp {
988 struct pf_addr addr[2];
989 u_int16_t port[2];
990 sa_family_t af;
991 u_int8_t proto;
992 u_int8_t pad[2];
993 };
994
995 struct pf_state_key {
996 struct pf_addr addr[2];
997 u_int16_t port[2];
998 sa_family_t af;
999 u_int8_t proto;
1000 u_int8_t pad[2];
1001
1002 LIST_ENTRY(pf_state_key) entry;
1003 TAILQ_HEAD(, pf_kstate) states[2];
1004 };
1005
1006 #define PF_REVERSED_KEY(state, family) \
1007 (((state)->key[PF_SK_WIRE]->af != (state)->key[PF_SK_STACK]->af) && \
1008 ((state)->key[PF_SK_WIRE]->af != (family)) && \
1009 ((state)->direction == PF_IN))
1010
1011 /* Keep synced with struct pf_kstate. */
1012 struct pf_state_cmp {
1013 u_int64_t id;
1014 u_int32_t creatorid;
1015 u_int8_t direction;
1016 u_int8_t pad[3];
1017 };
1018
1019 struct pf_state_scrub_export {
1020 uint16_t pfss_flags;
1021 uint8_t pfss_ttl; /* stashed TTL */
1022 #define PF_SCRUB_FLAG_VALID 0x01
1023 uint8_t scrub_flag;
1024 uint32_t pfss_ts_mod; /* timestamp modulation */
1025 } __packed;
1026
1027 struct pf_state_key_export {
1028 struct pf_addr addr[2];
1029 uint16_t port[2];
1030 };
1031
1032 struct pf_state_peer_export {
1033 struct pf_state_scrub_export scrub; /* state is scrubbed */
1034 uint32_t seqlo; /* Max sequence number sent */
1035 uint32_t seqhi; /* Max the other end ACKd + win */
1036 uint32_t seqdiff; /* Sequence number modulator */
1037 uint16_t max_win; /* largest window (pre scaling) */
1038 uint16_t mss; /* Maximum segment size option */
1039 uint8_t state; /* active state level */
1040 uint8_t wscale; /* window scaling factor */
1041 uint8_t dummy[6];
1042 } __packed;
1043 _Static_assert(sizeof(struct pf_state_peer_export) == 32, "size incorrect");
1044
1045 struct pf_state_export {
1046 uint64_t version;
1047 #define PF_STATE_VERSION 20230404
1048 uint64_t id;
1049 char ifname[IFNAMSIZ];
1050 char orig_ifname[IFNAMSIZ];
1051 struct pf_state_key_export key[2];
1052 struct pf_state_peer_export src;
1053 struct pf_state_peer_export dst;
1054 struct pf_addr rt_addr;
1055 uint32_t rule;
1056 uint32_t anchor;
1057 uint32_t nat_rule;
1058 uint32_t creation;
1059 uint32_t expire;
1060 uint32_t spare0;
1061 uint64_t packets[2];
1062 uint64_t bytes[2];
1063 uint32_t creatorid;
1064 uint32_t spare1;
1065 sa_family_t af;
1066 uint8_t proto;
1067 uint8_t direction;
1068 uint8_t log;
1069 uint8_t state_flags_compat;
1070 uint8_t timeout;
1071 uint8_t sync_flags;
1072 uint8_t updates;
1073 uint16_t state_flags;
1074 uint16_t qid;
1075 uint16_t pqid;
1076 uint16_t dnpipe;
1077 uint16_t dnrpipe;
1078 int32_t rtableid;
1079 uint8_t min_ttl;
1080 uint8_t set_tos;
1081 uint16_t max_mss;
1082 uint8_t set_prio[2];
1083 uint8_t rt;
1084 char rt_ifname[IFNAMSIZ];
1085
1086 uint8_t spare[72];
1087 };
1088 _Static_assert(sizeof(struct pf_state_export) == 384, "size incorrect");
1089
1090 #ifdef _KERNEL
1091 struct pf_kstate {
1092 /*
1093 * Area shared with pf_state_cmp
1094 */
1095 u_int64_t id;
1096 u_int32_t creatorid;
1097 u_int8_t direction;
1098 u_int8_t pad[3];
1099 /*
1100 * end of the area
1101 */
1102
1103 u_int16_t state_flags;
1104 u_int8_t timeout;
1105 u_int8_t sync_state; /* PFSYNC_S_x */
1106 u_int8_t sync_updates;
1107 u_int refs;
1108 struct mtx *lock;
1109 TAILQ_ENTRY(pf_kstate) sync_list;
1110 TAILQ_ENTRY(pf_kstate) key_list[2];
1111 LIST_ENTRY(pf_kstate) entry;
1112 struct pf_state_peer src;
1113 struct pf_state_peer dst;
1114 struct pf_krule_slist match_rules;
1115 struct pf_krule *rule;
1116 struct pf_krule *anchor;
1117 struct pf_krule *nat_rule;
1118 struct pf_state_key *key[2]; /* addresses stack and wire */
1119 struct pf_udp_mapping *udp_mapping;
1120 struct pfi_kkif *kif;
1121 struct pfi_kkif *orig_kif; /* The real kif, even if we're a floating state (i.e. if == V_pfi_all). */
1122 struct pf_ksrc_node *sns[PF_SN_MAX];/* source nodes */
1123 u_int64_t packets[2];
1124 u_int64_t bytes[2];
1125 u_int64_t creation;
1126 u_int64_t expire;
1127 u_int32_t pfsync_time;
1128 struct pf_rule_actions act;
1129 u_int16_t tag;
1130 u_int16_t if_index_in;
1131 u_int16_t if_index_out;
1132 };
1133
1134 /*
1135 * 6 cache lines per struct, 10 structs per page.
1136 * Try to not grow the struct beyond that.
1137 */
1138 _Static_assert(sizeof(struct pf_kstate) <= 384, "pf_kstate size crosses 384 bytes");
1139
1140 enum pf_test_status {
1141 PF_TEST_FAIL = -1,
1142 PF_TEST_OK,
1143 PF_TEST_QUICK
1144 };
1145
1146 struct pf_test_ctx {
1147 enum pf_test_status test_status;
1148 struct pf_pdesc *pd;
1149 struct pf_rule_actions act;
1150 uint8_t icmpcode;
1151 uint8_t icmptype;
1152 int icmp_dir;
1153 int state_icmp;
1154 int tag;
1155 int rewrite;
1156 u_short reason;
1157 struct pf_src_node *sns[PF_SN_MAX];
1158 struct pf_krule_slist rules;
1159 struct pf_krule *nr;
1160 struct pf_krule *tr;
1161 struct pf_krule **rm;
1162 struct pf_krule *a;
1163 struct pf_krule **am;
1164 struct pf_kruleset **rsm;
1165 struct pf_kruleset *arsm;
1166 struct pf_kruleset *aruleset;
1167 struct pf_state_key *sk;
1168 struct pf_state_key *nk;
1169 struct tcphdr *th;
1170 struct pf_udp_mapping *udp_mapping;
1171 struct pf_kpool *nat_pool;
1172 uint16_t virtual_type;
1173 uint16_t virtual_id;
1174 int depth;
1175 };
1176
1177 #define PF_ANCHOR_STACK_MAX 32
1178 #endif
1179
1180 /*
1181 * Unified state structures for pulling states out of the kernel
1182 * used by pfsync(4) and the pf(4) ioctl.
1183 */
1184 struct pfsync_state_key {
1185 struct pf_addr addr[2];
1186 u_int16_t port[2];
1187 };
1188
1189 struct pfsync_state_1301 {
1190 u_int64_t id;
1191 char ifname[IFNAMSIZ];
1192 struct pfsync_state_key key[2];
1193 struct pf_state_peer_export src;
1194 struct pf_state_peer_export dst;
1195 struct pf_addr rt_addr;
1196 u_int32_t rule;
1197 u_int32_t anchor;
1198 u_int32_t nat_rule;
1199 u_int32_t creation;
1200 u_int32_t expire;
1201 u_int32_t packets[2][2];
1202 u_int32_t bytes[2][2];
1203 u_int32_t creatorid;
1204 sa_family_t af;
1205 u_int8_t proto;
1206 u_int8_t direction;
1207 u_int8_t __spare[2];
1208 u_int8_t log;
1209 u_int8_t state_flags;
1210 u_int8_t timeout;
1211 u_int8_t sync_flags;
1212 u_int8_t updates;
1213 } __packed;
1214
1215 struct pfsync_state_1400 {
1216 /* The beginning of the struct is compatible with previous versions */
1217 u_int64_t id;
1218 char ifname[IFNAMSIZ];
1219 struct pfsync_state_key key[2];
1220 struct pf_state_peer_export src;
1221 struct pf_state_peer_export dst;
1222 struct pf_addr rt_addr;
1223 u_int32_t rule;
1224 u_int32_t anchor;
1225 u_int32_t nat_rule;
1226 u_int32_t creation;
1227 u_int32_t expire;
1228 u_int32_t packets[2][2];
1229 u_int32_t bytes[2][2];
1230 u_int32_t creatorid;
1231 sa_family_t af;
1232 u_int8_t proto;
1233 u_int8_t direction;
1234 u_int16_t state_flags;
1235 u_int8_t log;
1236 u_int8_t __spare;
1237 u_int8_t timeout;
1238 u_int8_t sync_flags;
1239 u_int8_t updates;
1240 /* The rest is not */
1241 u_int16_t qid;
1242 u_int16_t pqid;
1243 u_int16_t dnpipe;
1244 u_int16_t dnrpipe;
1245 int32_t rtableid;
1246 u_int8_t min_ttl;
1247 u_int8_t set_tos;
1248 u_int16_t max_mss;
1249 u_int8_t set_prio[2];
1250 u_int8_t rt;
1251 char rt_ifname[IFNAMSIZ];
1252
1253 } __packed;
1254
1255 union pfsync_state_union {
1256 struct pfsync_state_1301 pfs_1301;
1257 struct pfsync_state_1400 pfs_1400;
1258 } __packed;
1259
1260 #ifdef _KERNEL
1261 /* pfsync */
1262 typedef int pfsync_state_import_t(union pfsync_state_union *, int, int);
1263 typedef void pfsync_insert_state_t(struct pf_kstate *);
1264 typedef void pfsync_update_state_t(struct pf_kstate *);
1265 typedef void pfsync_delete_state_t(struct pf_kstate *);
1266 typedef void pfsync_clear_states_t(u_int32_t, const char *);
1267 typedef int pfsync_defer_t(struct pf_kstate *, struct mbuf *);
1268 typedef void pfsync_detach_ifnet_t(struct ifnet *);
1269 typedef void pflow_export_state_t(const struct pf_kstate *);
1270 typedef bool pf_addr_filter_func_t(const sa_family_t, const struct pf_addr *);
1271
1272 VNET_DECLARE(pfsync_state_import_t *, pfsync_state_import_ptr);
1273 #define V_pfsync_state_import_ptr VNET(pfsync_state_import_ptr)
1274 VNET_DECLARE(pfsync_insert_state_t *, pfsync_insert_state_ptr);
1275 #define V_pfsync_insert_state_ptr VNET(pfsync_insert_state_ptr)
1276 VNET_DECLARE(pfsync_update_state_t *, pfsync_update_state_ptr);
1277 #define V_pfsync_update_state_ptr VNET(pfsync_update_state_ptr)
1278 VNET_DECLARE(pfsync_delete_state_t *, pfsync_delete_state_ptr);
1279 #define V_pfsync_delete_state_ptr VNET(pfsync_delete_state_ptr)
1280 VNET_DECLARE(pfsync_clear_states_t *, pfsync_clear_states_ptr);
1281 #define V_pfsync_clear_states_ptr VNET(pfsync_clear_states_ptr)
1282 VNET_DECLARE(pfsync_defer_t *, pfsync_defer_ptr);
1283 #define V_pfsync_defer_ptr VNET(pfsync_defer_ptr)
1284 VNET_DECLARE(pflow_export_state_t *, pflow_export_state_ptr);
1285 #define V_pflow_export_state_ptr VNET(pflow_export_state_ptr)
1286 extern pfsync_detach_ifnet_t *pfsync_detach_ifnet_ptr;
1287
1288 void pfsync_state_export(union pfsync_state_union *,
1289 struct pf_kstate *, int);
1290 void pf_state_export(struct pf_state_export *,
1291 struct pf_kstate *);
1292
1293 /* pflog */
1294 struct pf_kruleset;
1295 struct pf_pdesc;
1296 typedef int pflog_packet_t(uint8_t, u_int8_t,
1297 struct pf_krule *, struct pf_krule *, struct pf_kruleset *,
1298 struct pf_pdesc *, int, struct pf_krule *);
1299 extern pflog_packet_t *pflog_packet_ptr;
1300
1301 #endif /* _KERNEL */
1302
1303 #define PFSYNC_FLAG_SRCNODE 0x04
1304 #define PFSYNC_FLAG_NATSRCNODE 0x08
1305
1306 /* for copies to/from network byte order */
1307 /* ioctl interface also uses network byte order */
1308 void pf_state_peer_hton(const struct pf_state_peer *,
1309 struct pf_state_peer_export *);
1310 void pf_state_peer_ntoh(const struct pf_state_peer_export *,
1311 struct pf_state_peer *);
1312
1313 #define pf_state_counter_hton(s,d) do { \
1314 d[0] = htonl((s>>32)&0xffffffff); \
1315 d[1] = htonl(s&0xffffffff); \
1316 } while (0)
1317
1318 #define pf_state_counter_from_pfsync(s) \
1319 (((u_int64_t)(s[0])<<32) | (u_int64_t)(s[1]))
1320
1321 #define pf_state_counter_ntoh(s,d) do { \
1322 d = ntohl(s[0]); \
1323 d = d<<32; \
1324 d += ntohl(s[1]); \
1325 } while (0)
1326
1327 TAILQ_HEAD(pf_krulequeue, pf_krule);
1328
1329 struct pf_kanchor;
1330
1331 struct pf_kruleset {
1332 struct {
1333 struct pf_krulequeue queues[2];
1334 struct {
1335 struct pf_krulequeue *ptr;
1336 u_int32_t rcount;
1337 u_int32_t ticket;
1338 int open;
1339 struct pf_krule_global *tree;
1340 } active, inactive;
1341 } rules[PF_RULESET_MAX];
1342 struct pf_kanchor *anchor;
1343 u_int32_t tticket;
1344 int tables;
1345 int topen;
1346 };
1347
1348 RB_HEAD(pf_kanchor_global, pf_kanchor);
1349 RB_HEAD(pf_kanchor_node, pf_kanchor);
1350 struct pf_kanchor {
1351 RB_ENTRY(pf_kanchor) entry_global;
1352 RB_ENTRY(pf_kanchor) entry_node;
1353 struct pf_kanchor *parent;
1354 struct pf_kanchor_node children;
1355 char name[PF_ANCHOR_NAME_SIZE];
1356 char path[MAXPATHLEN];
1357 struct pf_kruleset ruleset;
1358 int refcnt; /* anchor rules */
1359 };
1360 RB_PROTOTYPE(pf_kanchor_global, pf_kanchor, entry_global, pf_anchor_compare);
1361 RB_PROTOTYPE(pf_kanchor_node, pf_kanchor, entry_node, pf_kanchor_compare);
1362
1363 #define PF_RESERVED_ANCHOR "_pf"
1364
1365 #define PFR_TFLAG_PERSIST 0x00000001
1366 #define PFR_TFLAG_CONST 0x00000002
1367 #define PFR_TFLAG_ACTIVE 0x00000004
1368 #define PFR_TFLAG_INACTIVE 0x00000008
1369 #define PFR_TFLAG_REFERENCED 0x00000010
1370 #define PFR_TFLAG_REFDANCHOR 0x00000020
1371 #define PFR_TFLAG_COUNTERS 0x00000040
1372 /* Adjust masks below when adding flags. */
1373 #define PFR_TFLAG_USRMASK (PFR_TFLAG_PERSIST | \
1374 PFR_TFLAG_CONST | \
1375 PFR_TFLAG_COUNTERS)
1376 #define PFR_TFLAG_SETMASK (PFR_TFLAG_ACTIVE | \
1377 PFR_TFLAG_INACTIVE | \
1378 PFR_TFLAG_REFERENCED | \
1379 PFR_TFLAG_REFDANCHOR)
1380 #define PFR_TFLAG_ALLMASK (PFR_TFLAG_PERSIST | \
1381 PFR_TFLAG_CONST | \
1382 PFR_TFLAG_ACTIVE | \
1383 PFR_TFLAG_INACTIVE | \
1384 PFR_TFLAG_REFERENCED | \
1385 PFR_TFLAG_REFDANCHOR | \
1386 PFR_TFLAG_COUNTERS)
1387
1388 struct pf_keth_anchor_stackframe;
1389
1390 struct pfr_table {
1391 char pfrt_anchor[MAXPATHLEN];
1392 char pfrt_name[PF_TABLE_NAME_SIZE];
1393 u_int32_t pfrt_flags;
1394 u_int8_t pfrt_fback;
1395 };
1396
1397 enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
1398 PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
1399 PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_NOCOUNT, PFR_FB_MAX };
1400
1401 struct pfr_addr {
1402 union {
1403 struct in_addr _pfra_ip4addr;
1404 struct in6_addr _pfra_ip6addr;
1405 } pfra_u;
1406 u_int8_t pfra_af;
1407 u_int8_t pfra_net;
1408 u_int8_t pfra_not;
1409 u_int8_t pfra_fback;
1410 };
1411 #define pfra_ip4addr pfra_u._pfra_ip4addr
1412 #define pfra_ip6addr pfra_u._pfra_ip6addr
1413
1414 enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
1415 enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
1416 enum { PFR_TYPE_PACKETS, PFR_TYPE_BYTES, PFR_TYPE_MAX };
1417 #define PFR_NUM_COUNTERS (PFR_DIR_MAX * PFR_OP_ADDR_MAX * PFR_TYPE_MAX)
1418 #define PFR_OP_XPASS PFR_OP_ADDR_MAX
1419
1420 struct pfr_astats {
1421 struct pfr_addr pfras_a;
1422 u_int64_t pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1423 u_int64_t pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1424 time_t pfras_tzero;
1425 };
1426
1427 enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
1428
1429 struct pfr_tstats {
1430 struct pfr_table pfrts_t;
1431 u_int64_t pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1432 u_int64_t pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1433 u_int64_t pfrts_match;
1434 u_int64_t pfrts_nomatch;
1435 time_t pfrts_tzero;
1436 int pfrts_cnt;
1437 int pfrts_refcnt[PFR_REFCNT_MAX];
1438 };
1439
1440 #ifdef _KERNEL
1441
1442 struct pfr_kstate_counter {
1443 counter_u64_t pkc_pcpu;
1444 u_int64_t pkc_zero;
1445 };
1446
1447 static inline int
pfr_kstate_counter_init(struct pfr_kstate_counter * pfrc,int flags)1448 pfr_kstate_counter_init(struct pfr_kstate_counter *pfrc, int flags)
1449 {
1450
1451 pfrc->pkc_zero = 0;
1452 pfrc->pkc_pcpu = counter_u64_alloc(flags);
1453 if (pfrc->pkc_pcpu == NULL)
1454 return (ENOMEM);
1455 return (0);
1456 }
1457
1458 static inline void
pfr_kstate_counter_deinit(struct pfr_kstate_counter * pfrc)1459 pfr_kstate_counter_deinit(struct pfr_kstate_counter *pfrc)
1460 {
1461
1462 counter_u64_free(pfrc->pkc_pcpu);
1463 }
1464
1465 static inline u_int64_t
pfr_kstate_counter_fetch(struct pfr_kstate_counter * pfrc)1466 pfr_kstate_counter_fetch(struct pfr_kstate_counter *pfrc)
1467 {
1468 u_int64_t c;
1469
1470 c = counter_u64_fetch(pfrc->pkc_pcpu);
1471 c -= pfrc->pkc_zero;
1472 return (c);
1473 }
1474
1475 static inline void
pfr_kstate_counter_zero(struct pfr_kstate_counter * pfrc)1476 pfr_kstate_counter_zero(struct pfr_kstate_counter *pfrc)
1477 {
1478 u_int64_t c;
1479
1480 c = counter_u64_fetch(pfrc->pkc_pcpu);
1481 pfrc->pkc_zero = c;
1482 }
1483
1484 static inline void
pfr_kstate_counter_add(struct pfr_kstate_counter * pfrc,int64_t n)1485 pfr_kstate_counter_add(struct pfr_kstate_counter *pfrc, int64_t n)
1486 {
1487
1488 counter_u64_add(pfrc->pkc_pcpu, n);
1489 }
1490
1491 struct pfr_ktstats {
1492 struct pfr_table pfrts_t;
1493 struct pfr_kstate_counter pfrkts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1494 struct pfr_kstate_counter pfrkts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1495 struct pfr_kstate_counter pfrkts_match;
1496 struct pfr_kstate_counter pfrkts_nomatch;
1497 time_t pfrkts_tzero;
1498 int pfrkts_cnt;
1499 int pfrkts_refcnt[PFR_REFCNT_MAX];
1500 };
1501
1502 #endif /* _KERNEL */
1503
1504 #define pfrts_name pfrts_t.pfrt_name
1505 #define pfrts_flags pfrts_t.pfrt_flags
1506
1507 #ifndef _SOCKADDR_UNION_DEFINED
1508 #define _SOCKADDR_UNION_DEFINED
1509 union sockaddr_union {
1510 struct sockaddr sa;
1511 struct sockaddr_in sin;
1512 struct sockaddr_in6 sin6;
1513 };
1514 #endif /* _SOCKADDR_UNION_DEFINED */
1515
1516 struct pfr_kcounters {
1517 counter_u64_t pfrkc_counters;
1518 time_t pfrkc_tzero;
1519 };
1520 #define pfr_kentry_counter(kc, dir, op, t) \
1521 ((kc)->pfrkc_counters + \
1522 (dir) * PFR_OP_ADDR_MAX * PFR_TYPE_MAX + (op) * PFR_TYPE_MAX + (t))
1523
1524 #ifdef _KERNEL
1525 SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
1526 struct pfr_kentry {
1527 struct radix_node pfrke_node[2];
1528 union sockaddr_union pfrke_sa;
1529 SLIST_ENTRY(pfr_kentry) pfrke_workq;
1530 struct pfr_kcounters pfrke_counters;
1531 u_int8_t pfrke_af;
1532 u_int8_t pfrke_net;
1533 u_int8_t pfrke_not;
1534 u_int8_t pfrke_mark;
1535 };
1536
1537 SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
1538 RB_HEAD(pfr_ktablehead, pfr_ktable);
1539 struct pfr_ktable {
1540 struct pfr_ktstats pfrkt_kts;
1541 RB_ENTRY(pfr_ktable) pfrkt_tree;
1542 SLIST_ENTRY(pfr_ktable) pfrkt_workq;
1543 struct radix_node_head *pfrkt_ip4;
1544 struct radix_node_head *pfrkt_ip6;
1545 struct pfr_ktable *pfrkt_shadow;
1546 struct pfr_ktable *pfrkt_root;
1547 struct pf_kruleset *pfrkt_rs;
1548 long pfrkt_larg;
1549 int pfrkt_nflags;
1550 };
1551 #define pfrkt_t pfrkt_kts.pfrts_t
1552 #define pfrkt_name pfrkt_t.pfrt_name
1553 #define pfrkt_anchor pfrkt_t.pfrt_anchor
1554 #define pfrkt_ruleset pfrkt_t.pfrt_ruleset
1555 #define pfrkt_flags pfrkt_t.pfrt_flags
1556 #define pfrkt_cnt pfrkt_kts.pfrkts_cnt
1557 #define pfrkt_refcnt pfrkt_kts.pfrkts_refcnt
1558 #define pfrkt_packets pfrkt_kts.pfrkts_packets
1559 #define pfrkt_bytes pfrkt_kts.pfrkts_bytes
1560 #define pfrkt_match pfrkt_kts.pfrkts_match
1561 #define pfrkt_nomatch pfrkt_kts.pfrkts_nomatch
1562 #define pfrkt_tzero pfrkt_kts.pfrkts_tzero
1563 #endif
1564
1565 #ifdef _KERNEL
1566 struct pfi_kkif {
1567 char pfik_name[IFNAMSIZ];
1568 union {
1569 RB_ENTRY(pfi_kkif) _pfik_tree;
1570 LIST_ENTRY(pfi_kkif) _pfik_list;
1571 } _pfik_glue;
1572 #define pfik_tree _pfik_glue._pfik_tree
1573 #define pfik_list _pfik_glue._pfik_list
1574 struct pf_counter_u64 pfik_packets[2][2][2];
1575 struct pf_counter_u64 pfik_bytes[2][2][2];
1576 time_t pfik_tzero;
1577 u_int pfik_flags;
1578 struct ifnet *pfik_ifp;
1579 struct ifg_group *pfik_group;
1580 u_int pfik_rulerefs;
1581 TAILQ_HEAD(, pfi_dynaddr) pfik_dynaddrs;
1582 #ifdef PF_WANT_32_TO_64_COUNTER
1583 LIST_ENTRY(pfi_kkif) pfik_allkiflist;
1584 #endif
1585 };
1586 #endif
1587
1588 #define PFI_IFLAG_REFS 0x0001 /* has state references */
1589 #define PFI_IFLAG_SKIP 0x0100 /* skip filtering on interface */
1590 #define PFI_IFLAG_ANY 0x0200 /* match any non-loopback interface */
1591
1592 #ifdef _KERNEL
1593 struct pf_sctp_multihome_job;
1594 TAILQ_HEAD(pf_sctp_multihome_jobs, pf_sctp_multihome_job);
1595
1596 struct pf_pdesc {
1597 struct {
1598 int done;
1599 uid_t uid;
1600 gid_t gid;
1601 } lookup;
1602 u_int64_t tot_len; /* Make Mickey money */
1603 union pf_headers {
1604 struct tcphdr tcp;
1605 struct udphdr udp;
1606 struct sctphdr sctp;
1607 struct icmp icmp;
1608 #ifdef INET6
1609 struct icmp6_hdr icmp6;
1610 #endif /* INET6 */
1611 char any[0];
1612 } hdr;
1613
1614 struct pf_addr nsaddr; /* src address after NAT */
1615 struct pf_addr ndaddr; /* dst address after NAT */
1616
1617 struct pfi_kkif *kif; /* incomming interface */
1618 struct mbuf *m;
1619
1620 struct pf_addr *src; /* src address */
1621 struct pf_addr *dst; /* dst address */
1622 struct pf_addr osrc;
1623 struct pf_addr odst;
1624 u_int16_t *pcksum; /* proto cksum */
1625 u_int16_t *sport;
1626 u_int16_t *dport;
1627 u_int16_t osport;
1628 u_int16_t odport;
1629 u_int16_t nsport; /* src port after NAT */
1630 u_int16_t ndport; /* dst port after NAT */
1631 struct pf_mtag *pf_mtag;
1632 struct pf_rule_actions act;
1633
1634 u_int32_t off; /* protocol header offset */
1635 bool df; /* IPv4 Don't fragment flag. */
1636 u_int32_t hdrlen; /* protocol header length */
1637 u_int32_t p_len; /* total length of protocol payload */
1638 u_int32_t extoff; /* extentsion header offset */
1639 u_int32_t fragoff; /* fragment header offset */
1640 u_int32_t jumbolen; /* length from v6 jumbo header */
1641 u_int32_t badopts; /* v4 options or v6 routing headers */
1642 #define PF_OPT_OTHER 0x0001
1643 #define PF_OPT_JUMBO 0x0002
1644 #define PF_OPT_ROUTER_ALERT 0x0004
1645
1646 u_int16_t *ip_sum;
1647 u_int16_t flags; /* Let SCRUB trigger behavior in
1648 * state code. Easier than tags */
1649 #define PFDESC_TCP_NORM 0x0001 /* TCP shall be statefully scrubbed */
1650 u_int16_t virtual_proto;
1651 #define PF_VPROTO_FRAGMENT 256
1652 sa_family_t af;
1653 sa_family_t naf;
1654 u_int8_t proto;
1655 u_int8_t tos;
1656 u_int8_t ttl;
1657 u_int8_t dir; /* direction */
1658 u_int8_t sidx; /* key index for source */
1659 u_int8_t didx; /* key index for destination */
1660 #define PFDESC_SCTP_INIT 0x0001
1661 #define PFDESC_SCTP_INIT_ACK 0x0002
1662 #define PFDESC_SCTP_COOKIE 0x0004
1663 #define PFDESC_SCTP_COOKIE_ACK 0x0008
1664 #define PFDESC_SCTP_ABORT 0x0010
1665 #define PFDESC_SCTP_SHUTDOWN 0x0020
1666 #define PFDESC_SCTP_SHUTDOWN_COMPLETE 0x0040
1667 #define PFDESC_SCTP_DATA 0x0080
1668 #define PFDESC_SCTP_ASCONF 0x0100
1669 #define PFDESC_SCTP_HEARTBEAT 0x0200
1670 #define PFDESC_SCTP_HEARTBEAT_ACK 0x0400
1671 #define PFDESC_SCTP_OTHER 0x0800
1672 #define PFDESC_SCTP_ADD_IP 0x1000
1673 u_int16_t sctp_flags;
1674 u_int32_t sctp_initiate_tag;
1675 u_int16_t sctp_dummy_sum;
1676 struct pf_krule *related_rule;
1677
1678 struct pf_sctp_multihome_jobs sctp_multihome_jobs;
1679 };
1680
1681 struct pf_sctp_multihome_job {
1682 TAILQ_ENTRY(pf_sctp_multihome_job) next;
1683 struct pf_pdesc pd;
1684 struct pf_addr src;
1685 struct pf_addr dst;
1686 int op;
1687 };
1688
1689 #endif
1690
1691 /* flags for RDR options */
1692 #define PF_DPORT_RANGE 0x01 /* Dest port uses range */
1693 #define PF_RPORT_RANGE 0x02 /* RDR'ed port uses range */
1694
1695 /* UDP state enumeration */
1696 #define PFUDPS_NO_TRAFFIC 0
1697 #define PFUDPS_SINGLE 1
1698 #define PFUDPS_MULTIPLE 2
1699
1700 #define PFUDPS_NSTATES 3 /* number of state levels */
1701
1702 #define PFUDPS_NAMES { \
1703 "NO_TRAFFIC", \
1704 "SINGLE", \
1705 "MULTIPLE", \
1706 NULL \
1707 }
1708
1709 /* Other protocol state enumeration */
1710 #define PFOTHERS_NO_TRAFFIC 0
1711 #define PFOTHERS_SINGLE 1
1712 #define PFOTHERS_MULTIPLE 2
1713
1714 #define PFOTHERS_NSTATES 3 /* number of state levels */
1715
1716 #define PFOTHERS_NAMES { \
1717 "NO_TRAFFIC", \
1718 "SINGLE", \
1719 "MULTIPLE", \
1720 NULL \
1721 }
1722
1723 #define ACTION_SET(a, x) \
1724 do { \
1725 if ((a) != NULL) \
1726 *(a) = (x); \
1727 } while (0)
1728
1729 #define REASON_SET(a, x) \
1730 do { \
1731 SDT_PROBE2(pf, , test, reason_set, x, __LINE__); \
1732 if ((a) != NULL) \
1733 *(a) = (x); \
1734 if (x < PFRES_MAX) \
1735 counter_u64_add(V_pf_status.counters[x], 1); \
1736 } while (0)
1737
1738 enum pf_syncookies_mode {
1739 PF_SYNCOOKIES_NEVER = 0,
1740 PF_SYNCOOKIES_ALWAYS = 1,
1741 PF_SYNCOOKIES_ADAPTIVE = 2,
1742 PF_SYNCOOKIES_MODE_MAX = PF_SYNCOOKIES_ADAPTIVE
1743 };
1744
1745 #define PF_SYNCOOKIES_HIWATPCT 25
1746 #define PF_SYNCOOKIES_LOWATPCT (PF_SYNCOOKIES_HIWATPCT / 2)
1747
1748 #ifdef _KERNEL
1749 struct pf_kstatus {
1750 counter_u64_t counters[PFRES_MAX]; /* reason for passing/dropping */
1751 counter_u64_t lcounters[KLCNT_MAX]; /* limit counters */
1752 struct pf_counter_u64 fcounters[FCNT_MAX]; /* state operation counters */
1753 counter_u64_t scounters[SCNT_MAX]; /* src_node operation counters */
1754 uint32_t states;
1755 uint32_t src_nodes;
1756 uint32_t running;
1757 uint32_t since;
1758 uint32_t debug;
1759 uint32_t hostid;
1760 char ifname[IFNAMSIZ];
1761 uint8_t pf_chksum[PF_MD5_DIGEST_LENGTH];
1762 bool keep_counters;
1763 enum pf_syncookies_mode syncookies_mode;
1764 bool syncookies_active;
1765 uint64_t syncookies_inflight[2];
1766 uint32_t states_halfopen;
1767 uint32_t reass;
1768 };
1769 #endif
1770
1771 struct pf_divert {
1772 union {
1773 struct in_addr ipv4;
1774 struct in6_addr ipv6;
1775 } addr;
1776 u_int16_t port;
1777 };
1778
1779 #define PFFRAG_FRENT_HIWAT 5000 /* Number of fragment entries */
1780 #define PFR_KENTRY_HIWAT 200000 /* Number of table entries */
1781
1782 struct pf_fragment_tag {
1783 uint16_t ft_hdrlen; /* header length of reassembled pkt */
1784 uint16_t ft_extoff; /* last extension header offset or 0 */
1785 uint16_t ft_maxlen; /* maximum fragment payload length */
1786 uint32_t ft_id; /* fragment id */
1787 };
1788
1789 /*
1790 * Limit the length of the fragment queue traversal. Remember
1791 * search entry points based on the fragment offset.
1792 */
1793 #define PF_FRAG_ENTRY_POINTS 16
1794
1795 /*
1796 * The number of entries in the fragment queue must be limited
1797 * to avoid DoS by linear searching. Instead of a global limit,
1798 * use a limit per entry point. For large packets these sum up.
1799 */
1800 #define PF_FRAG_ENTRY_LIMIT 64
1801
1802 /*
1803 * ioctl parameter structures
1804 */
1805
1806 struct pfioc_pooladdr {
1807 u_int32_t action;
1808 u_int32_t ticket;
1809 u_int32_t nr;
1810 u_int32_t r_num;
1811 u_int8_t r_action;
1812 u_int8_t r_last;
1813 u_int8_t af;
1814 char anchor[MAXPATHLEN];
1815 struct pf_pooladdr addr;
1816 };
1817
1818 struct pfioc_rule {
1819 u_int32_t action;
1820 u_int32_t ticket;
1821 u_int32_t pool_ticket;
1822 u_int32_t nr;
1823 char anchor[MAXPATHLEN];
1824 char anchor_call[MAXPATHLEN];
1825 struct pf_rule rule;
1826 };
1827
1828 struct pfioc_natlook {
1829 struct pf_addr saddr;
1830 struct pf_addr daddr;
1831 struct pf_addr rsaddr;
1832 struct pf_addr rdaddr;
1833 u_int16_t sport;
1834 u_int16_t dport;
1835 u_int16_t rsport;
1836 u_int16_t rdport;
1837 sa_family_t af;
1838 u_int8_t proto;
1839 u_int8_t direction;
1840 };
1841
1842 struct pfioc_state {
1843 struct pfsync_state_1301 state;
1844 };
1845
1846 struct pfioc_src_node_kill {
1847 sa_family_t psnk_af;
1848 struct pf_rule_addr psnk_src;
1849 struct pf_rule_addr psnk_dst;
1850 u_int psnk_killed;
1851 };
1852
1853 #ifdef _KERNEL
1854 struct pf_kstate_kill {
1855 struct pf_state_cmp psk_pfcmp;
1856 sa_family_t psk_af;
1857 int psk_proto;
1858 struct pf_rule_addr psk_src;
1859 struct pf_rule_addr psk_dst;
1860 struct pf_rule_addr psk_rt_addr;
1861 char psk_ifname[IFNAMSIZ];
1862 char psk_label[PF_RULE_LABEL_SIZE];
1863 u_int psk_killed;
1864 bool psk_kill_match;
1865 bool psk_nat;
1866 };
1867 #endif
1868
1869 struct pfioc_state_kill {
1870 struct pf_state_cmp psk_pfcmp;
1871 sa_family_t psk_af;
1872 int psk_proto;
1873 struct pf_rule_addr psk_src;
1874 struct pf_rule_addr psk_dst;
1875 char psk_ifname[IFNAMSIZ];
1876 char psk_label[PF_RULE_LABEL_SIZE];
1877 u_int psk_killed;
1878 };
1879
1880 struct pfioc_states {
1881 int ps_len;
1882 union {
1883 void *ps_buf;
1884 struct pfsync_state_1301 *ps_states;
1885 };
1886 };
1887
1888 struct pfioc_states_v2 {
1889 int ps_len;
1890 uint64_t ps_req_version;
1891 union {
1892 void *ps_buf;
1893 struct pf_state_export *ps_states;
1894 };
1895 };
1896
1897 struct pfioc_src_nodes {
1898 int psn_len;
1899 union {
1900 void *psn_buf;
1901 struct pf_src_node *psn_src_nodes;
1902 };
1903 };
1904
1905 struct pfioc_if {
1906 char ifname[IFNAMSIZ];
1907 };
1908
1909 struct pfioc_tm {
1910 int timeout;
1911 int seconds;
1912 };
1913
1914 struct pfioc_limit {
1915 int index;
1916 unsigned limit;
1917 };
1918
1919 struct pfioc_altq_v0 {
1920 u_int32_t action;
1921 u_int32_t ticket;
1922 u_int32_t nr;
1923 struct pf_altq_v0 altq;
1924 };
1925
1926 struct pfioc_altq_v1 {
1927 u_int32_t action;
1928 u_int32_t ticket;
1929 u_int32_t nr;
1930 /*
1931 * Placed here so code that only uses the above parameters can be
1932 * written entirely in terms of the v0 or v1 type.
1933 */
1934 u_int32_t version;
1935 struct pf_altq_v1 altq;
1936 };
1937
1938 /*
1939 * Latest version of struct pfioc_altq_vX. This must move in lock-step with
1940 * the latest version of struct pf_altq_vX as it has that struct as a
1941 * member.
1942 */
1943 #define PFIOC_ALTQ_VERSION PF_ALTQ_VERSION
1944
1945 struct pfioc_qstats_v0 {
1946 u_int32_t ticket;
1947 u_int32_t nr;
1948 void *buf;
1949 int nbytes;
1950 u_int8_t scheduler;
1951 };
1952
1953 struct pfioc_qstats_v1 {
1954 u_int32_t ticket;
1955 u_int32_t nr;
1956 void *buf;
1957 int nbytes;
1958 u_int8_t scheduler;
1959 /*
1960 * Placed here so code that only uses the above parameters can be
1961 * written entirely in terms of the v0 or v1 type.
1962 */
1963 u_int32_t version; /* Requested version of stats struct */
1964 };
1965
1966 /* Latest version of struct pfioc_qstats_vX */
1967 #define PFIOC_QSTATS_VERSION 1
1968
1969 struct pfioc_ruleset {
1970 u_int32_t nr;
1971 char path[MAXPATHLEN];
1972 char name[PF_ANCHOR_NAME_SIZE];
1973 };
1974
1975 #define PF_RULESET_ALTQ (PF_RULESET_MAX)
1976 #define PF_RULESET_TABLE (PF_RULESET_MAX+1)
1977 #define PF_RULESET_ETH (PF_RULESET_MAX+2)
1978 struct pfioc_trans {
1979 int size; /* number of elements */
1980 int esize; /* size of each element in bytes */
1981 struct pfioc_trans_e {
1982 int rs_num;
1983 char anchor[MAXPATHLEN];
1984 u_int32_t ticket;
1985 } *array;
1986 };
1987
1988 #define PFR_FLAG_ATOMIC 0x00000001 /* unused */
1989 #define PFR_FLAG_DUMMY 0x00000002
1990 #define PFR_FLAG_FEEDBACK 0x00000004
1991 #define PFR_FLAG_CLSTATS 0x00000008
1992 #define PFR_FLAG_ADDRSTOO 0x00000010
1993 #define PFR_FLAG_REPLACE 0x00000020
1994 #define PFR_FLAG_ALLRSETS 0x00000040
1995 #define PFR_FLAG_ALLMASK 0x0000007F
1996 #ifdef _KERNEL
1997 #define PFR_FLAG_USERIOCTL 0x10000000
1998 #endif
1999
2000 struct pfioc_table {
2001 struct pfr_table pfrio_table;
2002 void *pfrio_buffer;
2003 int pfrio_esize;
2004 int pfrio_size;
2005 int pfrio_size2;
2006 int pfrio_nadd;
2007 int pfrio_ndel;
2008 int pfrio_nchange;
2009 int pfrio_flags;
2010 u_int32_t pfrio_ticket;
2011 };
2012 #define pfrio_exists pfrio_nadd
2013 #define pfrio_nzero pfrio_nadd
2014 #define pfrio_nmatch pfrio_nadd
2015 #define pfrio_naddr pfrio_size2
2016 #define pfrio_setflag pfrio_size2
2017 #define pfrio_clrflag pfrio_nadd
2018
2019 struct pfioc_iface {
2020 char pfiio_name[IFNAMSIZ];
2021 void *pfiio_buffer;
2022 int pfiio_esize;
2023 int pfiio_size;
2024 int pfiio_nzero;
2025 int pfiio_flags;
2026 };
2027
2028 /*
2029 * ioctl operations
2030 */
2031
2032 #define DIOCSTART _IO ('D', 1)
2033 #define DIOCSTOP _IO ('D', 2)
2034 #define DIOCADDRULE _IOWR('D', 4, struct pfioc_rule)
2035 #define DIOCADDRULENV _IOWR('D', 4, struct pfioc_nv)
2036 #define DIOCGETRULES _IOWR('D', 6, struct pfioc_rule)
2037 #define DIOCGETRULENV _IOWR('D', 7, struct pfioc_nv)
2038 #define DIOCCLRSTATESNV _IOWR('D', 18, struct pfioc_nv)
2039 #define DIOCGETSTATE _IOWR('D', 19, struct pfioc_state)
2040 #define DIOCGETSTATENV _IOWR('D', 19, struct pfioc_nv)
2041 #define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_if)
2042 #define DIOCGETSTATUSNV _IOWR('D', 21, struct pfioc_nv)
2043 #define DIOCCLRSTATUS _IO ('D', 22)
2044 #define DIOCNATLOOK _IOWR('D', 23, struct pfioc_natlook)
2045 #define DIOCSETDEBUG _IOWR('D', 24, u_int32_t)
2046 #ifdef COMPAT_FREEBSD14
2047 #define DIOCGETSTATES _IOWR('D', 25, struct pfioc_states)
2048 #endif
2049 #define DIOCCHANGERULE _IOWR('D', 26, struct pfioc_rule)
2050 #define DIOCSETTIMEOUT _IOWR('D', 29, struct pfioc_tm)
2051 #define DIOCGETTIMEOUT _IOWR('D', 30, struct pfioc_tm)
2052 #define DIOCADDSTATE _IOWR('D', 37, struct pfioc_state)
2053 #define DIOCCLRRULECTRS _IO ('D', 38)
2054 #define DIOCGETLIMIT _IOWR('D', 39, struct pfioc_limit)
2055 #define DIOCSETLIMIT _IOWR('D', 40, struct pfioc_limit)
2056 #define DIOCKILLSTATESNV _IOWR('D', 41, struct pfioc_nv)
2057 #define DIOCSTARTALTQ _IO ('D', 42)
2058 #define DIOCSTOPALTQ _IO ('D', 43)
2059 #define DIOCADDALTQV0 _IOWR('D', 45, struct pfioc_altq_v0)
2060 #define DIOCADDALTQV1 _IOWR('D', 45, struct pfioc_altq_v1)
2061 #define DIOCGETALTQSV0 _IOWR('D', 47, struct pfioc_altq_v0)
2062 #define DIOCGETALTQSV1 _IOWR('D', 47, struct pfioc_altq_v1)
2063 #define DIOCGETALTQV0 _IOWR('D', 48, struct pfioc_altq_v0)
2064 #define DIOCGETALTQV1 _IOWR('D', 48, struct pfioc_altq_v1)
2065 #define DIOCCHANGEALTQV0 _IOWR('D', 49, struct pfioc_altq_v0)
2066 #define DIOCCHANGEALTQV1 _IOWR('D', 49, struct pfioc_altq_v1)
2067 #define DIOCGETQSTATSV0 _IOWR('D', 50, struct pfioc_qstats_v0)
2068 #define DIOCGETQSTATSV1 _IOWR('D', 50, struct pfioc_qstats_v1)
2069 #define DIOCBEGINADDRS _IOWR('D', 51, struct pfioc_pooladdr)
2070 #define DIOCADDADDR _IOWR('D', 52, struct pfioc_pooladdr)
2071 #define DIOCGETADDRS _IOWR('D', 53, struct pfioc_pooladdr)
2072 #define DIOCGETADDR _IOWR('D', 54, struct pfioc_pooladdr)
2073 #define DIOCCHANGEADDR _IOWR('D', 55, struct pfioc_pooladdr)
2074 #define DIOCGETRULESETS _IOWR('D', 58, struct pfioc_ruleset)
2075 #define DIOCGETRULESET _IOWR('D', 59, struct pfioc_ruleset)
2076 #define DIOCRCLRTABLES _IOWR('D', 60, struct pfioc_table)
2077 #define DIOCRADDTABLES _IOWR('D', 61, struct pfioc_table)
2078 #define DIOCRDELTABLES _IOWR('D', 62, struct pfioc_table)
2079 #define DIOCRGETTABLES _IOWR('D', 63, struct pfioc_table)
2080 #define DIOCRGETTSTATS _IOWR('D', 64, struct pfioc_table)
2081 #define DIOCRCLRTSTATS _IOWR('D', 65, struct pfioc_table)
2082 #define DIOCRCLRADDRS _IOWR('D', 66, struct pfioc_table)
2083 #define DIOCRADDADDRS _IOWR('D', 67, struct pfioc_table)
2084 #define DIOCRDELADDRS _IOWR('D', 68, struct pfioc_table)
2085 #define DIOCRSETADDRS _IOWR('D', 69, struct pfioc_table)
2086 #define DIOCRGETADDRS _IOWR('D', 70, struct pfioc_table)
2087 #define DIOCRGETASTATS _IOWR('D', 71, struct pfioc_table)
2088 #define DIOCRCLRASTATS _IOWR('D', 72, struct pfioc_table)
2089 #define DIOCRTSTADDRS _IOWR('D', 73, struct pfioc_table)
2090 #define DIOCRSETTFLAGS _IOWR('D', 74, struct pfioc_table)
2091 #define DIOCRINADEFINE _IOWR('D', 77, struct pfioc_table)
2092 #define DIOCOSFPFLUSH _IO('D', 78)
2093 #define DIOCOSFPADD _IOWR('D', 79, struct pf_osfp_ioctl)
2094 #define DIOCOSFPGET _IOWR('D', 80, struct pf_osfp_ioctl)
2095 #define DIOCXBEGIN _IOWR('D', 81, struct pfioc_trans)
2096 #define DIOCXCOMMIT _IOWR('D', 82, struct pfioc_trans)
2097 #define DIOCXROLLBACK _IOWR('D', 83, struct pfioc_trans)
2098 #define DIOCGETSRCNODES _IOWR('D', 84, struct pfioc_src_nodes)
2099 #define DIOCCLRSRCNODES _IO('D', 85)
2100 #define DIOCSETHOSTID _IOWR('D', 86, u_int32_t)
2101 #define DIOCIGETIFACES _IOWR('D', 87, struct pfioc_iface)
2102 #define DIOCSETIFFLAG _IOWR('D', 89, struct pfioc_iface)
2103 #define DIOCCLRIFFLAG _IOWR('D', 90, struct pfioc_iface)
2104 #define DIOCKILLSRCNODES _IOWR('D', 91, struct pfioc_src_node_kill)
2105 #define DIOCGIFSPEEDV0 _IOWR('D', 92, struct pf_ifspeed_v0)
2106 #define DIOCGIFSPEEDV1 _IOWR('D', 92, struct pf_ifspeed_v1)
2107 #ifdef COMPAT_FREEBSD14
2108 #define DIOCGETSTATESV2 _IOWR('D', 93, struct pfioc_states_v2)
2109 #endif
2110 #define DIOCGETSYNCOOKIES _IOWR('D', 94, struct pfioc_nv)
2111 #define DIOCSETSYNCOOKIES _IOWR('D', 95, struct pfioc_nv)
2112 #define DIOCKEEPCOUNTERS _IOWR('D', 96, struct pfioc_nv)
2113 #define DIOCKEEPCOUNTERS_FREEBSD13 _IOWR('D', 92, struct pfioc_nv)
2114 #define DIOCADDETHRULE _IOWR('D', 97, struct pfioc_nv)
2115 #define DIOCGETETHRULE _IOWR('D', 98, struct pfioc_nv)
2116 #define DIOCGETETHRULES _IOWR('D', 99, struct pfioc_nv)
2117 #define DIOCGETETHRULESETS _IOWR('D', 100, struct pfioc_nv)
2118 #define DIOCGETETHRULESET _IOWR('D', 101, struct pfioc_nv)
2119 #define DIOCSETREASS _IOWR('D', 102, u_int32_t)
2120
2121 struct pf_ifspeed_v0 {
2122 char ifname[IFNAMSIZ];
2123 u_int32_t baudrate;
2124 };
2125
2126 struct pf_ifspeed_v1 {
2127 char ifname[IFNAMSIZ];
2128 u_int32_t baudrate32;
2129 /* layout identical to struct pf_ifspeed_v0 up to this point */
2130 u_int64_t baudrate;
2131 };
2132
2133 /* Latest version of struct pf_ifspeed_vX */
2134 #define PF_IFSPEED_VERSION 1
2135
2136 /*
2137 * Compatibility and convenience macros
2138 */
2139 #ifndef _KERNEL
2140 #ifdef PFIOC_USE_LATEST
2141 /*
2142 * Maintaining in-tree consumers of the ioctl interface is easier when that
2143 * code can be written in terms old names that refer to the latest interface
2144 * version as that reduces the required changes in the consumers to those
2145 * that are functionally necessary to accommodate a new interface version.
2146 */
2147 #define pfioc_altq __CONCAT(pfioc_altq_v, PFIOC_ALTQ_VERSION)
2148 #define pfioc_qstats __CONCAT(pfioc_qstats_v, PFIOC_QSTATS_VERSION)
2149 #define pf_ifspeed __CONCAT(pf_ifspeed_v, PF_IFSPEED_VERSION)
2150
2151 #define DIOCADDALTQ __CONCAT(DIOCADDALTQV, PFIOC_ALTQ_VERSION)
2152 #define DIOCGETALTQS __CONCAT(DIOCGETALTQSV, PFIOC_ALTQ_VERSION)
2153 #define DIOCGETALTQ __CONCAT(DIOCGETALTQV, PFIOC_ALTQ_VERSION)
2154 #define DIOCCHANGEALTQ __CONCAT(DIOCCHANGEALTQV, PFIOC_ALTQ_VERSION)
2155 #define DIOCGETQSTATS __CONCAT(DIOCGETQSTATSV, PFIOC_QSTATS_VERSION)
2156 #define DIOCGIFSPEED __CONCAT(DIOCGIFSPEEDV, PF_IFSPEED_VERSION)
2157 #else
2158 /*
2159 * When building out-of-tree code that is written for the old interface,
2160 * such as may exist in ports for example, resolve the old struct tags and
2161 * ioctl command names to the v0 versions.
2162 */
2163 #define pfioc_altq __CONCAT(pfioc_altq_v, 0)
2164 #define pfioc_qstats __CONCAT(pfioc_qstats_v, 0)
2165 #define pf_ifspeed __CONCAT(pf_ifspeed_v, 0)
2166
2167 #define DIOCADDALTQ __CONCAT(DIOCADDALTQV, 0)
2168 #define DIOCGETALTQS __CONCAT(DIOCGETALTQSV, 0)
2169 #define DIOCGETALTQ __CONCAT(DIOCGETALTQV, 0)
2170 #define DIOCCHANGEALTQ __CONCAT(DIOCCHANGEALTQV, 0)
2171 #define DIOCGETQSTATS __CONCAT(DIOCGETQSTATSV, 0)
2172 #define DIOCGIFSPEED __CONCAT(DIOCGIFSPEEDV, 0)
2173 #endif /* PFIOC_USE_LATEST */
2174 #endif /* _KERNEL */
2175
2176 #ifdef _KERNEL
2177 LIST_HEAD(pf_ksrc_node_list, pf_ksrc_node);
2178 struct pf_srchash {
2179 struct pf_ksrc_node_list nodes;
2180 struct mtx lock;
2181 };
2182
2183 struct pf_keyhash {
2184 LIST_HEAD(, pf_state_key) keys;
2185 struct mtx lock;
2186 };
2187
2188 struct pf_idhash {
2189 LIST_HEAD(, pf_kstate) states;
2190 struct mtx lock;
2191 };
2192
2193 struct pf_udpendpointhash {
2194 LIST_HEAD(, pf_udp_endpoint) endpoints;
2195 /* refcont is synchronized on the source endpoint's row lock */
2196 struct mtx lock;
2197 };
2198
2199 extern u_long pf_ioctl_maxcount;
2200 VNET_DECLARE(u_long, pf_hashmask);
2201 #define V_pf_hashmask VNET(pf_hashmask)
2202 VNET_DECLARE(u_long, pf_srchashmask);
2203 #define V_pf_srchashmask VNET(pf_srchashmask)
2204 VNET_DECLARE(u_long, pf_udpendpointhashmask);
2205 #define V_pf_udpendpointhashmask VNET(pf_udpendpointhashmask)
2206 #define PF_HASHSIZ (131072)
2207 #define PF_SRCHASHSIZ (PF_HASHSIZ/4)
2208 #define PF_UDPENDHASHSIZ (PF_HASHSIZ/4)
2209 VNET_DECLARE(struct pf_keyhash *, pf_keyhash);
2210 VNET_DECLARE(struct pf_idhash *, pf_idhash);
2211 VNET_DECLARE(struct pf_udpendpointhash *, pf_udpendpointhash);
2212 #define V_pf_keyhash VNET(pf_keyhash)
2213 #define V_pf_idhash VNET(pf_idhash)
2214 #define V_pf_udpendpointhash VNET(pf_udpendpointhash)
2215 VNET_DECLARE(struct pf_srchash *, pf_srchash);
2216 #define V_pf_srchash VNET(pf_srchash)
2217
2218 #define PF_IDHASHID(id) (be64toh(id) % (V_pf_hashmask + 1))
2219 #define PF_IDHASH(s) PF_IDHASHID((s)->id)
2220
2221 VNET_DECLARE(void *, pf_swi_cookie);
2222 #define V_pf_swi_cookie VNET(pf_swi_cookie)
2223 VNET_DECLARE(struct intr_event *, pf_swi_ie);
2224 #define V_pf_swi_ie VNET(pf_swi_ie)
2225
2226 VNET_DECLARE(struct unrhdr64, pf_stateid);
2227 #define V_pf_stateid VNET(pf_stateid)
2228
2229 TAILQ_HEAD(pf_altqqueue, pf_altq);
2230 VNET_DECLARE(struct pf_altqqueue, pf_altqs[4]);
2231 #define V_pf_altqs VNET(pf_altqs)
2232 VNET_DECLARE(struct pf_kpalist, pf_pabuf[3]);
2233 #define V_pf_pabuf VNET(pf_pabuf)
2234
2235 VNET_DECLARE(u_int32_t, ticket_altqs_active);
2236 #define V_ticket_altqs_active VNET(ticket_altqs_active)
2237 VNET_DECLARE(u_int32_t, ticket_altqs_inactive);
2238 #define V_ticket_altqs_inactive VNET(ticket_altqs_inactive)
2239 VNET_DECLARE(int, altqs_inactive_open);
2240 #define V_altqs_inactive_open VNET(altqs_inactive_open)
2241 VNET_DECLARE(u_int32_t, ticket_pabuf);
2242 #define V_ticket_pabuf VNET(ticket_pabuf)
2243 VNET_DECLARE(struct pf_altqqueue *, pf_altqs_active);
2244 #define V_pf_altqs_active VNET(pf_altqs_active)
2245 VNET_DECLARE(struct pf_altqqueue *, pf_altq_ifs_active);
2246 #define V_pf_altq_ifs_active VNET(pf_altq_ifs_active)
2247 VNET_DECLARE(struct pf_altqqueue *, pf_altqs_inactive);
2248 #define V_pf_altqs_inactive VNET(pf_altqs_inactive)
2249 VNET_DECLARE(struct pf_altqqueue *, pf_altq_ifs_inactive);
2250 #define V_pf_altq_ifs_inactive VNET(pf_altq_ifs_inactive)
2251
2252 VNET_DECLARE(struct pf_krulequeue, pf_unlinked_rules);
2253 #define V_pf_unlinked_rules VNET(pf_unlinked_rules)
2254
2255 #ifdef PF_WANT_32_TO_64_COUNTER
2256 LIST_HEAD(allkiflist_head, pfi_kkif);
2257 VNET_DECLARE(struct allkiflist_head, pf_allkiflist);
2258 #define V_pf_allkiflist VNET(pf_allkiflist)
2259 VNET_DECLARE(size_t, pf_allkifcount);
2260 #define V_pf_allkifcount VNET(pf_allkifcount)
2261 VNET_DECLARE(struct pfi_kkif *, pf_kifmarker);
2262 #define V_pf_kifmarker VNET(pf_kifmarker)
2263
2264 LIST_HEAD(allrulelist_head, pf_krule);
2265 VNET_DECLARE(struct allrulelist_head, pf_allrulelist);
2266 #define V_pf_allrulelist VNET(pf_allrulelist)
2267 VNET_DECLARE(size_t, pf_allrulecount);
2268 #define V_pf_allrulecount VNET(pf_allrulecount)
2269 VNET_DECLARE(struct pf_krule *, pf_rulemarker);
2270 #define V_pf_rulemarker VNET(pf_rulemarker)
2271 #endif
2272
2273 int pf_start(void);
2274 int pf_stop(void);
2275 void pf_initialize(void);
2276 void pf_mtag_initialize(void);
2277 void pf_mtag_cleanup(void);
2278 void pf_cleanup(void);
2279
2280 struct pf_mtag *pf_get_mtag(struct mbuf *);
2281
2282 extern void pf_calc_skip_steps(struct pf_krulequeue *);
2283 #ifdef ALTQ
2284 extern void pf_altq_ifnet_event(struct ifnet *, int);
2285 #endif
2286 VNET_DECLARE(uma_zone_t, pf_state_z);
2287 #define V_pf_state_z VNET(pf_state_z)
2288 VNET_DECLARE(uma_zone_t, pf_state_key_z);
2289 #define V_pf_state_key_z VNET(pf_state_key_z)
2290 VNET_DECLARE(uma_zone_t, pf_udp_mapping_z);
2291 #define V_pf_udp_mapping_z VNET(pf_udp_mapping_z)
2292 VNET_DECLARE(uma_zone_t, pf_state_scrub_z);
2293 #define V_pf_state_scrub_z VNET(pf_state_scrub_z)
2294 VNET_DECLARE(uma_zone_t, pf_anchor_z);
2295 #define V_pf_anchor_z VNET(pf_anchor_z)
2296 VNET_DECLARE(uma_zone_t, pf_eth_anchor_z);
2297 #define V_pf_eth_anchor_z VNET(pf_eth_anchor_z)
2298
2299 extern void pf_purge_thread(void *);
2300 extern void pf_unload_vnet_purge(void);
2301 extern void pf_intr(void *);
2302 extern void pf_purge_expired_src_nodes(void);
2303
2304 extern int pf_remove_state(struct pf_kstate *);
2305 extern int pf_state_insert(struct pfi_kkif *,
2306 struct pfi_kkif *,
2307 struct pf_state_key *,
2308 struct pf_state_key *,
2309 struct pf_kstate *);
2310 extern struct pf_kstate *pf_alloc_state(int);
2311 extern void pf_free_state(struct pf_kstate *);
2312 extern void pf_killstates(struct pf_kstate_kill *,
2313 unsigned int *);
2314 extern unsigned int pf_clear_states(const struct pf_kstate_kill *);
2315
2316 static __inline void
pf_ref_state(struct pf_kstate * s)2317 pf_ref_state(struct pf_kstate *s)
2318 {
2319
2320 refcount_acquire(&s->refs);
2321 }
2322
2323 static __inline int
pf_release_state(struct pf_kstate * s)2324 pf_release_state(struct pf_kstate *s)
2325 {
2326
2327 if (refcount_release(&s->refs)) {
2328 pf_free_state(s);
2329 return (1);
2330 } else
2331 return (0);
2332 }
2333
2334 static __inline int
pf_release_staten(struct pf_kstate * s,u_int n)2335 pf_release_staten(struct pf_kstate *s, u_int n)
2336 {
2337
2338 if (refcount_releasen(&s->refs, n)) {
2339 pf_free_state(s);
2340 return (1);
2341 } else
2342 return (0);
2343 }
2344
2345 static __inline uint64_t
pf_get_uptime(void)2346 pf_get_uptime(void)
2347 {
2348 struct timeval t;
2349 microuptime(&t);
2350 return ((t.tv_sec * 1000) + (t.tv_usec / 1000));
2351 }
2352
2353 static __inline uint64_t
pf_get_time(void)2354 pf_get_time(void)
2355 {
2356 struct timeval t;
2357 microtime(&t);
2358 return ((t.tv_sec * 1000) + (t.tv_usec / 1000));
2359 }
2360
2361 extern struct pf_kstate *pf_find_state_byid(uint64_t, uint32_t);
2362 extern struct pf_kstate *pf_find_state_all(
2363 const struct pf_state_key_cmp *,
2364 u_int, int *);
2365 extern bool pf_find_state_all_exists(
2366 const struct pf_state_key_cmp *,
2367 u_int);
2368 extern struct pf_udp_mapping *pf_udp_mapping_find(struct pf_udp_endpoint_cmp
2369 *endpoint);
2370 extern struct pf_udp_mapping *pf_udp_mapping_create(sa_family_t af,
2371 struct pf_addr *src_addr, uint16_t src_port,
2372 struct pf_addr *nat_addr, uint16_t nat_port);
2373 extern int pf_udp_mapping_insert(struct pf_udp_mapping
2374 *mapping);
2375 extern void pf_udp_mapping_release(struct pf_udp_mapping
2376 *mapping);
2377 uint32_t pf_hashsrc(struct pf_addr *, sa_family_t);
2378 extern bool pf_src_node_exists(struct pf_ksrc_node **,
2379 struct pf_srchash *);
2380 extern struct pf_ksrc_node *pf_find_src_node(struct pf_addr *,
2381 struct pf_krule *, sa_family_t,
2382 struct pf_srchash **, pf_sn_types_t, bool);
2383 extern void pf_unlink_src_node(struct pf_ksrc_node *);
2384 extern u_int pf_free_src_nodes(struct pf_ksrc_node_list *);
2385 extern void pf_print_state(struct pf_kstate *);
2386 extern void pf_print_flags(uint16_t);
2387 extern int pf_addr_wrap_neq(struct pf_addr_wrap *,
2388 struct pf_addr_wrap *);
2389 extern u_int16_t pf_cksum_fixup(u_int16_t, u_int16_t, u_int16_t,
2390 u_int8_t);
2391 extern u_int16_t pf_proto_cksum_fixup(struct mbuf *, u_int16_t,
2392 u_int16_t, u_int16_t, u_int8_t);
2393
2394 VNET_DECLARE(struct ifnet *, sync_ifp);
2395 #define V_sync_ifp VNET(sync_ifp);
2396 VNET_DECLARE(struct pf_krule, pf_default_rule);
2397 #define V_pf_default_rule VNET(pf_default_rule)
2398 extern void pf_addrcpy(struct pf_addr *, const struct pf_addr *,
2399 sa_family_t);
2400 void pf_free_rule(struct pf_krule *);
2401
2402 int pf_test_eth(int, int, struct ifnet *, struct mbuf **, struct inpcb *);
2403 int pf_scan_sctp(struct pf_pdesc *);
2404 #if defined(INET) || defined(INET6)
2405 int pf_test(sa_family_t, int, int, struct ifnet *, struct mbuf **, struct inpcb *,
2406 struct pf_rule_actions *);
2407 #endif
2408 #ifdef INET
2409 int pf_normalize_ip(u_short *, struct pf_pdesc *);
2410 #endif /* INET */
2411
2412 void pf_poolmask(struct pf_addr *, struct pf_addr*,
2413 struct pf_addr *, struct pf_addr *, sa_family_t);
2414 void pf_addr_inc(struct pf_addr *, sa_family_t);
2415 #ifdef INET6
2416 int pf_normalize_ip6(int, u_short *, struct pf_pdesc *);
2417 int pf_max_frag_size(struct mbuf *);
2418 int pf_refragment6(struct ifnet *, struct mbuf **, struct m_tag *,
2419 struct ifnet *, bool);
2420 #endif /* INET6 */
2421
2422 int pf_multihome_scan_init(int, int, struct pf_pdesc *);
2423 int pf_multihome_scan_asconf(int, int, struct pf_pdesc *);
2424
2425 u_int32_t pf_new_isn(struct pf_kstate *);
2426 void *pf_pull_hdr(const struct mbuf *, int, void *, int, u_short *, u_short *,
2427 sa_family_t);
2428 void pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
2429 void pf_change_proto_a(struct mbuf *, void *, u_int16_t *, u_int32_t,
2430 u_int8_t);
2431 void pf_change_tcp_a(struct mbuf *, void *, u_int16_t *, u_int32_t);
2432 int pf_patch_16(struct pf_pdesc *, void *, u_int16_t, bool);
2433 int pf_patch_32(struct pf_pdesc *, void *, u_int32_t, bool);
2434 void pf_send_deferred_syn(struct pf_kstate *);
2435 int pf_match_addr(u_int8_t, const struct pf_addr *,
2436 const struct pf_addr *, const struct pf_addr *, sa_family_t);
2437 int pf_match_addr_range(const struct pf_addr *, const struct pf_addr *,
2438 const struct pf_addr *, sa_family_t);
2439 int pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
2440
2441 void pf_normalize_init(void);
2442 void pf_normalize_cleanup(void);
2443 int pf_normalize_tcp(struct pf_pdesc *);
2444 void pf_normalize_tcp_cleanup(struct pf_kstate *);
2445 int pf_normalize_tcp_init(struct pf_pdesc *,
2446 struct tcphdr *, struct pf_state_peer *);
2447 int pf_normalize_tcp_stateful(struct pf_pdesc *,
2448 u_short *, struct tcphdr *, struct pf_kstate *,
2449 struct pf_state_peer *, struct pf_state_peer *, int *);
2450 int pf_normalize_sctp_init(struct pf_pdesc *,
2451 struct pf_state_peer *, struct pf_state_peer *);
2452 int pf_normalize_sctp(struct pf_pdesc *);
2453 u_int32_t
2454 pf_state_expires(const struct pf_kstate *);
2455 void pf_purge_expired_fragments(void);
2456 void pf_purge_fragments(uint32_t);
2457 int pf_routable(struct pf_addr *addr, sa_family_t af, struct pfi_kkif *,
2458 int);
2459 int pf_socket_lookup(struct pf_pdesc *);
2460 struct pf_state_key *pf_alloc_state_key(int);
2461 int pf_translate(struct pf_pdesc *, struct pf_addr *, u_int16_t,
2462 struct pf_addr *, u_int16_t, u_int16_t, int);
2463 int pf_translate_af(struct pf_pdesc *);
2464 bool pf_init_threshold(struct pf_kthreshold *, uint32_t, uint32_t);
2465
2466 void pfr_initialize(void);
2467 void pfr_cleanup(void);
2468 int pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
2469 void pfr_update_stats(struct pfr_ktable *, struct pf_addr *, sa_family_t,
2470 u_int64_t, int, int, int);
2471 int pfr_pool_get(struct pfr_ktable *, int *, struct pf_addr *, sa_family_t,
2472 pf_addr_filter_func_t, bool);
2473 void pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
2474 struct pfr_ktable *
2475 pfr_attach_table(struct pf_kruleset *, char *);
2476 struct pfr_ktable *
2477 pfr_eth_attach_table(struct pf_keth_ruleset *, char *);
2478 void pfr_detach_table(struct pfr_ktable *);
2479 int pfr_clr_tables(struct pfr_table *, int *, int);
2480 int pfr_add_tables(struct pfr_table *, int, int *, int);
2481 int pfr_del_tables(struct pfr_table *, int, int *, int);
2482 int pfr_table_count(struct pfr_table *, int);
2483 int pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
2484 int pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
2485 int pfr_clr_tstats(struct pfr_table *, int, int *, int);
2486 int pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
2487 int pfr_clr_addrs(struct pfr_table *, int *, int);
2488 int pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *, time_t);
2489 int pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
2490 int);
2491 int pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
2492 int);
2493 int pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
2494 int *, int *, int *, int, u_int32_t);
2495 int pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
2496 int pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
2497 int pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
2498 int);
2499 int pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
2500 int);
2501 int pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
2502 int pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
2503 int pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
2504 int pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
2505 int *, u_int32_t, int);
2506 struct pfr_ktable
2507 *pfr_ktable_select_active(struct pfr_ktable *);
2508
2509 MALLOC_DECLARE(PFI_MTYPE);
2510 VNET_DECLARE(struct pfi_kkif *, pfi_all);
2511 #define V_pfi_all VNET(pfi_all)
2512
2513 void pfi_initialize(void);
2514 void pfi_initialize_vnet(void);
2515 void pfi_cleanup(void);
2516 void pfi_cleanup_vnet(void);
2517 void pfi_kkif_ref(struct pfi_kkif *);
2518 void pfi_kkif_unref(struct pfi_kkif *);
2519 struct pfi_kkif *pfi_kkif_find(const char *);
2520 struct pfi_kkif *pfi_kkif_attach(struct pfi_kkif *, const char *);
2521 int pfi_kkif_match(struct pfi_kkif *, struct pfi_kkif *);
2522 void pfi_kkif_purge(void);
2523 int pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
2524 sa_family_t);
2525 int pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
2526 void pfi_dynaddr_remove(struct pfi_dynaddr *);
2527 void pfi_dynaddr_copyout(struct pf_addr_wrap *);
2528 void pfi_update_status(const char *, struct pf_status *);
2529 void pfi_get_ifaces(const char *, struct pfi_kif *, int *);
2530 int pfi_set_flags(const char *, int);
2531 int pfi_clear_flags(const char *, int);
2532
2533 int pf_match_tag(struct mbuf *, struct pf_krule *, int *, int);
2534 int pf_tag_packet(struct pf_pdesc *, int);
2535 int pf_addr_cmp(struct pf_addr *, struct pf_addr *,
2536 sa_family_t);
2537
2538 uint8_t* pf_find_tcpopt(u_int8_t *, u_int8_t *, size_t,
2539 u_int8_t, u_int8_t);
2540 u_int16_t pf_get_mss(struct pf_pdesc *);
2541 u_int8_t pf_get_wscale(struct pf_pdesc *);
2542 struct mbuf *pf_build_tcp(const struct pf_krule *, sa_family_t,
2543 const struct pf_addr *, const struct pf_addr *,
2544 u_int16_t, u_int16_t, u_int32_t, u_int32_t,
2545 u_int8_t, u_int16_t, u_int16_t, u_int8_t, int,
2546 u_int16_t, u_int16_t, u_int, int);
2547 void pf_send_tcp(const struct pf_krule *, sa_family_t,
2548 const struct pf_addr *, const struct pf_addr *,
2549 u_int16_t, u_int16_t, u_int32_t, u_int32_t,
2550 u_int8_t, u_int16_t, u_int16_t, u_int8_t, int,
2551 u_int16_t, u_int16_t, int);
2552
2553 void pf_syncookies_init(void);
2554 void pf_syncookies_cleanup(void);
2555 int pf_get_syncookies(struct pfioc_nv *);
2556 int pf_set_syncookies(struct pfioc_nv *);
2557 int pf_synflood_check(struct pf_pdesc *);
2558 void pf_syncookie_send(struct pf_pdesc *);
2559 bool pf_syncookie_check(struct pf_pdesc *);
2560 u_int8_t pf_syncookie_validate(struct pf_pdesc *);
2561 struct mbuf * pf_syncookie_recreate_syn(struct pf_pdesc *);
2562
2563 VNET_DECLARE(struct pf_kstatus, pf_status);
2564 #define V_pf_status VNET(pf_status)
2565
2566 struct pf_limit {
2567 uma_zone_t zone;
2568 u_int limit;
2569 };
2570 VNET_DECLARE(struct pf_limit, pf_limits[PF_LIMIT_MAX]);
2571 #define V_pf_limits VNET(pf_limits)
2572
2573 #endif /* _KERNEL */
2574
2575 #ifdef _KERNEL
2576 struct pf_nl_pooladdr {
2577 u_int32_t action;
2578 u_int32_t ticket;
2579 u_int32_t nr;
2580 u_int32_t r_num;
2581 u_int8_t r_action;
2582 u_int8_t r_last;
2583 u_int8_t af;
2584 char anchor[MAXPATHLEN];
2585 struct pf_pooladdr addr;
2586 /* Above this is identical to pfioc_pooladdr */
2587 int which;
2588 };
2589
2590 VNET_DECLARE(struct pf_kanchor_global, pf_anchors);
2591 #define V_pf_anchors VNET(pf_anchors)
2592 VNET_DECLARE(struct pf_kanchor, pf_main_anchor);
2593 #define V_pf_main_anchor VNET(pf_main_anchor)
2594 VNET_DECLARE(struct pf_keth_anchor_global, pf_keth_anchors);
2595 #define V_pf_keth_anchors VNET(pf_keth_anchors)
2596 #define pf_main_ruleset V_pf_main_anchor.ruleset
2597
2598 VNET_DECLARE(struct pf_keth_anchor, pf_main_keth_anchor);
2599 #define V_pf_main_keth_anchor VNET(pf_main_keth_anchor)
2600 VNET_DECLARE(struct pf_keth_ruleset*, pf_keth);
2601 #define V_pf_keth VNET(pf_keth)
2602
2603 void pf_init_kruleset(struct pf_kruleset *);
2604 void pf_init_keth(struct pf_keth_ruleset *);
2605 int pf_kanchor_setup(struct pf_krule *,
2606 const struct pf_kruleset *, const char *);
2607 int pf_kanchor_copyout(const struct pf_kruleset *,
2608 const struct pf_krule *, char *, size_t);
2609 int pf_kanchor_nvcopyout(const struct pf_kruleset *,
2610 const struct pf_krule *, nvlist_t *);
2611 void pf_remove_kanchor(struct pf_krule *);
2612 void pf_remove_if_empty_kruleset(struct pf_kruleset *);
2613 struct pf_kruleset *pf_find_kruleset(const char *);
2614 struct pf_kruleset *pf_get_leaf_kruleset(char *, char **);
2615 struct pf_kruleset *pf_find_or_create_kruleset(const char *);
2616 void pf_rs_initialize(void);
2617 void pf_rule_tree_free(struct pf_krule_global *);
2618
2619
2620 struct pf_krule *pf_krule_alloc(void);
2621
2622 void pf_remove_if_empty_keth_ruleset(
2623 struct pf_keth_ruleset *);
2624 struct pf_keth_ruleset *pf_find_keth_ruleset(const char *);
2625 struct pf_keth_anchor *pf_find_keth_anchor(const char *);
2626 int pf_keth_anchor_setup(struct pf_keth_rule *,
2627 const struct pf_keth_ruleset *, const char *);
2628 int pf_keth_anchor_nvcopyout(
2629 const struct pf_keth_ruleset *,
2630 const struct pf_keth_rule *, nvlist_t *);
2631 struct pf_keth_ruleset *pf_find_or_create_keth_ruleset(const char *);
2632 void pf_keth_anchor_remove(struct pf_keth_rule *);
2633
2634 int pf_ioctl_getrules(struct pfioc_rule *);
2635 int pf_ioctl_addrule(struct pf_krule *, uint32_t,
2636 uint32_t, const char *, const char *, uid_t uid,
2637 pid_t);
2638 void pf_ioctl_clear_status(void);
2639 int pf_ioctl_get_timeout(int, int *);
2640 int pf_ioctl_set_timeout(int, int, int *);
2641 int pf_ioctl_get_limit(int, unsigned int *);
2642 int pf_ioctl_set_limit(int, unsigned int, unsigned int *);
2643 int pf_ioctl_begin_addrs(uint32_t *);
2644 int pf_ioctl_add_addr(struct pf_nl_pooladdr *);
2645 int pf_ioctl_get_addrs(struct pf_nl_pooladdr *);
2646 int pf_ioctl_get_addr(struct pf_nl_pooladdr *);
2647 int pf_ioctl_get_rulesets(struct pfioc_ruleset *);
2648 int pf_ioctl_get_ruleset(struct pfioc_ruleset *);
2649 int pf_ioctl_natlook(struct pfioc_natlook *);
2650
2651 void pf_krule_free(struct pf_krule *);
2652 void pf_krule_clear_counters(struct pf_krule *);
2653 void pf_addr_copyout(struct pf_addr_wrap *);
2654 #endif
2655
2656 /* The fingerprint functions can be linked into userland programs (tcpdump) */
2657 int pf_osfp_add(struct pf_osfp_ioctl *);
2658 #ifdef _KERNEL
2659 struct pf_osfp_enlist *
2660 pf_osfp_fingerprint(struct pf_pdesc *, const struct tcphdr *);
2661 #endif /* _KERNEL */
2662 void pf_osfp_flush(void);
2663 int pf_osfp_get(struct pf_osfp_ioctl *);
2664 int pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
2665
2666 #ifdef _KERNEL
2667 void pf_print_host(struct pf_addr *, u_int16_t, sa_family_t);
2668
2669 enum pf_test_status pf_step_into_anchor(struct pf_test_ctx *, struct pf_krule *);
2670 enum pf_test_status pf_match_rule(struct pf_test_ctx *, struct pf_kruleset *);
2671 void pf_step_into_keth_anchor(struct pf_keth_anchor_stackframe *,
2672 int *, struct pf_keth_ruleset **,
2673 struct pf_keth_rule **, struct pf_keth_rule **,
2674 int *);
2675 int pf_step_out_of_keth_anchor(struct pf_keth_anchor_stackframe *,
2676 int *, struct pf_keth_ruleset **,
2677 struct pf_keth_rule **, struct pf_keth_rule **,
2678 int *);
2679
2680 u_short pf_map_addr(sa_family_t, struct pf_krule *,
2681 struct pf_addr *, struct pf_addr *,
2682 struct pfi_kkif **nkif, sa_family_t *,
2683 struct pf_addr *, struct pf_kpool *);
2684 u_short pf_map_addr_sn(u_int8_t, struct pf_krule *,
2685 struct pf_addr *, struct pf_addr *,
2686 sa_family_t *, struct pfi_kkif **,
2687 struct pf_addr *, struct pf_kpool *,
2688 pf_sn_types_t);
2689 int pf_get_transaddr_af(struct pf_krule *,
2690 struct pf_pdesc *);
2691 u_short pf_get_translation(struct pf_test_ctx *);
2692 u_short pf_get_transaddr(struct pf_test_ctx *,
2693 struct pf_krule *,
2694 u_int8_t, struct pf_kpool *);
2695 int pf_translate_compat(struct pf_test_ctx *);
2696
2697 int pf_state_key_setup(struct pf_pdesc *,
2698 u_int16_t, u_int16_t,
2699 struct pf_state_key **sk, struct pf_state_key **nk);
2700 struct pf_state_key *pf_state_key_clone(const struct pf_state_key *);
2701 void pf_rule_to_actions(struct pf_krule *,
2702 struct pf_rule_actions *);
2703 int pf_normalize_mss(struct pf_pdesc *pd);
2704 #if defined(INET) || defined(INET6)
2705 void pf_scrub(struct pf_pdesc *);
2706 #endif
2707
2708 struct pfi_kkif *pf_kkif_create(int);
2709 void pf_kkif_free(struct pfi_kkif *);
2710 void pf_kkif_zero(struct pfi_kkif *);
2711
2712
2713 /* NAT64 functions. */
2714 int inet_nat64(int, const void *, void *, const void *, u_int8_t);
2715 int inet_nat64_inet(const void *, void *, const void *, u_int8_t);
2716 int inet_nat64_inet6(const void *, void *, const void *, u_int8_t);
2717
2718 int inet_nat46(int, const void *, void *, const void *, u_int8_t);
2719 int inet_nat46_inet(const void *, void *, const void *, u_int8_t);
2720 int inet_nat46_inet6(const void *, void *, const void *, u_int8_t);
2721
2722 #endif /* _KERNEL */
2723
2724 #endif /* _NET_PFVAR_H_ */
2725