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