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