2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2007-2009 Bruce Simpson.
5 * Copyright (c) 2000 Wilbert De Graaf.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * Diagnostic and test utility for multicast sockets.
35 * XXX: This file currently assumes INET support in the base system.
36 * TODO: Support embedded KAME Scope ID in IPv6 group addresses.
37 * TODO: Use IPv4 link-local address when source address selection
38 * is implemented; use MCAST_JOIN_SOURCE for IPv4.
41 #include <sys/cdefs.h>
42 __FBSDID("$FreeBSD$");
44 #include <sys/types.h>
45 #include <sys/param.h>
46 #include <sys/errno.h>
47 #include <sys/socket.h>
49 #include <sys/ioctl.h>
52 #include <net/if_dl.h>
53 #include <net/ethernet.h>
55 #include <netinet/in.h>
56 #include <netinet/in_systm.h>
57 #include <netinet/ip.h>
58 #include <netinet/ip_var.h>
61 #include <netinet/in.h>
62 #include <netinet/ip6.h>
74 #include <arpa/inet.h>
79 struct sockaddr_storage ss;
81 struct sockaddr_dl sdl;
83 struct sockaddr_in sin;
86 struct sockaddr_in6 sin6;
89 typedef union sockunion sockunion_t;
94 struct ip_mreq_source mrs;
98 struct group_source_req gr;
101 typedef union mrequnion mrequnion_t;
105 #define LINE_LENGTH 80
108 static int __ifindex_to_primary_ip(const uint32_t, struct in_addr *);
110 static uint32_t parse_cmd_args(sockunion_t *, sockunion_t *,
111 const char *, const char *, const char *);
112 static void process_file(char *, int, int);
113 static void process_cmd(char*, int, int, FILE *);
114 static int su_cmp(const void *, const void *);
115 static void usage(void);
118 * Ordering predicate for qsort().
121 su_cmp(const void *a, const void *b)
123 const sockunion_t *sua = (const sockunion_t *)a;
124 const sockunion_t *sub = (const sockunion_t *)b;
126 assert(sua->sa.sa_family == sub->sa.sa_family);
128 switch (sua->sa.sa_family) {
131 return ((int)(sua->sin.sin_addr.s_addr -
132 sub->sin.sin_addr.s_addr));
137 return (memcmp(&sua->sin6.sin6_addr, &sub->sin6.sin6_addr,
138 sizeof(struct in6_addr)));
145 assert(sua->sa.sa_len == sub->sa.sa_len);
146 return (memcmp(sua, sub, sua->sa.sa_len));
151 * Internal: Map an interface index to primary IPv4 address.
152 * This is somewhat inefficient. This is a useful enough operation
153 * that it probably belongs in the C library.
154 * Return zero if found, -1 on error, 1 on not found.
157 __ifindex_to_primary_ip(const uint32_t ifindex, struct in_addr *pina)
159 char ifname[IFNAMSIZ];
161 struct ifaddrs *ifaddrs;
165 assert(ifindex != 0);
168 if (if_indextoname(ifindex, ifname) == NULL)
170 if (getifaddrs(&ifaddrs) < 0)
174 * Find the ifaddr entry corresponding to the interface name,
175 * and return the first matching IPv4 address.
178 for (ifa = ifaddrs; ifa != NULL; ifa = ifa->ifa_next) {
179 if (strcmp(ifa->ifa_name, ifname) != 0)
181 psu = (sockunion_t *)ifa->ifa_addr;
182 if (psu && psu->sa.sa_family == AF_INET) {
184 memcpy(pina, &psu->sin.sin_addr,
185 sizeof(struct in_addr));
191 errno = EADDRNOTAVAIL; /* XXX */
193 freeifaddrs(ifaddrs);
199 main(int argc, char **argv)
201 char line[LINE_LENGTH];
208 s = socket(AF_INET, SOCK_DGRAM, IPPROTO_UDP);
209 if (s == -1 && errno != EAFNOSUPPORT)
210 err(1, "can't open IPv4 socket");
213 s6 = socket(AF_INET6, SOCK_DGRAM, IPPROTO_UDP);
214 if (s6 == -1 && errno != EAFNOSUPPORT)
215 err(1, "can't open IPv6 socket");
217 if (s == -1 && s6 == -1)
218 errc(1, EPROTONOSUPPORT, "can't open socket");
221 if (isatty(STDIN_FILENO)) {
222 printf("multicast membership test program; "
223 "enter ? for list of commands\n");
226 if (fgets(line, sizeof(line), stdin) != NULL) {
228 process_cmd(line, s, s6, stdin);
230 /* Get the filename */
231 for (i = 1; isblank(line[i]); i++);
232 if ((p = (char*)strchr(line, '\n'))
235 process_file(&line[i], s, s6);
238 } while (!feof(stdin));
240 for (i = 1; i < argc; i++) {
241 process_file(argv[i], s, s6);
254 process_file(char *fname, int s, int s6)
260 fp = fopen(fname, "r");
266 /* Skip comments and empty lines. */
267 while (fgets(line, sizeof(line), fp) != NULL) {
269 while (isblank(*lineptr))
271 if (*lineptr != '#' && *lineptr != '\n')
272 process_cmd(lineptr, s, s6, fp);
279 * Parse join/leave/allow/block arguments, given:
280 * str1: group (as AF_INET or AF_INET6 printable)
282 * str3: optional source address (may be NULL).
283 * This argument must have the same parsed address family as str1.
284 * Return the ifindex of ifname, or 0 if any parse element failed.
287 parse_cmd_args(sockunion_t *psu, sockunion_t *psu2,
288 const char *str1, const char *str2, const char *str3)
290 struct addrinfo hints;
291 struct addrinfo *res;
296 assert(str1 != NULL);
297 assert(str2 != NULL);
301 ifindex = if_nametoindex(str2);
305 memset(&hints, 0, sizeof(struct addrinfo));
306 hints.ai_flags = AI_NUMERICHOST;
307 hints.ai_family = PF_UNSPEC;
308 hints.ai_socktype = SOCK_DGRAM;
310 memset(psu, 0, sizeof(sockunion_t));
311 psu->sa.sa_family = AF_UNSPEC;
313 error = getaddrinfo(str1, "0", &hints, &res);
315 warnx("getaddrinfo: %s", gai_strerror(error));
320 memcpy(psu, res->ai_addr, res->ai_addrlen);
323 /* sscanf() may pass the empty string. */
324 if (psu2 != NULL && str3 != NULL && *str3 != '\0') {
325 memset(psu2, 0, sizeof(sockunion_t));
326 psu2->sa.sa_family = AF_UNSPEC;
328 /* look for following address family; str3 is *optional*. */
329 hints.ai_family = af;
330 error = getaddrinfo(str3, "0", &hints, &res);
332 warnx("getaddrinfo: %s", gai_strerror(error));
335 if (af != res->ai_family) {
336 errno = EINVAL; /* XXX */
339 memcpy(psu2, res->ai_addr, res->ai_addrlen);
348 af2sock(const int af, int s, int s6)
363 af2socklen(const int af)
368 return (sizeof(struct sockaddr_in));
372 return (sizeof(struct sockaddr_in6));
378 process_cmd(char *cmd, int s, int s6, FILE *fp __unused)
389 uint32_t fmode, ifindex;
392 int af, error, f, flags, i, level, n, optname;
395 su.sa.sa_family = AF_UNSPEC;
396 su2.sa.sa_family = AF_UNSPEC;
399 while (isblank(*++line))
400 ; /* Skip whitespace. */
413 if ((sscanf(line, "%d", &n) != 1) || (n < 1)) {
425 sscanf(line, "%s %s %s", str1, str2, str3);
426 ifindex = parse_cmd_args(&su, &su2, str1, str2, str3);
431 af = su.sa.sa_family;
436 error = __ifindex_to_primary_ip(ifindex, &ina);
438 warn("primary_ip_lookup %s", str2);
444 if (su2.sa.sa_family != AF_UNSPEC) {
445 mr.mrs.imr_multiaddr = su.sin.sin_addr;
446 mr.mrs.imr_sourceaddr = su2.sin.sin_addr;
447 mr.mrs.imr_interface = ina;
448 optname = (*cmd == 'j') ?
449 IP_ADD_SOURCE_MEMBERSHIP :
450 IP_DROP_SOURCE_MEMBERSHIP;
451 toptname = (*cmd == 'j') ?
452 "IP_ADD_SOURCE_MEMBERSHIP" :
453 "IP_DROP_SOURCE_MEMBERSHIP";
454 optval = (void *)&mr.mrs;
455 optlen = sizeof(mr.mrs);
457 mr.mr.imr_multiaddr = su.sin.sin_addr;
458 mr.mr.imr_interface = ina;
459 optname = (*cmd == 'j') ?
460 IP_ADD_MEMBERSHIP : IP_DROP_MEMBERSHIP;
461 toptname = (*cmd == 'j') ?
462 "IP_ADD_MEMBERSHIP" : "IP_DROP_MEMBERSHIP";
463 optval = (void *)&mr.mr;
464 optlen = sizeof(mr.mr);
467 warnc(EPROTONOSUPPORT, "setsockopt %s",
469 } else if (setsockopt(s, level, optname, optval,
474 warn("setsockopt %s", toptname);
479 #endif /* INET with INET6 */
482 if (af == AF_INET6) {
483 level = IPPROTO_IPV6;
484 if (su2.sa.sa_family != AF_UNSPEC) {
485 mr.gr.gsr_interface = ifindex;
486 mr.gr.gsr_group = su.ss;
487 mr.gr.gsr_source = su2.ss;
488 optname = (*cmd == 'j') ?
489 MCAST_JOIN_SOURCE_GROUP:
490 MCAST_LEAVE_SOURCE_GROUP;
491 toptname = (*cmd == 'j') ?
492 "MCAST_JOIN_SOURCE_GROUP":
493 "MCAST_LEAVE_SOURCE_GROUP";
494 optval = (void *)&mr.gr;
495 optlen = sizeof(mr.gr);
497 mr.mr6.ipv6mr_multiaddr = su.sin6.sin6_addr;
498 mr.mr6.ipv6mr_interface = ifindex;
499 optname = (*cmd == 'j') ?
502 toptname = (*cmd == 'j') ?
505 optval = (void *)&mr.mr6;
506 optlen = sizeof(mr.mr6);
509 warnc(EPROTONOSUPPORT, "setsockopt %s",
511 } else if (setsockopt(s6, level, optname, optval,
516 warn("setsockopt %s", toptname);
525 * Set the socket to include or exclude filter mode, and
526 * add some sources to the filterlist, using the full-state API.
530 sockunion_t sources[MAX_ADDRS];
531 struct addrinfo hints;
532 struct addrinfo *res;
537 fmode = (*cmd == 'i') ? MCAST_INCLUDE : MCAST_EXCLUDE;
538 if ((sscanf(line, "%s %s %d", str1, str2, &n)) != 3) {
543 ifindex = parse_cmd_args(&su, NULL, str1, str2, NULL);
544 if (ifindex == 0 || n < 0 || n > MAX_ADDRS) {
548 af = su.sa.sa_family;
549 if (af2sock(af, s, s6) == -1) {
550 warnc(EPROTONOSUPPORT, "setsourcefilter");
554 memset(&hints, 0, sizeof(struct addrinfo));
555 hints.ai_flags = AI_NUMERICHOST;
556 hints.ai_family = af;
557 hints.ai_socktype = SOCK_DGRAM;
559 for (i = 0; i < n; i++) {
560 sockunion_t *psu = (sockunion_t *)&sources[i];
562 * Trim trailing whitespace, as getaddrinfo()
563 * can't cope with it.
565 fgets(str1, sizeof(str1), fp);
566 cp = strchr(str1, '\n');
571 error = getaddrinfo(str1, "0", &hints, &res);
576 memset(psu, 0, sizeof(sockunion_t));
577 af1 = res->ai_family;
579 memcpy(psu, res->ai_addr, res->ai_addrlen);
586 warnx("getaddrinfo: %s", gai_strerror(error));
590 if (setsourcefilter(af2sock(af, s, s6), ifindex,
591 &su.sa, su.sa.sa_len, fmode, n, &sources[0].ss) != 0)
592 warn("setsourcefilter");
598 * Allow or block traffic from a source, using the
605 sscanf(line, "%s %s %s", str1, str2, str3);
606 ifindex = parse_cmd_args(&su, &su2, str1, str2, str3);
607 if (ifindex == 0 || su2.sa.sa_family == AF_UNSPEC) {
611 af = su.sa.sa_family;
612 if (af2sock(af, s, s6) == -1) {
613 warnc(EPROTONOSUPPORT, "getsourcefilter");
617 /* First determine our current filter mode. */
618 if (getsourcefilter(af2sock(af, s, s6), ifindex,
619 &su.sa, su.sa.sa_len, &fmode, &n, NULL) != 0) {
620 warn("getsourcefilter");
627 error = __ifindex_to_primary_ip(ifindex, &ina);
629 warn("primary_ip_lookup %s", str2);
634 optval = (void *)&mr.mrs;
635 optlen = sizeof(mr.mrs);
636 mr.mrs.imr_multiaddr = su.sin.sin_addr;
637 mr.mrs.imr_sourceaddr = su2.sin.sin_addr;
638 mr.mrs.imr_interface = ina;
639 if (fmode == MCAST_EXCLUDE) {
640 /* Any-source mode socket membership. */
641 optname = (*cmd == 't') ?
644 toptname = (*cmd == 't') ?
645 "IP_UNBLOCK_SOURCE" :
648 /* Source-specific mode socket membership. */
649 optname = (*cmd == 't') ?
650 IP_ADD_SOURCE_MEMBERSHIP :
651 IP_DROP_SOURCE_MEMBERSHIP;
652 toptname = (*cmd == 't') ?
653 "IP_ADD_SOURCE_MEMBERSHIP" :
654 "IP_DROP_SOURCE_MEMBERSHIP";
656 if (setsockopt(s, level, optname, optval,
661 warn("setsockopt %s", toptname);
666 #endif /* INET with INET6 */
669 if (af == AF_INET6) {
670 level = IPPROTO_IPV6;
671 mr.gr.gsr_interface = ifindex;
672 mr.gr.gsr_group = su.ss;
673 mr.gr.gsr_source = su2.ss;
674 if (fmode == MCAST_EXCLUDE) {
675 /* Any-source mode socket membership. */
676 optname = (*cmd == 't') ?
677 MCAST_UNBLOCK_SOURCE :
679 toptname = (*cmd == 't') ?
680 "MCAST_UNBLOCK_SOURCE" :
681 "MCAST_BLOCK_SOURCE";
683 /* Source-specific mode socket membership. */
684 optname = (*cmd == 't') ?
685 MCAST_JOIN_SOURCE_GROUP :
686 MCAST_LEAVE_SOURCE_GROUP;
687 toptname = (*cmd == 't') ?
688 "MCAST_JOIN_SOURCE_GROUP":
689 "MCAST_LEAVE_SOURCE_GROUP";
691 optval = (void *)&mr.gr;
692 optlen = sizeof(mr.gr);
693 if (setsockopt(s6, level, optname, optval,
698 warn("setsockopt %s", toptname);
707 sockunion_t sources[MAX_ADDRS];
708 char addrbuf[NI_MAXHOST];
711 if ((sscanf(line, "%s %s %d", str1, str2, &nreqsrc)) != 3) {
715 ifindex = parse_cmd_args(&su, NULL, str1, str2, NULL);
716 if (ifindex == 0 || (n < 0 || n > MAX_ADDRS)) {
721 af = su.sa.sa_family;
722 if (af2sock(af, s, s6) == -1) {
723 warnc(EPROTONOSUPPORT, "getsourcefilter");
727 if (getsourcefilter(af2sock(af, s, s6), ifindex, &su.sa,
728 su.sa.sa_len, &fmode, &nsrc, &sources[0].ss) != 0) {
729 warn("getsourcefilter");
733 printf("%s\n", (fmode == MCAST_INCLUDE) ? "include" :
735 printf("%d\n", nsrc);
737 nsrc = MIN(nreqsrc, nsrc);
738 fprintf(stderr, "hexdump of sources:\n");
739 uint8_t *bp = (uint8_t *)&sources[0];
740 for (j = 0; j < (nsrc * sizeof(sources[0])); j++) {
741 fprintf(stderr, "%02x", bp[j]);
743 fprintf(stderr, "\nend hexdump\n");
745 qsort(sources, nsrc, af2socklen(af), su_cmp);
746 for (i = 0; i < nsrc; i++) {
747 sockunion_t *psu = (sockunion_t *)&sources[i];
749 error = getnameinfo(&psu->sa, psu->sa.sa_len,
750 addrbuf, sizeof(addrbuf), NULL, 0,
753 warnx("getnameinfo: %s", gai_strerror(error));
755 printf("%s\n", addrbuf);
760 /* link-layer stuff follows. */
764 struct sockaddr_dl *dlp;
765 struct ether_addr *ep;
767 memset(&ifr, 0, sizeof(struct ifreq));
768 dlp = (struct sockaddr_dl *)&ifr.ifr_addr;
769 dlp->sdl_len = sizeof(struct sockaddr_dl);
770 dlp->sdl_family = AF_LINK;
773 dlp->sdl_alen = ETHER_ADDR_LEN;
775 if (sscanf(line, "%s %s", str1, str2) != 2) {
776 warnc(EINVAL, "sscanf");
779 ep = ether_aton(str2);
781 warnc(EINVAL, "ether_aton");
784 strlcpy(ifr.ifr_name, str1, IF_NAMESIZE);
785 memcpy(LLADDR(dlp), ep, ETHER_ADDR_LEN);
786 if (ioctl(s, (*cmd == 'a') ? SIOCADDMULTI : SIOCDELMULTI,
788 warn("ioctl SIOCADDMULTI/SIOCDELMULTI");
797 "warning: IFF_ALLMULTI cannot be set from userland "
798 "in FreeBSD; command ignored.\n");
803 if (sscanf(line, "%s %u", ifr.ifr_name, &f) != 2) {
807 if (ioctl(s, SIOCGIFFLAGS, &ifr) == -1) {
808 warn("ioctl SIOCGIFFLAGS");
811 flags = (ifr.ifr_flags & 0xffff) | (ifr.ifr_flagshigh << 16);
813 flags &= ~IFF_PPROMISC;
815 flags |= IFF_PPROMISC;
817 ifr.ifr_flags = flags & 0xffff;
818 ifr.ifr_flagshigh = flags >> 16;
819 if (ioctl(s, SIOCSIFFLAGS, &ifr) == -1)
820 warn("ioctl SIOCGIFFLAGS");
822 printf( "changed to 0x%08x\n", flags );
828 printf("invalid command\n");
837 printf("j mcast-addr ifname [src-addr] - join IP multicast group\n");
838 printf("l mcast-addr ifname [src-addr] - leave IP multicast group\n");
840 "i mcast-addr ifname n - set n include mode src filter\n");
842 "e mcast-addr ifname n - set n exclude mode src filter\n");
843 printf("t mcast-addr ifname src-addr - allow traffic from src\n");
844 printf("b mcast-addr ifname src-addr - block traffic from src\n");
845 printf("g mcast-addr ifname n - get and show n src filters\n");
846 printf("a ifname mac-addr - add link multicast filter\n");
847 printf("d ifname mac-addr - delete link multicast filter\n");
848 printf("m ifname 1/0 - set/clear ether allmulti flag\n");
849 printf("p ifname 1/0 - set/clear ether promisc flag\n");
850 printf("f filename - read command(s) from file\n");
851 printf("s seconds - sleep for some time\n");
852 printf("q - quit\n");