sys/netinet/ip_fw.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause
   3  *
   4  * Copyright (c) 2002-2009 Luigi Rizzo, Universita` di Pisa
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  */
  27
  28 #ifndef _IPFW2_H
  29 #define _IPFW2_H
  30
  31 /*
  32  * The default rule number.  By the design of ip_fw, the default rule
  33  * is the last one, so its number can also serve as the highest number
  34  * allowed for a rule.  The ip_fw code relies on both meanings of this
  35  * constant.
  36  */
  37 #define IPFW_DEFAULT_RULE       65535
  38
  39 #define RESVD_SET               31      /*set for default and persistent rules*/
  40 #define IPFW_MAX_SETS           32      /* Number of sets supported by ipfw*/
  41
  42 /*
  43  * Compat values for old clients
  44  */
  45 #ifndef _KERNEL
  46 #define IPFW_TABLES_MAX         65535
  47 #define IPFW_TABLES_DEFAULT     128
  48 #endif
  49
  50 /*
  51  * Most commands (queue, pipe, tag, untag, limit...) can have a 16-bit
  52  * argument between 1 and 65534. The value 0 (IP_FW_TARG) is used
  53  * to represent 'tablearg' value, e.g.  indicate the use of a 'tablearg'
  54  * result of the most recent table() lookup.
  55  * Note that 16bit is only a historical limit, resulting from
  56  * the use of a 16-bit fields for that value. In reality, we can have
  57  * 2^32 pipes, queues, tag values and so on.
  58  */
  59 #define IPFW_ARG_MIN            1
  60 #define IPFW_ARG_MAX            65534
  61 #define IP_FW_TABLEARG          65535   /* Compat value for old clients */
  62 #define IP_FW_TARG              0       /* Current tablearg value */
  63 #define IP_FW_NAT44_GLOBAL      65535   /* arg1 value for "nat global" */
  64
  65 /*
  66  * Number of entries in the call stack of the call/return commands.
  67  * Call stack currently is an uint16_t array with rule numbers.
  68  */
  69 #define IPFW_CALLSTACK_SIZE     16
  70
  71 /* IP_FW3 header/opcodes */
  72 typedef struct _ip_fw3_opheader {
  73         uint16_t opcode;        /* Operation opcode */
  74         uint16_t version;       /* Opcode version */
  75         uint16_t reserved[2];   /* Align to 64-bit boundary */
  76 } ip_fw3_opheader;
  77
  78 /* IP_FW3 opcodes */
  79 #define IP_FW_TABLE_XADD        86      /* add entry */
  80 #define IP_FW_TABLE_XDEL        87      /* delete entry */
  81 #define IP_FW_TABLE_XGETSIZE    88      /* get table size (deprecated) */
  82 #define IP_FW_TABLE_XLIST       89      /* list table contents */
  83 #define IP_FW_TABLE_XDESTROY    90      /* destroy table */
  84 #define IP_FW_TABLES_XLIST      92      /* list all tables  */
  85 #define IP_FW_TABLE_XINFO       93      /* request info for one table */
  86 #define IP_FW_TABLE_XFLUSH      94      /* flush table data */
  87 #define IP_FW_TABLE_XCREATE     95      /* create new table  */
  88 #define IP_FW_TABLE_XMODIFY     96      /* modify existing table */
  89 #define IP_FW_XGET              97      /* Retrieve configuration */
  90 #define IP_FW_XADD              98      /* add rule */
  91 #define IP_FW_XDEL              99      /* del rule */
  92 #define IP_FW_XMOVE             100     /* move rules to different set  */
  93 #define IP_FW_XZERO             101     /* clear accounting */
  94 #define IP_FW_XRESETLOG         102     /* zero rules logs */
  95 #define IP_FW_SET_SWAP          103     /* Swap between 2 sets */
  96 #define IP_FW_SET_MOVE          104     /* Move one set to another one */
  97 #define IP_FW_SET_ENABLE        105     /* Enable/disable sets */
  98 #define IP_FW_TABLE_XFIND       106     /* finds an entry */
  99 #define IP_FW_XIFLIST           107     /* list tracked interfaces */
 100 #define IP_FW_TABLES_ALIST      108     /* list table algorithms */
 101 #define IP_FW_TABLE_XSWAP       109     /* swap two tables */
 102 #define IP_FW_TABLE_VLIST       110     /* dump table value hash */
 103
 104 #define IP_FW_NAT44_XCONFIG     111     /* Create/modify NAT44 instance */
 105 #define IP_FW_NAT44_DESTROY     112     /* Destroys NAT44 instance */
 106 #define IP_FW_NAT44_XGETCONFIG  113     /* Get NAT44 instance config */
 107 #define IP_FW_NAT44_LIST_NAT    114     /* List all NAT44 instances */
 108 #define IP_FW_NAT44_XGETLOG     115     /* Get log from NAT44 instance */
 109
 110 #define IP_FW_DUMP_SOPTCODES    116     /* Dump available sopts/versions */
 111 #define IP_FW_DUMP_SRVOBJECTS   117     /* Dump existing named objects */
 112
 113 #define IP_FW_NAT64STL_CREATE   130     /* Create stateless NAT64 instance */
 114 #define IP_FW_NAT64STL_DESTROY  131     /* Destroy stateless NAT64 instance */
 115 #define IP_FW_NAT64STL_CONFIG   132     /* Modify stateless NAT64 instance */
 116 #define IP_FW_NAT64STL_LIST     133     /* List stateless NAT64 instances */
 117 #define IP_FW_NAT64STL_STATS    134     /* Get NAT64STL instance statistics */
 118 #define IP_FW_NAT64STL_RESET_STATS 135  /* Reset NAT64STL instance statistics */
 119
 120 #define IP_FW_NAT64LSN_CREATE   140     /* Create stateful NAT64 instance */
 121 #define IP_FW_NAT64LSN_DESTROY  141     /* Destroy stateful NAT64 instance */
 122 #define IP_FW_NAT64LSN_CONFIG   142     /* Modify stateful NAT64 instance */
 123 #define IP_FW_NAT64LSN_LIST     143     /* List stateful NAT64 instances */
 124 #define IP_FW_NAT64LSN_STATS    144     /* Get NAT64LSN instance statistics */
 125 #define IP_FW_NAT64LSN_LIST_STATES 145  /* Get stateful NAT64 states */
 126 #define IP_FW_NAT64LSN_RESET_STATS 146  /* Reset NAT64LSN instance statistics */
 127
 128 #define IP_FW_NPTV6_CREATE      150     /* Create NPTv6 instance */
 129 #define IP_FW_NPTV6_DESTROY     151     /* Destroy NPTv6 instance */
 130 #define IP_FW_NPTV6_CONFIG      152     /* Modify NPTv6 instance */
 131 #define IP_FW_NPTV6_LIST        153     /* List NPTv6 instances */
 132 #define IP_FW_NPTV6_STATS       154     /* Get NPTv6 instance statistics */
 133 #define IP_FW_NPTV6_RESET_STATS 155     /* Reset NPTv6 instance statistics */
 134
 135 #define IP_FW_NAT64CLAT_CREATE  160     /* Create clat NAT64 instance */
 136 #define IP_FW_NAT64CLAT_DESTROY 161     /* Destroy clat NAT64 instance */
 137 #define IP_FW_NAT64CLAT_CONFIG  162     /* Modify clat NAT64 instance */
 138 #define IP_FW_NAT64CLAT_LIST    163     /* List clat NAT64 instances */
 139 #define IP_FW_NAT64CLAT_STATS   164     /* Get NAT64CLAT instance statistics */
 140 #define IP_FW_NAT64CLAT_RESET_STATS 165 /* Reset NAT64CLAT instance statistics */
 141
 142 /*
 143  * The kernel representation of ipfw rules is made of a list of
 144  * 'instructions' (for all practical purposes equivalent to BPF
 145  * instructions), which specify which fields of the packet
 146  * (or its metadata) should be analysed.
 147  *
 148  * Each instruction is stored in a structure which begins with
 149  * "ipfw_insn", and can contain extra fields depending on the
 150  * instruction type (listed below).
 151  * Note that the code is written so that individual instructions
 152  * have a size which is a multiple of 32 bits. This means that, if
 153  * such structures contain pointers or other 64-bit entities,
 154  * (there is just one instance now) they may end up unaligned on
 155  * 64-bit architectures, so the must be handled with care.
 156  *
 157  * "enum ipfw_opcodes" are the opcodes supported. We can have up
 158  * to 256 different opcodes. When adding new opcodes, they should
 159  * be appended to the end of the opcode list before O_LAST_OPCODE,
 160  * this will prevent the ABI from being broken, otherwise users
 161  * will have to recompile ipfw(8) when they update the kernel.
 162  */
 163
 164 enum ipfw_opcodes {             /* arguments (4 byte each)      */
 165         O_NOP,
 166
 167         O_IP_SRC,               /* u32 = IP                     */
 168         O_IP_SRC_MASK,          /* ip = IP/mask                 */
 169         O_IP_SRC_ME,            /* none                         */
 170         O_IP_SRC_SET,           /* u32=base, arg1=len, bitmap   */
 171
 172         O_IP_DST,               /* u32 = IP                     */
 173         O_IP_DST_MASK,          /* ip = IP/mask                 */
 174         O_IP_DST_ME,            /* none                         */
 175         O_IP_DST_SET,           /* u32=base, arg1=len, bitmap   */
 176
 177         O_IP_SRCPORT,           /* (n)port list:mask 4 byte ea  */
 178         O_IP_DSTPORT,           /* (n)port list:mask 4 byte ea  */
 179         O_PROTO,                /* arg1=protocol                */
 180
 181         O_MACADDR2,             /* 2 mac addr:mask              */
 182         O_MAC_TYPE,             /* same as srcport              */
 183
 184         O_LAYER2,               /* none                         */
 185         O_IN,                   /* none                         */
 186         O_FRAG,                 /* none                         */
 187
 188         O_RECV,                 /* none                         */
 189         O_XMIT,                 /* none                         */
 190         O_VIA,                  /* none                         */
 191
 192         O_IPOPT,                /* arg1 = 2*u8 bitmap           */
 193         O_IPLEN,                /* arg1 = len                   */
 194         O_IPID,                 /* arg1 = id                    */
 195
 196         O_IPTOS,                /* arg1 = id                    */
 197         O_IPPRECEDENCE,         /* arg1 = precedence << 5       */
 198         O_IPTTL,                /* arg1 = TTL                   */
 199
 200         O_IPVER,                /* arg1 = version               */
 201         O_UID,                  /* u32 = id                     */
 202         O_GID,                  /* u32 = id                     */
 203         O_ESTAB,                /* none (tcp established)       */
 204         O_TCPFLAGS,             /* arg1 = 2*u8 bitmap           */
 205         O_TCPWIN,               /* arg1 = desired win           */
 206         O_TCPSEQ,               /* u32 = desired seq.           */
 207         O_TCPACK,               /* u32 = desired seq.           */
 208         O_ICMPTYPE,             /* u32 = icmp bitmap            */
 209         O_TCPOPTS,              /* arg1 = 2*u8 bitmap           */
 210
 211         O_VERREVPATH,           /* none                         */
 212         O_VERSRCREACH,          /* none                         */
 213
 214         O_PROBE_STATE,          /* none                         */
 215         O_KEEP_STATE,           /* none                         */
 216         O_LIMIT,                /* ipfw_insn_limit              */
 217         O_LIMIT_PARENT,         /* dyn_type, not an opcode.     */
 218
 219         /*
 220          * These are really 'actions'.
 221          */
 222
 223         O_LOG,                  /* ipfw_insn_log                */
 224         O_PROB,                 /* u32 = match probability      */
 225
 226         O_CHECK_STATE,          /* none                         */
 227         O_ACCEPT,               /* none                         */
 228         O_DENY,                 /* none                         */
 229         O_REJECT,               /* arg1=icmp arg (same as deny) */
 230         O_COUNT,                /* none                         */
 231         O_SKIPTO,               /* arg1=next rule number        */
 232         O_PIPE,                 /* arg1=pipe number             */
 233         O_QUEUE,                /* arg1=queue number            */
 234         O_DIVERT,               /* arg1=port number             */
 235         O_TEE,                  /* arg1=port number             */
 236         O_FORWARD_IP,           /* fwd sockaddr                 */
 237         O_FORWARD_MAC,          /* fwd mac                      */
 238         O_NAT,                  /* nope                         */
 239         O_REASS,                /* none                         */
 240
 241         /*
 242          * More opcodes.
 243          */
 244         O_IPSEC,                /* has ipsec history            */
 245         O_IP_SRC_LOOKUP,        /* arg1=table number, u32=value */
 246         O_IP_DST_LOOKUP,        /* arg1=table number, u32=value */
 247         O_ANTISPOOF,            /* none                         */
 248         O_JAIL,                 /* u32 = id                     */
 249         O_ALTQ,                 /* u32 = altq classif. qid      */
 250         O_DIVERTED,             /* arg1=bitmap (1:loop, 2:out)  */
 251         O_TCPDATALEN,           /* arg1 = tcp data len          */
 252         O_IP6_SRC,              /* address without mask         */
 253         O_IP6_SRC_ME,           /* my addresses                 */
 254         O_IP6_SRC_MASK,         /* address with the mask        */
 255         O_IP6_DST,
 256         O_IP6_DST_ME,
 257         O_IP6_DST_MASK,
 258         O_FLOW6ID,              /* for flow id tag in the ipv6 pkt */
 259         O_ICMP6TYPE,            /* icmp6 packet type filtering  */
 260         O_EXT_HDR,              /* filtering for ipv6 extension header */
 261         O_IP6,
 262
 263         /*
 264          * actions for ng_ipfw
 265          */
 266         O_NETGRAPH,             /* send to ng_ipfw              */
 267         O_NGTEE,                /* copy to ng_ipfw              */
 268
 269         O_IP4,
 270
 271         O_UNREACH6,             /* arg1=icmpv6 code arg (deny)  */
 272
 273         O_TAG,                  /* arg1=tag number */
 274         O_TAGGED,               /* arg1=tag number */
 275
 276         O_SETFIB,               /* arg1=FIB number */
 277         O_FIB,                  /* arg1=FIB desired fib number */
 278
 279         O_SOCKARG,              /* socket argument */
 280
 281         O_CALLRETURN,           /* arg1=called rule number */
 282
 283         O_FORWARD_IP6,          /* fwd sockaddr_in6             */
 284
 285         O_DSCP,                 /* 2 u32 = DSCP mask */
 286         O_SETDSCP,              /* arg1=DSCP value */
 287         O_IP_FLOW_LOOKUP,       /* arg1=table number, u32=value */
 288
 289         O_EXTERNAL_ACTION,      /* arg1=id of external action handler */
 290         O_EXTERNAL_INSTANCE,    /* arg1=id of eaction handler instance */
 291         O_EXTERNAL_DATA,        /* variable length data */
 292
 293         O_SKIP_ACTION,          /* none                         */
 294         O_TCPMSS,               /* arg1=MSS value */
 295
 296         O_MAC_SRC_LOOKUP,       /* arg1=table number, u32=value */
 297         O_MAC_DST_LOOKUP,       /* arg1=table number, u32=value */
 298
 299         O_LAST_OPCODE           /* not an opcode!               */
 300 };
 301
 302 /*
 303  * Defines key types used by lookup instruction
 304  */
 305 enum ipfw_table_lookup_type {
 306         LOOKUP_DST_IP,
 307         LOOKUP_SRC_IP,
 308         LOOKUP_DST_PORT,
 309         LOOKUP_SRC_PORT,
 310         LOOKUP_UID,
 311         LOOKUP_JAIL,
 312         LOOKUP_DSCP,
 313         LOOKUP_DST_MAC,
 314         LOOKUP_SRC_MAC,
 315 };
 316
 317 /*
 318  * The extension header are filtered only for presence using a bit
 319  * vector with a flag for each header.
 320  */
 321 #define EXT_FRAGMENT    0x1
 322 #define EXT_HOPOPTS     0x2
 323 #define EXT_ROUTING     0x4
 324 #define EXT_AH          0x8
 325 #define EXT_ESP         0x10
 326 #define EXT_DSTOPTS     0x20
 327 #define EXT_RTHDR0              0x40
 328 #define EXT_RTHDR2              0x80
 329
 330 /*
 331  * Template for instructions.
 332  *
 333  * ipfw_insn is used for all instructions which require no operands,
 334  * a single 16-bit value (arg1), or a couple of 8-bit values.
 335  *
 336  * For other instructions which require different/larger arguments
 337  * we have derived structures, ipfw_insn_*.
 338  *
 339  * The size of the instruction (in 32-bit words) is in the low
 340  * 6 bits of "len". The 2 remaining bits are used to implement
 341  * NOT and OR on individual instructions. Given a type, you can
 342  * compute the length to be put in "len" using F_INSN_SIZE(t)
 343  *
 344  * F_NOT        negates the match result of the instruction.
 345  *
 346  * F_OR         is used to build or blocks. By default, instructions
 347  *              are evaluated as part of a logical AND. An "or" block
 348  *              { X or Y or Z } contains F_OR set in all but the last
 349  *              instruction of the block. A match will cause the code
 350  *              to skip past the last instruction of the block.
 351  *
 352  * NOTA BENE: in a couple of places we assume that
 353  *      sizeof(ipfw_insn) == sizeof(u_int32_t)
 354  * this needs to be fixed.
 355  *
 356  */
 357 typedef struct  _ipfw_insn {    /* template for instructions */
 358         _Alignas(_Alignof(u_int32_t)) u_int8_t  opcode;
 359         u_int8_t        len;    /* number of 32-bit words */
 360 #define F_NOT           0x80
 361 #define F_OR            0x40
 362 #define F_LEN_MASK      0x3f
 363 #define F_LEN(cmd)      ((cmd)->len & F_LEN_MASK)
 364
 365         u_int16_t       arg1;
 366 } ipfw_insn;
 367
 368 /*
 369  * The F_INSN_SIZE(type) computes the size, in 4-byte words, of
 370  * a given type.
 371  */
 372 #define F_INSN_SIZE(t)  ((sizeof (t))/sizeof(u_int32_t))
 373
 374 /*
 375  * This is used to store an array of 16-bit entries (ports etc.)
 376  */
 377 typedef struct  _ipfw_insn_u16 {
 378         ipfw_insn o;
 379         u_int16_t ports[2];     /* there may be more */
 380 } ipfw_insn_u16;
 381
 382 /*
 383  * This is used to store an array of 32-bit entries
 384  * (uid, single IPv4 addresses etc.)
 385  */
 386 typedef struct  _ipfw_insn_u32 {
 387         ipfw_insn o;
 388         u_int32_t d[1]; /* one or more */
 389 } ipfw_insn_u32;
 390
 391 /*
 392  * This is used to store IP addr-mask pairs.
 393  */
 394 typedef struct  _ipfw_insn_ip {
 395         ipfw_insn o;
 396         struct in_addr  addr;
 397         struct in_addr  mask;
 398 } ipfw_insn_ip;
 399
 400 /*
 401  * This is used to forward to a given address (ip).
 402  */
 403 typedef struct  _ipfw_insn_sa {
 404         ipfw_insn o;
 405         struct sockaddr_in sa;
 406 } ipfw_insn_sa;
 407
 408 /*
 409  * This is used to forward to a given address (ipv6).
 410  */
 411 typedef struct _ipfw_insn_sa6 {
 412         ipfw_insn o;
 413         struct sockaddr_in6 sa;
 414 } ipfw_insn_sa6;
 415
 416 /*
 417  * This is used for MAC addr-mask pairs.
 418  */
 419 typedef struct  _ipfw_insn_mac {
 420         ipfw_insn o;
 421         u_char addr[12];        /* dst[6] + src[6] */
 422         u_char mask[12];        /* dst[6] + src[6] */
 423 } ipfw_insn_mac;
 424
 425 /*
 426  * This is used for interface match rules (recv xx, xmit xx).
 427  */
 428 typedef struct  _ipfw_insn_if {
 429         ipfw_insn o;
 430         union {
 431                 struct in_addr ip;
 432                 int glob;
 433                 uint16_t kidx;
 434         } p;
 435         char name[IFNAMSIZ];
 436 } ipfw_insn_if;
 437
 438 /*
 439  * This is used for storing an altq queue id number.
 440  */
 441 typedef struct _ipfw_insn_altq {
 442         ipfw_insn       o;
 443         u_int32_t       qid;
 444 } ipfw_insn_altq;
 445
 446 /*
 447  * This is used for limit rules.
 448  */
 449 typedef struct  _ipfw_insn_limit {
 450         ipfw_insn o;
 451         u_int8_t _pad;
 452         u_int8_t limit_mask;    /* combination of DYN_* below   */
 453 #define DYN_SRC_ADDR    0x1
 454 #define DYN_SRC_PORT    0x2
 455 #define DYN_DST_ADDR    0x4
 456 #define DYN_DST_PORT    0x8
 457
 458         u_int16_t conn_limit;
 459 } ipfw_insn_limit;
 460
 461 /*
 462  * This is used for log instructions.
 463  */
 464 typedef struct  _ipfw_insn_log {
 465         ipfw_insn o;
 466         u_int32_t max_log;      /* how many do we log -- 0 = all */
 467         u_int32_t log_left;     /* how many left to log         */
 468 } ipfw_insn_log;
 469
 470 /* Legacy NAT structures, compat only */
 471 #ifndef _KERNEL
 472 /*
 473  * Data structures required by both ipfw(8) and ipfw(4) but not part of the
 474  * management API are protected by IPFW_INTERNAL.
 475  */
 476 #ifdef IPFW_INTERNAL
 477 /* Server pool support (LSNAT). */
 478 struct cfg_spool {
 479         LIST_ENTRY(cfg_spool)   _next;          /* chain of spool instances */
 480         struct in_addr          addr;
 481         u_short                 port;
 482 };
 483 #endif
 484
 485 /* Redirect modes id. */
 486 #define REDIR_ADDR      0x01
 487 #define REDIR_PORT      0x02
 488 #define REDIR_PROTO     0x04
 489
 490 #ifdef IPFW_INTERNAL
 491 /* Nat redirect configuration. */
 492 struct cfg_redir {
 493         LIST_ENTRY(cfg_redir)   _next;          /* chain of redir instances */
 494         u_int16_t               mode;           /* type of redirect mode */
 495         struct in_addr          laddr;          /* local ip address */
 496         struct in_addr          paddr;          /* public ip address */
 497         struct in_addr          raddr;          /* remote ip address */
 498         u_short                 lport;          /* local port */
 499         u_short                 pport;          /* public port */
 500         u_short                 rport;          /* remote port  */
 501         u_short                 pport_cnt;      /* number of public ports */
 502         u_short                 rport_cnt;      /* number of remote ports */
 503         int                     proto;          /* protocol: tcp/udp */
 504         struct alias_link       **alink;
 505         /* num of entry in spool chain */
 506         u_int16_t               spool_cnt;
 507         /* chain of spool instances */
 508         LIST_HEAD(spool_chain, cfg_spool) spool_chain;
 509 };
 510 #endif
 511
 512 #ifdef IPFW_INTERNAL
 513 /* Nat configuration data struct. */
 514 struct cfg_nat {
 515         /* chain of nat instances */
 516         LIST_ENTRY(cfg_nat)     _next;
 517         int                     id;                     /* nat id */
 518         struct in_addr          ip;                     /* nat ip address */
 519         char                    if_name[IF_NAMESIZE];   /* interface name */
 520         int                     mode;                   /* aliasing mode */
 521         struct libalias         *lib;                   /* libalias instance */
 522         /* number of entry in spool chain */
 523         int                     redir_cnt;
 524         /* chain of redir instances */
 525         LIST_HEAD(redir_chain, cfg_redir) redir_chain;
 526 };
 527 #endif
 528
 529 #define SOF_NAT         sizeof(struct cfg_nat)
 530 #define SOF_REDIR       sizeof(struct cfg_redir)
 531 #define SOF_SPOOL       sizeof(struct cfg_spool)
 532
 533 #endif  /* ifndef _KERNEL */
 534
 535 struct nat44_cfg_spool {
 536         struct in_addr  addr;
 537         uint16_t        port;
 538         uint16_t        spare;
 539 };
 540 #define NAT44_REDIR_ADDR        0x01
 541 #define NAT44_REDIR_PORT        0x02
 542 #define NAT44_REDIR_PROTO       0x04
 543
 544 /* Nat redirect configuration. */
 545 struct nat44_cfg_redir {
 546         struct in_addr  laddr;          /* local ip address */
 547         struct in_addr  paddr;          /* public ip address */
 548         struct in_addr  raddr;          /* remote ip address */
 549         uint16_t        lport;          /* local port */
 550         uint16_t        pport;          /* public port */
 551         uint16_t        rport;          /* remote port  */
 552         uint16_t        pport_cnt;      /* number of public ports */
 553         uint16_t        rport_cnt;      /* number of remote ports */
 554         uint16_t        mode;           /* type of redirect mode */
 555         uint16_t        spool_cnt;      /* num of entry in spool chain */
 556         uint16_t        spare;
 557         uint32_t        proto;          /* protocol: tcp/udp */
 558 };
 559
 560 /* Nat configuration data struct. */
 561 struct nat44_cfg_nat {
 562         char            name[64];       /* nat name */
 563         char            if_name[64];    /* interface name */
 564         uint32_t        size;           /* structure size incl. redirs */
 565         struct in_addr  ip;             /* nat IPv4 address */
 566         uint32_t        mode;           /* aliasing mode */
 567         uint32_t        redir_cnt;      /* number of entry in spool chain */
 568         u_short         alias_port_lo;  /* low range for port aliasing */
 569         u_short         alias_port_hi;  /* high range for port aliasing */
 570 };
 571
 572 /* Nat command. */
 573 typedef struct  _ipfw_insn_nat {
 574         ipfw_insn       o;
 575         struct cfg_nat *nat;
 576 } ipfw_insn_nat;
 577
 578 /* Apply ipv6 mask on ipv6 addr */
 579 #define APPLY_MASK(addr,mask)   do {                                    \
 580     (addr)->__u6_addr.__u6_addr32[0] &= (mask)->__u6_addr.__u6_addr32[0]; \
 581     (addr)->__u6_addr.__u6_addr32[1] &= (mask)->__u6_addr.__u6_addr32[1]; \
 582     (addr)->__u6_addr.__u6_addr32[2] &= (mask)->__u6_addr.__u6_addr32[2]; \
 583     (addr)->__u6_addr.__u6_addr32[3] &= (mask)->__u6_addr.__u6_addr32[3]; \
 584 } while (0)
 585
 586 /* Structure for ipv6 */
 587 typedef struct _ipfw_insn_ip6 {
 588        ipfw_insn o;
 589        struct in6_addr addr6;
 590        struct in6_addr mask6;
 591 } ipfw_insn_ip6;
 592
 593 /* Used to support icmp6 types */
 594 typedef struct _ipfw_insn_icmp6 {
 595        ipfw_insn o;
 596        uint32_t d[7]; /* XXX This number si related to the netinet/icmp6.h
 597                        *     define ICMP6_MAXTYPE
 598                        *     as follows: n = ICMP6_MAXTYPE/32 + 1
 599                         *     Actually is 203
 600                        */
 601 } ipfw_insn_icmp6;
 602
 603 /*
 604  * Here we have the structure representing an ipfw rule.
 605  *
 606  * Layout:
 607  * struct ip_fw_rule
 608  * [ counter block, size = rule->cntr_len ]
 609  * [ one or more instructions, size = rule->cmd_len * 4 ]
 610  *
 611  * It starts with a general area (with link fields).
 612  * Counter block may be next (if rule->cntr_len > 0),
 613  * followed by an array of one or more instructions, which the code
 614  * accesses as an array of 32-bit values. rule->cmd_len represents
 615  * the total instructions legth in u32 worrd, while act_ofs represents
 616  * rule action offset in u32 words.
 617  *
 618  * When assembling instruction, remember the following:
 619  *
 620  *  + if a rule has a "keep-state" (or "limit") option, then the
 621  *      first instruction (at r->cmd) MUST BE an O_PROBE_STATE
 622  *  + if a rule has a "log" option, then the first action
 623  *      (at ACTION_PTR(r)) MUST be O_LOG
 624  *  + if a rule has an "altq" option, it comes after "log"
 625  *  + if a rule has an O_TAG option, it comes after "log" and "altq"
 626  *
 627  *
 628  * All structures (excluding instructions) are u64-aligned.
 629  * Please keep this.
 630  */
 631
 632 struct ip_fw_rule {
 633         uint16_t        act_ofs;        /* offset of action in 32-bit units */
 634         uint16_t        cmd_len;        /* # of 32-bit words in cmd     */
 635         uint16_t        spare;
 636         uint8_t         set;            /* rule set (0..31)             */
 637         uint8_t         flags;          /* rule flags                   */
 638         uint32_t        rulenum;        /* rule number                  */
 639         uint32_t        id;             /* rule id                      */
 640
 641         ipfw_insn       cmd[1];         /* storage for commands         */
 642 };
 643 #define IPFW_RULE_NOOPT         0x01    /* Has no options in body       */
 644 #define IPFW_RULE_JUSTOPTS      0x02    /* new format of rule body      */
 645
 646 /* Unaligned version */
 647
 648 /* Base ipfw rule counter block. */
 649 struct ip_fw_bcounter {
 650         uint16_t        size;           /* Size of counter block, bytes */
 651         uint8_t         flags;          /* flags for given block        */
 652         uint8_t         spare;
 653         uint32_t        timestamp;      /* tv_sec of last match         */
 654         uint64_t        pcnt;           /* Packet counter               */
 655         uint64_t        bcnt;           /* Byte counter                 */
 656 };
 657
 658 #ifndef _KERNEL
 659 /*
 660  * Legacy rule format
 661  */
 662 struct ip_fw {
 663         struct ip_fw    *x_next;        /* linked list of rules         */
 664         struct ip_fw    *next_rule;     /* ptr to next [skipto] rule    */
 665         /* 'next_rule' is used to pass up 'set_disable' status          */
 666
 667         uint16_t        act_ofs;        /* offset of action in 32-bit units */
 668         uint16_t        cmd_len;        /* # of 32-bit words in cmd     */
 669         uint16_t        rulenum;        /* rule number                  */
 670         uint8_t         set;            /* rule set (0..31)             */
 671         uint8_t         _pad;           /* padding                      */
 672         uint32_t        id;             /* rule id */
 673
 674         /* These fields are present in all rules.                       */
 675         uint64_t        pcnt;           /* Packet counter               */
 676         uint64_t        bcnt;           /* Byte counter                 */
 677         uint32_t        timestamp;      /* tv_sec of last match         */
 678
 679         ipfw_insn       cmd[1];         /* storage for commands         */
 680 };
 681 #endif
 682
 683 #define ACTION_PTR(rule)                                \
 684         (ipfw_insn *)( (u_int32_t *)((rule)->cmd) + ((rule)->act_ofs) )
 685
 686 #define RULESIZE(rule)  (sizeof(*(rule)) + (rule)->cmd_len * 4 - 4)
 687
 688 #if 1 // should be moved to in.h
 689 /*
 690  * This structure is used as a flow mask and a flow id for various
 691  * parts of the code.
 692  * addr_type is used in userland and kernel to mark the address type.
 693  * fib is used in the kernel to record the fib in use.
 694  * _flags is used in the kernel to store tcp flags for dynamic rules.
 695  */
 696 struct ipfw_flow_id {
 697         uint32_t        dst_ip;
 698         uint32_t        src_ip;
 699         uint16_t        dst_port;
 700         uint16_t        src_port;
 701         uint8_t         fib;    /* XXX: must be uint16_t */
 702         uint8_t         proto;
 703         uint8_t         _flags; /* protocol-specific flags */
 704         uint8_t         addr_type; /* 4=ip4, 6=ip6, 1=ether ? */
 705         struct in6_addr dst_ip6;
 706         struct in6_addr src_ip6;
 707         uint32_t        flow_id6;
 708         uint32_t        extra; /* queue/pipe or frag_id */
 709 };
 710 #endif
 711
 712 #define IS_IP4_FLOW_ID(id)      ((id)->addr_type == 4)
 713 #define IS_IP6_FLOW_ID(id)      ((id)->addr_type == 6)
 714
 715 /*
 716  * Dynamic ipfw rule.
 717  */
 718 typedef struct _ipfw_dyn_rule ipfw_dyn_rule;
 719
 720 struct _ipfw_dyn_rule {
 721         ipfw_dyn_rule   *next;          /* linked list of rules.        */
 722         struct ip_fw *rule;             /* pointer to rule              */
 723         /* 'rule' is used to pass up the rule number (from the parent)  */
 724
 725         ipfw_dyn_rule *parent;          /* pointer to parent rule       */
 726         u_int64_t       pcnt;           /* packet match counter         */
 727         u_int64_t       bcnt;           /* byte match counter           */
 728         struct ipfw_flow_id id;         /* (masked) flow id             */
 729         u_int32_t       expire;         /* expire time                  */
 730         u_int32_t       bucket;         /* which bucket in hash table   */
 731         u_int32_t       state;          /* state of this rule (typically a
 732                                          * combination of TCP flags)
 733                                          */
 734 #define IPFW_DYN_ORPHANED       0x40000 /* state's parent rule was deleted */
 735         u_int32_t       ack_fwd;        /* most recent ACKs in forward  */
 736         u_int32_t       ack_rev;        /* and reverse directions (used */
 737                                         /* to generate keepalives)      */
 738         u_int16_t       dyn_type;       /* rule type                    */
 739         u_int16_t       count;          /* refcount                     */
 740         u_int16_t       kidx;           /* index of named object */
 741 } __packed __aligned(8);
 742
 743 /*
 744  * Definitions for IP option names.
 745  */
 746 #define IP_FW_IPOPT_LSRR        0x01
 747 #define IP_FW_IPOPT_SSRR        0x02
 748 #define IP_FW_IPOPT_RR          0x04
 749 #define IP_FW_IPOPT_TS          0x08
 750
 751 /*
 752  * Definitions for TCP option names.
 753  */
 754 #define IP_FW_TCPOPT_MSS        0x01
 755 #define IP_FW_TCPOPT_WINDOW     0x02
 756 #define IP_FW_TCPOPT_SACK       0x04
 757 #define IP_FW_TCPOPT_TS         0x08
 758 #define IP_FW_TCPOPT_CC         0x10
 759
 760 #define ICMP_REJECT_RST         0x100   /* fake ICMP code (send a TCP RST) */
 761 #define ICMP6_UNREACH_RST       0x100   /* fake ICMPv6 code (send a TCP RST) */
 762 #define ICMP_REJECT_ABORT       0x101   /* fake ICMP code (send an SCTP ABORT) */
 763 #define ICMP6_UNREACH_ABORT     0x101   /* fake ICMPv6 code (send an SCTP ABORT) */
 764
 765 /*
 766  * These are used for lookup tables.
 767  */
 768
 769 #define IPFW_TABLE_ADDR         1       /* Table for holding IPv4/IPv6 prefixes */
 770 #define IPFW_TABLE_INTERFACE    2       /* Table for holding interface names */
 771 #define IPFW_TABLE_NUMBER       3       /* Table for holding ports/uid/gid/etc */
 772 #define IPFW_TABLE_FLOW         4       /* Table for holding flow data */
 773 #define IPFW_TABLE_MAC          5       /* Table for holding mac address prefixes */
 774 #define IPFW_TABLE_MAXTYPE      5       /* Maximum valid number */
 775
 776 #define IPFW_TABLE_CIDR IPFW_TABLE_ADDR /* compat */
 777
 778 /* Value types */
 779 #define IPFW_VTYPE_LEGACY       0xFFFFFFFF      /* All data is filled in */
 780 #define IPFW_VTYPE_SKIPTO       0x00000001      /* skipto/call/callreturn */
 781 #define IPFW_VTYPE_PIPE         0x00000002      /* pipe/queue */
 782 #define IPFW_VTYPE_FIB          0x00000004      /* setfib */
 783 #define IPFW_VTYPE_NAT          0x00000008      /* nat */
 784 #define IPFW_VTYPE_DSCP         0x00000010      /* dscp */
 785 #define IPFW_VTYPE_TAG          0x00000020      /* tag/untag */
 786 #define IPFW_VTYPE_DIVERT       0x00000040      /* divert/tee */
 787 #define IPFW_VTYPE_NETGRAPH     0x00000080      /* netgraph/ngtee */
 788 #define IPFW_VTYPE_LIMIT        0x00000100      /* limit */
 789 #define IPFW_VTYPE_NH4          0x00000200      /* IPv4 nexthop */
 790 #define IPFW_VTYPE_NH6          0x00000400      /* IPv6 nexthop */
 791
 792 /* MAC/InfiniBand/etc address length */
 793 #define IPFW_MAX_L2_ADDR_LEN    20
 794
 795 typedef struct  _ipfw_table_entry {
 796         in_addr_t       addr;           /* network address              */
 797         u_int32_t       value;          /* value                        */
 798         u_int16_t       tbl;            /* table number                 */
 799         u_int8_t        masklen;        /* mask length                  */
 800 } ipfw_table_entry;
 801
 802 typedef struct  _ipfw_table_xentry {
 803         uint16_t        len;            /* Total entry length           */
 804         uint8_t         type;           /* entry type                   */
 805         uint8_t         masklen;        /* mask length                  */
 806         uint16_t        tbl;            /* table number                 */
 807         uint16_t        flags;          /* record flags                 */
 808         uint32_t        value;          /* value                        */
 809         union {
 810                 /* Longest field needs to be aligned by 4-byte boundary */
 811                 struct in6_addr addr6;  /* IPv6 address                 */
 812                 char    iface[IF_NAMESIZE];     /* interface name       */
 813         } k;
 814 } ipfw_table_xentry;
 815 #define IPFW_TCF_INET   0x01            /* CIDR flags: IPv4 record      */
 816
 817 typedef struct  _ipfw_table {
 818         u_int32_t       size;           /* size of entries in bytes     */
 819         u_int32_t       cnt;            /* # of entries                 */
 820         u_int16_t       tbl;            /* table number                 */
 821         ipfw_table_entry ent[0];        /* entries                      */
 822 } ipfw_table;
 823
 824 typedef struct  _ipfw_xtable {
 825         ip_fw3_opheader opheader;       /* IP_FW3 opcode */
 826         uint32_t        size;           /* size of entries in bytes     */
 827         uint32_t        cnt;            /* # of entries                 */
 828         uint16_t        tbl;            /* table number                 */
 829         uint8_t         type;           /* table type                   */
 830         ipfw_table_xentry xent[0];      /* entries                      */
 831 } ipfw_xtable;
 832
 833 typedef struct  _ipfw_obj_tlv {
 834         uint16_t        type;           /* TLV type */
 835         uint16_t        flags;          /* TLV-specific flags           */
 836         uint32_t        length;         /* Total length, aligned to u64 */
 837 } ipfw_obj_tlv;
 838 #define IPFW_TLV_TBL_NAME       1
 839 #define IPFW_TLV_TBLNAME_LIST   2
 840 #define IPFW_TLV_RULE_LIST      3
 841 #define IPFW_TLV_DYNSTATE_LIST  4
 842 #define IPFW_TLV_TBL_ENT        5
 843 #define IPFW_TLV_DYN_ENT        6
 844 #define IPFW_TLV_RULE_ENT       7
 845 #define IPFW_TLV_TBLENT_LIST    8
 846 #define IPFW_TLV_RANGE          9
 847 #define IPFW_TLV_EACTION        10
 848 #define IPFW_TLV_COUNTERS       11
 849 #define IPFW_TLV_OBJDATA        12
 850 #define IPFW_TLV_STATE_NAME     14
 851
 852 #define IPFW_TLV_EACTION_BASE   1000
 853 #define IPFW_TLV_EACTION_NAME(arg)      (IPFW_TLV_EACTION_BASE + (arg))
 854
 855 typedef struct _ipfw_obj_data {
 856         ipfw_obj_tlv    head;
 857         void            *data[0];
 858 } ipfw_obj_data;
 859
 860 /* Object name TLV */
 861 typedef struct _ipfw_obj_ntlv {
 862         ipfw_obj_tlv    head;           /* TLV header                   */
 863         uint16_t        idx;            /* Name index                   */
 864         uint8_t         set;            /* set, if applicable           */
 865         uint8_t         type;           /* object type, if applicable   */
 866         uint32_t        spare;          /* unused                       */
 867         char            name[64];       /* Null-terminated name         */
 868 } ipfw_obj_ntlv;
 869
 870 /* IPv4/IPv6 L4 flow description */
 871 struct tflow_entry {
 872         uint8_t         af;
 873         uint8_t         proto;
 874         uint16_t        spare;
 875         uint16_t        sport;
 876         uint16_t        dport;
 877         union {
 878                 struct {
 879                         struct in_addr  sip;
 880                         struct in_addr  dip;
 881                 } a4;
 882                 struct {
 883                         struct in6_addr sip6;
 884                         struct in6_addr dip6;
 885                 } a6;
 886         } a;
 887 };
 888
 889 typedef struct _ipfw_table_value {
 890         uint32_t        tag;            /* O_TAG/O_TAGGED */
 891         uint32_t        pipe;           /* O_PIPE/O_QUEUE */
 892         uint16_t        divert;         /* O_DIVERT/O_TEE */
 893         uint16_t        skipto;         /* skipto, CALLRET */
 894         uint32_t        netgraph;       /* O_NETGRAPH/O_NGTEE */
 895         uint32_t        fib;            /* O_SETFIB */
 896         uint32_t        nat;            /* O_NAT */
 897         uint32_t        nh4;
 898         uint8_t         dscp;
 899         uint8_t         spare0;
 900         uint16_t        spare1;
 901         struct in6_addr nh6;
 902         uint32_t        limit;          /* O_LIMIT */
 903         uint32_t        zoneid;         /* scope zone id for nh6 */
 904         uint64_t        reserved;
 905 } ipfw_table_value;
 906
 907 /* Table entry TLV */
 908 typedef struct  _ipfw_obj_tentry {
 909         ipfw_obj_tlv    head;           /* TLV header                   */
 910         uint8_t         subtype;        /* subtype (IPv4,IPv6)          */
 911         uint8_t         masklen;        /* mask length                  */
 912         uint8_t         result;         /* request result               */
 913         uint8_t         spare0;
 914         uint16_t        idx;            /* Table name index             */
 915         uint16_t        spare1;
 916         union {
 917                 /* Longest field needs to be aligned by 8-byte boundary */
 918                 struct in_addr          addr;           /* IPv4 address         */
 919                 uint32_t                key;            /* uid/gid/port         */
 920                 struct in6_addr         addr6;          /* IPv6 address         */
 921                 char    iface[IF_NAMESIZE];             /* interface name       */
 922                 u_char  mac[IPFW_MAX_L2_ADDR_LEN];      /* MAC address          */
 923                 struct tflow_entry      flow;
 924         } k;
 925         union {
 926                 ipfw_table_value        value;  /* value data */
 927                 uint32_t                kidx;   /* value kernel index */
 928         } v;
 929 } ipfw_obj_tentry;
 930 #define IPFW_TF_UPDATE  0x01            /* Update record if exists      */
 931 /* Container TLV */
 932 #define IPFW_CTF_ATOMIC 0x01            /* Perform atomic operation     */
 933 /* Operation results */
 934 #define IPFW_TR_IGNORED         0       /* Entry was ignored (rollback) */
 935 #define IPFW_TR_ADDED           1       /* Entry was successfully added */
 936 #define IPFW_TR_UPDATED         2       /* Entry was successfully updated*/
 937 #define IPFW_TR_DELETED         3       /* Entry was successfully deleted*/
 938 #define IPFW_TR_LIMIT           4       /* Entry was ignored (limit)    */
 939 #define IPFW_TR_NOTFOUND        5       /* Entry was not found          */
 940 #define IPFW_TR_EXISTS          6       /* Entry already exists         */
 941 #define IPFW_TR_ERROR           7       /* Request has failed (unknown) */
 942
 943 typedef struct _ipfw_obj_dyntlv {
 944         ipfw_obj_tlv    head;
 945         ipfw_dyn_rule   state;
 946 } ipfw_obj_dyntlv;
 947 #define IPFW_DF_LAST    0x01            /* Last state in chain          */
 948
 949 /* Containter TLVs */
 950 typedef struct _ipfw_obj_ctlv {
 951         ipfw_obj_tlv    head;           /* TLV header                   */
 952         uint32_t        count;          /* Number of sub-TLVs           */
 953         uint16_t        objsize;        /* Single object size           */
 954         uint8_t         version;        /* TLV version                  */
 955         uint8_t         flags;          /* TLV-specific flags           */
 956 } ipfw_obj_ctlv;
 957
 958 /* Range TLV */
 959 typedef struct _ipfw_range_tlv {
 960         ipfw_obj_tlv    head;           /* TLV header                   */
 961         uint32_t        flags;          /* Range flags                  */
 962         uint16_t        start_rule;     /* Range start                  */
 963         uint16_t        end_rule;       /* Range end                    */
 964         uint32_t        set;            /* Range set to match            */
 965         uint32_t        new_set;        /* New set to move/swap to      */
 966 } ipfw_range_tlv;
 967 #define IPFW_RCFLAG_RANGE       0x01    /* rule range is set            */
 968 #define IPFW_RCFLAG_ALL         0x02    /* match ALL rules              */
 969 #define IPFW_RCFLAG_SET         0x04    /* match rules in given set     */
 970 #define IPFW_RCFLAG_DYNAMIC     0x08    /* match only dynamic states    */
 971 /* User-settable flags */
 972 #define IPFW_RCFLAG_USER        (IPFW_RCFLAG_RANGE | IPFW_RCFLAG_ALL | \
 973         IPFW_RCFLAG_SET | IPFW_RCFLAG_DYNAMIC)
 974 /* Internally used flags */
 975 #define IPFW_RCFLAG_DEFAULT     0x0100  /* Do not skip defaul rule      */
 976
 977 typedef struct _ipfw_ta_tinfo {
 978         uint32_t        flags;          /* Format flags                 */
 979         uint32_t        spare;
 980         uint8_t         taclass4;       /* algorithm class              */
 981         uint8_t         spare4;
 982         uint16_t        itemsize4;      /* item size in runtime         */
 983         uint32_t        size4;          /* runtime structure size       */
 984         uint32_t        count4;         /* number of items in runtime   */
 985         uint8_t         taclass6;       /* algorithm class              */
 986         uint8_t         spare6;
 987         uint16_t        itemsize6;      /* item size in runtime         */
 988         uint32_t        size6;          /* runtime structure size       */
 989         uint32_t        count6;         /* number of items in runtime   */
 990 } ipfw_ta_tinfo;
 991 #define IPFW_TACLASS_HASH       1       /* algo is based on hash        */
 992 #define IPFW_TACLASS_ARRAY      2       /* algo is based on array       */
 993 #define IPFW_TACLASS_RADIX      3       /* algo is based on radix tree  */
 994
 995 #define IPFW_TATFLAGS_DATA      0x0001          /* Has data filled in   */
 996 #define IPFW_TATFLAGS_AFDATA    0x0002          /* Separate data per AF */
 997 #define IPFW_TATFLAGS_AFITEM    0x0004          /* diff. items per AF   */
 998
 999 typedef struct _ipfw_xtable_info {
1000         uint8_t         type;           /* table type (addr,iface,..)   */
1001         uint8_t         tflags;         /* type flags                   */
1002         uint16_t        mflags;         /* modification flags           */
1003         uint16_t        flags;          /* generic table flags          */
1004         uint16_t        spare[3];
1005         uint32_t        vmask;          /* bitmask with value types     */
1006         uint32_t        set;            /* set table is in              */
1007         uint32_t        kidx;           /* kernel index                 */
1008         uint32_t        refcnt;         /* number of references         */
1009         uint32_t        count;          /* Number of records            */
1010         uint32_t        size;           /* Total size of records(export)*/
1011         uint32_t        limit;          /* Max number of records        */
1012         char            tablename[64];  /* table name */
1013         char            algoname[64];   /* algorithm name               */
1014         ipfw_ta_tinfo   ta_info;        /* additional algo stats        */
1015 } ipfw_xtable_info;
1016 /* Generic table flags */
1017 #define IPFW_TGFLAGS_LOCKED     0x01    /* Tables is locked from changes*/
1018 /* Table type-specific flags */
1019 #define IPFW_TFFLAG_SRCIP       0x01
1020 #define IPFW_TFFLAG_DSTIP       0x02
1021 #define IPFW_TFFLAG_SRCPORT     0x04
1022 #define IPFW_TFFLAG_DSTPORT     0x08
1023 #define IPFW_TFFLAG_PROTO       0x10
1024 /* Table modification flags */
1025 #define IPFW_TMFLAGS_LIMIT      0x0002  /* Change limit value           */
1026 #define IPFW_TMFLAGS_LOCK       0x0004  /* Change table lock state      */
1027
1028 typedef struct _ipfw_iface_info {
1029         char            ifname[64];     /* interface name               */
1030         uint32_t        ifindex;        /* interface index              */
1031         uint32_t        flags;          /* flags                        */
1032         uint32_t        refcnt;         /* number of references         */
1033         uint32_t        gencnt;         /* number of changes            */
1034         uint64_t        spare;
1035 } ipfw_iface_info;
1036 #define IPFW_IFFLAG_RESOLVED    0x01    /* Interface exists             */
1037
1038 typedef struct _ipfw_ta_info {
1039         char            algoname[64];   /* algorithm name               */
1040         uint32_t        type;           /* lookup type                  */
1041         uint32_t        flags;
1042         uint32_t        refcnt;
1043         uint32_t        spare0;
1044         uint64_t        spare1;
1045 } ipfw_ta_info;
1046
1047 typedef struct _ipfw_obj_header {
1048         ip_fw3_opheader opheader;       /* IP_FW3 opcode                */
1049         uint32_t        spare;
1050         uint16_t        idx;            /* object name index            */
1051         uint8_t         objtype;        /* object type                  */
1052         uint8_t         objsubtype;     /* object subtype               */
1053         ipfw_obj_ntlv   ntlv;           /* object name tlv              */
1054 } ipfw_obj_header;
1055
1056 typedef struct _ipfw_obj_lheader {
1057         ip_fw3_opheader opheader;       /* IP_FW3 opcode                */
1058         uint32_t        set_mask;       /* disabled set mask            */
1059         uint32_t        count;          /* Total objects count          */
1060         uint32_t        size;           /* Total size (incl. header)    */
1061         uint32_t        objsize;        /* Size of one object           */
1062 } ipfw_obj_lheader;
1063
1064 #define IPFW_CFG_GET_STATIC     0x01
1065 #define IPFW_CFG_GET_STATES     0x02
1066 #define IPFW_CFG_GET_COUNTERS   0x04
1067 typedef struct _ipfw_cfg_lheader {
1068         ip_fw3_opheader opheader;       /* IP_FW3 opcode                */
1069         uint32_t        set_mask;       /* enabled set mask             */
1070         uint32_t        spare;
1071         uint32_t        flags;          /* Request flags                */
1072         uint32_t        size;           /* neded buffer size            */
1073         uint32_t        start_rule;
1074         uint32_t        end_rule;
1075 } ipfw_cfg_lheader;
1076
1077 typedef struct _ipfw_range_header {
1078         ip_fw3_opheader opheader;       /* IP_FW3 opcode                */
1079         ipfw_range_tlv  range;
1080 } ipfw_range_header;
1081
1082 typedef struct _ipfw_sopt_info {
1083         uint16_t        opcode;
1084         uint8_t         version;
1085         uint8_t         dir;
1086         uint8_t         spare;
1087         uint64_t        refcnt;
1088 } ipfw_sopt_info;
1089
1090 #endif /* _IPFW2_H */