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