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>
44 #include <time.h> /* ctime */
45 #include <timeconv.h> /* _long_to_time */
48 #include <stddef.h> /* offsetof */
50 #include <net/ethernet.h>
51 #include <net/if.h> /* only IFNAMSIZ */
52 #include <netinet/in.h>
53 #include <netinet/in_systm.h> /* only n_short, n_long */
54 #include <netinet/ip.h>
55 #include <netinet/ip_icmp.h>
56 #include <netinet/ip_fw.h>
57 #include <netinet/tcp.h>
58 #include <arpa/inet.h>
60 struct cmdline_opts co; /* global options */
66 int show_time; /* show timestamp */
67 uint32_t set_mask; /* enabled sets mask */
68 uint32_t flags; /* request flags */
69 uint32_t first; /* first rule to request */
70 uint32_t last; /* last rule to request */
71 uint32_t dcnt; /* number of dynamic states */
72 ipfw_obj_ctlv *tstate; /* table state data */
75 int resvd_set_number = RESVD_SET;
79 #define CHECK_LENGTH(v, len) do { \
81 errx(EX_DATAERR, "Rule too long"); \
84 * Check if we have enough space in cmd buffer. Note that since
85 * first 8? u32 words are reserved by reserved header, full cmd
86 * buffer can't be used, so we need to protect from buffer overrun
87 * only. At the beginning, cblen is less than actual buffer size by
88 * size of ipfw_insn_u32 instruction + 1 u32 work. This eliminates need
89 * for checking small instructions fitting in given range.
90 * We also (ab)use the fact that ipfw_insn is always the first field
91 * for any custom instruction.
93 #define CHECK_CMDLEN CHECK_LENGTH(cblen, F_LEN((ipfw_insn *)cmd))
95 #define GET_UINT_ARG(arg, min, max, tok, s_x) do { \
97 errx(EX_USAGE, "%s: missing argument", match_value(s_x, tok)); \
98 if (_substrcmp(*av, "tablearg") == 0) { \
107 _xval = strtol(*av, &end, 10); \
109 if (!isdigit(**av) || *end != '\0' || (_xval == 0 && errno == EINVAL)) \
110 errx(EX_DATAERR, "%s: invalid argument: %s", \
111 match_value(s_x, tok), *av); \
113 if (errno == ERANGE || _xval < min || _xval > max) \
114 errx(EX_DATAERR, "%s: argument is out of range (%u..%u): %s", \
115 match_value(s_x, tok), min, max, *av); \
117 if (_xval == IP_FW_TARG) \
118 errx(EX_DATAERR, "%s: illegal argument value: %s", \
119 match_value(s_x, tok), *av); \
124 static struct _s_x f_tcpflags[] = {
135 static struct _s_x f_tcpopts[] = {
136 { "mss", IP_FW_TCPOPT_MSS },
137 { "maxseg", IP_FW_TCPOPT_MSS },
138 { "window", IP_FW_TCPOPT_WINDOW },
139 { "sack", IP_FW_TCPOPT_SACK },
140 { "ts", IP_FW_TCPOPT_TS },
141 { "timestamp", IP_FW_TCPOPT_TS },
142 { "cc", IP_FW_TCPOPT_CC },
148 * IP options span the range 0 to 255 so we need to remap them
149 * (though in fact only the low 5 bits are significant).
151 static struct _s_x f_ipopts[] = {
152 { "ssrr", IP_FW_IPOPT_SSRR},
153 { "lsrr", IP_FW_IPOPT_LSRR},
154 { "rr", IP_FW_IPOPT_RR},
155 { "ts", IP_FW_IPOPT_TS},
160 static struct _s_x f_iptos[] = {
161 { "lowdelay", IPTOS_LOWDELAY},
162 { "throughput", IPTOS_THROUGHPUT},
163 { "reliability", IPTOS_RELIABILITY},
164 { "mincost", IPTOS_MINCOST},
165 { "congestion", IPTOS_ECN_CE},
166 { "ecntransport", IPTOS_ECN_ECT0},
167 { "ip tos option", 0},
171 struct _s_x f_ipdscp[] = {
172 { "af11", IPTOS_DSCP_AF11 >> 2 }, /* 001010 */
173 { "af12", IPTOS_DSCP_AF12 >> 2 }, /* 001100 */
174 { "af13", IPTOS_DSCP_AF13 >> 2 }, /* 001110 */
175 { "af21", IPTOS_DSCP_AF21 >> 2 }, /* 010010 */
176 { "af22", IPTOS_DSCP_AF22 >> 2 }, /* 010100 */
177 { "af23", IPTOS_DSCP_AF23 >> 2 }, /* 010110 */
178 { "af31", IPTOS_DSCP_AF31 >> 2 }, /* 011010 */
179 { "af32", IPTOS_DSCP_AF32 >> 2 }, /* 011100 */
180 { "af33", IPTOS_DSCP_AF33 >> 2 }, /* 011110 */
181 { "af41", IPTOS_DSCP_AF41 >> 2 }, /* 100010 */
182 { "af42", IPTOS_DSCP_AF42 >> 2 }, /* 100100 */
183 { "af43", IPTOS_DSCP_AF43 >> 2 }, /* 100110 */
184 { "be", IPTOS_DSCP_CS0 >> 2 }, /* 000000 */
185 { "ef", IPTOS_DSCP_EF >> 2 }, /* 101110 */
186 { "cs0", IPTOS_DSCP_CS0 >> 2 }, /* 000000 */
187 { "cs1", IPTOS_DSCP_CS1 >> 2 }, /* 001000 */
188 { "cs2", IPTOS_DSCP_CS2 >> 2 }, /* 010000 */
189 { "cs3", IPTOS_DSCP_CS3 >> 2 }, /* 011000 */
190 { "cs4", IPTOS_DSCP_CS4 >> 2 }, /* 100000 */
191 { "cs5", IPTOS_DSCP_CS5 >> 2 }, /* 101000 */
192 { "cs6", IPTOS_DSCP_CS6 >> 2 }, /* 110000 */
193 { "cs7", IPTOS_DSCP_CS7 >> 2 }, /* 100000 */
197 static struct _s_x limit_masks[] = {
198 {"all", DYN_SRC_ADDR|DYN_SRC_PORT|DYN_DST_ADDR|DYN_DST_PORT},
199 {"src-addr", DYN_SRC_ADDR},
200 {"src-port", DYN_SRC_PORT},
201 {"dst-addr", DYN_DST_ADDR},
202 {"dst-port", DYN_DST_PORT},
207 * we use IPPROTO_ETHERTYPE as a fake protocol id to call the print routines
208 * This is only used in this code.
210 #define IPPROTO_ETHERTYPE 0x1000
211 static struct _s_x ether_types[] = {
213 * Note, we cannot use "-:&/" in the names because they are field
214 * separators in the type specifications. Also, we use s = NULL as
215 * end-delimiter, because a type of 0 can be legal.
228 { "pppoe_disc", 0x8863 },
229 { "pppoe_sess", 0x8864 },
230 { "ipx_8022", 0x00E0 },
231 { "ipx_8023", 0x0000 },
232 { "ipx_ii", 0x8137 },
233 { "ipx_snap", 0x8137 },
239 static struct _s_x rule_eactions[] = {
240 { "nat64lsn", TOK_NAT64LSN },
241 { "nat64stl", TOK_NAT64STL },
242 { "nptv6", TOK_NPTV6 },
243 { "tcp-setmss", TOK_TCPSETMSS },
244 { NULL, 0 } /* terminator */
247 static struct _s_x rule_actions[] = {
248 { "abort6", TOK_ABORT6 },
249 { "abort", TOK_ABORT },
250 { "accept", TOK_ACCEPT },
251 { "pass", TOK_ACCEPT },
252 { "allow", TOK_ACCEPT },
253 { "permit", TOK_ACCEPT },
254 { "count", TOK_COUNT },
255 { "pipe", TOK_PIPE },
256 { "queue", TOK_QUEUE },
257 { "divert", TOK_DIVERT },
259 { "netgraph", TOK_NETGRAPH },
260 { "ngtee", TOK_NGTEE },
261 { "fwd", TOK_FORWARD },
262 { "forward", TOK_FORWARD },
263 { "skipto", TOK_SKIPTO },
264 { "deny", TOK_DENY },
265 { "drop", TOK_DENY },
266 { "reject", TOK_REJECT },
267 { "reset6", TOK_RESET6 },
268 { "reset", TOK_RESET },
269 { "unreach6", TOK_UNREACH6 },
270 { "unreach", TOK_UNREACH },
271 { "check-state", TOK_CHECKSTATE },
272 { "//", TOK_COMMENT },
274 { "reass", TOK_REASS },
275 { "setfib", TOK_SETFIB },
276 { "setdscp", TOK_SETDSCP },
277 { "call", TOK_CALL },
278 { "return", TOK_RETURN },
279 { "eaction", TOK_EACTION },
280 { "tcp-setmss", TOK_TCPSETMSS },
281 { NULL, 0 } /* terminator */
284 static struct _s_x rule_action_params[] = {
285 { "altq", TOK_ALTQ },
288 { "untag", TOK_UNTAG },
289 { NULL, 0 } /* terminator */
293 * The 'lookup' instruction accepts one of the following arguments.
294 * -1 is a terminator for the list.
295 * Arguments are passed as v[1] in O_DST_LOOKUP options.
297 static int lookup_key[] = {
298 TOK_DSTIP, TOK_SRCIP, TOK_DSTPORT, TOK_SRCPORT,
299 TOK_UID, TOK_JAIL, TOK_DSCP, -1 };
301 static struct _s_x rule_options[] = {
302 { "tagged", TOK_TAGGED },
305 { "jail", TOK_JAIL },
307 { "limit", TOK_LIMIT },
308 { "set-limit", TOK_SETLIMIT },
309 { "keep-state", TOK_KEEPSTATE },
310 { "record-state", TOK_RECORDSTATE },
311 { "bridged", TOK_LAYER2 },
312 { "layer2", TOK_LAYER2 },
314 { "diverted", TOK_DIVERTED },
315 { "diverted-loopback", TOK_DIVERTEDLOOPBACK },
316 { "diverted-output", TOK_DIVERTEDOUTPUT },
317 { "xmit", TOK_XMIT },
318 { "recv", TOK_RECV },
320 { "fragment", TOK_FRAG },
321 { "frag", TOK_FRAG },
323 { "ipoptions", TOK_IPOPTS },
324 { "ipopts", TOK_IPOPTS },
325 { "iplen", TOK_IPLEN },
326 { "ipid", TOK_IPID },
327 { "ipprecedence", TOK_IPPRECEDENCE },
328 { "dscp", TOK_DSCP },
329 { "iptos", TOK_IPTOS },
330 { "ipttl", TOK_IPTTL },
331 { "ipversion", TOK_IPVER },
332 { "ipver", TOK_IPVER },
333 { "estab", TOK_ESTAB },
334 { "established", TOK_ESTAB },
335 { "setup", TOK_SETUP },
336 { "sockarg", TOK_SOCKARG },
337 { "tcpdatalen", TOK_TCPDATALEN },
338 { "tcpflags", TOK_TCPFLAGS },
339 { "tcpflgs", TOK_TCPFLAGS },
340 { "tcpoptions", TOK_TCPOPTS },
341 { "tcpopts", TOK_TCPOPTS },
342 { "tcpseq", TOK_TCPSEQ },
343 { "tcpack", TOK_TCPACK },
344 { "tcpwin", TOK_TCPWIN },
345 { "icmptype", TOK_ICMPTYPES },
346 { "icmptypes", TOK_ICMPTYPES },
347 { "dst-ip", TOK_DSTIP },
348 { "src-ip", TOK_SRCIP },
349 { "dst-port", TOK_DSTPORT },
350 { "src-port", TOK_SRCPORT },
351 { "proto", TOK_PROTO },
354 { "mac-type", TOK_MACTYPE },
355 { "verrevpath", TOK_VERREVPATH },
356 { "versrcreach", TOK_VERSRCREACH },
357 { "antispoof", TOK_ANTISPOOF },
358 { "ipsec", TOK_IPSEC },
359 { "icmp6type", TOK_ICMP6TYPES },
360 { "icmp6types", TOK_ICMP6TYPES },
361 { "ext6hdr", TOK_EXT6HDR},
362 { "flow-id", TOK_FLOWID},
367 { "dst-ipv6", TOK_DSTIP6},
368 { "dst-ip6", TOK_DSTIP6},
369 { "src-ipv6", TOK_SRCIP6},
370 { "src-ip6", TOK_SRCIP6},
371 { "lookup", TOK_LOOKUP},
373 { "defer-action", TOK_SKIPACTION },
374 { "defer-immediate-action", TOK_SKIPACTION },
375 { "//", TOK_COMMENT },
377 { "not", TOK_NOT }, /* pseudo option */
378 { "!", /* escape ? */ TOK_NOT }, /* pseudo option */
379 { "or", TOK_OR }, /* pseudo option */
380 { "|", /* escape */ TOK_OR }, /* pseudo option */
381 { "{", TOK_STARTBRACE }, /* pseudo option */
382 { "(", TOK_STARTBRACE }, /* pseudo option */
383 { "}", TOK_ENDBRACE }, /* pseudo option */
384 { ")", TOK_ENDBRACE }, /* pseudo option */
385 { NULL, 0 } /* terminator */
388 void bprint_uint_arg(struct buf_pr *bp, const char *str, uint32_t arg);
389 static int ipfw_get_config(struct cmdline_opts *co, struct format_opts *fo,
390 ipfw_cfg_lheader **pcfg, size_t *psize);
391 static int ipfw_show_config(struct cmdline_opts *co, struct format_opts *fo,
392 ipfw_cfg_lheader *cfg, size_t sz, int ac, char **av);
393 static void ipfw_list_tifaces(void);
396 static uint16_t pack_object(struct tidx *tstate, char *name, int otype);
397 static uint16_t pack_table(struct tidx *tstate, char *name);
399 static char *table_search_ctlv(ipfw_obj_ctlv *ctlv, uint16_t idx);
400 static void object_sort_ctlv(ipfw_obj_ctlv *ctlv);
401 static char *object_search_ctlv(ipfw_obj_ctlv *ctlv, uint16_t idx,
405 * Simple string buffer API.
406 * Used to simplify buffer passing between function and for
407 * transparent overrun handling.
411 * Allocates new buffer of given size @sz.
413 * Returns 0 on success.
416 bp_alloc(struct buf_pr *b, size_t size)
418 memset(b, 0, sizeof(struct buf_pr));
420 if ((b->buf = calloc(1, size)) == NULL)
431 bp_free(struct buf_pr *b)
438 * Flushes buffer so new writer start from beginning.
441 bp_flush(struct buf_pr *b)
450 * Print message specified by @format and args.
451 * Automatically manage buffer space and transparently handle
454 * Returns number of bytes that should have been printed.
457 bprintf(struct buf_pr *b, char *format, ...)
462 va_start(args, format);
464 i = vsnprintf(b->ptr, b->avail, format, args);
467 if (i > b->avail || i < 0) {
468 /* Overflow or print error */
481 * Special values printer for tablearg-aware opcodes.
484 bprint_uint_arg(struct buf_pr *bp, const char *str, uint32_t arg)
488 bprintf(bp, "%s", str);
489 if (arg == IP_FW_TARG)
490 bprintf(bp, "tablearg");
492 bprintf(bp, "%u", arg);
496 * Helper routine to print a possibly unaligned uint64_t on
497 * various platform. If width > 0, print the value with
498 * the desired width, followed by a space;
499 * otherwise, return the required width.
502 pr_u64(struct buf_pr *b, uint64_t *pd, int width)
505 #define U64_FMT "I64"
507 #define U64_FMT "llu"
510 unsigned long long d;
512 bcopy (pd, &u, sizeof(u));
515 bprintf(b, "%*" U64_FMT " ", width, d) :
516 snprintf(NULL, 0, "%" U64_FMT, d) ;
522 safe_calloc(size_t number, size_t size)
524 void *ret = calloc(number, size);
527 err(EX_OSERR, "calloc");
532 safe_realloc(void *ptr, size_t size)
534 void *ret = realloc(ptr, size);
537 err(EX_OSERR, "realloc");
542 * Compare things like interface or table names.
545 stringnum_cmp(const char *a, const char *b)
557 return (strcmp(a, b));
562 * conditionally runs the command.
563 * Selected options or negative -> getsockopt
566 do_cmd(int optname, void *optval, uintptr_t optlen)
573 if (ipfw_socket == -1)
574 ipfw_socket = socket(AF_INET, SOCK_RAW, IPPROTO_RAW);
576 err(EX_UNAVAILABLE, "socket");
578 if (optname == IP_FW_GET || optname == IP_DUMMYNET_GET ||
579 optname == IP_FW_ADD || optname == IP_FW3 ||
580 optname == IP_FW_NAT_GET_CONFIG ||
582 optname == IP_FW_NAT_GET_LOG) {
585 i = getsockopt(ipfw_socket, IPPROTO_IP, optname, optval,
586 (socklen_t *)optlen);
588 i = setsockopt(ipfw_socket, IPPROTO_IP, optname, optval, optlen);
594 * do_set3 - pass ipfw control cmd to kernel
595 * @optname: option name
596 * @optval: pointer to option data
597 * @optlen: option length
599 * Assumes op3 header is already embedded.
600 * Calls setsockopt() with IP_FW3 as kernel-visible opcode.
601 * Returns 0 on success or errno otherwise.
604 do_set3(int optname, ip_fw3_opheader *op3, size_t optlen)
610 if (ipfw_socket == -1)
611 ipfw_socket = socket(AF_INET, SOCK_RAW, IPPROTO_RAW);
613 err(EX_UNAVAILABLE, "socket");
615 op3->opcode = optname;
617 return (setsockopt(ipfw_socket, IPPROTO_IP, IP_FW3, op3, optlen));
621 * do_get3 - pass ipfw control cmd to kernel
622 * @optname: option name
623 * @optval: pointer to option data
624 * @optlen: pointer to option length
626 * Assumes op3 header is already embedded.
627 * Calls getsockopt() with IP_FW3 as kernel-visible opcode.
628 * Returns 0 on success or errno otherwise.
631 do_get3(int optname, ip_fw3_opheader *op3, size_t *optlen)
639 if (ipfw_socket == -1)
640 ipfw_socket = socket(AF_INET, SOCK_RAW, IPPROTO_RAW);
642 err(EX_UNAVAILABLE, "socket");
644 op3->opcode = optname;
647 error = getsockopt(ipfw_socket, IPPROTO_IP, IP_FW3, op3, &len);
654 * match_token takes a table and a string, returns the value associated
655 * with the string (-1 in case of failure).
658 match_token(struct _s_x *table, const char *string)
661 uint i = strlen(string);
663 for (pt = table ; i && pt->s != NULL ; pt++)
664 if (strlen(pt->s) == i && !bcmp(string, pt->s, i))
670 * match_token_relaxed takes a table and a string, returns the value associated
671 * with the string for the best match.
674 * value from @table for matched records
675 * -1 for non-matched records
676 * -2 if more than one records match @string.
679 match_token_relaxed(struct _s_x *table, const char *string)
687 for (pt = table ; i != 0 && pt->s != NULL ; pt++) {
688 if (strncmp(pt->s, string, i) != 0)
697 return (c > 0 ? -2: -1);
701 get_token(struct _s_x *table, const char *string, const char *errbase)
705 if ((tcmd = match_token_relaxed(table, string)) < 0)
706 errx(EX_USAGE, "%s %s %s",
707 (tcmd == 0) ? "invalid" : "ambiguous", errbase, string);
713 * match_value takes a table and a value, returns the string associated
714 * with the value (NULL in case of failure).
717 match_value(struct _s_x *p, int value)
719 for (; p->s != NULL; p++)
726 concat_tokens(char *buf, size_t bufsize, struct _s_x *table, char *delimiter)
732 for (sz = 0, pt = table ; pt->s != NULL; pt++) {
733 l = snprintf(buf + sz, bufsize - sz, "%s%s",
734 (sz == 0) ? "" : delimiter, pt->s);
745 * helper function to process a set of flags and set bits in the
749 fill_flags(struct _s_x *flags, char *p, char **e, uint32_t *set,
752 char *q; /* points to the separator */
754 uint32_t *which; /* mask we are working on */
765 val = match_token(flags, p);
771 *which |= (uint32_t)val;
778 print_flags_buffer(char *buf, size_t sz, struct _s_x *list, uint32_t set)
780 char const *comma = "";
783 for (i = 0; list[i].x != 0; i++) {
784 if ((set & list[i].x) == 0)
788 l = snprintf(buf, sz, "%s%s", comma, list[i].s);
798 * _substrcmp takes two strings and returns 1 if they do not match,
799 * and 0 if they match exactly or the first string is a sub-string
800 * of the second. A warning is printed to stderr in the case that the
801 * first string is a sub-string of the second.
803 * This function will be removed in the future through the usual
804 * deprecation process.
807 _substrcmp(const char *str1, const char* str2)
810 if (strncmp(str1, str2, strlen(str1)) != 0)
813 if (strlen(str1) != strlen(str2))
814 warnx("DEPRECATED: '%s' matched '%s' as a sub-string",
820 * _substrcmp2 takes three strings and returns 1 if the first two do not match,
821 * and 0 if they match exactly or the second string is a sub-string
822 * of the first. A warning is printed to stderr in the case that the
823 * first string does not match the third.
825 * This function exists to warn about the bizarre construction
826 * strncmp(str, "by", 2) which is used to allow people to use a shortcut
827 * for "bytes". The problem is that in addition to accepting "by",
828 * "byt", "byte", and "bytes", it also excepts "by_rabid_dogs" and any
829 * other string beginning with "by".
831 * This function will be removed in the future through the usual
832 * deprecation process.
835 _substrcmp2(const char *str1, const char* str2, const char* str3)
838 if (strncmp(str1, str2, strlen(str2)) != 0)
841 if (strcmp(str1, str3) != 0)
842 warnx("DEPRECATED: '%s' matched '%s'",
848 * prints one port, symbolic or numeric
851 print_port(struct buf_pr *bp, int proto, uint16_t port)
854 if (proto == IPPROTO_ETHERTYPE) {
857 if (co.do_resolv && (s = match_value(ether_types, port)) )
858 bprintf(bp, "%s", s);
860 bprintf(bp, "0x%04x", port);
862 struct servent *se = NULL;
864 struct protoent *pe = getprotobynumber(proto);
866 se = getservbyport(htons(port), pe ? pe->p_name : NULL);
869 bprintf(bp, "%s", se->s_name);
871 bprintf(bp, "%d", port);
875 static struct _s_x _port_name[] = {
876 {"dst-port", O_IP_DSTPORT},
877 {"src-port", O_IP_SRCPORT},
881 {"mac-type", O_MAC_TYPE},
882 {"tcpdatalen", O_TCPDATALEN},
883 {"tcpwin", O_TCPWIN},
884 {"tagged", O_TAGGED},
889 * Print the values in a list 16-bit items of the types above.
890 * XXX todo: add support for mask.
893 print_newports(struct buf_pr *bp, ipfw_insn_u16 *cmd, int proto, int opcode)
895 uint16_t *p = cmd->ports;
900 sep = match_value(_port_name, opcode);
903 bprintf(bp, " %s", sep);
906 for (i = F_LEN((ipfw_insn *)cmd) - 1; i > 0; i--, p += 2) {
907 bprintf(bp, "%s", sep);
908 print_port(bp, proto, p[0]);
911 print_port(bp, proto, p[1]);
918 * Like strtol, but also translates service names into port numbers
919 * for some protocols.
921 * proto == -1 disables the protocol check;
922 * proto == IPPROTO_ETHERTYPE looks up an internal table
923 * proto == <some value in /etc/protocols> matches the values there.
924 * Returns *end == s in case the parameter is not found.
927 strtoport(char *s, char **end, int base, int proto)
933 *end = s; /* default - not found */
935 return 0; /* not found */
938 return strtol(s, end, base);
941 * find separator. '\\' escapes the next char.
943 for (s1 = s; *s1 && (isalnum(*s1) || *s1 == '\\') ; s1++)
944 if (*s1 == '\\' && s1[1] != '\0')
947 buf = safe_calloc(s1 - s + 1, 1);
950 * copy into a buffer skipping backslashes
952 for (p = s, i = 0; p != s1 ; p++)
957 if (proto == IPPROTO_ETHERTYPE) {
958 i = match_token(ether_types, buf);
960 if (i != -1) { /* found */
965 struct protoent *pe = NULL;
969 pe = getprotobynumber(proto);
971 se = getservbyname(buf, pe ? pe->p_name : NULL);
975 return ntohs(se->s_port);
978 return 0; /* not found */
982 * Fill the body of the command with the list of port ranges.
985 fill_newports(ipfw_insn_u16 *cmd, char *av, int proto, int cblen)
987 uint16_t a, b, *p = cmd->ports;
992 a = strtoport(av, &s, 0, proto);
993 if (s == av) /* empty or invalid argument */
996 CHECK_LENGTH(cblen, i + 2);
999 case '-': /* a range */
1001 b = strtoport(av, &s, 0, proto);
1002 /* Reject expressions like '1-abc' or '1-2-3'. */
1003 if (s == av || (*s != ',' && *s != '\0'))
1008 case ',': /* comma separated list */
1013 warnx("port list: invalid separator <%c> in <%s>",
1023 if (i + 1 > F_LEN_MASK)
1024 errx(EX_DATAERR, "too many ports/ranges\n");
1025 cmd->o.len |= i + 1; /* leave F_NOT and F_OR untouched */
1031 * Fill the body of the command with the list of DiffServ codepoints.
1034 fill_dscp(ipfw_insn *cmd, char *av, int cblen)
1036 uint32_t *low, *high;
1040 cmd->opcode = O_DSCP;
1041 cmd->len |= F_INSN_SIZE(ipfw_insn_u32) + 1;
1045 low = (uint32_t *)(cmd + 1);
1058 if ((code = match_token(f_ipdscp, s)) == -1)
1059 errx(EX_DATAERR, "Unknown DSCP code");
1061 code = strtoul(s, NULL, 10);
1062 if (code < 0 || code > 63)
1063 errx(EX_DATAERR, "Invalid DSCP value");
1067 *high |= 1 << (code - 32);
1075 static struct _s_x icmpcodes[] = {
1076 { "net", ICMP_UNREACH_NET },
1077 { "host", ICMP_UNREACH_HOST },
1078 { "protocol", ICMP_UNREACH_PROTOCOL },
1079 { "port", ICMP_UNREACH_PORT },
1080 { "needfrag", ICMP_UNREACH_NEEDFRAG },
1081 { "srcfail", ICMP_UNREACH_SRCFAIL },
1082 { "net-unknown", ICMP_UNREACH_NET_UNKNOWN },
1083 { "host-unknown", ICMP_UNREACH_HOST_UNKNOWN },
1084 { "isolated", ICMP_UNREACH_ISOLATED },
1085 { "net-prohib", ICMP_UNREACH_NET_PROHIB },
1086 { "host-prohib", ICMP_UNREACH_HOST_PROHIB },
1087 { "tosnet", ICMP_UNREACH_TOSNET },
1088 { "toshost", ICMP_UNREACH_TOSHOST },
1089 { "filter-prohib", ICMP_UNREACH_FILTER_PROHIB },
1090 { "host-precedence", ICMP_UNREACH_HOST_PRECEDENCE },
1091 { "precedence-cutoff", ICMP_UNREACH_PRECEDENCE_CUTOFF },
1096 fill_reject_code(u_short *codep, char *str)
1101 val = strtoul(str, &s, 0);
1102 if (s == str || *s != '\0' || val >= 0x100)
1103 val = match_token(icmpcodes, str);
1105 errx(EX_DATAERR, "unknown ICMP unreachable code ``%s''", str);
1111 print_reject_code(struct buf_pr *bp, uint16_t code)
1115 if ((s = match_value(icmpcodes, code)) != NULL)
1116 bprintf(bp, "unreach %s", s);
1118 bprintf(bp, "unreach %u", code);
1122 * Returns the number of bits set (from left) in a contiguous bitmask,
1123 * or -1 if the mask is not contiguous.
1124 * XXX this needs a proper fix.
1125 * This effectively works on masks in big-endian (network) format.
1126 * when compiled on little endian architectures.
1128 * First bit is bit 7 of the first byte -- note, for MAC addresses,
1129 * the first bit on the wire is bit 0 of the first byte.
1130 * len is the max length in bits.
1133 contigmask(uint8_t *p, int len)
1137 for (i=0; i<len ; i++)
1138 if ( (p[i/8] & (1 << (7 - (i%8)))) == 0) /* first bit unset */
1140 for (n=i+1; n < len; n++)
1141 if ( (p[n/8] & (1 << (7 - (n%8)))) != 0)
1142 return -1; /* mask not contiguous */
1147 * print flags set/clear in the two bitmasks passed as parameters.
1148 * There is a specialized check for f_tcpflags.
1151 print_flags(struct buf_pr *bp, char const *name, ipfw_insn *cmd,
1154 char const *comma = "";
1156 uint8_t set = cmd->arg1 & 0xff;
1157 uint8_t clear = (cmd->arg1 >> 8) & 0xff;
1159 if (list == f_tcpflags && set == TH_SYN && clear == TH_ACK) {
1160 bprintf(bp, " setup");
1164 bprintf(bp, " %s ", name);
1165 for (i=0; list[i].x != 0; i++) {
1166 if (set & list[i].x) {
1168 bprintf(bp, "%s%s", comma, list[i].s);
1171 if (clear & list[i].x) {
1172 clear &= ~list[i].x;
1173 bprintf(bp, "%s!%s", comma, list[i].s);
1181 * Print the ip address contained in a command.
1184 print_ip(struct buf_pr *bp, const struct format_opts *fo, ipfw_insn_ip *cmd)
1186 struct hostent *he = NULL;
1188 uint32_t len = F_LEN((ipfw_insn *)cmd);
1189 uint32_t *a = ((ipfw_insn_u32 *)cmd)->d;
1193 if (cmd->o.opcode == O_IP_DST_LOOKUP && len > F_INSN_SIZE(ipfw_insn_u32)) {
1195 const char *arg = "<invalid>";
1197 if (d < sizeof(lookup_key)/sizeof(lookup_key[0]))
1198 arg = match_value(rule_options, lookup_key[d]);
1199 t = table_search_ctlv(fo->tstate, ((ipfw_insn *)cmd)->arg1);
1200 bprintf(bp, "lookup %s %s", arg, t);
1203 if (cmd->o.opcode == O_IP_SRC_ME || cmd->o.opcode == O_IP_DST_ME) {
1207 if (cmd->o.opcode == O_IP_SRC_LOOKUP ||
1208 cmd->o.opcode == O_IP_DST_LOOKUP) {
1209 t = table_search_ctlv(fo->tstate, ((ipfw_insn *)cmd)->arg1);
1210 bprintf(bp, "table(%s", t);
1211 if (len == F_INSN_SIZE(ipfw_insn_u32))
1212 bprintf(bp, ",%u", *a);
1216 if (cmd->o.opcode == O_IP_SRC_SET || cmd->o.opcode == O_IP_DST_SET) {
1217 uint32_t x, *map = (uint32_t *)&(cmd->mask);
1221 x = cmd->o.arg1 - 1;
1223 cmd->addr.s_addr = htonl(cmd->addr.s_addr);
1224 bprintf(bp, "%s/%d", inet_ntoa(cmd->addr),
1225 contigmask((uint8_t *)&x, 32));
1226 x = cmd->addr.s_addr = htonl(cmd->addr.s_addr);
1227 x &= 0xff; /* base */
1229 * Print bits and ranges.
1230 * Locate first bit set (i), then locate first bit unset (j).
1231 * If we have 3+ consecutive bits set, then print them as a
1232 * range, otherwise only print the initial bit and rescan.
1234 for (i=0; i < cmd->o.arg1; i++)
1235 if (map[i/32] & (1<<(i & 31))) {
1236 for (j=i+1; j < cmd->o.arg1; j++)
1237 if (!(map[ j/32] & (1<<(j & 31))))
1239 bprintf(bp, "%c%d", comma, i+x);
1240 if (j>i+2) { /* range has at least 3 elements */
1241 bprintf(bp, "-%d", j-1+x);
1250 * len == 2 indicates a single IP, whereas lists of 1 or more
1251 * addr/mask pairs have len = (2n+1). We convert len to n so we
1252 * use that to count the number of entries.
1254 for (len = len / 2; len > 0; len--, a += 2) {
1255 int mb = /* mask length */
1256 (cmd->o.opcode == O_IP_SRC || cmd->o.opcode == O_IP_DST) ?
1257 32 : contigmask((uint8_t *)&(a[1]), 32);
1258 if (mb == 32 && co.do_resolv)
1259 he = gethostbyaddr((char *)&(a[0]), sizeof(u_long), AF_INET);
1260 if (he != NULL) /* resolved to name */
1261 bprintf(bp, "%s", he->h_name);
1262 else if (mb == 0) /* any */
1264 else { /* numeric IP followed by some kind of mask */
1265 ia = (struct in_addr *)&a[0];
1266 bprintf(bp, "%s", inet_ntoa(*ia));
1268 ia = (struct in_addr *)&a[1];
1269 bprintf(bp, ":%s", inet_ntoa(*ia));
1271 bprintf(bp, "/%d", mb);
1279 * prints a MAC address/mask pair
1282 format_mac(struct buf_pr *bp, uint8_t *addr, uint8_t *mask)
1284 int l = contigmask(mask, 48);
1287 bprintf(bp, " any");
1289 bprintf(bp, " %02x:%02x:%02x:%02x:%02x:%02x",
1290 addr[0], addr[1], addr[2], addr[3], addr[4], addr[5]);
1292 bprintf(bp, "&%02x:%02x:%02x:%02x:%02x:%02x",
1293 mask[0], mask[1], mask[2],
1294 mask[3], mask[4], mask[5]);
1296 bprintf(bp, "/%d", l);
1301 print_mac(struct buf_pr *bp, ipfw_insn_mac *mac)
1304 bprintf(bp, " MAC");
1305 format_mac(bp, mac->addr, mac->mask);
1306 format_mac(bp, mac->addr + 6, mac->mask + 6);
1310 fill_icmptypes(ipfw_insn_u32 *cmd, char *av)
1319 type = strtoul(av, &av, 0);
1321 if (*av != ',' && *av != '\0')
1322 errx(EX_DATAERR, "invalid ICMP type");
1325 errx(EX_DATAERR, "ICMP type out of range");
1327 cmd->d[0] |= 1 << type;
1329 cmd->o.opcode = O_ICMPTYPE;
1330 cmd->o.len |= F_INSN_SIZE(ipfw_insn_u32);
1334 print_icmptypes(struct buf_pr *bp, ipfw_insn_u32 *cmd)
1339 bprintf(bp, " icmptypes");
1340 for (i = 0; i < 32; i++) {
1341 if ( (cmd->d[0] & (1 << (i))) == 0)
1343 bprintf(bp, "%c%d", sep, i);
1349 print_dscp(struct buf_pr *bp, ipfw_insn_u32 *cmd)
1356 bprintf(bp, " dscp");
1359 if (*v & (1 << i)) {
1360 if ((code = match_value(f_ipdscp, i)) != NULL)
1361 bprintf(bp, "%c%s", sep, code);
1363 bprintf(bp, "%c%d", sep, i);
1367 if ((++i % 32) == 0)
1372 #define insntod(cmd, type) ((ipfw_insn_ ## type *)(cmd))
1374 struct ip_fw_rule *rule;
1375 const ipfw_insn *eaction;
1378 #define HAVE_PROTO 0x0001
1379 #define HAVE_SRCIP 0x0002
1380 #define HAVE_DSTIP 0x0004
1381 #define HAVE_PROBE_STATE 0x0008
1387 init_show_state(struct show_state *state, struct ip_fw_rule *rule)
1390 state->printed = calloc(rule->cmd_len, sizeof(uint8_t));
1391 if (state->printed == NULL)
1394 state->eaction = NULL;
1397 state->or_block = 0;
1402 free_show_state(struct show_state *state)
1405 free(state->printed);
1409 is_printed_opcode(struct show_state *state, const ipfw_insn *cmd)
1412 return (state->printed[cmd - state->rule->cmd]);
1416 mark_printed(struct show_state *state, const ipfw_insn *cmd)
1419 state->printed[cmd - state->rule->cmd] = 1;
1423 print_limit_mask(struct buf_pr *bp, const ipfw_insn_limit *limit)
1425 struct _s_x *p = limit_masks;
1426 char const *comma = " ";
1429 for (x = limit->limit_mask; p->x != 0; p++) {
1430 if ((x & p->x) == p->x) {
1432 bprintf(bp, "%s%s", comma, p->s);
1436 bprint_uint_arg(bp, " ", limit->conn_limit);
1440 print_instruction(struct buf_pr *bp, const struct format_opts *fo,
1441 struct show_state *state, ipfw_insn *cmd)
1443 struct protoent *pe;
1449 if (is_printed_opcode(state, cmd))
1451 if ((cmd->len & F_OR) != 0 && state->or_block == 0)
1453 if (cmd->opcode != O_IN && (cmd->len & F_NOT) != 0)
1454 bprintf(bp, " not");
1456 switch (cmd->opcode) {
1458 d = 1.0 * insntod(cmd, u32)->d[0] / 0x7fffffff;
1459 bprintf(bp, "prob %f ", d);
1461 case O_PROBE_STATE: /* no need to print anything here */
1462 state->flags |= HAVE_PROBE_STATE;
1465 case O_IP_SRC_LOOKUP:
1469 if (state->flags & HAVE_SRCIP)
1470 bprintf(bp, " src-ip");
1471 print_ip(bp, fo, insntod(cmd, ip));
1474 case O_IP_DST_LOOKUP:
1478 if (state->flags & HAVE_DSTIP)
1479 bprintf(bp, " dst-ip");
1480 print_ip(bp, fo, insntod(cmd, ip));
1483 case O_IP6_SRC_MASK:
1485 if (state->flags & HAVE_SRCIP)
1486 bprintf(bp, " src-ip6");
1487 print_ip6(bp, insntod(cmd, ip6));
1490 case O_IP6_DST_MASK:
1492 if (state->flags & HAVE_DSTIP)
1493 bprintf(bp, " dst-ip6");
1494 print_ip6(bp, insntod(cmd, ip6));
1497 print_flow6id(bp, insntod(cmd, u32));
1501 print_newports(bp, insntod(cmd, u16), state->proto,
1502 (state->flags & (HAVE_SRCIP | HAVE_DSTIP)) ==
1503 (HAVE_SRCIP | HAVE_DSTIP) ? cmd->opcode: 0);
1506 pe = getprotobynumber(cmd->arg1);
1507 if (state->flags & HAVE_PROTO)
1508 bprintf(bp, " proto");
1510 bprintf(bp, " %s", pe->p_name);
1512 bprintf(bp, " %u", cmd->arg1);
1515 print_mac(bp, insntod(cmd, mac));
1518 print_newports(bp, insntod(cmd, u16),
1519 IPPROTO_ETHERTYPE, cmd->opcode);
1522 bprintf(bp, " frag");
1525 bprintf(bp, " fib %u", cmd->arg1);
1528 bprintf(bp, " sockarg");
1531 bprintf(bp, cmd->len & F_NOT ? " out" : " in");
1534 switch (cmd->arg1) {
1536 bprintf(bp, " diverted");
1539 bprintf(bp, " diverted-output");
1542 bprintf(bp, " diverted-loopback");
1545 bprintf(bp, " diverted-?<%u>", cmd->arg1);
1550 bprintf(bp, " layer2");
1555 if (cmd->opcode == O_XMIT)
1557 else if (cmd->opcode == O_RECV)
1559 else /* if (cmd->opcode == O_VIA) */
1561 switch (insntod(cmd, if)->name[0]) {
1563 bprintf(bp, " %s %s", s,
1564 inet_ntoa(insntod(cmd, if)->p.ip));
1567 bprintf(bp, " %s table(%s)", s,
1568 table_search_ctlv(fo->tstate,
1569 insntod(cmd, if)->p.kidx));
1572 bprintf(bp, " %s %s", s,
1573 insntod(cmd, if)->name);
1576 case O_IP_FLOW_LOOKUP:
1577 s = table_search_ctlv(fo->tstate, cmd->arg1);
1578 bprintf(bp, " flow table(%s", s);
1579 if (F_LEN(cmd) == F_INSN_SIZE(ipfw_insn_u32))
1580 bprintf(bp, ",%u", insntod(cmd, u32)->d[0]);
1588 if (F_LEN(cmd) == 1) {
1589 switch (cmd->opcode) {
1606 bprintf(bp, " %s %u", s, cmd->arg1);
1608 print_newports(bp, insntod(cmd, u16), 0,
1612 bprintf(bp, " ipver %u", cmd->arg1);
1614 case O_IPPRECEDENCE:
1615 bprintf(bp, " ipprecedence %u", cmd->arg1 >> 5);
1618 print_dscp(bp, insntod(cmd, u32));
1621 print_flags(bp, "ipoptions", cmd, f_ipopts);
1624 print_flags(bp, "iptos", cmd, f_iptos);
1627 print_icmptypes(bp, insntod(cmd, u32));
1630 bprintf(bp, " established");
1633 print_flags(bp, "tcpflags", cmd, f_tcpflags);
1636 print_flags(bp, "tcpoptions", cmd, f_tcpopts);
1639 bprintf(bp, " tcpack %d",
1640 ntohl(insntod(cmd, u32)->d[0]));
1643 bprintf(bp, " tcpseq %d",
1644 ntohl(insntod(cmd, u32)->d[0]));
1647 pwd = getpwuid(insntod(cmd, u32)->d[0]);
1649 bprintf(bp, " uid %s", pwd->pw_name);
1651 bprintf(bp, " uid %u",
1652 insntod(cmd, u32)->d[0]);
1655 grp = getgrgid(insntod(cmd, u32)->d[0]);
1657 bprintf(bp, " gid %s", grp->gr_name);
1659 bprintf(bp, " gid %u",
1660 insntod(cmd, u32)->d[0]);
1663 bprintf(bp, " jail %d", insntod(cmd, u32)->d[0]);
1666 bprintf(bp, " verrevpath");
1669 bprintf(bp, " versrcreach");
1672 bprintf(bp, " antispoof");
1675 bprintf(bp, " ipsec");
1678 bprintf(bp, " // %s", (char *)(cmd + 1));
1681 if (state->flags & HAVE_PROBE_STATE)
1682 bprintf(bp, " keep-state");
1684 bprintf(bp, " record-state");
1686 object_search_ctlv(fo->tstate, cmd->arg1,
1687 IPFW_TLV_STATE_NAME));
1690 if (state->flags & HAVE_PROBE_STATE)
1691 bprintf(bp, " limit");
1693 bprintf(bp, " set-limit");
1694 print_limit_mask(bp, insntod(cmd, limit));
1696 object_search_ctlv(fo->tstate, cmd->arg1,
1697 IPFW_TLV_STATE_NAME));
1700 bprintf(bp, " ip6");
1703 bprintf(bp, " ip4");
1706 print_icmp6types(bp, insntod(cmd, u32));
1709 print_ext6hdr(bp, cmd);
1712 if (F_LEN(cmd) == 1)
1713 bprint_uint_arg(bp, " tagged ", cmd->arg1);
1715 print_newports(bp, insntod(cmd, u16),
1719 bprintf(bp, " defer-immediate-action");
1722 bprintf(bp, " [opcode %d len %d]", cmd->opcode,
1725 if (cmd->len & F_OR) {
1727 state->or_block = 1;
1728 } else if (state->or_block != 0) {
1730 state->or_block = 0;
1732 mark_printed(state, cmd);
1738 print_opcode(struct buf_pr *bp, struct format_opts *fo,
1739 struct show_state *state, int opcode)
1744 for (l = state->rule->act_ofs, cmd = state->rule->cmd;
1745 l > 0; l -= F_LEN(cmd), cmd += F_LEN(cmd)) {
1746 /* We use zero opcode to print the rest of options */
1747 if (opcode >= 0 && cmd->opcode != opcode)
1750 * Skip O_NOP, when we printing the rest
1751 * of options, it will be handled separately.
1753 if (cmd->opcode == O_NOP && opcode != O_NOP)
1755 if (!print_instruction(bp, fo, state, cmd))
1763 print_fwd(struct buf_pr *bp, const ipfw_insn *cmd)
1765 char buf[INET6_ADDRSTRLEN + IF_NAMESIZE + 2];
1770 if (cmd->opcode == O_FORWARD_IP) {
1771 sa = insntod(cmd, sa);
1772 port = sa->sa.sin_port;
1773 if (sa->sa.sin_addr.s_addr == INADDR_ANY)
1774 bprintf(bp, "fwd tablearg");
1776 bprintf(bp, "fwd %s", inet_ntoa(sa->sa.sin_addr));
1778 sa6 = insntod(cmd, sa6);
1779 port = sa6->sa.sin6_port;
1780 bprintf(bp, "fwd ");
1781 if (getnameinfo((const struct sockaddr *)&sa6->sa,
1782 sizeof(struct sockaddr_in6), buf, sizeof(buf), NULL, 0,
1783 NI_NUMERICHOST) == 0)
1784 bprintf(bp, "%s", buf);
1787 bprintf(bp, ",%u", port);
1791 print_action_instruction(struct buf_pr *bp, const struct format_opts *fo,
1792 struct show_state *state, const ipfw_insn *cmd)
1796 if (is_printed_opcode(state, cmd))
1798 switch (cmd->opcode) {
1800 bprintf(bp, "check-state");
1802 s = object_search_ctlv(fo->tstate, cmd->arg1,
1803 IPFW_TLV_STATE_NAME);
1806 bprintf(bp, " :%s", s ? s: "any");
1809 bprintf(bp, "allow");
1812 bprintf(bp, "count");
1815 bprintf(bp, "deny");
1818 if (cmd->arg1 == ICMP_REJECT_RST)
1819 bprintf(bp, "reset");
1820 else if (cmd->arg1 == ICMP_REJECT_ABORT)
1821 bprintf(bp, "abort");
1822 else if (cmd->arg1 == ICMP_UNREACH_HOST)
1823 bprintf(bp, "reject");
1825 print_reject_code(bp, cmd->arg1);
1828 if (cmd->arg1 == ICMP6_UNREACH_RST)
1829 bprintf(bp, "reset6");
1830 else if (cmd->arg1 == ICMP6_UNREACH_ABORT)
1831 bprintf(bp, "abort6");
1833 print_unreach6_code(bp, cmd->arg1);
1836 bprint_uint_arg(bp, "skipto ", cmd->arg1);
1839 bprint_uint_arg(bp, "pipe ", cmd->arg1);
1842 bprint_uint_arg(bp, "queue ", cmd->arg1);
1845 bprint_uint_arg(bp, "divert ", cmd->arg1);
1848 bprint_uint_arg(bp, "tee ", cmd->arg1);
1851 bprint_uint_arg(bp, "netgraph ", cmd->arg1);
1854 bprint_uint_arg(bp, "ngtee ", cmd->arg1);
1861 if (insntod(cmd, log)->max_log > 0)
1862 bprintf(bp, " log logamount %d",
1863 insntod(cmd, log)->max_log);
1865 bprintf(bp, " log");
1869 print_altq_cmd(bp, insntod(cmd, altq));
1873 bprint_uint_arg(bp, cmd->len & F_NOT ? " untag ":
1874 " tag ", cmd->arg1);
1877 if (cmd->arg1 != IP_FW_NAT44_GLOBAL)
1878 bprint_uint_arg(bp, "nat ", cmd->arg1);
1880 bprintf(bp, "nat global");
1883 if (cmd->arg1 == IP_FW_TARG)
1884 bprint_uint_arg(bp, "setfib ", cmd->arg1);
1886 bprintf(bp, "setfib %u", cmd->arg1 & 0x7FFF);
1888 case O_EXTERNAL_ACTION:
1890 * The external action can consists of two following
1891 * each other opcodes - O_EXTERNAL_ACTION and
1892 * O_EXTERNAL_INSTANCE. The first contains the ID of
1893 * name of external action. The second contains the ID
1894 * of name of external action instance.
1895 * NOTE: in case when external action has no named
1896 * instances support, the second opcode isn't needed.
1898 state->eaction = cmd;
1899 s = object_search_ctlv(fo->tstate, cmd->arg1,
1901 if (match_token(rule_eactions, s) != -1)
1902 bprintf(bp, "%s", s);
1904 bprintf(bp, "eaction %s", s);
1906 case O_EXTERNAL_INSTANCE:
1907 if (state->eaction == NULL)
1910 * XXX: we need to teach ipfw(9) to rewrite opcodes
1911 * in the user buffer on rule addition. When we add
1912 * the rule, we specify zero TLV type for
1913 * O_EXTERNAL_INSTANCE object. To show correct
1914 * rule after `ipfw add` we need to search instance
1915 * name with zero type. But when we do `ipfw show`
1916 * we calculate TLV type using IPFW_TLV_EACTION_NAME()
1919 s = object_search_ctlv(fo->tstate, cmd->arg1, 0);
1921 s = object_search_ctlv(fo->tstate,
1922 cmd->arg1, IPFW_TLV_EACTION_NAME(
1923 state->eaction->arg1));
1924 bprintf(bp, " %s", s);
1926 case O_EXTERNAL_DATA:
1927 if (state->eaction == NULL)
1930 * Currently we support data formatting only for
1931 * external data with datalen u16. For unknown data
1932 * print its size in bytes.
1934 if (cmd->len == F_INSN_SIZE(ipfw_insn))
1935 bprintf(bp, " %u", cmd->arg1);
1937 bprintf(bp, " %ubytes",
1938 cmd->len * sizeof(uint32_t));
1941 if (cmd->arg1 == IP_FW_TARG) {
1942 bprintf(bp, "setdscp tablearg");
1945 s = match_value(f_ipdscp, cmd->arg1 & 0x3F);
1947 bprintf(bp, "setdscp %s", s);
1949 bprintf(bp, "setdscp %u", cmd->arg1 & 0x3F);
1952 bprintf(bp, "reass");
1955 if (cmd->len & F_NOT)
1956 bprintf(bp, "return");
1958 bprint_uint_arg(bp, "call ", cmd->arg1);
1961 bprintf(bp, "** unrecognized action %d len %d ",
1962 cmd->opcode, cmd->len);
1964 mark_printed(state, cmd);
1971 print_action(struct buf_pr *bp, struct format_opts *fo,
1972 struct show_state *state, uint8_t opcode)
1977 for (l = state->rule->cmd_len - state->rule->act_ofs,
1978 cmd = ACTION_PTR(state->rule); l > 0;
1979 l -= F_LEN(cmd), cmd += F_LEN(cmd)) {
1980 if (cmd->opcode != opcode)
1982 if (!print_action_instruction(bp, fo, state, cmd))
1990 print_proto(struct buf_pr *bp, struct format_opts *fo,
1991 struct show_state *state)
1994 int l, proto, ip4, ip6, tmp;
1996 /* Count all O_PROTO, O_IP4, O_IP6 instructions. */
1997 proto = tmp = ip4 = ip6 = 0;
1998 for (l = state->rule->act_ofs, cmd = state->rule->cmd;
1999 l > 0; l -= F_LEN(cmd), cmd += F_LEN(cmd)) {
2000 switch (cmd->opcode) {
2006 if (cmd->len & F_OR)
2011 if (cmd->len & F_OR)
2018 if (proto == 0 && ip4 == 0 && ip6 == 0) {
2019 state->proto = IPPROTO_IP;
2020 state->flags |= HAVE_PROTO;
2024 /* To handle the case { ip4 or ip6 }, print opcode with F_OR first */
2027 cmd = print_opcode(bp, fo, state, ip4 > ip6 ? O_IP4: O_IP6);
2028 if (cmd != NULL && (cmd->len & F_OR))
2029 cmd = print_opcode(bp, fo, state, ip4 > ip6 ? O_IP6: O_IP4);
2030 if (cmd == NULL || (cmd->len & F_OR))
2031 for (l = proto; l > 0; l--) {
2032 cmd = print_opcode(bp, fo, state, O_PROTO);
2033 if (cmd != NULL && (cmd->len & F_OR) == 0)
2037 /* Initialize proto, it is used by print_newports() */
2041 state->proto = IPPROTO_IPV6;
2043 state->proto = IPPROTO_IP;
2044 state->flags |= HAVE_PROTO;
2048 match_opcode(int opcode, const int opcodes[], size_t nops)
2052 for (i = 0; i < nops; i++)
2053 if (opcode == opcodes[i])
2059 print_address(struct buf_pr *bp, struct format_opts *fo,
2060 struct show_state *state, const int opcodes[], size_t nops, int portop,
2064 int count, l, portcnt, pf;
2066 count = portcnt = 0;
2067 for (l = state->rule->act_ofs, cmd = state->rule->cmd;
2068 l > 0; l -= F_LEN(cmd), cmd += F_LEN(cmd)) {
2069 if (match_opcode(cmd->opcode, opcodes, nops))
2071 else if (cmd->opcode == portop)
2075 bprintf(bp, " any");
2076 for (l = state->rule->act_ofs, cmd = state->rule->cmd;
2077 l > 0 && count > 0; l -= F_LEN(cmd), cmd += F_LEN(cmd)) {
2078 if (!match_opcode(cmd->opcode, opcodes, nops))
2080 print_instruction(bp, fo, state, cmd);
2081 if ((cmd->len & F_OR) == 0)
2086 * If several O_IP_?PORT opcodes specified, leave them to the
2090 for (l = state->rule->act_ofs, cmd = state->rule->cmd, pf = 0;
2091 l > 0; l -= F_LEN(cmd), cmd += F_LEN(cmd)) {
2092 if (cmd->opcode != portop) {
2093 pf = (cmd->len & F_OR);
2096 /* Print opcode iff it is not in OR block. */
2097 if (pf == 0 && (cmd->len & F_OR) == 0)
2098 print_instruction(bp, fo, state, cmd);
2102 state->flags |= flag;
2105 static const int action_opcodes[] = {
2106 O_CHECK_STATE, O_ACCEPT, O_COUNT, O_DENY, O_REJECT,
2107 O_UNREACH6, O_SKIPTO, O_PIPE, O_QUEUE, O_DIVERT, O_TEE,
2108 O_NETGRAPH, O_NGTEE, O_FORWARD_IP, O_FORWARD_IP6, O_NAT,
2109 O_SETFIB, O_SETDSCP, O_REASS, O_CALLRETURN,
2110 /* keep the following opcodes at the end of the list */
2111 O_EXTERNAL_ACTION, O_EXTERNAL_INSTANCE, O_EXTERNAL_DATA
2114 static const int modifier_opcodes[] = {
2115 O_LOG, O_ALTQ, O_TAG
2118 static const int src_opcodes[] = {
2119 O_IP_SRC, O_IP_SRC_LOOKUP, O_IP_SRC_MASK, O_IP_SRC_ME,
2120 O_IP_SRC_SET, O_IP6_SRC, O_IP6_SRC_MASK, O_IP6_SRC_ME
2123 static const int dst_opcodes[] = {
2124 O_IP_DST, O_IP_DST_LOOKUP, O_IP_DST_MASK, O_IP_DST_ME,
2125 O_IP_DST_SET, O_IP6_DST, O_IP6_DST_MASK, O_IP6_DST_ME
2129 show_static_rule(struct cmdline_opts *co, struct format_opts *fo,
2130 struct buf_pr *bp, struct ip_fw_rule *rule, struct ip_fw_bcounter *cntr)
2132 struct show_state state;
2134 static int twidth = 0;
2137 /* Print # DISABLED or skip the rule */
2138 if ((fo->set_mask & (1 << rule->set)) == 0) {
2143 bprintf(bp, "# DISABLED ");
2145 if (init_show_state(&state, rule) != 0) {
2146 warn("init_show_state() failed");
2149 bprintf(bp, "%05u ", rule->rulenum);
2151 /* Print counters if enabled */
2152 if (fo->pcwidth > 0 || fo->bcwidth > 0) {
2153 pr_u64(bp, &cntr->pcnt, fo->pcwidth);
2154 pr_u64(bp, &cntr->bcnt, fo->bcwidth);
2157 /* Print timestamp */
2158 if (co->do_time == TIMESTAMP_NUMERIC)
2159 bprintf(bp, "%10u ", cntr->timestamp);
2160 else if (co->do_time == TIMESTAMP_STRING) {
2162 time_t t = (time_t)0;
2165 strcpy(timestr, ctime(&t));
2166 *strchr(timestr, '\n') = '\0';
2167 twidth = strlen(timestr);
2169 if (cntr->timestamp > 0) {
2170 t = _long_to_time(cntr->timestamp);
2172 strcpy(timestr, ctime(&t));
2173 *strchr(timestr, '\n') = '\0';
2174 bprintf(bp, "%s ", timestr);
2176 bprintf(bp, "%*s", twidth, " ");
2180 /* Print set number */
2182 bprintf(bp, "set %d ", rule->set);
2184 /* Print the optional "match probability" */
2185 cmd = print_opcode(bp, fo, &state, O_PROB);
2186 /* Print rule action */
2187 for (i = 0; i < nitems(action_opcodes); i++) {
2188 cmd = print_action(bp, fo, &state, action_opcodes[i]);
2191 /* Handle special cases */
2192 switch (cmd->opcode) {
2195 case O_EXTERNAL_ACTION:
2196 case O_EXTERNAL_INSTANCE:
2197 /* External action can have several instructions */
2202 /* Print rule modifiers */
2203 for (i = 0; i < nitems(modifier_opcodes); i++)
2204 print_action(bp, fo, &state, modifier_opcodes[i]);
2208 if (co->comment_only != 0)
2210 print_proto(bp, fo, &state);
2213 bprintf(bp, " from");
2214 print_address(bp, fo, &state, src_opcodes, nitems(src_opcodes),
2215 O_IP_SRCPORT, HAVE_SRCIP);
2217 /* Print destination */
2219 print_address(bp, fo, &state, dst_opcodes, nitems(dst_opcodes),
2220 O_IP_DSTPORT, HAVE_DSTIP);
2222 /* Print the rest of options */
2223 while (print_opcode(bp, fo, &state, -1))
2226 /* Print comment at the end */
2227 cmd = print_opcode(bp, fo, &state, O_NOP);
2228 if (co->comment_only != 0 && cmd == NULL)
2229 bprintf(bp, " // ...");
2231 free_show_state(&state);
2235 show_dyn_state(struct cmdline_opts *co, struct format_opts *fo,
2236 struct buf_pr *bp, ipfw_dyn_rule *d)
2238 struct protoent *pe;
2241 char buf[INET6_ADDRSTRLEN];
2243 if (!co->do_expired) {
2244 if (!d->expire && !(d->dyn_type == O_LIMIT_PARENT))
2247 bcopy(&d->rule, &rulenum, sizeof(rulenum));
2248 bprintf(bp, "%05d", rulenum);
2249 if (fo->pcwidth > 0 || fo->bcwidth > 0) {
2251 pr_u64(bp, &d->pcnt, fo->pcwidth);
2252 pr_u64(bp, &d->bcnt, fo->bcwidth);
2253 bprintf(bp, "(%ds)", d->expire);
2255 switch (d->dyn_type) {
2256 case O_LIMIT_PARENT:
2257 bprintf(bp, " PARENT %d", d->count);
2260 bprintf(bp, " LIMIT");
2262 case O_KEEP_STATE: /* bidir, no mask */
2263 bprintf(bp, " STATE");
2267 if ((pe = getprotobynumber(d->id.proto)) != NULL)
2268 bprintf(bp, " %s", pe->p_name);
2270 bprintf(bp, " proto %u", d->id.proto);
2272 if (d->id.addr_type == 4) {
2273 a.s_addr = htonl(d->id.src_ip);
2274 bprintf(bp, " %s %d", inet_ntoa(a), d->id.src_port);
2276 a.s_addr = htonl(d->id.dst_ip);
2277 bprintf(bp, " <-> %s %d", inet_ntoa(a), d->id.dst_port);
2278 } else if (d->id.addr_type == 6) {
2279 bprintf(bp, " %s %d", inet_ntop(AF_INET6, &d->id.src_ip6, buf,
2280 sizeof(buf)), d->id.src_port);
2281 bprintf(bp, " <-> %s %d", inet_ntop(AF_INET6, &d->id.dst_ip6,
2282 buf, sizeof(buf)), d->id.dst_port);
2284 bprintf(bp, " UNKNOWN <-> UNKNOWN");
2286 bprintf(bp, " :%s", object_search_ctlv(fo->tstate,
2287 d->kidx, IPFW_TLV_STATE_NAME));
2291 do_range_cmd(int cmd, ipfw_range_tlv *rt)
2293 ipfw_range_header rh;
2296 memset(&rh, 0, sizeof(rh));
2297 memcpy(&rh.range, rt, sizeof(*rt));
2298 rh.range.head.length = sizeof(*rt);
2299 rh.range.head.type = IPFW_TLV_RANGE;
2302 if (do_get3(cmd, &rh.opheader, &sz) != 0)
2304 /* Save number of matched objects */
2305 rt->new_set = rh.range.new_set;
2310 * This one handles all set-related commands
2311 * ipfw set { show | enable | disable }
2313 * ipfw set move X to Y
2314 * ipfw set move rule X to Y
2317 ipfw_sets_handler(char *av[])
2328 memset(&rt, 0, sizeof(rt));
2331 errx(EX_USAGE, "set needs command");
2332 if (_substrcmp(*av, "show") == 0) {
2333 struct format_opts fo;
2334 ipfw_cfg_lheader *cfg;
2336 memset(&fo, 0, sizeof(fo));
2337 if (ipfw_get_config(&co, &fo, &cfg, &size) != 0)
2338 err(EX_OSERR, "requesting config failed");
2340 for (i = 0, msg = "disable"; i < RESVD_SET; i++)
2341 if ((cfg->set_mask & (1<<i)) == 0) {
2342 printf("%s %d", msg, i);
2345 msg = (cfg->set_mask != (uint32_t)-1) ? " enable" : "enable";
2346 for (i = 0; i < RESVD_SET; i++)
2347 if ((cfg->set_mask & (1<<i)) != 0) {
2348 printf("%s %d", msg, i);
2353 } else if (_substrcmp(*av, "swap") == 0) {
2355 if ( av[0] == NULL || av[1] == NULL )
2356 errx(EX_USAGE, "set swap needs 2 set numbers\n");
2357 rt.set = atoi(av[0]);
2358 rt.new_set = atoi(av[1]);
2359 if (!isdigit(*(av[0])) || rt.set > RESVD_SET)
2360 errx(EX_DATAERR, "invalid set number %s\n", av[0]);
2361 if (!isdigit(*(av[1])) || rt.new_set > RESVD_SET)
2362 errx(EX_DATAERR, "invalid set number %s\n", av[1]);
2363 i = do_range_cmd(IP_FW_SET_SWAP, &rt);
2364 } else if (_substrcmp(*av, "move") == 0) {
2366 if (av[0] && _substrcmp(*av, "rule") == 0) {
2367 rt.flags = IPFW_RCFLAG_RANGE; /* move rules to new set */
2371 cmd = IP_FW_SET_MOVE; /* Move set to new one */
2372 if (av[0] == NULL || av[1] == NULL || av[2] == NULL ||
2373 av[3] != NULL || _substrcmp(av[1], "to") != 0)
2374 errx(EX_USAGE, "syntax: set move [rule] X to Y\n");
2375 rulenum = atoi(av[0]);
2376 rt.new_set = atoi(av[2]);
2377 if (cmd == IP_FW_XMOVE) {
2378 rt.start_rule = rulenum;
2379 rt.end_rule = rulenum;
2382 rt.new_set = atoi(av[2]);
2383 if (!isdigit(*(av[0])) || (cmd == 3 && rt.set > RESVD_SET) ||
2384 (cmd == 2 && rt.start_rule == IPFW_DEFAULT_RULE) )
2385 errx(EX_DATAERR, "invalid source number %s\n", av[0]);
2386 if (!isdigit(*(av[2])) || rt.new_set > RESVD_SET)
2387 errx(EX_DATAERR, "invalid dest. set %s\n", av[1]);
2388 i = do_range_cmd(cmd, &rt);
2390 err(EX_OSERR, "failed to move %s",
2391 cmd == IP_FW_SET_MOVE ? "set": "rule");
2392 } else if (_substrcmp(*av, "disable") == 0 ||
2393 _substrcmp(*av, "enable") == 0 ) {
2394 int which = _substrcmp(*av, "enable") == 0 ? 1 : 0;
2397 masks[0] = masks[1] = 0;
2400 if (isdigit(**av)) {
2402 if (i < 0 || i > RESVD_SET)
2404 "invalid set number %d\n", i);
2405 masks[which] |= (1<<i);
2406 } else if (_substrcmp(*av, "disable") == 0)
2408 else if (_substrcmp(*av, "enable") == 0)
2412 "invalid set command %s\n", *av);
2415 if ( (masks[0] & masks[1]) != 0 )
2417 "cannot enable and disable the same set\n");
2420 rt.new_set = masks[1];
2421 i = do_range_cmd(IP_FW_SET_ENABLE, &rt);
2423 warn("set enable/disable: setsockopt(IP_FW_SET_ENABLE)");
2425 errx(EX_USAGE, "invalid set command %s\n", *av);
2429 ipfw_sysctl_handler(char *av[], int which)
2433 if (av[0] == NULL) {
2434 warnx("missing keyword to enable/disable\n");
2435 } else if (_substrcmp(*av, "firewall") == 0) {
2436 sysctlbyname("net.inet.ip.fw.enable", NULL, 0,
2437 &which, sizeof(which));
2438 sysctlbyname("net.inet6.ip6.fw.enable", NULL, 0,
2439 &which, sizeof(which));
2440 } else if (_substrcmp(*av, "one_pass") == 0) {
2441 sysctlbyname("net.inet.ip.fw.one_pass", NULL, 0,
2442 &which, sizeof(which));
2443 } else if (_substrcmp(*av, "debug") == 0) {
2444 sysctlbyname("net.inet.ip.fw.debug", NULL, 0,
2445 &which, sizeof(which));
2446 } else if (_substrcmp(*av, "verbose") == 0) {
2447 sysctlbyname("net.inet.ip.fw.verbose", NULL, 0,
2448 &which, sizeof(which));
2449 } else if (_substrcmp(*av, "dyn_keepalive") == 0) {
2450 sysctlbyname("net.inet.ip.fw.dyn_keepalive", NULL, 0,
2451 &which, sizeof(which));
2453 } else if (_substrcmp(*av, "altq") == 0) {
2454 altq_set_enabled(which);
2457 warnx("unrecognize enable/disable keyword: %s\n", *av);
2461 typedef void state_cb(struct cmdline_opts *co, struct format_opts *fo,
2462 void *arg, void *state);
2465 prepare_format_dyn(struct cmdline_opts *co, struct format_opts *fo,
2466 void *arg, void *_state)
2472 d = (ipfw_dyn_rule *)_state;
2473 /* Count _ALL_ states */
2476 if (fo->show_counters == 0)
2480 /* skip states from another set */
2481 bcopy((char *)&d->rule + sizeof(uint16_t), &set,
2483 if (set != co->use_set - 1)
2487 width = pr_u64(NULL, &d->pcnt, 0);
2488 if (width > fo->pcwidth)
2489 fo->pcwidth = width;
2491 width = pr_u64(NULL, &d->bcnt, 0);
2492 if (width > fo->bcwidth)
2493 fo->bcwidth = width;
2497 foreach_state(struct cmdline_opts *co, struct format_opts *fo,
2498 caddr_t base, size_t sz, state_cb dyn_bc, void *dyn_arg)
2504 ipfw_obj_ctlv *ctlv;
2510 ctlv = (ipfw_obj_ctlv *)base;
2511 switch (ctlv->head.type) {
2512 case IPFW_TLV_DYNSTATE_LIST:
2513 base += sizeof(*ctlv);
2514 sz -= sizeof(*ctlv);
2515 ttype = IPFW_TLV_DYN_ENT;
2524 tlv = (ipfw_obj_tlv *)base;
2525 if (tlv->type != ttype)
2528 fptr(co, fo, farg, tlv + 1);
2530 base += tlv->length;
2538 prepare_format_opts(struct cmdline_opts *co, struct format_opts *fo,
2539 ipfw_obj_tlv *rtlv, int rcnt, caddr_t dynbase, size_t dynsz)
2541 int bcwidth, pcwidth, width;
2543 struct ip_fw_bcounter *cntr;
2544 struct ip_fw_rule *r;
2548 if (fo->show_counters != 0) {
2549 for (n = 0; n < rcnt; n++,
2550 rtlv = (ipfw_obj_tlv *)((caddr_t)rtlv + rtlv->length)) {
2551 cntr = (struct ip_fw_bcounter *)(rtlv + 1);
2552 r = (struct ip_fw_rule *)((caddr_t)cntr + cntr->size);
2553 /* skip rules from another set */
2554 if (co->use_set && r->set != co->use_set - 1)
2557 /* packet counter */
2558 width = pr_u64(NULL, &cntr->pcnt, 0);
2559 if (width > pcwidth)
2563 width = pr_u64(NULL, &cntr->bcnt, 0);
2564 if (width > bcwidth)
2568 fo->bcwidth = bcwidth;
2569 fo->pcwidth = pcwidth;
2572 if (co->do_dynamic && dynsz > 0)
2573 foreach_state(co, fo, dynbase, dynsz, prepare_format_dyn, NULL);
2577 list_static_range(struct cmdline_opts *co, struct format_opts *fo,
2578 struct buf_pr *bp, ipfw_obj_tlv *rtlv, int rcnt)
2581 struct ip_fw_rule *r;
2582 struct ip_fw_bcounter *cntr;
2585 for (n = seen = 0; n < rcnt; n++,
2586 rtlv = (ipfw_obj_tlv *)((caddr_t)rtlv + rtlv->length)) {
2588 if ((fo->show_counters | fo->show_time) != 0) {
2589 cntr = (struct ip_fw_bcounter *)(rtlv + 1);
2590 r = (struct ip_fw_rule *)((caddr_t)cntr + cntr->size);
2593 r = (struct ip_fw_rule *)(rtlv + 1);
2595 if (r->rulenum > fo->last)
2597 if (co->use_set && r->set != co->use_set - 1)
2599 if (r->rulenum >= fo->first && r->rulenum <= fo->last) {
2600 show_static_rule(co, fo, bp, r, cntr);
2601 printf("%s", bp->buf);
2612 list_dyn_state(struct cmdline_opts *co, struct format_opts *fo,
2613 void *_arg, void *_state)
2620 d = (ipfw_dyn_rule *)_state;
2621 bp = (struct buf_pr *)_arg;
2623 bcopy(&d->rule, &rulenum, sizeof(rulenum));
2624 if (rulenum > fo->last)
2627 bcopy((char *)&d->rule + sizeof(uint16_t),
2628 &set, sizeof(uint8_t));
2629 if (set != co->use_set - 1)
2632 if (rulenum >= fo->first) {
2633 show_dyn_state(co, fo, bp, d);
2634 printf("%s\n", bp->buf);
2640 list_dyn_range(struct cmdline_opts *co, struct format_opts *fo,
2641 struct buf_pr *bp, caddr_t base, size_t sz)
2644 sz = foreach_state(co, fo, base, sz, list_dyn_state, bp);
2649 ipfw_list(int ac, char *av[], int show_counters)
2651 ipfw_cfg_lheader *cfg;
2652 struct format_opts sfo;
2661 fprintf(stderr, "Testing only, list disabled\n");
2665 dummynet_list(ac, av, show_counters);
2671 memset(&sfo, 0, sizeof(sfo));
2673 /* Determine rule range to request */
2675 for (lac = ac, lav = av; lac != 0; lac--) {
2676 rnum = strtoul(*lav++, &endptr, 10);
2677 if (sfo.first == 0 || rnum < sfo.first)
2681 rnum = strtoul(endptr + 1, &endptr, 10);
2682 if (sfo.last == 0 || rnum > sfo.last)
2687 /* get configuraion from kernel */
2689 sfo.show_counters = show_counters;
2690 sfo.show_time = co.do_time;
2691 sfo.flags = IPFW_CFG_GET_STATIC;
2692 if (co.do_dynamic != 0)
2693 sfo.flags |= IPFW_CFG_GET_STATES;
2694 if ((sfo.show_counters | sfo.show_time) != 0)
2695 sfo.flags |= IPFW_CFG_GET_COUNTERS;
2696 if (ipfw_get_config(&co, &sfo, &cfg, &sz) != 0)
2697 err(EX_OSERR, "retrieving config failed");
2699 error = ipfw_show_config(&co, &sfo, cfg, sz, ac, av);
2708 ipfw_show_config(struct cmdline_opts *co, struct format_opts *fo,
2709 ipfw_cfg_lheader *cfg, size_t sz, int ac, char *av[])
2714 int exitval = EX_OK;
2720 ipfw_obj_ctlv *ctlv, *tstate;
2721 ipfw_obj_tlv *rbase;
2724 * Handle tablenames TLV first, if any
2730 readsz = sizeof(*cfg);
2733 fo->set_mask = cfg->set_mask;
2735 ctlv = (ipfw_obj_ctlv *)(cfg + 1);
2737 if (cfg->flags & IPFW_CFG_GET_STATIC) {
2738 /* We've requested static rules */
2739 if (ctlv->head.type == IPFW_TLV_TBLNAME_LIST) {
2740 object_sort_ctlv(ctlv);
2742 readsz += ctlv->head.length;
2743 ctlv = (ipfw_obj_ctlv *)((caddr_t)ctlv +
2747 if (ctlv->head.type == IPFW_TLV_RULE_LIST) {
2748 rbase = (ipfw_obj_tlv *)(ctlv + 1);
2750 readsz += ctlv->head.length;
2751 ctlv = (ipfw_obj_ctlv *)((caddr_t)ctlv +
2756 if ((cfg->flags & IPFW_CFG_GET_STATES) && (readsz != sz)) {
2757 /* We may have some dynamic states */
2758 dynsz = sz - readsz;
2759 /* Skip empty header */
2760 if (dynsz != sizeof(ipfw_obj_ctlv))
2761 dynbase = (caddr_t)ctlv;
2766 prepare_format_opts(co, fo, rbase, rcnt, dynbase, dynsz);
2767 bp_alloc(&bp, 4096);
2769 /* if no rule numbers were specified, list all rules */
2772 fo->last = IPFW_DEFAULT_RULE;
2773 list_static_range(co, fo, &bp, rbase, rcnt);
2775 if (co->do_dynamic && dynsz > 0) {
2776 printf("## Dynamic rules (%d %zu):\n", fo->dcnt, dynsz);
2777 list_dyn_range(co, fo, &bp, dynbase, dynsz);
2784 /* display specific rules requested on command line */
2785 for (lac = ac, lav = av; lac != 0; lac--) {
2786 /* convert command line rule # */
2787 fo->last = fo->first = strtoul(*lav++, &endptr, 10);
2789 fo->last = strtoul(endptr + 1, &endptr, 10);
2792 warnx("invalid rule number: %s", *(lav - 1));
2796 if (list_static_range(co, fo, &bp, rbase, rcnt) == 0) {
2797 /* give precedence to other error(s) */
2798 if (exitval == EX_OK)
2799 exitval = EX_UNAVAILABLE;
2800 if (fo->first == fo->last)
2801 warnx("rule %u does not exist", fo->first);
2803 warnx("no rules in range %u-%u",
2804 fo->first, fo->last);
2808 if (co->do_dynamic && dynsz > 0) {
2809 printf("## Dynamic rules:\n");
2810 for (lac = ac, lav = av; lac != 0; lac--) {
2811 fo->last = fo->first = strtoul(*lav++, &endptr, 10);
2813 fo->last = strtoul(endptr+1, &endptr, 10);
2815 /* already warned */
2817 list_dyn_range(co, fo, &bp, dynbase, dynsz);
2827 * Retrieves current ipfw configuration of given type
2828 * and stores its pointer to @pcfg.
2830 * Caller is responsible for freeing @pcfg.
2832 * Returns 0 on success.
2836 ipfw_get_config(struct cmdline_opts *co, struct format_opts *fo,
2837 ipfw_cfg_lheader **pcfg, size_t *psize)
2839 ipfw_cfg_lheader *cfg;
2844 if (co->test_only != 0) {
2845 fprintf(stderr, "Testing only, list disabled\n");
2849 /* Start with some data size */
2853 for (i = 0; i < 16; i++) {
2856 if ((cfg = calloc(1, sz)) == NULL)
2859 cfg->flags = fo->flags;
2860 cfg->start_rule = fo->first;
2861 cfg->end_rule = fo->last;
2863 if (do_get3(IP_FW_XGET, &cfg->opheader, &sz) != 0) {
2864 if (errno != ENOMEM) {
2869 /* Buffer size is not enough. Try to increase */
2886 lookup_host (char *host, struct in_addr *ipaddr)
2890 if (!inet_aton(host, ipaddr)) {
2891 if ((he = gethostbyname(host)) == NULL)
2893 *ipaddr = *(struct in_addr *)he->h_addr_list[0];
2907 ipfw_check_object_name(const char *name)
2912 * Check that name is null-terminated and contains
2913 * valid symbols only. Valid mask is:
2914 * [a-zA-Z0-9\-_\.]{1,63}
2917 if (l == 0 || l >= 64)
2919 for (i = 0; i < l; i++) {
2921 if (isalpha(c) || isdigit(c) || c == '_' ||
2922 c == '-' || c == '.')
2929 static char *default_state_name = "default";
2931 state_check_name(const char *name)
2934 if (ipfw_check_object_name(name) != 0)
2936 if (strcmp(name, "any") == 0)
2942 eaction_check_name(const char *name)
2945 if (ipfw_check_object_name(name) != 0)
2947 /* Restrict some 'special' names */
2948 if (match_token(rule_actions, name) != -1 &&
2949 match_token(rule_action_params, name) != -1)
2955 pack_object(struct tidx *tstate, char *name, int otype)
2958 ipfw_obj_ntlv *ntlv;
2960 for (i = 0; i < tstate->count; i++) {
2961 if (strcmp(tstate->idx[i].name, name) != 0)
2963 if (tstate->idx[i].set != tstate->set)
2965 if (tstate->idx[i].head.type != otype)
2968 return (tstate->idx[i].idx);
2971 if (tstate->count + 1 > tstate->size) {
2973 tstate->idx = realloc(tstate->idx, tstate->size *
2974 sizeof(ipfw_obj_ntlv));
2975 if (tstate->idx == NULL)
2979 ntlv = &tstate->idx[i];
2980 memset(ntlv, 0, sizeof(ipfw_obj_ntlv));
2981 strlcpy(ntlv->name, name, sizeof(ntlv->name));
2982 ntlv->head.type = otype;
2983 ntlv->head.length = sizeof(ipfw_obj_ntlv);
2984 ntlv->set = tstate->set;
2985 ntlv->idx = ++tstate->counter;
2992 pack_table(struct tidx *tstate, char *name)
2995 if (table_check_name(name) != 0)
2998 return (pack_object(tstate, name, IPFW_TLV_TBL_NAME));
3002 fill_table(struct _ipfw_insn *cmd, char *av, uint8_t opcode,
3003 struct tidx *tstate)
3005 uint32_t *d = ((ipfw_insn_u32 *)cmd)->d;
3009 if ((p = strchr(av + 6, ')')) == NULL)
3010 errx(EX_DATAERR, "forgotten parenthesis: '%s'", av);
3012 p = strchr(av + 6, ',');
3016 if ((uidx = pack_table(tstate, av + 6)) == 0)
3017 errx(EX_DATAERR, "Invalid table name: %s", av + 6);
3019 cmd->opcode = opcode;
3022 cmd->len |= F_INSN_SIZE(ipfw_insn_u32);
3023 d[0] = strtoul(p, NULL, 0);
3025 cmd->len |= F_INSN_SIZE(ipfw_insn);
3030 * fills the addr and mask fields in the instruction as appropriate from av.
3031 * Update length as appropriate.
3032 * The following formats are allowed:
3033 * me returns O_IP_*_ME
3034 * 1.2.3.4 single IP address
3035 * 1.2.3.4:5.6.7.8 address:mask
3036 * 1.2.3.4/24 address/mask
3037 * 1.2.3.4/26{1,6,5,4,23} set of addresses in a subnet
3038 * We can have multiple comma-separated address/mask entries.
3041 fill_ip(ipfw_insn_ip *cmd, char *av, int cblen, struct tidx *tstate)
3044 uint32_t *d = ((ipfw_insn_u32 *)cmd)->d;
3046 cmd->o.len &= ~F_LEN_MASK; /* zero len */
3048 if (_substrcmp(av, "any") == 0)
3051 if (_substrcmp(av, "me") == 0) {
3052 cmd->o.len |= F_INSN_SIZE(ipfw_insn);
3056 if (strncmp(av, "table(", 6) == 0) {
3057 fill_table(&cmd->o, av, O_IP_DST_LOOKUP, tstate);
3063 * After the address we can have '/' or ':' indicating a mask,
3064 * ',' indicating another address follows, '{' indicating a
3065 * set of addresses of unspecified size.
3067 char *t = NULL, *p = strpbrk(av, "/:,{");
3071 CHECK_LENGTH(cblen, F_INSN_SIZE(ipfw_insn) + 2 + len);
3076 if ((t = strpbrk(p, ",{")) != NULL) {
3083 if (lookup_host(av, (struct in_addr *)&d[0]) != 0)
3084 errx(EX_NOHOST, "hostname ``%s'' unknown", av);
3087 if (!inet_aton(p, (struct in_addr *)&d[1]))
3088 errx(EX_DATAERR, "bad netmask ``%s''", p);
3093 d[1] = htonl(0U); /* mask */
3094 else if (masklen > 32)
3095 errx(EX_DATAERR, "bad width ``%s''", p);
3097 d[1] = htonl(~0U << (32 - masklen));
3099 case '{': /* no mask, assume /24 and put back the '{' */
3100 d[1] = htonl(~0U << (32 - 24));
3104 case ',': /* single address plus continuation */
3107 case 0: /* initialization value */
3109 d[1] = htonl(~0U); /* force /32 */
3112 d[0] &= d[1]; /* mask base address with mask */
3115 /* find next separator */
3117 p = strpbrk(p, ",{");
3118 if (p && *p == '{') {
3120 * We have a set of addresses. They are stored as follows:
3121 * arg1 is the set size (powers of 2, 2..256)
3122 * addr is the base address IN HOST FORMAT
3123 * mask.. is an array of arg1 bits (rounded up to
3124 * the next multiple of 32) with bits set
3125 * for each host in the map.
3127 uint32_t *map = (uint32_t *)&cmd->mask;
3129 int i = contigmask((uint8_t *)&(d[1]), 32);
3132 errx(EX_DATAERR, "address set cannot be in a list");
3133 if (i < 24 || i > 31)
3134 errx(EX_DATAERR, "invalid set with mask %d\n", i);
3135 cmd->o.arg1 = 1<<(32-i); /* map length */
3136 d[0] = ntohl(d[0]); /* base addr in host format */
3137 cmd->o.opcode = O_IP_DST_SET; /* default */
3138 cmd->o.len |= F_INSN_SIZE(ipfw_insn_u32) + (cmd->o.arg1+31)/32;
3139 for (i = 0; i < (cmd->o.arg1+31)/32 ; i++)
3140 map[i] = 0; /* clear map */
3144 high = low + cmd->o.arg1 - 1;
3146 * Here, i stores the previous value when we specify a range
3147 * of addresses within a mask, e.g. 45-63. i = -1 means we
3148 * have no previous value.
3150 i = -1; /* previous value in a range */
3151 while (isdigit(*av)) {
3153 int a = strtol(av, &s, 0);
3155 if (s == av) { /* no parameter */
3157 errx(EX_DATAERR, "set not closed\n");
3159 errx(EX_DATAERR, "incomplete range %d-", i);
3162 if (a < low || a > high)
3163 errx(EX_DATAERR, "addr %d out of range [%d-%d]\n",
3166 if (i == -1) /* no previous in range */
3168 else { /* check that range is valid */
3170 errx(EX_DATAERR, "invalid range %d-%d",
3173 errx(EX_DATAERR, "double '-' in range");
3176 map[i/32] |= 1<<(i & 31);
3187 if (av) /* then *av must be a ',' */
3190 /* Check this entry */
3191 if (d[1] == 0) { /* "any", specified as x.x.x.x/0 */
3193 * 'any' turns the entire list into a NOP.
3194 * 'not any' never matches, so it is removed from the
3195 * list unless it is the only item, in which case we
3198 if (cmd->o.len & F_NOT) { /* "not any" never matches */
3199 if (av == NULL && len == 0) /* only this entry */
3200 errx(EX_DATAERR, "not any never matches");
3202 /* else do nothing and skip this entry */
3205 /* A single IP can be stored in an optimized format */
3206 if (d[1] == (uint32_t)~0 && av == NULL && len == 0) {
3207 cmd->o.len |= F_INSN_SIZE(ipfw_insn_u32);
3210 len += 2; /* two words... */
3213 if (len + 1 > F_LEN_MASK)
3214 errx(EX_DATAERR, "address list too long");
3215 cmd->o.len |= len+1;
3219 /* n2mask sets n bits of the mask */
3221 n2mask(struct in6_addr *mask, int n)
3223 static int minimask[9] =
3224 { 0x00, 0x80, 0xc0, 0xe0, 0xf0, 0xf8, 0xfc, 0xfe, 0xff };
3227 memset(mask, 0, sizeof(struct in6_addr));
3228 p = (u_char *) mask;
3229 for (; n > 0; p++, n -= 8) {
3239 fill_flags_cmd(ipfw_insn *cmd, enum ipfw_opcodes opcode,
3240 struct _s_x *flags, char *p)
3243 uint32_t set = 0, clear = 0;
3245 if (fill_flags(flags, p, &e, &set, &clear) != 0)
3246 errx(EX_DATAERR, "invalid flag %s", e);
3248 cmd->opcode = opcode;
3249 cmd->len = (cmd->len & (F_NOT | F_OR)) | 1;
3250 cmd->arg1 = (set & 0xff) | ( (clear & 0xff) << 8);
3255 ipfw_delete(char *av[])
3260 int exitval = EX_OK;
3264 NEED1("missing rule specification");
3265 if ( *av && _substrcmp(*av, "set") == 0) {
3266 /* Do not allow using the following syntax:
3267 * ipfw set N delete set M
3270 errx(EX_DATAERR, "invalid syntax");
3271 do_set = 1; /* delete set */
3276 while (*av && isdigit(**av)) {
3277 i = strtol(*av, &sep, 10);
3280 j = strtol(sep + 1, NULL, 10);
3283 exitval = do_cmd(IP_FW_NAT_DEL, &i, sizeof i);
3285 exitval = EX_UNAVAILABLE;
3288 warn("nat %u not available", i);
3290 } else if (co.do_pipe) {
3291 exitval = ipfw_delete_pipe(co.do_pipe, i);
3293 memset(&rt, 0, sizeof(rt));
3296 rt.flags = IPFW_RCFLAG_SET;
3298 rt.start_rule = i & 0xffff;
3299 rt.end_rule = j & 0xffff;
3300 if (rt.start_rule == 0 && rt.end_rule == 0)
3301 rt.flags |= IPFW_RCFLAG_ALL;
3303 rt.flags |= IPFW_RCFLAG_RANGE;
3304 if (co.use_set != 0) {
3305 rt.set = co.use_set - 1;
3306 rt.flags |= IPFW_RCFLAG_SET;
3309 i = do_range_cmd(IP_FW_XDEL, &rt);
3311 exitval = EX_UNAVAILABLE;
3314 warn("rule %u: setsockopt(IP_FW_XDEL)",
3316 } else if (rt.new_set == 0 && do_set == 0) {
3317 exitval = EX_UNAVAILABLE;
3320 if (rt.start_rule != rt.end_rule)
3321 warnx("no rules rules in %u-%u range",
3322 rt.start_rule, rt.end_rule);
3324 warnx("rule %u not found",
3329 if (exitval != EX_OK && co.do_force == 0)
3335 * fill the interface structure. We do not check the name as we can
3336 * create interfaces dynamically, so checking them at insert time
3337 * makes relatively little sense.
3338 * Interface names containing '*', '?', or '[' are assumed to be shell
3339 * patterns which match interfaces.
3342 fill_iface(ipfw_insn_if *cmd, char *arg, int cblen, struct tidx *tstate)
3347 cmd->name[0] = '\0';
3348 cmd->o.len |= F_INSN_SIZE(ipfw_insn_if);
3352 /* Parse the interface or address */
3353 if (strcmp(arg, "any") == 0)
3354 cmd->o.len = 0; /* effectively ignore this command */
3355 else if (strncmp(arg, "table(", 6) == 0) {
3356 if ((p = strchr(arg + 6, ')')) == NULL)
3357 errx(EX_DATAERR, "forgotten parenthesis: '%s'", arg);
3359 p = strchr(arg + 6, ',');
3362 if ((uidx = pack_table(tstate, arg + 6)) == 0)
3363 errx(EX_DATAERR, "Invalid table name: %s", arg + 6);
3365 cmd->name[0] = '\1'; /* Special value indicating table */
3367 } else if (!isdigit(*arg)) {
3368 strlcpy(cmd->name, arg, sizeof(cmd->name));
3369 cmd->p.glob = strpbrk(arg, "*?[") != NULL ? 1 : 0;
3370 } else if (!inet_aton(arg, &cmd->p.ip))
3371 errx(EX_DATAERR, "bad ip address ``%s''", arg);
3375 get_mac_addr_mask(const char *p, uint8_t *addr, uint8_t *mask)
3379 char *ap, *ptr, *optr;
3380 struct ether_addr *mac;
3381 const char *macset = "0123456789abcdefABCDEF:";
3383 if (strcmp(p, "any") == 0) {
3384 for (i = 0; i < ETHER_ADDR_LEN; i++)
3385 addr[i] = mask[i] = 0;
3389 optr = ptr = strdup(p);
3390 if ((ap = strsep(&ptr, "&/")) != NULL && *ap != 0) {
3392 if (strspn(ap, macset) != l || (mac = ether_aton(ap)) == NULL)
3393 errx(EX_DATAERR, "Incorrect MAC address");
3394 bcopy(mac, addr, ETHER_ADDR_LEN);
3396 errx(EX_DATAERR, "Incorrect MAC address");
3398 if (ptr != NULL) { /* we have mask? */
3399 if (p[ptr - optr - 1] == '/') { /* mask len */
3400 long ml = strtol(ptr, &ap, 10);
3401 if (*ap != 0 || ml > ETHER_ADDR_LEN * 8 || ml < 0)
3402 errx(EX_DATAERR, "Incorrect mask length");
3403 for (i = 0; ml > 0 && i < ETHER_ADDR_LEN; ml -= 8, i++)
3404 mask[i] = (ml >= 8) ? 0xff: (~0) << (8 - ml);
3407 if (strspn(ptr, macset) != l ||
3408 (mac = ether_aton(ptr)) == NULL)
3409 errx(EX_DATAERR, "Incorrect mask");
3410 bcopy(mac, mask, ETHER_ADDR_LEN);
3412 } else { /* default mask: ff:ff:ff:ff:ff:ff */
3413 for (i = 0; i < ETHER_ADDR_LEN; i++)
3416 for (i = 0; i < ETHER_ADDR_LEN; i++)
3423 * helper function, updates the pointer to cmd with the length
3424 * of the current command, and also cleans up the first word of
3425 * the new command in case it has been clobbered before.
3428 next_cmd(ipfw_insn *cmd, int *len)
3431 CHECK_LENGTH(*len, 0);
3433 bzero(cmd, sizeof(*cmd));
3438 * Takes arguments and copies them into a comment
3441 fill_comment(ipfw_insn *cmd, char **av, int cblen)
3444 char *p = (char *)(cmd + 1);
3446 cmd->opcode = O_NOP;
3447 cmd->len = (cmd->len & (F_NOT | F_OR));
3449 /* Compute length of comment string. */
3450 for (i = 0, l = 0; av[i] != NULL; i++)
3451 l += strlen(av[i]) + 1;
3456 "comment too long (max 80 chars)");
3458 cmd->len = (cmd->len & (F_NOT | F_OR)) | l;
3461 for (i = 0; av[i] != NULL; i++) {
3470 * A function to fill simple commands of size 1.
3471 * Existing flags are preserved.
3474 fill_cmd(ipfw_insn *cmd, enum ipfw_opcodes opcode, int flags, uint16_t arg)
3476 cmd->opcode = opcode;
3477 cmd->len = ((cmd->len | flags) & (F_NOT | F_OR)) | 1;
3482 * Fetch and add the MAC address and type, with masks. This generates one or
3483 * two microinstructions, and returns the pointer to the last one.
3486 add_mac(ipfw_insn *cmd, char *av[], int cblen)
3490 if ( ( av[0] == NULL ) || ( av[1] == NULL ) )
3491 errx(EX_DATAERR, "MAC dst src");
3493 cmd->opcode = O_MACADDR2;
3494 cmd->len = (cmd->len & (F_NOT | F_OR)) | F_INSN_SIZE(ipfw_insn_mac);
3497 mac = (ipfw_insn_mac *)cmd;
3498 get_mac_addr_mask(av[0], mac->addr, mac->mask); /* dst */
3499 get_mac_addr_mask(av[1], &(mac->addr[ETHER_ADDR_LEN]),
3500 &(mac->mask[ETHER_ADDR_LEN])); /* src */
3505 add_mactype(ipfw_insn *cmd, char *av, int cblen)
3508 errx(EX_DATAERR, "missing MAC type");
3509 if (strcmp(av, "any") != 0) { /* we have a non-null type */
3510 fill_newports((ipfw_insn_u16 *)cmd, av, IPPROTO_ETHERTYPE,
3512 cmd->opcode = O_MAC_TYPE;
3519 add_proto0(ipfw_insn *cmd, char *av, u_char *protop)
3521 struct protoent *pe;
3525 proto = strtol(av, &ep, 10);
3526 if (*ep != '\0' || proto <= 0) {
3527 if ((pe = getprotobyname(av)) == NULL)
3529 proto = pe->p_proto;
3532 fill_cmd(cmd, O_PROTO, 0, proto);
3538 add_proto(ipfw_insn *cmd, char *av, u_char *protop)
3540 u_char proto = IPPROTO_IP;
3542 if (_substrcmp(av, "all") == 0 || strcmp(av, "ip") == 0)
3543 ; /* do not set O_IP4 nor O_IP6 */
3544 else if (strcmp(av, "ip4") == 0)
3545 /* explicit "just IPv4" rule */
3546 fill_cmd(cmd, O_IP4, 0, 0);
3547 else if (strcmp(av, "ip6") == 0) {
3548 /* explicit "just IPv6" rule */
3549 proto = IPPROTO_IPV6;
3550 fill_cmd(cmd, O_IP6, 0, 0);
3552 return add_proto0(cmd, av, protop);
3559 add_proto_compat(ipfw_insn *cmd, char *av, u_char *protop)
3561 u_char proto = IPPROTO_IP;
3563 if (_substrcmp(av, "all") == 0 || strcmp(av, "ip") == 0)
3564 ; /* do not set O_IP4 nor O_IP6 */
3565 else if (strcmp(av, "ipv4") == 0 || strcmp(av, "ip4") == 0)
3566 /* explicit "just IPv4" rule */
3567 fill_cmd(cmd, O_IP4, 0, 0);
3568 else if (strcmp(av, "ipv6") == 0 || strcmp(av, "ip6") == 0) {
3569 /* explicit "just IPv6" rule */
3570 proto = IPPROTO_IPV6;
3571 fill_cmd(cmd, O_IP6, 0, 0);
3573 return add_proto0(cmd, av, protop);
3580 add_srcip(ipfw_insn *cmd, char *av, int cblen, struct tidx *tstate)
3582 fill_ip((ipfw_insn_ip *)cmd, av, cblen, tstate);
3583 if (cmd->opcode == O_IP_DST_SET) /* set */
3584 cmd->opcode = O_IP_SRC_SET;
3585 else if (cmd->opcode == O_IP_DST_LOOKUP) /* table */
3586 cmd->opcode = O_IP_SRC_LOOKUP;
3587 else if (F_LEN(cmd) == F_INSN_SIZE(ipfw_insn)) /* me */
3588 cmd->opcode = O_IP_SRC_ME;
3589 else if (F_LEN(cmd) == F_INSN_SIZE(ipfw_insn_u32)) /* one IP */
3590 cmd->opcode = O_IP_SRC;
3591 else /* addr/mask */
3592 cmd->opcode = O_IP_SRC_MASK;
3597 add_dstip(ipfw_insn *cmd, char *av, int cblen, struct tidx *tstate)
3599 fill_ip((ipfw_insn_ip *)cmd, av, cblen, tstate);
3600 if (cmd->opcode == O_IP_DST_SET) /* set */
3602 else if (cmd->opcode == O_IP_DST_LOOKUP) /* table */
3604 else if (F_LEN(cmd) == F_INSN_SIZE(ipfw_insn)) /* me */
3605 cmd->opcode = O_IP_DST_ME;
3606 else if (F_LEN(cmd) == F_INSN_SIZE(ipfw_insn_u32)) /* one IP */
3607 cmd->opcode = O_IP_DST;
3608 else /* addr/mask */
3609 cmd->opcode = O_IP_DST_MASK;
3613 static struct _s_x f_reserved_keywords[] = {
3616 { "diverted", TOK_OR },
3617 { "dst-port", TOK_OR },
3618 { "src-port", TOK_OR },
3619 { "established", TOK_OR },
3620 { "keep-state", TOK_OR },
3622 { "icmptypes", TOK_OR },
3630 { NULL, 0 } /* terminator */
3634 add_ports(ipfw_insn *cmd, char *av, u_char proto, int opcode, int cblen)
3637 if (match_token(f_reserved_keywords, av) != -1)
3640 if (fill_newports((ipfw_insn_u16 *)cmd, av, proto, cblen)) {
3641 /* XXX todo: check that we have a protocol with ports */
3642 cmd->opcode = opcode;
3649 add_src(ipfw_insn *cmd, char *av, u_char proto, int cblen, struct tidx *tstate)
3652 char *host, *ch, buf[INET6_ADDRSTRLEN];
3653 ipfw_insn *ret = NULL;
3656 /* Copy first address in set if needed */
3657 if ((ch = strpbrk(av, "/,")) != NULL) {
3659 strlcpy(buf, av, sizeof(buf));
3660 if (len < sizeof(buf))
3666 if (proto == IPPROTO_IPV6 || strcmp(av, "me6") == 0 ||
3667 inet_pton(AF_INET6, host, &a) == 1)
3668 ret = add_srcip6(cmd, av, cblen, tstate);
3669 /* XXX: should check for IPv4, not !IPv6 */
3670 if (ret == NULL && (proto == IPPROTO_IP || strcmp(av, "me") == 0 ||
3671 inet_pton(AF_INET6, host, &a) != 1))
3672 ret = add_srcip(cmd, av, cblen, tstate);
3673 if (ret == NULL && strcmp(av, "any") != 0)
3680 add_dst(ipfw_insn *cmd, char *av, u_char proto, int cblen, struct tidx *tstate)
3683 char *host, *ch, buf[INET6_ADDRSTRLEN];
3684 ipfw_insn *ret = NULL;
3687 /* Copy first address in set if needed */
3688 if ((ch = strpbrk(av, "/,")) != NULL) {
3690 strlcpy(buf, av, sizeof(buf));
3691 if (len < sizeof(buf))
3697 if (proto == IPPROTO_IPV6 || strcmp(av, "me6") == 0 ||
3698 inet_pton(AF_INET6, host, &a) == 1)
3699 ret = add_dstip6(cmd, av, cblen, tstate);
3700 /* XXX: should check for IPv4, not !IPv6 */
3701 if (ret == NULL && (proto == IPPROTO_IP || strcmp(av, "me") == 0 ||
3702 inet_pton(AF_INET6, host, &a) != 1))
3703 ret = add_dstip(cmd, av, cblen, tstate);
3704 if (ret == NULL && strcmp(av, "any") != 0)
3711 * Parse arguments and assemble the microinstructions which make up a rule.
3712 * Rules are added into the 'rulebuf' and then copied in the correct order
3713 * into the actual rule.
3715 * The syntax for a rule starts with the action, followed by
3716 * optional action parameters, and the various match patterns.
3717 * In the assembled microcode, the first opcode must be an O_PROBE_STATE
3718 * (generated if the rule includes a keep-state option), then the
3719 * various match patterns, log/altq actions, and the actual action.
3723 compile_rule(char *av[], uint32_t *rbuf, int *rbufsize, struct tidx *tstate)
3726 * rules are added into the 'rulebuf' and then copied in
3727 * the correct order into the actual rule.
3728 * Some things that need to go out of order (prob, action etc.)
3731 static uint32_t actbuf[255], cmdbuf[255];
3732 int rblen, ablen, cblen;
3734 ipfw_insn *src, *dst, *cmd, *action, *prev=NULL;
3735 ipfw_insn *first_cmd; /* first match pattern */
3737 struct ip_fw_rule *rule;
3740 * various flags used to record that we entered some fields.
3742 ipfw_insn *have_state = NULL; /* any state-related option */
3743 int have_rstate = 0;
3744 ipfw_insn *have_log = NULL, *have_altq = NULL, *have_tag = NULL;
3745 ipfw_insn *have_skipcmd = NULL;
3750 int open_par = 0; /* open parenthesis ( */
3752 /* proto is here because it is used to fetch ports */
3753 u_char proto = IPPROTO_IP; /* default protocol */
3755 double match_prob = 1; /* match probability, default is always match */
3757 bzero(actbuf, sizeof(actbuf)); /* actions go here */
3758 bzero(cmdbuf, sizeof(cmdbuf));
3759 bzero(rbuf, *rbufsize);
3761 rule = (struct ip_fw_rule *)rbuf;
3762 cmd = (ipfw_insn *)cmdbuf;
3763 action = (ipfw_insn *)actbuf;
3765 rblen = *rbufsize / sizeof(uint32_t);
3766 rblen -= sizeof(struct ip_fw_rule) / sizeof(uint32_t);
3767 ablen = sizeof(actbuf) / sizeof(actbuf[0]);
3768 cblen = sizeof(cmdbuf) / sizeof(cmdbuf[0]);
3769 cblen -= F_INSN_SIZE(ipfw_insn_u32) + 1;
3771 #define CHECK_RBUFLEN(len) { CHECK_LENGTH(rblen, len); rblen -= len; }
3772 #define CHECK_ACTLEN CHECK_LENGTH(ablen, action->len)
3776 /* [rule N] -- Rule number optional */
3777 if (av[0] && isdigit(**av)) {
3778 rule->rulenum = atoi(*av);
3782 /* [set N] -- set number (0..RESVD_SET), optional */
3783 if (av[0] && av[1] && _substrcmp(*av, "set") == 0) {
3784 int set = strtoul(av[1], NULL, 10);
3785 if (set < 0 || set > RESVD_SET)
3786 errx(EX_DATAERR, "illegal set %s", av[1]);
3792 /* [prob D] -- match probability, optional */
3793 if (av[0] && av[1] && _substrcmp(*av, "prob") == 0) {
3794 match_prob = strtod(av[1], NULL);
3796 if (match_prob <= 0 || match_prob > 1)
3797 errx(EX_DATAERR, "illegal match prob. %s", av[1]);
3801 /* action -- mandatory */
3802 NEED1("missing action");
3803 i = match_token(rule_actions, *av);
3805 action->len = 1; /* default */
3808 case TOK_CHECKSTATE:
3809 have_state = action;
3810 action->opcode = O_CHECK_STATE;
3812 match_token(rule_options, *av) == TOK_COMMENT) {
3813 action->arg1 = pack_object(tstate,
3814 default_state_name, IPFW_TLV_STATE_NAME);
3817 if (*av[0] == ':') {
3818 if (strcmp(*av + 1, "any") == 0)
3820 else if (state_check_name(*av + 1) == 0)
3821 action->arg1 = pack_object(tstate, *av + 1,
3822 IPFW_TLV_STATE_NAME);
3824 errx(EX_DATAERR, "Invalid state name %s",
3829 errx(EX_DATAERR, "Invalid state name %s", *av);
3833 action->opcode = O_REJECT;
3834 action->arg1 = ICMP_REJECT_ABORT;
3838 action->opcode = O_UNREACH6;
3839 action->arg1 = ICMP6_UNREACH_ABORT;
3843 action->opcode = O_ACCEPT;
3847 action->opcode = O_DENY;
3852 action->opcode = O_REJECT;
3853 action->arg1 = ICMP_UNREACH_HOST;
3857 action->opcode = O_REJECT;
3858 action->arg1 = ICMP_REJECT_RST;
3862 action->opcode = O_UNREACH6;
3863 action->arg1 = ICMP6_UNREACH_RST;
3867 action->opcode = O_REJECT;
3868 NEED1("missing reject code");
3869 fill_reject_code(&action->arg1, *av);
3874 action->opcode = O_UNREACH6;
3875 NEED1("missing unreach code");
3876 fill_unreach6_code(&action->arg1, *av);
3881 action->opcode = O_COUNT;
3885 action->opcode = O_NAT;
3886 action->len = F_INSN_SIZE(ipfw_insn_nat);
3888 if (*av != NULL && _substrcmp(*av, "global") == 0) {
3889 action->arg1 = IP_FW_NAT44_GLOBAL;
3895 action->opcode = O_QUEUE;
3898 action->opcode = O_PIPE;
3901 action->opcode = O_SKIPTO;
3904 action->opcode = O_NETGRAPH;
3907 action->opcode = O_NGTEE;
3910 action->opcode = O_DIVERT;
3913 action->opcode = O_TEE;
3916 action->opcode = O_CALLRETURN;
3919 errx(EX_USAGE, "missing argument for %s", *(av - 1));
3920 if (isdigit(**av)) {
3921 action->arg1 = strtoul(*av, NULL, 10);
3922 if (action->arg1 <= 0 || action->arg1 >= IP_FW_TABLEARG)
3923 errx(EX_DATAERR, "illegal argument for %s",
3925 } else if (_substrcmp(*av, "tablearg") == 0) {
3926 action->arg1 = IP_FW_TARG;
3927 } else if (i == TOK_DIVERT || i == TOK_TEE) {
3930 s = getservbyname(av[0], "divert");
3932 action->arg1 = ntohs(s->s_port);
3934 errx(EX_DATAERR, "illegal divert/tee port");
3936 errx(EX_DATAERR, "illegal argument for %s", *(av - 1));
3942 * Locate the address-port separator (':' or ',').
3943 * Could be one of the following:
3947 * IPv6 w:x:y::z,port
3948 * The ':' can only be used with hostname and IPv4 address.
3949 * XXX-BZ Should we also support [w:x:y::z]:port?
3951 struct sockaddr_storage result;
3952 struct addrinfo *res;
3955 u_short port_number;
3957 NEED1("missing forward address[:port]");
3960 * locate the address-port separator (':' or ',')
3962 s = strchr(*av, ',');
3964 /* Distinguish between IPv4:port and IPv6 cases. */
3965 s = strchr(*av, ':');
3966 if (s && strchr(s+1, ':'))
3967 s = NULL; /* no port */
3972 /* Terminate host portion and set s to start of port. */
3974 i = strtoport(s, &end, 0 /* base */, 0 /* proto */);
3977 "illegal forwarding port ``%s''", s);
3978 port_number = (u_short)i;
3981 if (_substrcmp(*av, "tablearg") == 0) {
3983 ((struct sockaddr_in*)&result)->sin_addr.s_addr =
3987 * Resolve the host name or address to a family and a
3988 * network representation of the address.
3990 if (getaddrinfo(*av, NULL, NULL, &res))
3991 errx(EX_DATAERR, NULL);
3992 /* Just use the first host in the answer. */
3993 family = res->ai_family;
3994 memcpy(&result, res->ai_addr, res->ai_addrlen);
3998 if (family == PF_INET) {
3999 ipfw_insn_sa *p = (ipfw_insn_sa *)action;
4001 action->opcode = O_FORWARD_IP;
4002 action->len = F_INSN_SIZE(ipfw_insn_sa);
4006 * In the kernel we assume AF_INET and use only
4007 * sin_port and sin_addr. Remember to set sin_len as
4008 * the routing code seems to use it too.
4010 p->sa.sin_len = sizeof(struct sockaddr_in);
4011 p->sa.sin_family = AF_INET;
4012 p->sa.sin_port = port_number;
4013 p->sa.sin_addr.s_addr =
4014 ((struct sockaddr_in *)&result)->sin_addr.s_addr;
4015 } else if (family == PF_INET6) {
4016 ipfw_insn_sa6 *p = (ipfw_insn_sa6 *)action;
4018 action->opcode = O_FORWARD_IP6;
4019 action->len = F_INSN_SIZE(ipfw_insn_sa6);
4022 p->sa.sin6_len = sizeof(struct sockaddr_in6);
4023 p->sa.sin6_family = AF_INET6;
4024 p->sa.sin6_port = port_number;
4025 p->sa.sin6_flowinfo = 0;
4026 p->sa.sin6_scope_id =
4027 ((struct sockaddr_in6 *)&result)->sin6_scope_id;
4028 bcopy(&((struct sockaddr_in6*)&result)->sin6_addr,
4029 &p->sa.sin6_addr, sizeof(p->sa.sin6_addr));
4031 errx(EX_DATAERR, "Invalid address family in forward action");
4037 /* pretend it is a 'count' rule followed by the comment */
4038 action->opcode = O_COUNT;
4039 av--; /* go back... */
4045 size_t intsize = sizeof(int);
4047 action->opcode = O_SETFIB;
4048 NEED1("missing fib number");
4049 if (_substrcmp(*av, "tablearg") == 0) {
4050 action->arg1 = IP_FW_TARG;
4052 action->arg1 = strtoul(*av, NULL, 10);
4053 if (sysctlbyname("net.fibs", &numfibs, &intsize,
4055 errx(EX_DATAERR, "fibs not suported.\n");
4056 if (action->arg1 >= numfibs) /* Temporary */
4057 errx(EX_DATAERR, "fib too large.\n");
4058 /* Add high-order bit to fib to make room for tablearg*/
4059 action->arg1 |= 0x8000;
4069 action->opcode = O_SETDSCP;
4070 NEED1("missing DSCP code");
4071 if (_substrcmp(*av, "tablearg") == 0) {
4072 action->arg1 = IP_FW_TARG;
4074 if (isalpha(*av[0])) {
4075 if ((code = match_token(f_ipdscp, *av)) == -1)
4076 errx(EX_DATAERR, "Unknown DSCP code");
4077 action->arg1 = code;
4079 action->arg1 = strtoul(*av, NULL, 10);
4081 * Add high-order bit to DSCP to make room
4084 action->arg1 |= 0x8000;
4091 action->opcode = O_REASS;
4095 fill_cmd(action, O_CALLRETURN, F_NOT, 0);
4098 case TOK_TCPSETMSS: {
4102 idx = pack_object(tstate, "tcp-setmss", IPFW_TLV_EACTION);
4104 errx(EX_DATAERR, "pack_object failed");
4105 fill_cmd(action, O_EXTERNAL_ACTION, 0, idx);
4106 NEED1("Missing MSS value");
4107 action = next_cmd(action, &ablen);
4110 mss = strtoul(*av, NULL, 10);
4111 if (mss == 0 || mss > UINT16_MAX)
4112 errx(EX_USAGE, "invalid MSS value %s", *av);
4113 fill_cmd(action, O_EXTERNAL_DATA, 0, (uint16_t)mss);
4120 if (match_token(rule_eactions, *av) == -1)
4121 errx(EX_DATAERR, "invalid action %s\n", *av);
4123 * External actions support.
4124 * XXX: we support only syntax with instance name.
4125 * For known external actions (from rule_eactions list)
4126 * we can handle syntax directly. But with `eaction'
4127 * keyword we can use only `eaction <name> <instance>'
4133 NEED1("Missing eaction name");
4134 if (eaction_check_name(*av) != 0)
4135 errx(EX_DATAERR, "Invalid eaction name %s", *av);
4136 idx = pack_object(tstate, *av, IPFW_TLV_EACTION);
4138 errx(EX_DATAERR, "pack_object failed");
4139 fill_cmd(action, O_EXTERNAL_ACTION, 0, idx);
4141 NEED1("Missing eaction instance name");
4142 action = next_cmd(action, &ablen);
4145 if (eaction_check_name(*av) != 0)
4146 errx(EX_DATAERR, "Invalid eaction instance name %s",
4149 * External action instance object has TLV type depended
4150 * from the external action name object index. Since we
4151 * currently don't know this index, use zero as TLV type.
4153 idx = pack_object(tstate, *av, 0);
4155 errx(EX_DATAERR, "pack_object failed");
4156 fill_cmd(action, O_EXTERNAL_INSTANCE, 0, idx);
4160 action = next_cmd(action, &ablen);
4163 * [altq queuename] -- altq tag, optional
4164 * [log [logamount N]] -- log, optional
4166 * If they exist, it go first in the cmdbuf, but then it is
4167 * skipped in the copy section to the end of the buffer.
4169 while (av[0] != NULL && (i = match_token(rule_action_params, *av)) != -1) {
4174 ipfw_insn_log *c = (ipfw_insn_log *)cmd;
4179 "log cannot be specified more than once");
4180 have_log = (ipfw_insn *)c;
4181 cmd->len = F_INSN_SIZE(ipfw_insn_log);
4183 cmd->opcode = O_LOG;
4184 if (av[0] && _substrcmp(*av, "logamount") == 0) {
4186 NEED1("logamount requires argument");
4190 "logamount must be positive");
4194 len = sizeof(c->max_log);
4195 if (sysctlbyname("net.inet.ip.fw.verbose_limit",
4196 &c->max_log, &len, NULL, 0) == -1) {
4201 errx(1, "sysctlbyname(\"%s\")",
4202 "net.inet.ip.fw.verbose_limit");
4211 ipfw_insn_altq *a = (ipfw_insn_altq *)cmd;
4213 NEED1("missing altq queue name");
4216 "altq cannot be specified more than once");
4217 have_altq = (ipfw_insn *)a;
4218 cmd->len = F_INSN_SIZE(ipfw_insn_altq);
4220 cmd->opcode = O_ALTQ;
4221 a->qid = altq_name_to_qid(*av);
4232 errx(EX_USAGE, "tag and untag cannot be "
4233 "specified more than once");
4234 GET_UINT_ARG(tag, IPFW_ARG_MIN, IPFW_ARG_MAX, i,
4235 rule_action_params);
4237 fill_cmd(cmd, O_TAG, (i == TOK_TAG) ? 0: F_NOT, tag);
4245 cmd = next_cmd(cmd, &cblen);
4248 if (have_state) { /* must be a check-state, we are done */
4250 match_token(rule_options, *av) == TOK_COMMENT) {
4251 /* check-state has a comment */
4253 fill_comment(cmd, av, cblen);
4254 cmd = next_cmd(cmd, &cblen);
4260 #define OR_START(target) \
4261 if (av[0] && (*av[0] == '(' || *av[0] == '{')) { \
4263 errx(EX_USAGE, "nested \"(\" not allowed\n"); \
4266 if ( (av[0])[1] == '\0') { \
4277 strcmp(*av, ")") == 0 || \
4278 strcmp(*av, "}") == 0)) { \
4283 errx(EX_USAGE, "missing \")\"\n"); \
4287 if (av[0] && _substrcmp(*av, "not") == 0) { \
4288 if (cmd->len & F_NOT) \
4289 errx(EX_USAGE, "double \"not\" not allowed\n"); \
4290 cmd->len |= F_NOT; \
4294 #define OR_BLOCK(target) \
4295 if (av[0] && _substrcmp(*av, "or") == 0) { \
4296 if (prev == NULL || open_par == 0) \
4297 errx(EX_DATAERR, "invalid OR block"); \
4298 prev->len |= F_OR; \
4308 * MAC addresses, optional.
4309 * If we have this, we skip the part "proto from src to dst"
4310 * and jump straight to the option parsing.
4313 NEED1("missing protocol");
4314 if (_substrcmp(*av, "MAC") == 0 ||
4315 _substrcmp(*av, "mac") == 0) {
4316 av++; /* the "MAC" keyword */
4317 add_mac(cmd, av); /* exits in case of errors */
4318 cmd = next_cmd(cmd);
4319 av += 2; /* dst-mac and src-mac */
4321 NEED1("missing mac type");
4322 if (add_mactype(cmd, av[0]))
4323 cmd = next_cmd(cmd);
4324 av++; /* any or mac-type */
4330 * protocol, mandatory
4332 OR_START(get_proto);
4334 NEED1("missing protocol");
4335 if (add_proto_compat(cmd, *av, &proto)) {
4337 if (F_LEN(cmd) != 0) {
4339 cmd = next_cmd(cmd, &cblen);
4341 } else if (first_cmd != cmd) {
4342 errx(EX_DATAERR, "invalid protocol ``%s''", *av);
4345 OR_BLOCK(get_proto);
4350 if ((av[0] == NULL) || _substrcmp(*av, "from") != 0)
4351 errx(EX_USAGE, "missing ``from''");
4355 * source IP, mandatory
4357 OR_START(source_ip);
4358 NOT_BLOCK; /* optional "not" */
4359 NEED1("missing source address");
4360 if (add_src(cmd, *av, proto, cblen, tstate)) {
4362 if (F_LEN(cmd) != 0) { /* ! any */
4364 cmd = next_cmd(cmd, &cblen);
4367 errx(EX_USAGE, "bad source address %s", *av);
4368 OR_BLOCK(source_ip);
4371 * source ports, optional
4373 NOT_BLOCK; /* optional "not" */
4374 if ( av[0] != NULL ) {
4375 if (_substrcmp(*av, "any") == 0 ||
4376 add_ports(cmd, *av, proto, O_IP_SRCPORT, cblen)) {
4378 if (F_LEN(cmd) != 0)
4379 cmd = next_cmd(cmd, &cblen);
4386 if ( (av[0] == NULL) || _substrcmp(*av, "to") != 0 )
4387 errx(EX_USAGE, "missing ``to''");
4391 * destination, mandatory
4394 NOT_BLOCK; /* optional "not" */
4395 NEED1("missing dst address");
4396 if (add_dst(cmd, *av, proto, cblen, tstate)) {
4398 if (F_LEN(cmd) != 0) { /* ! any */
4400 cmd = next_cmd(cmd, &cblen);
4403 errx( EX_USAGE, "bad destination address %s", *av);
4407 * dest. ports, optional
4409 NOT_BLOCK; /* optional "not" */
4411 if (_substrcmp(*av, "any") == 0 ||
4412 add_ports(cmd, *av, proto, O_IP_DSTPORT, cblen)) {
4414 if (F_LEN(cmd) != 0)
4415 cmd = next_cmd(cmd, &cblen);
4421 while ( av[0] != NULL ) {
4423 ipfw_insn_u32 *cmd32; /* alias for cmd */
4426 cmd32 = (ipfw_insn_u32 *)cmd;
4428 if (*s == '!') { /* alternate syntax for NOT */
4429 if (cmd->len & F_NOT)
4430 errx(EX_USAGE, "double \"not\" not allowed\n");
4434 i = match_token(rule_options, s);
4438 if (cmd->len & F_NOT)
4439 errx(EX_USAGE, "double \"not\" not allowed\n");
4444 if (open_par == 0 || prev == NULL)
4445 errx(EX_USAGE, "invalid \"or\" block\n");
4449 case TOK_STARTBRACE:
4451 errx(EX_USAGE, "+nested \"(\" not allowed\n");
4457 errx(EX_USAGE, "+missing \")\"\n");
4463 fill_cmd(cmd, O_IN, 0, 0);
4467 cmd->len ^= F_NOT; /* toggle F_NOT */
4468 fill_cmd(cmd, O_IN, 0, 0);
4472 fill_cmd(cmd, O_DIVERTED, 0, 3);
4475 case TOK_DIVERTEDLOOPBACK:
4476 fill_cmd(cmd, O_DIVERTED, 0, 1);
4479 case TOK_DIVERTEDOUTPUT:
4480 fill_cmd(cmd, O_DIVERTED, 0, 2);
4484 fill_cmd(cmd, O_FRAG, 0, 0);
4488 fill_cmd(cmd, O_LAYER2, 0, 0);
4494 NEED1("recv, xmit, via require interface name"
4496 fill_iface((ipfw_insn_if *)cmd, av[0], cblen, tstate);
4498 if (F_LEN(cmd) == 0) /* not a valid address */
4501 cmd->opcode = O_XMIT;
4502 else if (i == TOK_RECV)
4503 cmd->opcode = O_RECV;
4504 else if (i == TOK_VIA)
4505 cmd->opcode = O_VIA;
4509 NEED1("icmptypes requires list of types");
4510 fill_icmptypes((ipfw_insn_u32 *)cmd, *av);
4514 case TOK_ICMP6TYPES:
4515 NEED1("icmptypes requires list of types");
4516 fill_icmp6types((ipfw_insn_icmp6 *)cmd, *av, cblen);
4521 NEED1("ipttl requires TTL");
4522 if (strpbrk(*av, "-,")) {
4523 if (!add_ports(cmd, *av, 0, O_IPTTL, cblen))
4524 errx(EX_DATAERR, "invalid ipttl %s", *av);
4526 fill_cmd(cmd, O_IPTTL, 0, strtoul(*av, NULL, 0));
4531 NEED1("ipid requires id");
4532 if (strpbrk(*av, "-,")) {
4533 if (!add_ports(cmd, *av, 0, O_IPID, cblen))
4534 errx(EX_DATAERR, "invalid ipid %s", *av);
4536 fill_cmd(cmd, O_IPID, 0, strtoul(*av, NULL, 0));
4541 NEED1("iplen requires length");
4542 if (strpbrk(*av, "-,")) {
4543 if (!add_ports(cmd, *av, 0, O_IPLEN, cblen))
4544 errx(EX_DATAERR, "invalid ip len %s", *av);
4546 fill_cmd(cmd, O_IPLEN, 0, strtoul(*av, NULL, 0));
4551 NEED1("ipver requires version");
4552 fill_cmd(cmd, O_IPVER, 0, strtoul(*av, NULL, 0));
4556 case TOK_IPPRECEDENCE:
4557 NEED1("ipprecedence requires value");
4558 fill_cmd(cmd, O_IPPRECEDENCE, 0,
4559 (strtoul(*av, NULL, 0) & 7) << 5);
4564 NEED1("missing DSCP code");
4565 fill_dscp(cmd, *av, cblen);
4570 NEED1("missing argument for ipoptions");
4571 fill_flags_cmd(cmd, O_IPOPT, f_ipopts, *av);
4576 NEED1("missing argument for iptos");
4577 fill_flags_cmd(cmd, O_IPTOS, f_iptos, *av);
4582 NEED1("uid requires argument");
4588 cmd->opcode = O_UID;
4589 uid = strtoul(*av, &end, 0);
4590 pwd = (*end == '\0') ? getpwuid(uid) : getpwnam(*av);
4592 errx(EX_DATAERR, "uid \"%s\" nonexistent", *av);
4593 cmd32->d[0] = pwd->pw_uid;
4594 cmd->len |= F_INSN_SIZE(ipfw_insn_u32);
4600 NEED1("gid requires argument");
4606 cmd->opcode = O_GID;
4607 gid = strtoul(*av, &end, 0);
4608 grp = (*end == '\0') ? getgrgid(gid) : getgrnam(*av);
4610 errx(EX_DATAERR, "gid \"%s\" nonexistent", *av);
4611 cmd32->d[0] = grp->gr_gid;
4612 cmd->len |= F_INSN_SIZE(ipfw_insn_u32);
4618 NEED1("jail requires argument");
4622 cmd->opcode = O_JAIL;
4623 jid = jail_getid(*av);
4625 errx(EX_DATAERR, "%s", jail_errmsg);
4626 cmd32->d[0] = (uint32_t)jid;
4627 cmd->len |= F_INSN_SIZE(ipfw_insn_u32);
4633 fill_cmd(cmd, O_ESTAB, 0, 0);
4637 fill_cmd(cmd, O_TCPFLAGS, 0,
4638 (TH_SYN) | ( (TH_ACK) & 0xff) <<8 );
4641 case TOK_TCPDATALEN:
4642 NEED1("tcpdatalen requires length");
4643 if (strpbrk(*av, "-,")) {
4644 if (!add_ports(cmd, *av, 0, O_TCPDATALEN, cblen))
4645 errx(EX_DATAERR, "invalid tcpdata len %s", *av);
4647 fill_cmd(cmd, O_TCPDATALEN, 0,
4648 strtoul(*av, NULL, 0));
4653 NEED1("missing argument for tcpoptions");
4654 fill_flags_cmd(cmd, O_TCPOPTS, f_tcpopts, *av);
4660 NEED1("tcpseq/tcpack requires argument");
4661 cmd->len = F_INSN_SIZE(ipfw_insn_u32);
4662 cmd->opcode = (i == TOK_TCPSEQ) ? O_TCPSEQ : O_TCPACK;
4663 cmd32->d[0] = htonl(strtoul(*av, NULL, 0));
4668 NEED1("tcpwin requires length");
4669 if (strpbrk(*av, "-,")) {
4670 if (!add_ports(cmd, *av, 0, O_TCPWIN, cblen))
4671 errx(EX_DATAERR, "invalid tcpwin len %s", *av);
4673 fill_cmd(cmd, O_TCPWIN, 0,
4674 strtoul(*av, NULL, 0));
4679 NEED1("missing argument for tcpflags");
4680 cmd->opcode = O_TCPFLAGS;
4681 fill_flags_cmd(cmd, O_TCPFLAGS, f_tcpflags, *av);
4686 case TOK_RECORDSTATE: {
4690 errx(EX_USAGE, "keep-state or record-state cannot be part "
4693 errx(EX_USAGE, "only one of keep-state, record-state, "
4694 " limit and set-limit is allowed");
4695 if (*av != NULL && *av[0] == ':') {
4696 if (state_check_name(*av + 1) != 0)
4698 "Invalid state name %s", *av);
4699 uidx = pack_object(tstate, *av + 1,
4700 IPFW_TLV_STATE_NAME);
4703 uidx = pack_object(tstate, default_state_name,
4704 IPFW_TLV_STATE_NAME);
4706 have_rstate = i == TOK_RECORDSTATE;
4707 fill_cmd(cmd, O_KEEP_STATE, 0, uidx);
4712 case TOK_SETLIMIT: {
4713 ipfw_insn_limit *c = (ipfw_insn_limit *)cmd;
4718 "limit or set-limit cannot be part of an or block");
4720 errx(EX_USAGE, "only one of keep-state, record-state, "
4721 " limit and set-limit is allowed");
4723 have_rstate = i == TOK_SETLIMIT;
4725 cmd->len = F_INSN_SIZE(ipfw_insn_limit);
4727 cmd->opcode = O_LIMIT;
4728 c->limit_mask = c->conn_limit = 0;
4730 while ( av[0] != NULL ) {
4731 if ((val = match_token(limit_masks, *av)) <= 0)
4733 c->limit_mask |= val;
4737 if (c->limit_mask == 0)
4738 errx(EX_USAGE, "limit: missing limit mask");
4740 GET_UINT_ARG(c->conn_limit, IPFW_ARG_MIN, IPFW_ARG_MAX,
4741 TOK_LIMIT, rule_options);
4744 if (*av != NULL && *av[0] == ':') {
4745 if (state_check_name(*av + 1) != 0)
4747 "Invalid state name %s", *av);
4748 cmd->arg1 = pack_object(tstate, *av + 1,
4749 IPFW_TLV_STATE_NAME);
4752 cmd->arg1 = pack_object(tstate,
4753 default_state_name, IPFW_TLV_STATE_NAME);
4758 NEED1("missing protocol");
4759 if (add_proto(cmd, *av, &proto)) {
4762 errx(EX_DATAERR, "invalid protocol ``%s''",
4767 NEED1("missing source IP");
4768 if (add_srcip(cmd, *av, cblen, tstate)) {
4774 NEED1("missing destination IP");
4775 if (add_dstip(cmd, *av, cblen, tstate)) {
4781 NEED1("missing source IP6");
4782 if (add_srcip6(cmd, *av, cblen, tstate)) {
4788 NEED1("missing destination IP6");
4789 if (add_dstip6(cmd, *av, cblen, tstate)) {
4795 NEED1("missing source port");
4796 if (_substrcmp(*av, "any") == 0 ||
4797 add_ports(cmd, *av, proto, O_IP_SRCPORT, cblen)) {
4800 errx(EX_DATAERR, "invalid source port %s", *av);
4804 NEED1("missing destination port");
4805 if (_substrcmp(*av, "any") == 0 ||
4806 add_ports(cmd, *av, proto, O_IP_DSTPORT, cblen)) {
4809 errx(EX_DATAERR, "invalid destination port %s",
4814 if (add_mac(cmd, av, cblen))
4819 NEED1("missing mac type");
4820 if (!add_mactype(cmd, *av, cblen))
4821 errx(EX_DATAERR, "invalid mac type %s", *av);
4825 case TOK_VERREVPATH:
4826 fill_cmd(cmd, O_VERREVPATH, 0, 0);
4829 case TOK_VERSRCREACH:
4830 fill_cmd(cmd, O_VERSRCREACH, 0, 0);
4834 fill_cmd(cmd, O_ANTISPOOF, 0, 0);
4838 fill_cmd(cmd, O_IPSEC, 0, 0);
4842 fill_cmd(cmd, O_IP6, 0, 0);
4846 fill_cmd(cmd, O_IP4, 0, 0);
4850 fill_ext6hdr( cmd, *av );
4855 if (proto != IPPROTO_IPV6 )
4856 errx( EX_USAGE, "flow-id filter is active "
4857 "only for ipv6 protocol\n");
4858 fill_flow6( (ipfw_insn_u32 *) cmd, *av, cblen);
4863 fill_comment(cmd, av, cblen);
4868 if (av[0] && strpbrk(*av, "-,")) {
4869 if (!add_ports(cmd, *av, 0, O_TAGGED, cblen))
4870 errx(EX_DATAERR, "tagged: invalid tag"
4876 GET_UINT_ARG(tag, IPFW_ARG_MIN, IPFW_ARG_MAX,
4877 TOK_TAGGED, rule_options);
4878 fill_cmd(cmd, O_TAGGED, 0, tag);
4884 NEED1("fib requires fib number");
4885 fill_cmd(cmd, O_FIB, 0, strtoul(*av, NULL, 0));
4889 fill_cmd(cmd, O_SOCKARG, 0, 0);
4893 ipfw_insn_u32 *c = (ipfw_insn_u32 *)cmd;
4896 if (!av[0] || !av[1])
4897 errx(EX_USAGE, "format: lookup argument tablenum");
4898 cmd->opcode = O_IP_DST_LOOKUP;
4899 cmd->len |= F_INSN_SIZE(ipfw_insn) + 2;
4900 i = match_token(rule_options, *av);
4901 for (j = 0; lookup_key[j] >= 0 ; j++) {
4902 if (i == lookup_key[j])
4905 if (lookup_key[j] <= 0)
4906 errx(EX_USAGE, "format: cannot lookup on %s", *av);
4907 __PAST_END(c->d, 1) = j; // i converted to option
4910 if ((j = pack_table(tstate, *av)) == 0)
4911 errx(EX_DATAERR, "Invalid table name: %s", *av);
4918 NEED1("missing table name");
4919 if (strncmp(*av, "table(", 6) != 0)
4921 "enclose table name into \"table()\"");
4922 fill_table(cmd, *av, O_IP_FLOW_LOOKUP, tstate);
4926 case TOK_SKIPACTION:
4928 errx(EX_USAGE, "only one defer-action "
4931 fill_cmd(cmd, O_SKIP_ACTION, 0, 0);
4935 errx(EX_USAGE, "unrecognised option [%d] %s\n", i, s);
4937 if (F_LEN(cmd) > 0) { /* prepare to advance */
4939 cmd = next_cmd(cmd, &cblen);
4945 if (!have_state && have_skipcmd)
4946 warnx("Rule contains \"defer-immediate-action\" "
4947 "and doesn't contain any state-related options.");
4950 * Now copy stuff into the rule.
4951 * If we have a keep-state option, the first instruction
4952 * must be a PROBE_STATE (which is generated here).
4953 * If we have a LOG option, it was stored as the first command,
4954 * and now must be moved to the top of the action part.
4956 dst = (ipfw_insn *)rule->cmd;
4959 * First thing to write into the command stream is the match probability.
4961 if (match_prob != 1) { /* 1 means always match */
4962 dst->opcode = O_PROB;
4964 *((int32_t *)(dst+1)) = (int32_t)(match_prob * 0x7fffffff);
4969 * generate O_PROBE_STATE if necessary
4971 if (have_state && have_state->opcode != O_CHECK_STATE && !have_rstate) {
4972 fill_cmd(dst, O_PROBE_STATE, 0, have_state->arg1);
4973 dst = next_cmd(dst, &rblen);
4977 * copy all commands but O_LOG, O_KEEP_STATE, O_LIMIT, O_ALTQ, O_TAG,
4980 for (src = (ipfw_insn *)cmdbuf; src != cmd; src += i) {
4984 switch (src->opcode) {
4993 bcopy(src, dst, i * sizeof(uint32_t));
4999 * put back the have_state command as last opcode
5001 if (have_state && have_state->opcode != O_CHECK_STATE) {
5002 i = F_LEN(have_state);
5004 bcopy(have_state, dst, i * sizeof(uint32_t));
5009 * put back the have_skipcmd command as very last opcode
5012 i = F_LEN(have_skipcmd);
5014 bcopy(have_skipcmd, dst, i * sizeof(uint32_t));
5019 * start action section
5021 rule->act_ofs = dst - rule->cmd;
5023 /* put back O_LOG, O_ALTQ, O_TAG if necessary */
5025 i = F_LEN(have_log);
5027 bcopy(have_log, dst, i * sizeof(uint32_t));
5031 i = F_LEN(have_altq);
5033 bcopy(have_altq, dst, i * sizeof(uint32_t));
5037 i = F_LEN(have_tag);
5039 bcopy(have_tag, dst, i * sizeof(uint32_t));
5044 * copy all other actions
5046 for (src = (ipfw_insn *)actbuf; src != action; src += i) {
5049 bcopy(src, dst, i * sizeof(uint32_t));
5053 rule->cmd_len = (uint32_t *)dst - (uint32_t *)(rule->cmd);
5054 *rbufsize = (char *)dst - (char *)rule;
5058 compare_ntlv(const void *_a, const void *_b)
5060 ipfw_obj_ntlv *a, *b;
5062 a = (ipfw_obj_ntlv *)_a;
5063 b = (ipfw_obj_ntlv *)_b;
5065 if (a->set < b->set)
5067 else if (a->set > b->set)
5070 if (a->idx < b->idx)
5072 else if (a->idx > b->idx)
5075 if (a->head.type < b->head.type)
5077 else if (a->head.type > b->head.type)
5084 * Provide kernel with sorted list of referenced objects
5087 object_sort_ctlv(ipfw_obj_ctlv *ctlv)
5090 qsort(ctlv + 1, ctlv->count, ctlv->objsize, compare_ntlv);
5098 compare_object_kntlv(const void *k, const void *v)
5100 ipfw_obj_ntlv *ntlv;
5101 struct object_kt key;
5103 key = *((struct object_kt *)k);
5104 ntlv = (ipfw_obj_ntlv *)v;
5106 if (key.uidx < ntlv->idx)
5108 else if (key.uidx > ntlv->idx)
5111 if (key.type < ntlv->head.type)
5113 else if (key.type > ntlv->head.type)
5120 * Finds object name in @ctlv by @idx and @type.
5121 * Uses the following facts:
5122 * 1) All TLVs are the same size
5123 * 2) Kernel implementation provides already sorted list.
5125 * Returns table name or NULL.
5128 object_search_ctlv(ipfw_obj_ctlv *ctlv, uint16_t idx, uint16_t type)
5130 ipfw_obj_ntlv *ntlv;
5131 struct object_kt key;
5136 ntlv = bsearch(&key, (ctlv + 1), ctlv->count, ctlv->objsize,
5137 compare_object_kntlv);
5140 return (ntlv->name);
5146 table_search_ctlv(ipfw_obj_ctlv *ctlv, uint16_t idx)
5149 return (object_search_ctlv(ctlv, idx, IPFW_TLV_TBL_NAME));
5153 * Adds one or more rules to ipfw chain.
5158 * [ ipfw_obj_ctlv(IPFW_TLV_TBL_LIST) ipfw_obj_ntlv x N ] (optional *1)
5159 * [ ipfw_obj_ctlv(IPFW_TLV_RULE_LIST) [ ip_fw_rule ip_fw_insn ] x N ] (*2) (*3)
5164 * [ ipfw_obj_ctlv(IPFW_TLV_TBL_LIST) ipfw_obj_ntlv x N ] (optional)
5165 * [ ipfw_obj_ctlv(IPFW_TLV_RULE_LIST) [ ip_fw_rule ip_fw_insn ] x N ]
5168 * Rules in reply are modified to store their actual ruleset number.
5170 * (*1) TLVs inside IPFW_TLV_TBL_LIST needs to be sorted ascending
5171 * according to their idx field and there has to be no duplicates.
5172 * (*2) Numbered rules inside IPFW_TLV_RULE_LIST needs to be sorted ascending.
5173 * (*3) Each ip_fw structure needs to be aligned to u64 boundary.
5176 ipfw_add(char *av[])
5178 uint32_t rulebuf[1024];
5179 int rbufsize, default_off, tlen, rlen;
5182 struct ip_fw_rule *rule;
5184 ip_fw3_opheader *op3;
5185 ipfw_obj_ctlv *ctlv, *tstate;
5187 rbufsize = sizeof(rulebuf);
5188 memset(rulebuf, 0, rbufsize);
5189 memset(&ts, 0, sizeof(ts));
5191 /* Optimize case with no tables */
5192 default_off = sizeof(ipfw_obj_ctlv) + sizeof(ip_fw3_opheader);
5193 op3 = (ip_fw3_opheader *)rulebuf;
5194 ctlv = (ipfw_obj_ctlv *)(op3 + 1);
5195 rule = (struct ip_fw_rule *)(ctlv + 1);
5196 rbufsize -= default_off;
5198 compile_rule(av, (uint32_t *)rule, &rbufsize, &ts);
5199 /* Align rule size to u64 boundary */
5200 rlen = roundup2(rbufsize, sizeof(uint64_t));
5205 if (ts.count != 0) {
5206 /* Some tables. We have to alloc more data */
5207 tlen = ts.count * sizeof(ipfw_obj_ntlv);
5208 sz = default_off + sizeof(ipfw_obj_ctlv) + tlen + rlen;
5210 if ((tbuf = calloc(1, sz)) == NULL)
5211 err(EX_UNAVAILABLE, "malloc() failed for IP_FW_ADD");
5212 op3 = (ip_fw3_opheader *)tbuf;
5214 ctlv = (ipfw_obj_ctlv *)(op3 + 1);
5215 ctlv->head.type = IPFW_TLV_TBLNAME_LIST;
5216 ctlv->head.length = sizeof(ipfw_obj_ctlv) + tlen;
5217 ctlv->count = ts.count;
5218 ctlv->objsize = sizeof(ipfw_obj_ntlv);
5219 memcpy(ctlv + 1, ts.idx, tlen);
5220 object_sort_ctlv(ctlv);
5223 ctlv = (ipfw_obj_ctlv *)((caddr_t)ctlv + ctlv->head.length);
5224 ctlv->head.type = IPFW_TLV_RULE_LIST;
5225 ctlv->head.length = sizeof(ipfw_obj_ctlv) + rlen;
5227 memcpy(ctlv + 1, rule, rbufsize);
5229 /* Simply add header */
5230 sz = rlen + default_off;
5231 memset(ctlv, 0, sizeof(*ctlv));
5232 ctlv->head.type = IPFW_TLV_RULE_LIST;
5233 ctlv->head.length = sizeof(ipfw_obj_ctlv) + rlen;
5237 if (do_get3(IP_FW_XADD, op3, &sz) != 0)
5238 err(EX_UNAVAILABLE, "getsockopt(%s)", "IP_FW_XADD");
5241 struct format_opts sfo;
5243 memset(&sfo, 0, sizeof(sfo));
5244 sfo.tstate = tstate;
5245 sfo.set_mask = (uint32_t)(-1);
5246 bp_alloc(&bp, 4096);
5247 show_static_rule(&co, &sfo, &bp, rule, NULL);
5248 printf("%s", bp.buf);
5260 * clear the counters or the log counters.
5261 * optname has the following values:
5262 * 0 (zero both counters and logging)
5263 * 1 (zero logging only)
5266 ipfw_zero(int ac, char *av[], int optname)
5270 char const *name = optname ? "RESETLOG" : "ZERO";
5274 optname = optname ? IP_FW_XRESETLOG : IP_FW_XZERO;
5278 /* clear all entries */
5279 memset(&rt, 0, sizeof(rt));
5280 rt.flags = IPFW_RCFLAG_ALL;
5281 if (do_range_cmd(optname, &rt) < 0)
5282 err(EX_UNAVAILABLE, "setsockopt(IP_FW_X%s)", name);
5284 printf("%s.\n", optname == IP_FW_XZERO ?
5285 "Accounting cleared":"Logging counts reset");
5292 if (isdigit(**av)) {
5293 arg = strtonum(*av, 0, 0xffff, &errstr);
5296 "invalid rule number %s\n", *av);
5297 memset(&rt, 0, sizeof(rt));
5298 rt.start_rule = arg;
5300 rt.flags |= IPFW_RCFLAG_RANGE;
5301 if (co.use_set != 0) {
5302 rt.set = co.use_set - 1;
5303 rt.flags |= IPFW_RCFLAG_SET;
5305 if (do_range_cmd(optname, &rt) != 0) {
5306 warn("rule %u: setsockopt(IP_FW_X%s)",
5308 failed = EX_UNAVAILABLE;
5309 } else if (rt.new_set == 0) {
5310 printf("Entry %d not found\n", arg);
5311 failed = EX_UNAVAILABLE;
5312 } else if (!co.do_quiet)
5313 printf("Entry %d %s.\n", arg,
5314 optname == IP_FW_XZERO ?
5315 "cleared" : "logging count reset");
5317 errx(EX_USAGE, "invalid rule number ``%s''", *av);
5321 if (failed != EX_OK)
5326 ipfw_flush(int force)
5330 if (!force && !co.do_quiet) { /* need to ask user */
5333 printf("Are you sure? [yn] ");
5336 c = toupper(getc(stdin));
5337 while (c != '\n' && getc(stdin) != '\n')
5339 return; /* and do not flush */
5340 } while (c != 'Y' && c != 'N');
5342 if (c == 'N') /* user said no */
5349 /* `ipfw set N flush` - is the same that `ipfw delete set N` */
5350 memset(&rt, 0, sizeof(rt));
5351 if (co.use_set != 0) {
5352 rt.set = co.use_set - 1;
5353 rt.flags = IPFW_RCFLAG_SET;
5355 rt.flags = IPFW_RCFLAG_ALL;
5356 if (do_range_cmd(IP_FW_XDEL, &rt) != 0)
5357 err(EX_UNAVAILABLE, "setsockopt(IP_FW_XDEL)");
5359 printf("Flushed all %s.\n", co.do_pipe ? "pipes" : "rules");
5362 static struct _s_x intcmds[] = {
5363 { "talist", TOK_TALIST },
5364 { "iflist", TOK_IFLIST },
5365 { "olist", TOK_OLIST },
5366 { "vlist", TOK_VLIST },
5370 static struct _s_x otypes[] = {
5371 { "EACTION", IPFW_TLV_EACTION },
5372 { "DYNSTATE", IPFW_TLV_STATE_NAME },
5377 lookup_eaction_name(ipfw_obj_ntlv *ntlv, int cnt, uint16_t type)
5383 for (i = 0; i < cnt; i++) {
5384 if (ntlv[i].head.type != IPFW_TLV_EACTION)
5386 if (IPFW_TLV_EACTION_NAME(ntlv[i].idx) != type)
5388 name = ntlv[i].name;
5395 ipfw_list_objects(int ac, char *av[])
5397 ipfw_obj_lheader req, *olh;
5398 ipfw_obj_ntlv *ntlv;
5403 memset(&req, 0, sizeof(req));
5405 if (do_get3(IP_FW_DUMP_SRVOBJECTS, &req.opheader, &sz) != 0)
5406 if (errno != ENOMEM)
5410 if ((olh = calloc(1, sz)) == NULL)
5414 if (do_get3(IP_FW_DUMP_SRVOBJECTS, &olh->opheader, &sz) != 0) {
5420 printf("Objects list:\n");
5422 printf("There are no objects\n");
5423 ntlv = (ipfw_obj_ntlv *)(olh + 1);
5424 for (i = 0; i < olh->count; i++) {
5425 name = match_value(otypes, ntlv->head.type);
5427 name = lookup_eaction_name(
5428 (ipfw_obj_ntlv *)(olh + 1), olh->count,
5431 printf(" kidx: %4d\ttype: %10d\tname: %s\n",
5432 ntlv->idx, ntlv->head.type, ntlv->name);
5434 printf(" kidx: %4d\ttype: %10s\tname: %s\n",
5435 ntlv->idx, name, ntlv->name);
5442 ipfw_internal_handler(int ac, char *av[])
5447 NEED1("internal cmd required");
5449 if ((tcmd = match_token(intcmds, *av)) == -1)
5450 errx(EX_USAGE, "invalid internal sub-cmd: %s", *av);
5454 ipfw_list_tifaces();
5457 ipfw_list_ta(ac, av);
5460 ipfw_list_objects(ac, av);
5463 ipfw_list_values(ac, av);
5469 ipfw_get_tracked_ifaces(ipfw_obj_lheader **polh)
5471 ipfw_obj_lheader req, *olh;
5474 memset(&req, 0, sizeof(req));
5477 if (do_get3(IP_FW_XIFLIST, &req.opheader, &sz) != 0) {
5478 if (errno != ENOMEM)
5483 if ((olh = calloc(1, sz)) == NULL)
5487 if (do_get3(IP_FW_XIFLIST, &olh->opheader, &sz) != 0) {
5497 ifinfo_cmp(const void *a, const void *b)
5499 ipfw_iface_info *ia, *ib;
5501 ia = (ipfw_iface_info *)a;
5502 ib = (ipfw_iface_info *)b;
5504 return (stringnum_cmp(ia->ifname, ib->ifname));
5508 * Retrieves table list from kernel,
5509 * optionally sorts it and calls requested function for each table.
5510 * Returns 0 on success.
5515 ipfw_obj_lheader *olh;
5516 ipfw_iface_info *info;
5519 if ((error = ipfw_get_tracked_ifaces(&olh)) != 0)
5520 err(EX_OSERR, "Unable to request ipfw tracked interface list");
5523 qsort(olh + 1, olh->count, olh->objsize, ifinfo_cmp);
5525 info = (ipfw_iface_info *)(olh + 1);
5526 for (i = 0; i < olh->count; i++) {
5527 if (info->flags & IPFW_IFFLAG_RESOLVED)
5528 printf("%s ifindex: %d refcount: %u changes: %u\n",
5529 info->ifname, info->ifindex, info->refcnt,
5532 printf("%s ifindex: unresolved refcount: %u changes: %u\n",
5533 info->ifname, info->refcnt, info->gencnt);
5534 info = (ipfw_iface_info *)((caddr_t)info + olh->objsize);