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