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