1 /* 2 * Copyright (c) 2007-2024 Apple Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5 * 6 * This file contains Original Code and/or Modifications of Original Code 7 * as defined in and that are subject to the Apple Public Source License 8 * Version 2.0 (the 'License'). You may not use this file except in 9 * compliance with the License. The rights granted to you under the License 10 * may not be used to create, or enable the creation or redistribution of, 11 * unlawful or unlicensed copies of an Apple operating system, or to 12 * circumvent, violate, or enable the circumvention or violation of, any 13 * terms of an Apple operating system software license agreement. 14 * 15 * Please obtain a copy of the License at 16 * http://www.opensource.apple.com/apsl/ and read it before using this file. 17 * 18 * The Original Code and all software distributed under the License are 19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23 * Please see the License for the specific language governing rights and 24 * limitations under the License. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28 29 /* $apfw: git commit b6bf13f8321283cd7ee82b1795e86506084b1b95 $ */ 30 /* $OpenBSD: pfvar.h,v 1.259 2007/12/02 12:08:04 pascoe Exp $ */ 31 32 /* 33 * Copyright (c) 2001 Daniel Hartmeier 34 * NAT64 - Copyright (c) 2010 Viagenie Inc. (http://www.viagenie.ca) 35 * All rights reserved. 36 * 37 * Redistribution and use in source and binary forms, with or without 38 * modification, are permitted provided that the following conditions 39 * are met: 40 * 41 * - Redistributions of source code must retain the above copyright 42 * notice, this list of conditions and the following disclaimer. 43 * - Redistributions in binary form must reproduce the above 44 * copyright notice, this list of conditions and the following 45 * disclaimer in the documentation and/or other materials provided 46 * with the distribution. 47 * 48 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 49 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 50 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 51 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 52 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 53 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 54 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 55 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 56 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 57 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 58 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 59 * POSSIBILITY OF SUCH DAMAGE. 60 * 61 */ 62 63 #ifndef _NET_PFVAR_H_ 64 #define _NET_PFVAR_H_ 65 66 #ifdef PRIVATE 67 /* 68 * XXX 69 * XXX Private interfaces. Do not include this file; use pfctl(8) instead. 70 * XXX 71 */ 72 #if PF || !defined(KERNEL) 73 74 #ifdef __cplusplus 75 extern "C" { 76 #endif 77 78 #include <stdbool.h> 79 #include <sys/param.h> 80 #include <sys/types.h> 81 #include <sys/queue.h> 82 #include <libkern/tree.h> 83 84 #include <netinet/in.h> 85 #include <net/if_var.h> 86 #ifdef KERNEL 87 #include <net/radix.h> 88 #include <kern/kern_types.h> 89 #include <kern/zalloc.h> 90 #include <kern/locks.h> 91 92 #include <machine/endian.h> 93 #include <sys/systm.h> 94 #include <net/pf_pbuf.h> 95 96 #if SKYWALK 97 #include <netinet/in_pcb.h> 98 #include <skywalk/namespace/netns.h> 99 #endif 100 101 #include <netinet/tcp.h> 102 #include <netinet/udp.h> 103 #include <netinet/ip_icmp.h> 104 #include <netinet/icmp6.h> 105 106 #if BYTE_ORDER == BIG_ENDIAN 107 #define htobe64(x) (x) 108 #else /* LITTLE ENDIAN */ 109 #define htobe64(x) __DARWIN_OSSwapInt64(x) 110 #endif /* LITTLE_ENDIAN */ 111 112 #define be64toh(x) htobe64(x) 113 114 extern lck_rw_t pf_perim_lock; 115 extern lck_mtx_t pf_lock; 116 117 struct pool { 118 struct zone *pool_zone; /* pointer to backend zone */ 119 const char *pool_name; /* name of pool */ 120 unsigned int pool_count; /* # of outstanding elements */ 121 unsigned int pool_hiwat; /* high watermark */ 122 unsigned int pool_limit; /* hard limit */ 123 unsigned int pool_fails; /* # of failed allocs due to limit */ 124 }; 125 126 #define PR_NOWAIT FALSE 127 #define PR_WAITOK TRUE 128 129 __private_extern__ void pool_init(struct pool *, size_t, unsigned int, 130 unsigned int, int, const char *, void *); 131 __private_extern__ void pool_destroy(struct pool *); 132 __private_extern__ void pool_sethiwat(struct pool *, int); 133 __private_extern__ void pool_sethardlimit(struct pool *, int, 134 const char *, int); 135 __private_extern__ void *pool_get(struct pool *, int); 136 __private_extern__ void pool_put(struct pool *, void *); 137 __private_extern__ u_int64_t pf_time_second(void); 138 __private_extern__ u_int64_t pf_calendar_time_second(void); 139 #endif /* KERNEL */ 140 141 union sockaddr_union { 142 struct sockaddr sa; 143 struct sockaddr_in sin; 144 struct sockaddr_in6 sin6; 145 }; 146 147 #define PF_TCPS_PROXY_SRC ((TCP_NSTATES)+0) 148 #define PF_TCPS_PROXY_DST ((TCP_NSTATES)+1) 149 150 #define PF_MD5_DIGEST_LENGTH 16 151 #ifdef MD5_DIGEST_LENGTH 152 #if PF_MD5_DIGEST_LENGTH != MD5_DIGEST_LENGTH 153 #error 154 #endif /* PF_MD5_DIGEST_LENGTH != MD5_DIGEST_LENGTH */ 155 #endif /* MD5_DIGEST_LENGTH */ 156 157 #ifdef KERNEL 158 struct pf_grev1_hdr { 159 u_int16_t flags; 160 u_int16_t protocol_type; 161 u_int16_t payload_length; 162 u_int16_t call_id; 163 }; 164 165 struct pf_esp_hdr { 166 u_int32_t spi; 167 u_int32_t seqno; 168 }; 169 #endif /* KERNEL */ 170 171 #define PF_GRE_PPTP_VARIANT 0x01 172 173 enum { PF_INOUT, PF_IN, PF_OUT }; 174 enum { PF_PASS, PF_DROP, PF_SCRUB, PF_NOSCRUB, PF_NAT, PF_NONAT, 175 PF_BINAT, PF_NOBINAT, PF_RDR, PF_NORDR, PF_SYNPROXY_DROP, 176 PF_DUMMYNET, PF_NODUMMYNET, PF_NAT64, PF_NONAT64 }; 177 enum { PF_RULESET_SCRUB, PF_RULESET_FILTER, PF_RULESET_NAT, 178 PF_RULESET_BINAT, PF_RULESET_RDR, PF_RULESET_DUMMYNET, 179 PF_RULESET_MAX }; 180 enum { PF_OP_NONE, PF_OP_IRG, PF_OP_EQ, PF_OP_NE, PF_OP_LT, 181 PF_OP_LE, PF_OP_GT, PF_OP_GE, PF_OP_XRG, PF_OP_RRG }; 182 enum { PF_DEBUG_NONE, PF_DEBUG_URGENT, PF_DEBUG_MISC, PF_DEBUG_NOISY }; 183 enum { PF_CHANGE_NONE, PF_CHANGE_ADD_HEAD, PF_CHANGE_ADD_TAIL, 184 PF_CHANGE_ADD_BEFORE, PF_CHANGE_ADD_AFTER, 185 PF_CHANGE_REMOVE, PF_CHANGE_GET_TICKET }; 186 enum { PF_GET_NONE, PF_GET_CLR_CNTR }; 187 188 /* 189 * Note about PFTM_*: real indices into pf_rule.timeout[] come before 190 * PFTM_MAX, special cases afterwards. See pf_state_expires(). 191 */ 192 enum { PFTM_TCP_FIRST_PACKET, PFTM_TCP_OPENING, PFTM_TCP_ESTABLISHED, 193 PFTM_TCP_CLOSING, PFTM_TCP_FIN_WAIT, PFTM_TCP_CLOSED, 194 PFTM_UDP_FIRST_PACKET, PFTM_UDP_SINGLE, PFTM_UDP_MULTIPLE, 195 PFTM_ICMP_FIRST_PACKET, PFTM_ICMP_ERROR_REPLY, 196 PFTM_GREv1_FIRST_PACKET, PFTM_GREv1_INITIATING, 197 PFTM_GREv1_ESTABLISHED, PFTM_ESP_FIRST_PACKET, PFTM_ESP_INITIATING, 198 PFTM_ESP_ESTABLISHED, PFTM_OTHER_FIRST_PACKET, PFTM_OTHER_SINGLE, 199 PFTM_OTHER_MULTIPLE, PFTM_FRAG, PFTM_INTERVAL, 200 PFTM_ADAPTIVE_START, PFTM_ADAPTIVE_END, PFTM_SRC_NODE, 201 PFTM_TS_DIFF, PFTM_MAX, PFTM_PURGE, PFTM_UNLINKED }; 202 203 /* PFTM default values */ 204 #define PFTM_TCP_FIRST_PACKET_VAL 120 /* First TCP packet */ 205 #define PFTM_TCP_OPENING_VAL 30 /* No response yet */ 206 #define PFTM_TCP_ESTABLISHED_VAL (24 * 60 * 60) /* Established */ 207 #define PFTM_TCP_CLOSING_VAL (15 * 60) /* Half closed */ 208 #define PFTM_TCP_FIN_WAIT_VAL 45 /* Got both FINs */ 209 #define PFTM_TCP_CLOSED_VAL 90 /* Got a RST */ 210 #define PFTM_UDP_FIRST_PACKET_VAL 60 /* First UDP packet */ 211 #define PFTM_UDP_SINGLE_VAL 30 /* Unidirectional */ 212 #define PFTM_UDP_MULTIPLE_VAL 60 /* Bidirectional */ 213 #define PFTM_ICMP_FIRST_PACKET_VAL 20 /* First ICMP packet */ 214 #define PFTM_ICMP_ERROR_REPLY_VAL 10 /* Got error response */ 215 #define PFTM_GREv1_FIRST_PACKET_VAL 120 216 #define PFTM_GREv1_INITIATING_VAL 30 217 #define PFTM_GREv1_ESTABLISHED_VAL 1800 218 #define PFTM_ESP_FIRST_PACKET_VAL 120 219 #define PFTM_ESP_INITIATING_VAL 30 220 #define PFTM_ESP_ESTABLISHED_VAL 900 221 #define PFTM_OTHER_FIRST_PACKET_VAL 60 /* First packet */ 222 #define PFTM_OTHER_SINGLE_VAL 30 /* Unidirectional */ 223 #define PFTM_OTHER_MULTIPLE_VAL 60 /* Bidirectional */ 224 #define PFTM_FRAG_VAL 30 /* Fragment expire */ 225 #define PFTM_INTERVAL_VAL 10 /* Expire interval */ 226 #define PFTM_SRC_NODE_VAL 0 /* Source tracking */ 227 #define PFTM_TS_DIFF_VAL 30 /* Allowed TS diff */ 228 229 enum { PF_NOPFROUTE, PF_FASTROUTE, PF_ROUTETO, PF_DUPTO, PF_REPLYTO }; 230 enum { PF_LIMIT_STATES, 231 PF_LIMIT_APP_STATES, 232 PF_LIMIT_SRC_NODES, PF_LIMIT_FRAGS, 233 PF_LIMIT_TABLES, PF_LIMIT_TABLE_ENTRIES, PF_LIMIT_MAX }; 234 #define PF_POOL_IDMASK 0x0f 235 enum { PF_POOL_NONE, PF_POOL_BITMASK, PF_POOL_RANDOM, 236 PF_POOL_SRCHASH, PF_POOL_ROUNDROBIN }; 237 enum { PF_ADDR_ADDRMASK, PF_ADDR_NOROUTE, PF_ADDR_DYNIFTL, 238 PF_ADDR_TABLE, PF_ADDR_RTLABEL, PF_ADDR_URPFFAILED, 239 PF_ADDR_RANGE }; 240 #define PF_POOL_TYPEMASK 0x0f 241 #define PF_POOL_STICKYADDR 0x20 242 #define PF_WSCALE_FLAG 0x80 243 #define PF_WSCALE_MASK 0x0f 244 245 #define PF_LOG 0x01 246 #define PF_LOG_ALL 0x02 247 #define PF_LOG_SOCKET_LOOKUP 0x04 248 249 struct pf_addr { 250 union { 251 struct in_addr _v4addr; 252 struct in6_addr _v6addr; 253 u_int8_t _addr8[16]; 254 u_int16_t _addr16[8]; 255 u_int32_t _addr32[4]; 256 } pfa; /* 128-bit address */ 257 #define v4addr pfa._v4addr 258 #define v6addr pfa._v6addr 259 #define addr8 pfa._addr8 260 #define addr16 pfa._addr16 261 #define addr32 pfa._addr32 262 }; 263 264 #define PF_TABLE_NAME_SIZE 32 265 266 #define PFI_AFLAG_NETWORK 0x01 267 #define PFI_AFLAG_BROADCAST 0x02 268 #define PFI_AFLAG_PEER 0x04 269 #define PFI_AFLAG_MODEMASK 0x07 270 #define PFI_AFLAG_NOALIAS 0x08 271 272 #ifndef RTLABEL_LEN 273 #define RTLABEL_LEN 32 274 #endif 275 276 struct pf_addr_wrap { 277 union { 278 struct { 279 struct pf_addr addr; 280 struct pf_addr mask; 281 } a; 282 char ifname[IFNAMSIZ]; 283 char tblname[PF_TABLE_NAME_SIZE]; 284 char rtlabelname[RTLABEL_LEN]; 285 u_int32_t rtlabel; 286 } v; 287 union { 288 #ifdef KERNEL 289 struct pfi_dynaddr *dyn __attribute__((aligned(8))); 290 struct pfr_ktable *tbl __attribute__((aligned(8))); 291 #else /* !KERNEL */ 292 void *dyn __attribute__((aligned(8))); 293 void *tbl __attribute__((aligned(8))); 294 #endif /* !KERNEL */ 295 int dyncnt __attribute__((aligned(8))); 296 int tblcnt __attribute__((aligned(8))); 297 } p __attribute__((aligned(8))); 298 u_int8_t type; /* PF_ADDR_* */ 299 u_int8_t iflags; /* PFI_AFLAG_* */ 300 }; 301 302 struct pf_port_range { 303 u_int16_t port[2]; 304 u_int8_t op; 305 }; 306 307 union pf_rule_xport { 308 struct pf_port_range range; 309 u_int16_t call_id; 310 u_int32_t spi; 311 }; 312 313 #ifdef KERNEL 314 struct pfi_dynaddr { 315 TAILQ_ENTRY(pfi_dynaddr) entry; 316 struct pf_addr pfid_addr4; 317 struct pf_addr pfid_mask4; 318 struct pf_addr pfid_addr6; 319 struct pf_addr pfid_mask6; 320 struct pfr_ktable *pfid_kt; 321 struct pfi_kif *pfid_kif; 322 void *pfid_hook_cookie; 323 uint8_t pfid_net; /* mask or 128 */ 324 int pfid_acnt4; /* address count IPv4 */ 325 int pfid_acnt6; /* address count IPv6 */ 326 sa_family_t pfid_af; /* rule af */ 327 u_int8_t pfid_iflags; /* PFI_AFLAG_* */ 328 }; 329 330 /* 331 * Address manipulation macros 332 */ 333 334 #if INET 335 #endif /* INET */ 336 337 #if !INET 338 #define PF_INET6_ONLY 339 #endif /* ! INET */ 340 341 #if INET 342 #define PF_INET_INET6 343 #endif /* INET */ 344 345 #else /* !KERNEL */ 346 347 #define PF_INET_INET6 348 349 #endif /* !KERNEL */ 350 351 /* Both IPv4 and IPv6 */ 352 #ifdef PF_INET_INET6 353 354 #define PF_AEQ(a, b, c) \ 355 ((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \ 356 (c == AF_INET6 && ((a)->addr32[3] == (b)->addr32[3] && \ 357 (a)->addr32[2] == (b)->addr32[2] && \ 358 (a)->addr32[1] == (b)->addr32[1] && \ 359 (a)->addr32[0] == (b)->addr32[0]))) \ 360 361 #define PF_ANEQ(a, b, c) \ 362 ((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \ 363 (c == AF_INET6 && ((a)->addr32[3] != (b)->addr32[3] || \ 364 (a)->addr32[2] != (b)->addr32[2] || \ 365 (a)->addr32[1] != (b)->addr32[1] || \ 366 (a)->addr32[0] != (b)->addr32[0]))) \ 367 368 #define PF_ALEQ(a, b, c) \ 369 ((c == AF_INET && (a)->addr32[0] <= (b)->addr32[0]) || \ 370 (c == AF_INET6 && ((a)->addr32[3] <= (b)->addr32[3] && \ 371 (a)->addr32[2] <= (b)->addr32[2] && \ 372 (a)->addr32[1] <= (b)->addr32[1] && \ 373 (a)->addr32[0] <= (b)->addr32[0]))) \ 374 375 #define PF_AZERO(a, c) \ 376 ((c == AF_INET && !(a)->addr32[0]) || \ 377 (c == AF_INET6 && (!(a)->addr32[0] && !(a)->addr32[1] && \ 378 !(a)->addr32[2] && !(a)->addr32[3]))) \ 379 380 #define PF_MATCHA(n, a, m, b, f) \ 381 pf_match_addr(n, a, m, b, f) 382 383 #define PF_ACPY(a, b, f) \ 384 pf_addrcpy(a, b, f) 385 386 #define PF_AINC(a, f) \ 387 pf_addr_inc(a, f) 388 389 #define PF_POOLMASK(a, b, c, d, f) \ 390 pf_poolmask(a, b, c, d, f) 391 392 #else 393 394 /* Just IPv6 */ 395 396 #ifdef PF_INET6_ONLY 397 398 #define PF_AEQ(a, b, c) \ 399 ((a)->addr32[3] == (b)->addr32[3] && \ 400 (a)->addr32[2] == (b)->addr32[2] && \ 401 (a)->addr32[1] == (b)->addr32[1] && \ 402 (a)->addr32[0] == (b)->addr32[0]) \ 403 404 #define PF_ANEQ(a, b, c) \ 405 ((a)->addr32[3] != (b)->addr32[3] || \ 406 (a)->addr32[2] != (b)->addr32[2] || \ 407 (a)->addr32[1] != (b)->addr32[1] || \ 408 (a)->addr32[0] != (b)->addr32[0]) \ 409 410 #define PF_ALEQ(a, b, c) \ 411 ((a)->addr32[3] <= (b)->addr32[3] && \ 412 (a)->addr32[2] <= (b)->addr32[2] && \ 413 (a)->addr32[1] <= (b)->addr32[1] && \ 414 (a)->addr32[0] <= (b)->addr32[0]) \ 415 416 #define PF_AZERO(a, c) \ 417 (!(a)->addr32[0] && \ 418 !(a)->addr32[1] && \ 419 !(a)->addr32[2] && \ 420 !(a)->addr32[3]) \ 421 422 #define PF_MATCHA(n, a, m, b, f) \ 423 pf_match_addr(n, a, m, b, f) 424 425 #define PF_ACPY(a, b, f) \ 426 pf_addrcpy(a, b, f) 427 428 #define PF_AINC(a, f) \ 429 pf_addr_inc(a, f) 430 431 #define PF_POOLMASK(a, b, c, d, f) \ 432 pf_poolmask(a, b, c, d, f) 433 434 #else 435 436 /* Just IPv4 */ 437 #ifdef PF_INET_ONLY 438 439 #define PF_AEQ(a, b, c) \ 440 ((a)->addr32[0] == (b)->addr32[0]) 441 442 #define PF_ANEQ(a, b, c) \ 443 ((a)->addr32[0] != (b)->addr32[0]) 444 445 #define PF_ALEQ(a, b, c) \ 446 ((a)->addr32[0] <= (b)->addr32[0]) 447 448 #define PF_AZERO(a, c) \ 449 (!(a)->addr32[0]) 450 451 #define PF_MATCHA(n, a, m, b, f) \ 452 pf_match_addr(n, a, m, b, f) 453 454 #define PF_ACPY(a, b, f) \ 455 (a)->v4.s_addr = (b)->v4.s_addr 456 457 #define PF_AINC(a, f) \ 458 do { \ 459 (a)->addr32[0] = htonl(ntohl((a)->addr32[0]) + 1); \ 460 } while (0) 461 462 #define PF_POOLMASK(a, b, c, d, f) \ 463 do { \ 464 (a)->addr32[0] = ((b)->addr32[0] & (c)->addr32[0]) | \ 465 (((c)->addr32[0] ^ 0xffffffff) & (d)->addr32[0]); \ 466 } while (0) 467 468 #endif /* PF_INET_ONLY */ 469 #endif /* PF_INET6_ONLY */ 470 #endif /* PF_INET_INET6 */ 471 472 #ifdef KERNEL 473 #define PF_MISMATCHAW(aw, x, af, neg, ifp) \ 474 ( \ 475 (((aw)->type == PF_ADDR_NOROUTE && \ 476 pf_routable((x), (af), NULL)) || \ 477 (((aw)->type == PF_ADDR_URPFFAILED && (ifp) != NULL && \ 478 pf_routable((x), (af), (ifp))) || \ 479 ((aw)->type == PF_ADDR_RTLABEL && \ 480 !pf_rtlabel_match((x), (af), (aw))) || \ 481 ((aw)->type == PF_ADDR_TABLE && \ 482 !pfr_match_addr((aw)->p.tbl, (x), (af))) || \ 483 ((aw)->type == PF_ADDR_DYNIFTL && \ 484 !pfi_match_addr((aw)->p.dyn, (x), (af))) || \ 485 ((aw)->type == PF_ADDR_RANGE && \ 486 !pf_match_addr_range(&(aw)->v.a.addr, \ 487 &(aw)->v.a.mask, (x), (af))) || \ 488 ((aw)->type == PF_ADDR_ADDRMASK && \ 489 !PF_AZERO(&(aw)->v.a.mask, (af)) && \ 490 !PF_MATCHA(0, &(aw)->v.a.addr, \ 491 &(aw)->v.a.mask, (x), (af))))) != \ 492 (neg) \ 493 ) 494 #endif /* KERNEL */ 495 496 struct pf_rule_uid { 497 uid_t uid[2]; 498 u_int8_t op; 499 u_int8_t _pad[3]; 500 }; 501 502 struct pf_rule_gid { 503 uid_t gid[2]; 504 u_int8_t op; 505 u_int8_t _pad[3]; 506 }; 507 508 struct pf_rule_addr { 509 struct pf_addr_wrap addr; 510 union pf_rule_xport xport; 511 u_int8_t neg; 512 }; 513 514 struct pf_pooladdr { 515 struct pf_addr_wrap addr; 516 TAILQ_ENTRY(pf_pooladdr) entries; 517 #if !defined(__LP64__) 518 u_int32_t _pad[2]; 519 #endif /* !__LP64__ */ 520 char ifname[IFNAMSIZ]; 521 #ifdef KERNEL 522 struct pfi_kif *kif __attribute__((aligned(8))); 523 #else /* !KERNEL */ 524 void *kif __attribute__((aligned(8))); 525 #endif /* !KERNEL */ 526 }; 527 528 TAILQ_HEAD(pf_palist, pf_pooladdr); 529 530 struct pf_poolhashkey { 531 union { 532 u_int8_t key8[16]; 533 u_int16_t key16[8]; 534 u_int32_t key32[4]; 535 } pfk; /* 128-bit hash key */ 536 #define key8 pfk.key8 537 #define key16 pfk.key16 538 #define key32 pfk.key32 539 }; 540 541 struct pf_pool { 542 struct pf_palist list; 543 #if !defined(__LP64__) 544 u_int32_t _pad[2]; 545 #endif /* !__LP64__ */ 546 #ifdef KERNEL 547 struct pf_pooladdr *cur __attribute__((aligned(8))); 548 #else /* !KERNEL */ 549 void *cur __attribute__((aligned(8))); 550 #endif /* !KERNEL */ 551 struct pf_poolhashkey key __attribute__((aligned(8))); 552 struct pf_addr counter; 553 int tblidx; 554 u_int16_t proxy_port[2]; 555 u_int8_t port_op; 556 u_int8_t opts; 557 sa_family_t af; 558 }; 559 560 561 /* A packed Operating System description for fingerprinting */ 562 typedef u_int32_t pf_osfp_t; 563 #define PF_OSFP_ANY ((pf_osfp_t)0) 564 #define PF_OSFP_UNKNOWN ((pf_osfp_t)-1) 565 #define PF_OSFP_NOMATCH ((pf_osfp_t)-2) 566 567 struct pf_osfp_entry { 568 SLIST_ENTRY(pf_osfp_entry) fp_entry; 569 #if !defined(__LP64__) 570 u_int32_t _pad; 571 #endif /* !__LP64__ */ 572 pf_osfp_t fp_os; 573 int fp_enflags; 574 #define PF_OSFP_EXPANDED 0x001 /* expanded entry */ 575 #define PF_OSFP_GENERIC 0x002 /* generic signature */ 576 #define PF_OSFP_NODETAIL 0x004 /* no p0f details */ 577 #define PF_OSFP_LEN 32 578 char fp_class_nm[PF_OSFP_LEN]; 579 char fp_version_nm[PF_OSFP_LEN]; 580 char fp_subtype_nm[PF_OSFP_LEN]; 581 }; 582 #define PF_OSFP_ENTRY_EQ(a, b) \ 583 ((a)->fp_os == (b)->fp_os && \ 584 memcmp((a)->fp_class_nm, (b)->fp_class_nm, PF_OSFP_LEN) == 0 && \ 585 memcmp((a)->fp_version_nm, (b)->fp_version_nm, PF_OSFP_LEN) == 0 && \ 586 memcmp((a)->fp_subtype_nm, (b)->fp_subtype_nm, PF_OSFP_LEN) == 0) 587 588 /* handle pf_osfp_t packing */ 589 #define _FP_RESERVED_BIT 1 /* For the special negative #defines */ 590 #define _FP_UNUSED_BITS 1 591 #define _FP_CLASS_BITS 10 /* OS Class (Windows, Linux) */ 592 #define _FP_VERSION_BITS 10 /* OS version (95, 98, NT, 2.4.54, 3.2) */ 593 #define _FP_SUBTYPE_BITS 10 /* patch level (NT SP4, SP3, ECN patch) */ 594 #define PF_OSFP_UNPACK(osfp, class, version, subtype) do { \ 595 (class) = ((osfp) >> (_FP_VERSION_BITS+_FP_SUBTYPE_BITS)) & \ 596 ((1 << _FP_CLASS_BITS) - 1); \ 597 (version) = ((osfp) >> _FP_SUBTYPE_BITS) & \ 598 ((1 << _FP_VERSION_BITS) - 1);\ 599 (subtype) = (osfp) & ((1 << _FP_SUBTYPE_BITS) - 1); \ 600 } while (0) 601 #define PF_OSFP_PACK(osfp, class, version, subtype) do { \ 602 (osfp) = ((class) & ((1 << _FP_CLASS_BITS) - 1)) << (_FP_VERSION_BITS \ 603 + _FP_SUBTYPE_BITS); \ 604 (osfp) |= ((version) & ((1 << _FP_VERSION_BITS) - 1)) << \ 605 _FP_SUBTYPE_BITS; \ 606 (osfp) |= (subtype) & ((1 << _FP_SUBTYPE_BITS) - 1); \ 607 } while (0) 608 609 /* the fingerprint of an OSes TCP SYN packet */ 610 typedef u_int64_t pf_tcpopts_t; 611 struct pf_os_fingerprint { 612 SLIST_HEAD(pf_osfp_enlist, pf_osfp_entry) fp_oses; /* list of matches */ 613 pf_tcpopts_t fp_tcpopts; /* packed TCP options */ 614 u_int16_t fp_wsize; /* TCP window size */ 615 u_int16_t fp_psize; /* ip->ip_len */ 616 u_int16_t fp_mss; /* TCP MSS */ 617 u_int16_t fp_flags; 618 #define PF_OSFP_WSIZE_MOD 0x0001 /* Window modulus */ 619 #define PF_OSFP_WSIZE_DC 0x0002 /* Window don't care */ 620 #define PF_OSFP_WSIZE_MSS 0x0004 /* Window multiple of MSS */ 621 #define PF_OSFP_WSIZE_MTU 0x0008 /* Window multiple of MTU */ 622 #define PF_OSFP_PSIZE_MOD 0x0010 /* packet size modulus */ 623 #define PF_OSFP_PSIZE_DC 0x0020 /* packet size don't care */ 624 #define PF_OSFP_WSCALE 0x0040 /* TCP window scaling */ 625 #define PF_OSFP_WSCALE_MOD 0x0080 /* TCP window scale modulus */ 626 #define PF_OSFP_WSCALE_DC 0x0100 /* TCP window scale dont-care */ 627 #define PF_OSFP_MSS 0x0200 /* TCP MSS */ 628 #define PF_OSFP_MSS_MOD 0x0400 /* TCP MSS modulus */ 629 #define PF_OSFP_MSS_DC 0x0800 /* TCP MSS dont-care */ 630 #define PF_OSFP_DF 0x1000 /* IPv4 don't fragment bit */ 631 #define PF_OSFP_TS0 0x2000 /* Zero timestamp */ 632 #define PF_OSFP_INET6 0x4000 /* IPv6 */ 633 u_int8_t fp_optcnt; /* TCP option count */ 634 u_int8_t fp_wscale; /* TCP window scaling */ 635 u_int8_t fp_ttl; /* IPv4 TTL */ 636 #define PF_OSFP_MAXTTL_OFFSET 40 637 /* TCP options packing */ 638 #define PF_OSFP_TCPOPT_NOP 0x0 /* TCP NOP option */ 639 #define PF_OSFP_TCPOPT_WSCALE 0x1 /* TCP window scaling option */ 640 #define PF_OSFP_TCPOPT_MSS 0x2 /* TCP max segment size opt */ 641 #define PF_OSFP_TCPOPT_SACK 0x3 /* TCP SACK OK option */ 642 #define PF_OSFP_TCPOPT_TS 0x4 /* TCP timestamp option */ 643 #define PF_OSFP_TCPOPT_BITS 3 /* bits used by each option */ 644 #define PF_OSFP_MAX_OPTS \ 645 ((sizeof(pf_tcpopts_t) * 8) \ 646 / PF_OSFP_TCPOPT_BITS) 647 648 SLIST_ENTRY(pf_os_fingerprint) fp_next; 649 }; 650 651 struct pf_osfp_ioctl { 652 struct pf_osfp_entry fp_os; 653 pf_tcpopts_t fp_tcpopts; /* packed TCP options */ 654 u_int16_t fp_wsize; /* TCP window size */ 655 u_int16_t fp_psize; /* ip->ip_len */ 656 u_int16_t fp_mss; /* TCP MSS */ 657 u_int16_t fp_flags; 658 u_int8_t fp_optcnt; /* TCP option count */ 659 u_int8_t fp_wscale; /* TCP window scaling */ 660 u_int8_t fp_ttl; /* IPv4 TTL */ 661 662 int fp_getnum; /* DIOCOSFPGET number */ 663 }; 664 665 666 union pf_rule_ptr { 667 struct pf_rule *ptr __attribute__((aligned(8))); 668 u_int32_t nr __attribute__((aligned(8))); 669 } __attribute__((aligned(8))); 670 671 #define PF_ANCHOR_NAME_SIZE 64 672 673 struct pf_rule { 674 struct pf_rule_addr src; 675 struct pf_rule_addr dst; 676 #define PF_SKIP_IFP 0 677 #define PF_SKIP_DIR 1 678 #define PF_SKIP_AF 2 679 #define PF_SKIP_PROTO 3 680 #define PF_SKIP_SRC_ADDR 4 681 #define PF_SKIP_SRC_PORT 5 682 #define PF_SKIP_DST_ADDR 6 683 #define PF_SKIP_DST_PORT 7 684 #define PF_SKIP_COUNT 8 685 union pf_rule_ptr skip[PF_SKIP_COUNT]; 686 #define PF_RULE_LABEL_SIZE 64 687 char label[PF_RULE_LABEL_SIZE]; 688 #define PF_QNAME_SIZE 64 689 char ifname[IFNAMSIZ]; 690 char qname[PF_QNAME_SIZE]; 691 char pqname[PF_QNAME_SIZE]; 692 #define PF_TAG_NAME_SIZE 64 693 char tagname[PF_TAG_NAME_SIZE]; 694 char match_tagname[PF_TAG_NAME_SIZE]; 695 696 char overload_tblname[PF_TABLE_NAME_SIZE]; 697 698 TAILQ_ENTRY(pf_rule) entries; 699 #if !defined(__LP64__) 700 u_int32_t _pad[2]; 701 #endif /* !__LP64__ */ 702 struct pf_pool rpool; 703 704 u_int64_t evaluations; 705 u_int64_t packets[2]; 706 u_int64_t bytes[2]; 707 708 u_int64_t ticket; 709 #define PF_OWNER_NAME_SIZE 64 710 char owner[PF_OWNER_NAME_SIZE]; 711 u_int32_t priority; 712 713 #ifdef KERNEL 714 struct pfi_kif *kif __attribute__((aligned(8))); 715 #else /* !KERNEL */ 716 void *kif __attribute__((aligned(8))); 717 #endif /* !KERNEL */ 718 struct pf_anchor *anchor __attribute__((aligned(8))); 719 #ifdef KERNEL 720 struct pfr_ktable *overload_tbl __attribute__((aligned(8))); 721 #else /* !KERNEL */ 722 void *overload_tbl __attribute__((aligned(8))); 723 #endif /* !KERNEL */ 724 725 pf_osfp_t os_fingerprint __attribute__((aligned(8))); 726 727 unsigned int rtableid; 728 u_int32_t timeout[PFTM_MAX]; 729 u_int32_t states; 730 u_int32_t max_states; 731 u_int32_t src_nodes; 732 u_int32_t max_src_nodes; 733 u_int32_t max_src_states; 734 u_int32_t max_src_conn; 735 struct { 736 u_int32_t limit; 737 u_int32_t seconds; 738 } max_src_conn_rate; 739 u_int32_t qid; 740 u_int32_t pqid; 741 u_int32_t rt_listid; 742 u_int32_t nr; 743 u_int32_t prob; 744 uid_t cuid; 745 pid_t cpid; 746 747 u_int16_t return_icmp; 748 u_int16_t return_icmp6; 749 u_int16_t max_mss; 750 u_int16_t tag; 751 u_int16_t match_tag; 752 753 struct pf_rule_uid uid; 754 struct pf_rule_gid gid; 755 756 u_int32_t rule_flag; 757 u_int8_t action; 758 u_int8_t direction; 759 u_int8_t log; 760 u_int8_t logif; 761 u_int8_t quick; 762 u_int8_t ifnot; 763 u_int8_t match_tag_not; 764 u_int8_t natpass; 765 766 #define PF_STATE_NORMAL 0x1 767 #define PF_STATE_MODULATE 0x2 768 #define PF_STATE_SYNPROXY 0x3 769 u_int8_t keep_state; 770 sa_family_t af; 771 u_int8_t proto; 772 u_int8_t type; 773 u_int8_t code; 774 u_int8_t flags; 775 u_int8_t flagset; 776 u_int8_t min_ttl; 777 u_int8_t allow_opts; 778 u_int8_t rt; 779 u_int8_t return_ttl; 780 781 /* service class categories */ 782 #define SCIDX_MASK 0x0f 783 #define SC_BE 0x10 784 #define SC_BK_SYS 0x11 785 #define SC_BK 0x12 786 #define SC_RD 0x13 787 #define SC_OAM 0x14 788 #define SC_AV 0x15 789 #define SC_RV 0x16 790 #define SC_VI 0x17 791 #define SC_SIG 0x17 792 #define SC_VO 0x18 793 #define SC_CTL 0x19 794 795 /* diffserve code points */ 796 #define DSCP_MASK 0xfc 797 #define DSCP_CUMASK 0x03 798 #define DSCP_EF 0xb8 799 #define DSCP_AF11 0x28 800 #define DSCP_AF12 0x30 801 #define DSCP_AF13 0x38 802 #define DSCP_AF21 0x48 803 #define DSCP_AF22 0x50 804 #define DSCP_AF23 0x58 805 #define DSCP_AF31 0x68 806 #define DSCP_AF32 0x70 807 #define DSCP_AF33 0x78 808 #define DSCP_AF41 0x88 809 #define DSCP_AF42 0x90 810 #define DSCP_AF43 0x98 811 #define AF_CLASSMASK 0xe0 812 #define AF_DROPPRECMASK 0x18 813 u_int8_t tos; 814 u_int8_t anchor_relative; 815 u_int8_t anchor_wildcard; 816 817 #define PF_FLUSH 0x01 818 #define PF_FLUSH_GLOBAL 0x02 819 u_int8_t flush; 820 821 u_int8_t proto_variant; 822 u_int8_t extfilter; /* Filter mode [PF_EXTFILTER_xxx] */ 823 u_int8_t extmap; /* Mapping mode [PF_EXTMAP_xxx] */ 824 u_int32_t dnpipe; 825 u_int32_t dntype; 826 }; 827 828 /* pf device identifiers */ 829 #define PFDEV_PF 0 830 #define PFDEV_PFM 1 831 #define PFDEV_MAX 2 832 833 /* rule flags */ 834 #define PFRULE_DROP 0x0000 835 #define PFRULE_RETURNRST 0x0001 836 #define PFRULE_FRAGMENT 0x0002 837 #define PFRULE_RETURNICMP 0x0004 838 #define PFRULE_RETURN 0x0008 839 #define PFRULE_NOSYNC 0x0010 840 #define PFRULE_SRCTRACK 0x0020 /* track source states */ 841 #define PFRULE_RULESRCTRACK 0x0040 /* per rule */ 842 843 /* scrub flags */ 844 #define PFRULE_NODF 0x0100 845 #define PFRULE_FRAGCROP 0x0200 /* non-buffering frag cache */ 846 #define PFRULE_FRAGDROP 0x0400 /* drop funny fragments */ 847 #define PFRULE_RANDOMID 0x0800 848 #define PFRULE_REASSEMBLE_TCP 0x1000 849 850 /* rule flags for TOS/DSCP/service class differentiation */ 851 #define PFRULE_TOS 0x2000 852 #define PFRULE_DSCP 0x4000 853 #define PFRULE_SC 0x8000 854 855 /* rule flags again */ 856 #define PFRULE_IFBOUND 0x00010000 /* if-bound */ 857 #define PFRULE_PFM 0x00020000 /* created by pfm device */ 858 859 #define PFSTATE_HIWAT 10000 /* default state table size */ 860 #define PFSTATE_ADAPT_START 6000 /* default adaptive timeout start */ 861 #define PFSTATE_ADAPT_END 12000 /* default adaptive timeout end */ 862 863 #define PFAPPSTATE_HIWAT 10000 /* default same as state table */ 864 865 /* PF reserved special purpose tags */ 866 #define PF_TAG_NAME_SYSTEM_SERVICE "com.apple.pf.system_service_tag" 867 #define PF_TAG_NAME_STACK_DROP "com.apple.pf.stack_drop_tag" 868 869 enum pf_extmap { 870 PF_EXTMAP_APD = 1, /* Address-port-dependent mapping */ 871 PF_EXTMAP_AD, /* Address-dependent mapping */ 872 PF_EXTMAP_EI /* Endpoint-independent mapping */ 873 }; 874 875 enum pf_extfilter { 876 PF_EXTFILTER_APD = 1, /* Address-port-dependent filtering */ 877 PF_EXTFILTER_AD, /* Address-dependent filtering */ 878 PF_EXTFILTER_EI /* Endpoint-independent filtering */ 879 }; 880 881 struct pf_threshold { 882 u_int32_t limit; 883 #define PF_THRESHOLD_MULT 1000 884 #define PF_THRESHOLD_MAX 0xffffffff / PF_THRESHOLD_MULT 885 u_int32_t seconds; 886 u_int32_t count; 887 u_int32_t last; 888 }; 889 890 struct pf_src_node { 891 RB_ENTRY(pf_src_node) entry; 892 struct pf_addr addr; 893 struct pf_addr raddr; 894 union pf_rule_ptr rule; 895 #ifdef KERNEL 896 struct pfi_kif *kif; 897 #else /* !KERNEL */ 898 void *kif; 899 #endif /* !KERNEL */ 900 u_int64_t bytes[2]; 901 u_int64_t packets[2]; 902 u_int32_t states; 903 u_int32_t conn; 904 struct pf_threshold conn_rate; 905 u_int64_t creation; 906 u_int64_t expire; 907 sa_family_t af; 908 u_int8_t ruletype; 909 }; 910 911 #define PFSNODE_HIWAT 10000 /* default source node table size */ 912 913 #ifdef KERNEL 914 struct pf_state_scrub { 915 struct timeval pfss_last; /* time received last packet */ 916 u_int32_t pfss_tsecr; /* last echoed timestamp */ 917 u_int32_t pfss_tsval; /* largest timestamp */ 918 u_int32_t pfss_tsval0; /* original timestamp */ 919 u_int16_t pfss_flags; 920 #define PFSS_TIMESTAMP 0x0001 /* modulate timestamp */ 921 #define PFSS_PAWS 0x0010 /* stricter PAWS checks */ 922 #define PFSS_PAWS_IDLED 0x0020 /* was idle too long. no PAWS */ 923 #define PFSS_DATA_TS 0x0040 /* timestamp on data packets */ 924 #define PFSS_DATA_NOTS 0x0080 /* no timestamp on data packets */ 925 u_int8_t pfss_ttl; /* stashed TTL */ 926 u_int8_t pad; 927 u_int32_t pfss_ts_mod; /* timestamp modulation */ 928 }; 929 #endif /* KERNEL */ 930 931 union pf_state_xport { 932 u_int16_t port; 933 u_int16_t call_id; 934 u_int32_t spi; 935 }; 936 937 struct pf_state_host { 938 struct pf_addr addr; 939 union pf_state_xport xport; 940 }; 941 942 #ifdef KERNEL 943 struct pf_state_peer { 944 u_int32_t seqlo; /* Max sequence number sent */ 945 u_int32_t seqhi; /* Max the other end ACKd + win */ 946 u_int32_t seqdiff; /* Sequence number modulator */ 947 u_int16_t max_win; /* largest window (pre scaling) */ 948 u_int8_t state; /* active state level */ 949 u_int8_t wscale; /* window scaling factor */ 950 u_int16_t mss; /* Maximum segment size option */ 951 u_int8_t tcp_est; /* Did we reach TCPS_ESTABLISHED */ 952 struct pf_state_scrub *scrub; /* state is scrubbed */ 953 u_int8_t pad[3]; 954 }; 955 956 TAILQ_HEAD(pf_state_queue, pf_state); 957 958 struct pf_state; 959 struct pf_pdesc; 960 struct pf_app_state; 961 962 typedef void (*pf_app_handler)(struct pf_state *, int, int, struct pf_pdesc *, 963 struct pfi_kif *); 964 965 typedef int (*pf_app_compare)(struct pf_app_state *, struct pf_app_state *); 966 967 struct pf_pptp_state { 968 struct pf_state *grev1_state; 969 }; 970 971 struct pf_grev1_state { 972 struct pf_state *pptp_state; 973 }; 974 975 struct pf_ike_state { 976 u_int64_t cookie; 977 }; 978 979 struct pf_app_state { 980 pf_app_handler handler; 981 pf_app_compare compare_lan_ext; 982 pf_app_compare compare_ext_gwy; 983 union { 984 struct pf_pptp_state pptp; 985 struct pf_grev1_state grev1; 986 struct pf_ike_state ike; 987 } u; 988 }; 989 990 /* keep synced with struct pf_state, used in RB_FIND */ 991 struct pf_state_key_cmp { 992 struct pf_state_host lan; 993 struct pf_state_host gwy; 994 struct pf_state_host ext_lan; 995 struct pf_state_host ext_gwy; 996 sa_family_t af_lan; 997 sa_family_t af_gwy; 998 u_int8_t proto; 999 u_int8_t direction; 1000 u_int8_t proto_variant; 1001 struct pf_app_state *app_state; 1002 }; 1003 1004 TAILQ_HEAD(pf_statelist, pf_state); 1005 1006 struct pf_state_key { 1007 struct pf_state_host lan; 1008 struct pf_state_host gwy; 1009 struct pf_state_host ext_lan; 1010 struct pf_state_host ext_gwy; 1011 sa_family_t af_lan; 1012 sa_family_t af_gwy; 1013 u_int8_t proto; 1014 u_int8_t direction; 1015 u_int8_t proto_variant; 1016 struct pf_app_state *app_state; 1017 u_int32_t flowsrc; 1018 u_int32_t flowhash; 1019 1020 RB_ENTRY(pf_state_key) entry_lan_ext; 1021 RB_ENTRY(pf_state_key) entry_ext_gwy; 1022 struct pf_statelist states; 1023 u_int32_t refcnt; 1024 }; 1025 1026 1027 /* keep synced with struct pf_state, used in RB_FIND */ 1028 struct pf_state_cmp { 1029 u_int64_t id; 1030 u_int32_t creatorid; 1031 u_int32_t pad; 1032 }; 1033 1034 /* flowhash key (12-bytes multiple for performance) */ 1035 struct pf_flowhash_key { 1036 struct pf_state_host ap1; /* address+port blob 1 */ 1037 struct pf_state_host ap2; /* address+port blob 2 */ 1038 u_int32_t af; 1039 u_int32_t proto; 1040 }; 1041 #endif /* KERNEL */ 1042 1043 struct hook_desc; 1044 TAILQ_HEAD(hook_desc_head, hook_desc); 1045 1046 #ifdef KERNEL 1047 struct pf_state { 1048 u_int64_t id; 1049 u_int32_t creatorid; 1050 u_int32_t pad; 1051 1052 TAILQ_ENTRY(pf_state) entry_list; 1053 TAILQ_ENTRY(pf_state) next; 1054 RB_ENTRY(pf_state) entry_id; 1055 struct pf_state_peer src; 1056 struct pf_state_peer dst; 1057 union pf_rule_ptr rule; 1058 union pf_rule_ptr anchor; 1059 union pf_rule_ptr nat_rule; 1060 struct pf_addr rt_addr; 1061 struct hook_desc_head unlink_hooks; 1062 struct pf_state_key *state_key; 1063 struct pfi_kif *kif; 1064 struct pfi_kif *rt_kif; 1065 struct pf_src_node *src_node; 1066 struct pf_src_node *nat_src_node; 1067 u_int64_t packets[2]; 1068 u_int64_t bytes[2]; 1069 u_int64_t creation; 1070 u_int64_t expire; 1071 u_int64_t pfsync_time; 1072 u_int16_t tag; 1073 u_int8_t log; 1074 u_int8_t allow_opts; 1075 u_int8_t timeout; 1076 u_int8_t sync_flags; 1077 #if SKYWALK 1078 netns_token nstoken; 1079 #endif 1080 }; 1081 #endif /* KERNEL */ 1082 1083 #define PFSTATE_NOSYNC 0x01 1084 #define PFSTATE_FROMSYNC 0x02 1085 #define PFSTATE_STALE 0x04 1086 1087 #define __packed __attribute__((__packed__)) 1088 1089 /* 1090 * Unified state structures for pulling states out of the kernel 1091 * used by pfsync(4) and the pf(4) ioctl. 1092 */ 1093 struct pfsync_state_scrub { 1094 u_int16_t pfss_flags; 1095 u_int8_t pfss_ttl; /* stashed TTL */ 1096 #define PFSYNC_SCRUB_FLAG_VALID 0x01 1097 u_int8_t scrub_flag; 1098 u_int32_t pfss_ts_mod; /* timestamp modulation */ 1099 } __packed; 1100 1101 struct pfsync_state_host { 1102 struct pf_addr addr; 1103 union pf_state_xport xport; 1104 u_int16_t pad[2]; 1105 } __packed; 1106 1107 struct pfsync_state_peer { 1108 struct pfsync_state_scrub scrub; /* state is scrubbed */ 1109 u_int32_t seqlo; /* Max sequence number sent */ 1110 u_int32_t seqhi; /* Max the other end ACKd + win */ 1111 u_int32_t seqdiff; /* Sequence number modulator */ 1112 u_int16_t max_win; /* largest window (pre scaling) */ 1113 u_int16_t mss; /* Maximum segment size option */ 1114 u_int8_t state; /* active state level */ 1115 u_int8_t wscale; /* window scaling factor */ 1116 u_int8_t pad[6]; 1117 } __packed; 1118 1119 struct pfsync_state { 1120 u_int32_t id[2]; 1121 char ifname[IFNAMSIZ]; 1122 struct pfsync_state_host lan; 1123 struct pfsync_state_host gwy; 1124 struct pfsync_state_host ext_lan; 1125 struct pfsync_state_host ext_gwy; 1126 struct pfsync_state_peer src; 1127 struct pfsync_state_peer dst; 1128 struct pf_addr rt_addr; 1129 struct hook_desc_head unlink_hooks; 1130 #if !defined(__LP64__) 1131 u_int32_t _pad[2]; 1132 #endif /* !__LP64__ */ 1133 u_int32_t rule; 1134 u_int32_t anchor; 1135 u_int32_t nat_rule; 1136 u_int64_t creation; 1137 u_int64_t expire; 1138 u_int32_t packets[2][2]; 1139 u_int32_t bytes[2][2]; 1140 u_int32_t creatorid; 1141 u_int16_t tag; 1142 sa_family_t af_lan; 1143 sa_family_t af_gwy; 1144 u_int8_t proto; 1145 u_int8_t direction; 1146 u_int8_t log; 1147 u_int8_t allow_opts; 1148 u_int8_t timeout; 1149 u_int8_t sync_flags; 1150 u_int8_t updates; 1151 u_int8_t proto_variant; 1152 u_int8_t __pad; 1153 u_int32_t flowhash; 1154 } __packed; 1155 1156 #define PFSYNC_FLAG_COMPRESS 0x01 1157 #define PFSYNC_FLAG_STALE 0x02 1158 #define PFSYNC_FLAG_SRCNODE 0x04 1159 #define PFSYNC_FLAG_NATSRCNODE 0x08 1160 1161 #ifdef KERNEL 1162 /* for copies to/from userland via pf_ioctl() */ 1163 #define pf_state_peer_to_pfsync(s, d) do { \ 1164 (d)->seqlo = (s)->seqlo; \ 1165 (d)->seqhi = (s)->seqhi; \ 1166 (d)->seqdiff = (s)->seqdiff; \ 1167 (d)->max_win = (s)->max_win; \ 1168 (d)->mss = (s)->mss; \ 1169 (d)->state = (s)->state; \ 1170 (d)->wscale = (s)->wscale; \ 1171 if ((s)->scrub) { \ 1172 (d)->scrub.pfss_flags = \ 1173 (s)->scrub->pfss_flags & PFSS_TIMESTAMP; \ 1174 (d)->scrub.pfss_ttl = (s)->scrub->pfss_ttl; \ 1175 (d)->scrub.pfss_ts_mod = (s)->scrub->pfss_ts_mod; \ 1176 (d)->scrub.scrub_flag = PFSYNC_SCRUB_FLAG_VALID; \ 1177 } \ 1178 } while (0) 1179 1180 #define pf_state_peer_from_pfsync(s, d) do { \ 1181 (d)->seqlo = (s)->seqlo; \ 1182 (d)->seqhi = (s)->seqhi; \ 1183 (d)->seqdiff = (s)->seqdiff; \ 1184 (d)->max_win = (s)->max_win; \ 1185 (d)->mss = ntohs((s)->mss); \ 1186 (d)->state = (s)->state; \ 1187 (d)->wscale = (s)->wscale; \ 1188 if ((s)->scrub.scrub_flag == PFSYNC_SCRUB_FLAG_VALID && \ 1189 (d)->scrub != NULL) { \ 1190 (d)->scrub->pfss_flags = \ 1191 ntohs((s)->scrub.pfss_flags) & PFSS_TIMESTAMP; \ 1192 (d)->scrub->pfss_ttl = (s)->scrub.pfss_ttl; \ 1193 (d)->scrub->pfss_ts_mod = (s)->scrub.pfss_ts_mod; \ 1194 } \ 1195 } while (0) 1196 #endif /* KERNEL */ 1197 1198 #define pf_state_counter_to_pfsync(s, d) do { \ 1199 d[0] = (s>>32)&0xffffffff; \ 1200 d[1] = s&0xffffffff; \ 1201 } while (0) 1202 1203 #define pf_state_counter_from_pfsync(s) \ 1204 (((u_int64_t)(s[0])<<32) | (u_int64_t)(s[1])) 1205 1206 1207 1208 TAILQ_HEAD(pf_rulequeue, pf_rule); 1209 1210 struct pf_anchor; 1211 1212 struct pf_ruleset { 1213 struct { 1214 struct pf_rulequeue queues[2]; 1215 struct { 1216 struct pf_rulequeue *ptr; 1217 struct pf_rule **__counted_by(rsize) ptr_array; 1218 u_int32_t rcount; 1219 u_int32_t rsize; 1220 u_int32_t ticket; 1221 int open; 1222 } active, inactive; 1223 } rules[PF_RULESET_MAX]; 1224 struct pf_anchor *anchor; 1225 u_int32_t tticket; 1226 int tables; 1227 int topen; 1228 }; 1229 1230 RB_HEAD(pf_anchor_global, pf_anchor); 1231 RB_HEAD(pf_anchor_node, pf_anchor); 1232 struct pf_anchor { 1233 RB_ENTRY(pf_anchor) entry_global; 1234 RB_ENTRY(pf_anchor) entry_node; 1235 struct pf_anchor *parent; 1236 struct pf_anchor_node children; 1237 char name[PF_ANCHOR_NAME_SIZE]; 1238 char path[MAXPATHLEN]; 1239 struct pf_ruleset ruleset; 1240 int refcnt; /* anchor rules */ 1241 int match; 1242 char owner[PF_OWNER_NAME_SIZE]; 1243 }; 1244 #ifdef KERNEL 1245 RB_PROTOTYPE_SC(__private_extern__, pf_anchor_global, pf_anchor, entry_global, 1246 pf_anchor_compare); 1247 RB_PROTOTYPE_SC(__private_extern__, pf_anchor_node, pf_anchor, entry_node, 1248 pf_anchor_compare); 1249 #else /* !KERNEL */ 1250 RB_PROTOTYPE(pf_anchor_global, pf_anchor, entry_global, pf_anchor_compare); 1251 RB_PROTOTYPE(pf_anchor_node, pf_anchor, entry_node, pf_anchor_compare); 1252 #endif /* !KERNEL */ 1253 1254 #define PF_RESERVED_ANCHOR "_pf" 1255 1256 #define PFR_TFLAG_PERSIST 0x00000001 1257 #define PFR_TFLAG_CONST 0x00000002 1258 #define PFR_TFLAG_ACTIVE 0x00000004 1259 #define PFR_TFLAG_INACTIVE 0x00000008 1260 #define PFR_TFLAG_REFERENCED 0x00000010 1261 #define PFR_TFLAG_REFDANCHOR 0x00000020 1262 #define PFR_TFLAG_USRMASK 0x00000003 1263 #define PFR_TFLAG_SETMASK 0x0000003C 1264 #define PFR_TFLAG_ALLMASK 0x0000003F 1265 1266 struct pfr_table { 1267 char pfrt_anchor[MAXPATHLEN]; 1268 char pfrt_name[PF_TABLE_NAME_SIZE]; 1269 uint32_t pfrt_flags; 1270 uint8_t pfrt_fback; 1271 }; 1272 1273 enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED, 1274 PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE, 1275 PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_MAX }; 1276 1277 struct pfr_addr { 1278 union { 1279 struct in_addr _pfra_ip4addr; 1280 struct in6_addr _pfra_ip6addr; 1281 } pfra_u; 1282 uint8_t pfra_af; 1283 uint8_t pfra_net; 1284 uint8_t pfra_not; 1285 uint8_t pfra_fback; 1286 }; 1287 #define pfra_ip4addr pfra_u._pfra_ip4addr 1288 #define pfra_ip6addr pfra_u._pfra_ip6addr 1289 1290 enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX }; 1291 enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX }; 1292 #define PFR_OP_XPASS PFR_OP_ADDR_MAX 1293 1294 struct pfr_astats { 1295 struct pfr_addr pfras_a; 1296 #if !defined(__LP64__) 1297 uint32_t _pad; 1298 #endif /* !__LP64__ */ 1299 uint64_t pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX]; 1300 uint64_t pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX]; 1301 uint64_t pfras_tzero; 1302 }; 1303 1304 enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX }; 1305 1306 struct pfr_tstats { 1307 struct pfr_table pfrts_t; 1308 u_int64_t pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX]; 1309 u_int64_t pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX]; 1310 u_int64_t pfrts_match; 1311 u_int64_t pfrts_nomatch; 1312 u_int64_t pfrts_tzero; 1313 int pfrts_cnt; 1314 int pfrts_refcnt[PFR_REFCNT_MAX]; 1315 #if !defined(__LP64__) 1316 u_int32_t _pad; 1317 #endif /* !__LP64__ */ 1318 }; 1319 #define pfrts_name pfrts_t.pfrt_name 1320 #define pfrts_flags pfrts_t.pfrt_flags 1321 1322 #ifdef KERNEL 1323 SLIST_HEAD(pfr_kentryworkq, pfr_kentry); 1324 struct pfr_kentry { 1325 struct radix_node pfrke_node[2]; 1326 union sockaddr_union pfrke_sa; 1327 u_int64_t pfrke_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX]; 1328 u_int64_t pfrke_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX]; 1329 SLIST_ENTRY(pfr_kentry) pfrke_workq; 1330 u_int64_t pfrke_tzero; 1331 u_int8_t pfrke_af; 1332 u_int8_t pfrke_net; 1333 u_int8_t pfrke_not; 1334 u_int8_t pfrke_mark; 1335 u_int8_t pfrke_intrpool; 1336 }; 1337 1338 SLIST_HEAD(pfr_ktableworkq, pfr_ktable); 1339 RB_HEAD(pfr_ktablehead, pfr_ktable); 1340 struct pfr_ktable { 1341 struct pfr_tstats pfrkt_ts; 1342 RB_ENTRY(pfr_ktable) pfrkt_tree; 1343 SLIST_ENTRY(pfr_ktable) pfrkt_workq; 1344 struct radix_node_head *pfrkt_ip4; 1345 struct radix_node_head *pfrkt_ip6; 1346 struct pfr_ktable *pfrkt_shadow; 1347 struct pfr_ktable *pfrkt_root; 1348 struct pf_ruleset *pfrkt_rs; 1349 u_int64_t pfrkt_larg; 1350 u_int32_t pfrkt_nflags; 1351 }; 1352 #define pfrkt_t pfrkt_ts.pfrts_t 1353 #define pfrkt_name pfrkt_t.pfrt_name 1354 #define pfrkt_anchor pfrkt_t.pfrt_anchor 1355 #define pfrkt_ruleset pfrkt_t.pfrt_ruleset 1356 #define pfrkt_flags pfrkt_t.pfrt_flags 1357 #define pfrkt_cnt pfrkt_ts.pfrts_cnt 1358 #define pfrkt_refcnt pfrkt_ts.pfrts_refcnt 1359 #define pfrkt_packets pfrkt_ts.pfrts_packets 1360 #define pfrkt_bytes pfrkt_ts.pfrts_bytes 1361 #define pfrkt_match pfrkt_ts.pfrts_match 1362 #define pfrkt_nomatch pfrkt_ts.pfrts_nomatch 1363 #define pfrkt_tzero pfrkt_ts.pfrts_tzero 1364 1365 RB_HEAD(pf_state_tree_lan_ext, pf_state_key); 1366 RB_PROTOTYPE_SC(__private_extern__, pf_state_tree_lan_ext, pf_state_key, 1367 entry_lan_ext, pf_state_compare_lan_ext); 1368 1369 RB_HEAD(pf_state_tree_ext_gwy, pf_state_key); 1370 RB_PROTOTYPE_SC(__private_extern__, pf_state_tree_ext_gwy, pf_state_key, 1371 entry_ext_gwy, pf_state_compare_ext_gwy); 1372 1373 RB_HEAD(pfi_ifhead, pfi_kif); 1374 1375 /* state tables */ 1376 extern struct pf_state_tree_lan_ext pf_statetbl_lan_ext; 1377 extern struct pf_state_tree_ext_gwy pf_statetbl_ext_gwy; 1378 1379 struct pfi_kif { 1380 char pfik_name[IFNAMSIZ]; 1381 RB_ENTRY(pfi_kif) pfik_tree; 1382 u_int64_t pfik_packets[2][2][2]; 1383 u_int64_t pfik_bytes[2][2][2]; 1384 u_int64_t pfik_tzero; 1385 int pfik_flags; 1386 void *pfik_ah_cookie; 1387 struct ifnet *pfik_ifp; 1388 int pfik_states; 1389 int pfik_rules; 1390 TAILQ_HEAD(, pfi_dynaddr) pfik_dynaddrs; 1391 }; 1392 1393 enum pfi_kif_refs { 1394 PFI_KIF_REF_NONE, 1395 PFI_KIF_REF_STATE, 1396 PFI_KIF_REF_RULE 1397 }; 1398 1399 struct pfi_uif { 1400 #else /* !KERNEL */ 1401 struct pfi_kif { 1402 #endif /* !KERNEL */ 1403 char pfik_name[IFNAMSIZ]; 1404 u_int64_t pfik_packets[2][2][2]; 1405 u_int64_t pfik_bytes[2][2][2]; 1406 u_int64_t pfik_tzero; 1407 int pfik_flags; 1408 int pfik_states; 1409 int pfik_rules; 1410 #if !defined(__LP64__) 1411 u_int32_t _pad; 1412 #endif /* !__LP64__ */ 1413 }; 1414 1415 #define PFI_IFLAG_SKIP 0x0100 /* skip filtering on interface */ 1416 1417 #ifdef KERNEL 1418 struct pf_pdesc { 1419 struct { 1420 int done; 1421 uid_t uid; 1422 gid_t gid; 1423 pid_t pid; 1424 } lookup; 1425 u_int64_t tot_len; /* Make Mickey money */ 1426 1427 /* 1428 * hdrlen and hdrmaxlen may differ in cases such as ICMP, 1429 * where hdrlen == ICMP_MINLEN, and hdrmaxlen == sizeof(struct icmp). 1430 * Another example is GRE, where hdrlen is only non-zero if the packet 1431 * is PPTP, but hdrmaxlen is always the actual buffer length. 1432 */ 1433 void *__sized_by(hdrmaxlen) hdr; 1434 size_t hdrlen; 1435 size_t hdrmaxlen; 1436 /* XXX TODO: Change baddr and naddr to *saddr */ 1437 struct pf_addr baddr; /* src address before translation */ 1438 struct pf_addr bdaddr; /* dst address before translation */ 1439 struct pf_addr naddr; /* src address after translation */ 1440 struct pf_addr ndaddr; /* dst address after translation */ 1441 struct pf_rule *nat_rule; /* nat/rdr rule applied to packet */ 1442 struct pf_addr *src; 1443 struct pf_addr *dst; 1444 struct ether_header *eh; 1445 pbuf_t *mp; 1446 int lmw; /* lazy writable offset */ 1447 struct pf_mtag *pf_mtag; 1448 u_int16_t *ip_sum; 1449 u_int32_t off; /* protocol header offset */ 1450 u_int32_t p_len; /* total length of payload */ 1451 u_int16_t flags; /* Let SCRUB trigger behavior in */ 1452 /* state code. Easier than tags */ 1453 #define PFDESC_TCP_NORM 0x0001 /* TCP shall be statefully scrubbed */ 1454 #define PFDESC_IP_REAS 0x0002 /* IP frags would've been reassembled */ 1455 #define PFDESC_IP_FRAG 0x0004 /* This is a fragment */ 1456 sa_family_t af; 1457 sa_family_t naf; /* address family after translation */ 1458 u_int8_t proto; 1459 u_int8_t tos; 1460 u_int8_t ttl; 1461 u_int8_t proto_variant; 1462 mbuf_svc_class_t sc; /* mbuf service class (MBUF_SVC) */ 1463 u_int32_t pktflags; /* mbuf packet flags (PKTF) */ 1464 u_int32_t flowsrc; /* flow source (FLOWSRC) */ 1465 u_int32_t flowhash; /* flow hash to identify the sender */ 1466 }; 1467 1468 #define _DEFINE_PDESC_HDR_ACCESSOR(HDR_TAG, HDR_TYPE) \ 1469 /* getter */ \ 1470 static inline \ 1471 HDR_TYPE * __single \ 1472 pf_pd_get_hdr_##HDR_TAG(const struct pf_pdesc *pdesc) \ 1473 { \ 1474 return (HDR_TYPE * __single)pdesc->hdr; \ 1475 } \ 1476 /* ptr getter */ \ 1477 static inline \ 1478 uint8_t *__header_indexable \ 1479 pf_pd_get_hdr_ptr_##HDR_TAG(const struct pf_pdesc *pdesc) \ 1480 { \ 1481 return (uint8_t *__header_indexable) pdesc->hdr; \ 1482 } \ 1483 /* setter with hdrlen != hdrmaxlen != sizeof(TYPE) */ \ 1484 static inline \ 1485 void \ 1486 __attribute__((overloadable)) \ 1487 pf_pd_set_hdr_##HDR_TAG(struct pf_pdesc *pdesc, \ 1488 void *__sized_by(hdrmaxlen) hdr, \ 1489 uint32_t hdrlen, \ 1490 uint32_t hdrmaxlen) \ 1491 { \ 1492 pdesc->hdrlen = hdrlen; \ 1493 pdesc->hdrmaxlen = hdrmaxlen; \ 1494 pdesc->hdr = (void *) hdr; \ 1495 } 1496 1497 #define _DEFINE_PDESC_TYPED_HDR_ACCESSOR(HDR_TAG, HDR_TYPE) \ 1498 _DEFINE_PDESC_HDR_ACCESSOR(HDR_TAG, HDR_TYPE) \ 1499 /* setter with hdrlen == hdrmaxlen == sizeof(TYPE) */ \ 1500 static inline \ 1501 void \ 1502 __attribute__((overloadable)) \ 1503 pf_pd_set_hdr_##HDR_TAG(struct pf_pdesc *pdesc, \ 1504 HDR_TYPE *hdr) \ 1505 { \ 1506 pf_pd_set_hdr_##HDR_TAG(pdesc, \ 1507 hdr, sizeof(HDR_TYPE), sizeof(HDR_TYPE)); \ 1508 } \ 1509 /* setter with hdrlen != hdrmaxlen == sizeof(TYPE) */ \ 1510 static inline \ 1511 void \ 1512 __attribute__((overloadable)) \ 1513 pf_pd_set_hdr_##HDR_TAG(struct pf_pdesc *pdesc, \ 1514 HDR_TYPE *hdr, \ 1515 uint32_t hdrlen) \ 1516 { \ 1517 pf_pd_set_hdr_##HDR_TAG(pdesc, \ 1518 hdr, hdrlen, sizeof(HDR_TYPE)); \ 1519 } \ 1520 1521 1522 _DEFINE_PDESC_TYPED_HDR_ACCESSOR(tcp, struct tcphdr); 1523 _DEFINE_PDESC_TYPED_HDR_ACCESSOR(udp, struct udphdr); 1524 _DEFINE_PDESC_TYPED_HDR_ACCESSOR(icmp, struct icmp); 1525 _DEFINE_PDESC_TYPED_HDR_ACCESSOR(icmp6, struct icmp6_hdr); 1526 _DEFINE_PDESC_TYPED_HDR_ACCESSOR(grev1, struct pf_grev1_hdr); 1527 _DEFINE_PDESC_TYPED_HDR_ACCESSOR(esp, struct pf_esp_hdr); 1528 _DEFINE_PDESC_HDR_ACCESSOR(any, void); 1529 1530 #endif /* KERNEL */ 1531 1532 /* flags for RDR options */ 1533 #define PF_DPORT_RANGE 0x01 /* Dest port uses range */ 1534 #define PF_RPORT_RANGE 0x02 /* RDR'ed port uses range */ 1535 1536 /* Reasons code for passing/dropping a packet */ 1537 #define PFRES_MATCH 0 /* Explicit match of a rule */ 1538 #define PFRES_BADOFF 1 /* Bad offset for pull_hdr */ 1539 #define PFRES_FRAG 2 /* Dropping following fragment */ 1540 #define PFRES_SHORT 3 /* Dropping short packet */ 1541 #define PFRES_NORM 4 /* Dropping by normalizer */ 1542 #define PFRES_MEMORY 5 /* Dropped due to lacking mem */ 1543 #define PFRES_TS 6 /* Bad TCP Timestamp (RFC1323) */ 1544 #define PFRES_CONGEST 7 /* Congestion (of ipintrq) */ 1545 #define PFRES_IPOPTIONS 8 /* IP option */ 1546 #define PFRES_PROTCKSUM 9 /* Protocol checksum invalid */ 1547 #define PFRES_BADSTATE 10 /* State mismatch */ 1548 #define PFRES_STATEINS 11 /* State insertion failure */ 1549 #define PFRES_MAXSTATES 12 /* State limit */ 1550 #define PFRES_SRCLIMIT 13 /* Source node/conn limit */ 1551 #define PFRES_SYNPROXY 14 /* SYN proxy */ 1552 #define PFRES_DUMMYNET 15 /* Dummynet */ 1553 #define PFRES_INVPORT 16 /* Invalid TCP/UDP port */ 1554 #define PFRES_MAX 17 /* total+1 */ 1555 1556 #define PFRES_NAMES { \ 1557 "match", \ 1558 "bad-offset", \ 1559 "fragment", \ 1560 "short", \ 1561 "normalize", \ 1562 "memory", \ 1563 "bad-timestamp", \ 1564 "congestion", \ 1565 "ip-option", \ 1566 "proto-cksum", \ 1567 "state-mismatch", \ 1568 "state-insert", \ 1569 "state-limit", \ 1570 "src-limit", \ 1571 "synproxy", \ 1572 "dummynet", \ 1573 "invalid-port", \ 1574 NULL \ 1575 } 1576 1577 /* Counters for other things we want to keep track of */ 1578 #define LCNT_STATES 0 /* states */ 1579 #define LCNT_SRCSTATES 1 /* max-src-states */ 1580 #define LCNT_SRCNODES 2 /* max-src-nodes */ 1581 #define LCNT_SRCCONN 3 /* max-src-conn */ 1582 #define LCNT_SRCCONNRATE 4 /* max-src-conn-rate */ 1583 #define LCNT_OVERLOAD_TABLE 5 /* entry added to overload table */ 1584 #define LCNT_OVERLOAD_FLUSH 6 /* state entries flushed */ 1585 #define LCNT_MAX 7 /* total+1 */ 1586 1587 #define LCNT_NAMES { \ 1588 "max states per rule", \ 1589 "max-src-states", \ 1590 "max-src-nodes", \ 1591 "max-src-conn", \ 1592 "max-src-conn-rate", \ 1593 "overload table insertion", \ 1594 "overload flush states", \ 1595 NULL \ 1596 } 1597 1598 /* UDP state enumeration */ 1599 #define PFUDPS_NO_TRAFFIC 0 1600 #define PFUDPS_SINGLE 1 1601 #define PFUDPS_MULTIPLE 2 1602 1603 #define PFUDPS_NSTATES 3 /* number of state levels */ 1604 1605 #define PFUDPS_NAMES { \ 1606 "NO_TRAFFIC", \ 1607 "SINGLE", \ 1608 "MULTIPLE", \ 1609 NULL \ 1610 } 1611 1612 /* GREv1 protocol state enumeration */ 1613 #define PFGRE1S_NO_TRAFFIC 0 1614 #define PFGRE1S_INITIATING 1 1615 #define PFGRE1S_ESTABLISHED 2 1616 1617 #define PFGRE1S_NSTATES 3 /* number of state levels */ 1618 1619 #define PFGRE1S_NAMES { \ 1620 "NO_TRAFFIC", \ 1621 "INITIATING", \ 1622 "ESTABLISHED", \ 1623 NULL \ 1624 } 1625 1626 #define PFESPS_NO_TRAFFIC 0 1627 #define PFESPS_INITIATING 1 1628 #define PFESPS_ESTABLISHED 2 1629 1630 #define PFESPS_NSTATES 3 /* number of state levels */ 1631 1632 #define PFESPS_NAMES { "NO_TRAFFIC", "INITIATING", "ESTABLISHED", NULL } 1633 1634 /* Other protocol state enumeration */ 1635 #define PFOTHERS_NO_TRAFFIC 0 1636 #define PFOTHERS_SINGLE 1 1637 #define PFOTHERS_MULTIPLE 2 1638 1639 #define PFOTHERS_NSTATES 3 /* number of state levels */ 1640 1641 #define PFOTHERS_NAMES { \ 1642 "NO_TRAFFIC", \ 1643 "SINGLE", \ 1644 "MULTIPLE", \ 1645 NULL \ 1646 } 1647 1648 #define FCNT_STATE_SEARCH 0 1649 #define FCNT_STATE_INSERT 1 1650 #define FCNT_STATE_REMOVALS 2 1651 #define FCNT_MAX 3 1652 1653 #define SCNT_SRC_NODE_SEARCH 0 1654 #define SCNT_SRC_NODE_INSERT 1 1655 #define SCNT_SRC_NODE_REMOVALS 2 1656 #define SCNT_MAX 3 1657 1658 #ifdef KERNEL 1659 #define ACTION_SET(a, x) \ 1660 do { \ 1661 if ((a) != NULL) \ 1662 *(a) = (x); \ 1663 } while (0) 1664 1665 #define REASON_SET(a, x) \ 1666 do { \ 1667 if ((a) != NULL) \ 1668 *(a) = (x); \ 1669 if (x < PFRES_MAX) \ 1670 pf_status.counters[x]++; \ 1671 } while (0) 1672 #endif /* KERNEL */ 1673 1674 struct pf_status { 1675 u_int64_t counters[PFRES_MAX]; 1676 u_int64_t lcounters[LCNT_MAX]; /* limit counters */ 1677 u_int64_t fcounters[FCNT_MAX]; 1678 u_int64_t scounters[SCNT_MAX]; 1679 u_int64_t pcounters[2][2][3]; 1680 u_int64_t bcounters[2][2]; 1681 u_int64_t stateid; 1682 u_int32_t running; 1683 u_int32_t states; 1684 u_int32_t src_nodes; 1685 u_int64_t since __attribute__((aligned(8))); 1686 u_int32_t debug; 1687 u_int32_t hostid; 1688 char ifname[IFNAMSIZ]; 1689 u_int8_t pf_chksum[PF_MD5_DIGEST_LENGTH]; 1690 }; 1691 1692 struct cbq_opts { 1693 u_int32_t minburst; 1694 u_int32_t maxburst; 1695 u_int32_t pktsize; 1696 u_int32_t maxpktsize; 1697 u_int32_t ns_per_byte; 1698 u_int32_t maxidle; 1699 int32_t minidle; 1700 u_int32_t offtime; 1701 u_int32_t flags; 1702 }; 1703 1704 struct priq_opts { 1705 u_int32_t flags; 1706 }; 1707 1708 struct hfsc_opts { 1709 /* real-time service curve */ 1710 u_int64_t rtsc_m1; /* slope of the 1st segment in bps */ 1711 u_int64_t rtsc_d; /* the x-projection of m1 in msec */ 1712 u_int64_t rtsc_m2; /* slope of the 2nd segment in bps */ 1713 u_int32_t rtsc_fl; /* service curve flags */ 1714 #if !defined(__LP64__) 1715 u_int32_t _pad; 1716 #endif /* !__LP64__ */ 1717 /* link-sharing service curve */ 1718 u_int64_t lssc_m1; 1719 u_int64_t lssc_d; 1720 u_int64_t lssc_m2; 1721 u_int32_t lssc_fl; 1722 #if !defined(__LP64__) 1723 u_int32_t __pad; 1724 #endif /* !__LP64__ */ 1725 /* upper-limit service curve */ 1726 u_int64_t ulsc_m1; 1727 u_int64_t ulsc_d; 1728 u_int64_t ulsc_m2; 1729 u_int32_t ulsc_fl; 1730 u_int32_t flags; /* scheduler flags */ 1731 }; 1732 1733 struct fairq_opts { 1734 u_int32_t nbuckets; /* hash buckets */ 1735 u_int32_t flags; 1736 u_int64_t hogs_m1; /* hog detection bandwidth */ 1737 1738 /* link-sharing service curve */ 1739 u_int64_t lssc_m1; 1740 u_int64_t lssc_d; 1741 u_int64_t lssc_m2; 1742 }; 1743 1744 /* bandwidth types */ 1745 #define PF_ALTQ_BW_ABSOLUTE 1 /* bw in absolute value (bps) */ 1746 #define PF_ALTQ_BW_PERCENT 2 /* bandwidth in percentage */ 1747 1748 /* ALTQ rule flags */ 1749 #define PF_ALTQF_TBR 0x1 /* enable Token Bucket Regulator */ 1750 1751 /* queue rule flags */ 1752 #define PF_ALTQ_QRF_WEIGHT 0x1 /* weight instead of priority */ 1753 1754 struct pf_altq { 1755 char ifname[IFNAMSIZ]; 1756 1757 /* discipline-specific state */ 1758 void *altq_disc __attribute__((aligned(8))); 1759 TAILQ_ENTRY(pf_altq) entries __attribute__((aligned(8))); 1760 #if !defined(__LP64__) 1761 u_int32_t _pad[2]; 1762 #endif /* !__LP64__ */ 1763 1764 u_int32_t aflags; /* ALTQ rule flags */ 1765 u_int32_t bwtype; /* bandwidth type */ 1766 1767 /* scheduler spec */ 1768 u_int32_t scheduler; /* scheduler type */ 1769 u_int32_t tbrsize; /* tokenbucket regulator size */ 1770 u_int64_t ifbandwidth; /* interface bandwidth */ 1771 1772 /* queue spec */ 1773 char qname[PF_QNAME_SIZE]; /* queue name */ 1774 char parent[PF_QNAME_SIZE]; /* parent name */ 1775 u_int32_t parent_qid; /* parent queue id */ 1776 u_int32_t qrflags; /* queue rule flags */ 1777 union { 1778 u_int32_t priority; /* priority */ 1779 u_int32_t weight; /* weight */ 1780 }; 1781 u_int32_t qlimit; /* queue size limit */ 1782 u_int32_t flags; /* misc flags */ 1783 #if !defined(__LP64__) 1784 u_int32_t __pad; 1785 #endif /* !__LP64__ */ 1786 u_int64_t bandwidth; /* queue bandwidth */ 1787 union { 1788 struct cbq_opts cbq_opts; 1789 struct priq_opts priq_opts; 1790 struct hfsc_opts hfsc_opts; 1791 struct fairq_opts fairq_opts; 1792 } pq_u; 1793 1794 u_int32_t qid; /* return value */ 1795 }; 1796 1797 struct pf_tagname { 1798 TAILQ_ENTRY(pf_tagname) entries; 1799 char name[PF_TAG_NAME_SIZE]; 1800 u_int16_t tag; 1801 int ref; 1802 }; 1803 1804 #define PFFRAG_FRENT_HIWAT 5000 /* Number of fragment entries */ 1805 #define PFFRAG_FRAG_HIWAT 1000 /* Number of fragmented packets */ 1806 #define PFFRAG_FRCENT_HIWAT 50000 /* Number of fragment cache entries */ 1807 #define PFFRAG_FRCACHE_HIWAT 10000 /* Number of fragment descriptors */ 1808 1809 #define PFR_KTABLE_HIWAT 1000 /* Number of tables */ 1810 #define PFR_KENTRY_HIWAT 200000 /* Number of table entries */ 1811 #define PFR_KENTRY_HIWAT_SMALL 100000 /* Number of table entries (tiny hosts) */ 1812 1813 /* 1814 * ioctl parameter structures 1815 */ 1816 1817 struct pfioc_pooladdr { 1818 u_int32_t action; 1819 u_int32_t ticket; 1820 u_int32_t nr; 1821 u_int32_t r_num; 1822 u_int8_t r_action; 1823 u_int8_t r_last; 1824 u_int8_t af; 1825 char anchor[MAXPATHLEN]; 1826 struct pf_pooladdr addr; 1827 }; 1828 1829 struct pfioc_rule { 1830 u_int32_t action; 1831 u_int32_t ticket; 1832 u_int32_t pool_ticket; 1833 u_int32_t nr; 1834 char anchor[MAXPATHLEN]; 1835 char anchor_call[MAXPATHLEN]; 1836 struct pf_rule rule; 1837 }; 1838 1839 struct pfioc_natlook { 1840 struct pf_addr saddr; 1841 struct pf_addr daddr; 1842 struct pf_addr rsaddr; 1843 struct pf_addr rdaddr; 1844 union pf_state_xport sxport; 1845 union pf_state_xport dxport; 1846 union pf_state_xport rsxport; 1847 union pf_state_xport rdxport; 1848 sa_family_t af; 1849 u_int8_t proto; 1850 u_int8_t proto_variant; 1851 u_int8_t direction; 1852 }; 1853 1854 struct pfioc_state { 1855 struct pfsync_state state; 1856 }; 1857 1858 struct pfioc_src_node_kill { 1859 /* XXX returns the number of src nodes killed in psnk_af */ 1860 sa_family_t psnk_af; 1861 struct pf_rule_addr psnk_src; 1862 struct pf_rule_addr psnk_dst; 1863 }; 1864 1865 struct pfioc_state_addr_kill { 1866 struct pf_addr_wrap addr; 1867 u_int8_t reserved_[3]; 1868 u_int8_t neg; 1869 union pf_rule_xport xport; 1870 }; 1871 1872 struct pfioc_state_kill { 1873 /* XXX returns the number of states killed in psk_af */ 1874 sa_family_t psk_af; 1875 u_int8_t psk_proto; 1876 u_int8_t psk_proto_variant; 1877 u_int8_t _pad; 1878 struct pfioc_state_addr_kill psk_src; 1879 struct pfioc_state_addr_kill psk_dst; 1880 char psk_ifname[IFNAMSIZ]; 1881 char psk_ownername[PF_OWNER_NAME_SIZE]; 1882 }; 1883 1884 struct pfioc_states { 1885 int ps_len; 1886 union { 1887 caddr_t psu_buf; 1888 struct pfsync_state *psu_states; 1889 } ps_u __attribute__((aligned(8))); 1890 #define ps_buf ps_u.psu_buf 1891 #define ps_states ps_u.psu_states 1892 }; 1893 1894 #ifdef KERNEL 1895 struct pfioc_states_32 { 1896 int ps_len; 1897 union { 1898 user32_addr_t psu_buf; 1899 user32_addr_t psu_states; 1900 } ps_u __attribute__((aligned(8))); 1901 }; 1902 1903 struct pfioc_states_64 { 1904 int ps_len; 1905 union { 1906 user64_addr_t psu_buf; 1907 user64_addr_t psu_states; 1908 } ps_u __attribute__((aligned(8))); 1909 }; 1910 #endif /* KERNEL */ 1911 1912 #define PFTOK_PROCNAME_LEN 64 1913 #pragma pack(1) 1914 struct pfioc_token { 1915 u_int64_t token_value; 1916 u_int64_t timestamp; 1917 pid_t pid; 1918 char proc_name[PFTOK_PROCNAME_LEN]; 1919 }; 1920 #pragma pack() 1921 1922 struct pfioc_kernel_token { 1923 SLIST_ENTRY(pfioc_kernel_token) next; 1924 struct pfioc_token token; 1925 }; 1926 1927 struct pfioc_remove_token { 1928 u_int64_t token_value; 1929 u_int64_t refcount; 1930 }; 1931 1932 struct pfioc_tokens { 1933 int size; 1934 union { 1935 caddr_t pgtu_buf; 1936 struct pfioc_token *pgtu_tokens; 1937 } pgt_u __attribute__((aligned(8))); 1938 #define pgt_buf pgt_u.pgtu_buf 1939 #define pgt_tokens pgt_u.pgtu_tokens 1940 }; 1941 1942 #ifdef KERNEL 1943 struct pfioc_tokens_32 { 1944 int size; 1945 union { 1946 user32_addr_t pgtu_buf; 1947 user32_addr_t pgtu_tokens; 1948 } pgt_u __attribute__((aligned(8))); 1949 }; 1950 1951 struct pfioc_tokens_64 { 1952 int size; 1953 union { 1954 user64_addr_t pgtu_buf; 1955 user64_addr_t pgtu_tokens; 1956 } pgt_u __attribute__((aligned(8))); 1957 }; 1958 #endif /* KERNEL */ 1959 1960 1961 struct pfioc_src_nodes { 1962 int psn_len; 1963 union { 1964 caddr_t psu_buf; 1965 struct pf_src_node *psu_src_nodes; 1966 } psn_u __attribute__((aligned(8))); 1967 #define psn_buf psn_u.psu_buf 1968 #define psn_src_nodes psn_u.psu_src_nodes 1969 }; 1970 1971 #ifdef KERNEL 1972 struct pfioc_src_nodes_32 { 1973 int psn_len; 1974 union { 1975 user32_addr_t psu_buf; 1976 user32_addr_t psu_src_nodes; 1977 } psn_u __attribute__((aligned(8))); 1978 }; 1979 1980 struct pfioc_src_nodes_64 { 1981 int psn_len; 1982 union { 1983 user64_addr_t psu_buf; 1984 user64_addr_t psu_src_nodes; 1985 } psn_u __attribute__((aligned(8))); 1986 }; 1987 #endif /* KERNEL */ 1988 1989 struct pfioc_if { 1990 char ifname[IFNAMSIZ]; 1991 }; 1992 1993 struct pfioc_tm { 1994 int timeout; 1995 int seconds; 1996 }; 1997 1998 struct pfioc_limit { 1999 int index; 2000 unsigned limit; 2001 }; 2002 2003 struct pfioc_altq { 2004 u_int32_t action; 2005 u_int32_t ticket; 2006 u_int32_t nr; 2007 struct pf_altq altq __attribute__((aligned(8))); 2008 }; 2009 2010 struct pfioc_qstats { 2011 u_int32_t ticket; 2012 u_int32_t nr; 2013 void *buf __attribute__((aligned(8))); 2014 int nbytes __attribute__((aligned(8))); 2015 u_int8_t scheduler; 2016 }; 2017 2018 struct pfioc_ruleset { 2019 u_int32_t nr; 2020 char path[MAXPATHLEN]; 2021 char name[PF_ANCHOR_NAME_SIZE]; 2022 }; 2023 2024 #define PF_RULESET_ALTQ (PF_RULESET_MAX) 2025 #define PF_RULESET_TABLE (PF_RULESET_MAX+1) 2026 struct pfioc_trans { 2027 int size; /* number of elements */ 2028 int esize; /* size of each element in bytes */ 2029 struct pfioc_trans_e { 2030 int rs_num; 2031 char anchor[MAXPATHLEN]; 2032 u_int32_t ticket; 2033 } *array __attribute__((aligned(8))); 2034 }; 2035 2036 #ifdef KERNEL 2037 struct pfioc_trans_32 { 2038 int size; /* number of elements */ 2039 int esize; /* size of each element in bytes */ 2040 user32_addr_t array __attribute__((aligned(8))); 2041 }; 2042 2043 struct pfioc_trans_64 { 2044 int size; /* number of elements */ 2045 int esize; /* size of each element in bytes */ 2046 user64_addr_t array __attribute__((aligned(8))); 2047 }; 2048 #endif /* KERNEL */ 2049 2050 2051 #define PFR_FLAG_ATOMIC 0x00000001 2052 #define PFR_FLAG_DUMMY 0x00000002 2053 #define PFR_FLAG_FEEDBACK 0x00000004 2054 #define PFR_FLAG_CLSTATS 0x00000008 2055 #define PFR_FLAG_ADDRSTOO 0x00000010 2056 #define PFR_FLAG_REPLACE 0x00000020 2057 #define PFR_FLAG_ALLRSETS 0x00000040 2058 #define PFR_FLAG_ALLMASK 0x0000007F 2059 #ifdef KERNEL 2060 #define PFR_FLAG_USERIOCTL 0x10000000 2061 #endif /* KERNEL */ 2062 2063 struct pfioc_table { 2064 struct pfr_table pfrio_table; 2065 void *pfrio_buffer __attribute__((aligned(8))); 2066 int pfrio_esize __attribute__((aligned(8))); 2067 int pfrio_size; 2068 int pfrio_size2; 2069 int pfrio_nadd; 2070 int pfrio_ndel; 2071 int pfrio_nchange; 2072 int pfrio_flags; 2073 u_int32_t pfrio_ticket; 2074 }; 2075 #define pfrio_exists pfrio_nadd 2076 #define pfrio_nzero pfrio_nadd 2077 #define pfrio_nmatch pfrio_nadd 2078 #define pfrio_naddr pfrio_size2 2079 #define pfrio_setflag pfrio_size2 2080 #define pfrio_clrflag pfrio_nadd 2081 2082 #ifdef KERNEL 2083 struct pfioc_table_32 { 2084 struct pfr_table pfrio_table; 2085 user32_addr_t pfrio_buffer __attribute__((aligned(8))); 2086 int pfrio_esize __attribute__((aligned(8))); 2087 int pfrio_size; 2088 int pfrio_size2; 2089 int pfrio_nadd; 2090 int pfrio_ndel; 2091 int pfrio_nchange; 2092 int pfrio_flags; 2093 u_int32_t pfrio_ticket; 2094 }; 2095 2096 struct pfioc_table_64 { 2097 struct pfr_table pfrio_table; 2098 user64_addr_t pfrio_buffer __attribute__((aligned(8))); 2099 int pfrio_esize __attribute__((aligned(8))); 2100 int pfrio_size; 2101 int pfrio_size2; 2102 int pfrio_nadd; 2103 int pfrio_ndel; 2104 int pfrio_nchange; 2105 int pfrio_flags; 2106 u_int32_t pfrio_ticket; 2107 }; 2108 #endif /* KERNEL */ 2109 2110 struct pfioc_iface { 2111 char pfiio_name[IFNAMSIZ]; 2112 void *pfiio_buffer __attribute__((aligned(8))); 2113 int pfiio_esize __attribute__((aligned(8))); 2114 int pfiio_size; 2115 int pfiio_nzero; 2116 int pfiio_flags; 2117 }; 2118 2119 #ifdef KERNEL 2120 struct pfioc_iface_32 { 2121 char pfiio_name[IFNAMSIZ]; 2122 user32_addr_t pfiio_buffer __attribute__((aligned(8))); 2123 int pfiio_esize __attribute__((aligned(8))); 2124 int pfiio_size; 2125 int pfiio_nzero; 2126 int pfiio_flags; 2127 }; 2128 2129 struct pfioc_iface_64 { 2130 char pfiio_name[IFNAMSIZ]; 2131 user64_addr_t pfiio_buffer __attribute__((aligned(8))); 2132 int pfiio_esize __attribute__((aligned(8))); 2133 int pfiio_size; 2134 int pfiio_nzero; 2135 int pfiio_flags; 2136 }; 2137 #endif /* KERNEL */ 2138 2139 struct pf_ifspeed { 2140 char ifname[IFNAMSIZ]; 2141 u_int64_t baudrate; 2142 }; 2143 2144 /* 2145 * ioctl operations 2146 */ 2147 2148 #define DIOCSTART _IO ('D', 1) 2149 #define DIOCSTOP _IO ('D', 2) 2150 #define DIOCADDRULE _IOWR('D', 4, struct pfioc_rule) 2151 #define DIOCGETSTARTERS _IOWR('D', 5, struct pfioc_tokens) 2152 #define DIOCGETRULES _IOWR('D', 6, struct pfioc_rule) 2153 #define DIOCGETRULE _IOWR('D', 7, struct pfioc_rule) 2154 #define DIOCSTARTREF _IOR ('D', 8, u_int64_t) 2155 #define DIOCSTOPREF _IOWR('D', 9, struct pfioc_remove_token) 2156 /* XXX cut 10 - 17 */ 2157 #define DIOCCLRSTATES _IOWR('D', 18, struct pfioc_state_kill) 2158 #define DIOCGETSTATE _IOWR('D', 19, struct pfioc_state) 2159 #define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_if) 2160 #define DIOCGETSTATUS _IOWR('D', 21, struct pf_status) 2161 #define DIOCCLRSTATUS _IO ('D', 22) 2162 #define DIOCNATLOOK _IOWR('D', 23, struct pfioc_natlook) 2163 #define DIOCSETDEBUG _IOWR('D', 24, u_int32_t) 2164 #define DIOCGETSTATES _IOWR('D', 25, struct pfioc_states) 2165 #define DIOCCHANGERULE _IOWR('D', 26, struct pfioc_rule) 2166 #define DIOCINSERTRULE _IOWR('D', 27, struct pfioc_rule) 2167 #define DIOCDELETERULE _IOWR('D', 28, struct pfioc_rule) 2168 #define DIOCSETTIMEOUT _IOWR('D', 29, struct pfioc_tm) 2169 #define DIOCGETTIMEOUT _IOWR('D', 30, struct pfioc_tm) 2170 #define DIOCADDSTATE _IOWR('D', 37, struct pfioc_state) 2171 #define DIOCCLRRULECTRS _IO ('D', 38) 2172 #define DIOCGETLIMIT _IOWR('D', 39, struct pfioc_limit) 2173 #define DIOCSETLIMIT _IOWR('D', 40, struct pfioc_limit) 2174 #define DIOCKILLSTATES _IOWR('D', 41, struct pfioc_state_kill) 2175 #define DIOCSTARTALTQ _IO ('D', 42) 2176 #define DIOCSTOPALTQ _IO ('D', 43) 2177 #define DIOCADDALTQ _IOWR('D', 45, struct pfioc_altq) 2178 #define DIOCGETALTQS _IOWR('D', 47, struct pfioc_altq) 2179 #define DIOCGETALTQ _IOWR('D', 48, struct pfioc_altq) 2180 #define DIOCCHANGEALTQ _IOWR('D', 49, struct pfioc_altq) 2181 #define DIOCGETQSTATS _IOWR('D', 50, struct pfioc_qstats) 2182 #define DIOCBEGINADDRS _IOWR('D', 51, struct pfioc_pooladdr) 2183 #define DIOCADDADDR _IOWR('D', 52, struct pfioc_pooladdr) 2184 #define DIOCGETADDRS _IOWR('D', 53, struct pfioc_pooladdr) 2185 #define DIOCGETADDR _IOWR('D', 54, struct pfioc_pooladdr) 2186 #define DIOCCHANGEADDR _IOWR('D', 55, struct pfioc_pooladdr) 2187 /* XXX cut 55 - 57 */ 2188 #define DIOCGETRULESETS _IOWR('D', 58, struct pfioc_ruleset) 2189 #define DIOCGETRULESET _IOWR('D', 59, struct pfioc_ruleset) 2190 #define DIOCRCLRTABLES _IOWR('D', 60, struct pfioc_table) 2191 #define DIOCRADDTABLES _IOWR('D', 61, struct pfioc_table) 2192 #define DIOCRDELTABLES _IOWR('D', 62, struct pfioc_table) 2193 #define DIOCRGETTABLES _IOWR('D', 63, struct pfioc_table) 2194 #define DIOCRGETTSTATS _IOWR('D', 64, struct pfioc_table) 2195 #define DIOCRCLRTSTATS _IOWR('D', 65, struct pfioc_table) 2196 #define DIOCRCLRADDRS _IOWR('D', 66, struct pfioc_table) 2197 #define DIOCRADDADDRS _IOWR('D', 67, struct pfioc_table) 2198 #define DIOCRDELADDRS _IOWR('D', 68, struct pfioc_table) 2199 #define DIOCRSETADDRS _IOWR('D', 69, struct pfioc_table) 2200 #define DIOCRGETADDRS _IOWR('D', 70, struct pfioc_table) 2201 #define DIOCRGETASTATS _IOWR('D', 71, struct pfioc_table) 2202 #define DIOCRCLRASTATS _IOWR('D', 72, struct pfioc_table) 2203 #define DIOCRTSTADDRS _IOWR('D', 73, struct pfioc_table) 2204 #define DIOCRSETTFLAGS _IOWR('D', 74, struct pfioc_table) 2205 #define DIOCRINADEFINE _IOWR('D', 77, struct pfioc_table) 2206 #define DIOCOSFPFLUSH _IO('D', 78) 2207 #define DIOCOSFPADD _IOWR('D', 79, struct pf_osfp_ioctl) 2208 #define DIOCOSFPGET _IOWR('D', 80, struct pf_osfp_ioctl) 2209 #define DIOCXBEGIN _IOWR('D', 81, struct pfioc_trans) 2210 #define DIOCXCOMMIT _IOWR('D', 82, struct pfioc_trans) 2211 #define DIOCXROLLBACK _IOWR('D', 83, struct pfioc_trans) 2212 #define DIOCGETSRCNODES _IOWR('D', 84, struct pfioc_src_nodes) 2213 #define DIOCCLRSRCNODES _IO('D', 85) 2214 #define DIOCSETHOSTID _IOWR('D', 86, u_int32_t) 2215 #define DIOCIGETIFACES _IOWR('D', 87, struct pfioc_iface) 2216 #define DIOCSETIFFLAG _IOWR('D', 89, struct pfioc_iface) 2217 #define DIOCCLRIFFLAG _IOWR('D', 90, struct pfioc_iface) 2218 #define DIOCKILLSRCNODES _IOWR('D', 91, struct pfioc_src_node_kill) 2219 #define DIOCGIFSPEED _IOWR('D', 92, struct pf_ifspeed) 2220 2221 #ifdef KERNEL_PRIVATE 2222 RB_HEAD(pf_src_tree, pf_src_node); 2223 RB_PROTOTYPE_SC(__private_extern__, pf_src_tree, pf_src_node, entry, 2224 pf_src_compare); 2225 extern struct pf_src_tree tree_src_tracking; 2226 2227 RB_HEAD(pf_state_tree_id, pf_state); 2228 RB_PROTOTYPE_SC(__private_extern__, pf_state_tree_id, pf_state, 2229 entry_id, pf_state_compare_id); 2230 extern struct pf_state_tree_id tree_id; 2231 extern struct pf_state_queue state_list; 2232 2233 TAILQ_HEAD(pf_poolqueue, pf_pool); 2234 extern struct pf_poolqueue pf_pools[2]; 2235 extern struct pf_palist pf_pabuf; 2236 extern u_int32_t ticket_pabuf; 2237 extern struct pf_poolqueue *pf_pools_active; 2238 extern struct pf_poolqueue *pf_pools_inactive; 2239 2240 __private_extern__ int pf_tbladdr_setup(struct pf_ruleset *, 2241 struct pf_addr_wrap *); 2242 __private_extern__ void pf_tbladdr_remove(struct pf_addr_wrap *); 2243 __private_extern__ void pf_tbladdr_copyout(struct pf_addr_wrap *); 2244 __private_extern__ void pf_calc_skip_steps(struct pf_rulequeue *); 2245 __private_extern__ u_int32_t pf_calc_state_key_flowhash(struct pf_state_key *); 2246 2247 extern struct pool pf_src_tree_pl, pf_rule_pl; 2248 extern struct pool pf_state_pl, pf_state_key_pl, pf_pooladdr_pl; 2249 extern struct pool pf_state_scrub_pl; 2250 extern struct pool pf_app_state_pl; 2251 2252 extern struct thread *pf_purge_thread; 2253 2254 extern void pf_register_m_tag(void); 2255 2256 __private_extern__ void pfinit(void); 2257 __private_extern__ void pf_purge_thread_fn(void *, wait_result_t) __dead2; 2258 __private_extern__ void pf_purge_expired_src_nodes(void); 2259 __private_extern__ void pf_purge_expired_states(u_int32_t); 2260 __private_extern__ void pf_unlink_state(struct pf_state *); 2261 __private_extern__ void pf_free_state(struct pf_state *); 2262 __private_extern__ int pf_insert_state(struct pfi_kif *, struct pf_state *); 2263 __private_extern__ int pf_insert_src_node(struct pf_src_node **, 2264 struct pf_rule *, struct pf_addr *, sa_family_t); 2265 __private_extern__ void pf_src_tree_remove_state(struct pf_state *); 2266 __private_extern__ struct pf_state *pf_find_state_byid(struct pf_state_cmp *); 2267 __private_extern__ struct pf_state *pf_find_state_all(struct pf_state_key_cmp *, 2268 u_int, int *); 2269 __private_extern__ void pf_print_state(struct pf_state *); 2270 __private_extern__ void pf_print_flags(u_int8_t); 2271 __private_extern__ u_int16_t pf_cksum_fixup(u_int16_t, u_int16_t, u_int16_t, 2272 u_int8_t); 2273 2274 extern struct ifnet *sync_ifp; 2275 extern struct pf_rule pf_default_rule; 2276 __private_extern__ void pf_addrcpy(struct pf_addr *, struct pf_addr *, 2277 u_int8_t); 2278 __private_extern__ void pf_rm_rule(struct pf_rulequeue *, struct pf_rule *); 2279 2280 struct ip_fw_args; 2281 2282 extern boolean_t is_nlc_enabled_glb; 2283 2284 #if INET 2285 __private_extern__ int pf_test_mbuf(int, struct ifnet *, struct mbuf **, 2286 struct ether_header *, struct ip_fw_args *); 2287 #endif /* INET */ 2288 2289 __private_extern__ int pf_test6_mbuf(int, struct ifnet *, struct mbuf **, 2290 struct ether_header *, struct ip_fw_args *); 2291 __private_extern__ void pf_poolmask(struct pf_addr *, struct pf_addr *, 2292 struct pf_addr *, struct pf_addr *, u_int8_t); 2293 __private_extern__ void pf_addr_inc(struct pf_addr *, sa_family_t); 2294 __private_extern__ int pf_normalize_ip6(pbuf_t *, int, struct pfi_kif *, 2295 u_short *, struct pf_pdesc *); 2296 __private_extern__ int pf_refragment6(struct ifnet *, pbuf_t **, 2297 struct pf_fragment_tag *); 2298 2299 __private_extern__ void *pf_lazy_makewritable(struct pf_pdesc *, 2300 pbuf_t *, int); 2301 __private_extern__ void *pf_pull_hdr(pbuf_t *, int, void __sized_by(p_buflen) * p, int p_buflen, int copylen, 2302 u_short *, u_short *, sa_family_t); 2303 __private_extern__ void pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t); 2304 __private_extern__ int pflog_packet(struct pfi_kif *, pbuf_t *, 2305 sa_family_t, u_int8_t, u_int8_t, struct pf_rule *, struct pf_rule *, 2306 struct pf_ruleset *, struct pf_pdesc *); 2307 __private_extern__ int pf_match_addr(u_int8_t, struct pf_addr *, 2308 struct pf_addr *, struct pf_addr *, sa_family_t); 2309 __private_extern__ int pf_match_addr_range(struct pf_addr *, struct pf_addr *, 2310 struct pf_addr *, sa_family_t); 2311 __private_extern__ int pf_match(u_int8_t, u_int32_t, u_int32_t, u_int32_t); 2312 __private_extern__ int pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t); 2313 __private_extern__ int pf_match_xport(u_int8_t, u_int8_t, union pf_rule_xport *, 2314 union pf_state_xport *); 2315 __private_extern__ int pf_match_uid(u_int8_t, uid_t, uid_t, uid_t); 2316 __private_extern__ int pf_match_gid(u_int8_t, gid_t, gid_t, gid_t); 2317 2318 __private_extern__ void pf_normalize_init(void); 2319 __private_extern__ int pf_normalize_isempty(void); 2320 __private_extern__ int pf_normalize_ip(pbuf_t *, int, struct pfi_kif *, 2321 u_short *, struct pf_pdesc *); 2322 __private_extern__ int pf_normalize_tcp(int, struct pfi_kif *, pbuf_t *, 2323 int, int, void *, struct pf_pdesc *); 2324 __private_extern__ void pf_normalize_tcp_cleanup(struct pf_state *); 2325 __private_extern__ int pf_normalize_tcp_init(pbuf_t *, int, 2326 struct pf_pdesc *, struct tcphdr *, struct pf_state_peer *, 2327 struct pf_state_peer *); 2328 __private_extern__ int pf_normalize_tcp_stateful(pbuf_t *, int, 2329 struct pf_pdesc *, u_short *, struct tcphdr *, struct pf_state *, 2330 struct pf_state_peer *, struct pf_state_peer *, int *); 2331 __private_extern__ u_int64_t pf_state_expires(const struct pf_state *); 2332 __private_extern__ void pf_purge_expired_fragments(void); 2333 __private_extern__ int pf_routable(struct pf_addr *addr, sa_family_t af, 2334 struct pfi_kif *); 2335 __private_extern__ int pf_rtlabel_match(struct pf_addr *, sa_family_t, 2336 struct pf_addr_wrap *); 2337 __private_extern__ int pf_socket_lookup(int, struct pf_pdesc *); 2338 __private_extern__ struct pf_state_key *pf_alloc_state_key(struct pf_state *, 2339 struct pf_state_key *); 2340 __private_extern__ void pf_detach_state(struct pf_state *, int); 2341 __private_extern__ void pfr_initialize(void); 2342 __private_extern__ int pfr_match_addr(struct pfr_ktable *, struct pf_addr *, 2343 sa_family_t); 2344 __private_extern__ void pfr_update_stats(struct pfr_ktable *, struct pf_addr *, 2345 sa_family_t, u_int64_t, int, int, int); 2346 __private_extern__ int pfr_pool_get(struct pfr_ktable *, int *, 2347 struct pf_addr *, struct pf_addr **, struct pf_addr **, sa_family_t); 2348 __private_extern__ void pfr_dynaddr_update(struct pfr_ktable *, 2349 struct pfi_dynaddr *); 2350 __private_extern__ void pfr_table_copyin_cleanup(struct pfr_table *); 2351 __private_extern__ struct pfr_ktable *pfr_attach_table(struct pf_ruleset *, 2352 char const *); 2353 __private_extern__ void pfr_detach_table(struct pfr_ktable *); 2354 __private_extern__ int pfr_clr_tables(struct pfr_table *, int *, int); 2355 __private_extern__ int pfr_add_tables(user_addr_t, int, int *, int); 2356 __private_extern__ int pfr_del_tables(user_addr_t, int, int *, int); 2357 __private_extern__ int pfr_get_tables(struct pfr_table *, user_addr_t, 2358 int *, int); 2359 __private_extern__ int pfr_get_tstats(struct pfr_table *, user_addr_t, 2360 int *, int); 2361 __private_extern__ int pfr_clr_tstats(user_addr_t, int, int *, int); 2362 __private_extern__ int pfr_set_tflags(user_addr_t, int, int, int, int *, 2363 int *, int); 2364 __private_extern__ int pfr_clr_addrs(struct pfr_table *, int *, int); 2365 __private_extern__ int pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *, 2366 u_int64_t); 2367 __private_extern__ int pfr_add_addrs(struct pfr_table *, user_addr_t, 2368 int, int *, int); 2369 __private_extern__ int pfr_del_addrs(struct pfr_table *, user_addr_t, 2370 int, int *, int); 2371 __private_extern__ int pfr_set_addrs(struct pfr_table *, user_addr_t, 2372 int, int *, int *, int *, int *, int, u_int32_t); 2373 __private_extern__ int pfr_get_addrs(struct pfr_table *, user_addr_t, 2374 int *, int); 2375 __private_extern__ int pfr_get_astats(struct pfr_table *, user_addr_t, 2376 int *, int); 2377 __private_extern__ int pfr_clr_astats(struct pfr_table *, user_addr_t, 2378 int, int *, int); 2379 __private_extern__ int pfr_tst_addrs(struct pfr_table *, user_addr_t, 2380 int, int *, int); 2381 __private_extern__ int pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, 2382 int); 2383 __private_extern__ int pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, 2384 int); 2385 __private_extern__ int pfr_ina_commit(struct pfr_table *, u_int32_t, int *, 2386 int *, int); 2387 __private_extern__ int pfr_ina_define(struct pfr_table *, user_addr_t, 2388 int, int *, int *, u_int32_t, int); 2389 2390 extern struct pfi_kif *pfi_all; 2391 2392 __private_extern__ void pfi_initialize(void); 2393 __private_extern__ struct pfi_kif *pfi_kif_get(const char *); 2394 __private_extern__ void pfi_kif_ref(struct pfi_kif *, enum pfi_kif_refs); 2395 __private_extern__ void pfi_kif_unref(struct pfi_kif *, enum pfi_kif_refs); 2396 __private_extern__ int pfi_kif_match(struct pfi_kif *, struct pfi_kif *); 2397 __private_extern__ void pfi_attach_ifnet(struct ifnet *); 2398 __private_extern__ void pfi_detach_ifnet(struct ifnet *); 2399 __private_extern__ int pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *, 2400 sa_family_t); 2401 __private_extern__ int pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t); 2402 __private_extern__ void pfi_dynaddr_remove(struct pf_addr_wrap *); 2403 __private_extern__ void pfi_dynaddr_copyout(struct pf_addr_wrap *); 2404 __private_extern__ void pfi_update_status(const char *__null_terminated, struct pf_status *); 2405 __private_extern__ int pfi_get_ifaces(const char *, user_addr_t, int *); 2406 __private_extern__ int pfi_set_flags(const char *, int); 2407 __private_extern__ int pfi_clear_flags(const char *, int); 2408 2409 __private_extern__ u_int16_t pf_tagname2tag(char const *); 2410 __private_extern__ u_int16_t pf_tagname2tag_ext(char const *); 2411 __private_extern__ void pf_tag_ref(u_int16_t); 2412 __private_extern__ void pf_tag_unref(u_int16_t); 2413 __private_extern__ int pf_tag_packet(pbuf_t *, struct pf_mtag *, 2414 int, unsigned int, struct pf_pdesc *); 2415 __private_extern__ void pf_step_into_anchor(int *, struct pf_ruleset **, int, 2416 struct pf_rule **, struct pf_rule **, int *); 2417 __private_extern__ int pf_step_out_of_anchor(int *, struct pf_ruleset **, int, 2418 struct pf_rule **, struct pf_rule **, int *); 2419 __private_extern__ u_int32_t pf_qname2qid(char *); 2420 __private_extern__ void pf_qid2qname(u_int32_t, char *); 2421 __private_extern__ void pf_qid_unref(u_int32_t); 2422 2423 extern struct pf_status pf_status; 2424 extern struct pool pf_frent_pl, pf_frag_pl; 2425 2426 struct pf_pool_limit { 2427 void *pp; 2428 unsigned limit; 2429 }; 2430 extern struct pf_pool_limit pf_pool_limits[PF_LIMIT_MAX]; 2431 2432 __private_extern__ int pf_af_hook(struct ifnet *, struct mbuf **, 2433 struct mbuf **, unsigned int, int, struct ip_fw_args *); 2434 __private_extern__ int pf_ifaddr_hook(struct ifnet *); 2435 __private_extern__ void pf_ifnet_hook(struct ifnet *, int); 2436 2437 extern int pf_is_enabled; 2438 extern int16_t pf_nat64_configured; 2439 #define PF_IS_ENABLED (pf_is_enabled != 0) 2440 extern u_int32_t pf_hash_seed; 2441 2442 __private_extern__ int pf_get_ruleset_number(u_int8_t); 2443 __private_extern__ void pf_init_ruleset(struct pf_ruleset *); 2444 __private_extern__ int pf_anchor_setup(struct pf_rule *, 2445 const struct pf_ruleset *, const char *__counted_by(len), size_t len); 2446 __private_extern__ int pf_anchor_copyout(const struct pf_ruleset *, 2447 const struct pf_rule *, struct pfioc_rule *); 2448 __private_extern__ void pf_anchor_remove(struct pf_rule *); 2449 __private_extern__ void pf_remove_if_empty_ruleset(struct pf_ruleset *); 2450 __private_extern__ struct pf_anchor *pf_find_anchor(const char *); 2451 __private_extern__ int pf_reference_anchor(struct pf_anchor *a); 2452 __private_extern__ int pf_release_anchor(struct pf_anchor *a); 2453 __private_extern__ int pf_release_ruleset(struct pf_ruleset *r); 2454 __private_extern__ struct pf_ruleset *pf_find_ruleset(const char *); 2455 __private_extern__ struct pf_ruleset *pf_find_ruleset_with_owner(const char *, 2456 const char *, int, int *); 2457 __private_extern__ struct pf_ruleset *pf_find_or_create_ruleset(const char *); 2458 __private_extern__ void pf_rs_initialize(void); 2459 2460 __private_extern__ int pf_osfp_add(struct pf_osfp_ioctl *); 2461 __private_extern__ struct pf_osfp_enlist *pf_osfp_fingerprint(struct pf_pdesc *, 2462 pbuf_t *, int, const struct tcphdr *); 2463 __private_extern__ struct pf_osfp_enlist *pf_osfp_fingerprint_hdr( 2464 const struct ip *, const struct ip6_hdr *, const struct tcphdr *__sized_by(tcphdr_max_len), size_t tcphdr_max_len); 2465 __private_extern__ void pf_osfp_flush(void); 2466 __private_extern__ int pf_osfp_get(struct pf_osfp_ioctl *); 2467 __private_extern__ void pf_osfp_initialize(void); 2468 __private_extern__ int pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t); 2469 __private_extern__ struct pf_os_fingerprint *pf_osfp_validate(void); 2470 __private_extern__ struct pf_mtag *pf_find_mtag(struct mbuf *); 2471 __private_extern__ struct pf_mtag *pf_find_mtag_pbuf(pbuf_t *); 2472 __private_extern__ struct pf_mtag *pf_get_mtag(struct mbuf *); 2473 __private_extern__ struct pf_mtag *pf_get_mtag_pbuf(pbuf_t *); 2474 __private_extern__ struct pf_fragment_tag * pf_find_fragment_tag_pbuf(pbuf_t *); 2475 __private_extern__ struct pf_fragment_tag * pf_find_fragment_tag(struct mbuf *); 2476 __private_extern__ struct pf_fragment_tag * pf_copy_fragment_tag(struct mbuf *, 2477 struct pf_fragment_tag *, int); 2478 #if SKYWALK 2479 #define PF_COMPATIBLE_FLAGS_PF_ENABLED 0x00000001 2480 #define PF_COMPATIBLE_FLAGS_CUSTOM_ANCHORS_PRESENT 0x00000002 2481 #define PF_COMPATIBLE_FLAGS_CUSTOM_RULES_PRESENT 0x00000004 2482 2483 __private_extern__ uint32_t pf_check_compatible_rules(void); 2484 #endif // SKYWALK 2485 #endif /* KERNEL_PRIVATE */ 2486 extern struct pf_anchor_global pf_anchors; 2487 extern struct pf_anchor pf_main_anchor; 2488 #define pf_main_ruleset pf_main_anchor.ruleset 2489 2490 #ifdef __cplusplus 2491 } 2492 #endif 2493 #endif /* PF || !KERNEL */ 2494 #endif /* PRIVATE */ 2495 #endif /* _NET_PFVAR_H_ */ 2496