2 * Copyright (c) 2002-2003 Luigi Rizzo
3 * Copyright (c) 1996 Alex Nash, Paul Traina, Poul-Henning Kamp
4 * Copyright (c) 1994 Ugen J.S.Antsilevich
6 * Idea and grammar partially left from:
7 * Copyright (c) 1993 Daniel Boulet
9 * Redistribution and use in source forms, with and without modification,
10 * are permitted provided that this entire comment appears intact.
12 * Redistribution in binary form may occur without any restrictions.
13 * Obviously, it would be nice if you gave credit where credit is due
14 * but requiring it would be too onerous.
16 * This software is provided ``AS IS'' without any warranties of any kind.
18 * NEW command line interface for IP firewall facility
23 #include <sys/types.h>
24 #include <sys/param.h>
25 #include <sys/socket.h>
26 #include <sys/sockio.h>
27 #include <sys/sysctl.h>
42 #include <time.h> /* ctime */
43 #include <timeconv.h> /* _long_to_time */
46 #include <stddef.h> /* offsetof */
48 #include <net/ethernet.h>
49 #include <net/if.h> /* only IFNAMSIZ */
50 #include <netinet/in.h>
51 #include <netinet/in_systm.h> /* only n_short, n_long */
52 #include <netinet/ip.h>
53 #include <netinet/ip_icmp.h>
54 #include <netinet/ip_fw.h>
55 #include <netinet/tcp.h>
56 #include <arpa/inet.h>
58 struct cmdline_opts co; /* global options */
64 int show_time; /* show timestamp */
65 uint32_t set_mask; /* enabled sets mask */
66 uint32_t flags; /* request flags */
67 uint32_t first; /* first rule to request */
68 uint32_t last; /* last rule to request */
69 uint32_t dcnt; /* number of dynamic states */
70 ipfw_obj_ctlv *tstate; /* table state data */
73 int resvd_set_number = RESVD_SET;
77 #define CHECK_LENGTH(v, len) do { \
79 errx(EX_DATAERR, "Rule too long"); \
82 * Check if we have enough space in cmd buffer. Note that since
83 * first 8? u32 words are reserved by reserved header, full cmd
84 * buffer can't be used, so we need to protect from buffer overrun
85 * only. At the beginning, cblen is less than actual buffer size by
86 * size of ipfw_insn_u32 instruction + 1 u32 work. This eliminates need
87 * for checking small instructions fitting in given range.
88 * We also (ab)use the fact that ipfw_insn is always the first field
89 * for any custom instruction.
91 #define CHECK_CMDLEN CHECK_LENGTH(cblen, F_LEN((ipfw_insn *)cmd))
93 #define GET_UINT_ARG(arg, min, max, tok, s_x) do { \
95 errx(EX_USAGE, "%s: missing argument", match_value(s_x, tok)); \
96 if (_substrcmp(*av, "tablearg") == 0) { \
105 _xval = strtol(*av, &end, 10); \
107 if (!isdigit(**av) || *end != '\0' || (_xval == 0 && errno == EINVAL)) \
108 errx(EX_DATAERR, "%s: invalid argument: %s", \
109 match_value(s_x, tok), *av); \
111 if (errno == ERANGE || _xval < min || _xval > max) \
112 errx(EX_DATAERR, "%s: argument is out of range (%u..%u): %s", \
113 match_value(s_x, tok), min, max, *av); \
115 if (_xval == IP_FW_TARG) \
116 errx(EX_DATAERR, "%s: illegal argument value: %s", \
117 match_value(s_x, tok), *av); \
122 static struct _s_x f_tcpflags[] = {
133 static struct _s_x f_tcpopts[] = {
134 { "mss", IP_FW_TCPOPT_MSS },
135 { "maxseg", IP_FW_TCPOPT_MSS },
136 { "window", IP_FW_TCPOPT_WINDOW },
137 { "sack", IP_FW_TCPOPT_SACK },
138 { "ts", IP_FW_TCPOPT_TS },
139 { "timestamp", IP_FW_TCPOPT_TS },
140 { "cc", IP_FW_TCPOPT_CC },
146 * IP options span the range 0 to 255 so we need to remap them
147 * (though in fact only the low 5 bits are significant).
149 static struct _s_x f_ipopts[] = {
150 { "ssrr", IP_FW_IPOPT_SSRR},
151 { "lsrr", IP_FW_IPOPT_LSRR},
152 { "rr", IP_FW_IPOPT_RR},
153 { "ts", IP_FW_IPOPT_TS},
158 static struct _s_x f_iptos[] = {
159 { "lowdelay", IPTOS_LOWDELAY},
160 { "throughput", IPTOS_THROUGHPUT},
161 { "reliability", IPTOS_RELIABILITY},
162 { "mincost", IPTOS_MINCOST},
163 { "congestion", IPTOS_ECN_CE},
164 { "ecntransport", IPTOS_ECN_ECT0},
165 { "ip tos option", 0},
169 struct _s_x f_ipdscp[] = {
170 { "af11", IPTOS_DSCP_AF11 >> 2 }, /* 001010 */
171 { "af12", IPTOS_DSCP_AF12 >> 2 }, /* 001100 */
172 { "af13", IPTOS_DSCP_AF13 >> 2 }, /* 001110 */
173 { "af21", IPTOS_DSCP_AF21 >> 2 }, /* 010010 */
174 { "af22", IPTOS_DSCP_AF22 >> 2 }, /* 010100 */
175 { "af23", IPTOS_DSCP_AF23 >> 2 }, /* 010110 */
176 { "af31", IPTOS_DSCP_AF31 >> 2 }, /* 011010 */
177 { "af32", IPTOS_DSCP_AF32 >> 2 }, /* 011100 */
178 { "af33", IPTOS_DSCP_AF33 >> 2 }, /* 011110 */
179 { "af41", IPTOS_DSCP_AF41 >> 2 }, /* 100010 */
180 { "af42", IPTOS_DSCP_AF42 >> 2 }, /* 100100 */
181 { "af43", IPTOS_DSCP_AF43 >> 2 }, /* 100110 */
182 { "be", IPTOS_DSCP_CS0 >> 2 }, /* 000000 */
183 { "ef", IPTOS_DSCP_EF >> 2 }, /* 101110 */
184 { "cs0", IPTOS_DSCP_CS0 >> 2 }, /* 000000 */
185 { "cs1", IPTOS_DSCP_CS1 >> 2 }, /* 001000 */
186 { "cs2", IPTOS_DSCP_CS2 >> 2 }, /* 010000 */
187 { "cs3", IPTOS_DSCP_CS3 >> 2 }, /* 011000 */
188 { "cs4", IPTOS_DSCP_CS4 >> 2 }, /* 100000 */
189 { "cs5", IPTOS_DSCP_CS5 >> 2 }, /* 101000 */
190 { "cs6", IPTOS_DSCP_CS6 >> 2 }, /* 110000 */
191 { "cs7", IPTOS_DSCP_CS7 >> 2 }, /* 100000 */
195 static struct _s_x limit_masks[] = {
196 {"all", DYN_SRC_ADDR|DYN_SRC_PORT|DYN_DST_ADDR|DYN_DST_PORT},
197 {"src-addr", DYN_SRC_ADDR},
198 {"src-port", DYN_SRC_PORT},
199 {"dst-addr", DYN_DST_ADDR},
200 {"dst-port", DYN_DST_PORT},
205 * we use IPPROTO_ETHERTYPE as a fake protocol id to call the print routines
206 * This is only used in this code.
208 #define IPPROTO_ETHERTYPE 0x1000
209 static struct _s_x ether_types[] = {
211 * Note, we cannot use "-:&/" in the names because they are field
212 * separators in the type specifications. Also, we use s = NULL as
213 * end-delimiter, because a type of 0 can be legal.
226 { "pppoe_disc", 0x8863 },
227 { "pppoe_sess", 0x8864 },
228 { "ipx_8022", 0x00E0 },
229 { "ipx_8023", 0x0000 },
230 { "ipx_ii", 0x8137 },
231 { "ipx_snap", 0x8137 },
237 static struct _s_x rule_eactions[] = {
238 { "nat64lsn", TOK_NAT64LSN },
239 { "nat64stl", TOK_NAT64STL },
240 { "nptv6", TOK_NPTV6 },
241 { NULL, 0 } /* terminator */
244 static struct _s_x rule_actions[] = {
245 { "accept", TOK_ACCEPT },
246 { "pass", TOK_ACCEPT },
247 { "allow", TOK_ACCEPT },
248 { "permit", TOK_ACCEPT },
249 { "count", TOK_COUNT },
250 { "pipe", TOK_PIPE },
251 { "queue", TOK_QUEUE },
252 { "divert", TOK_DIVERT },
254 { "netgraph", TOK_NETGRAPH },
255 { "ngtee", TOK_NGTEE },
256 { "fwd", TOK_FORWARD },
257 { "forward", TOK_FORWARD },
258 { "skipto", TOK_SKIPTO },
259 { "deny", TOK_DENY },
260 { "drop", TOK_DENY },
261 { "reject", TOK_REJECT },
262 { "reset6", TOK_RESET6 },
263 { "reset", TOK_RESET },
264 { "unreach6", TOK_UNREACH6 },
265 { "unreach", TOK_UNREACH },
266 { "check-state", TOK_CHECKSTATE },
267 { "//", TOK_COMMENT },
269 { "reass", TOK_REASS },
270 { "setfib", TOK_SETFIB },
271 { "setdscp", TOK_SETDSCP },
272 { "call", TOK_CALL },
273 { "return", TOK_RETURN },
274 { "eaction", TOK_EACTION },
275 { NULL, 0 } /* terminator */
278 static struct _s_x rule_action_params[] = {
279 { "altq", TOK_ALTQ },
282 { "untag", TOK_UNTAG },
283 { NULL, 0 } /* terminator */
287 * The 'lookup' instruction accepts one of the following arguments.
288 * -1 is a terminator for the list.
289 * Arguments are passed as v[1] in O_DST_LOOKUP options.
291 static int lookup_key[] = {
292 TOK_DSTIP, TOK_SRCIP, TOK_DSTPORT, TOK_SRCPORT,
293 TOK_UID, TOK_JAIL, TOK_DSCP, -1 };
295 static struct _s_x rule_options[] = {
296 { "tagged", TOK_TAGGED },
299 { "jail", TOK_JAIL },
301 { "limit", TOK_LIMIT },
302 { "keep-state", TOK_KEEPSTATE },
303 { "bridged", TOK_LAYER2 },
304 { "layer2", TOK_LAYER2 },
306 { "diverted", TOK_DIVERTED },
307 { "diverted-loopback", TOK_DIVERTEDLOOPBACK },
308 { "diverted-output", TOK_DIVERTEDOUTPUT },
309 { "xmit", TOK_XMIT },
310 { "recv", TOK_RECV },
312 { "fragment", TOK_FRAG },
313 { "frag", TOK_FRAG },
315 { "ipoptions", TOK_IPOPTS },
316 { "ipopts", TOK_IPOPTS },
317 { "iplen", TOK_IPLEN },
318 { "ipid", TOK_IPID },
319 { "ipprecedence", TOK_IPPRECEDENCE },
320 { "dscp", TOK_DSCP },
321 { "iptos", TOK_IPTOS },
322 { "ipttl", TOK_IPTTL },
323 { "ipversion", TOK_IPVER },
324 { "ipver", TOK_IPVER },
325 { "estab", TOK_ESTAB },
326 { "established", TOK_ESTAB },
327 { "setup", TOK_SETUP },
328 { "sockarg", TOK_SOCKARG },
329 { "tcpdatalen", TOK_TCPDATALEN },
330 { "tcpflags", TOK_TCPFLAGS },
331 { "tcpflgs", TOK_TCPFLAGS },
332 { "tcpoptions", TOK_TCPOPTS },
333 { "tcpopts", TOK_TCPOPTS },
334 { "tcpseq", TOK_TCPSEQ },
335 { "tcpack", TOK_TCPACK },
336 { "tcpwin", TOK_TCPWIN },
337 { "icmptype", TOK_ICMPTYPES },
338 { "icmptypes", TOK_ICMPTYPES },
339 { "dst-ip", TOK_DSTIP },
340 { "src-ip", TOK_SRCIP },
341 { "dst-port", TOK_DSTPORT },
342 { "src-port", TOK_SRCPORT },
343 { "proto", TOK_PROTO },
346 { "mac-type", TOK_MACTYPE },
347 { "verrevpath", TOK_VERREVPATH },
348 { "versrcreach", TOK_VERSRCREACH },
349 { "antispoof", TOK_ANTISPOOF },
350 { "ipsec", TOK_IPSEC },
351 { "icmp6type", TOK_ICMP6TYPES },
352 { "icmp6types", TOK_ICMP6TYPES },
353 { "ext6hdr", TOK_EXT6HDR},
354 { "flow-id", TOK_FLOWID},
359 { "dst-ipv6", TOK_DSTIP6},
360 { "dst-ip6", TOK_DSTIP6},
361 { "src-ipv6", TOK_SRCIP6},
362 { "src-ip6", TOK_SRCIP6},
363 { "lookup", TOK_LOOKUP},
365 { "//", TOK_COMMENT },
367 { "not", TOK_NOT }, /* pseudo option */
368 { "!", /* escape ? */ TOK_NOT }, /* pseudo option */
369 { "or", TOK_OR }, /* pseudo option */
370 { "|", /* escape */ TOK_OR }, /* pseudo option */
371 { "{", TOK_STARTBRACE }, /* pseudo option */
372 { "(", TOK_STARTBRACE }, /* pseudo option */
373 { "}", TOK_ENDBRACE }, /* pseudo option */
374 { ")", TOK_ENDBRACE }, /* pseudo option */
375 { NULL, 0 } /* terminator */
378 void bprint_uint_arg(struct buf_pr *bp, const char *str, uint32_t arg);
379 static int ipfw_get_config(struct cmdline_opts *co, struct format_opts *fo,
380 ipfw_cfg_lheader **pcfg, size_t *psize);
381 static int ipfw_show_config(struct cmdline_opts *co, struct format_opts *fo,
382 ipfw_cfg_lheader *cfg, size_t sz, int ac, char **av);
383 static void ipfw_list_tifaces(void);
386 static uint16_t pack_object(struct tidx *tstate, char *name, int otype);
387 static uint16_t pack_table(struct tidx *tstate, char *name);
389 static char *table_search_ctlv(ipfw_obj_ctlv *ctlv, uint16_t idx);
390 static void object_sort_ctlv(ipfw_obj_ctlv *ctlv);
391 static char *object_search_ctlv(ipfw_obj_ctlv *ctlv, uint16_t idx,
395 * Simple string buffer API.
396 * Used to simplify buffer passing between function and for
397 * transparent overrun handling.
401 * Allocates new buffer of given size @sz.
403 * Returns 0 on success.
406 bp_alloc(struct buf_pr *b, size_t size)
408 memset(b, 0, sizeof(struct buf_pr));
410 if ((b->buf = calloc(1, size)) == NULL)
421 bp_free(struct buf_pr *b)
428 * Flushes buffer so new writer start from beginning.
431 bp_flush(struct buf_pr *b)
440 * Print message specified by @format and args.
441 * Automatically manage buffer space and transparently handle
444 * Returns number of bytes that should have been printed.
447 bprintf(struct buf_pr *b, char *format, ...)
452 va_start(args, format);
454 i = vsnprintf(b->ptr, b->avail, format, args);
457 if (i > b->avail || i < 0) {
458 /* Overflow or print error */
471 * Special values printer for tablearg-aware opcodes.
474 bprint_uint_arg(struct buf_pr *bp, const char *str, uint32_t arg)
478 bprintf(bp, "%s", str);
479 if (arg == IP_FW_TARG)
480 bprintf(bp, "tablearg");
482 bprintf(bp, "%u", arg);
486 * Helper routine to print a possibly unaligned uint64_t on
487 * various platform. If width > 0, print the value with
488 * the desired width, followed by a space;
489 * otherwise, return the required width.
492 pr_u64(struct buf_pr *b, uint64_t *pd, int width)
495 #define U64_FMT "I64"
497 #define U64_FMT "llu"
500 unsigned long long d;
502 bcopy (pd, &u, sizeof(u));
505 bprintf(b, "%*" U64_FMT " ", width, d) :
506 snprintf(NULL, 0, "%" U64_FMT, d) ;
512 safe_calloc(size_t number, size_t size)
514 void *ret = calloc(number, size);
517 err(EX_OSERR, "calloc");
522 safe_realloc(void *ptr, size_t size)
524 void *ret = realloc(ptr, size);
527 err(EX_OSERR, "realloc");
532 * Compare things like interface or table names.
535 stringnum_cmp(const char *a, const char *b)
547 return (strcmp(a, b));
552 * conditionally runs the command.
553 * Selected options or negative -> getsockopt
556 do_cmd(int optname, void *optval, uintptr_t optlen)
563 if (ipfw_socket == -1)
564 ipfw_socket = socket(AF_INET, SOCK_RAW, IPPROTO_RAW);
566 err(EX_UNAVAILABLE, "socket");
568 if (optname == IP_FW_GET || optname == IP_DUMMYNET_GET ||
569 optname == IP_FW_ADD || optname == IP_FW3 ||
570 optname == IP_FW_NAT_GET_CONFIG ||
572 optname == IP_FW_NAT_GET_LOG) {
575 i = getsockopt(ipfw_socket, IPPROTO_IP, optname, optval,
576 (socklen_t *)optlen);
578 i = setsockopt(ipfw_socket, IPPROTO_IP, optname, optval, optlen);
584 * do_set3 - pass ipfw control cmd to kernel
585 * @optname: option name
586 * @optval: pointer to option data
587 * @optlen: option length
589 * Assumes op3 header is already embedded.
590 * Calls setsockopt() with IP_FW3 as kernel-visible opcode.
591 * Returns 0 on success or errno otherwise.
594 do_set3(int optname, ip_fw3_opheader *op3, size_t optlen)
600 if (ipfw_socket == -1)
601 ipfw_socket = socket(AF_INET, SOCK_RAW, IPPROTO_RAW);
603 err(EX_UNAVAILABLE, "socket");
605 op3->opcode = optname;
607 return (setsockopt(ipfw_socket, IPPROTO_IP, IP_FW3, op3, optlen));
611 * do_get3 - pass ipfw control cmd to kernel
612 * @optname: option name
613 * @optval: pointer to option data
614 * @optlen: pointer to option length
616 * Assumes op3 header is already embedded.
617 * Calls getsockopt() with IP_FW3 as kernel-visible opcode.
618 * Returns 0 on success or errno otherwise.
621 do_get3(int optname, ip_fw3_opheader *op3, size_t *optlen)
629 if (ipfw_socket == -1)
630 ipfw_socket = socket(AF_INET, SOCK_RAW, IPPROTO_RAW);
632 err(EX_UNAVAILABLE, "socket");
634 op3->opcode = optname;
637 error = getsockopt(ipfw_socket, IPPROTO_IP, IP_FW3, op3, &len);
644 * match_token takes a table and a string, returns the value associated
645 * with the string (-1 in case of failure).
648 match_token(struct _s_x *table, const char *string)
651 uint i = strlen(string);
653 for (pt = table ; i && pt->s != NULL ; pt++)
654 if (strlen(pt->s) == i && !bcmp(string, pt->s, i))
660 * match_token_relaxed takes a table and a string, returns the value associated
661 * with the string for the best match.
664 * value from @table for matched records
665 * -1 for non-matched records
666 * -2 if more than one records match @string.
669 match_token_relaxed(struct _s_x *table, const char *string)
677 for (pt = table ; i != 0 && pt->s != NULL ; pt++) {
678 if (strncmp(pt->s, string, i) != 0)
687 return (c > 0 ? -2: -1);
691 get_token(struct _s_x *table, const char *string, const char *errbase)
695 if ((tcmd = match_token_relaxed(table, string)) < 0)
696 errx(EX_USAGE, "%s %s %s",
697 (tcmd == 0) ? "invalid" : "ambiguous", errbase, string);
703 * match_value takes a table and a value, returns the string associated
704 * with the value (NULL in case of failure).
707 match_value(struct _s_x *p, int value)
709 for (; p->s != NULL; p++)
716 concat_tokens(char *buf, size_t bufsize, struct _s_x *table, char *delimiter)
722 for (sz = 0, pt = table ; pt->s != NULL; pt++) {
723 l = snprintf(buf + sz, bufsize - sz, "%s%s",
724 (sz == 0) ? "" : delimiter, pt->s);
735 * helper function to process a set of flags and set bits in the
739 fill_flags(struct _s_x *flags, char *p, char **e, uint32_t *set,
742 char *q; /* points to the separator */
744 uint32_t *which; /* mask we are working on */
755 val = match_token(flags, p);
761 *which |= (uint32_t)val;
768 print_flags_buffer(char *buf, size_t sz, struct _s_x *list, uint32_t set)
770 char const *comma = "";
773 for (i = 0; list[i].x != 0; i++) {
774 if ((set & list[i].x) == 0)
778 l = snprintf(buf, sz, "%s%s", comma, list[i].s);
788 * _substrcmp takes two strings and returns 1 if they do not match,
789 * and 0 if they match exactly or the first string is a sub-string
790 * of the second. A warning is printed to stderr in the case that the
791 * first string is a sub-string of the second.
793 * This function will be removed in the future through the usual
794 * deprecation process.
797 _substrcmp(const char *str1, const char* str2)
800 if (strncmp(str1, str2, strlen(str1)) != 0)
803 if (strlen(str1) != strlen(str2))
804 warnx("DEPRECATED: '%s' matched '%s' as a sub-string",
810 * _substrcmp2 takes three strings and returns 1 if the first two do not match,
811 * and 0 if they match exactly or the second string is a sub-string
812 * of the first. A warning is printed to stderr in the case that the
813 * first string does not match the third.
815 * This function exists to warn about the bizarre construction
816 * strncmp(str, "by", 2) which is used to allow people to use a shortcut
817 * for "bytes". The problem is that in addition to accepting "by",
818 * "byt", "byte", and "bytes", it also excepts "by_rabid_dogs" and any
819 * other string beginning with "by".
821 * This function will be removed in the future through the usual
822 * deprecation process.
825 _substrcmp2(const char *str1, const char* str2, const char* str3)
828 if (strncmp(str1, str2, strlen(str2)) != 0)
831 if (strcmp(str1, str3) != 0)
832 warnx("DEPRECATED: '%s' matched '%s'",
838 * prints one port, symbolic or numeric
841 print_port(struct buf_pr *bp, int proto, uint16_t port)
844 if (proto == IPPROTO_ETHERTYPE) {
847 if (co.do_resolv && (s = match_value(ether_types, port)) )
848 bprintf(bp, "%s", s);
850 bprintf(bp, "0x%04x", port);
852 struct servent *se = NULL;
854 struct protoent *pe = getprotobynumber(proto);
856 se = getservbyport(htons(port), pe ? pe->p_name : NULL);
859 bprintf(bp, "%s", se->s_name);
861 bprintf(bp, "%d", port);
865 static struct _s_x _port_name[] = {
866 {"dst-port", O_IP_DSTPORT},
867 {"src-port", O_IP_SRCPORT},
871 {"mac-type", O_MAC_TYPE},
872 {"tcpdatalen", O_TCPDATALEN},
873 {"tcpwin", O_TCPWIN},
874 {"tagged", O_TAGGED},
879 * Print the values in a list 16-bit items of the types above.
880 * XXX todo: add support for mask.
883 print_newports(struct buf_pr *bp, ipfw_insn_u16 *cmd, int proto, int opcode)
885 uint16_t *p = cmd->ports;
890 sep = match_value(_port_name, opcode);
893 bprintf(bp, " %s", sep);
896 for (i = F_LEN((ipfw_insn *)cmd) - 1; i > 0; i--, p += 2) {
897 bprintf(bp, "%s", sep);
898 print_port(bp, proto, p[0]);
901 print_port(bp, proto, p[1]);
908 * Like strtol, but also translates service names into port numbers
909 * for some protocols.
911 * proto == -1 disables the protocol check;
912 * proto == IPPROTO_ETHERTYPE looks up an internal table
913 * proto == <some value in /etc/protocols> matches the values there.
914 * Returns *end == s in case the parameter is not found.
917 strtoport(char *s, char **end, int base, int proto)
923 *end = s; /* default - not found */
925 return 0; /* not found */
928 return strtol(s, end, base);
931 * find separator. '\\' escapes the next char.
933 for (s1 = s; *s1 && (isalnum(*s1) || *s1 == '\\') ; s1++)
934 if (*s1 == '\\' && s1[1] != '\0')
937 buf = safe_calloc(s1 - s + 1, 1);
940 * copy into a buffer skipping backslashes
942 for (p = s, i = 0; p != s1 ; p++)
947 if (proto == IPPROTO_ETHERTYPE) {
948 i = match_token(ether_types, buf);
950 if (i != -1) { /* found */
955 struct protoent *pe = NULL;
959 pe = getprotobynumber(proto);
961 se = getservbyname(buf, pe ? pe->p_name : NULL);
965 return ntohs(se->s_port);
968 return 0; /* not found */
972 * Fill the body of the command with the list of port ranges.
975 fill_newports(ipfw_insn_u16 *cmd, char *av, int proto, int cblen)
977 uint16_t a, b, *p = cmd->ports;
982 a = strtoport(av, &s, 0, proto);
983 if (s == av) /* empty or invalid argument */
986 CHECK_LENGTH(cblen, i + 2);
989 case '-': /* a range */
991 b = strtoport(av, &s, 0, proto);
992 /* Reject expressions like '1-abc' or '1-2-3'. */
993 if (s == av || (*s != ',' && *s != '\0'))
998 case ',': /* comma separated list */
1003 warnx("port list: invalid separator <%c> in <%s>",
1013 if (i + 1 > F_LEN_MASK)
1014 errx(EX_DATAERR, "too many ports/ranges\n");
1015 cmd->o.len |= i + 1; /* leave F_NOT and F_OR untouched */
1021 * Fill the body of the command with the list of DiffServ codepoints.
1024 fill_dscp(ipfw_insn *cmd, char *av, int cblen)
1026 uint32_t *low, *high;
1030 cmd->opcode = O_DSCP;
1031 cmd->len |= F_INSN_SIZE(ipfw_insn_u32) + 1;
1035 low = (uint32_t *)(cmd + 1);
1048 if ((code = match_token(f_ipdscp, s)) == -1)
1049 errx(EX_DATAERR, "Unknown DSCP code");
1051 code = strtoul(s, NULL, 10);
1052 if (code < 0 || code > 63)
1053 errx(EX_DATAERR, "Invalid DSCP value");
1057 *high |= 1 << (code - 32);
1065 static struct _s_x icmpcodes[] = {
1066 { "net", ICMP_UNREACH_NET },
1067 { "host", ICMP_UNREACH_HOST },
1068 { "protocol", ICMP_UNREACH_PROTOCOL },
1069 { "port", ICMP_UNREACH_PORT },
1070 { "needfrag", ICMP_UNREACH_NEEDFRAG },
1071 { "srcfail", ICMP_UNREACH_SRCFAIL },
1072 { "net-unknown", ICMP_UNREACH_NET_UNKNOWN },
1073 { "host-unknown", ICMP_UNREACH_HOST_UNKNOWN },
1074 { "isolated", ICMP_UNREACH_ISOLATED },
1075 { "net-prohib", ICMP_UNREACH_NET_PROHIB },
1076 { "host-prohib", ICMP_UNREACH_HOST_PROHIB },
1077 { "tosnet", ICMP_UNREACH_TOSNET },
1078 { "toshost", ICMP_UNREACH_TOSHOST },
1079 { "filter-prohib", ICMP_UNREACH_FILTER_PROHIB },
1080 { "host-precedence", ICMP_UNREACH_HOST_PRECEDENCE },
1081 { "precedence-cutoff", ICMP_UNREACH_PRECEDENCE_CUTOFF },
1086 fill_reject_code(u_short *codep, char *str)
1091 val = strtoul(str, &s, 0);
1092 if (s == str || *s != '\0' || val >= 0x100)
1093 val = match_token(icmpcodes, str);
1095 errx(EX_DATAERR, "unknown ICMP unreachable code ``%s''", str);
1101 print_reject_code(struct buf_pr *bp, uint16_t code)
1105 if ((s = match_value(icmpcodes, code)) != NULL)
1106 bprintf(bp, "unreach %s", s);
1108 bprintf(bp, "unreach %u", code);
1112 * Returns the number of bits set (from left) in a contiguous bitmask,
1113 * or -1 if the mask is not contiguous.
1114 * XXX this needs a proper fix.
1115 * This effectively works on masks in big-endian (network) format.
1116 * when compiled on little endian architectures.
1118 * First bit is bit 7 of the first byte -- note, for MAC addresses,
1119 * the first bit on the wire is bit 0 of the first byte.
1120 * len is the max length in bits.
1123 contigmask(uint8_t *p, int len)
1127 for (i=0; i<len ; i++)
1128 if ( (p[i/8] & (1 << (7 - (i%8)))) == 0) /* first bit unset */
1130 for (n=i+1; n < len; n++)
1131 if ( (p[n/8] & (1 << (7 - (n%8)))) != 0)
1132 return -1; /* mask not contiguous */
1137 * print flags set/clear in the two bitmasks passed as parameters.
1138 * There is a specialized check for f_tcpflags.
1141 print_flags(struct buf_pr *bp, char const *name, ipfw_insn *cmd,
1144 char const *comma = "";
1146 uint8_t set = cmd->arg1 & 0xff;
1147 uint8_t clear = (cmd->arg1 >> 8) & 0xff;
1149 if (list == f_tcpflags && set == TH_SYN && clear == TH_ACK) {
1150 bprintf(bp, " setup");
1154 bprintf(bp, " %s ", name);
1155 for (i=0; list[i].x != 0; i++) {
1156 if (set & list[i].x) {
1158 bprintf(bp, "%s%s", comma, list[i].s);
1161 if (clear & list[i].x) {
1162 clear &= ~list[i].x;
1163 bprintf(bp, "%s!%s", comma, list[i].s);
1171 * Print the ip address contained in a command.
1174 print_ip(struct buf_pr *bp, struct format_opts *fo, ipfw_insn_ip *cmd,
1177 struct hostent *he = NULL;
1179 uint32_t len = F_LEN((ipfw_insn *)cmd);
1180 uint32_t *a = ((ipfw_insn_u32 *)cmd)->d;
1183 if (cmd->o.opcode == O_IP_DST_LOOKUP && len > F_INSN_SIZE(ipfw_insn_u32)) {
1185 const char *arg = "<invalid>";
1187 if (d < sizeof(lookup_key)/sizeof(lookup_key[0]))
1188 arg = match_value(rule_options, lookup_key[d]);
1189 t = table_search_ctlv(fo->tstate, ((ipfw_insn *)cmd)->arg1);
1190 bprintf(bp, "%s lookup %s %s", cmd->o.len & F_NOT ? " not": "",
1194 bprintf(bp, "%s%s ", cmd->o.len & F_NOT ? " not": "", s);
1196 if (cmd->o.opcode == O_IP_SRC_ME || cmd->o.opcode == O_IP_DST_ME) {
1200 if (cmd->o.opcode == O_IP_SRC_LOOKUP ||
1201 cmd->o.opcode == O_IP_DST_LOOKUP) {
1202 t = table_search_ctlv(fo->tstate, ((ipfw_insn *)cmd)->arg1);
1203 bprintf(bp, "table(%s", t);
1204 if (len == F_INSN_SIZE(ipfw_insn_u32))
1205 bprintf(bp, ",%u", *a);
1209 if (cmd->o.opcode == O_IP_SRC_SET || cmd->o.opcode == O_IP_DST_SET) {
1210 uint32_t x, *map = (uint32_t *)&(cmd->mask);
1214 x = cmd->o.arg1 - 1;
1216 cmd->addr.s_addr = htonl(cmd->addr.s_addr);
1217 bprintf(bp, "%s/%d", inet_ntoa(cmd->addr),
1218 contigmask((uint8_t *)&x, 32));
1219 x = cmd->addr.s_addr = htonl(cmd->addr.s_addr);
1220 x &= 0xff; /* base */
1222 * Print bits and ranges.
1223 * Locate first bit set (i), then locate first bit unset (j).
1224 * If we have 3+ consecutive bits set, then print them as a
1225 * range, otherwise only print the initial bit and rescan.
1227 for (i=0; i < cmd->o.arg1; i++)
1228 if (map[i/32] & (1<<(i & 31))) {
1229 for (j=i+1; j < cmd->o.arg1; j++)
1230 if (!(map[ j/32] & (1<<(j & 31))))
1232 bprintf(bp, "%c%d", comma, i+x);
1233 if (j>i+2) { /* range has at least 3 elements */
1234 bprintf(bp, "-%d", j-1+x);
1243 * len == 2 indicates a single IP, whereas lists of 1 or more
1244 * addr/mask pairs have len = (2n+1). We convert len to n so we
1245 * use that to count the number of entries.
1247 for (len = len / 2; len > 0; len--, a += 2) {
1248 int mb = /* mask length */
1249 (cmd->o.opcode == O_IP_SRC || cmd->o.opcode == O_IP_DST) ?
1250 32 : contigmask((uint8_t *)&(a[1]), 32);
1251 if (mb == 32 && co.do_resolv)
1252 he = gethostbyaddr((char *)&(a[0]), sizeof(u_long), AF_INET);
1253 if (he != NULL) /* resolved to name */
1254 bprintf(bp, "%s", he->h_name);
1255 else if (mb == 0) /* any */
1257 else { /* numeric IP followed by some kind of mask */
1258 ia = (struct in_addr *)&a[0];
1259 bprintf(bp, "%s", inet_ntoa(*ia));
1261 ia = (struct in_addr *)&a[1];
1262 bprintf(bp, ":%s", inet_ntoa(*ia));
1264 bprintf(bp, "/%d", mb);
1272 * prints a MAC address/mask pair
1275 print_mac(struct buf_pr *bp, uint8_t *addr, uint8_t *mask)
1277 int l = contigmask(mask, 48);
1280 bprintf(bp, " any");
1282 bprintf(bp, " %02x:%02x:%02x:%02x:%02x:%02x",
1283 addr[0], addr[1], addr[2], addr[3], addr[4], addr[5]);
1285 bprintf(bp, "&%02x:%02x:%02x:%02x:%02x:%02x",
1286 mask[0], mask[1], mask[2],
1287 mask[3], mask[4], mask[5]);
1289 bprintf(bp, "/%d", l);
1294 fill_icmptypes(ipfw_insn_u32 *cmd, char *av)
1303 type = strtoul(av, &av, 0);
1305 if (*av != ',' && *av != '\0')
1306 errx(EX_DATAERR, "invalid ICMP type");
1309 errx(EX_DATAERR, "ICMP type out of range");
1311 cmd->d[0] |= 1 << type;
1313 cmd->o.opcode = O_ICMPTYPE;
1314 cmd->o.len |= F_INSN_SIZE(ipfw_insn_u32);
1318 print_icmptypes(struct buf_pr *bp, ipfw_insn_u32 *cmd)
1323 bprintf(bp, " icmptypes");
1324 for (i = 0; i < 32; i++) {
1325 if ( (cmd->d[0] & (1 << (i))) == 0)
1327 bprintf(bp, "%c%d", sep, i);
1333 print_dscp(struct buf_pr *bp, ipfw_insn_u32 *cmd)
1340 bprintf(bp, " dscp");
1343 if (*v & (1 << i)) {
1344 if ((code = match_value(f_ipdscp, i)) != NULL)
1345 bprintf(bp, "%c%s", sep, code);
1347 bprintf(bp, "%c%d", sep, i);
1351 if ((++i % 32) == 0)
1357 * show_ipfw() prints the body of an ipfw rule.
1358 * Because the standard rule has at least proto src_ip dst_ip, we use
1359 * a helper function to produce these entries if not provided explicitly.
1360 * The first argument is the list of fields we have, the second is
1361 * the list of fields we want to be printed.
1363 * Special cases if we have provided a MAC header:
1364 * + if the rule does not contain IP addresses/ports, do not print them;
1365 * + if the rule does not contain an IP proto, print "all" instead of "ip";
1367 * Once we have 'have_options', IP header fields are printed as options.
1369 #define HAVE_PROTO 0x0001
1370 #define HAVE_SRCIP 0x0002
1371 #define HAVE_DSTIP 0x0004
1372 #define HAVE_PROTO4 0x0008
1373 #define HAVE_PROTO6 0x0010
1374 #define HAVE_IP 0x0100
1375 #define HAVE_OPTIONS 0x8000
1378 show_prerequisites(struct buf_pr *bp, int *flags, int want, int cmd)
1380 (void)cmd; /* UNUSED */
1381 if (co.comment_only)
1383 if ( (*flags & HAVE_IP) == HAVE_IP)
1384 *flags |= HAVE_OPTIONS;
1386 if ( !(*flags & HAVE_OPTIONS)) {
1387 if ( !(*flags & HAVE_PROTO) && (want & HAVE_PROTO)) {
1388 if ( (*flags & HAVE_PROTO4))
1389 bprintf(bp, " ip4");
1390 else if ( (*flags & HAVE_PROTO6))
1391 bprintf(bp, " ip6");
1395 if ( !(*flags & HAVE_SRCIP) && (want & HAVE_SRCIP))
1396 bprintf(bp, " from any");
1397 if ( !(*flags & HAVE_DSTIP) && (want & HAVE_DSTIP))
1398 bprintf(bp, " to any");
1404 show_static_rule(struct cmdline_opts *co, struct format_opts *fo,
1405 struct buf_pr *bp, struct ip_fw_rule *rule, struct ip_fw_bcounter *cntr)
1407 static int twidth = 0;
1409 ipfw_insn *cmd, *has_eaction = NULL, *tagptr = NULL;
1410 const char *comment = NULL; /* ptr to comment if we have one */
1412 int proto = 0; /* default */
1413 int flags = 0; /* prerequisites */
1414 ipfw_insn_log *logptr = NULL; /* set if we find an O_LOG */
1415 ipfw_insn_altq *altqptr = NULL; /* set if we find an O_ALTQ */
1416 int or_block = 0; /* we are in an or block */
1419 if ((fo->set_mask & (1 << rule->set)) == 0) {
1424 bprintf(bp, "# DISABLED ");
1426 bprintf(bp, "%05u ", rule->rulenum);
1428 /* Print counters if enabled */
1429 if (fo->pcwidth > 0 || fo->bcwidth > 0) {
1430 pr_u64(bp, &cntr->pcnt, fo->pcwidth);
1431 pr_u64(bp, &cntr->bcnt, fo->bcwidth);
1434 if (co->do_time == 2)
1435 bprintf(bp, "%10u ", cntr->timestamp);
1436 else if (co->do_time == 1) {
1438 time_t t = (time_t)0;
1441 strcpy(timestr, ctime(&t));
1442 *strchr(timestr, '\n') = '\0';
1443 twidth = strlen(timestr);
1445 if (cntr->timestamp > 0) {
1446 t = _long_to_time(cntr->timestamp);
1448 strcpy(timestr, ctime(&t));
1449 *strchr(timestr, '\n') = '\0';
1450 bprintf(bp, "%s ", timestr);
1452 bprintf(bp, "%*s", twidth, " ");
1457 bprintf(bp, "set %d ", rule->set);
1460 * print the optional "match probability"
1462 if (rule->cmd_len > 0) {
1464 if (cmd->opcode == O_PROB) {
1465 ipfw_insn_u32 *p = (ipfw_insn_u32 *)cmd;
1466 double d = 1.0 * p->d[0];
1468 d = (d / 0x7fffffff);
1469 bprintf(bp, "prob %f ", d);
1474 * first print actions
1476 for (l = rule->cmd_len - rule->act_ofs, cmd = ACTION_PTR(rule);
1477 l > 0 ; l -= F_LEN(cmd), cmd += F_LEN(cmd)) {
1478 switch(cmd->opcode) {
1480 bprintf(bp, "check-state");
1482 ename = object_search_ctlv(fo->tstate,
1483 cmd->arg1, IPFW_TLV_STATE_NAME);
1486 bprintf(bp, " :%s", ename ? ename: "any");
1487 /* avoid printing anything else */
1488 flags = HAVE_PROTO | HAVE_SRCIP |
1489 HAVE_DSTIP | HAVE_IP;
1493 bprintf(bp, "allow");
1497 bprintf(bp, "count");
1501 bprintf(bp, "deny");
1505 if (cmd->arg1 == ICMP_REJECT_RST)
1506 bprintf(bp, "reset");
1507 else if (cmd->arg1 == ICMP_UNREACH_HOST)
1508 bprintf(bp, "reject");
1510 print_reject_code(bp, cmd->arg1);
1514 if (cmd->arg1 == ICMP6_UNREACH_RST)
1515 bprintf(bp, "reset6");
1517 print_unreach6_code(bp, cmd->arg1);
1521 bprint_uint_arg(bp, "skipto ", cmd->arg1);
1525 bprint_uint_arg(bp, "pipe ", cmd->arg1);
1529 bprint_uint_arg(bp, "queue ", cmd->arg1);
1533 bprint_uint_arg(bp, "divert ", cmd->arg1);
1537 bprint_uint_arg(bp, "tee ", cmd->arg1);
1541 bprint_uint_arg(bp, "netgraph ", cmd->arg1);
1545 bprint_uint_arg(bp, "ngtee ", cmd->arg1);
1550 ipfw_insn_sa *s = (ipfw_insn_sa *)cmd;
1552 if (s->sa.sin_addr.s_addr == INADDR_ANY) {
1553 bprintf(bp, "fwd tablearg");
1555 bprintf(bp, "fwd %s",inet_ntoa(s->sa.sin_addr));
1558 bprintf(bp, ",%d", s->sa.sin_port);
1564 char buf[INET6_ADDRSTRLEN + IF_NAMESIZE + 2];
1565 ipfw_insn_sa6 *s = (ipfw_insn_sa6 *)cmd;
1567 bprintf(bp, "fwd ");
1568 if (getnameinfo((const struct sockaddr *)&s->sa,
1569 sizeof(struct sockaddr_in6), buf, sizeof(buf),
1570 NULL, 0, NI_NUMERICHOST) == 0)
1571 bprintf(bp, "%s", buf);
1572 if (s->sa.sin6_port)
1573 bprintf(bp, ",%d", s->sa.sin6_port);
1577 case O_LOG: /* O_LOG is printed last */
1578 logptr = (ipfw_insn_log *)cmd;
1581 case O_ALTQ: /* O_ALTQ is printed after O_LOG */
1582 altqptr = (ipfw_insn_altq *)cmd;
1590 if (cmd->arg1 != IP_FW_NAT44_GLOBAL)
1591 bprint_uint_arg(bp, "nat ", cmd->arg1);
1593 bprintf(bp, "nat global");
1597 if (cmd->arg1 == IP_FW_TARG)
1598 bprint_uint_arg(bp, "setfib ", cmd->arg1);
1600 bprintf(bp, "setfib %u", cmd->arg1 & 0x7FFF);
1603 case O_EXTERNAL_ACTION: {
1605 * The external action can consists of two following
1606 * each other opcodes - O_EXTERNAL_ACTION and
1607 * O_EXTERNAL_INSTANCE. The first contains the ID of
1608 * name of external action. The second contains the ID
1609 * of name of external action instance.
1610 * NOTE: in case when external action has no named
1611 * instances support, the second opcode isn't needed.
1614 ename = object_search_ctlv(fo->tstate, cmd->arg1,
1616 if (match_token(rule_eactions, ename) != -1)
1617 bprintf(bp, "%s", ename);
1619 bprintf(bp, "eaction %s", ename);
1623 case O_EXTERNAL_INSTANCE: {
1624 if (has_eaction == NULL)
1627 * XXX: we need to teach ipfw(9) to rewrite opcodes
1628 * in the user buffer on rule addition. When we add
1629 * the rule, we specify zero TLV type for
1630 * O_EXTERNAL_INSTANCE object. To show correct
1631 * rule after `ipfw add` we need to search instance
1632 * name with zero type. But when we do `ipfw show`
1633 * we calculate TLV type using IPFW_TLV_EACTION_NAME()
1636 ename = object_search_ctlv(fo->tstate, cmd->arg1, 0);
1638 ename = object_search_ctlv(fo->tstate,
1640 IPFW_TLV_EACTION_NAME(has_eaction->arg1));
1641 bprintf(bp, " %s", ename);
1649 if (cmd->arg1 == IP_FW_TARG) {
1650 bprint_uint_arg(bp, "setdscp ", cmd->arg1);
1653 uval = cmd->arg1 & 0x3F;
1654 if ((code = match_value(f_ipdscp, uval)) != NULL)
1655 bprintf(bp, "setdscp %s", code);
1657 bprint_uint_arg(bp, "setdscp ", uval);
1662 bprintf(bp, "reass");
1666 if (cmd->len & F_NOT)
1667 bprintf(bp, "return");
1669 bprint_uint_arg(bp, "call ", cmd->arg1);
1673 bprintf(bp, "** unrecognized action %d len %d ",
1674 cmd->opcode, cmd->len);
1678 if (logptr->max_log > 0)
1679 bprintf(bp, " log logamount %d", logptr->max_log);
1681 bprintf(bp, " log");
1685 print_altq_cmd(bp, altqptr);
1689 if (tagptr->len & F_NOT)
1690 bprint_uint_arg(bp, " untag ", tagptr->arg1);
1692 bprint_uint_arg(bp, " tag ", tagptr->arg1);
1696 * then print the body.
1698 for (l = rule->act_ofs, cmd = rule->cmd;
1699 l > 0 ; l -= F_LEN(cmd) , cmd += F_LEN(cmd)) {
1700 if ((cmd->len & F_OR) || (cmd->len & F_NOT))
1702 if (cmd->opcode == O_IP4) {
1703 flags |= HAVE_PROTO4;
1705 } else if (cmd->opcode == O_IP6) {
1706 flags |= HAVE_PROTO6;
1710 if (rule->flags & IPFW_RULE_NOOPT) { /* empty rules before options */
1711 if (!co->do_compact) {
1712 show_prerequisites(bp, &flags, HAVE_PROTO, 0);
1713 bprintf(bp, " from any to any");
1715 flags |= HAVE_IP | HAVE_OPTIONS | HAVE_PROTO |
1716 HAVE_SRCIP | HAVE_DSTIP;
1719 if (co->comment_only)
1722 for (l = rule->act_ofs, cmd = rule->cmd;
1723 l > 0 ; l -= F_LEN(cmd) , cmd += F_LEN(cmd)) {
1725 ipfw_insn_u32 *cmd32 = (ipfw_insn_u32 *)cmd;
1727 if (co->comment_only) {
1728 if (cmd->opcode != O_NOP)
1730 bprintf(bp, " // %s\n", (char *)(cmd + 1));
1734 show_prerequisites(bp, &flags, 0, cmd->opcode);
1736 switch(cmd->opcode) {
1738 break; /* done already */
1741 break; /* no need to print anything here */
1744 case O_IP_SRC_LOOKUP:
1748 show_prerequisites(bp, &flags, HAVE_PROTO, 0);
1749 if (!(flags & HAVE_SRCIP))
1750 bprintf(bp, " from");
1751 if ((cmd->len & F_OR) && !or_block)
1753 print_ip(bp, fo, (ipfw_insn_ip *)cmd,
1754 (flags & HAVE_OPTIONS) ? " src-ip" : "");
1755 flags |= HAVE_SRCIP;
1759 case O_IP_DST_LOOKUP:
1763 show_prerequisites(bp, &flags, HAVE_PROTO|HAVE_SRCIP, 0);
1764 if (!(flags & HAVE_DSTIP))
1766 if ((cmd->len & F_OR) && !or_block)
1768 print_ip(bp, fo, (ipfw_insn_ip *)cmd,
1769 (flags & HAVE_OPTIONS) ? " dst-ip" : "");
1770 flags |= HAVE_DSTIP;
1774 case O_IP6_SRC_MASK:
1776 show_prerequisites(bp, &flags, HAVE_PROTO, 0);
1777 if (!(flags & HAVE_SRCIP))
1778 bprintf(bp, " from");
1779 if ((cmd->len & F_OR) && !or_block)
1781 print_ip6(bp, (ipfw_insn_ip6 *)cmd,
1782 (flags & HAVE_OPTIONS) ? " src-ip6" : "");
1783 flags |= HAVE_SRCIP | HAVE_PROTO;
1787 case O_IP6_DST_MASK:
1789 show_prerequisites(bp, &flags, HAVE_PROTO|HAVE_SRCIP, 0);
1790 if (!(flags & HAVE_DSTIP))
1792 if ((cmd->len & F_OR) && !or_block)
1794 print_ip6(bp, (ipfw_insn_ip6 *)cmd,
1795 (flags & HAVE_OPTIONS) ? " dst-ip6" : "");
1796 flags |= HAVE_DSTIP;
1800 print_flow6id(bp, (ipfw_insn_u32 *) cmd );
1801 flags |= HAVE_OPTIONS;
1805 show_prerequisites(bp, &flags,
1806 HAVE_PROTO | HAVE_SRCIP |
1807 HAVE_DSTIP | HAVE_IP, 0);
1809 if (flags & HAVE_DSTIP)
1811 show_prerequisites(bp, &flags,
1812 HAVE_PROTO | HAVE_SRCIP, 0);
1813 if ((cmd->len & F_OR) && !or_block)
1815 if (cmd->len & F_NOT)
1816 bprintf(bp, " not");
1817 print_newports(bp, (ipfw_insn_u16 *)cmd, proto,
1818 (flags & HAVE_OPTIONS) ? cmd->opcode : 0);
1822 struct protoent *pe = NULL;
1824 if ((cmd->len & F_OR) && !or_block)
1826 if (cmd->len & F_NOT)
1827 bprintf(bp, " not");
1829 pe = getprotobynumber(cmd->arg1);
1830 if ((flags & (HAVE_PROTO4 | HAVE_PROTO6)) &&
1831 !(flags & HAVE_PROTO))
1832 show_prerequisites(bp, &flags,
1833 HAVE_PROTO | HAVE_IP | HAVE_SRCIP |
1834 HAVE_DSTIP | HAVE_OPTIONS, 0);
1835 if (flags & HAVE_OPTIONS)
1836 bprintf(bp, " proto");
1838 bprintf(bp, " %s", pe->p_name);
1840 bprintf(bp, " %u", cmd->arg1);
1842 flags |= HAVE_PROTO;
1845 default: /*options ... */
1846 if (!(cmd->len & (F_OR|F_NOT)))
1847 if (((cmd->opcode == O_IP6) &&
1848 (flags & HAVE_PROTO6)) ||
1849 ((cmd->opcode == O_IP4) &&
1850 (flags & HAVE_PROTO4)))
1852 show_prerequisites(bp, &flags, HAVE_PROTO | HAVE_SRCIP |
1853 HAVE_DSTIP | HAVE_IP | HAVE_OPTIONS, 0);
1854 if ((cmd->len & F_OR) && !or_block)
1856 if (cmd->len & F_NOT && cmd->opcode != O_IN)
1857 bprintf(bp, " not");
1858 switch(cmd->opcode) {
1860 ipfw_insn_mac *m = (ipfw_insn_mac *)cmd;
1862 bprintf(bp, " MAC");
1863 print_mac(bp, m->addr, m->mask);
1864 print_mac(bp, m->addr + 6, m->mask + 6);
1869 print_newports(bp, (ipfw_insn_u16 *)cmd,
1870 IPPROTO_ETHERTYPE, cmd->opcode);
1875 bprintf(bp, " frag");
1879 bprintf(bp, " fib %u", cmd->arg1 );
1882 bprintf(bp, " sockarg");
1886 bprintf(bp, cmd->len & F_NOT ? " out" : " in");
1890 switch (cmd->arg1) {
1892 bprintf(bp, " diverted");
1895 bprintf(bp, " diverted-loopback");
1898 bprintf(bp, " diverted-output");
1901 bprintf(bp, " diverted-?<%u>", cmd->arg1);
1907 bprintf(bp, " layer2");
1914 ipfw_insn_if *cmdif = (ipfw_insn_if *)cmd;
1916 if (cmd->opcode == O_XMIT)
1918 else if (cmd->opcode == O_RECV)
1920 else /* if (cmd->opcode == O_VIA) */
1922 if (cmdif->name[0] == '\0')
1923 bprintf(bp, " %s %s", s,
1924 inet_ntoa(cmdif->p.ip));
1925 else if (cmdif->name[0] == '\1') {
1926 /* interface table */
1927 t = table_search_ctlv(fo->tstate,
1929 bprintf(bp, " %s table(%s)", s, t);
1931 bprintf(bp, " %s %s", s, cmdif->name);
1935 case O_IP_FLOW_LOOKUP:
1939 t = table_search_ctlv(fo->tstate, cmd->arg1);
1940 bprintf(bp, " flow table(%s", t);
1941 if (F_LEN(cmd) == F_INSN_SIZE(ipfw_insn_u32))
1943 ((ipfw_insn_u32 *)cmd)->d[0]);
1948 if (F_LEN(cmd) == 1)
1949 bprintf(bp, " ipid %u", cmd->arg1 );
1951 print_newports(bp, (ipfw_insn_u16 *)cmd, 0,
1956 if (F_LEN(cmd) == 1)
1957 bprintf(bp, " ipttl %u", cmd->arg1 );
1959 print_newports(bp, (ipfw_insn_u16 *)cmd, 0,
1964 bprintf(bp, " ipver %u", cmd->arg1 );
1967 case O_IPPRECEDENCE:
1968 bprintf(bp, " ipprecedence %u", cmd->arg1 >> 5);
1972 print_dscp(bp, (ipfw_insn_u32 *)cmd);
1976 if (F_LEN(cmd) == 1)
1977 bprintf(bp, " iplen %u", cmd->arg1 );
1979 print_newports(bp, (ipfw_insn_u16 *)cmd, 0,
1984 print_flags(bp, "ipoptions", cmd, f_ipopts);
1988 print_flags(bp, "iptos", cmd, f_iptos);
1992 print_icmptypes(bp, (ipfw_insn_u32 *)cmd);
1996 bprintf(bp, " established");
2000 if (F_LEN(cmd) == 1)
2001 bprintf(bp, " tcpdatalen %u", cmd->arg1 );
2003 print_newports(bp, (ipfw_insn_u16 *)cmd, 0,
2008 print_flags(bp, "tcpflags", cmd, f_tcpflags);
2012 print_flags(bp, "tcpoptions", cmd, f_tcpopts);
2016 if (F_LEN(cmd) == 1)
2017 bprintf(bp, " tcpwin %u", cmd->arg1);
2019 print_newports(bp, (ipfw_insn_u16 *)cmd, 0,
2024 bprintf(bp, " tcpack %d", ntohl(cmd32->d[0]));
2028 bprintf(bp, " tcpseq %d", ntohl(cmd32->d[0]));
2033 struct passwd *pwd = getpwuid(cmd32->d[0]);
2036 bprintf(bp, " uid %s", pwd->pw_name);
2038 bprintf(bp, " uid %u", cmd32->d[0]);
2044 struct group *grp = getgrgid(cmd32->d[0]);
2047 bprintf(bp, " gid %s", grp->gr_name);
2049 bprintf(bp, " gid %u", cmd32->d[0]);
2054 bprintf(bp, " jail %d", cmd32->d[0]);
2058 bprintf(bp, " verrevpath");
2062 bprintf(bp, " versrcreach");
2066 bprintf(bp, " antispoof");
2070 bprintf(bp, " ipsec");
2074 comment = (char *)(cmd + 1);
2078 bprintf(bp, " keep-state");
2080 object_search_ctlv(fo->tstate, cmd->arg1,
2081 IPFW_TLV_STATE_NAME));
2085 struct _s_x *p = limit_masks;
2086 ipfw_insn_limit *c = (ipfw_insn_limit *)cmd;
2087 uint8_t x = c->limit_mask;
2088 char const *comma = " ";
2090 bprintf(bp, " limit");
2091 for (; p->x != 0 ; p++)
2092 if ((x & p->x) == p->x) {
2094 bprintf(bp, "%s%s", comma,p->s);
2097 bprint_uint_arg(bp, " ", c->conn_limit);
2099 object_search_ctlv(fo->tstate, cmd->arg1,
2100 IPFW_TLV_STATE_NAME));
2105 bprintf(bp, " ip6");
2109 bprintf(bp, " ip4");
2113 print_icmp6types(bp, (ipfw_insn_u32 *)cmd);
2117 print_ext6hdr(bp, (ipfw_insn *)cmd);
2121 if (F_LEN(cmd) == 1)
2122 bprint_uint_arg(bp, " tagged ",
2125 print_newports(bp, (ipfw_insn_u16 *)cmd,
2130 bprintf(bp, " [opcode %d len %d]",
2131 cmd->opcode, cmd->len);
2134 if (cmd->len & F_OR) {
2137 } else if (or_block) {
2142 show_prerequisites(bp, &flags, HAVE_PROTO | HAVE_SRCIP | HAVE_DSTIP
2145 bprintf(bp, " // %s", comment);
2150 show_dyn_state(struct cmdline_opts *co, struct format_opts *fo,
2151 struct buf_pr *bp, ipfw_dyn_rule *d)
2153 struct protoent *pe;
2156 char buf[INET6_ADDRSTRLEN];
2158 if (!co->do_expired) {
2159 if (!d->expire && !(d->dyn_type == O_LIMIT_PARENT))
2162 bcopy(&d->rule, &rulenum, sizeof(rulenum));
2163 bprintf(bp, "%05d", rulenum);
2164 if (fo->pcwidth > 0 || fo->bcwidth > 0) {
2166 pr_u64(bp, &d->pcnt, fo->pcwidth);
2167 pr_u64(bp, &d->bcnt, fo->bcwidth);
2168 bprintf(bp, "(%ds)", d->expire);
2170 switch (d->dyn_type) {
2171 case O_LIMIT_PARENT:
2172 bprintf(bp, " PARENT %d", d->count);
2175 bprintf(bp, " LIMIT");
2177 case O_KEEP_STATE: /* bidir, no mask */
2178 bprintf(bp, " STATE");
2182 if ((pe = getprotobynumber(d->id.proto)) != NULL)
2183 bprintf(bp, " %s", pe->p_name);
2185 bprintf(bp, " proto %u", d->id.proto);
2187 if (d->id.addr_type == 4) {
2188 a.s_addr = htonl(d->id.src_ip);
2189 bprintf(bp, " %s %d", inet_ntoa(a), d->id.src_port);
2191 a.s_addr = htonl(d->id.dst_ip);
2192 bprintf(bp, " <-> %s %d", inet_ntoa(a), d->id.dst_port);
2193 } else if (d->id.addr_type == 6) {
2194 bprintf(bp, " %s %d", inet_ntop(AF_INET6, &d->id.src_ip6, buf,
2195 sizeof(buf)), d->id.src_port);
2196 bprintf(bp, " <-> %s %d", inet_ntop(AF_INET6, &d->id.dst_ip6,
2197 buf, sizeof(buf)), d->id.dst_port);
2199 bprintf(bp, " UNKNOWN <-> UNKNOWN");
2201 bprintf(bp, " :%s", object_search_ctlv(fo->tstate,
2202 d->kidx, IPFW_TLV_STATE_NAME));
2206 do_range_cmd(int cmd, ipfw_range_tlv *rt)
2208 ipfw_range_header rh;
2211 memset(&rh, 0, sizeof(rh));
2212 memcpy(&rh.range, rt, sizeof(*rt));
2213 rh.range.head.length = sizeof(*rt);
2214 rh.range.head.type = IPFW_TLV_RANGE;
2217 if (do_get3(cmd, &rh.opheader, &sz) != 0)
2219 /* Save number of matched objects */
2220 rt->new_set = rh.range.new_set;
2225 * This one handles all set-related commands
2226 * ipfw set { show | enable | disable }
2228 * ipfw set move X to Y
2229 * ipfw set move rule X to Y
2232 ipfw_sets_handler(char *av[])
2236 uint8_t cmd, rulenum;
2242 memset(&rt, 0, sizeof(rt));
2245 errx(EX_USAGE, "set needs command");
2246 if (_substrcmp(*av, "show") == 0) {
2247 struct format_opts fo;
2248 ipfw_cfg_lheader *cfg;
2250 memset(&fo, 0, sizeof(fo));
2251 if (ipfw_get_config(&co, &fo, &cfg, &size) != 0)
2252 err(EX_OSERR, "requesting config failed");
2254 for (i = 0, msg = "disable"; i < RESVD_SET; i++)
2255 if ((cfg->set_mask & (1<<i)) == 0) {
2256 printf("%s %d", msg, i);
2259 msg = (cfg->set_mask != (uint32_t)-1) ? " enable" : "enable";
2260 for (i = 0; i < RESVD_SET; i++)
2261 if ((cfg->set_mask & (1<<i)) != 0) {
2262 printf("%s %d", msg, i);
2267 } else if (_substrcmp(*av, "swap") == 0) {
2269 if ( av[0] == NULL || av[1] == NULL )
2270 errx(EX_USAGE, "set swap needs 2 set numbers\n");
2271 rt.set = atoi(av[0]);
2272 rt.new_set = atoi(av[1]);
2273 if (!isdigit(*(av[0])) || rt.set > RESVD_SET)
2274 errx(EX_DATAERR, "invalid set number %s\n", av[0]);
2275 if (!isdigit(*(av[1])) || rt.new_set > RESVD_SET)
2276 errx(EX_DATAERR, "invalid set number %s\n", av[1]);
2277 i = do_range_cmd(IP_FW_SET_SWAP, &rt);
2278 } else if (_substrcmp(*av, "move") == 0) {
2280 if (av[0] && _substrcmp(*av, "rule") == 0) {
2281 rt.flags = IPFW_RCFLAG_RANGE; /* move rules to new set */
2285 cmd = IP_FW_SET_MOVE; /* Move set to new one */
2286 if (av[0] == NULL || av[1] == NULL || av[2] == NULL ||
2287 av[3] != NULL || _substrcmp(av[1], "to") != 0)
2288 errx(EX_USAGE, "syntax: set move [rule] X to Y\n");
2289 rulenum = atoi(av[0]);
2290 rt.new_set = atoi(av[2]);
2291 if (cmd == IP_FW_XMOVE) {
2292 rt.start_rule = rulenum;
2293 rt.end_rule = rulenum;
2296 rt.new_set = atoi(av[2]);
2297 if (!isdigit(*(av[0])) || (cmd == 3 && rt.set > RESVD_SET) ||
2298 (cmd == 2 && rt.start_rule == IPFW_DEFAULT_RULE) )
2299 errx(EX_DATAERR, "invalid source number %s\n", av[0]);
2300 if (!isdigit(*(av[2])) || rt.new_set > RESVD_SET)
2301 errx(EX_DATAERR, "invalid dest. set %s\n", av[1]);
2302 i = do_range_cmd(cmd, &rt);
2304 err(EX_OSERR, "failed to move %s",
2305 cmd == IP_FW_SET_MOVE ? "set": "rule");
2306 } else if (_substrcmp(*av, "disable") == 0 ||
2307 _substrcmp(*av, "enable") == 0 ) {
2308 int which = _substrcmp(*av, "enable") == 0 ? 1 : 0;
2311 masks[0] = masks[1] = 0;
2314 if (isdigit(**av)) {
2316 if (i < 0 || i > RESVD_SET)
2318 "invalid set number %d\n", i);
2319 masks[which] |= (1<<i);
2320 } else if (_substrcmp(*av, "disable") == 0)
2322 else if (_substrcmp(*av, "enable") == 0)
2326 "invalid set command %s\n", *av);
2329 if ( (masks[0] & masks[1]) != 0 )
2331 "cannot enable and disable the same set\n");
2334 rt.new_set = masks[1];
2335 i = do_range_cmd(IP_FW_SET_ENABLE, &rt);
2337 warn("set enable/disable: setsockopt(IP_FW_SET_ENABLE)");
2339 errx(EX_USAGE, "invalid set command %s\n", *av);
2343 ipfw_sysctl_handler(char *av[], int which)
2347 if (av[0] == NULL) {
2348 warnx("missing keyword to enable/disable\n");
2349 } else if (_substrcmp(*av, "firewall") == 0) {
2350 sysctlbyname("net.inet.ip.fw.enable", NULL, 0,
2351 &which, sizeof(which));
2352 sysctlbyname("net.inet6.ip6.fw.enable", NULL, 0,
2353 &which, sizeof(which));
2354 } else if (_substrcmp(*av, "one_pass") == 0) {
2355 sysctlbyname("net.inet.ip.fw.one_pass", NULL, 0,
2356 &which, sizeof(which));
2357 } else if (_substrcmp(*av, "debug") == 0) {
2358 sysctlbyname("net.inet.ip.fw.debug", NULL, 0,
2359 &which, sizeof(which));
2360 } else if (_substrcmp(*av, "verbose") == 0) {
2361 sysctlbyname("net.inet.ip.fw.verbose", NULL, 0,
2362 &which, sizeof(which));
2363 } else if (_substrcmp(*av, "dyn_keepalive") == 0) {
2364 sysctlbyname("net.inet.ip.fw.dyn_keepalive", NULL, 0,
2365 &which, sizeof(which));
2367 } else if (_substrcmp(*av, "altq") == 0) {
2368 altq_set_enabled(which);
2371 warnx("unrecognize enable/disable keyword: %s\n", *av);
2375 typedef void state_cb(struct cmdline_opts *co, struct format_opts *fo,
2376 void *arg, void *state);
2379 prepare_format_dyn(struct cmdline_opts *co, struct format_opts *fo,
2380 void *arg, void *_state)
2386 d = (ipfw_dyn_rule *)_state;
2387 /* Count _ALL_ states */
2390 if (fo->show_counters == 0)
2394 /* skip states from another set */
2395 bcopy((char *)&d->rule + sizeof(uint16_t), &set,
2397 if (set != co->use_set - 1)
2401 width = pr_u64(NULL, &d->pcnt, 0);
2402 if (width > fo->pcwidth)
2403 fo->pcwidth = width;
2405 width = pr_u64(NULL, &d->bcnt, 0);
2406 if (width > fo->bcwidth)
2407 fo->bcwidth = width;
2411 foreach_state(struct cmdline_opts *co, struct format_opts *fo,
2412 caddr_t base, size_t sz, state_cb dyn_bc, void *dyn_arg)
2418 ipfw_obj_ctlv *ctlv;
2424 ctlv = (ipfw_obj_ctlv *)base;
2425 switch (ctlv->head.type) {
2426 case IPFW_TLV_DYNSTATE_LIST:
2427 base += sizeof(*ctlv);
2428 sz -= sizeof(*ctlv);
2429 ttype = IPFW_TLV_DYN_ENT;
2438 tlv = (ipfw_obj_tlv *)base;
2439 if (tlv->type != ttype)
2442 fptr(co, fo, farg, tlv + 1);
2444 base += tlv->length;
2452 prepare_format_opts(struct cmdline_opts *co, struct format_opts *fo,
2453 ipfw_obj_tlv *rtlv, int rcnt, caddr_t dynbase, size_t dynsz)
2455 int bcwidth, pcwidth, width;
2457 struct ip_fw_bcounter *cntr;
2458 struct ip_fw_rule *r;
2462 if (fo->show_counters != 0) {
2463 for (n = 0; n < rcnt; n++,
2464 rtlv = (ipfw_obj_tlv *)((caddr_t)rtlv + rtlv->length)) {
2465 cntr = (struct ip_fw_bcounter *)(rtlv + 1);
2466 r = (struct ip_fw_rule *)((caddr_t)cntr + cntr->size);
2467 /* skip rules from another set */
2468 if (co->use_set && r->set != co->use_set - 1)
2471 /* packet counter */
2472 width = pr_u64(NULL, &cntr->pcnt, 0);
2473 if (width > pcwidth)
2477 width = pr_u64(NULL, &cntr->bcnt, 0);
2478 if (width > bcwidth)
2482 fo->bcwidth = bcwidth;
2483 fo->pcwidth = pcwidth;
2486 if (co->do_dynamic && dynsz > 0)
2487 foreach_state(co, fo, dynbase, dynsz, prepare_format_dyn, NULL);
2491 list_static_range(struct cmdline_opts *co, struct format_opts *fo,
2492 struct buf_pr *bp, ipfw_obj_tlv *rtlv, int rcnt)
2495 struct ip_fw_rule *r;
2496 struct ip_fw_bcounter *cntr;
2499 for (n = seen = 0; n < rcnt; n++,
2500 rtlv = (ipfw_obj_tlv *)((caddr_t)rtlv + rtlv->length)) {
2502 if ((fo->show_counters | fo->show_time) != 0) {
2503 cntr = (struct ip_fw_bcounter *)(rtlv + 1);
2504 r = (struct ip_fw_rule *)((caddr_t)cntr + cntr->size);
2507 r = (struct ip_fw_rule *)(rtlv + 1);
2509 if (r->rulenum > fo->last)
2511 if (co->use_set && r->set != co->use_set - 1)
2513 if (r->rulenum >= fo->first && r->rulenum <= fo->last) {
2514 show_static_rule(co, fo, bp, r, cntr);
2515 printf("%s", bp->buf);
2526 list_dyn_state(struct cmdline_opts *co, struct format_opts *fo,
2527 void *_arg, void *_state)
2534 d = (ipfw_dyn_rule *)_state;
2535 bp = (struct buf_pr *)_arg;
2537 bcopy(&d->rule, &rulenum, sizeof(rulenum));
2538 if (rulenum > fo->last)
2541 bcopy((char *)&d->rule + sizeof(uint16_t),
2542 &set, sizeof(uint8_t));
2543 if (set != co->use_set - 1)
2546 if (rulenum >= fo->first) {
2547 show_dyn_state(co, fo, bp, d);
2548 printf("%s\n", bp->buf);
2554 list_dyn_range(struct cmdline_opts *co, struct format_opts *fo,
2555 struct buf_pr *bp, caddr_t base, size_t sz)
2558 sz = foreach_state(co, fo, base, sz, list_dyn_state, bp);
2563 ipfw_list(int ac, char *av[], int show_counters)
2565 ipfw_cfg_lheader *cfg;
2566 struct format_opts sfo;
2575 fprintf(stderr, "Testing only, list disabled\n");
2579 dummynet_list(ac, av, show_counters);
2585 memset(&sfo, 0, sizeof(sfo));
2587 /* Determine rule range to request */
2589 for (lac = ac, lav = av; lac != 0; lac--) {
2590 rnum = strtoul(*lav++, &endptr, 10);
2591 if (sfo.first == 0 || rnum < sfo.first)
2595 rnum = strtoul(endptr + 1, &endptr, 10);
2596 if (sfo.last == 0 || rnum > sfo.last)
2601 /* get configuraion from kernel */
2603 sfo.show_counters = show_counters;
2604 sfo.show_time = co.do_time;
2605 sfo.flags = IPFW_CFG_GET_STATIC;
2606 if (co.do_dynamic != 0)
2607 sfo.flags |= IPFW_CFG_GET_STATES;
2608 if ((sfo.show_counters | sfo.show_time) != 0)
2609 sfo.flags |= IPFW_CFG_GET_COUNTERS;
2610 if (ipfw_get_config(&co, &sfo, &cfg, &sz) != 0)
2611 err(EX_OSERR, "retrieving config failed");
2613 error = ipfw_show_config(&co, &sfo, cfg, sz, ac, av);
2622 ipfw_show_config(struct cmdline_opts *co, struct format_opts *fo,
2623 ipfw_cfg_lheader *cfg, size_t sz, int ac, char *av[])
2628 int exitval = EX_OK;
2634 ipfw_obj_ctlv *ctlv, *tstate;
2635 ipfw_obj_tlv *rbase;
2638 * Handle tablenames TLV first, if any
2644 readsz = sizeof(*cfg);
2647 fo->set_mask = cfg->set_mask;
2649 ctlv = (ipfw_obj_ctlv *)(cfg + 1);
2651 if (cfg->flags & IPFW_CFG_GET_STATIC) {
2652 /* We've requested static rules */
2653 if (ctlv->head.type == IPFW_TLV_TBLNAME_LIST) {
2654 object_sort_ctlv(ctlv);
2656 readsz += ctlv->head.length;
2657 ctlv = (ipfw_obj_ctlv *)((caddr_t)ctlv +
2661 if (ctlv->head.type == IPFW_TLV_RULE_LIST) {
2662 rbase = (ipfw_obj_tlv *)(ctlv + 1);
2664 readsz += ctlv->head.length;
2665 ctlv = (ipfw_obj_ctlv *)((caddr_t)ctlv +
2670 if ((cfg->flags & IPFW_CFG_GET_STATES) && (readsz != sz)) {
2671 /* We may have some dynamic states */
2672 dynsz = sz - readsz;
2673 /* Skip empty header */
2674 if (dynsz != sizeof(ipfw_obj_ctlv))
2675 dynbase = (caddr_t)ctlv;
2680 prepare_format_opts(co, fo, rbase, rcnt, dynbase, dynsz);
2681 bp_alloc(&bp, 4096);
2683 /* if no rule numbers were specified, list all rules */
2686 fo->last = IPFW_DEFAULT_RULE;
2687 list_static_range(co, fo, &bp, rbase, rcnt);
2689 if (co->do_dynamic && dynsz > 0) {
2690 printf("## Dynamic rules (%d %zu):\n", fo->dcnt, dynsz);
2691 list_dyn_range(co, fo, &bp, dynbase, dynsz);
2698 /* display specific rules requested on command line */
2699 for (lac = ac, lav = av; lac != 0; lac--) {
2700 /* convert command line rule # */
2701 fo->last = fo->first = strtoul(*lav++, &endptr, 10);
2703 fo->last = strtoul(endptr + 1, &endptr, 10);
2706 warnx("invalid rule number: %s", *(lav - 1));
2710 if (list_static_range(co, fo, &bp, rbase, rcnt) == 0) {
2711 /* give precedence to other error(s) */
2712 if (exitval == EX_OK)
2713 exitval = EX_UNAVAILABLE;
2714 if (fo->first == fo->last)
2715 warnx("rule %u does not exist", fo->first);
2717 warnx("no rules in range %u-%u",
2718 fo->first, fo->last);
2722 if (co->do_dynamic && dynsz > 0) {
2723 printf("## Dynamic rules:\n");
2724 for (lac = ac, lav = av; lac != 0; lac--) {
2725 fo->last = fo->first = strtoul(*lav++, &endptr, 10);
2727 fo->last = strtoul(endptr+1, &endptr, 10);
2729 /* already warned */
2731 list_dyn_range(co, fo, &bp, dynbase, dynsz);
2741 * Retrieves current ipfw configuration of given type
2742 * and stores its pointer to @pcfg.
2744 * Caller is responsible for freeing @pcfg.
2746 * Returns 0 on success.
2750 ipfw_get_config(struct cmdline_opts *co, struct format_opts *fo,
2751 ipfw_cfg_lheader **pcfg, size_t *psize)
2753 ipfw_cfg_lheader *cfg;
2758 if (co->test_only != 0) {
2759 fprintf(stderr, "Testing only, list disabled\n");
2763 /* Start with some data size */
2767 for (i = 0; i < 16; i++) {
2770 if ((cfg = calloc(1, sz)) == NULL)
2773 cfg->flags = fo->flags;
2774 cfg->start_rule = fo->first;
2775 cfg->end_rule = fo->last;
2777 if (do_get3(IP_FW_XGET, &cfg->opheader, &sz) != 0) {
2778 if (errno != ENOMEM) {
2783 /* Buffer size is not enough. Try to increase */
2800 lookup_host (char *host, struct in_addr *ipaddr)
2804 if (!inet_aton(host, ipaddr)) {
2805 if ((he = gethostbyname(host)) == NULL)
2807 *ipaddr = *(struct in_addr *)he->h_addr_list[0];
2821 ipfw_check_object_name(const char *name)
2826 * Check that name is null-terminated and contains
2827 * valid symbols only. Valid mask is:
2828 * [a-zA-Z0-9\-_\.]{1,63}
2831 if (l == 0 || l >= 64)
2833 for (i = 0; i < l; i++) {
2835 if (isalpha(c) || isdigit(c) || c == '_' ||
2836 c == '-' || c == '.')
2843 static char *default_state_name = "default";
2845 state_check_name(const char *name)
2848 if (ipfw_check_object_name(name) != 0)
2850 if (strcmp(name, "any") == 0)
2856 eaction_check_name(const char *name)
2859 if (ipfw_check_object_name(name) != 0)
2861 /* Restrict some 'special' names */
2862 if (match_token(rule_actions, name) != -1 &&
2863 match_token(rule_action_params, name) != -1)
2869 pack_object(struct tidx *tstate, char *name, int otype)
2872 ipfw_obj_ntlv *ntlv;
2874 for (i = 0; i < tstate->count; i++) {
2875 if (strcmp(tstate->idx[i].name, name) != 0)
2877 if (tstate->idx[i].set != tstate->set)
2879 if (tstate->idx[i].head.type != otype)
2882 return (tstate->idx[i].idx);
2885 if (tstate->count + 1 > tstate->size) {
2887 tstate->idx = realloc(tstate->idx, tstate->size *
2888 sizeof(ipfw_obj_ntlv));
2889 if (tstate->idx == NULL)
2893 ntlv = &tstate->idx[i];
2894 memset(ntlv, 0, sizeof(ipfw_obj_ntlv));
2895 strlcpy(ntlv->name, name, sizeof(ntlv->name));
2896 ntlv->head.type = otype;
2897 ntlv->head.length = sizeof(ipfw_obj_ntlv);
2898 ntlv->set = tstate->set;
2899 ntlv->idx = ++tstate->counter;
2906 pack_table(struct tidx *tstate, char *name)
2909 if (table_check_name(name) != 0)
2912 return (pack_object(tstate, name, IPFW_TLV_TBL_NAME));
2916 fill_table(struct _ipfw_insn *cmd, char *av, uint8_t opcode,
2917 struct tidx *tstate)
2919 uint32_t *d = ((ipfw_insn_u32 *)cmd)->d;
2923 if ((p = strchr(av + 6, ')')) == NULL)
2924 errx(EX_DATAERR, "forgotten parenthesis: '%s'", av);
2926 p = strchr(av + 6, ',');
2930 if ((uidx = pack_table(tstate, av + 6)) == 0)
2931 errx(EX_DATAERR, "Invalid table name: %s", av + 6);
2933 cmd->opcode = opcode;
2936 cmd->len |= F_INSN_SIZE(ipfw_insn_u32);
2937 d[0] = strtoul(p, NULL, 0);
2939 cmd->len |= F_INSN_SIZE(ipfw_insn);
2944 * fills the addr and mask fields in the instruction as appropriate from av.
2945 * Update length as appropriate.
2946 * The following formats are allowed:
2947 * me returns O_IP_*_ME
2948 * 1.2.3.4 single IP address
2949 * 1.2.3.4:5.6.7.8 address:mask
2950 * 1.2.3.4/24 address/mask
2951 * 1.2.3.4/26{1,6,5,4,23} set of addresses in a subnet
2952 * We can have multiple comma-separated address/mask entries.
2955 fill_ip(ipfw_insn_ip *cmd, char *av, int cblen, struct tidx *tstate)
2958 uint32_t *d = ((ipfw_insn_u32 *)cmd)->d;
2960 cmd->o.len &= ~F_LEN_MASK; /* zero len */
2962 if (_substrcmp(av, "any") == 0)
2965 if (_substrcmp(av, "me") == 0) {
2966 cmd->o.len |= F_INSN_SIZE(ipfw_insn);
2970 if (strncmp(av, "table(", 6) == 0) {
2971 fill_table(&cmd->o, av, O_IP_DST_LOOKUP, tstate);
2977 * After the address we can have '/' or ':' indicating a mask,
2978 * ',' indicating another address follows, '{' indicating a
2979 * set of addresses of unspecified size.
2981 char *t = NULL, *p = strpbrk(av, "/:,{");
2985 CHECK_LENGTH(cblen, F_INSN_SIZE(ipfw_insn) + 2 + len);
2990 if ((t = strpbrk(p, ",{")) != NULL) {
2997 if (lookup_host(av, (struct in_addr *)&d[0]) != 0)
2998 errx(EX_NOHOST, "hostname ``%s'' unknown", av);
3001 if (!inet_aton(p, (struct in_addr *)&d[1]))
3002 errx(EX_DATAERR, "bad netmask ``%s''", p);
3007 d[1] = htonl(0U); /* mask */
3008 else if (masklen > 32)
3009 errx(EX_DATAERR, "bad width ``%s''", p);
3011 d[1] = htonl(~0U << (32 - masklen));
3013 case '{': /* no mask, assume /24 and put back the '{' */
3014 d[1] = htonl(~0U << (32 - 24));
3018 case ',': /* single address plus continuation */
3021 case 0: /* initialization value */
3023 d[1] = htonl(~0U); /* force /32 */
3026 d[0] &= d[1]; /* mask base address with mask */
3029 /* find next separator */
3031 p = strpbrk(p, ",{");
3032 if (p && *p == '{') {
3034 * We have a set of addresses. They are stored as follows:
3035 * arg1 is the set size (powers of 2, 2..256)
3036 * addr is the base address IN HOST FORMAT
3037 * mask.. is an array of arg1 bits (rounded up to
3038 * the next multiple of 32) with bits set
3039 * for each host in the map.
3041 uint32_t *map = (uint32_t *)&cmd->mask;
3043 int i = contigmask((uint8_t *)&(d[1]), 32);
3046 errx(EX_DATAERR, "address set cannot be in a list");
3047 if (i < 24 || i > 31)
3048 errx(EX_DATAERR, "invalid set with mask %d\n", i);
3049 cmd->o.arg1 = 1<<(32-i); /* map length */
3050 d[0] = ntohl(d[0]); /* base addr in host format */
3051 cmd->o.opcode = O_IP_DST_SET; /* default */
3052 cmd->o.len |= F_INSN_SIZE(ipfw_insn_u32) + (cmd->o.arg1+31)/32;
3053 for (i = 0; i < (cmd->o.arg1+31)/32 ; i++)
3054 map[i] = 0; /* clear map */
3058 high = low + cmd->o.arg1 - 1;
3060 * Here, i stores the previous value when we specify a range
3061 * of addresses within a mask, e.g. 45-63. i = -1 means we
3062 * have no previous value.
3064 i = -1; /* previous value in a range */
3065 while (isdigit(*av)) {
3067 int a = strtol(av, &s, 0);
3069 if (s == av) { /* no parameter */
3071 errx(EX_DATAERR, "set not closed\n");
3073 errx(EX_DATAERR, "incomplete range %d-", i);
3076 if (a < low || a > high)
3077 errx(EX_DATAERR, "addr %d out of range [%d-%d]\n",
3080 if (i == -1) /* no previous in range */
3082 else { /* check that range is valid */
3084 errx(EX_DATAERR, "invalid range %d-%d",
3087 errx(EX_DATAERR, "double '-' in range");
3090 map[i/32] |= 1<<(i & 31);
3101 if (av) /* then *av must be a ',' */
3104 /* Check this entry */
3105 if (d[1] == 0) { /* "any", specified as x.x.x.x/0 */
3107 * 'any' turns the entire list into a NOP.
3108 * 'not any' never matches, so it is removed from the
3109 * list unless it is the only item, in which case we
3112 if (cmd->o.len & F_NOT) { /* "not any" never matches */
3113 if (av == NULL && len == 0) /* only this entry */
3114 errx(EX_DATAERR, "not any never matches");
3116 /* else do nothing and skip this entry */
3119 /* A single IP can be stored in an optimized format */
3120 if (d[1] == (uint32_t)~0 && av == NULL && len == 0) {
3121 cmd->o.len |= F_INSN_SIZE(ipfw_insn_u32);
3124 len += 2; /* two words... */
3127 if (len + 1 > F_LEN_MASK)
3128 errx(EX_DATAERR, "address list too long");
3129 cmd->o.len |= len+1;
3133 /* n2mask sets n bits of the mask */
3135 n2mask(struct in6_addr *mask, int n)
3137 static int minimask[9] =
3138 { 0x00, 0x80, 0xc0, 0xe0, 0xf0, 0xf8, 0xfc, 0xfe, 0xff };
3141 memset(mask, 0, sizeof(struct in6_addr));
3142 p = (u_char *) mask;
3143 for (; n > 0; p++, n -= 8) {
3153 fill_flags_cmd(ipfw_insn *cmd, enum ipfw_opcodes opcode,
3154 struct _s_x *flags, char *p)
3157 uint32_t set = 0, clear = 0;
3159 if (fill_flags(flags, p, &e, &set, &clear) != 0)
3160 errx(EX_DATAERR, "invalid flag %s", e);
3162 cmd->opcode = opcode;
3163 cmd->len = (cmd->len & (F_NOT | F_OR)) | 1;
3164 cmd->arg1 = (set & 0xff) | ( (clear & 0xff) << 8);
3169 ipfw_delete(char *av[])
3172 int exitval = EX_OK;
3178 NEED1("missing rule specification");
3179 memset(&rt, 0, sizeof(rt));
3180 if ( *av && _substrcmp(*av, "set") == 0) {
3181 /* Do not allow using the following syntax:
3182 * ipfw set N delete set M
3185 errx(EX_DATAERR, "invalid syntax");
3186 do_set = 1; /* delete set */
3191 while (*av && isdigit(**av)) {
3192 i = strtol(*av, &sep, 10);
3195 j = strtol(sep + 1, NULL, 10);
3198 exitval = do_cmd(IP_FW_NAT_DEL, &i, sizeof i);
3200 exitval = EX_UNAVAILABLE;
3201 warn("rule %u not available", i);
3203 } else if (co.do_pipe) {
3204 exitval = ipfw_delete_pipe(co.do_pipe, i);
3208 rt.flags = IPFW_RCFLAG_SET;
3210 rt.start_rule = i & 0xffff;
3211 rt.end_rule = j & 0xffff;
3212 if (rt.start_rule == 0 && rt.end_rule == 0)
3213 rt.flags |= IPFW_RCFLAG_ALL;
3215 rt.flags |= IPFW_RCFLAG_RANGE;
3216 if (co.use_set != 0) {
3217 rt.set = co.use_set - 1;
3218 rt.flags |= IPFW_RCFLAG_SET;
3221 i = do_range_cmd(IP_FW_XDEL, &rt);
3223 exitval = EX_UNAVAILABLE;
3224 warn("rule %u: setsockopt(IP_FW_XDEL)",
3226 } else if (rt.new_set == 0 && do_set == 0) {
3227 exitval = EX_UNAVAILABLE;
3228 if (rt.start_rule != rt.end_rule)
3229 warnx("no rules rules in %u-%u range",
3230 rt.start_rule, rt.end_rule);
3232 warnx("rule %u not found",
3237 if (exitval != EX_OK)
3243 * fill the interface structure. We do not check the name as we can
3244 * create interfaces dynamically, so checking them at insert time
3245 * makes relatively little sense.
3246 * Interface names containing '*', '?', or '[' are assumed to be shell
3247 * patterns which match interfaces.
3250 fill_iface(ipfw_insn_if *cmd, char *arg, int cblen, struct tidx *tstate)
3255 cmd->name[0] = '\0';
3256 cmd->o.len |= F_INSN_SIZE(ipfw_insn_if);
3260 /* Parse the interface or address */
3261 if (strcmp(arg, "any") == 0)
3262 cmd->o.len = 0; /* effectively ignore this command */
3263 else if (strncmp(arg, "table(", 6) == 0) {
3264 if ((p = strchr(arg + 6, ')')) == NULL)
3265 errx(EX_DATAERR, "forgotten parenthesis: '%s'", arg);
3267 p = strchr(arg + 6, ',');
3270 if ((uidx = pack_table(tstate, arg + 6)) == 0)
3271 errx(EX_DATAERR, "Invalid table name: %s", arg + 6);
3273 cmd->name[0] = '\1'; /* Special value indicating table */
3275 } else if (!isdigit(*arg)) {
3276 strlcpy(cmd->name, arg, sizeof(cmd->name));
3277 cmd->p.glob = strpbrk(arg, "*?[") != NULL ? 1 : 0;
3278 } else if (!inet_aton(arg, &cmd->p.ip))
3279 errx(EX_DATAERR, "bad ip address ``%s''", arg);
3283 get_mac_addr_mask(const char *p, uint8_t *addr, uint8_t *mask)
3287 char *ap, *ptr, *optr;
3288 struct ether_addr *mac;
3289 const char *macset = "0123456789abcdefABCDEF:";
3291 if (strcmp(p, "any") == 0) {
3292 for (i = 0; i < ETHER_ADDR_LEN; i++)
3293 addr[i] = mask[i] = 0;
3297 optr = ptr = strdup(p);
3298 if ((ap = strsep(&ptr, "&/")) != NULL && *ap != 0) {
3300 if (strspn(ap, macset) != l || (mac = ether_aton(ap)) == NULL)
3301 errx(EX_DATAERR, "Incorrect MAC address");
3302 bcopy(mac, addr, ETHER_ADDR_LEN);
3304 errx(EX_DATAERR, "Incorrect MAC address");
3306 if (ptr != NULL) { /* we have mask? */
3307 if (p[ptr - optr - 1] == '/') { /* mask len */
3308 long ml = strtol(ptr, &ap, 10);
3309 if (*ap != 0 || ml > ETHER_ADDR_LEN * 8 || ml < 0)
3310 errx(EX_DATAERR, "Incorrect mask length");
3311 for (i = 0; ml > 0 && i < ETHER_ADDR_LEN; ml -= 8, i++)
3312 mask[i] = (ml >= 8) ? 0xff: (~0) << (8 - ml);
3315 if (strspn(ptr, macset) != l ||
3316 (mac = ether_aton(ptr)) == NULL)
3317 errx(EX_DATAERR, "Incorrect mask");
3318 bcopy(mac, mask, ETHER_ADDR_LEN);
3320 } else { /* default mask: ff:ff:ff:ff:ff:ff */
3321 for (i = 0; i < ETHER_ADDR_LEN; i++)
3324 for (i = 0; i < ETHER_ADDR_LEN; i++)
3331 * helper function, updates the pointer to cmd with the length
3332 * of the current command, and also cleans up the first word of
3333 * the new command in case it has been clobbered before.
3336 next_cmd(ipfw_insn *cmd, int *len)
3339 CHECK_LENGTH(*len, 0);
3341 bzero(cmd, sizeof(*cmd));
3346 * Takes arguments and copies them into a comment
3349 fill_comment(ipfw_insn *cmd, char **av, int cblen)
3352 char *p = (char *)(cmd + 1);
3354 cmd->opcode = O_NOP;
3355 cmd->len = (cmd->len & (F_NOT | F_OR));
3357 /* Compute length of comment string. */
3358 for (i = 0, l = 0; av[i] != NULL; i++)
3359 l += strlen(av[i]) + 1;
3364 "comment too long (max 80 chars)");
3366 cmd->len = (cmd->len & (F_NOT | F_OR)) | l;
3369 for (i = 0; av[i] != NULL; i++) {
3378 * A function to fill simple commands of size 1.
3379 * Existing flags are preserved.
3382 fill_cmd(ipfw_insn *cmd, enum ipfw_opcodes opcode, int flags, uint16_t arg)
3384 cmd->opcode = opcode;
3385 cmd->len = ((cmd->len | flags) & (F_NOT | F_OR)) | 1;
3390 * Fetch and add the MAC address and type, with masks. This generates one or
3391 * two microinstructions, and returns the pointer to the last one.
3394 add_mac(ipfw_insn *cmd, char *av[], int cblen)
3398 if ( ( av[0] == NULL ) || ( av[1] == NULL ) )
3399 errx(EX_DATAERR, "MAC dst src");
3401 cmd->opcode = O_MACADDR2;
3402 cmd->len = (cmd->len & (F_NOT | F_OR)) | F_INSN_SIZE(ipfw_insn_mac);
3405 mac = (ipfw_insn_mac *)cmd;
3406 get_mac_addr_mask(av[0], mac->addr, mac->mask); /* dst */
3407 get_mac_addr_mask(av[1], &(mac->addr[ETHER_ADDR_LEN]),
3408 &(mac->mask[ETHER_ADDR_LEN])); /* src */
3413 add_mactype(ipfw_insn *cmd, char *av, int cblen)
3416 errx(EX_DATAERR, "missing MAC type");
3417 if (strcmp(av, "any") != 0) { /* we have a non-null type */
3418 fill_newports((ipfw_insn_u16 *)cmd, av, IPPROTO_ETHERTYPE,
3420 cmd->opcode = O_MAC_TYPE;
3427 add_proto0(ipfw_insn *cmd, char *av, u_char *protop)
3429 struct protoent *pe;
3433 proto = strtol(av, &ep, 10);
3434 if (*ep != '\0' || proto <= 0) {
3435 if ((pe = getprotobyname(av)) == NULL)
3437 proto = pe->p_proto;
3440 fill_cmd(cmd, O_PROTO, 0, proto);
3446 add_proto(ipfw_insn *cmd, char *av, u_char *protop)
3448 u_char proto = IPPROTO_IP;
3450 if (_substrcmp(av, "all") == 0 || strcmp(av, "ip") == 0)
3451 ; /* do not set O_IP4 nor O_IP6 */
3452 else if (strcmp(av, "ip4") == 0)
3453 /* explicit "just IPv4" rule */
3454 fill_cmd(cmd, O_IP4, 0, 0);
3455 else if (strcmp(av, "ip6") == 0) {
3456 /* explicit "just IPv6" rule */
3457 proto = IPPROTO_IPV6;
3458 fill_cmd(cmd, O_IP6, 0, 0);
3460 return add_proto0(cmd, av, protop);
3467 add_proto_compat(ipfw_insn *cmd, char *av, u_char *protop)
3469 u_char proto = IPPROTO_IP;
3471 if (_substrcmp(av, "all") == 0 || strcmp(av, "ip") == 0)
3472 ; /* do not set O_IP4 nor O_IP6 */
3473 else if (strcmp(av, "ipv4") == 0 || strcmp(av, "ip4") == 0)
3474 /* explicit "just IPv4" rule */
3475 fill_cmd(cmd, O_IP4, 0, 0);
3476 else if (strcmp(av, "ipv6") == 0 || strcmp(av, "ip6") == 0) {
3477 /* explicit "just IPv6" rule */
3478 proto = IPPROTO_IPV6;
3479 fill_cmd(cmd, O_IP6, 0, 0);
3481 return add_proto0(cmd, av, protop);
3488 add_srcip(ipfw_insn *cmd, char *av, int cblen, struct tidx *tstate)
3490 fill_ip((ipfw_insn_ip *)cmd, av, cblen, tstate);
3491 if (cmd->opcode == O_IP_DST_SET) /* set */
3492 cmd->opcode = O_IP_SRC_SET;
3493 else if (cmd->opcode == O_IP_DST_LOOKUP) /* table */
3494 cmd->opcode = O_IP_SRC_LOOKUP;
3495 else if (F_LEN(cmd) == F_INSN_SIZE(ipfw_insn)) /* me */
3496 cmd->opcode = O_IP_SRC_ME;
3497 else if (F_LEN(cmd) == F_INSN_SIZE(ipfw_insn_u32)) /* one IP */
3498 cmd->opcode = O_IP_SRC;
3499 else /* addr/mask */
3500 cmd->opcode = O_IP_SRC_MASK;
3505 add_dstip(ipfw_insn *cmd, char *av, int cblen, struct tidx *tstate)
3507 fill_ip((ipfw_insn_ip *)cmd, av, cblen, tstate);
3508 if (cmd->opcode == O_IP_DST_SET) /* set */
3510 else if (cmd->opcode == O_IP_DST_LOOKUP) /* table */
3512 else if (F_LEN(cmd) == F_INSN_SIZE(ipfw_insn)) /* me */
3513 cmd->opcode = O_IP_DST_ME;
3514 else if (F_LEN(cmd) == F_INSN_SIZE(ipfw_insn_u32)) /* one IP */
3515 cmd->opcode = O_IP_DST;
3516 else /* addr/mask */
3517 cmd->opcode = O_IP_DST_MASK;
3521 static struct _s_x f_reserved_keywords[] = {
3524 { "diverted", TOK_OR },
3525 { "dst-port", TOK_OR },
3526 { "src-port", TOK_OR },
3527 { "established", TOK_OR },
3528 { "keep-state", TOK_OR },
3530 { "icmptypes", TOK_OR },
3538 { NULL, 0 } /* terminator */
3542 add_ports(ipfw_insn *cmd, char *av, u_char proto, int opcode, int cblen)
3545 if (match_token(f_reserved_keywords, av) != -1)
3548 if (fill_newports((ipfw_insn_u16 *)cmd, av, proto, cblen)) {
3549 /* XXX todo: check that we have a protocol with ports */
3550 cmd->opcode = opcode;
3557 add_src(ipfw_insn *cmd, char *av, u_char proto, int cblen, struct tidx *tstate)
3560 char *host, *ch, buf[INET6_ADDRSTRLEN];
3561 ipfw_insn *ret = NULL;
3564 /* Copy first address in set if needed */
3565 if ((ch = strpbrk(av, "/,")) != NULL) {
3567 strlcpy(buf, av, sizeof(buf));
3568 if (len < sizeof(buf))
3574 if (proto == IPPROTO_IPV6 || strcmp(av, "me6") == 0 ||
3575 inet_pton(AF_INET6, host, &a) == 1)
3576 ret = add_srcip6(cmd, av, cblen, tstate);
3577 /* XXX: should check for IPv4, not !IPv6 */
3578 if (ret == NULL && (proto == IPPROTO_IP || strcmp(av, "me") == 0 ||
3579 inet_pton(AF_INET6, host, &a) != 1))
3580 ret = add_srcip(cmd, av, cblen, tstate);
3581 if (ret == NULL && strcmp(av, "any") != 0)
3588 add_dst(ipfw_insn *cmd, char *av, u_char proto, int cblen, struct tidx *tstate)
3591 char *host, *ch, buf[INET6_ADDRSTRLEN];
3592 ipfw_insn *ret = NULL;
3595 /* Copy first address in set if needed */
3596 if ((ch = strpbrk(av, "/,")) != NULL) {
3598 strlcpy(buf, av, sizeof(buf));
3599 if (len < sizeof(buf))
3605 if (proto == IPPROTO_IPV6 || strcmp(av, "me6") == 0 ||
3606 inet_pton(AF_INET6, host, &a) == 1)
3607 ret = add_dstip6(cmd, av, cblen, tstate);
3608 /* XXX: should check for IPv4, not !IPv6 */
3609 if (ret == NULL && (proto == IPPROTO_IP || strcmp(av, "me") == 0 ||
3610 inet_pton(AF_INET6, host, &a) != 1))
3611 ret = add_dstip(cmd, av, cblen, tstate);
3612 if (ret == NULL && strcmp(av, "any") != 0)
3619 * Parse arguments and assemble the microinstructions which make up a rule.
3620 * Rules are added into the 'rulebuf' and then copied in the correct order
3621 * into the actual rule.
3623 * The syntax for a rule starts with the action, followed by
3624 * optional action parameters, and the various match patterns.
3625 * In the assembled microcode, the first opcode must be an O_PROBE_STATE
3626 * (generated if the rule includes a keep-state option), then the
3627 * various match patterns, log/altq actions, and the actual action.
3631 compile_rule(char *av[], uint32_t *rbuf, int *rbufsize, struct tidx *tstate)
3634 * rules are added into the 'rulebuf' and then copied in
3635 * the correct order into the actual rule.
3636 * Some things that need to go out of order (prob, action etc.)
3639 static uint32_t actbuf[255], cmdbuf[255];
3640 int rblen, ablen, cblen;
3642 ipfw_insn *src, *dst, *cmd, *action, *prev=NULL;
3643 ipfw_insn *first_cmd; /* first match pattern */
3645 struct ip_fw_rule *rule;
3648 * various flags used to record that we entered some fields.
3650 ipfw_insn *have_state = NULL; /* check-state or keep-state */
3651 ipfw_insn *have_log = NULL, *have_altq = NULL, *have_tag = NULL;
3656 int open_par = 0; /* open parenthesis ( */
3658 /* proto is here because it is used to fetch ports */
3659 u_char proto = IPPROTO_IP; /* default protocol */
3661 double match_prob = 1; /* match probability, default is always match */
3663 bzero(actbuf, sizeof(actbuf)); /* actions go here */
3664 bzero(cmdbuf, sizeof(cmdbuf));
3665 bzero(rbuf, *rbufsize);
3667 rule = (struct ip_fw_rule *)rbuf;
3668 cmd = (ipfw_insn *)cmdbuf;
3669 action = (ipfw_insn *)actbuf;
3671 rblen = *rbufsize / sizeof(uint32_t);
3672 rblen -= sizeof(struct ip_fw_rule) / sizeof(uint32_t);
3673 ablen = sizeof(actbuf) / sizeof(actbuf[0]);
3674 cblen = sizeof(cmdbuf) / sizeof(cmdbuf[0]);
3675 cblen -= F_INSN_SIZE(ipfw_insn_u32) + 1;
3677 #define CHECK_RBUFLEN(len) { CHECK_LENGTH(rblen, len); rblen -= len; }
3678 #define CHECK_ACTLEN CHECK_LENGTH(ablen, action->len)
3682 /* [rule N] -- Rule number optional */
3683 if (av[0] && isdigit(**av)) {
3684 rule->rulenum = atoi(*av);
3688 /* [set N] -- set number (0..RESVD_SET), optional */
3689 if (av[0] && av[1] && _substrcmp(*av, "set") == 0) {
3690 int set = strtoul(av[1], NULL, 10);
3691 if (set < 0 || set > RESVD_SET)
3692 errx(EX_DATAERR, "illegal set %s", av[1]);
3698 /* [prob D] -- match probability, optional */
3699 if (av[0] && av[1] && _substrcmp(*av, "prob") == 0) {
3700 match_prob = strtod(av[1], NULL);
3702 if (match_prob <= 0 || match_prob > 1)
3703 errx(EX_DATAERR, "illegal match prob. %s", av[1]);
3707 /* action -- mandatory */
3708 NEED1("missing action");
3709 i = match_token(rule_actions, *av);
3711 action->len = 1; /* default */
3714 case TOK_CHECKSTATE:
3715 have_state = action;
3716 action->opcode = O_CHECK_STATE;
3718 match_token(rule_options, *av) == TOK_COMMENT) {
3719 action->arg1 = pack_object(tstate,
3720 default_state_name, IPFW_TLV_STATE_NAME);
3723 if (*av[0] == ':') {
3724 if (strcmp(*av + 1, "any") == 0)
3726 else if (state_check_name(*av + 1) == 0)
3727 action->arg1 = pack_object(tstate, *av + 1,
3728 IPFW_TLV_STATE_NAME);
3730 errx(EX_DATAERR, "Invalid state name %s",
3735 errx(EX_DATAERR, "Invalid state name %s", *av);
3739 action->opcode = O_ACCEPT;
3743 action->opcode = O_DENY;
3748 action->opcode = O_REJECT;
3749 action->arg1 = ICMP_UNREACH_HOST;
3753 action->opcode = O_REJECT;
3754 action->arg1 = ICMP_REJECT_RST;
3758 action->opcode = O_UNREACH6;
3759 action->arg1 = ICMP6_UNREACH_RST;
3763 action->opcode = O_REJECT;
3764 NEED1("missing reject code");
3765 fill_reject_code(&action->arg1, *av);
3770 action->opcode = O_UNREACH6;
3771 NEED1("missing unreach code");
3772 fill_unreach6_code(&action->arg1, *av);
3777 action->opcode = O_COUNT;
3781 action->opcode = O_NAT;
3782 action->len = F_INSN_SIZE(ipfw_insn_nat);
3784 if (*av != NULL && _substrcmp(*av, "global") == 0) {
3785 action->arg1 = IP_FW_NAT44_GLOBAL;
3791 action->opcode = O_QUEUE;
3794 action->opcode = O_PIPE;
3797 action->opcode = O_SKIPTO;
3800 action->opcode = O_NETGRAPH;
3803 action->opcode = O_NGTEE;
3806 action->opcode = O_DIVERT;
3809 action->opcode = O_TEE;
3812 action->opcode = O_CALLRETURN;
3815 errx(EX_USAGE, "missing argument for %s", *(av - 1));
3816 if (isdigit(**av)) {
3817 action->arg1 = strtoul(*av, NULL, 10);
3818 if (action->arg1 <= 0 || action->arg1 >= IP_FW_TABLEARG)
3819 errx(EX_DATAERR, "illegal argument for %s",
3821 } else if (_substrcmp(*av, "tablearg") == 0) {
3822 action->arg1 = IP_FW_TARG;
3823 } else if (i == TOK_DIVERT || i == TOK_TEE) {
3826 s = getservbyname(av[0], "divert");
3828 action->arg1 = ntohs(s->s_port);
3830 errx(EX_DATAERR, "illegal divert/tee port");
3832 errx(EX_DATAERR, "illegal argument for %s", *(av - 1));
3838 * Locate the address-port separator (':' or ',').
3839 * Could be one of the following:
3843 * IPv6 w:x:y::z,port
3844 * The ':' can only be used with hostname and IPv4 address.
3845 * XXX-BZ Should we also support [w:x:y::z]:port?
3847 struct sockaddr_storage result;
3848 struct addrinfo *res;
3851 u_short port_number;
3853 NEED1("missing forward address[:port]");
3856 * locate the address-port separator (':' or ',')
3858 s = strchr(*av, ',');
3860 /* Distinguish between IPv4:port and IPv6 cases. */
3861 s = strchr(*av, ':');
3862 if (s && strchr(s+1, ':'))
3863 s = NULL; /* no port */
3868 /* Terminate host portion and set s to start of port. */
3870 i = strtoport(s, &end, 0 /* base */, 0 /* proto */);
3873 "illegal forwarding port ``%s''", s);
3874 port_number = (u_short)i;
3877 if (_substrcmp(*av, "tablearg") == 0) {
3879 ((struct sockaddr_in*)&result)->sin_addr.s_addr =
3883 * Resolve the host name or address to a family and a
3884 * network representation of the address.
3886 if (getaddrinfo(*av, NULL, NULL, &res))
3887 errx(EX_DATAERR, NULL);
3888 /* Just use the first host in the answer. */
3889 family = res->ai_family;
3890 memcpy(&result, res->ai_addr, res->ai_addrlen);
3894 if (family == PF_INET) {
3895 ipfw_insn_sa *p = (ipfw_insn_sa *)action;
3897 action->opcode = O_FORWARD_IP;
3898 action->len = F_INSN_SIZE(ipfw_insn_sa);
3902 * In the kernel we assume AF_INET and use only
3903 * sin_port and sin_addr. Remember to set sin_len as
3904 * the routing code seems to use it too.
3906 p->sa.sin_len = sizeof(struct sockaddr_in);
3907 p->sa.sin_family = AF_INET;
3908 p->sa.sin_port = port_number;
3909 p->sa.sin_addr.s_addr =
3910 ((struct sockaddr_in *)&result)->sin_addr.s_addr;
3911 } else if (family == PF_INET6) {
3912 ipfw_insn_sa6 *p = (ipfw_insn_sa6 *)action;
3914 action->opcode = O_FORWARD_IP6;
3915 action->len = F_INSN_SIZE(ipfw_insn_sa6);
3918 p->sa.sin6_len = sizeof(struct sockaddr_in6);
3919 p->sa.sin6_family = AF_INET6;
3920 p->sa.sin6_port = port_number;
3921 p->sa.sin6_flowinfo = 0;
3922 p->sa.sin6_scope_id =
3923 ((struct sockaddr_in6 *)&result)->sin6_scope_id;
3924 bcopy(&((struct sockaddr_in6*)&result)->sin6_addr,
3925 &p->sa.sin6_addr, sizeof(p->sa.sin6_addr));
3927 errx(EX_DATAERR, "Invalid address family in forward action");
3933 /* pretend it is a 'count' rule followed by the comment */
3934 action->opcode = O_COUNT;
3935 av--; /* go back... */
3941 size_t intsize = sizeof(int);
3943 action->opcode = O_SETFIB;
3944 NEED1("missing fib number");
3945 if (_substrcmp(*av, "tablearg") == 0) {
3946 action->arg1 = IP_FW_TARG;
3948 action->arg1 = strtoul(*av, NULL, 10);
3949 if (sysctlbyname("net.fibs", &numfibs, &intsize,
3951 errx(EX_DATAERR, "fibs not suported.\n");
3952 if (action->arg1 >= numfibs) /* Temporary */
3953 errx(EX_DATAERR, "fib too large.\n");
3954 /* Add high-order bit to fib to make room for tablearg*/
3955 action->arg1 |= 0x8000;
3965 action->opcode = O_SETDSCP;
3966 NEED1("missing DSCP code");
3967 if (_substrcmp(*av, "tablearg") == 0) {
3968 action->arg1 = IP_FW_TARG;
3970 if (isalpha(*av[0])) {
3971 if ((code = match_token(f_ipdscp, *av)) == -1)
3972 errx(EX_DATAERR, "Unknown DSCP code");
3973 action->arg1 = code;
3975 action->arg1 = strtoul(*av, NULL, 10);
3977 * Add high-order bit to DSCP to make room
3980 action->arg1 |= 0x8000;
3987 action->opcode = O_REASS;
3991 fill_cmd(action, O_CALLRETURN, F_NOT, 0);
3996 if (match_token(rule_eactions, *av) == -1)
3997 errx(EX_DATAERR, "invalid action %s\n", *av);
3999 * External actions support.
4000 * XXX: we support only syntax with instance name.
4001 * For known external actions (from rule_eactions list)
4002 * we can handle syntax directly. But with `eaction'
4003 * keyword we can use only `eaction <name> <instance>'
4009 NEED1("Missing eaction name");
4010 if (eaction_check_name(*av) != 0)
4011 errx(EX_DATAERR, "Invalid eaction name %s", *av);
4012 idx = pack_object(tstate, *av, IPFW_TLV_EACTION);
4014 errx(EX_DATAERR, "pack_object failed");
4015 fill_cmd(action, O_EXTERNAL_ACTION, 0, idx);
4017 NEED1("Missing eaction instance name");
4018 action = next_cmd(action, &ablen);
4021 if (eaction_check_name(*av) != 0)
4022 errx(EX_DATAERR, "Invalid eaction instance name %s",
4025 * External action instance object has TLV type depended
4026 * from the external action name object index. Since we
4027 * currently don't know this index, use zero as TLV type.
4029 idx = pack_object(tstate, *av, 0);
4031 errx(EX_DATAERR, "pack_object failed");
4032 fill_cmd(action, O_EXTERNAL_INSTANCE, 0, idx);
4036 action = next_cmd(action, &ablen);
4039 * [altq queuename] -- altq tag, optional
4040 * [log [logamount N]] -- log, optional
4042 * If they exist, it go first in the cmdbuf, but then it is
4043 * skipped in the copy section to the end of the buffer.
4045 while (av[0] != NULL && (i = match_token(rule_action_params, *av)) != -1) {
4050 ipfw_insn_log *c = (ipfw_insn_log *)cmd;
4055 "log cannot be specified more than once");
4056 have_log = (ipfw_insn *)c;
4057 cmd->len = F_INSN_SIZE(ipfw_insn_log);
4059 cmd->opcode = O_LOG;
4060 if (av[0] && _substrcmp(*av, "logamount") == 0) {
4062 NEED1("logamount requires argument");
4066 "logamount must be positive");
4070 len = sizeof(c->max_log);
4071 if (sysctlbyname("net.inet.ip.fw.verbose_limit",
4072 &c->max_log, &len, NULL, 0) == -1) {
4077 errx(1, "sysctlbyname(\"%s\")",
4078 "net.inet.ip.fw.verbose_limit");
4087 ipfw_insn_altq *a = (ipfw_insn_altq *)cmd;
4089 NEED1("missing altq queue name");
4092 "altq cannot be specified more than once");
4093 have_altq = (ipfw_insn *)a;
4094 cmd->len = F_INSN_SIZE(ipfw_insn_altq);
4096 cmd->opcode = O_ALTQ;
4097 a->qid = altq_name_to_qid(*av);
4108 errx(EX_USAGE, "tag and untag cannot be "
4109 "specified more than once");
4110 GET_UINT_ARG(tag, IPFW_ARG_MIN, IPFW_ARG_MAX, i,
4111 rule_action_params);
4113 fill_cmd(cmd, O_TAG, (i == TOK_TAG) ? 0: F_NOT, tag);
4121 cmd = next_cmd(cmd, &cblen);
4124 if (have_state) { /* must be a check-state, we are done */
4126 match_token(rule_options, *av) == TOK_COMMENT) {
4127 /* check-state has a comment */
4129 fill_comment(cmd, av, cblen);
4130 cmd = next_cmd(cmd, &cblen);
4136 #define OR_START(target) \
4137 if (av[0] && (*av[0] == '(' || *av[0] == '{')) { \
4139 errx(EX_USAGE, "nested \"(\" not allowed\n"); \
4142 if ( (av[0])[1] == '\0') { \
4153 strcmp(*av, ")") == 0 || \
4154 strcmp(*av, "}") == 0)) { \
4159 errx(EX_USAGE, "missing \")\"\n"); \
4163 if (av[0] && _substrcmp(*av, "not") == 0) { \
4164 if (cmd->len & F_NOT) \
4165 errx(EX_USAGE, "double \"not\" not allowed\n"); \
4166 cmd->len |= F_NOT; \
4170 #define OR_BLOCK(target) \
4171 if (av[0] && _substrcmp(*av, "or") == 0) { \
4172 if (prev == NULL || open_par == 0) \
4173 errx(EX_DATAERR, "invalid OR block"); \
4174 prev->len |= F_OR; \
4184 * MAC addresses, optional.
4185 * If we have this, we skip the part "proto from src to dst"
4186 * and jump straight to the option parsing.
4189 NEED1("missing protocol");
4190 if (_substrcmp(*av, "MAC") == 0 ||
4191 _substrcmp(*av, "mac") == 0) {
4192 av++; /* the "MAC" keyword */
4193 add_mac(cmd, av); /* exits in case of errors */
4194 cmd = next_cmd(cmd);
4195 av += 2; /* dst-mac and src-mac */
4197 NEED1("missing mac type");
4198 if (add_mactype(cmd, av[0]))
4199 cmd = next_cmd(cmd);
4200 av++; /* any or mac-type */
4206 * protocol, mandatory
4208 OR_START(get_proto);
4210 NEED1("missing protocol");
4211 if (add_proto_compat(cmd, *av, &proto)) {
4213 if (F_LEN(cmd) != 0) {
4215 cmd = next_cmd(cmd, &cblen);
4217 } else if (first_cmd != cmd) {
4218 errx(EX_DATAERR, "invalid protocol ``%s''", *av);
4221 OR_BLOCK(get_proto);
4226 if ((av[0] == NULL) || _substrcmp(*av, "from") != 0)
4227 errx(EX_USAGE, "missing ``from''");
4231 * source IP, mandatory
4233 OR_START(source_ip);
4234 NOT_BLOCK; /* optional "not" */
4235 NEED1("missing source address");
4236 if (add_src(cmd, *av, proto, cblen, tstate)) {
4238 if (F_LEN(cmd) != 0) { /* ! any */
4240 cmd = next_cmd(cmd, &cblen);
4243 errx(EX_USAGE, "bad source address %s", *av);
4244 OR_BLOCK(source_ip);
4247 * source ports, optional
4249 NOT_BLOCK; /* optional "not" */
4250 if ( av[0] != NULL ) {
4251 if (_substrcmp(*av, "any") == 0 ||
4252 add_ports(cmd, *av, proto, O_IP_SRCPORT, cblen)) {
4254 if (F_LEN(cmd) != 0)
4255 cmd = next_cmd(cmd, &cblen);
4262 if ( (av[0] == NULL) || _substrcmp(*av, "to") != 0 )
4263 errx(EX_USAGE, "missing ``to''");
4267 * destination, mandatory
4270 NOT_BLOCK; /* optional "not" */
4271 NEED1("missing dst address");
4272 if (add_dst(cmd, *av, proto, cblen, tstate)) {
4274 if (F_LEN(cmd) != 0) { /* ! any */
4276 cmd = next_cmd(cmd, &cblen);
4279 errx( EX_USAGE, "bad destination address %s", *av);
4283 * dest. ports, optional
4285 NOT_BLOCK; /* optional "not" */
4287 if (_substrcmp(*av, "any") == 0 ||
4288 add_ports(cmd, *av, proto, O_IP_DSTPORT, cblen)) {
4290 if (F_LEN(cmd) != 0)
4291 cmd = next_cmd(cmd, &cblen);
4296 if (av[0] && first_cmd == cmd) {
4298 * nothing specified so far, store in the rule to ease
4301 rule->flags |= IPFW_RULE_NOOPT;
4304 while ( av[0] != NULL ) {
4306 ipfw_insn_u32 *cmd32; /* alias for cmd */
4309 cmd32 = (ipfw_insn_u32 *)cmd;
4311 if (*s == '!') { /* alternate syntax for NOT */
4312 if (cmd->len & F_NOT)
4313 errx(EX_USAGE, "double \"not\" not allowed\n");
4317 i = match_token(rule_options, s);
4321 if (cmd->len & F_NOT)
4322 errx(EX_USAGE, "double \"not\" not allowed\n");
4327 if (open_par == 0 || prev == NULL)
4328 errx(EX_USAGE, "invalid \"or\" block\n");
4332 case TOK_STARTBRACE:
4334 errx(EX_USAGE, "+nested \"(\" not allowed\n");
4340 errx(EX_USAGE, "+missing \")\"\n");
4346 fill_cmd(cmd, O_IN, 0, 0);
4350 cmd->len ^= F_NOT; /* toggle F_NOT */
4351 fill_cmd(cmd, O_IN, 0, 0);
4355 fill_cmd(cmd, O_DIVERTED, 0, 3);
4358 case TOK_DIVERTEDLOOPBACK:
4359 fill_cmd(cmd, O_DIVERTED, 0, 1);
4362 case TOK_DIVERTEDOUTPUT:
4363 fill_cmd(cmd, O_DIVERTED, 0, 2);
4367 fill_cmd(cmd, O_FRAG, 0, 0);
4371 fill_cmd(cmd, O_LAYER2, 0, 0);
4377 NEED1("recv, xmit, via require interface name"
4379 fill_iface((ipfw_insn_if *)cmd, av[0], cblen, tstate);
4381 if (F_LEN(cmd) == 0) /* not a valid address */
4384 cmd->opcode = O_XMIT;
4385 else if (i == TOK_RECV)
4386 cmd->opcode = O_RECV;
4387 else if (i == TOK_VIA)
4388 cmd->opcode = O_VIA;
4392 NEED1("icmptypes requires list of types");
4393 fill_icmptypes((ipfw_insn_u32 *)cmd, *av);
4397 case TOK_ICMP6TYPES:
4398 NEED1("icmptypes requires list of types");
4399 fill_icmp6types((ipfw_insn_icmp6 *)cmd, *av, cblen);
4404 NEED1("ipttl requires TTL");
4405 if (strpbrk(*av, "-,")) {
4406 if (!add_ports(cmd, *av, 0, O_IPTTL, cblen))
4407 errx(EX_DATAERR, "invalid ipttl %s", *av);
4409 fill_cmd(cmd, O_IPTTL, 0, strtoul(*av, NULL, 0));
4414 NEED1("ipid requires id");
4415 if (strpbrk(*av, "-,")) {
4416 if (!add_ports(cmd, *av, 0, O_IPID, cblen))
4417 errx(EX_DATAERR, "invalid ipid %s", *av);
4419 fill_cmd(cmd, O_IPID, 0, strtoul(*av, NULL, 0));
4424 NEED1("iplen requires length");
4425 if (strpbrk(*av, "-,")) {
4426 if (!add_ports(cmd, *av, 0, O_IPLEN, cblen))
4427 errx(EX_DATAERR, "invalid ip len %s", *av);
4429 fill_cmd(cmd, O_IPLEN, 0, strtoul(*av, NULL, 0));
4434 NEED1("ipver requires version");
4435 fill_cmd(cmd, O_IPVER, 0, strtoul(*av, NULL, 0));
4439 case TOK_IPPRECEDENCE:
4440 NEED1("ipprecedence requires value");
4441 fill_cmd(cmd, O_IPPRECEDENCE, 0,
4442 (strtoul(*av, NULL, 0) & 7) << 5);
4447 NEED1("missing DSCP code");
4448 fill_dscp(cmd, *av, cblen);
4453 NEED1("missing argument for ipoptions");
4454 fill_flags_cmd(cmd, O_IPOPT, f_ipopts, *av);
4459 NEED1("missing argument for iptos");
4460 fill_flags_cmd(cmd, O_IPTOS, f_iptos, *av);
4465 NEED1("uid requires argument");
4471 cmd->opcode = O_UID;
4472 uid = strtoul(*av, &end, 0);
4473 pwd = (*end == '\0') ? getpwuid(uid) : getpwnam(*av);
4475 errx(EX_DATAERR, "uid \"%s\" nonexistent", *av);
4476 cmd32->d[0] = pwd->pw_uid;
4477 cmd->len |= F_INSN_SIZE(ipfw_insn_u32);
4483 NEED1("gid requires argument");
4489 cmd->opcode = O_GID;
4490 gid = strtoul(*av, &end, 0);
4491 grp = (*end == '\0') ? getgrgid(gid) : getgrnam(*av);
4493 errx(EX_DATAERR, "gid \"%s\" nonexistent", *av);
4494 cmd32->d[0] = grp->gr_gid;
4495 cmd->len |= F_INSN_SIZE(ipfw_insn_u32);
4501 NEED1("jail requires argument");
4506 cmd->opcode = O_JAIL;
4507 jid = (int)strtol(*av, &end, 0);
4508 if (jid < 0 || *end != '\0')
4509 errx(EX_DATAERR, "jail requires prison ID");
4510 cmd32->d[0] = (uint32_t)jid;
4511 cmd->len |= F_INSN_SIZE(ipfw_insn_u32);
4517 fill_cmd(cmd, O_ESTAB, 0, 0);
4521 fill_cmd(cmd, O_TCPFLAGS, 0,
4522 (TH_SYN) | ( (TH_ACK) & 0xff) <<8 );
4525 case TOK_TCPDATALEN:
4526 NEED1("tcpdatalen requires length");
4527 if (strpbrk(*av, "-,")) {
4528 if (!add_ports(cmd, *av, 0, O_TCPDATALEN, cblen))
4529 errx(EX_DATAERR, "invalid tcpdata len %s", *av);
4531 fill_cmd(cmd, O_TCPDATALEN, 0,
4532 strtoul(*av, NULL, 0));
4537 NEED1("missing argument for tcpoptions");
4538 fill_flags_cmd(cmd, O_TCPOPTS, f_tcpopts, *av);
4544 NEED1("tcpseq/tcpack requires argument");
4545 cmd->len = F_INSN_SIZE(ipfw_insn_u32);
4546 cmd->opcode = (i == TOK_TCPSEQ) ? O_TCPSEQ : O_TCPACK;
4547 cmd32->d[0] = htonl(strtoul(*av, NULL, 0));
4552 NEED1("tcpwin requires length");
4553 if (strpbrk(*av, "-,")) {
4554 if (!add_ports(cmd, *av, 0, O_TCPWIN, cblen))
4555 errx(EX_DATAERR, "invalid tcpwin len %s", *av);
4557 fill_cmd(cmd, O_TCPWIN, 0,
4558 strtoul(*av, NULL, 0));
4563 NEED1("missing argument for tcpflags");
4564 cmd->opcode = O_TCPFLAGS;
4565 fill_flags_cmd(cmd, O_TCPFLAGS, f_tcpflags, *av);
4569 case TOK_KEEPSTATE: {
4573 errx(EX_USAGE, "keep-state cannot be part "
4576 errx(EX_USAGE, "only one of keep-state "
4577 "and limit is allowed");
4578 if (*av != NULL && *av[0] == ':') {
4579 if (state_check_name(*av + 1) != 0)
4581 "Invalid state name %s", *av);
4582 uidx = pack_object(tstate, *av + 1,
4583 IPFW_TLV_STATE_NAME);
4586 uidx = pack_object(tstate, default_state_name,
4587 IPFW_TLV_STATE_NAME);
4589 fill_cmd(cmd, O_KEEP_STATE, 0, uidx);
4594 ipfw_insn_limit *c = (ipfw_insn_limit *)cmd;
4599 "limit cannot be part of an or block");
4601 errx(EX_USAGE, "only one of keep-state and "
4602 "limit is allowed");
4605 cmd->len = F_INSN_SIZE(ipfw_insn_limit);
4607 cmd->opcode = O_LIMIT;
4608 c->limit_mask = c->conn_limit = 0;
4610 while ( av[0] != NULL ) {
4611 if ((val = match_token(limit_masks, *av)) <= 0)
4613 c->limit_mask |= val;
4617 if (c->limit_mask == 0)
4618 errx(EX_USAGE, "limit: missing limit mask");
4620 GET_UINT_ARG(c->conn_limit, IPFW_ARG_MIN, IPFW_ARG_MAX,
4621 TOK_LIMIT, rule_options);
4624 if (*av != NULL && *av[0] == ':') {
4625 if (state_check_name(*av + 1) != 0)
4627 "Invalid state name %s", *av);
4628 cmd->arg1 = pack_object(tstate, *av + 1,
4629 IPFW_TLV_STATE_NAME);
4632 cmd->arg1 = pack_object(tstate,
4633 default_state_name, IPFW_TLV_STATE_NAME);
4638 NEED1("missing protocol");
4639 if (add_proto(cmd, *av, &proto)) {
4642 errx(EX_DATAERR, "invalid protocol ``%s''",
4647 NEED1("missing source IP");
4648 if (add_srcip(cmd, *av, cblen, tstate)) {
4654 NEED1("missing destination IP");
4655 if (add_dstip(cmd, *av, cblen, tstate)) {
4661 NEED1("missing source IP6");
4662 if (add_srcip6(cmd, *av, cblen, tstate)) {
4668 NEED1("missing destination IP6");
4669 if (add_dstip6(cmd, *av, cblen, tstate)) {
4675 NEED1("missing source port");
4676 if (_substrcmp(*av, "any") == 0 ||
4677 add_ports(cmd, *av, proto, O_IP_SRCPORT, cblen)) {
4680 errx(EX_DATAERR, "invalid source port %s", *av);
4684 NEED1("missing destination port");
4685 if (_substrcmp(*av, "any") == 0 ||
4686 add_ports(cmd, *av, proto, O_IP_DSTPORT, cblen)) {
4689 errx(EX_DATAERR, "invalid destination port %s",
4694 if (add_mac(cmd, av, cblen))
4699 NEED1("missing mac type");
4700 if (!add_mactype(cmd, *av, cblen))
4701 errx(EX_DATAERR, "invalid mac type %s", *av);
4705 case TOK_VERREVPATH:
4706 fill_cmd(cmd, O_VERREVPATH, 0, 0);
4709 case TOK_VERSRCREACH:
4710 fill_cmd(cmd, O_VERSRCREACH, 0, 0);
4714 fill_cmd(cmd, O_ANTISPOOF, 0, 0);
4718 fill_cmd(cmd, O_IPSEC, 0, 0);
4722 fill_cmd(cmd, O_IP6, 0, 0);
4726 fill_cmd(cmd, O_IP4, 0, 0);
4730 fill_ext6hdr( cmd, *av );
4735 if (proto != IPPROTO_IPV6 )
4736 errx( EX_USAGE, "flow-id filter is active "
4737 "only for ipv6 protocol\n");
4738 fill_flow6( (ipfw_insn_u32 *) cmd, *av, cblen);
4743 fill_comment(cmd, av, cblen);
4748 if (av[0] && strpbrk(*av, "-,")) {
4749 if (!add_ports(cmd, *av, 0, O_TAGGED, cblen))
4750 errx(EX_DATAERR, "tagged: invalid tag"
4756 GET_UINT_ARG(tag, IPFW_ARG_MIN, IPFW_ARG_MAX,
4757 TOK_TAGGED, rule_options);
4758 fill_cmd(cmd, O_TAGGED, 0, tag);
4764 NEED1("fib requires fib number");
4765 fill_cmd(cmd, O_FIB, 0, strtoul(*av, NULL, 0));
4769 fill_cmd(cmd, O_SOCKARG, 0, 0);
4773 ipfw_insn_u32 *c = (ipfw_insn_u32 *)cmd;
4776 if (!av[0] || !av[1])
4777 errx(EX_USAGE, "format: lookup argument tablenum");
4778 cmd->opcode = O_IP_DST_LOOKUP;
4779 cmd->len |= F_INSN_SIZE(ipfw_insn) + 2;
4780 i = match_token(rule_options, *av);
4781 for (j = 0; lookup_key[j] >= 0 ; j++) {
4782 if (i == lookup_key[j])
4785 if (lookup_key[j] <= 0)
4786 errx(EX_USAGE, "format: cannot lookup on %s", *av);
4787 __PAST_END(c->d, 1) = j; // i converted to option
4790 if ((j = pack_table(tstate, *av)) == 0)
4791 errx(EX_DATAERR, "Invalid table name: %s", *av);
4798 NEED1("missing table name");
4799 if (strncmp(*av, "table(", 6) != 0)
4801 "enclose table name into \"table()\"");
4802 fill_table(cmd, *av, O_IP_FLOW_LOOKUP, tstate);
4807 errx(EX_USAGE, "unrecognised option [%d] %s\n", i, s);
4809 if (F_LEN(cmd) > 0) { /* prepare to advance */
4811 cmd = next_cmd(cmd, &cblen);
4817 * Now copy stuff into the rule.
4818 * If we have a keep-state option, the first instruction
4819 * must be a PROBE_STATE (which is generated here).
4820 * If we have a LOG option, it was stored as the first command,
4821 * and now must be moved to the top of the action part.
4823 dst = (ipfw_insn *)rule->cmd;
4826 * First thing to write into the command stream is the match probability.
4828 if (match_prob != 1) { /* 1 means always match */
4829 dst->opcode = O_PROB;
4831 *((int32_t *)(dst+1)) = (int32_t)(match_prob * 0x7fffffff);
4836 * generate O_PROBE_STATE if necessary
4838 if (have_state && have_state->opcode != O_CHECK_STATE) {
4839 fill_cmd(dst, O_PROBE_STATE, 0, have_state->arg1);
4840 dst = next_cmd(dst, &rblen);
4843 /* copy all commands but O_LOG, O_KEEP_STATE, O_LIMIT, O_ALTQ, O_TAG */
4844 for (src = (ipfw_insn *)cmdbuf; src != cmd; src += i) {
4848 switch (src->opcode) {
4856 bcopy(src, dst, i * sizeof(uint32_t));
4862 * put back the have_state command as last opcode
4864 if (have_state && have_state->opcode != O_CHECK_STATE) {
4865 i = F_LEN(have_state);
4867 bcopy(have_state, dst, i * sizeof(uint32_t));
4871 * start action section
4873 rule->act_ofs = dst - rule->cmd;
4875 /* put back O_LOG, O_ALTQ, O_TAG if necessary */
4877 i = F_LEN(have_log);
4879 bcopy(have_log, dst, i * sizeof(uint32_t));
4883 i = F_LEN(have_altq);
4885 bcopy(have_altq, dst, i * sizeof(uint32_t));
4889 i = F_LEN(have_tag);
4891 bcopy(have_tag, dst, i * sizeof(uint32_t));
4896 * copy all other actions
4898 for (src = (ipfw_insn *)actbuf; src != action; src += i) {
4901 bcopy(src, dst, i * sizeof(uint32_t));
4905 rule->cmd_len = (uint32_t *)dst - (uint32_t *)(rule->cmd);
4906 *rbufsize = (char *)dst - (char *)rule;
4910 compare_ntlv(const void *_a, const void *_b)
4912 ipfw_obj_ntlv *a, *b;
4914 a = (ipfw_obj_ntlv *)_a;
4915 b = (ipfw_obj_ntlv *)_b;
4917 if (a->set < b->set)
4919 else if (a->set > b->set)
4922 if (a->idx < b->idx)
4924 else if (a->idx > b->idx)
4927 if (a->head.type < b->head.type)
4929 else if (a->head.type > b->head.type)
4936 * Provide kernel with sorted list of referenced objects
4939 object_sort_ctlv(ipfw_obj_ctlv *ctlv)
4942 qsort(ctlv + 1, ctlv->count, ctlv->objsize, compare_ntlv);
4950 compare_object_kntlv(const void *k, const void *v)
4952 ipfw_obj_ntlv *ntlv;
4953 struct object_kt key;
4955 key = *((struct object_kt *)k);
4956 ntlv = (ipfw_obj_ntlv *)v;
4958 if (key.uidx < ntlv->idx)
4960 else if (key.uidx > ntlv->idx)
4963 if (key.type < ntlv->head.type)
4965 else if (key.type > ntlv->head.type)
4972 * Finds object name in @ctlv by @idx and @type.
4973 * Uses the following facts:
4974 * 1) All TLVs are the same size
4975 * 2) Kernel implementation provides already sorted list.
4977 * Returns table name or NULL.
4980 object_search_ctlv(ipfw_obj_ctlv *ctlv, uint16_t idx, uint16_t type)
4982 ipfw_obj_ntlv *ntlv;
4983 struct object_kt key;
4988 ntlv = bsearch(&key, (ctlv + 1), ctlv->count, ctlv->objsize,
4989 compare_object_kntlv);
4992 return (ntlv->name);
4998 table_search_ctlv(ipfw_obj_ctlv *ctlv, uint16_t idx)
5001 return (object_search_ctlv(ctlv, idx, IPFW_TLV_TBL_NAME));
5005 * Adds one or more rules to ipfw chain.
5010 * [ ipfw_obj_ctlv(IPFW_TLV_TBL_LIST) ipfw_obj_ntlv x N ] (optional *1)
5011 * [ ipfw_obj_ctlv(IPFW_TLV_RULE_LIST) [ ip_fw_rule ip_fw_insn ] x N ] (*2) (*3)
5016 * [ ipfw_obj_ctlv(IPFW_TLV_TBL_LIST) ipfw_obj_ntlv x N ] (optional)
5017 * [ ipfw_obj_ctlv(IPFW_TLV_RULE_LIST) [ ip_fw_rule ip_fw_insn ] x N ]
5020 * Rules in reply are modified to store their actual ruleset number.
5022 * (*1) TLVs inside IPFW_TLV_TBL_LIST needs to be sorted ascending
5023 * according to their idx field and there has to be no duplicates.
5024 * (*2) Numbered rules inside IPFW_TLV_RULE_LIST needs to be sorted ascending.
5025 * (*3) Each ip_fw structure needs to be aligned to u64 boundary.
5028 ipfw_add(char *av[])
5030 uint32_t rulebuf[1024];
5031 int rbufsize, default_off, tlen, rlen;
5034 struct ip_fw_rule *rule;
5036 ip_fw3_opheader *op3;
5037 ipfw_obj_ctlv *ctlv, *tstate;
5039 rbufsize = sizeof(rulebuf);
5040 memset(rulebuf, 0, rbufsize);
5041 memset(&ts, 0, sizeof(ts));
5043 /* Optimize case with no tables */
5044 default_off = sizeof(ipfw_obj_ctlv) + sizeof(ip_fw3_opheader);
5045 op3 = (ip_fw3_opheader *)rulebuf;
5046 ctlv = (ipfw_obj_ctlv *)(op3 + 1);
5047 rule = (struct ip_fw_rule *)(ctlv + 1);
5048 rbufsize -= default_off;
5050 compile_rule(av, (uint32_t *)rule, &rbufsize, &ts);
5051 /* Align rule size to u64 boundary */
5052 rlen = roundup2(rbufsize, sizeof(uint64_t));
5057 if (ts.count != 0) {
5058 /* Some tables. We have to alloc more data */
5059 tlen = ts.count * sizeof(ipfw_obj_ntlv);
5060 sz = default_off + sizeof(ipfw_obj_ctlv) + tlen + rlen;
5062 if ((tbuf = calloc(1, sz)) == NULL)
5063 err(EX_UNAVAILABLE, "malloc() failed for IP_FW_ADD");
5064 op3 = (ip_fw3_opheader *)tbuf;
5066 ctlv = (ipfw_obj_ctlv *)(op3 + 1);
5067 ctlv->head.type = IPFW_TLV_TBLNAME_LIST;
5068 ctlv->head.length = sizeof(ipfw_obj_ctlv) + tlen;
5069 ctlv->count = ts.count;
5070 ctlv->objsize = sizeof(ipfw_obj_ntlv);
5071 memcpy(ctlv + 1, ts.idx, tlen);
5072 object_sort_ctlv(ctlv);
5075 ctlv = (ipfw_obj_ctlv *)((caddr_t)ctlv + ctlv->head.length);
5076 ctlv->head.type = IPFW_TLV_RULE_LIST;
5077 ctlv->head.length = sizeof(ipfw_obj_ctlv) + rlen;
5079 memcpy(ctlv + 1, rule, rbufsize);
5081 /* Simply add header */
5082 sz = rlen + default_off;
5083 memset(ctlv, 0, sizeof(*ctlv));
5084 ctlv->head.type = IPFW_TLV_RULE_LIST;
5085 ctlv->head.length = sizeof(ipfw_obj_ctlv) + rlen;
5089 if (do_get3(IP_FW_XADD, op3, &sz) != 0)
5090 err(EX_UNAVAILABLE, "getsockopt(%s)", "IP_FW_XADD");
5093 struct format_opts sfo;
5095 memset(&sfo, 0, sizeof(sfo));
5096 sfo.tstate = tstate;
5097 sfo.set_mask = (uint32_t)(-1);
5098 bp_alloc(&bp, 4096);
5099 show_static_rule(&co, &sfo, &bp, rule, NULL);
5100 printf("%s", bp.buf);
5112 * clear the counters or the log counters.
5113 * optname has the following values:
5114 * 0 (zero both counters and logging)
5115 * 1 (zero logging only)
5118 ipfw_zero(int ac, char *av[], int optname)
5124 char const *name = optname ? "RESETLOG" : "ZERO";
5126 optname = optname ? IP_FW_XRESETLOG : IP_FW_XZERO;
5127 memset(&rt, 0, sizeof(rt));
5132 /* clear all entries */
5133 rt.flags = IPFW_RCFLAG_ALL;
5134 if (do_range_cmd(optname, &rt) < 0)
5135 err(EX_UNAVAILABLE, "setsockopt(IP_FW_X%s)", name);
5137 printf("%s.\n", optname == IP_FW_XZERO ?
5138 "Accounting cleared":"Logging counts reset");
5145 if (isdigit(**av)) {
5146 arg = strtonum(*av, 0, 0xffff, &errstr);
5149 "invalid rule number %s\n", *av);
5150 rt.start_rule = arg;
5152 rt.flags |= IPFW_RCFLAG_RANGE;
5153 if (co.use_set != 0) {
5154 rt.set = co.use_set - 1;
5155 rt.flags |= IPFW_RCFLAG_SET;
5157 if (do_range_cmd(optname, &rt) != 0) {
5158 warn("rule %u: setsockopt(IP_FW_X%s)",
5160 failed = EX_UNAVAILABLE;
5161 } else if (rt.new_set == 0) {
5162 printf("Entry %d not found\n", arg);
5163 failed = EX_UNAVAILABLE;
5164 } else if (!co.do_quiet)
5165 printf("Entry %d %s.\n", arg,
5166 optname == IP_FW_XZERO ?
5167 "cleared" : "logging count reset");
5169 errx(EX_USAGE, "invalid rule number ``%s''", *av);
5173 if (failed != EX_OK)
5178 ipfw_flush(int force)
5182 if (!force && !co.do_quiet) { /* need to ask user */
5185 printf("Are you sure? [yn] ");
5188 c = toupper(getc(stdin));
5189 while (c != '\n' && getc(stdin) != '\n')
5191 return; /* and do not flush */
5192 } while (c != 'Y' && c != 'N');
5194 if (c == 'N') /* user said no */
5201 /* `ipfw set N flush` - is the same that `ipfw delete set N` */
5202 memset(&rt, 0, sizeof(rt));
5203 if (co.use_set != 0) {
5204 rt.set = co.use_set - 1;
5205 rt.flags = IPFW_RCFLAG_SET;
5207 rt.flags = IPFW_RCFLAG_ALL;
5208 if (do_range_cmd(IP_FW_XDEL, &rt) != 0)
5209 err(EX_UNAVAILABLE, "setsockopt(IP_FW_XDEL)");
5211 printf("Flushed all %s.\n", co.do_pipe ? "pipes" : "rules");
5214 static struct _s_x intcmds[] = {
5215 { "talist", TOK_TALIST },
5216 { "iflist", TOK_IFLIST },
5217 { "olist", TOK_OLIST },
5218 { "vlist", TOK_VLIST },
5222 static struct _s_x otypes[] = {
5223 { "EACTION", IPFW_TLV_EACTION },
5224 { "DYNSTATE", IPFW_TLV_STATE_NAME },
5229 lookup_eaction_name(ipfw_obj_ntlv *ntlv, int cnt, uint16_t type)
5235 for (i = 0; i < cnt; i++) {
5236 if (ntlv[i].head.type != IPFW_TLV_EACTION)
5238 if (IPFW_TLV_EACTION_NAME(ntlv[i].idx) != type)
5240 name = ntlv[i].name;
5247 ipfw_list_objects(int ac, char *av[])
5249 ipfw_obj_lheader req, *olh;
5250 ipfw_obj_ntlv *ntlv;
5255 memset(&req, 0, sizeof(req));
5257 if (do_get3(IP_FW_DUMP_SRVOBJECTS, &req.opheader, &sz) != 0)
5258 if (errno != ENOMEM)
5262 if ((olh = calloc(1, sz)) == NULL)
5266 if (do_get3(IP_FW_DUMP_SRVOBJECTS, &olh->opheader, &sz) != 0) {
5272 printf("Objects list:\n");
5274 printf("There are no objects\n");
5275 ntlv = (ipfw_obj_ntlv *)(olh + 1);
5276 for (i = 0; i < olh->count; i++) {
5277 name = match_value(otypes, ntlv->head.type);
5279 name = lookup_eaction_name(
5280 (ipfw_obj_ntlv *)(olh + 1), olh->count,
5283 printf(" kidx: %4d\ttype: %10d\tname: %s\n",
5284 ntlv->idx, ntlv->head.type, ntlv->name);
5286 printf(" kidx: %4d\ttype: %10s\tname: %s\n",
5287 ntlv->idx, name, ntlv->name);
5294 ipfw_internal_handler(int ac, char *av[])
5299 NEED1("internal cmd required");
5301 if ((tcmd = match_token(intcmds, *av)) == -1)
5302 errx(EX_USAGE, "invalid internal sub-cmd: %s", *av);
5306 ipfw_list_tifaces();
5309 ipfw_list_ta(ac, av);
5312 ipfw_list_objects(ac, av);
5315 ipfw_list_values(ac, av);
5321 ipfw_get_tracked_ifaces(ipfw_obj_lheader **polh)
5323 ipfw_obj_lheader req, *olh;
5326 memset(&req, 0, sizeof(req));
5329 if (do_get3(IP_FW_XIFLIST, &req.opheader, &sz) != 0) {
5330 if (errno != ENOMEM)
5335 if ((olh = calloc(1, sz)) == NULL)
5339 if (do_get3(IP_FW_XIFLIST, &olh->opheader, &sz) != 0) {
5349 ifinfo_cmp(const void *a, const void *b)
5351 ipfw_iface_info *ia, *ib;
5353 ia = (ipfw_iface_info *)a;
5354 ib = (ipfw_iface_info *)b;
5356 return (stringnum_cmp(ia->ifname, ib->ifname));
5360 * Retrieves table list from kernel,
5361 * optionally sorts it and calls requested function for each table.
5362 * Returns 0 on success.
5367 ipfw_obj_lheader *olh;
5368 ipfw_iface_info *info;
5371 if ((error = ipfw_get_tracked_ifaces(&olh)) != 0)
5372 err(EX_OSERR, "Unable to request ipfw tracked interface list");
5375 qsort(olh + 1, olh->count, olh->objsize, ifinfo_cmp);
5377 info = (ipfw_iface_info *)(olh + 1);
5378 for (i = 0; i < olh->count; i++) {
5379 if (info->flags & IPFW_IFFLAG_RESOLVED)
5380 printf("%s ifindex: %d refcount: %u changes: %u\n",
5381 info->ifname, info->ifindex, info->refcnt,
5384 printf("%s ifindex: unresolved refcount: %u changes: %u\n",
5385 info->ifname, info->refcnt, info->gencnt);
5386 info = (ipfw_iface_info *)((caddr_t)info + olh->objsize);