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