sys/net/pf/pfvar.h

   1 /*      $OpenBSD: pfvar.h,v 1.276 2008/07/03 15:46:23 henning Exp $ */
   2
   3 /*
   4  * Copyright (c) 2010 The DragonFly Project.  All rights reserved.
   5  *
   6  * Copyright (c) 2001 Daniel Hartmeier
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  *
  13  *    - Redistributions of source code must retain the above copyright
  14  *      notice, this list of conditions and the following disclaimer.
  15  *    - Redistributions in binary form must reproduce the above
  16  *      copyright notice, this list of conditions and the following
  17  *      disclaimer in the documentation and/or other materials provided
  18  *      with the distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  24  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  */
  34
  35 #ifndef _NET_PFVAR_H_
  36 #define _NET_PFVAR_H_
  37
  38 #include <sys/param.h>
  39 #include <sys/types.h>
  40 #include <sys/limits.h>
  41 #include <sys/ioccom.h>
  42 #include <sys/queue.h>
  43 #include <sys/tree.h>
  44 #include <sys/lock.h>
  45
  46 #include <net/radix.h>
  47 #include <net/if_clone.h>
  48 #include <netinet/in.h>
  49 #include <netinet/in_pcb.h>
  50
  51
  52 /*
  53  * XXX
  54  *  If we include <netipsec/keydb.h>, we need _KERNEL definition.
  55  *  This makes pfctl compilation difficult.
  56  */
  57 union sockaddr_union {
  58         struct sockaddr         sa;
  59         struct sockaddr_in      sin;
  60         struct sockaddr_in6     sin6;
  61 };
  62
  63 #include <netinet/tcp_fsm.h>
  64
  65 struct ip;
  66 struct ip6_hdr;
  67
  68 extern struct lwkt_token pf_token;
  69
  70 #define PF_TCPS_PROXY_SRC       ((TCP_NSTATES)+0)
  71 #define PF_TCPS_PROXY_DST       ((TCP_NSTATES)+1)
  72
  73
  74 #define RTLABEL_LEN 32
  75 #define IFG_ALL         "all"           /* group contains all interfaces */
  76 #define BPF_DIRECTION_OUT       (1<<1)
  77 #define PWAIT 0
  78 #define RT_NUMFIBS 1
  79 #define ALTQ_IS_ENABLED(ifq)            ((ifq)->altq_flags & ALTQF_ENABLED)
  80
  81
  82 #define PF_MD5_DIGEST_LENGTH    16
  83 #ifdef MD5_DIGEST_LENGTH
  84 #if PF_MD5_DIGEST_LENGTH != MD5_DIGEST_LENGTH
  85 #error
  86 #endif
  87 #endif
  88
  89 enum    { PF_INOUT, PF_IN, PF_OUT };
  90 enum    { PF_PASS, PF_DROP, PF_SCRUB, PF_NOSCRUB, PF_NAT, PF_NONAT,
  91           PF_BINAT, PF_NOBINAT, PF_RDR, PF_NORDR, PF_SYNPROXY_DROP };
  92 enum    { PF_RULESET_SCRUB, PF_RULESET_FILTER, PF_RULESET_NAT,
  93           PF_RULESET_BINAT, PF_RULESET_RDR, PF_RULESET_MAX };
  94 enum    { PF_OP_NONE, PF_OP_IRG, PF_OP_EQ, PF_OP_NE, PF_OP_LT,
  95           PF_OP_LE, PF_OP_GT, PF_OP_GE, PF_OP_XRG, PF_OP_RRG };
  96 enum    { PF_DEBUG_NONE, PF_DEBUG_URGENT, PF_DEBUG_MISC, PF_DEBUG_NOISY };
  97 enum    { PF_CHANGE_NONE, PF_CHANGE_ADD_HEAD, PF_CHANGE_ADD_TAIL,
  98           PF_CHANGE_ADD_BEFORE, PF_CHANGE_ADD_AFTER,
  99           PF_CHANGE_REMOVE, PF_CHANGE_GET_TICKET };
 100 enum    { PF_GET_NONE, PF_GET_CLR_CNTR };
 101 enum    { PF_SK_WIRE, PF_SK_STACK, PF_SK_BOTH };
 102
 103 /*
 104  * Note about PFTM_*: real indices into pf_rule.timeout[] come before
 105  * PFTM_MAX, special cases afterwards. See pf_state_expires().
 106  */
 107 enum    { PFTM_TCP_FIRST_PACKET, PFTM_TCP_OPENING, PFTM_TCP_ESTABLISHED,
 108           PFTM_TCP_CLOSING, PFTM_TCP_FIN_WAIT, PFTM_TCP_CLOSED,
 109           PFTM_UDP_FIRST_PACKET, PFTM_UDP_SINGLE, PFTM_UDP_MULTIPLE,
 110           PFTM_ICMP_FIRST_PACKET, PFTM_ICMP_ERROR_REPLY,
 111           PFTM_OTHER_FIRST_PACKET, PFTM_OTHER_SINGLE,
 112           PFTM_OTHER_MULTIPLE, PFTM_FRAG, PFTM_INTERVAL,
 113           PFTM_ADAPTIVE_START, PFTM_ADAPTIVE_END, PFTM_SRC_NODE,
 114           PFTM_TS_DIFF, PFTM_MAX, PFTM_PURGE, PFTM_UNLINKED,
 115           PFTM_UNTIL_PACKET };
 116
 117 /* PFTM default values */
 118 #define PFTM_TCP_FIRST_PACKET_VAL       120     /* First TCP packet */
 119 #define PFTM_TCP_OPENING_VAL            30      /* No response yet */
 120 #define PFTM_TCP_ESTABLISHED_VAL        24*60*60/* Established */
 121 #define PFTM_TCP_CLOSING_VAL            15 * 60 /* Half closed */
 122 #define PFTM_TCP_FIN_WAIT_VAL           45      /* Got both FINs */
 123 #define PFTM_TCP_CLOSED_VAL             90      /* Got a RST */
 124 #define PFTM_UDP_FIRST_PACKET_VAL       60      /* First UDP packet */
 125 #define PFTM_UDP_SINGLE_VAL             30      /* Unidirectional */
 126 #define PFTM_UDP_MULTIPLE_VAL           60      /* Bidirectional */
 127 #define PFTM_ICMP_FIRST_PACKET_VAL      20      /* First ICMP packet */
 128 #define PFTM_ICMP_ERROR_REPLY_VAL       10      /* Got error response */
 129 #define PFTM_OTHER_FIRST_PACKET_VAL     60      /* First packet */
 130 #define PFTM_OTHER_SINGLE_VAL           30      /* Unidirectional */
 131 #define PFTM_OTHER_MULTIPLE_VAL         60      /* Bidirectional */
 132 #define PFTM_FRAG_VAL                   30      /* Fragment expire */
 133 #define PFTM_INTERVAL_VAL               10      /* Expire interval */
 134 #define PFTM_SRC_NODE_VAL               0       /* Source tracking */
 135 #define PFTM_TS_DIFF_VAL                30      /* Allowed TS diff */
 136
 137 enum    { PF_NOPFROUTE, PF_FASTROUTE, PF_ROUTETO, PF_DUPTO, PF_REPLYTO };
 138 enum    { PF_LIMIT_STATES, PF_LIMIT_SRC_NODES, PF_LIMIT_FRAGS,
 139           PF_LIMIT_TABLES, PF_LIMIT_TABLE_ENTRIES, PF_LIMIT_MAX };
 140 #define PF_POOL_IDMASK          0x0f
 141 enum    { PF_POOL_NONE, PF_POOL_BITMASK, PF_POOL_RANDOM,
 142           PF_POOL_SRCHASH, PF_POOL_ROUNDROBIN };
 143 enum    { PF_ADDR_ADDRMASK, PF_ADDR_NOROUTE, PF_ADDR_DYNIFTL,
 144           PF_ADDR_TABLE, PF_ADDR_RTLABEL, PF_ADDR_URPFFAILED,
 145           PF_ADDR_RANGE };
 146 #define PF_POOL_TYPEMASK        0x0f
 147 #define PF_POOL_STICKYADDR      0x20
 148 #define PF_WSCALE_FLAG          0x80
 149 #define PF_WSCALE_MASK          0x0f
 150
 151 #define PF_LOG                  0x01
 152 #define PF_LOG_ALL              0x02
 153 #define PF_LOG_SOCKET_LOOKUP    0x04
 154
 155 #define PR_WAITOK       0x0001 /* M_WAITOK */
 156 #define PR_NOWAIT       0x0002 /* M_NOWAIT */
 157 #define PR_LIMITFAIL    0x0004 /* M_CANFAIL */
 158 #define PR_ZERO         0x0008 /* M_ZERO */
 159
 160
 161 struct pf_addr {
 162         union {
 163                 struct in_addr          v4;
 164                 struct in6_addr         v6;
 165                 u_int8_t                addr8[16];
 166                 u_int16_t               addr16[8];
 167                 u_int32_t               addr32[4];
 168         } pfa;              /* 128-bit address */
 169 #define v4      pfa.v4
 170 #define v6      pfa.v6
 171 #define addr8   pfa.addr8
 172 #define addr16  pfa.addr16
 173 #define addr32  pfa.addr32
 174 };
 175
 176 #define PF_TABLE_NAME_SIZE       32
 177
 178 #define PFI_AFLAG_NETWORK       0x01
 179 #define PFI_AFLAG_BROADCAST     0x02
 180 #define PFI_AFLAG_PEER          0x04
 181 #define PFI_AFLAG_MODEMASK      0x07
 182 #define PFI_AFLAG_NOALIAS       0x08
 183
 184 struct pf_addr_wrap {
 185         union {
 186                 struct {
 187                         struct pf_addr           addr;
 188                         struct pf_addr           mask;
 189                 }                        a;
 190                 char                     ifname[IFNAMSIZ];
 191                 char                     tblname[PF_TABLE_NAME_SIZE];
 192                 char                     rtlabelname[RTLABEL_LEN];
 193                 u_int32_t                rtlabel;
 194         }                        v;
 195         union {
 196                 struct pfi_dynaddr      *dyn;
 197                 struct pfr_ktable       *tbl;
 198                 int                      dyncnt;
 199                 int                      tblcnt;
 200         }                        p;
 201         u_int8_t                 type;          /* PF_ADDR_* */
 202         u_int8_t                 iflags;        /* PFI_AFLAG_* */
 203 };
 204
 205 #ifdef _KERNEL
 206
 207 struct pfi_dynaddr {
 208         TAILQ_ENTRY(pfi_dynaddr)         entry;
 209         struct pf_addr                   pfid_addr4;
 210         struct pf_addr                   pfid_mask4;
 211         struct pf_addr                   pfid_addr6;
 212         struct pf_addr                   pfid_mask6;
 213         struct pfr_ktable               *pfid_kt;
 214         struct pfi_kif                  *pfid_kif;
 215         void                            *pfid_hook_cookie;
 216         int                              pfid_net;      /* mask or 128 */
 217         int                              pfid_acnt4;    /* address count IPv4 */
 218         int                              pfid_acnt6;    /* address count IPv6 */
 219         sa_family_t                      pfid_af;       /* rule af */
 220         u_int8_t                         pfid_iflags;   /* PFI_AFLAG_* */
 221 };
 222
 223 /*
 224  * Address manipulation macros
 225  */
 226
 227 #define NTOHS(x)        (x) = ntohs((__uint16_t)(x))
 228 #define HTONS(x)        (x) = htons((__uint16_t)(x))
 229
 230 #define PF_NAME         "pf"
 231
 232 #define PF_MODVER       44
 233 #define PFLOG_MODVER    44
 234 #define PFSYNC_MODVER   44
 235
 236 #define PFLOG_MINVER    44
 237 #define PFLOG_PREFVER   PFLOG_MODVER
 238 #define PFLOG_MAXVER    44
 239 #define PFSYNC_MINVER   44
 240 #define PFSYNC_PREFVER  PFSYNC_MODVER
 241 #define PFSYNC_MAXVER   44
 242
 243 /* prototyped for pf_subr.c */
 244 struct hook_desc {
 245         TAILQ_ENTRY(hook_desc) hd_list;
 246         void    (*hd_fn)(void *);
 247         void    *hd_arg;
 248 };
 249 TAILQ_HEAD(hook_desc_head, hook_desc);
 250
 251 void *hook_establish(struct hook_desc_head *, int, void (*)(void *), void *);
 252 void hook_disestablish(struct hook_desc_head *, void *);
 253 void dohooks(struct hook_desc_head *, int);
 254
 255 #define HOOK_REMOVE     0x01
 256 #define HOOK_FREE       0x02
 257
 258 #ifdef INET
 259 #ifndef INET6
 260 #define PF_INET_ONLY
 261 #endif /* ! INET6 */
 262 #endif /* INET */
 263
 264 #ifdef INET6
 265 #ifndef INET
 266 #define PF_INET6_ONLY
 267 #endif /* ! INET */
 268 #endif /* INET6 */
 269
 270 #ifdef INET
 271 #ifdef INET6
 272 #define PF_INET_INET6
 273 #endif /* INET6 */
 274 #endif /* INET */
 275
 276 #else
 277
 278 #define PF_INET_INET6
 279
 280 #endif /* _KERNEL */
 281
 282 /* Both IPv4 and IPv6 */
 283 #ifdef PF_INET_INET6
 284
 285 #define PF_AEQ(a, b, c) \
 286         ((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \
 287         ((a)->addr32[3] == (b)->addr32[3] && \
 288         (a)->addr32[2] == (b)->addr32[2] && \
 289         (a)->addr32[1] == (b)->addr32[1] && \
 290         (a)->addr32[0] == (b)->addr32[0])) \
 291
 292 #define PF_ANEQ(a, b, c) \
 293         ((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \
 294         ((a)->addr32[3] != (b)->addr32[3] || \
 295         (a)->addr32[2] != (b)->addr32[2] || \
 296         (a)->addr32[1] != (b)->addr32[1] || \
 297         (a)->addr32[0] != (b)->addr32[0])) \
 298
 299 #define PF_AZERO(a, c) \
 300         ((c == AF_INET && !(a)->addr32[0]) || \
 301         (!(a)->addr32[0] && !(a)->addr32[1] && \
 302         !(a)->addr32[2] && !(a)->addr32[3] )) \
 303
 304 #define PF_MATCHA(n, a, m, b, f) \
 305         pf_match_addr(n, a, m, b, f)
 306
 307 #define PF_ACPY(a, b, f) \
 308         pf_addrcpy(a, b, f)
 309
 310 #define PF_AINC(a, f) \
 311         pf_addr_inc(a, f)
 312
 313 #define PF_POOLMASK(a, b, c, d, f) \
 314         pf_poolmask(a, b, c, d, f)
 315
 316 #else
 317
 318 /* Just IPv6 */
 319
 320 #ifdef PF_INET6_ONLY
 321
 322 #define PF_AEQ(a, b, c) \
 323         ((a)->addr32[3] == (b)->addr32[3] && \
 324         (a)->addr32[2] == (b)->addr32[2] && \
 325         (a)->addr32[1] == (b)->addr32[1] && \
 326         (a)->addr32[0] == (b)->addr32[0]) \
 327
 328 #define PF_ANEQ(a, b, c) \
 329         ((a)->addr32[3] != (b)->addr32[3] || \
 330         (a)->addr32[2] != (b)->addr32[2] || \
 331         (a)->addr32[1] != (b)->addr32[1] || \
 332         (a)->addr32[0] != (b)->addr32[0]) \
 333
 334 #define PF_AZERO(a, c) \
 335         (!(a)->addr32[0] && \
 336         !(a)->addr32[1] && \
 337         !(a)->addr32[2] && \
 338         !(a)->addr32[3] ) \
 339
 340 #define PF_MATCHA(n, a, m, b, f) \
 341         pf_match_addr(n, a, m, b, f)
 342
 343 #define PF_ACPY(a, b, f) \
 344         pf_addrcpy(a, b, f)
 345
 346 #define PF_AINC(a, f) \
 347         pf_addr_inc(a, f)
 348
 349 #define PF_POOLMASK(a, b, c, d, f) \
 350         pf_poolmask(a, b, c, d, f)
 351
 352 #else
 353
 354 /* Just IPv4 */
 355 #ifdef PF_INET_ONLY
 356
 357 #define PF_AEQ(a, b, c) \
 358         ((a)->addr32[0] == (b)->addr32[0])
 359
 360 #define PF_ANEQ(a, b, c) \
 361         ((a)->addr32[0] != (b)->addr32[0])
 362
 363 #define PF_AZERO(a, c) \
 364         (!(a)->addr32[0])
 365
 366 #define PF_MATCHA(n, a, m, b, f) \
 367         pf_match_addr(n, a, m, b, f)
 368
 369 #define PF_ACPY(a, b, f) \
 370         (a)->v4.s_addr = (b)->v4.s_addr
 371
 372 #define PF_AINC(a, f) \
 373         do { \
 374                 (a)->addr32[0] = htonl(ntohl((a)->addr32[0]) + 1); \
 375         } while (0)
 376
 377 #define PF_POOLMASK(a, b, c, d, f) \
 378         do { \
 379                 (a)->addr32[0] = ((b)->addr32[0] & (c)->addr32[0]) | \
 380                 (((c)->addr32[0] ^ 0xffffffff ) & (d)->addr32[0]); \
 381         } while (0)
 382
 383 #endif /* PF_INET_ONLY */
 384 #endif /* PF_INET6_ONLY */
 385 #endif /* PF_INET_INET6 */
 386
 387 #define PF_MISMATCHAW(aw, x, af, neg, ifp)                              \
 388         (                                                               \
 389                 (((aw)->type == PF_ADDR_NOROUTE &&                      \
 390                     pf_routable((x), (af), NULL)) ||                    \
 391                 (((aw)->type == PF_ADDR_URPFFAILED && (ifp) != NULL &&  \
 392                     pf_routable((x), (af), (ifp))) ||                   \
 393                 ((aw)->type == PF_ADDR_RTLABEL &&                       \
 394                     !pf_rtlabel_match((x), (af), (aw))) ||              \
 395                 ((aw)->type == PF_ADDR_TABLE &&                         \
 396                     !pfr_match_addr((aw)->p.tbl, (x), (af))) ||         \
 397                 ((aw)->type == PF_ADDR_DYNIFTL &&                       \
 398                     !pfi_match_addr((aw)->p.dyn, (x), (af))) ||         \
 399                 ((aw)->type == PF_ADDR_RANGE &&                         \
 400                     !pf_match_addr_range(&(aw)->v.a.addr,               \
 401                     &(aw)->v.a.mask, (x), (af))) ||                     \
 402                 ((aw)->type == PF_ADDR_ADDRMASK &&                      \
 403                     !PF_AZERO(&(aw)->v.a.mask, (af)) &&                 \
 404                     !PF_MATCHA(0, &(aw)->v.a.addr,                      \
 405                     &(aw)->v.a.mask, (x), (af))))) !=                   \
 406                 (neg)                                                   \
 407         )
 408
 409 struct pf_rule_uid {
 410         uid_t            uid[2];
 411         u_int8_t         op;
 412 };
 413
 414 struct pf_rule_gid {
 415         uid_t            gid[2];
 416         u_int8_t         op;
 417 };
 418
 419 struct pf_rule_addr {
 420         struct pf_addr_wrap      addr;
 421         u_int16_t                port[2];
 422         u_int8_t                 neg;
 423         u_int8_t                 port_op;
 424 };
 425
 426 struct pf_pooladdr {
 427         struct pf_addr_wrap              addr;
 428         TAILQ_ENTRY(pf_pooladdr)         entries;
 429         char                             ifname[IFNAMSIZ];
 430         struct pfi_kif                  *kif;
 431 };
 432
 433 TAILQ_HEAD(pf_palist, pf_pooladdr);
 434
 435 struct pf_poolhashkey {
 436         union {
 437                 u_int8_t                key8[16];
 438                 u_int16_t               key16[8];
 439                 u_int32_t               key32[4];
 440         } pfk;              /* 128-bit hash key */
 441 #define key8    pfk.key8
 442 #define key16   pfk.key16
 443 #define key32   pfk.key32
 444 };
 445
 446 struct pf_pool {
 447         struct pf_palist         list;
 448         struct pf_pooladdr      *cur;
 449         struct pf_poolhashkey    key;
 450         struct pf_addr           counter;
 451         int                      tblidx;
 452         u_int16_t                proxy_port[2];
 453         u_int8_t                 port_op;
 454         u_int8_t                 opts;
 455 };
 456
 457
 458 /* A packed Operating System description for fingerprinting */
 459 typedef u_int32_t pf_osfp_t;
 460 #define PF_OSFP_ANY     ((pf_osfp_t)0)
 461 #define PF_OSFP_UNKNOWN ((pf_osfp_t)-1)
 462 #define PF_OSFP_NOMATCH ((pf_osfp_t)-2)
 463
 464 struct pf_osfp_entry {
 465         SLIST_ENTRY(pf_osfp_entry) fp_entry;
 466         pf_osfp_t               fp_os;
 467         int                     fp_enflags;
 468 #define PF_OSFP_EXPANDED        0x001           /* expanded entry */
 469 #define PF_OSFP_GENERIC         0x002           /* generic signature */
 470 #define PF_OSFP_NODETAIL        0x004           /* no p0f details */
 471 #define PF_OSFP_LEN     32
 472         char                    fp_class_nm[PF_OSFP_LEN];
 473         char                    fp_version_nm[PF_OSFP_LEN];
 474         char                    fp_subtype_nm[PF_OSFP_LEN];
 475 };
 476 #define PF_OSFP_ENTRY_EQ(a, b) \
 477     ((a)->fp_os == (b)->fp_os && \
 478     memcmp((a)->fp_class_nm, (b)->fp_class_nm, PF_OSFP_LEN) == 0 && \
 479     memcmp((a)->fp_version_nm, (b)->fp_version_nm, PF_OSFP_LEN) == 0 && \
 480     memcmp((a)->fp_subtype_nm, (b)->fp_subtype_nm, PF_OSFP_LEN) == 0)
 481
 482 /* handle pf_osfp_t packing */
 483 #define _FP_RESERVED_BIT        1  /* For the special negative #defines */
 484 #define _FP_UNUSED_BITS         1
 485 #define _FP_CLASS_BITS          10 /* OS Class (Windows, Linux) */
 486 #define _FP_VERSION_BITS        10 /* OS version (95, 98, NT, 2.4.54, 3.2) */
 487 #define _FP_SUBTYPE_BITS        10 /* patch level (NT SP4, SP3, ECN patch) */
 488 #define PF_OSFP_UNPACK(osfp, class, version, subtype) do { \
 489         (class) = ((osfp) >> (_FP_VERSION_BITS+_FP_SUBTYPE_BITS)) & \
 490             ((1 << _FP_CLASS_BITS) - 1); \
 491         (version) = ((osfp) >> _FP_SUBTYPE_BITS) & \
 492             ((1 << _FP_VERSION_BITS) - 1);\
 493         (subtype) = (osfp) & ((1 << _FP_SUBTYPE_BITS) - 1); \
 494 } while(0)
 495 #define PF_OSFP_PACK(osfp, class, version, subtype) do { \
 496         (osfp) = ((class) & ((1 << _FP_CLASS_BITS) - 1)) << (_FP_VERSION_BITS \
 497             + _FP_SUBTYPE_BITS); \
 498         (osfp) |= ((version) & ((1 << _FP_VERSION_BITS) - 1)) << \
 499             _FP_SUBTYPE_BITS; \
 500         (osfp) |= (subtype) & ((1 << _FP_SUBTYPE_BITS) - 1); \
 501 } while(0)
 502
 503 /* the fingerprint of an OSes TCP SYN packet */
 504 typedef u_int64_t       pf_tcpopts_t;
 505 struct pf_os_fingerprint {
 506         SLIST_HEAD(pf_osfp_enlist, pf_osfp_entry) fp_oses; /* list of matches */
 507         pf_tcpopts_t            fp_tcpopts;     /* packed TCP options */
 508         u_int16_t               fp_wsize;       /* TCP window size */
 509         u_int16_t               fp_psize;       /* ip->ip_len */
 510         u_int16_t               fp_mss;         /* TCP MSS */
 511         u_int16_t               fp_flags;
 512 #define PF_OSFP_WSIZE_MOD       0x0001          /* Window modulus */
 513 #define PF_OSFP_WSIZE_DC        0x0002          /* Window don't care */
 514 #define PF_OSFP_WSIZE_MSS       0x0004          /* Window multiple of MSS */
 515 #define PF_OSFP_WSIZE_MTU       0x0008          /* Window multiple of MTU */
 516 #define PF_OSFP_PSIZE_MOD       0x0010          /* packet size modulus */
 517 #define PF_OSFP_PSIZE_DC        0x0020          /* packet size don't care */
 518 #define PF_OSFP_WSCALE          0x0040          /* TCP window scaling */
 519 #define PF_OSFP_WSCALE_MOD      0x0080          /* TCP window scale modulus */
 520 #define PF_OSFP_WSCALE_DC       0x0100          /* TCP window scale dont-care */
 521 #define PF_OSFP_MSS             0x0200          /* TCP MSS */
 522 #define PF_OSFP_MSS_MOD         0x0400          /* TCP MSS modulus */
 523 #define PF_OSFP_MSS_DC          0x0800          /* TCP MSS dont-care */
 524 #define PF_OSFP_DF              0x1000          /* IPv4 don't fragment bit */
 525 #define PF_OSFP_TS0             0x2000          /* Zero timestamp */
 526 #define PF_OSFP_INET6           0x4000          /* IPv6 */
 527         u_int8_t                fp_optcnt;      /* TCP option count */
 528         u_int8_t                fp_wscale;      /* TCP window scaling */
 529         u_int8_t                fp_ttl;         /* IPv4 TTL */
 530 #define PF_OSFP_MAXTTL_OFFSET   40
 531 /* TCP options packing */
 532 #define PF_OSFP_TCPOPT_NOP      0x0             /* TCP NOP option */
 533 #define PF_OSFP_TCPOPT_WSCALE   0x1             /* TCP window scaling option */
 534 #define PF_OSFP_TCPOPT_MSS      0x2             /* TCP max segment size opt */
 535 #define PF_OSFP_TCPOPT_SACK     0x3             /* TCP SACK OK option */
 536 #define PF_OSFP_TCPOPT_TS       0x4             /* TCP timestamp option */
 537 #define PF_OSFP_TCPOPT_BITS     3               /* bits used by each option */
 538 #define PF_OSFP_MAX_OPTS \
 539     (sizeof(((struct pf_os_fingerprint *)0)->fp_tcpopts) * 8) \
 540     / PF_OSFP_TCPOPT_BITS
 541
 542         SLIST_ENTRY(pf_os_fingerprint)  fp_next;
 543 };
 544
 545 struct pf_osfp_ioctl {
 546         struct pf_osfp_entry    fp_os;
 547         pf_tcpopts_t            fp_tcpopts;     /* packed TCP options */
 548         u_int16_t               fp_wsize;       /* TCP window size */
 549         u_int16_t               fp_psize;       /* ip->ip_len */
 550         u_int16_t               fp_mss;         /* TCP MSS */
 551         u_int16_t               fp_flags;
 552         u_int8_t                fp_optcnt;      /* TCP option count */
 553         u_int8_t                fp_wscale;      /* TCP window scaling */
 554         u_int8_t                fp_ttl;         /* IPv4 TTL */
 555
 556         int                     fp_getnum;      /* DIOCOSFPGET number */
 557 };
 558
 559
 560 union pf_rule_ptr {
 561         struct pf_rule          *ptr;
 562         u_int32_t                nr;
 563 };
 564
 565 #define PF_ANCHOR_NAME_SIZE      64
 566
 567 struct pf_rule {
 568         struct pf_rule_addr      src;
 569         struct pf_rule_addr      dst;
 570 #define PF_SKIP_IFP             0
 571 #define PF_SKIP_DIR             1
 572 #define PF_SKIP_AF              2
 573 #define PF_SKIP_PROTO           3
 574 #define PF_SKIP_SRC_ADDR        4
 575 #define PF_SKIP_SRC_PORT        5
 576 #define PF_SKIP_DST_ADDR        6
 577 #define PF_SKIP_DST_PORT        7
 578 #define PF_SKIP_COUNT           8
 579         union pf_rule_ptr        skip[PF_SKIP_COUNT];
 580 #define PF_RULE_LABEL_SIZE       64
 581         char                     label[PF_RULE_LABEL_SIZE];
 582 #define PF_QNAME_SIZE            64
 583         char                     ifname[IFNAMSIZ];
 584         char                     qname[PF_QNAME_SIZE];
 585         char                     pqname[PF_QNAME_SIZE];
 586 #define PF_TAG_NAME_SIZE         64
 587         char                     tagname[PF_TAG_NAME_SIZE];
 588         char                     match_tagname[PF_TAG_NAME_SIZE];
 589
 590         char                     overload_tblname[PF_TABLE_NAME_SIZE];
 591
 592         TAILQ_ENTRY(pf_rule)     entries;
 593         struct pf_pool           rpool;
 594
 595         u_int64_t                evaluations;
 596         u_int64_t                packets[2];
 597         u_int64_t                bytes[2];
 598
 599         struct pfi_kif          *kif;
 600         struct pf_anchor        *anchor;
 601         struct pfr_ktable       *overload_tbl;
 602
 603         pf_osfp_t                os_fingerprint;
 604
 605         int                      rtableid;
 606         u_int32_t                timeout[PFTM_MAX];
 607         u_int32_t                states_cur;
 608         u_int32_t                states_tot;
 609         u_int32_t                max_states;
 610         u_int32_t                src_nodes;
 611         u_int32_t                max_src_nodes;
 612         u_int32_t                max_src_states;
 613         u_int32_t                max_src_conn;
 614         struct {
 615                 u_int32_t               limit;
 616                 u_int32_t               seconds;
 617         }                        max_src_conn_rate;
 618         u_int32_t                qid;
 619         u_int32_t                pqid;
 620         u_int32_t                rt_listid;
 621         u_int32_t                nr;
 622         u_int32_t                prob;
 623         uid_t                    cuid;
 624         pid_t                    cpid;
 625
 626         u_int16_t                return_icmp;
 627         u_int16_t                return_icmp6;
 628         u_int16_t                max_mss;
 629         u_int16_t                tag;
 630         u_int16_t                match_tag;
 631
 632         struct pf_rule_uid       uid;
 633         struct pf_rule_gid       gid;
 634
 635         u_int32_t                rule_flag;
 636         u_int8_t                 action;
 637         u_int8_t                 direction;
 638         u_int8_t                 log;
 639         u_int8_t                 logif;
 640         u_int8_t                 quick;
 641         u_int8_t                 ifnot;
 642         u_int8_t                 match_tag_not;
 643         u_int8_t                 natpass;
 644
 645 #define PF_STATE_NORMAL         0x1
 646 #define PF_STATE_MODULATE       0x2
 647 #define PF_STATE_SYNPROXY       0x3
 648         u_int8_t                 keep_state;
 649         sa_family_t              af;
 650         u_int8_t                 proto;
 651         u_int8_t                 type;
 652         u_int8_t                 code;
 653         u_int8_t                 flags;
 654         u_int8_t                 flagset;
 655         u_int8_t                 min_ttl;
 656         u_int8_t                 allow_opts;
 657         u_int8_t                 rt;
 658         u_int8_t                 return_ttl;
 659         u_int8_t                 tos;
 660         u_int8_t                 set_tos;
 661         u_int8_t                 anchor_relative;
 662         u_int8_t                 anchor_wildcard;
 663
 664 #define PF_FLUSH                0x01
 665 #define PF_FLUSH_GLOBAL         0x02
 666         u_int8_t                 flush;
 667
 668         struct {
 669                 struct pf_addr          addr;
 670                 u_int16_t               port;
 671         }                       divert;
 672
 673 #define PF_PICKUPS_UNSPECIFIED  0
 674 #define PF_PICKUPS_DISABLED     1
 675 #define PF_PICKUPS_HASHONLY     2
 676 #define PF_PICKUPS_ENABLED      3
 677         u_int8_t                 pickup_mode;
 678         u_int8_t                 unused01;      /* available for use */
 679 };
 680
 681 /* rule flags */
 682 #define PFRULE_DROP             0x0000
 683 #define PFRULE_RETURNRST        0x0001
 684 #define PFRULE_FRAGMENT         0x0002
 685 #define PFRULE_RETURNICMP       0x0004
 686 #define PFRULE_RETURN           0x0008
 687 #define PFRULE_NOSYNC           0x0010
 688 #define PFRULE_SRCTRACK         0x0020  /* track source states */
 689 #define PFRULE_RULESRCTRACK     0x0040  /* per rule */
 690
 691 /* scrub flags */
 692 #define PFRULE_NODF             0x0100
 693 #define PFRULE_FRAGCROP         0x0200  /* non-buffering frag cache */
 694 #define PFRULE_FRAGDROP         0x0400  /* drop funny fragments */
 695 #define PFRULE_RANDOMID         0x0800
 696 #define PFRULE_REASSEMBLE_TCP   0x1000
 697 #define PFRULE_SET_TOS          0x2000
 698
 699 /* rule flags again */
 700 #define PFRULE_IFBOUND          0x00010000      /* if-bound */
 701 #define PFRULE_STATESLOPPY      0x00020000      /* sloppy state tracking */
 702
 703 #define PFSTATE_HIWAT           10000   /* default state table size */
 704 #define PFSTATE_ADAPT_START     6000    /* default adaptive timeout start */
 705 #define PFSTATE_ADAPT_END       12000   /* default adaptive timeout end */
 706
 707
 708 struct pf_threshold {
 709         u_int32_t       limit;
 710 #define PF_THRESHOLD_MULT       1000
 711 #define PF_THRESHOLD_MAX        0xffffffff / PF_THRESHOLD_MULT
 712         u_int32_t       seconds;
 713         u_int32_t       count;
 714         u_int32_t       last;
 715 };
 716
 717 struct pf_src_node {
 718         RB_ENTRY(pf_src_node) entry;
 719         struct pf_addr   addr;
 720         struct pf_addr   raddr;
 721         union pf_rule_ptr rule;
 722         struct pfi_kif  *kif;
 723         u_int64_t        bytes[2];
 724         u_int64_t        packets[2];
 725         u_int32_t        states;
 726         u_int32_t        conn;
 727         struct pf_threshold     conn_rate;
 728         u_int32_t        creation;
 729         u_int32_t        expire;
 730         sa_family_t      af;
 731         u_int8_t         ruletype;
 732 };
 733
 734 #define PFSNODE_HIWAT           10000   /* default source node table size */
 735
 736 struct pf_state_scrub {
 737         struct timeval  pfss_last;      /* time received last packet    */
 738         u_int32_t       pfss_tsecr;     /* last echoed timestamp        */
 739         u_int32_t       pfss_tsval;     /* largest timestamp            */
 740         u_int32_t       pfss_tsval0;    /* original timestamp           */
 741         u_int16_t       pfss_flags;
 742 #define PFSS_TIMESTAMP  0x0001          /* modulate timestamp           */
 743 #define PFSS_PAWS       0x0010          /* stricter PAWS checks         */
 744 #define PFSS_PAWS_IDLED 0x0020          /* was idle too long.  no PAWS  */
 745 #define PFSS_DATA_TS    0x0040          /* timestamp on data packets    */
 746 #define PFSS_DATA_NOTS  0x0080          /* no timestamp on data packets */
 747         u_int8_t        pfss_ttl;       /* stashed TTL                  */
 748         u_int8_t        pad;
 749         u_int32_t       pfss_ts_mod;    /* timestamp modulation         */
 750 };
 751
 752 struct pf_state_host {
 753         struct pf_addr  addr;
 754         u_int16_t       port;
 755         u_int16_t       pad;
 756 };
 757
 758 struct pf_state_peer {
 759         struct pf_state_scrub   *scrub; /* state is scrubbed            */
 760         u_int32_t       seqlo;          /* Max sequence number sent     */
 761         u_int32_t       seqhi;          /* Max the other end ACKd + win */
 762         u_int32_t       seqdiff;        /* Sequence number modulator    */
 763         u_int16_t       max_win;        /* largest window (pre scaling) */
 764         u_int16_t       mss;            /* Maximum segment size option  */
 765         u_int8_t        state;          /* active state level           */
 766         u_int8_t        wscale;         /* window scaling factor        */
 767         u_int8_t        tcp_est;        /* Did we reach TCPS_ESTABLISHED */
 768         u_int8_t        pad[1];
 769 };
 770
 771 TAILQ_HEAD(pf_state_queue, pf_state);
 772
 773 /* keep synced with struct pf_state_key, used in RB_FIND */
 774 struct pf_state_key_cmp {
 775         struct pf_addr   addr[2];
 776         u_int16_t        port[2];
 777         sa_family_t      af;
 778         u_int8_t         proto;
 779         u_int8_t         pad[2];
 780 };
 781
 782 struct pf_state_item {
 783         TAILQ_ENTRY(pf_state_item)       entry;
 784         struct pf_state                 *s;
 785 };
 786
 787 TAILQ_HEAD(pf_statelisthead, pf_state_item);
 788
 789 struct pf_state_key {
 790         struct pf_addr   addr[2];
 791         u_int16_t        port[2];
 792         sa_family_t      af;
 793         u_int8_t         proto;
 794         u_int8_t         pad[2];
 795
 796         RB_ENTRY(pf_state_key)   entry;
 797         struct pf_statelisthead  states;
 798         struct pf_state_key     *reverse;
 799         struct inpcb            *inp;
 800 };
 801
 802 /* keep synced with struct pf_state, used in RB_FIND */
 803 struct pf_state_cmp {
 804         u_int64_t                id;
 805         u_int32_t                creatorid;
 806         u_int8_t                 direction;
 807         u_int8_t                 pad[3];
 808 };
 809
 810 struct pf_state {
 811         u_int64_t                id;
 812         u_int32_t                creatorid;
 813         u_int8_t                 direction;
 814         u_int8_t                 pad[3];
 815
 816         TAILQ_ENTRY(pf_state)    entry_list;
 817         RB_ENTRY(pf_state)       entry_id;
 818         struct pf_state_peer     src;
 819         struct pf_state_peer     dst;
 820         union pf_rule_ptr        rule;
 821         union pf_rule_ptr        anchor;
 822         union pf_rule_ptr        nat_rule;
 823         struct pf_addr           rt_addr;
 824         struct pf_state_key     *key[2];        /* addresses stack and wire  */
 825         struct pfi_kif          *kif;
 826         struct pfi_kif          *rt_kif;
 827         struct pf_src_node      *src_node;
 828         struct pf_src_node      *nat_src_node;
 829         u_int64_t                packets[2];
 830         u_int64_t                bytes[2];
 831         u_int32_t                hash;
 832         u_int32_t                creation;
 833         u_int32_t                expire;
 834         u_int32_t                pfsync_time;
 835         u_int16_t                tag;
 836         u_int8_t                 log;
 837         u_int8_t                 state_flags;
 838 #define PFSTATE_ALLOWOPTS       0x01
 839 #define PFSTATE_SLOPPY          0x02
 840         u_int8_t                 timeout;
 841         u_int8_t                 sync_flags;
 842         u_int8_t                 pickup_mode;
 843 #define PFSTATE_NOSYNC   0x01
 844 #define PFSTATE_FROMSYNC 0x02
 845 #define PFSTATE_STALE    0x04
 846 };
 847
 848 /*
 849  * Unified state structures for pulling states out of the kernel
 850  * used by pfsync(4) and the pf(4) ioctl.
 851  */
 852 struct pfsync_state_scrub {
 853         u_int16_t       pfss_flags;
 854         u_int8_t        pfss_ttl;       /* stashed TTL          */
 855 #define PFSYNC_SCRUB_FLAG_VALID         0x01
 856         u_int8_t        scrub_flag;
 857         u_int32_t       pfss_ts_mod;    /* timestamp modulation */
 858 } __packed;
 859
 860 struct pfsync_state_peer {
 861         struct pfsync_state_scrub scrub;        /* state is scrubbed    */
 862         u_int32_t       seqlo;          /* Max sequence number sent     */
 863         u_int32_t       seqhi;          /* Max the other end ACKd + win */
 864         u_int32_t       seqdiff;        /* Sequence number modulator    */
 865         u_int16_t       max_win;        /* largest window (pre scaling) */
 866         u_int16_t       mss;            /* Maximum segment size option  */
 867         u_int8_t        state;          /* active state level           */
 868         u_int8_t        wscale;         /* window scaling factor        */
 869         u_int8_t        pad[6];
 870 } __packed;
 871
 872 struct pfsync_state_key {
 873         struct pf_addr   addr[2];
 874         u_int16_t        port[2];
 875 };
 876
 877 struct pfsync_state {
 878         u_int32_t        id[2];
 879         char             ifname[IFNAMSIZ];
 880         struct pfsync_state_key key[2];
 881         struct pfsync_state_peer src;
 882         struct pfsync_state_peer dst;
 883         struct pf_addr   rt_addr;
 884         u_int32_t        rule;
 885         u_int32_t        anchor;
 886         u_int32_t        nat_rule;
 887         u_int32_t        creation;
 888         u_int32_t        expire;
 889         u_int32_t        packets[2][2];
 890         u_int32_t        bytes[2][2];
 891         u_int32_t        creatorid;
 892         sa_family_t      af;
 893         u_int8_t         proto;
 894         u_int8_t         direction;
 895         u_int8_t         log;
 896         u_int8_t         state_flags;
 897         u_int8_t         timeout;
 898         u_int8_t         sync_flags;
 899         u_int8_t         updates;
 900 };
 901
 902 #define PFSYNC_FLAG_COMPRESS    0x01
 903 #define PFSYNC_FLAG_STALE       0x02
 904 #define PFSYNC_FLAG_SRCNODE     0x04
 905 #define PFSYNC_FLAG_NATSRCNODE  0x08
 906 #define PFSTATE_GOT_SYN_MASK    (PFSTATE_GOT_SYN1|PFSTATE_GOT_SYN2)
 907 #define PFSTATE_GOT_SYN1 0x04   /* got SYN in one direction */
 908 #define PFSTATE_GOT_SYN2 0x08   /* got SYN in the other direction */
 909
 910 /* for copies to/from network byte order */
 911 /* ioctl interface also uses network byte order */
 912 #define pf_state_peer_hton(s,d) do {            \
 913         (d)->seqlo = htonl((s)->seqlo);         \
 914         (d)->seqhi = htonl((s)->seqhi);         \
 915         (d)->seqdiff = htonl((s)->seqdiff);     \
 916         (d)->max_win = htons((s)->max_win);     \
 917         (d)->mss = htons((s)->mss);             \
 918         (d)->state = (s)->state;                \
 919         (d)->wscale = (s)->wscale;              \
 920         if ((s)->scrub) {                                               \
 921                 (d)->scrub.pfss_flags =                                 \
 922                     htons((s)->scrub->pfss_flags & PFSS_TIMESTAMP);     \
 923                 (d)->scrub.pfss_ttl = (s)->scrub->pfss_ttl;             \
 924                 (d)->scrub.pfss_ts_mod = htonl((s)->scrub->pfss_ts_mod);\
 925                 (d)->scrub.scrub_flag = PFSYNC_SCRUB_FLAG_VALID;        \
 926         }                                                               \
 927 } while (0)
 928
 929 #define pf_state_peer_ntoh(s,d) do {            \
 930         (d)->seqlo = ntohl((s)->seqlo);         \
 931         (d)->seqhi = ntohl((s)->seqhi);         \
 932         (d)->seqdiff = ntohl((s)->seqdiff);     \
 933         (d)->max_win = ntohs((s)->max_win);     \
 934         (d)->mss = ntohs((s)->mss);             \
 935         (d)->state = (s)->state;                \
 936         (d)->wscale = (s)->wscale;              \
 937         if ((s)->scrub.scrub_flag == PFSYNC_SCRUB_FLAG_VALID &&         \
 938             (d)->scrub != NULL) {                                       \
 939                 (d)->scrub->pfss_flags =                                \
 940                     ntohs((s)->scrub.pfss_flags) & PFSS_TIMESTAMP;      \
 941                 (d)->scrub->pfss_ttl = (s)->scrub.pfss_ttl;             \
 942                 (d)->scrub->pfss_ts_mod = ntohl((s)->scrub.pfss_ts_mod);\
 943         }                                                               \
 944 } while (0)
 945
 946 #define pf_state_counter_hton(s,d) do {                         \
 947         d[0] = htonl((s>>32)&0xffffffff);                       \
 948         d[1] = htonl(s&0xffffffff);                             \
 949 } while (0)
 950
 951 #define pf_state_counter_from_pfsync(s)                         \
 952         (((u_int64_t)(s[0])<<32) | (u_int64_t)(s[1]))
 953
 954 #define pf_state_counter_ntoh(s,d) do {                         \
 955         d = ntohl(s[0]);                                        \
 956         d = d<<32;                                              \
 957         d += ntohl(s[1]);                                       \
 958 } while (0)
 959
 960 TAILQ_HEAD(pf_rulequeue, pf_rule);
 961
 962 struct pf_anchor;
 963
 964 struct pf_ruleset {
 965         struct {
 966                 struct pf_rulequeue      queues[2];
 967                 struct {
 968                         struct pf_rulequeue     *ptr;
 969                         struct pf_rule          **ptr_array;
 970                         u_int32_t                rcount;
 971                         u_int32_t                ticket;
 972                         int                      open;
 973                 }                        active, inactive;
 974         }                        rules[PF_RULESET_MAX];
 975         struct pf_anchor        *anchor;
 976         u_int32_t                tticket;
 977         int                      tables;
 978         int                      topen;
 979 };
 980
 981 RB_HEAD(pf_anchor_global, pf_anchor);
 982 RB_HEAD(pf_anchor_node, pf_anchor);
 983 struct pf_anchor {
 984         RB_ENTRY(pf_anchor)      entry_global;
 985         RB_ENTRY(pf_anchor)      entry_node;
 986         struct pf_anchor        *parent;
 987         struct pf_anchor_node    children;
 988         char                     name[PF_ANCHOR_NAME_SIZE];
 989         char                     path[MAXPATHLEN];
 990         struct pf_ruleset        ruleset;
 991         int                      refcnt;        /* anchor rules */
 992         int                      match;
 993 };
 994 RB_PROTOTYPE(pf_anchor_global, pf_anchor, entry_global, pf_anchor_compare);
 995 RB_PROTOTYPE(pf_anchor_node, pf_anchor, entry_node, pf_anchor_compare);
 996
 997 #define PF_RESERVED_ANCHOR      "_pf"
 998
 999 #define PFR_TFLAG_PERSIST       0x00000001
