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
22 * In-kernel nat support
25 #include <sys/types.h>
26 #include <sys/socket.h>
27 #include <sys/sysctl.h>
39 #define IPFW_INTERNAL /* Access to protected structures in ip_fw.h. */
42 #include <net/if_dl.h>
43 #include <net/route.h> /* def. of struct route */
44 #include <netinet/in.h>
45 #include <netinet/ip_fw.h>
46 #include <arpa/inet.h>
49 static struct _s_x nat_params[] = {
53 { "deny_in", TOK_DENY_INC },
54 { "same_ports", TOK_SAME_PORTS },
55 { "unreg_only", TOK_UNREG_ONLY },
56 { "skip_global", TOK_SKIP_GLOBAL },
57 { "reset", TOK_RESET_ADDR },
58 { "reverse", TOK_ALIAS_REV },
59 { "proxy_only", TOK_PROXY_ONLY },
60 { "redirect_addr", TOK_REDIR_ADDR },
61 { "redirect_port", TOK_REDIR_PORT },
62 { "redirect_proto", TOK_REDIR_PROTO },
63 { NULL, 0 } /* terminator */
68 * Search for interface with name "ifn", and fill n accordingly:
70 * n->ip ip address of interface "ifn"
71 * n->if_name copy of interface name "ifn"
74 set_addr_dynamic(const char *ifn, struct cfg_nat *n)
78 char *buf, *lim, *next;
79 struct if_msghdr *ifm;
80 struct ifa_msghdr *ifam;
81 struct sockaddr_dl *sdl;
82 struct sockaddr_in *sin;
89 mib[4] = NET_RT_IFLIST;
94 if (sysctl(mib, 6, NULL, &needed, NULL, 0) == -1)
95 err(1, "iflist-sysctl-estimate");
96 buf = safe_calloc(1, needed);
97 if (sysctl(mib, 6, buf, &needed, NULL, 0) == -1)
98 err(1, "iflist-sysctl-get");
101 * Loop through interfaces until one with
102 * given name is found. This is done to
103 * find correct interface index for routing
104 * message processing.
109 ifm = (struct if_msghdr *)next;
110 next += ifm->ifm_msglen;
111 if (ifm->ifm_version != RTM_VERSION) {
113 warnx("routing message version %d "
114 "not understood", ifm->ifm_version);
117 if (ifm->ifm_type == RTM_IFINFO) {
118 sdl = (struct sockaddr_dl *)(ifm + 1);
119 if (strlen(ifn) == sdl->sdl_nlen &&
120 strncmp(ifn, sdl->sdl_data, sdl->sdl_nlen) == 0) {
121 ifIndex = ifm->ifm_index;
122 ifMTU = ifm->ifm_data.ifi_mtu;
128 errx(1, "unknown interface name %s", ifn);
130 * Get interface address.
134 ifam = (struct ifa_msghdr *)next;
135 next += ifam->ifam_msglen;
136 if (ifam->ifam_version != RTM_VERSION) {
138 warnx("routing message version %d "
139 "not understood", ifam->ifam_version);
142 if (ifam->ifam_type != RTM_NEWADDR)
144 if (ifam->ifam_addrs & RTA_IFA) {
146 char *cp = (char *)(ifam + 1);
148 for (i = 1; i < RTA_IFA; i <<= 1) {
149 if (ifam->ifam_addrs & i)
150 cp += SA_SIZE((struct sockaddr *)cp);
152 if (((struct sockaddr *)cp)->sa_family == AF_INET) {
153 sin = (struct sockaddr_in *)cp;
159 errx(1, "%s: cannot get interface address", ifn);
161 n->ip = sin->sin_addr;
162 strncpy(n->if_name, ifn, IF_NAMESIZE);
168 * XXX - The following functions, macros and definitions come from natd.c:
169 * it would be better to move them outside natd.c, in a file
170 * (redirect_support.[ch]?) shared by ipfw and natd, but for now i can live
175 * Definition of a port range, and macros to deal with values.
176 * FORMAT: HI 16-bits == first port in range, 0 == all ports.
177 * LO 16-bits == number of ports in range
178 * NOTES: - Port values are not stored in network byte order.
181 #define port_range u_long
183 #define GETLOPORT(x) ((x) >> 0x10)
184 #define GETNUMPORTS(x) ((x) & 0x0000ffff)
185 #define GETHIPORT(x) (GETLOPORT((x)) + GETNUMPORTS((x)))
187 /* Set y to be the low-port value in port_range variable x. */
188 #define SETLOPORT(x,y) ((x) = ((x) & 0x0000ffff) | ((y) << 0x10))
190 /* Set y to be the number of ports in port_range variable x. */
191 #define SETNUMPORTS(x,y) ((x) = ((x) & 0xffff0000) | (y))
194 StrToAddr (const char* str, struct in_addr* addr)
198 if (inet_aton (str, addr))
201 hp = gethostbyname (str);
203 errx (1, "unknown host %s", str);
205 memcpy (addr, hp->h_addr, sizeof (struct in_addr));
209 StrToPortRange (const char* str, const char* proto, port_range *portRange)
217 /* First see if this is a service, return corresponding port if so. */
218 sp = getservbyname (str,proto);
220 SETLOPORT(*portRange, ntohs(sp->s_port));
221 SETNUMPORTS(*portRange, 1);
225 /* Not a service, see if it's a single port or port range. */
226 sep = strchr (str, '-');
228 SETLOPORT(*portRange, strtol(str, &end, 10));
231 SETNUMPORTS(*portRange, 1);
235 /* Error in port range field. */
236 errx (EX_DATAERR, "%s/%s: unknown service", str, proto);
239 /* Port range, get the values and sanity check. */
240 sscanf (str, "%hu-%hu", &loPort, &hiPort);
241 SETLOPORT(*portRange, loPort);
242 SETNUMPORTS(*portRange, 0); /* Error by default */
243 if (loPort <= hiPort)
244 SETNUMPORTS(*portRange, hiPort - loPort + 1);
246 if (GETNUMPORTS(*portRange) == 0)
247 errx (EX_DATAERR, "invalid port range %s", str);
253 StrToProto (const char* str)
255 if (!strcmp (str, "tcp"))
258 if (!strcmp (str, "udp"))
261 if (!strcmp (str, "sctp"))
263 errx (EX_DATAERR, "unknown protocol %s. Expected sctp, tcp or udp", str);
267 StrToAddrAndPortRange (const char* str, struct in_addr* addr, char* proto,
268 port_range *portRange)
272 ptr = strchr (str, ':');
274 errx (EX_DATAERR, "%s is missing port number", str);
279 StrToAddr (str, addr);
280 return StrToPortRange (ptr, proto, portRange);
283 /* End of stuff taken from natd.c. */
286 * The next 3 functions add support for the addr, port and proto redirect and
287 * their logic is loosely based on SetupAddressRedirect(), SetupPortRedirect()
288 * and SetupProtoRedirect() from natd.c.
290 * Every setup_* function fills at least one redirect entry
291 * (struct cfg_redir) and zero or more server pool entry (struct cfg_spool)
294 * The format of data in buf is:
296 * cfg_nat cfg_redir cfg_spool ...... cfg_spool
298 * ------------------------------------- ------------
299 * | | .....X ... | | | | .....
300 * ------------------------------------- ...... ------------
302 * spool_cnt n=0 ...... n=(X-1)
304 * len points to the amount of available space in buf
305 * space counts the memory consumed by every function
307 * XXX - Every function get all the argv params so it
308 * has to check, in optional parameters, that the next
309 * args is a valid option for the redir entry and not
310 * another token. Only redir_port and redir_proto are
315 estimate_redir_addr(int *ac, char ***av)
317 size_t space = sizeof(struct cfg_redir);
321 while ((sep = strchr(sep, ',')) != NULL) {
329 space += c * sizeof(struct cfg_spool);
335 setup_redir_addr(char *buf, int *ac, char ***av)
341 r = (struct cfg_redir *)buf;
342 r->mode = REDIR_ADDR;
343 /* Skip cfg_redir at beginning of buf. */
344 buf = &buf[sizeof(struct cfg_redir)];
345 space = sizeof(struct cfg_redir);
347 /* Extract local address. */
348 if ((sep = strtok(**av, ",")) != NULL) {
349 struct cfg_spool *spool;
351 /* Setup LSNAT server pool. */
352 r->laddr.s_addr = INADDR_NONE;
353 while (sep != NULL) {
354 spool = (struct cfg_spool *)buf;
355 space += sizeof(struct cfg_spool);
356 StrToAddr(sep, &spool->addr);
359 /* Point to the next possible cfg_spool. */
360 buf = &buf[sizeof(struct cfg_spool)];
361 sep = strtok(NULL, ",");
364 StrToAddr(**av, &r->laddr);
367 /* Extract public address. */
368 StrToAddr(**av, &r->paddr);
375 estimate_redir_port(int *ac, char ***av)
377 size_t space = sizeof(struct cfg_redir);
381 while ((sep = strchr(sep, ',')) != NULL) {
389 space += c * sizeof(struct cfg_spool);
395 setup_redir_port(char *buf, int *ac, char ***av)
398 char *sep, *protoName, *lsnat = NULL;
400 u_short numLocalPorts;
401 port_range portRange;
405 r = (struct cfg_redir *)buf;
406 r->mode = REDIR_PORT;
407 /* Skip cfg_redir at beginning of buf. */
408 buf = &buf[sizeof(struct cfg_redir)];
409 space = sizeof(struct cfg_redir);
414 r->proto = StrToProto(**av);
419 * Extract local address.
421 if ((sep = strchr(**av, ',')) != NULL) {
422 r->laddr.s_addr = INADDR_NONE;
428 * The sctp nat does not allow the port numbers to be mapped to
429 * new port numbers. Therefore, no ports are to be specified
430 * in the target port field.
432 if (r->proto == IPPROTO_SCTP) {
433 if (strchr(**av, ':'))
434 errx(EX_DATAERR, "redirect_port:"
435 "port numbers do not change in sctp, so do "
436 "not specify them as part of the target");
438 StrToAddr(**av, &r->laddr);
440 if (StrToAddrAndPortRange(**av, &r->laddr, protoName,
442 errx(EX_DATAERR, "redirect_port: "
443 "invalid local port range");
445 r->lport = GETLOPORT(portRange);
446 numLocalPorts = GETNUMPORTS(portRange);
452 * Extract public port and optionally address.
454 if ((sep = strchr(**av, ':')) != NULL) {
455 if (StrToAddrAndPortRange(**av, &r->paddr, protoName,
457 errx(EX_DATAERR, "redirect_port: "
458 "invalid public port range");
460 r->paddr.s_addr = INADDR_ANY;
461 if (StrToPortRange(**av, protoName, &portRange) != 0)
462 errx(EX_DATAERR, "redirect_port: "
463 "invalid public port range");
466 r->pport = GETLOPORT(portRange);
467 if (r->proto == IPPROTO_SCTP) { /* so the logic below still works */
468 numLocalPorts = GETNUMPORTS(portRange);
471 r->pport_cnt = GETNUMPORTS(portRange);
475 * Extract remote address and optionally port.
478 * NB: isdigit(**av) => we've to check that next parameter is really an
479 * option for this redirect entry, else stop here processing arg[cv].
481 if (*ac != 0 && isdigit(***av)) {
482 if ((sep = strchr(**av, ':')) != NULL) {
483 if (StrToAddrAndPortRange(**av, &r->raddr, protoName,
485 errx(EX_DATAERR, "redirect_port: "
486 "invalid remote port range");
488 SETLOPORT(portRange, 0);
489 SETNUMPORTS(portRange, 1);
490 StrToAddr(**av, &r->raddr);
494 SETLOPORT(portRange, 0);
495 SETNUMPORTS(portRange, 1);
496 r->raddr.s_addr = INADDR_ANY;
498 r->rport = GETLOPORT(portRange);
499 r->rport_cnt = GETNUMPORTS(portRange);
502 * Make sure port ranges match up, then add the redirect ports.
504 if (numLocalPorts != r->pport_cnt)
505 errx(EX_DATAERR, "redirect_port: "
506 "port ranges must be equal in size");
508 /* Remote port range is allowed to be '0' which means all ports. */
509 if (r->rport_cnt != numLocalPorts &&
510 (r->rport_cnt != 1 || r->rport != 0))
511 errx(EX_DATAERR, "redirect_port: remote port must"
512 "be 0 or equal to local port range in size");
514 /* Setup LSNAT server pool. */
516 struct cfg_spool *spool;
518 sep = strtok(lsnat, ",");
519 while (sep != NULL) {
520 spool = (struct cfg_spool *)buf;
521 space += sizeof(struct cfg_spool);
523 * The sctp nat does not allow the port numbers to
524 * be mapped to new port numbers. Therefore, no ports
525 * are to be specified in the target port field.
527 if (r->proto == IPPROTO_SCTP) {
528 if (strchr (sep, ':')) {
529 errx(EX_DATAERR, "redirect_port:"
530 "port numbers do not change in "
531 "sctp, so do not specify them as "
532 "part of the target");
534 StrToAddr(sep, &spool->addr);
535 spool->port = r->pport;
538 if (StrToAddrAndPortRange(sep, &spool->addr,
539 protoName, &portRange) != 0)
540 errx(EX_DATAERR, "redirect_port:"
541 "invalid local port range");
542 if (GETNUMPORTS(portRange) != 1)
543 errx(EX_DATAERR, "redirect_port: "
544 "local port must be single in "
546 spool->port = GETLOPORT(portRange);
549 /* Point to the next possible cfg_spool. */
550 buf = &buf[sizeof(struct cfg_spool)];
551 sep = strtok(NULL, ",");
559 setup_redir_proto(char *buf, int *ac, char ***av)
562 struct protoent *protoent;
565 r = (struct cfg_redir *)buf;
566 r->mode = REDIR_PROTO;
567 /* Skip cfg_redir at beginning of buf. */
568 buf = &buf[sizeof(struct cfg_redir)];
569 space = sizeof(struct cfg_redir);
574 protoent = getprotobyname(**av);
575 if (protoent == NULL)
576 errx(EX_DATAERR, "redirect_proto: unknown protocol %s", **av);
578 r->proto = protoent->p_proto;
583 * Extract local address.
585 StrToAddr(**av, &r->laddr);
590 * Extract optional public address.
593 r->paddr.s_addr = INADDR_ANY;
594 r->raddr.s_addr = INADDR_ANY;
596 /* see above in setup_redir_port() */
597 if (isdigit(***av)) {
598 StrToAddr(**av, &r->paddr);
602 * Extract optional remote address.
604 /* see above in setup_redir_port() */
605 if (*ac != 0 && isdigit(***av)) {
606 StrToAddr(**av, &r->raddr);
616 print_nat_config(unsigned char *buf)
619 int i, cnt, flag, off;
624 n = (struct cfg_nat *)buf;
627 printf("ipfw nat %u config", n->id);
628 if (strlen(n->if_name) != 0)
629 printf(" if %s", n->if_name);
630 else if (n->ip.s_addr != 0)
631 printf(" ip %s", inet_ntoa(n->ip));
632 while (n->mode != 0) {
633 if (n->mode & PKT_ALIAS_LOG) {
635 n->mode &= ~PKT_ALIAS_LOG;
636 } else if (n->mode & PKT_ALIAS_DENY_INCOMING) {
638 n->mode &= ~PKT_ALIAS_DENY_INCOMING;
639 } else if (n->mode & PKT_ALIAS_SAME_PORTS) {
640 printf(" same_ports");
641 n->mode &= ~PKT_ALIAS_SAME_PORTS;
642 } else if (n->mode & PKT_ALIAS_SKIP_GLOBAL) {
643 printf(" skip_global");
644 n->mode &= ~PKT_ALIAS_SKIP_GLOBAL;
645 } else if (n->mode & PKT_ALIAS_UNREGISTERED_ONLY) {
646 printf(" unreg_only");
647 n->mode &= ~PKT_ALIAS_UNREGISTERED_ONLY;
648 } else if (n->mode & PKT_ALIAS_RESET_ON_ADDR_CHANGE) {
650 n->mode &= ~PKT_ALIAS_RESET_ON_ADDR_CHANGE;
651 } else if (n->mode & PKT_ALIAS_REVERSE) {
653 n->mode &= ~PKT_ALIAS_REVERSE;
654 } else if (n->mode & PKT_ALIAS_PROXY_ONLY) {
655 printf(" proxy_only");
656 n->mode &= ~PKT_ALIAS_PROXY_ONLY;
659 /* Print all the redirect's data configuration. */
660 for (cnt = 0; cnt < n->redir_cnt; cnt++) {
661 t = (struct cfg_redir *)&buf[off];
665 printf(" redirect_addr");
666 if (t->spool_cnt == 0)
667 printf(" %s", inet_ntoa(t->laddr));
669 for (i = 0; i < t->spool_cnt; i++) {
670 s = (struct cfg_spool *)&buf[off];
675 printf("%s", inet_ntoa(s->addr));
678 printf(" %s", inet_ntoa(t->paddr));
681 p = getprotobynumber(t->proto);
682 printf(" redirect_port %s ", p->p_name);
684 printf("%s:%u", inet_ntoa(t->laddr), t->lport);
685 if (t->pport_cnt > 1)
686 printf("-%u", t->lport +
689 for (i=0; i < t->spool_cnt; i++) {
690 s = (struct cfg_spool *)&buf[off];
693 printf("%s:%u", inet_ntoa(s->addr),
700 printf("%s:", inet_ntoa(t->paddr));
701 printf("%u", t->pport);
702 if (!t->spool_cnt && t->pport_cnt > 1)
703 printf("-%u", t->pport + t->pport_cnt - 1);
705 if (t->raddr.s_addr) {
706 printf(" %s", inet_ntoa(t->raddr));
708 printf(":%u", t->rport);
709 if (!t->spool_cnt && t->rport_cnt > 1)
710 printf("-%u", t->rport +
716 p = getprotobynumber(t->proto);
717 printf(" redirect_proto %s %s", p->p_name,
718 inet_ntoa(t->laddr));
719 if (t->paddr.s_addr != 0) {
720 printf(" %s", inet_ntoa(t->paddr));
722 printf(" %s", inet_ntoa(t->raddr));
726 errx(EX_DATAERR, "unknown redir mode");
734 ipfw_config_nat(int ac, char **av)
736 struct cfg_nat *n; /* Nat instance configuration. */
737 int i, off, tok, ac1;
738 char *id, *buf, **av1, *end;
745 errx(EX_DATAERR, "missing nat id");
747 i = (int)strtol(id, &end, 0);
748 if (i <= 0 || *end != '\0')
749 errx(EX_DATAERR, "illegal nat id: %s", id);
753 errx(EX_DATAERR, "missing option");
755 len = sizeof(struct cfg_nat);
759 tok = match_token(nat_params, *av1);
771 case TOK_SKIP_GLOBAL:
779 errx(EX_DATAERR, "redirect_addr: "
780 "not enough arguments");
781 len += estimate_redir_addr(&ac1, &av1);
787 errx(EX_DATAERR, "redirect_port: "
788 "not enough arguments");
791 len += estimate_redir_port(&ac1, &av1);
794 /* Skip optional remoteIP/port */
795 if (ac1 != 0 && isdigit(**av1)) {
800 case TOK_REDIR_PROTO:
802 errx(EX_DATAERR, "redirect_proto: "
803 "not enough arguments");
804 len += sizeof(struct cfg_redir);
807 /* Skip optional remoteIP/port */
808 if (ac1 != 0 && isdigit(**av1)) {
812 if (ac1 != 0 && isdigit(**av1)) {
818 errx(EX_DATAERR, "unrecognised option ``%s''", av1[-1]);
822 if ((buf = malloc(len)) == NULL)
823 errx(EX_OSERR, "malloc failed");
825 /* Offset in buf: save space for n at the beginning. */
828 n = (struct cfg_nat *)buf;
832 tok = match_token(nat_params, *av);
838 errx(EX_DATAERR, "missing option");
839 if (!inet_aton(av[0], &(n->ip)))
840 errx(EX_DATAERR, "bad ip address ``%s''",
847 errx(EX_DATAERR, "missing option");
848 set_addr_dynamic(av[0], n);
853 n->mode |= PKT_ALIAS_LOG;
856 n->mode |= PKT_ALIAS_DENY_INCOMING;
859 n->mode |= PKT_ALIAS_SAME_PORTS;
862 n->mode |= PKT_ALIAS_UNREGISTERED_ONLY;
864 case TOK_SKIP_GLOBAL:
865 n->mode |= PKT_ALIAS_SKIP_GLOBAL;
868 n->mode |= PKT_ALIAS_RESET_ON_ADDR_CHANGE;
871 n->mode |= PKT_ALIAS_REVERSE;
874 n->mode |= PKT_ALIAS_PROXY_ONLY;
877 * All the setup_redir_* functions work directly in
878 * the final buffer, see above for details.
882 case TOK_REDIR_PROTO:
885 i = setup_redir_addr(&buf[off], &ac, &av);
888 i = setup_redir_port(&buf[off], &ac, &av);
890 case TOK_REDIR_PROTO:
891 i = setup_redir_proto(&buf[off], &ac, &av);
900 i = do_cmd(IP_FW_NAT_CFG, buf, off);
902 err(1, "setsockopt(%s)", "IP_FW_NAT_CFG");
905 /* After every modification, we show the resultant rule. */
907 const char *_av[] = {"show", "config", id};
908 ipfw_show_nat(_ac, (char **)(void *)_av);
914 ipfw_show_nat(int ac, char **av)
918 int cmd, i, nbytes, do_cfg, do_rule, frule, lrule, nalloc, size;
919 int nat_cnt, redir_cnt, r;
928 lrule = IPFW_DEFAULT_RULE; /* max ipfw rule number */
935 /* Parse parameters. */
936 for (cmd = IP_FW_NAT_GET_LOG, do_cfg = 0; ac != 0; ac--, av++) {
937 if (!strncmp(av[0], "config", strlen(av[0]))) {
938 cmd = IP_FW_NAT_GET_CONFIG, do_cfg = 1;
941 /* Convert command line rule #. */
942 frule = lrule = strtoul(av[0], &endptr, 10);
944 lrule = strtoul(endptr+1, &endptr, 10);
946 err(EX_USAGE, "invalid rule number: %s", av[0]);
951 while (nbytes >= nalloc) {
954 data = safe_realloc(data, nbytes);
955 if (do_cmd(cmd, data, (uintptr_t)&nbytes) < 0)
956 err(EX_OSERR, "getsockopt(IP_FW_GET_%s)",
957 (cmd == IP_FW_NAT_GET_LOG) ? "LOG" : "CONFIG");
962 nat_cnt = *((int *)data);
963 for (i = sizeof(nat_cnt); nat_cnt; nat_cnt--) {
964 n = (struct cfg_nat *)&data[i];
965 if (frule <= n->id && lrule >= n->id)
966 print_nat_config(&data[i]);
967 i += sizeof(struct cfg_nat);
968 for (redir_cnt = 0; redir_cnt < n->redir_cnt; redir_cnt++) {
969 e = (struct cfg_redir *)&data[i];
970 i += sizeof(struct cfg_redir) + e->spool_cnt *
971 sizeof(struct cfg_spool);
975 for (i = 0; 1; i += LIBALIAS_BUF_SIZE + sizeof(int)) {
977 if (p == data + nbytes)
979 bcopy(p, &r, sizeof(int));
981 if (!(frule <= r && lrule >= r))
984 printf("nat %u: %s\n", r, p+sizeof(int));