1 /*- 2 * Copyright (c) 2002-2009 Luigi Rizzo, Universita` di Pisa 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23 * SUCH DAMAGE. 24 * 25 * $FreeBSD$ 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_LAST_OPCODE /* not an opcode! */ 297 }; 298 299 /* 300 * The extension header are filtered only for presence using a bit 301 * vector with a flag for each header. 302 */ 303 #define EXT_FRAGMENT 0x1 304 #define EXT_HOPOPTS 0x2 305 #define EXT_ROUTING 0x4 306 #define EXT_AH 0x8 307 #define EXT_ESP 0x10 308 #define EXT_DSTOPTS 0x20 309 #define EXT_RTHDR0 0x40 310 #define EXT_RTHDR2 0x80 311 312 /* 313 * Template for instructions. 314 * 315 * ipfw_insn is used for all instructions which require no operands, 316 * a single 16-bit value (arg1), or a couple of 8-bit values. 317 * 318 * For other instructions which require different/larger arguments 319 * we have derived structures, ipfw_insn_*. 320 * 321 * The size of the instruction (in 32-bit words) is in the low 322 * 6 bits of "len". The 2 remaining bits are used to implement 323 * NOT and OR on individual instructions. Given a type, you can 324 * compute the length to be put in "len" using F_INSN_SIZE(t) 325 * 326 * F_NOT negates the match result of the instruction. 327 * 328 * F_OR is used to build or blocks. By default, instructions 329 * are evaluated as part of a logical AND. An "or" block 330 * { X or Y or Z } contains F_OR set in all but the last 331 * instruction of the block. A match will cause the code 332 * to skip past the last instruction of the block. 333 * 334 * NOTA BENE: in a couple of places we assume that 335 * sizeof(ipfw_insn) == sizeof(u_int32_t) 336 * this needs to be fixed. 337 * 338 */ 339 typedef struct _ipfw_insn { /* template for instructions */ 340 u_int8_t opcode; 341 u_int8_t len; /* number of 32-bit words */ 342 #define F_NOT 0x80 343 #define F_OR 0x40 344 #define F_LEN_MASK 0x3f 345 #define F_LEN(cmd) ((cmd)->len & F_LEN_MASK) 346 347 u_int16_t arg1; 348 } ipfw_insn; 349 350 /* 351 * The F_INSN_SIZE(type) computes the size, in 4-byte words, of 352 * a given type. 353 */ 354 #define F_INSN_SIZE(t) ((sizeof (t))/sizeof(u_int32_t)) 355 356 /* 357 * This is used to store an array of 16-bit entries (ports etc.) 358 */ 359 typedef struct _ipfw_insn_u16 { 360 ipfw_insn o; 361 u_int16_t ports[2]; /* there may be more */ 362 } ipfw_insn_u16; 363 364 /* 365 * This is used to store an array of 32-bit entries 366 * (uid, single IPv4 addresses etc.) 367 */ 368 typedef struct _ipfw_insn_u32 { 369 ipfw_insn o; 370 u_int32_t d[1]; /* one or more */ 371 } ipfw_insn_u32; 372 373 /* 374 * This is used to store IP addr-mask pairs. 375 */ 376 typedef struct _ipfw_insn_ip { 377 ipfw_insn o; 378 struct in_addr addr; 379 struct in_addr mask; 380 } ipfw_insn_ip; 381 382 /* 383 * This is used to forward to a given address (ip). 384 */ 385 typedef struct _ipfw_insn_sa { 386 ipfw_insn o; 387 struct sockaddr_in sa; 388 } ipfw_insn_sa; 389 390 /* 391 * This is used to forward to a given address (ipv6). 392 */ 393 typedef struct _ipfw_insn_sa6 { 394 ipfw_insn o; 395 struct sockaddr_in6 sa; 396 } ipfw_insn_sa6; 397 398 /* 399 * This is used for MAC addr-mask pairs. 400 */ 401 typedef struct _ipfw_insn_mac { 402 ipfw_insn o; 403 u_char addr[12]; /* dst[6] + src[6] */ 404 u_char mask[12]; /* dst[6] + src[6] */ 405 } ipfw_insn_mac; 406 407 /* 408 * This is used for interface match rules (recv xx, xmit xx). 409 */ 410 typedef struct _ipfw_insn_if { 411 ipfw_insn o; 412 union { 413 struct in_addr ip; 414 int glob; 415 uint16_t kidx; 416 } p; 417 char name[IFNAMSIZ]; 418 } ipfw_insn_if; 419 420 /* 421 * This is used for storing an altq queue id number. 422 */ 423 typedef struct _ipfw_insn_altq { 424 ipfw_insn o; 425 u_int32_t qid; 426 } ipfw_insn_altq; 427 428 /* 429 * This is used for limit rules. 430 */ 431 typedef struct _ipfw_insn_limit { 432 ipfw_insn o; 433 u_int8_t _pad; 434 u_int8_t limit_mask; /* combination of DYN_* below */ 435 #define DYN_SRC_ADDR 0x1 436 #define DYN_SRC_PORT 0x2 437 #define DYN_DST_ADDR 0x4 438 #define DYN_DST_PORT 0x8 439 440 u_int16_t conn_limit; 441 } ipfw_insn_limit; 442 443 /* 444 * This is used for log instructions. 445 */ 446 typedef struct _ipfw_insn_log { 447 ipfw_insn o; 448 u_int32_t max_log; /* how many do we log -- 0 = all */ 449 u_int32_t log_left; /* how many left to log */ 450 } ipfw_insn_log; 451 452 /* Legacy NAT structures, compat only */ 453 #ifndef _KERNEL 454 /* 455 * Data structures required by both ipfw(8) and ipfw(4) but not part of the 456 * management API are protected by IPFW_INTERNAL. 457 */ 458 #ifdef IPFW_INTERNAL 459 /* Server pool support (LSNAT). */ 460 struct cfg_spool { 461 LIST_ENTRY(cfg_spool) _next; /* chain of spool instances */ 462 struct in_addr addr; 463 u_short port; 464 }; 465 #endif 466 467 /* Redirect modes id. */ 468 #define REDIR_ADDR 0x01 469 #define REDIR_PORT 0x02 470 #define REDIR_PROTO 0x04 471 472 #ifdef IPFW_INTERNAL 473 /* Nat redirect configuration. */ 474 struct cfg_redir { 475 LIST_ENTRY(cfg_redir) _next; /* chain of redir instances */ 476 u_int16_t mode; /* type of redirect mode */ 477 struct in_addr laddr; /* local ip address */ 478 struct in_addr paddr; /* public ip address */ 479 struct in_addr raddr; /* remote ip address */ 480 u_short lport; /* local port */ 481 u_short pport; /* public port */ 482 u_short rport; /* remote port */ 483 u_short pport_cnt; /* number of public ports */ 484 u_short rport_cnt; /* number of remote ports */ 485 int proto; /* protocol: tcp/udp */ 486 struct alias_link **alink; 487 /* num of entry in spool chain */ 488 u_int16_t spool_cnt; 489 /* chain of spool instances */ 490 LIST_HEAD(spool_chain, cfg_spool) spool_chain; 491 }; 492 #endif 493 494 #ifdef IPFW_INTERNAL 495 /* Nat configuration data struct. */ 496 struct cfg_nat { 497 /* chain of nat instances */ 498 LIST_ENTRY(cfg_nat) _next; 499 int id; /* nat id */ 500 struct in_addr ip; /* nat ip address */ 501 char if_name[IF_NAMESIZE]; /* interface name */ 502 int mode; /* aliasing mode */ 503 struct libalias *lib; /* libalias instance */ 504 /* number of entry in spool chain */ 505 int redir_cnt; 506 /* chain of redir instances */ 507 LIST_HEAD(redir_chain, cfg_redir) redir_chain; 508 }; 509 #endif 510 511 #define SOF_NAT sizeof(struct cfg_nat) 512 #define SOF_REDIR sizeof(struct cfg_redir) 513 #define SOF_SPOOL sizeof(struct cfg_spool) 514 515 #endif /* ifndef _KERNEL */ 516 517 518 struct nat44_cfg_spool { 519 struct in_addr addr; 520 uint16_t port; 521 uint16_t spare; 522 }; 523 #define NAT44_REDIR_ADDR 0x01 524 #define NAT44_REDIR_PORT 0x02 525 #define NAT44_REDIR_PROTO 0x04 526 527 /* Nat redirect configuration. */ 528 struct nat44_cfg_redir { 529 struct in_addr laddr; /* local ip address */ 530 struct in_addr paddr; /* public ip address */ 531 struct in_addr raddr; /* remote ip address */ 532 uint16_t lport; /* local port */ 533 uint16_t pport; /* public port */ 534 uint16_t rport; /* remote port */ 535 uint16_t pport_cnt; /* number of public ports */ 536 uint16_t rport_cnt; /* number of remote ports */ 537 uint16_t mode; /* type of redirect mode */ 538 uint16_t spool_cnt; /* num of entry in spool chain */ 539 uint16_t spare; 540 uint32_t proto; /* protocol: tcp/udp */ 541 }; 542 543 /* Nat configuration data struct. */ 544 struct nat44_cfg_nat { 545 char name[64]; /* nat name */ 546 char if_name[64]; /* interface name */ 547 uint32_t size; /* structure size incl. redirs */ 548 struct in_addr ip; /* nat IPv4 address */ 549 uint32_t mode; /* aliasing mode */ 550 uint32_t redir_cnt; /* number of entry in spool chain */ 551 }; 552 553 /* Nat command. */ 554 typedef struct _ipfw_insn_nat { 555 ipfw_insn o; 556 struct cfg_nat *nat; 557 } ipfw_insn_nat; 558 559 /* Apply ipv6 mask on ipv6 addr */ 560 #define APPLY_MASK(addr,mask) do { \ 561 (addr)->__u6_addr.__u6_addr32[0] &= (mask)->__u6_addr.__u6_addr32[0]; \ 562 (addr)->__u6_addr.__u6_addr32[1] &= (mask)->__u6_addr.__u6_addr32[1]; \ 563 (addr)->__u6_addr.__u6_addr32[2] &= (mask)->__u6_addr.__u6_addr32[2]; \ 564 (addr)->__u6_addr.__u6_addr32[3] &= (mask)->__u6_addr.__u6_addr32[3]; \ 565 } while (0) 566 567 /* Structure for ipv6 */ 568 typedef struct _ipfw_insn_ip6 { 569 ipfw_insn o; 570 struct in6_addr addr6; 571 struct in6_addr mask6; 572 } ipfw_insn_ip6; 573 574 /* Used to support icmp6 types */ 575 typedef struct _ipfw_insn_icmp6 { 576 ipfw_insn o; 577 uint32_t d[7]; /* XXX This number si related to the netinet/icmp6.h 578 * define ICMP6_MAXTYPE 579 * as follows: n = ICMP6_MAXTYPE/32 + 1 580 * Actually is 203 581 */ 582 } ipfw_insn_icmp6; 583 584 /* 585 * Here we have the structure representing an ipfw rule. 586 * 587 * Layout: 588 * struct ip_fw_rule 589 * [ counter block, size = rule->cntr_len ] 590 * [ one or more instructions, size = rule->cmd_len * 4 ] 591 * 592 * It starts with a general area (with link fields). 593 * Counter block may be next (if rule->cntr_len > 0), 594 * followed by an array of one or more instructions, which the code 595 * accesses as an array of 32-bit values. rule->cmd_len represents 596 * the total instructions legth in u32 worrd, while act_ofs represents 597 * rule action offset in u32 words. 598 * 599 * When assembling instruction, remember the following: 600 * 601 * + if a rule has a "keep-state" (or "limit") option, then the 602 * first instruction (at r->cmd) MUST BE an O_PROBE_STATE 603 * + if a rule has a "log" option, then the first action 604 * (at ACTION_PTR(r)) MUST be O_LOG 605 * + if a rule has an "altq" option, it comes after "log" 606 * + if a rule has an O_TAG option, it comes after "log" and "altq" 607 * 608 * 609 * All structures (excluding instructions) are u64-aligned. 610 * Please keep this. 611 */ 612 613 struct ip_fw_rule { 614 uint16_t act_ofs; /* offset of action in 32-bit units */ 615 uint16_t cmd_len; /* # of 32-bit words in cmd */ 616 uint16_t spare; 617 uint8_t set; /* rule set (0..31) */ 618 uint8_t flags; /* rule flags */ 619 uint32_t rulenum; /* rule number */ 620 uint32_t id; /* rule id */ 621 622 ipfw_insn cmd[1]; /* storage for commands */ 623 }; 624 #define IPFW_RULE_NOOPT 0x01 /* Has no options in body */ 625 #define IPFW_RULE_JUSTOPTS 0x02 /* new format of rule body */ 626 627 /* Unaligned version */ 628 629 /* Base ipfw rule counter block. */ 630 struct ip_fw_bcounter { 631 uint16_t size; /* Size of counter block, bytes */ 632 uint8_t flags; /* flags for given block */ 633 uint8_t spare; 634 uint32_t timestamp; /* tv_sec of last match */ 635 uint64_t pcnt; /* Packet counter */ 636 uint64_t bcnt; /* Byte counter */ 637 }; 638 639 640 #ifndef _KERNEL 641 /* 642 * Legacy rule format 643 */ 644 struct ip_fw { 645 struct ip_fw *x_next; /* linked list of rules */ 646 struct ip_fw *next_rule; /* ptr to next [skipto] rule */ 647 /* 'next_rule' is used to pass up 'set_disable' status */ 648 649 uint16_t act_ofs; /* offset of action in 32-bit units */ 650 uint16_t cmd_len; /* # of 32-bit words in cmd */ 651 uint16_t rulenum; /* rule number */ 652 uint8_t set; /* rule set (0..31) */ 653 uint8_t _pad; /* padding */ 654 uint32_t id; /* rule id */ 655 656 /* These fields are present in all rules. */ 657 uint64_t pcnt; /* Packet counter */ 658 uint64_t bcnt; /* Byte counter */ 659 uint32_t timestamp; /* tv_sec of last match */ 660 661 ipfw_insn cmd[1]; /* storage for commands */ 662 }; 663 #endif 664 665 #define ACTION_PTR(rule) \ 666 (ipfw_insn *)( (u_int32_t *)((rule)->cmd) + ((rule)->act_ofs) ) 667 668 #define RULESIZE(rule) (sizeof(*(rule)) + (rule)->cmd_len * 4 - 4) 669 670 671 #if 1 // should be moved to in.h 672 /* 673 * This structure is used as a flow mask and a flow id for various 674 * parts of the code. 675 * addr_type is used in userland and kernel to mark the address type. 676 * fib is used in the kernel to record the fib in use. 677 * _flags is used in the kernel to store tcp flags for dynamic rules. 678 */ 679 struct ipfw_flow_id { 680 uint32_t dst_ip; 681 uint32_t src_ip; 682 uint16_t dst_port; 683 uint16_t src_port; 684 uint8_t fib; /* XXX: must be uint16_t */ 685 uint8_t proto; 686 uint8_t _flags; /* protocol-specific flags */ 687 uint8_t addr_type; /* 4=ip4, 6=ip6, 1=ether ? */ 688 struct in6_addr dst_ip6; 689 struct in6_addr src_ip6; 690 uint32_t flow_id6; 691 uint32_t extra; /* queue/pipe or frag_id */ 692 }; 693 #endif 694 695 #define IS_IP4_FLOW_ID(id) ((id)->addr_type == 4) 696 #define IS_IP6_FLOW_ID(id) ((id)->addr_type == 6) 697 698 /* 699 * Dynamic ipfw rule. 700 */ 701 typedef struct _ipfw_dyn_rule ipfw_dyn_rule; 702 703 struct _ipfw_dyn_rule { 704 ipfw_dyn_rule *next; /* linked list of rules. */ 705 struct ip_fw *rule; /* pointer to rule */ 706 /* 'rule' is used to pass up the rule number (from the parent) */ 707 708 ipfw_dyn_rule *parent; /* pointer to parent rule */ 709 u_int64_t pcnt; /* packet match counter */ 710 u_int64_t bcnt; /* byte match counter */ 711 struct ipfw_flow_id id; /* (masked) flow id */ 712 u_int32_t expire; /* expire time */ 713 u_int32_t bucket; /* which bucket in hash table */ 714 u_int32_t state; /* state of this rule (typically a 715 * combination of TCP flags) 716 */ 717 #define IPFW_DYN_ORPHANED 0x40000 /* state's parent rule was deleted */ 718 u_int32_t ack_fwd; /* most recent ACKs in forward */ 719 u_int32_t ack_rev; /* and reverse directions (used */ 720 /* to generate keepalives) */ 721 u_int16_t dyn_type; /* rule type */ 722 u_int16_t count; /* refcount */ 723 u_int16_t kidx; /* index of named object */ 724 } __packed __aligned(8); 725 726 /* 727 * Definitions for IP option names. 728 */ 729 #define IP_FW_IPOPT_LSRR 0x01 730 #define IP_FW_IPOPT_SSRR 0x02 731 #define IP_FW_IPOPT_RR 0x04 732 #define IP_FW_IPOPT_TS 0x08 733 734 /* 735 * Definitions for TCP option names. 736 */ 737 #define IP_FW_TCPOPT_MSS 0x01 738 #define IP_FW_TCPOPT_WINDOW 0x02 739 #define IP_FW_TCPOPT_SACK 0x04 740 #define IP_FW_TCPOPT_TS 0x08 741 #define IP_FW_TCPOPT_CC 0x10 742 743 #define ICMP_REJECT_RST 0x100 /* fake ICMP code (send a TCP RST) */ 744 #define ICMP6_UNREACH_RST 0x100 /* fake ICMPv6 code (send a TCP RST) */ 745 #define ICMP_REJECT_ABORT 0x101 /* fake ICMP code (send an SCTP ABORT) */ 746 #define ICMP6_UNREACH_ABORT 0x101 /* fake ICMPv6 code (send an SCTP ABORT) */ 747 748 /* 749 * These are used for lookup tables. 750 */ 751 752 #define IPFW_TABLE_ADDR 1 /* Table for holding IPv4/IPv6 prefixes */ 753 #define IPFW_TABLE_INTERFACE 2 /* Table for holding interface names */ 754 #define IPFW_TABLE_NUMBER 3 /* Table for holding ports/uid/gid/etc */ 755 #define IPFW_TABLE_FLOW 4 /* Table for holding flow data */ 756 #define IPFW_TABLE_MAXTYPE 4 /* Maximum valid number */ 757 758 #define IPFW_TABLE_CIDR IPFW_TABLE_ADDR /* compat */ 759 760 /* Value types */ 761 #define IPFW_VTYPE_LEGACY 0xFFFFFFFF /* All data is filled in */ 762 #define IPFW_VTYPE_SKIPTO 0x00000001 /* skipto/call/callreturn */ 763 #define IPFW_VTYPE_PIPE 0x00000002 /* pipe/queue */ 764 #define IPFW_VTYPE_FIB 0x00000004 /* setfib */ 765 #define IPFW_VTYPE_NAT 0x00000008 /* nat */ 766 #define IPFW_VTYPE_DSCP 0x00000010 /* dscp */ 767 #define IPFW_VTYPE_TAG 0x00000020 /* tag/untag */ 768 #define IPFW_VTYPE_DIVERT 0x00000040 /* divert/tee */ 769 #define IPFW_VTYPE_NETGRAPH 0x00000080 /* netgraph/ngtee */ 770 #define IPFW_VTYPE_LIMIT 0x00000100 /* limit */ 771 #define IPFW_VTYPE_NH4 0x00000200 /* IPv4 nexthop */ 772 #define IPFW_VTYPE_NH6 0x00000400 /* IPv6 nexthop */ 773 774 typedef struct _ipfw_table_entry { 775 in_addr_t addr; /* network address */ 776 u_int32_t value; /* value */ 777 u_int16_t tbl; /* table number */ 778 u_int8_t masklen; /* mask length */ 779 } ipfw_table_entry; 780 781 typedef struct _ipfw_table_xentry { 782 uint16_t len; /* Total entry length */ 783 uint8_t type; /* entry type */ 784 uint8_t masklen; /* mask length */ 785 uint16_t tbl; /* table number */ 786 uint16_t flags; /* record flags */ 787 uint32_t value; /* value */ 788 union { 789 /* Longest field needs to be aligned by 4-byte boundary */ 790 struct in6_addr addr6; /* IPv6 address */ 791 char iface[IF_NAMESIZE]; /* interface name */ 792 } k; 793 } ipfw_table_xentry; 794 #define IPFW_TCF_INET 0x01 /* CIDR flags: IPv4 record */ 795 796 typedef struct _ipfw_table { 797 u_int32_t size; /* size of entries in bytes */ 798 u_int32_t cnt; /* # of entries */ 799 u_int16_t tbl; /* table number */ 800 ipfw_table_entry ent[0]; /* entries */ 801 } ipfw_table; 802 803 typedef struct _ipfw_xtable { 804 ip_fw3_opheader opheader; /* IP_FW3 opcode */ 805 uint32_t size; /* size of entries in bytes */ 806 uint32_t cnt; /* # of entries */ 807 uint16_t tbl; /* table number */ 808 uint8_t type; /* table type */ 809 ipfw_table_xentry xent[0]; /* entries */ 810 } ipfw_xtable; 811 812 typedef struct _ipfw_obj_tlv { 813 uint16_t type; /* TLV type */ 814 uint16_t flags; /* TLV-specific flags */ 815 uint32_t length; /* Total length, aligned to u64 */ 816 } ipfw_obj_tlv; 817 #define IPFW_TLV_TBL_NAME 1 818 #define IPFW_TLV_TBLNAME_LIST 2 819 #define IPFW_TLV_RULE_LIST 3 820 #define IPFW_TLV_DYNSTATE_LIST 4 821 #define IPFW_TLV_TBL_ENT 5 822 #define IPFW_TLV_DYN_ENT 6 823 #define IPFW_TLV_RULE_ENT 7 824 #define IPFW_TLV_TBLENT_LIST 8 825 #define IPFW_TLV_RANGE 9 826 #define IPFW_TLV_EACTION 10 827 #define IPFW_TLV_COUNTERS 11 828 #define IPFW_TLV_OBJDATA 12 829 #define IPFW_TLV_STATE_NAME 14 830 831 #define IPFW_TLV_EACTION_BASE 1000 832 #define IPFW_TLV_EACTION_NAME(arg) (IPFW_TLV_EACTION_BASE + (arg)) 833 834 typedef struct _ipfw_obj_data { 835 ipfw_obj_tlv head; 836 void *data[0]; 837 } ipfw_obj_data; 838 839 /* Object name TLV */ 840 typedef struct _ipfw_obj_ntlv { 841 ipfw_obj_tlv head; /* TLV header */ 842 uint16_t idx; /* Name index */ 843 uint8_t set; /* set, if applicable */ 844 uint8_t type; /* object type, if applicable */ 845 uint32_t spare; /* unused */ 846 char name[64]; /* Null-terminated name */ 847 } ipfw_obj_ntlv; 848 849 /* IPv4/IPv6 L4 flow description */ 850 struct tflow_entry { 851 uint8_t af; 852 uint8_t proto; 853 uint16_t spare; 854 uint16_t sport; 855 uint16_t dport; 856 union { 857 struct { 858 struct in_addr sip; 859 struct in_addr dip; 860 } a4; 861 struct { 862 struct in6_addr sip6; 863 struct in6_addr dip6; 864 } a6; 865 } a; 866 }; 867 868 typedef struct _ipfw_table_value { 869 uint32_t tag; /* O_TAG/O_TAGGED */ 870 uint32_t pipe; /* O_PIPE/O_QUEUE */ 871 uint16_t divert; /* O_DIVERT/O_TEE */ 872 uint16_t skipto; /* skipto, CALLRET */ 873 uint32_t netgraph; /* O_NETGRAPH/O_NGTEE */ 874 uint32_t fib; /* O_SETFIB */ 875 uint32_t nat; /* O_NAT */ 876 uint32_t nh4; 877 uint8_t dscp; 878 uint8_t spare0; 879 uint16_t spare1; 880 struct in6_addr nh6; 881 uint32_t limit; /* O_LIMIT */ 882 uint32_t zoneid; /* scope zone id for nh6 */ 883 uint64_t reserved; 884 } ipfw_table_value; 885 886 /* Table entry TLV */ 887 typedef struct _ipfw_obj_tentry { 888 ipfw_obj_tlv head; /* TLV header */ 889 uint8_t subtype; /* subtype (IPv4,IPv6) */ 890 uint8_t masklen; /* mask length */ 891 uint8_t result; /* request result */ 892 uint8_t spare0; 893 uint16_t idx; /* Table name index */ 894 uint16_t spare1; 895 union { 896 /* Longest field needs to be aligned by 8-byte boundary */ 897 struct in_addr addr; /* IPv4 address */ 898 uint32_t key; /* uid/gid/port */ 899 struct in6_addr addr6; /* IPv6 address */ 900 char iface[IF_NAMESIZE]; /* interface name */ 901 struct tflow_entry flow; 902 } k; 903 union { 904 ipfw_table_value value; /* value data */ 905 uint32_t kidx; /* value kernel index */ 906 } v; 907 } ipfw_obj_tentry; 908 #define IPFW_TF_UPDATE 0x01 /* Update record if exists */ 909 /* Container TLV */ 910 #define IPFW_CTF_ATOMIC 0x01 /* Perform atomic operation */ 911 /* Operation results */ 912 #define IPFW_TR_IGNORED 0 /* Entry was ignored (rollback) */ 913 #define IPFW_TR_ADDED 1 /* Entry was successfully added */ 914 #define IPFW_TR_UPDATED 2 /* Entry was successfully updated*/ 915 #define IPFW_TR_DELETED 3 /* Entry was successfully deleted*/ 916 #define IPFW_TR_LIMIT 4 /* Entry was ignored (limit) */ 917 #define IPFW_TR_NOTFOUND 5 /* Entry was not found */ 918 #define IPFW_TR_EXISTS 6 /* Entry already exists */ 919 #define IPFW_TR_ERROR 7 /* Request has failed (unknown) */ 920 921 typedef struct _ipfw_obj_dyntlv { 922 ipfw_obj_tlv head; 923 ipfw_dyn_rule state; 924 } ipfw_obj_dyntlv; 925 #define IPFW_DF_LAST 0x01 /* Last state in chain */ 926 927 /* Containter TLVs */ 928 typedef struct _ipfw_obj_ctlv { 929 ipfw_obj_tlv head; /* TLV header */ 930 uint32_t count; /* Number of sub-TLVs */ 931 uint16_t objsize; /* Single object size */ 932 uint8_t version; /* TLV version */ 933 uint8_t flags; /* TLV-specific flags */ 934 } ipfw_obj_ctlv; 935 936 /* Range TLV */ 937 typedef struct _ipfw_range_tlv { 938 ipfw_obj_tlv head; /* TLV header */ 939 uint32_t flags; /* Range flags */ 940 uint16_t start_rule; /* Range start */ 941 uint16_t end_rule; /* Range end */ 942 uint32_t set; /* Range set to match */ 943 uint32_t new_set; /* New set to move/swap to */ 944 } ipfw_range_tlv; 945 #define IPFW_RCFLAG_RANGE 0x01 /* rule range is set */ 946 #define IPFW_RCFLAG_ALL 0x02 /* match ALL rules */ 947 #define IPFW_RCFLAG_SET 0x04 /* match rules in given set */ 948 #define IPFW_RCFLAG_DYNAMIC 0x08 /* match only dynamic states */ 949 /* User-settable flags */ 950 #define IPFW_RCFLAG_USER (IPFW_RCFLAG_RANGE | IPFW_RCFLAG_ALL | \ 951 IPFW_RCFLAG_SET | IPFW_RCFLAG_DYNAMIC) 952 /* Internally used flags */ 953 #define IPFW_RCFLAG_DEFAULT 0x0100 /* Do not skip defaul rule */ 954 955 typedef struct _ipfw_ta_tinfo { 956 uint32_t flags; /* Format flags */ 957 uint32_t spare; 958 uint8_t taclass4; /* algorithm class */ 959 uint8_t spare4; 960 uint16_t itemsize4; /* item size in runtime */ 961 uint32_t size4; /* runtime structure size */ 962 uint32_t count4; /* number of items in runtime */ 963 uint8_t taclass6; /* algorithm class */ 964 uint8_t spare6; 965 uint16_t itemsize6; /* item size in runtime */ 966 uint32_t size6; /* runtime structure size */ 967 uint32_t count6; /* number of items in runtime */ 968 } ipfw_ta_tinfo; 969 #define IPFW_TACLASS_HASH 1 /* algo is based on hash */ 970 #define IPFW_TACLASS_ARRAY 2 /* algo is based on array */ 971 #define IPFW_TACLASS_RADIX 3 /* algo is based on radix tree */ 972 973 #define IPFW_TATFLAGS_DATA 0x0001 /* Has data filled in */ 974 #define IPFW_TATFLAGS_AFDATA 0x0002 /* Separate data per AF */ 975 #define IPFW_TATFLAGS_AFITEM 0x0004 /* diff. items per AF */ 976 977 typedef struct _ipfw_xtable_info { 978 uint8_t type; /* table type (addr,iface,..) */ 979 uint8_t tflags; /* type flags */ 980 uint16_t mflags; /* modification flags */ 981 uint16_t flags; /* generic table flags */ 982 uint16_t spare[3]; 983 uint32_t vmask; /* bitmask with value types */ 984 uint32_t set; /* set table is in */ 985 uint32_t kidx; /* kernel index */ 986 uint32_t refcnt; /* number of references */ 987 uint32_t count; /* Number of records */ 988 uint32_t size; /* Total size of records(export)*/ 989 uint32_t limit; /* Max number of records */ 990 char tablename[64]; /* table name */ 991 char algoname[64]; /* algorithm name */ 992 ipfw_ta_tinfo ta_info; /* additional algo stats */ 993 } ipfw_xtable_info; 994 /* Generic table flags */ 995 #define IPFW_TGFLAGS_LOCKED 0x01 /* Tables is locked from changes*/ 996 /* Table type-specific flags */ 997 #define IPFW_TFFLAG_SRCIP 0x01 998 #define IPFW_TFFLAG_DSTIP 0x02 999 #define IPFW_TFFLAG_SRCPORT 0x04 1000 #define IPFW_TFFLAG_DSTPORT 0x08 1001 #define IPFW_TFFLAG_PROTO 0x10 1002 /* Table modification flags */ 1003 #define IPFW_TMFLAGS_LIMIT 0x0002 /* Change limit value */ 1004 #define IPFW_TMFLAGS_LOCK 0x0004 /* Change table lock state */ 1005 1006 typedef struct _ipfw_iface_info { 1007 char ifname[64]; /* interface name */ 1008 uint32_t ifindex; /* interface index */ 1009 uint32_t flags; /* flags */ 1010 uint32_t refcnt; /* number of references */ 1011 uint32_t gencnt; /* number of changes */ 1012 uint64_t spare; 1013 } ipfw_iface_info; 1014 #define IPFW_IFFLAG_RESOLVED 0x01 /* Interface exists */ 1015 1016 typedef struct _ipfw_ta_info { 1017 char algoname[64]; /* algorithm name */ 1018 uint32_t type; /* lookup type */ 1019 uint32_t flags; 1020 uint32_t refcnt; 1021 uint32_t spare0; 1022 uint64_t spare1; 1023 } ipfw_ta_info; 1024 1025 typedef struct _ipfw_obj_header { 1026 ip_fw3_opheader opheader; /* IP_FW3 opcode */ 1027 uint32_t spare; 1028 uint16_t idx; /* object name index */ 1029 uint8_t objtype; /* object type */ 1030 uint8_t objsubtype; /* object subtype */ 1031 ipfw_obj_ntlv ntlv; /* object name tlv */ 1032 } ipfw_obj_header; 1033 1034 typedef struct _ipfw_obj_lheader { 1035 ip_fw3_opheader opheader; /* IP_FW3 opcode */ 1036 uint32_t set_mask; /* disabled set mask */ 1037 uint32_t count; /* Total objects count */ 1038 uint32_t size; /* Total size (incl. header) */ 1039 uint32_t objsize; /* Size of one object */ 1040 } ipfw_obj_lheader; 1041 1042 #define IPFW_CFG_GET_STATIC 0x01 1043 #define IPFW_CFG_GET_STATES 0x02 1044 #define IPFW_CFG_GET_COUNTERS 0x04 1045 typedef struct _ipfw_cfg_lheader { 1046 ip_fw3_opheader opheader; /* IP_FW3 opcode */ 1047 uint32_t set_mask; /* enabled set mask */ 1048 uint32_t spare; 1049 uint32_t flags; /* Request flags */ 1050 uint32_t size; /* neded buffer size */ 1051 uint32_t start_rule; 1052 uint32_t end_rule; 1053 } ipfw_cfg_lheader; 1054 1055 typedef struct _ipfw_range_header { 1056 ip_fw3_opheader opheader; /* IP_FW3 opcode */ 1057 ipfw_range_tlv range; 1058 } ipfw_range_header; 1059 1060 typedef struct _ipfw_sopt_info { 1061 uint16_t opcode; 1062 uint8_t version; 1063 uint8_t dir; 1064 uint8_t spare; 1065 uint64_t refcnt; 1066 } ipfw_sopt_info; 1067 1068 #endif /* _IPFW2_H */ 1069