1000 #define PFR_TFLAG_CONST         0x00000002
1001 #define PFR_TFLAG_ACTIVE        0x00000004
1002 #define PFR_TFLAG_INACTIVE      0x00000008
1003 #define PFR_TFLAG_REFERENCED    0x00000010
1004 #define PFR_TFLAG_REFDANCHOR    0x00000020
1005 #define PFR_TFLAG_COUNTERS      0x00000040
1006 /* Adjust masks below when adding flags. */
1007 #define PFR_TFLAG_USRMASK       0x00000043
1008 #define PFR_TFLAG_SETMASK       0x0000003C
1009 #define PFR_TFLAG_ALLMASK       0x0000007F
1010
1011 struct pfr_table {
1012         char                     pfrt_anchor[MAXPATHLEN];
1013         char                     pfrt_name[PF_TABLE_NAME_SIZE];
1014         u_int32_t                pfrt_flags;
1015         u_int8_t                 pfrt_fback;
1016 };
1017
1018 enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
1019         PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
1020         PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_NOCOUNT, PFR_FB_MAX };
1021
1022 struct pfr_addr {
1023         union {
1024                 struct in_addr   _pfra_ip4addr;
1025                 struct in6_addr  _pfra_ip6addr;
1026         }                pfra_u;
1027         u_int8_t         pfra_af;
1028         u_int8_t         pfra_net;
1029         u_int8_t         pfra_not;
1030         u_int8_t         pfra_fback;
1031 };
1032 #define pfra_ip4addr    pfra_u._pfra_ip4addr
1033 #define pfra_ip6addr    pfra_u._pfra_ip6addr
1034
1035 enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
1036 enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
1037 #define PFR_OP_XPASS    PFR_OP_ADDR_MAX
1038
1039 struct pfr_astats {
1040         struct pfr_addr  pfras_a;
1041         u_int64_t        pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1042         u_int64_t        pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1043         long             pfras_tzero;
1044 };
1045
1046 enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
1047
1048 struct pfr_tstats {
1049         struct pfr_table pfrts_t;
1050         u_int64_t        pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1051         u_int64_t        pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1052         u_int64_t        pfrts_match;
1053         u_int64_t        pfrts_nomatch;
1054         long             pfrts_tzero;
1055         int              pfrts_cnt;
1056         int              pfrts_refcnt[PFR_REFCNT_MAX];
1057 };
1058 #define pfrts_name      pfrts_t.pfrt_name
1059 #define pfrts_flags     pfrts_t.pfrt_flags
1060
1061 struct pfr_kcounters {
1062         u_int64_t                pfrkc_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1063         u_int64_t                pfrkc_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1064 };
1065
1066 SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
1067 struct pfr_kentry {
1068         struct radix_node        pfrke_node[2];
1069         union sockaddr_union     pfrke_sa;
1070         SLIST_ENTRY(pfr_kentry)  pfrke_workq;
1071         union {
1072
1073                 struct pfr_kcounters            *pfrke_counters;
1074 #if 0
1075                 struct pfr_kroute               *pfrke_route;
1076 #endif
1077         } u;
1078         long                     pfrke_tzero;
1079         u_int8_t                 pfrke_af;
1080         u_int8_t                 pfrke_net;
1081         u_int8_t                 pfrke_not;
1082         u_int8_t                 pfrke_mark;
1083         u_int8_t                 pfrke_intrpool;
1084 };
1085 #define pfrke_counters  u.pfrke_counters
1086 #define pfrke_route     u.pfrke_route
1087
1088
1089 SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
1090 RB_HEAD(pfr_ktablehead, pfr_ktable);
1091 struct pfr_ktable {
1092         struct pfr_tstats        pfrkt_ts;
1093         RB_ENTRY(pfr_ktable)     pfrkt_tree;
1094         SLIST_ENTRY(pfr_ktable)  pfrkt_workq;
1095         struct radix_node_head  *pfrkt_ip4;
1096         struct radix_node_head  *pfrkt_ip6;
1097         struct pfr_ktable       *pfrkt_shadow;
1098         struct pfr_ktable       *pfrkt_root;
1099         struct pf_ruleset       *pfrkt_rs;
1100         long                     pfrkt_larg;
1101         int                      pfrkt_nflags;
1102 };
1103 #define pfrkt_t         pfrkt_ts.pfrts_t
1104 #define pfrkt_name      pfrkt_t.pfrt_name
1105 #define pfrkt_anchor    pfrkt_t.pfrt_anchor
1106 #define pfrkt_ruleset   pfrkt_t.pfrt_ruleset
1107 #define pfrkt_flags     pfrkt_t.pfrt_flags
1108 #define pfrkt_cnt       pfrkt_ts.pfrts_cnt
1109 #define pfrkt_refcnt    pfrkt_ts.pfrts_refcnt
1110 #define pfrkt_packets   pfrkt_ts.pfrts_packets
1111 #define pfrkt_bytes     pfrkt_ts.pfrts_bytes
1112 #define pfrkt_match     pfrkt_ts.pfrts_match
1113 #define pfrkt_nomatch   pfrkt_ts.pfrts_nomatch
1114 #define pfrkt_tzero     pfrkt_ts.pfrts_tzero
1115
1116 RB_HEAD(pf_state_tree, pf_state_key);
1117 RB_PROTOTYPE(pf_state_tree, pf_state_key, entry, pf_state_compare_key);
1118
1119 RB_HEAD(pf_state_tree_ext_gwy, pf_state_key);
1120 RB_PROTOTYPE(pf_state_tree_ext_gwy, pf_state_key,
1121     entry_ext_gwy, pf_state_compare_ext_gwy);
1122
1123 struct pfi_if {
1124         char                             pfif_name[IFNAMSIZ];
1125         u_int64_t                        pfif_packets[2][2][2];
1126         u_int64_t                        pfif_bytes[2][2][2];
1127         u_int64_t                        pfif_addcnt;
1128         u_int64_t                        pfif_delcnt;
1129         long                             pfif_tzero;
1130         int                              pfif_states;
1131         int                              pfif_rules;
1132         int                              pfif_flags;
1133 };
1134
1135 TAILQ_HEAD(pfi_grouphead, pfi_kif);
1136 TAILQ_HEAD(pfi_statehead, pfi_kif);
1137 RB_HEAD(pfi_ifhead, pfi_kif);
1138
1139 /* state tables */
1140 extern struct pf_state_tree      pf_statetbl;
1141
1142 /* keep synced with pfi_kif, used in RB_FIND */
1143 struct pfi_kif_cmp {
1144         char                             pfik_ifname[IFNAMSIZ];
1145 };
1146
1147 struct pfi_kif {
1148         struct pfi_if                    pfik_if;
1149         RB_ENTRY(pfi_kif)                pfik_tree;
1150         u_int64_t                        pfik_packets[2][2][2];
1151         u_int64_t                        pfik_bytes[2][2][2];
1152         u_int32_t                        pfik_tzero;
1153         int                              pfik_flags;
1154         struct hook_desc_head           *pfik_ah_head;
1155         void                            *pfik_ah_cookie;
1156         struct pfi_kif                  *pfik_parent;
1157         struct ifnet                    *pfik_ifp;
1158         struct ifg_group                *pfik_group;
1159         int                              pfik_states;
1160         int                              pfik_rules;
1161         TAILQ_HEAD(, pfi_dynaddr)        pfik_dynaddrs;
1162 };
1163 #define pfik_name       pfik_if.pfif_name
1164 #define pfik_packets    pfik_if.pfif_packets
1165 #define pfik_bytes      pfik_if.pfif_bytes
1166 #define pfik_tzero      pfik_if.pfif_tzero
1167 #define pfik_flags      pfik_if.pfif_flags
1168 #define pfik_addcnt     pfik_if.pfif_addcnt
1169 #define pfik_delcnt     pfik_if.pfif_delcnt
1170 #define pfik_states     pfik_if.pfif_states
1171 #define pfik_rules      pfik_if.pfif_rules
1172
1173 enum pfi_kif_refs {
1174         PFI_KIF_REF_NONE,
1175         PFI_KIF_REF_STATE,
1176         PFI_KIF_REF_RULE
1177 };
1178
1179 #define PFI_IFLAG_GROUP         0x0001  /* group of interfaces */
1180 #define PFI_IFLAG_INSTANCE      0x0002  /* single instance */
1181 #define PFI_IFLAG_CLONABLE      0x0010  /* clonable group */
1182 #define PFI_IFLAG_DYNAMIC       0x0020  /* dynamic group */
1183 #define PFI_IFLAG_SKIP          0x0100  /* skip filtering on interface */
1184 #define PFI_IFLAG_PLACEHOLDER   0x8000  /* placeholder group/interface */
1185
1186 struct pf_pdesc {
1187         struct {
1188                 int      done;
1189                 uid_t    uid;
1190                 gid_t    gid;
1191                 pid_t    pid;
1192         }                lookup;
1193         u_int64_t        tot_len;       /* Make Mickey money */
1194         union {
1195                 struct tcphdr           *tcp;
1196                 struct udphdr           *udp;
1197                 struct icmp             *icmp;
1198 #ifdef INET6
1199                 struct icmp6_hdr        *icmp6;
1200 #endif /* INET6 */
1201                 void                    *any;
1202         } hdr;
1203
1204         struct pf_rule  *nat_rule;      /* nat/rdr rule applied to packet */
1205         struct ether_header
1206                         *eh;
1207         struct pf_addr  *src;           /* src address */
1208         struct pf_addr  *dst;           /* dst address */
1209         u_int16_t *sport;
1210         u_int16_t *dport;
1211
1212         u_int32_t        p_len;         /* total length of payload */
1213
1214         u_int16_t       *ip_sum;
1215         u_int16_t       *proto_sum;
1216         u_int16_t        flags;         /* Let SCRUB trigger behavior in
1217                                          * state code. Easier than tags */
1218 #define PFDESC_TCP_NORM 0x0001          /* TCP shall be statefully scrubbed */
1219 #define PFDESC_IP_REAS  0x0002          /* IP frags would've been reassembled */
1220         sa_family_t      af;
1221         u_int8_t         proto;
1222         u_int8_t         tos;
1223         u_int8_t         dir;           /* direction */
1224         u_int8_t         sidx;          /* key index for source */
1225         u_int8_t         didx;          /* key index for destination */
1226 };
1227
1228 /* flags for RDR options */
1229 #define PF_DPORT_RANGE  0x01            /* Dest port uses range */
1230 #define PF_RPORT_RANGE  0x02            /* RDR'ed port uses range */
1231
1232 /* Reasons code for passing/dropping a packet */
1233 #define PFRES_MATCH     0               /* Explicit match of a rule */
1234 #define PFRES_BADOFF    1               /* Bad offset for pull_hdr */
1235 #define PFRES_FRAG      2               /* Dropping following fragment */
1236 #define PFRES_SHORT     3               /* Dropping short packet */
1237 #define PFRES_NORM      4               /* Dropping by normalizer */
1238 #define PFRES_MEMORY    5               /* Dropped due to lacking mem */
1239 #define PFRES_TS        6               /* Bad TCP Timestamp (RFC1323) */
1240 #define PFRES_CONGEST   7               /* Congestion (of ipintrq) */
1241 #define PFRES_IPOPTIONS 8               /* IP option */
1242 #define PFRES_PROTCKSUM 9               /* Protocol checksum invalid */
1243 #define PFRES_BADSTATE  10              /* State mismatch */
1244 #define PFRES_STATEINS  11              /* State insertion failure */
1245 #define PFRES_MAXSTATES 12              /* State limit */
1246 #define PFRES_SRCLIMIT  13              /* Source node/conn limit */
1247 #define PFRES_SYNPROXY  14              /* SYN proxy */
1248 #define PFRES_MAX       15              /* total+1 */
1249
1250 #define PFRES_NAMES { \
1251         "match", \
1252         "bad-offset", \
1253         "fragment", \
1254         "short", \
1255         "normalize", \
1256         "memory", \
1257         "bad-timestamp", \
1258         "congestion", \
1259         "ip-option", \
1260         "proto-cksum", \
1261         "state-mismatch", \
1262         "state-insert", \
1263         "state-limit", \
1264         "src-limit", \
1265         "synproxy", \
1266         NULL \
1267 }
1268
1269 /* Counters for other things we want to keep track of */
1270 #define LCNT_STATES             0       /* states */
1271 #define LCNT_SRCSTATES          1       /* max-src-states */
1272 #define LCNT_SRCNODES           2       /* max-src-nodes */
1273 #define LCNT_SRCCONN            3       /* max-src-conn */
1274 #define LCNT_SRCCONNRATE        4       /* max-src-conn-rate */
1275 #define LCNT_OVERLOAD_TABLE     5       /* entry added to overload table */
1276 #define LCNT_OVERLOAD_FLUSH     6       /* state entries flushed */
1277 #define LCNT_MAX                7       /* total+1 */
1278
1279 #define LCNT_NAMES { \
1280         "max states per rule", \
1281         "max-src-states", \
1282         "max-src-nodes", \
1283         "max-src-conn", \
1284         "max-src-conn-rate", \
1285         "overload table insertion", \
1286         "overload flush states", \
1287         NULL \
1288 }
1289
1290 /* UDP state enumeration */
1291 #define PFUDPS_NO_TRAFFIC       0
1292 #define PFUDPS_SINGLE           1
1293 #define PFUDPS_MULTIPLE         2
1294
1295 #define PFUDPS_NSTATES          3       /* number of state levels */
1296
1297 #define PFUDPS_NAMES { \
1298         "NO_TRAFFIC", \
1299         "SINGLE", \
1300         "MULTIPLE", \
1301         NULL \
1302 }
1303
1304 /* Other protocol state enumeration */
1305 #define PFOTHERS_NO_TRAFFIC     0
1306 #define PFOTHERS_SINGLE         1
1307 #define PFOTHERS_MULTIPLE       2
1308
1309 #define PFOTHERS_NSTATES        3       /* number of state levels */
1310
1311 #define PFOTHERS_NAMES { \
1312         "NO_TRAFFIC", \
1313         "SINGLE", \
1314         "MULTIPLE", \
1315         NULL \
1316 }
1317
1318 #define FCNT_STATE_SEARCH       0
1319 #define FCNT_STATE_INSERT       1
1320 #define FCNT_STATE_REMOVALS     2
1321 #define FCNT_MAX                3
1322
1323 #define SCNT_SRC_NODE_SEARCH    0
1324 #define SCNT_SRC_NODE_INSERT    1
1325 #define SCNT_SRC_NODE_REMOVALS  2
1326 #define SCNT_MAX                3
1327
1328 #define ACTION_SET(a, x) \
1329         do { \
1330                 if ((a) != NULL) \
1331                         *(a) = (x); \
1332         } while (0)
1333
1334 #define REASON_SET(a, x) \
1335         do { \
1336                 if ((a) != NULL) \
1337                         *(a) = (x); \
1338                 if (x < PFRES_MAX) \
1339                         pf_status.counters[x]++; \
1340         } while (0)
1341
1342 struct pf_status {
1343         u_int64_t       counters[PFRES_MAX];
1344         u_int64_t       lcounters[LCNT_MAX];    /* limit counters */
1345         u_int64_t       fcounters[FCNT_MAX];
1346         u_int64_t       scounters[SCNT_MAX];
1347         u_int64_t       pcounters[2][2][3];
1348         u_int64_t       bcounters[2][2];
1349         u_int64_t       stateid;
1350         u_int32_t       running;
1351         u_int32_t       states;
1352         u_int32_t       src_nodes;
1353         u_int32_t       since;
1354         u_int32_t       debug;
1355         u_int32_t       hostid;
1356         char            ifname[IFNAMSIZ];
1357         u_int8_t        pf_chksum[PF_MD5_DIGEST_LENGTH];
1358 };
1359
1360 struct cbq_opts {
1361         u_int           minburst;
1362         u_int           maxburst;
1363         u_int           pktsize;
1364         u_int           maxpktsize;
1365         u_int           ns_per_byte;
1366         u_int           maxidle;
1367         int             minidle;
1368         u_int           offtime;
1369         int             flags;
1370 };
1371
1372 struct priq_opts {
1373         int             flags;
1374 };
1375
1376 struct hfsc_opts {
1377         /* real-time service curve */
1378         u_int           rtsc_m1;        /* slope of the 1st segment in bps */
1379         u_int           rtsc_d;         /* the x-projection of m1 in msec */
1380         u_int           rtsc_m2;        /* slope of the 2nd segment in bps */
1381         /* link-sharing service curve */
1382         u_int           lssc_m1;
1383         u_int           lssc_d;
1384         u_int           lssc_m2;
1385         /* upper-limit service curve */
1386         u_int           ulsc_m1;
1387         u_int           ulsc_d;
1388         u_int           ulsc_m2;
1389         int             flags;
1390 };
1391
1392 /*
1393  * XXX this needs some work
1394  */
1395 struct fairq_opts {
1396         u_int           nbuckets;       /* hash buckets */
1397         u_int           hogs_m1;        /* hog detection bandwidth */
1398         int             flags;
1399
1400         /* link-sharing service curve */
1401         u_int           lssc_m1;
1402         u_int           lssc_d;
1403         u_int           lssc_m2;
1404 };
1405
1406 struct pf_altq {
1407         char                     ifname[IFNAMSIZ];
1408
1409         void                    *altq_disc;     /* discipline-specific state */
1410         TAILQ_ENTRY(pf_altq)     entries;
1411
1412         /* scheduler spec */
1413         u_int8_t                 scheduler;     /* scheduler type */
1414         u_int16_t                tbrsize;       /* tokenbucket regulator size */
1415         u_int32_t                ifbandwidth;   /* interface bandwidth */
1416
1417         /* queue spec */
1418         char                     qname[PF_QNAME_SIZE];  /* queue name */
1419         char                     parent[PF_QNAME_SIZE]; /* parent name */
1420         u_int32_t                parent_qid;    /* parent queue id */
1421         u_int32_t                bandwidth;     /* queue bandwidth */
1422         u_int8_t                 priority;      /* priority */
1423         u_int16_t                qlimit;        /* queue size limit */
1424         u_int16_t                flags;         /* misc flags */
1425         union {
1426                 struct cbq_opts          cbq_opts;
1427                 struct priq_opts         priq_opts;
1428                 struct hfsc_opts         hfsc_opts;
1429                 struct fairq_opts        fairq_opts;
1430         } pq_u;
1431
1432         u_int32_t                qid;           /* return value */
1433 };
1434
1435 /*
1436  * DO NOT USE PF_TAG_GENERATED!  Set PF_MBUF_TAGGED in fw_flags instead and
1437  * then clear pf.flags.  The mbuf allocator does not automatically clear
1438  * the pf fields in the mbuf packet header.
1439  */
1440 /*#define       PF_TAG_GENERATED                0x01*/
1441 #define PF_TAG_FRAGCACHE                0x02
1442 #define PF_TAG_TRANSLATE_LOCALHOST      0x04
1443 #define PF_TAG_STATE_HASHED             0x08
1444
1445 struct pf_tagname {
1446         TAILQ_ENTRY(pf_tagname) entries;
1447         char                    name[PF_TAG_NAME_SIZE];
1448         u_int16_t               tag;
1449         int                     ref;
1450 };
1451
1452 struct pf_divert {
1453         union {
1454                 struct in_addr  ipv4;
1455                 struct in6_addr ipv6;
1456         }               addr;
1457         u_int16_t       port;
1458 };
1459
1460 #define PFFRAG_FRENT_HIWAT      5000    /* Number of fragment entries */
1461 #define PFFRAG_FRAG_HIWAT       1000    /* Number of fragmented packets */
1462 #define PFFRAG_FRCENT_HIWAT     50000   /* Number of fragment cache entries */
1463 #define PFFRAG_FRCACHE_HIWAT    10000   /* Number of fragment descriptors */
1464
1465 #define PFR_KTABLE_HIWAT        1000    /* Number of tables */
1466 #define PFR_KENTRY_HIWAT        200000  /* Number of table entries */
1467 #define PFR_KENTRY_HIWAT_SMALL  100000  /* Number of table entries (tiny hosts) */
1468
1469 /*
1470  * ioctl parameter structures
1471  */
1472
1473 struct pfioc_pooladdr {
1474         u_int32_t                action;
1475         u_int32_t                ticket;
1476         u_int32_t                nr;
1477         u_int32_t                r_num;
1478         u_int8_t                 r_action;
1479         u_int8_t                 r_last;
1480         u_int8_t                 af;
1481         char                     anchor[MAXPATHLEN];
1482         struct pf_pooladdr       addr;
1483 };
1484
1485 struct pfioc_rule {
1486         u_int32_t        action;
1487         u_int32_t        ticket;
1488         u_int32_t        pool_ticket;
1489         u_int32_t        nr;
1490         char             anchor[MAXPATHLEN];
1491         char             anchor_call[MAXPATHLEN];
1492         struct pf_rule   rule;
1493 };
1494
1495 struct pfioc_natlook {
1496         struct pf_addr   saddr;
1497         struct pf_addr   daddr;
1498         struct pf_addr   rsaddr;
1499         struct pf_addr   rdaddr;
1500         u_int16_t        sport;
1501         u_int16_t        dport;
1502         u_int16_t        rsport;
1503         u_int16_t        rdport;
1504         sa_family_t      af;
1505         u_int8_t         proto;
1506         u_int8_t         direction;
1507 };
1508
1509 struct pfioc_state {
1510         struct pfsync_state     state;
1511 };
1512
1513 struct pfioc_src_node_kill {
1514         sa_family_t psnk_af;
1515         struct pf_rule_addr psnk_src;
1516         struct pf_rule_addr psnk_dst;
1517         u_int               psnk_killed;
1518 };
1519
1520 struct pfioc_state_kill {
1521         struct pf_state_cmp     psk_pfcmp;
1522         sa_family_t             psk_af;
1523         int                     psk_proto;
1524         struct pf_rule_addr     psk_src;
1525         struct pf_rule_addr     psk_dst;
1526         char                    psk_ifname[IFNAMSIZ];
1527         char                    psk_label[PF_RULE_LABEL_SIZE];
1528         u_int                   psk_killed;
1529 };
1530
1531 struct pfioc_states {
1532         int     ps_len;
1533         union {
1534                 caddr_t                  psu_buf;
1535                 struct pfsync_state     *psu_states;
1536         } ps_u;
1537 #define ps_buf          ps_u.psu_buf
1538 #define ps_states       ps_u.psu_states
1539 };
1540
1541 struct pfioc_src_nodes {
1542         int     psn_len;
1543         union {
1544                 caddr_t          psu_buf;
1545                 struct pf_src_node      *psu_src_nodes;
1546         } psn_u;
1547 #define psn_buf         psn_u.psu_buf
1548 #define psn_src_nodes   psn_u.psu_src_nodes
1549 };
1550
1551 struct pfioc_if {
1552         char             ifname[IFNAMSIZ];
1553 };
1554
1555 struct pfioc_tm {
1556         int              timeout;
1557         int              seconds;
1558 };
1559
1560 struct pfioc_limit {
1561         int              index;
1562         unsigned         limit;
1563 };
1564
1565 struct pfioc_altq {
1566         u_int32_t        action;
1567         u_int32_t        ticket;
1568         u_int32_t        nr;
1569         struct pf_altq   altq;
1570 };
1571
1572 struct pfioc_qstats {
1573         u_int32_t        ticket;
1574         u_int32_t        nr;
1575         void            *buf;
1576         int              nbytes;
1577         u_int8_t         scheduler;
1578 };
1579
1580 struct pfioc_anchor {
1581         u_int32_t        nr;
1582         char             name[PF_ANCHOR_NAME_SIZE];
1583 };
1584
1585 struct pfioc_ruleset {
1586         u_int32_t        nr;
1587         char             path[MAXPATHLEN];
1588         char             name[PF_ANCHOR_NAME_SIZE];
1589 };
1590
1591 #define PF_RULESET_ALTQ         (PF_RULESET_MAX)
1592 #define PF_RULESET_TABLE        (PF_RULESET_MAX+1)
1593 struct pfioc_trans {
1594         int              size;  /* number of elements */
1595         int              esize; /* size of each element in bytes */
1596         struct pfioc_trans_e {
1597                 int             rs_num;
1598                 char            anchor[MAXPATHLEN];
1599                 u_int32_t       ticket;
1600         }               *array;
1601 };
1602
1603 #define PFR_FLAG_ATOMIC         0x00000001
1604 #define PFR_FLAG_DUMMY          0x00000002
1605 #define PFR_FLAG_FEEDBACK       0x00000004
1606 #define PFR_FLAG_CLSTATS        0x00000008
1607 #define PFR_FLAG_ADDRSTOO       0x00000010
1608 #define PFR_FLAG_REPLACE        0x00000020
1609 #define PFR_FLAG_ALLRSETS       0x00000040
1610 #define PFR_FLAG_ALLMASK        0x0000007F
1611 #ifdef _KERNEL
1612 #define PFR_FLAG_USERIOCTL      0x10000000
1613 #endif
1614
1615 struct pfioc_table {
1616         struct pfr_table         pfrio_table;
1617         void                    *pfrio_buffer;
1618         int                      pfrio_esize;
1619         int                      pfrio_size;
1620         int                      pfrio_size2;
1621         int                      pfrio_nadd;
1622         int                      pfrio_ndel;
1623         int                      pfrio_nchange;
1624         int                      pfrio_flags;
1625         u_int32_t                pfrio_ticket;
1626 };
1627 #define pfrio_exists    pfrio_nadd
1628 #define pfrio_nzero     pfrio_nadd
1629 #define pfrio_nmatch    pfrio_nadd
1630 #define pfrio_naddr     pfrio_size2
1631 #define pfrio_setflag   pfrio_size2
1632 #define pfrio_clrflag   pfrio_nadd
1633
1634 struct pfioc_iface {
1635         char     pfiio_name[IFNAMSIZ];
1636         void    *pfiio_buffer;
1637         int      pfiio_esize;
1638         int      pfiio_size;
1639         int      pfiio_nzero;
1640         int      pfiio_flags;
1641 };
1642
1643
1644 /*
1645  * ioctl operations
1646  */
1647
1648 #define DIOCSTART       _IO  ('D',  1)
1649 #define DIOCSTOP        _IO  ('D',  2)
1650 #define DIOCBEGINRULES  _IOWR('D',  3, struct pfioc_rule)
1651 #define DIOCADDRULE     _IOWR('D',  4, struct pfioc_rule)
1652 #define DIOCCOMMITRULES _IOWR('D',  5, struct pfioc_rule)
1653 #define DIOCGETRULES    _IOWR('D',  6, struct pfioc_rule)
1654 #define DIOCGETRULE     _IOWR('D',  7, struct pfioc_rule)
1655 /* XXX cut 8 - 17 */
1656 #define DIOCCLRSTATES   _IOWR('D', 18, struct pfioc_state_kill)
1657 #define DIOCGETSTATE    _IOWR('D', 19, struct pfioc_state)
1658 #define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_if)
1659 #define DIOCGETSTATUS   _IOWR('D', 21, struct pf_status)
1660 #define DIOCCLRSTATUS   _IO  ('D', 22)
1661 #define DIOCNATLOOK     _IOWR('D', 23, struct pfioc_natlook)
1662 #define DIOCSETDEBUG    _IOWR('D', 24, u_int32_t)
1663 #define DIOCGETSTATES   _IOWR('D', 25, struct pfioc_states)
1664 #define DIOCCHANGERULE  _IOWR('D', 26, struct pfioc_rule)
1665 /* XXX cut 26 - 28 */
1666 #define DIOCSETTIMEOUT  _IOWR('D', 29, struct pfioc_tm)
1667 #define DIOCGETTIMEOUT  _IOWR('D', 30, struct pfioc_tm)
1668 #define DIOCADDSTATE    _IOWR('D', 37, struct pfioc_state)
1669 #define DIOCCLRRULECTRS _IO  ('D', 38)
1670 #define DIOCGETLIMIT    _IOWR('D', 39, struct pfioc_limit)
1671 #define DIOCSETLIMIT    _IOWR('D', 40, struct pfioc_limit)
1672 #define DIOCKILLSTATES  _IOWR('D', 41, struct pfioc_state_kill)
1673 #define DIOCSTARTALTQ   _IO  ('D', 42)
1674 #define DIOCSTOPALTQ    _IO  ('D', 43)
1675 #define DIOCBEGINALTQS  _IOWR('D', 44, u_int32_t)
1676 #define DIOCADDALTQ     _IOWR('D', 45, struct pfioc_altq)
1677 #define DIOCCOMMITALTQS _IOWR('D', 46, u_int32_t)
1678 #define DIOCGETALTQS    _IOWR('D', 47, struct pfioc_altq)
1679 #define DIOCGETALTQ     _IOWR('D', 48, struct pfioc_altq)
1680 #define DIOCCHANGEALTQ  _IOWR('D', 49, struct pfioc_altq)
1681 #define DIOCGETQSTATS   _IOWR('D', 50, struct pfioc_qstats)
1682 #define DIOCBEGINADDRS  _IOWR('D', 51, struct pfioc_pooladdr)
1683 #define DIOCADDADDR     _IOWR('D', 52, struct pfioc_pooladdr)
1684 #define DIOCGETADDRS    _IOWR('D', 53, struct pfioc_pooladdr)
1685 #define DIOCGETADDR     _IOWR('D', 54, struct pfioc_pooladdr)
1686 #define DIOCCHANGEADDR  _IOWR('D', 55, struct pfioc_pooladdr)
1687 /* XXX cut 55 - 57 */
1688 #define DIOCGETRULESETS _IOWR('D', 58, struct pfioc_ruleset)
1689 #define DIOCGETRULESET  _IOWR('D', 59, struct pfioc_ruleset)
1690 #define DIOCRCLRTABLES  _IOWR('D', 60, struct pfioc_table)
1691 #define DIOCRADDTABLES  _IOWR('D', 61, struct pfioc_table)
1692 #define DIOCRDELTABLES  _IOWR('D', 62, struct pfioc_table)
1693 #define DIOCRGETTABLES  _IOWR('D', 63, struct pfioc_table)
1694 #define DIOCRGETTSTATS  _IOWR('D', 64, struct pfioc_table)
1695 #define DIOCRCLRTSTATS  _IOWR('D', 65, struct pfioc_table)
1696 #define DIOCRCLRADDRS   _IOWR('D', 66, struct pfioc_table)
1697 #define DIOCRADDADDRS   _IOWR('D', 67, struct pfioc_table)
1698 #define DIOCRDELADDRS   _IOWR('D', 68, struct pfioc_table)
1699 #define DIOCRSETADDRS   _IOWR('D', 69, struct pfioc_table)
1700 #define DIOCRGETADDRS   _IOWR('D', 70, struct pfioc_table)
1701 #define DIOCRGETASTATS  _IOWR('D', 71, struct pfioc_table)
1702 #define DIOCRCLRASTATS  _IOWR('D', 72, struct pfioc_table)
1703 #define DIOCRTSTADDRS   _IOWR('D', 73, struct pfioc_table)
1704 #define DIOCRSETTFLAGS  _IOWR('D', 74, struct pfioc_table)
1705 #define DIOCRINABEGIN   _IOWR('D', 75, struct pfioc_table)
1706 #define DIOCRINACOMMIT  _IOWR('D', 76, struct pfioc_table)
1707 #define DIOCRINADEFINE  _IOWR('D', 77, struct pfioc_table)
1708 #define DIOCOSFPFLUSH   _IO('D', 78)
1709 #define DIOCOSFPADD     _IOWR('D', 79, struct pf_osfp_ioctl)
1710 #define DIOCOSFPGET     _IOWR('D', 80, struct pf_osfp_ioctl)
1711 #define DIOCXBEGIN      _IOWR('D', 81, struct pfioc_trans)
1712 #define DIOCXCOMMIT     _IOWR('D', 82, struct pfioc_trans)
1713 #define DIOCXROLLBACK   _IOWR('D', 83, struct pfioc_trans)
1714 #define DIOCGETSRCNODES _IOWR('D', 84, struct pfioc_src_nodes)
1715 #define DIOCCLRSRCNODES _IO('D', 85)
1716 #define DIOCSETHOSTID   _IOWR('D', 86, u_int32_t)
1717 #define DIOCIGETIFACES  _IOWR('D', 87, struct pfioc_iface)
1718 #define DIOCICLRISTATS  _IOWR('D', 88, struct pfioc_iface)
1719 #define DIOCSETIFFLAG   _IOWR('D', 89, struct pfioc_iface)
1720 #define DIOCCLRIFFLAG   _IOWR('D', 90, struct pfioc_iface)
1721 #define DIOCKILLSRCNODES        _IOWR('D', 91, struct pfioc_src_node_kill)
1722 struct pf_ifspeed {
1723         char                    ifname[IFNAMSIZ];
1724         u_int32_t               baudrate;
1725 };
1726 #define DIOCGIFSPEED    _IOWR('D', 89, struct pf_ifspeed)
1727
1728 #ifdef _KERNEL
1729 RB_HEAD(pf_src_tree, pf_src_node);
1730 RB_PROTOTYPE(pf_src_tree, pf_src_node, entry, pf_src_compare);
1731 extern struct pf_src_tree tree_src_tracking;
1732
1733 RB_HEAD(pf_state_tree_id, pf_state);
1734 RB_PROTOTYPE(pf_state_tree_id, pf_state,
1735     entry_id, pf_state_compare_id);
1736 extern struct pf_state_tree_id tree_id;
1737 extern struct pf_state_queue state_list;
1738
1739 TAILQ_HEAD(pf_poolqueue, pf_pool);
1740 extern struct pf_poolqueue                pf_pools[2];
1741 TAILQ_HEAD(pf_altqqueue, pf_altq);
1742 extern struct pf_altqqueue                pf_altqs[2];
1743 extern struct pf_palist                   pf_pabuf;
1744
1745 extern u_int32_t                 ticket_altqs_active;
1746 extern u_int32_t                 ticket_altqs_inactive;
1747 extern int                       altqs_inactive_open;
1748 extern u_int32_t                 ticket_pabuf;
1749 extern struct pf_altqqueue      *pf_altqs_active;
1750 extern struct pf_altqqueue      *pf_altqs_inactive;
1751 extern struct pf_poolqueue      *pf_pools_active;
1752 extern struct pf_poolqueue      *pf_pools_inactive;
1753 extern int                       pf_tbladdr_setup(struct pf_ruleset *,
1754                                     struct pf_addr_wrap *);
1755 extern void                      pf_tbladdr_remove(struct pf_addr_wrap *);
1756 extern void                      pf_tbladdr_copyout(struct pf_addr_wrap *);
1757 extern void                      pf_calc_skip_steps(struct pf_rulequeue *);
1758 extern struct malloc_type       *pf_src_tree_pl, *pf_rule_pl;
1759 extern struct malloc_type       *pf_state_pl, *pf_state_key_pl, *pf_state_item_pl,
1760                                         *pf_altq_pl, *pf_pooladdr_pl;
1761 extern struct malloc_type       *pfr_ktable_pl, *pfr_kentry_pl;
1762 extern struct malloc_type       *pfr_kentry_pl2;
1763 extern struct malloc_type       *pf_cache_pl, *pf_cent_pl;
1764 extern struct malloc_type       *pf_state_scrub_pl;
1765 extern struct malloc_type       *pfi_addr_pl;
1766 extern void                      pf_purge_thread(void *);
1767 extern int                       pf_purge_expired_src_nodes(int);
1768 extern int                       pf_purge_expired_states(u_int32_t, int);
1769 extern void                      pf_unlink_state(struct pf_state *);
1770 extern void                      pf_free_state(struct pf_state *);
1771 extern int                       pf_state_insert(struct pfi_kif *,
1772                                     struct pf_state_key *,
1773                                     struct pf_state_key *,
1774                                     struct pf_state *);
1775 extern int                       pf_insert_src_node(struct pf_src_node **,
1776                                     struct pf_rule *, struct pf_addr *,
1777                                     sa_family_t);
1778 void                             pf_src_tree_remove_state(struct pf_state *);
1779 u_int32_t                        pf_state_hash(struct pf_state_key *sk);
1780 extern struct pf_state          *pf_find_state_byid(struct pf_state_cmp *);
1781 extern struct pf_state          *pf_find_state_all(struct pf_state_key_cmp *,
1782                                     u_int, int *);
1783 extern void                      pf_print_state(struct pf_state *);
1784 extern void                      pf_print_flags(u_int8_t);
1785 extern u_int16_t                 pf_cksum_fixup(u_int16_t, u_int16_t, u_int16_t,
1786                                     u_int8_t);
1787
1788 extern struct ifnet             *sync_ifp;
1789 extern struct pf_rule            pf_default_rule;
1790 extern void                      pf_addrcpy(struct pf_addr *, struct pf_addr *,
1791                                     u_int8_t);
1792 void                             pf_rm_rule(struct pf_rulequeue *,
1793                                     struct pf_rule *);
1794 struct pf_divert                *pf_find_divert(struct mbuf *);
1795
1796 #ifdef INET
1797 int     pf_test(int, struct ifnet *, struct mbuf **, struct ether_header *, struct inpcb *);
1798 #endif /* INET */
1799
1800 #ifdef INET6
1801 int     pf_test6(int, struct ifnet *, struct mbuf **, struct ether_header *, struct inpcb *);
1802 void    pf_poolmask(struct pf_addr *, struct pf_addr*,
1803             struct pf_addr *, struct pf_addr *, u_int8_t);
1804 void    pf_addr_inc(struct pf_addr *, sa_family_t);
1805 #endif /* INET6 */
1806
1807 void   *pf_pull_hdr(struct mbuf *, int, void *, int, u_short *, u_short *,
1808             sa_family_t);
1809 void    pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
1810 int     pflog_packet(struct pfi_kif *, struct mbuf *, sa_family_t, u_int8_t,
1811             u_int8_t, struct pf_rule *, struct pf_rule *, struct pf_ruleset *,
1812             struct pf_pdesc *);
1813 int     pf_match_addr(u_int8_t, struct pf_addr *, struct pf_addr *,
1814             struct pf_addr *, sa_family_t);
1815 int     pf_match_addr_range(struct pf_addr *, struct pf_addr *,
1816             struct pf_addr *, sa_family_t);
1817 int     pf_match(u_int8_t, u_int32_t, u_int32_t, u_int32_t);
1818 int     pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
1819 int     pf_match_uid(u_int8_t, uid_t, uid_t, uid_t);
1820 int     pf_match_gid(u_int8_t, gid_t, gid_t, gid_t);
1821
1822 void    pf_normalize_init(void);
1823 int     pf_normalize_ip(struct mbuf **, int, struct pfi_kif *, u_short *,
1824             struct pf_pdesc *);
1825 int     pf_normalize_ip6(struct mbuf **, int, struct pfi_kif *, u_short *,
1826             struct pf_pdesc *);
1827 int     pf_normalize_tcp(int, struct pfi_kif *, struct mbuf *, int, int, void *,
1828             struct pf_pdesc *);
1829 void    pf_normalize_tcp_cleanup(struct pf_state *);
1830 int     pf_normalize_tcp_init(struct mbuf *, int, struct pf_pdesc *,
1831             struct tcphdr *, struct pf_state_peer *, struct pf_state_peer *);
1832 int     pf_normalize_tcp_stateful(struct mbuf *, int, struct pf_pdesc *,
1833             u_short *, struct tcphdr *, struct pf_state *,
1834             struct pf_state_peer *, struct pf_state_peer *, int *);
1835 u_int32_t
1836         pf_state_expires(const struct pf_state *);
1837 void    pf_purge_expired_fragments(void);
1838 int     pf_routable(struct pf_addr *addr, sa_family_t af, struct pfi_kif *);
1839 int     pf_rtlabel_match(struct pf_addr *, sa_family_t, struct pf_addr_wrap *);
1840 int     pf_socket_lookup(int, struct pf_pdesc *);
1841 struct pf_state_key *pf_alloc_state_key(int);
1842 int     pf_state_key_attach(struct pf_state_key *, struct pf_state *, int);
1843 void    pfr_initialize(void);
1844 int     pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
1845 void    pfr_update_stats(struct pfr_ktable *, struct pf_addr *, sa_family_t,
1846             u_int64_t, int, int, int);
1847 int     pfr_pool_get(struct pfr_ktable *, int *, struct pf_addr *,
1848             struct pf_addr **, struct pf_addr **, sa_family_t);
1849 void    pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
1850 struct pfr_ktable *
1851         pfr_attach_table(struct pf_ruleset *, char *);
1852 void    pfr_detach_table(struct pfr_ktable *);
1853 int     pfr_clr_tables(struct pfr_table *, int *, int);
1854 int     pfr_add_tables(struct pfr_table *, int, int *, int);
1855 int     pfr_del_tables(struct pfr_table *, int, int *, int);
1856 int     pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
1857 int     pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
1858 int     pfr_clr_tstats(struct pfr_table *, int, int *, int);
1859 int     pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
1860 int     pfr_clr_addrs(struct pfr_table *, int *, int);
1861 int     pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *, long);
1862 int     pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1863             int);
1864 int     pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1865             int);
1866 int     pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1867             int *, int *, int *, int, u_int32_t);
1868 int     pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
1869 int     pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
1870 int     pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
1871             int);
1872 int     pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1873             int);
1874 int     pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
1875 int     pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
1876 int     pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
1877 int     pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
1878             int *, u_int32_t, int);
1879
1880 extern struct pfi_kif           *pfi_all;
1881
1882 void             pfi_initialize(void);
1883 struct pfi_kif  *pfi_kif_get(const char *);
1884 void             pfi_cleanup(void);
1885 void             pfi_attach_clone(struct if_clone *);
1886 void             pfi_kif_ref(struct pfi_kif *, enum pfi_kif_refs);
1887 void             pfi_kif_unref(struct pfi_kif *, enum pfi_kif_refs);
1888 int              pfi_kif_match(struct pfi_kif *, struct pfi_kif *);
1889 void             pfi_attach_ifnet(struct ifnet *);
1890 void             pfi_detach_ifnet(struct ifnet *);
1891 struct pfi_kif  *pfi_lookup_create(const char *);
1892 struct pfi_kif  *pfi_lookup_if(const char *);
1893 void             pfi_attach_ifgroup(struct ifg_group *);
1894 void             pfi_detach_ifgroup(struct ifg_group *);
1895 void             pfi_group_change(const char *);
1896 int              pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
1897                     sa_family_t);
1898 int              pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
1899 void             pfi_dynaddr_remove(struct pf_addr_wrap *);
1900 void             pfi_dynaddr_copyout(struct pf_addr_wrap *);
1901 void             pfi_update_status(const char *, struct pf_status *);
1902 int              pfi_get_ifaces(const char *, struct pfi_kif *, int *);
1903 int              pfi_set_flags(const char *, int);
1904 int              pfi_clear_flags(const char *, int);
1905
1906 int              pf_match_tag(struct mbuf *, struct pf_rule *, int *);
1907 u_int16_t        pf_tagname2tag(char *);
1908 void             pf_tag2tagname(u_int16_t, char *);
1909 void             pf_tag_ref(u_int16_t);
1910 void             pf_tag_unref(u_int16_t);
1911 int              pf_tag_packet(struct mbuf *, int, int);
1912 u_int32_t        pf_qname2qid(char *);
1913 void             pf_qid2qname(u_int32_t, char *);
1914 void             pf_qid_unref(u_int32_t);
1915
1916 extern struct pf_status pf_status;
1917 extern struct malloc_type       *pf_frent_pl, *pf_frag_pl;
1918 extern struct lock      pf_consistency_lock;
1919
1920 struct pf_pool_limit {
1921         void            *pp;
1922         unsigned         limit;
1923 };
1924 extern struct pf_pool_limit     pf_pool_limits[PF_LIMIT_MAX];
1925
1926 struct pf_frent {
1927         LIST_ENTRY(pf_frent) fr_next;
1928         struct ip *fr_ip;
1929         struct mbuf *fr_m;
1930 };
1931
1932 struct pf_frcache {
1933         LIST_ENTRY(pf_frcache) fr_next;
1934         uint16_t        fr_off;
1935         uint16_t        fr_end;
1936 };
1937
1938 struct pf_fragment {
1939         RB_ENTRY(pf_fragment) fr_entry;
1940         TAILQ_ENTRY(pf_fragment) frag_next;
1941         struct in_addr  fr_src;
1942         struct in_addr  fr_dst;
1943         u_int8_t        fr_p;           /* protocol of this fragment */
1944         u_int8_t        fr_flags;       /* status flags */
1945         u_int16_t       fr_id;          /* fragment id for reassemble */
1946         u_int16_t       fr_max;         /* fragment data max */
1947         u_int32_t       fr_timeout;
1948 #define fr_queue        fr_u.fru_queue
1949 #define fr_cache        fr_u.fru_cache
1950         union {
1951                 LIST_HEAD(pf_fragq, pf_frent) fru_queue;        /* buffering */
1952                 LIST_HEAD(pf_cacheq, pf_frcache) fru_cache;     /* non-buf */
1953         } fr_u;
1954 };
1955
1956 #endif /* _KERNEL */
1957
1958 extern struct radix_node_head   *pf_maskhead;
1959 extern struct pf_anchor_global  pf_anchors;
1960 extern struct pf_anchor        pf_main_anchor;
1961 #define pf_main_ruleset pf_main_anchor.ruleset
1962
1963 /* these ruleset functions can be linked into userland programs (pfctl) */
1964 int                      pf_get_ruleset_number(u_int8_t);
1965 void                     pf_init_ruleset(struct pf_ruleset *);
1966 int                      pf_anchor_setup(struct pf_rule *,
1967                             const struct pf_ruleset *, const char *);
1968 int                      pf_anchor_copyout(const struct pf_ruleset *,
1969                             const struct pf_rule *, struct pfioc_rule *);
1970 void                     pf_anchor_remove(struct pf_rule *);
1971 void                     pf_remove_if_empty_ruleset(struct pf_ruleset *);
1972 struct pf_anchor        *pf_find_anchor(const char *);
1973 struct pf_ruleset       *pf_find_ruleset(const char *);
1974 struct pf_ruleset       *pf_find_or_create_ruleset(const char *);
1975 void                     pf_rs_initialize(void);
1976
1977 /* The fingerprint functions can be linked into userland programs (tcpdump) */
1978 int     pf_osfp_add(struct pf_osfp_ioctl *);
1979 #ifdef _KERNEL
1980 struct pf_osfp_enlist *
1981         pf_osfp_fingerprint(struct pf_pdesc *, struct mbuf *, int,
1982             const struct tcphdr *);
1983 #endif /* _KERNEL */
1984 struct pf_osfp_enlist *
1985         pf_osfp_fingerprint_hdr(const struct ip *, const struct ip6_hdr *,
1986             const struct tcphdr *);
1987 void    pf_osfp_flush(void);
1988 int     pf_osfp_get(struct pf_osfp_ioctl *);
1989 void    pf_osfp_initialize(void);
1990 int     pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
1991 struct pf_os_fingerprint *
1992         pf_osfp_validate(void);
1993
1994
1995 #endif /* _NET_PFVAR_H_ */