2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1984, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * Sun Microsystems, Inc.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 static char const copyright[] =
38 "@(#) Copyright (c) 1984, 1993\n\
39 The Regents of the University of California. All rights reserved.\n";
43 static char const sccsid[] = "@(#)from: arp.c 8.2 (Berkeley) 1/2/94";
46 #include <sys/cdefs.h>
47 __FBSDID("$FreeBSD$");
50 * arp - display, set, and delete arp table entries
53 #include <sys/param.h>
55 #include <sys/socket.h>
56 #include <sys/sockio.h>
57 #include <sys/sysctl.h>
58 #include <sys/ioctl.h>
62 #include <net/if_dl.h>
63 #include <net/if_types.h>
64 #include <net/route.h>
66 #include <netinet/in.h>
67 #include <netinet/if_ether.h>
69 #include <arpa/inet.h>
84 typedef void (action_fn)(struct sockaddr_dl *sdl, struct sockaddr_in *s_in,
85 struct rt_msghdr *rtm);
87 static int search(u_long addr, action_fn *action);
88 static action_fn print_entry;
89 static action_fn nuke_entry;
91 static int delete(char *host);
92 static void usage(void);
93 static int set(int argc, char **argv);
94 static int get(char *host);
95 static int file(char *name);
96 static struct rt_msghdr *rtmsg(int cmd,
97 struct sockaddr_in *dst, struct sockaddr_dl *sdl);
98 static int get_ether_addr(in_addr_t ipaddr, struct ether_addr *hwaddr);
99 static struct sockaddr_in *getaddr(char *host);
100 static int valid_type(int type);
102 static int nflag; /* no reverse dns lookups */
103 static char *rifname;
105 static time_t expire_time;
106 static int flags, doing_proxy;
108 struct if_nameindex *ifnameindex;
110 /* which function we're supposed to do */
117 #define SETFUNC(f) { if (func) usage(); func = (f); }
119 #define ARP_XO_VERSION "1"
122 main(int argc, char *argv[])
126 int aflag = 0; /* do it for all entries */
128 argc = xo_parse_args(argc, argv);
132 while ((ch = getopt(argc, argv, "andfsSi:")) != -1)
165 if (func != F_GET && !(func == F_DELETE && aflag))
166 xo_errx(1, "-i not applicable to this operation");
167 if (if_nametoindex(rifname) == 0) {
169 xo_errx(1, "interface %s does not exist",
172 xo_err(1, "if_nametoindex(%s)", rifname);
181 xo_set_version(ARP_XO_VERSION);
182 xo_open_container("arp");
183 xo_open_list("arp-cache");
185 search(0, print_entry);
187 xo_close_list("arp-cache");
188 xo_close_container("arp");
198 if (argc < 2 || argc > 6)
200 if (func == F_REPLACE)
201 (void)delete(argv[0]);
202 rtn = set(argc, argv) ? 1 : 0;
208 search(0, nuke_entry);
212 rtn = delete(argv[0]);
222 if (ifnameindex != NULL)
223 if_freenameindex(ifnameindex);
229 * Process a file to set standard arp entries
236 char line[100], arg[5][50], *args[5], *p;
238 if ((fp = fopen(name, "r")) == NULL)
239 xo_err(1, "cannot open %s", name);
240 args[0] = &arg[0][0];
241 args[1] = &arg[1][0];
242 args[2] = &arg[2][0];
243 args[3] = &arg[3][0];
244 args[4] = &arg[4][0];
246 while(fgets(line, sizeof(line), fp) != NULL) {
247 if ((p = strchr(line, '#')) != NULL)
249 for (p = line; isblank(*p); p++);
250 if (*p == '\n' || *p == '\0')
252 i = sscanf(p, "%49s %49s %49s %49s %49s", arg[0], arg[1],
253 arg[2], arg[3], arg[4]);
255 xo_warnx("bad line: %s", line);
267 * Given a hostname, fills up a (static) struct sockaddr_in with
268 * the address of the host and returns a pointer to the
271 static struct sockaddr_in *
275 static struct sockaddr_in reply;
277 bzero(&reply, sizeof(reply));
278 reply.sin_len = sizeof(reply);
279 reply.sin_family = AF_INET;
280 reply.sin_addr.s_addr = inet_addr(host);
281 if (reply.sin_addr.s_addr == INADDR_NONE) {
282 if (!(hp = gethostbyname(host))) {
283 xo_warnx("%s: %s", host, hstrerror(h_errno));
286 bcopy((char *)hp->h_addr, (char *)&reply.sin_addr,
287 sizeof reply.sin_addr);
293 * Returns true if the type is a valid one for ARP.
314 * Set an individual arp entry
317 set(int argc, char **argv)
319 struct sockaddr_in *addr;
320 struct sockaddr_in *dst; /* what are we looking for */
321 struct sockaddr_dl *sdl;
322 struct rt_msghdr *rtm;
323 struct ether_addr *ea;
324 char *host = argv[0], *eaddr = argv[1];
325 struct sockaddr_dl sdl_m;
330 bzero(&sdl_m, sizeof(sdl_m));
331 sdl_m.sdl_len = sizeof(sdl_m);
332 sdl_m.sdl_family = AF_LINK;
337 doing_proxy = flags = expire_time = 0;
339 if (strcmp(argv[0], "temp") == 0) {
342 size_t len = sizeof(max_age);
344 clock_gettime(CLOCK_MONOTONIC, &tp);
345 if (sysctlbyname("net.link.ether.inet.max_age",
346 &max_age, &len, NULL, 0) != 0)
347 xo_err(1, "sysctlbyname");
348 expire_time = tp.tv_sec + max_age;
349 } else if (strcmp(argv[0], "pub") == 0) {
350 flags |= RTF_ANNOUNCE;
352 if (argc && strcmp(argv[1], "only") == 0) {
354 * Compatibility: in pre FreeBSD 8 times
355 * the "only" keyword used to mean that
356 * an ARP entry should be announced, but
357 * not installed into routing table.
361 } else if (strcmp(argv[0], "blackhole") == 0) {
362 if (flags & RTF_REJECT) {
363 xo_errx(1, "Choose one of blackhole or reject, "
366 flags |= RTF_BLACKHOLE;
367 } else if (strcmp(argv[0], "reject") == 0) {
368 if (flags & RTF_BLACKHOLE) {
369 xo_errx(1, "Choose one of blackhole or reject, "
374 xo_warnx("Invalid parameter '%s'", argv[0]);
379 ea = (struct ether_addr *)LLADDR(&sdl_m);
380 if (doing_proxy && !strcmp(eaddr, "auto")) {
381 if (!get_ether_addr(dst->sin_addr.s_addr, ea)) {
382 xo_warnx("no interface found for %s",
383 inet_ntoa(dst->sin_addr));
386 sdl_m.sdl_alen = ETHER_ADDR_LEN;
388 struct ether_addr *ea1 = ether_aton(eaddr);
391 xo_warnx("invalid Ethernet address '%s'", eaddr);
395 sdl_m.sdl_alen = ETHER_ADDR_LEN;
400 * In the case a proxy-arp entry is being added for
401 * a remote end point, the RTF_ANNOUNCE flag in the
402 * RTM_GET command is an indication to the kernel
403 * routing code that the interface associated with
404 * the prefix route covering the local end of the
405 * PPP link should be returned, on which ARP applies.
407 rtm = rtmsg(RTM_GET, dst, NULL);
412 addr = (struct sockaddr_in *)(rtm + 1);
413 sdl = (struct sockaddr_dl *)(SA_SIZE(addr) + (char *)addr);
415 if ((sdl->sdl_family != AF_LINK) ||
416 (rtm->rtm_flags & RTF_GATEWAY) ||
417 !valid_type(sdl->sdl_type)) {
418 xo_warnx("cannot intuit interface index and type for %s", host);
421 sdl_m.sdl_type = sdl->sdl_type;
422 sdl_m.sdl_index = sdl->sdl_index;
423 return (rtmsg(RTM_ADD, dst, &sdl_m) == NULL);
427 * Display an individual arp entry
432 struct sockaddr_in *addr;
435 addr = getaddr(host);
439 xo_set_version(ARP_XO_VERSION);
440 xo_open_container("arp");
441 xo_open_list("arp-cache");
443 found = search(addr->sin_addr.s_addr, print_entry);
446 xo_emit("{d:hostname/%s} ({d:ip-address/%s}) -- no entry",
447 host, inet_ntoa(addr->sin_addr));
449 xo_emit(" on {d:interface/%s}", rifname);
453 xo_close_list("arp-cache");
454 xo_close_container("arp");
461 * Delete an arp entry
466 struct sockaddr_in *addr, *dst;
467 struct rt_msghdr *rtm;
468 struct sockaddr_dl *sdl;
475 * Perform a regular entry delete first.
477 flags &= ~RTF_ANNOUNCE;
479 for (;;) { /* try twice */
480 rtm = rtmsg(RTM_GET, dst, NULL);
485 addr = (struct sockaddr_in *)(rtm + 1);
486 sdl = (struct sockaddr_dl *)(SA_SIZE(addr) + (char *)addr);
489 * With the new L2/L3 restructure, the route
490 * returned is a prefix route. The important
491 * piece of information from the previous
492 * RTM_GET is the interface index. In the
493 * case of ECMP, the kernel will traverse
494 * the route group for the given entry.
496 if (sdl->sdl_family == AF_LINK &&
497 !(rtm->rtm_flags & RTF_GATEWAY) &&
498 valid_type(sdl->sdl_type) ) {
499 addr->sin_addr.s_addr = dst->sin_addr.s_addr;
504 * Regular entry delete failed, now check if there
505 * is a proxy-arp entry to remove.
507 if (flags & RTF_ANNOUNCE) {
508 xo_warnx("delete: cannot locate %s", host);
512 flags |= RTF_ANNOUNCE;
514 rtm->rtm_flags |= RTF_LLDATA;
515 if (rtmsg(RTM_DELETE, dst, NULL) != NULL) {
516 printf("%s (%s) deleted\n", host, inet_ntoa(addr->sin_addr));
524 * Search the arp table and do some action on matching entries
527 search(u_long addr, action_fn *action)
531 char *lim, *buf, *next;
532 struct rt_msghdr *rtm;
533 struct sockaddr_in *sin2;
534 struct sockaddr_dl *sdl;
535 char ifname[IF_NAMESIZE];
536 int st, found_entry = 0;
542 mib[4] = NET_RT_FLAGS;
548 if (sysctl(mib, 6, NULL, &needed, NULL, 0) < 0)
549 xo_err(1, "route-sysctl-estimate");
550 if (needed == 0) /* empty table */
554 buf = reallocf(buf, needed);
556 xo_errx(1, "could not reallocate memory");
557 st = sysctl(mib, 6, buf, &needed, NULL, 0);
558 if (st == 0 || errno != ENOMEM)
560 needed += needed / 8;
563 xo_err(1, "actual retrieval of routing table");
565 for (next = buf; next < lim; next += rtm->rtm_msglen) {
566 rtm = (struct rt_msghdr *)next;
567 sin2 = (struct sockaddr_in *)(rtm + 1);
568 sdl = (struct sockaddr_dl *)((char *)sin2 + SA_SIZE(sin2));
569 if (rifname && if_indextoname(sdl->sdl_index, ifname) &&
570 strcmp(ifname, rifname))
573 if (addr != sin2->sin_addr.s_addr)
577 (*action)(sdl, sin2, rtm);
580 return (found_entry);
584 * Display an arp entry
588 print_entry(struct sockaddr_dl *sdl,
589 struct sockaddr_in *addr, struct rt_msghdr *rtm)
593 struct if_nameindex *p;
595 if (ifnameindex == NULL)
596 if ((ifnameindex = if_nameindex()) == NULL)
597 xo_err(1, "cannot retrieve interface names");
599 xo_open_instance("arp-cache");
602 hp = gethostbyaddr((caddr_t)&(addr->sin_addr),
603 sizeof addr->sin_addr, AF_INET);
610 if (h_errno == TRY_AGAIN)
613 xo_emit("{:hostname/%s} ({:ip-address/%s}) at ", host,
614 inet_ntoa(addr->sin_addr));
616 if ((sdl->sdl_type == IFT_ETHER ||
617 sdl->sdl_type == IFT_L2VLAN ||
618 sdl->sdl_type == IFT_BRIDGE) &&
619 sdl->sdl_alen == ETHER_ADDR_LEN)
620 xo_emit("{:mac-address/%s}",
621 ether_ntoa((struct ether_addr *)LLADDR(sdl)));
623 int n = sdl->sdl_nlen > 0 ? sdl->sdl_nlen + 1 : 0;
625 xo_emit("{:mac-address/%s}", link_ntoa(sdl) + n);
628 xo_emit("{d:/(incomplete)}{en:incomplete/true}");
630 for (p = ifnameindex; p && ifnameindex->if_index &&
631 ifnameindex->if_name; p++) {
632 if (p->if_index == sdl->sdl_index) {
633 xo_emit(" on {:interface/%s}", p->if_name);
638 if (rtm->rtm_rmx.rmx_expire == 0)
639 xo_emit("{d:/ permanent}{en:permanent/true}");
641 static struct timespec tp;
643 clock_gettime(CLOCK_MONOTONIC, &tp);
644 if ((expire_time = rtm->rtm_rmx.rmx_expire - tp.tv_sec) > 0)
645 xo_emit(" expires in {:expires/%d} seconds",
648 xo_emit("{d:/ expired}{en:expired/true}");
651 if (rtm->rtm_flags & RTF_ANNOUNCE)
652 xo_emit("{d:/ published}{en:published/true}");
654 switch(sdl->sdl_type) {
656 xo_emit(" [{:type/ethernet}]");
659 xo_emit(" [{:type/fddi}]");
662 xo_emit(" [{:type/atm}]");
665 xo_emit(" [{:type/vlan}]");
668 xo_emit(" [{:type/firewire}]");
671 xo_emit(" [{:type/bridge}]");
674 xo_emit(" [{:type/infiniband}]");
682 xo_close_instance("arp-cache");
689 nuke_entry(struct sockaddr_dl *sdl __unused,
690 struct sockaddr_in *addr, struct rt_msghdr *rtm)
694 if (rtm->rtm_flags & RTF_PINNED)
697 snprintf(ip, sizeof(ip), "%s", inet_ntoa(addr->sin_addr));
704 fprintf(stderr, "%s\n%s\n%s\n%s\n%s\n%s\n%s\n",
705 "usage: arp [-n] [-i interface] hostname",
706 " arp [-n] [-i interface] -a",
707 " arp -d hostname [pub]",
708 " arp -d [-i interface] -a",
709 " arp -s hostname ether_addr [temp] [reject | blackhole] [pub [only]]",
710 " arp -S hostname ether_addr [temp] [reject | blackhole] [pub [only]]",
715 static struct rt_msghdr *
716 rtmsg(int cmd, struct sockaddr_in *dst, struct sockaddr_dl *sdl)
721 struct sockaddr_in so_mask, *som = &so_mask;
726 struct rt_msghdr m_rtm;
730 struct rt_msghdr *rtm = &m_rtmsg.m_rtm;
731 char *cp = m_rtmsg.m_space;
733 if (s < 0) { /* first time: open socket, get pid */
734 s = socket(PF_ROUTE, SOCK_RAW, 0);
739 bzero(&so_mask, sizeof(so_mask));
741 so_mask.sin_addr.s_addr = 0xffffffff;
745 * XXX RTM_DELETE relies on a previous RTM_GET to fill the buffer
748 if (cmd == RTM_DELETE)
750 bzero((char *)&m_rtmsg, sizeof(m_rtmsg));
751 rtm->rtm_flags = flags;
752 rtm->rtm_version = RTM_VERSION;
756 xo_errx(1, "internal wrong cmd");
758 rtm->rtm_addrs |= RTA_GATEWAY;
759 rtm->rtm_rmx.rmx_expire = expire_time;
760 rtm->rtm_inits = RTV_EXPIRE;
761 rtm->rtm_flags |= (RTF_HOST | RTF_STATIC | RTF_LLDATA);
763 rtm->rtm_addrs |= RTA_NETMASK;
764 rtm->rtm_flags &= ~RTF_HOST;
768 rtm->rtm_addrs |= RTA_DST;
770 #define NEXTADDR(w, s) \
772 if ((s) != NULL && rtm->rtm_addrs & (w)) { \
773 bcopy((s), cp, sizeof(*(s))); \
778 NEXTADDR(RTA_DST, dst);
779 NEXTADDR(RTA_GATEWAY, sdl);
780 NEXTADDR(RTA_NETMASK, som);
782 rtm->rtm_msglen = cp - (char *)&m_rtmsg;
785 rtm->rtm_seq = ++seq;
787 if ((rlen = write(s, (char *)&m_rtmsg, l)) < 0) {
788 if (errno != ESRCH || cmd != RTM_DELETE) {
789 xo_warn("writing to routing socket");
794 l = read(s, (char *)&m_rtmsg, sizeof(m_rtmsg));
795 } while (l > 0 && (rtm->rtm_type != cmd || rtm->rtm_seq != seq ||
796 rtm->rtm_pid != pid));
798 xo_warn("read from routing socket");
803 * get_ether_addr - get the hardware address of an interface on the
804 * the same subnet as ipaddr.
809 get_ether_addr(in_addr_t ipaddr, struct ether_addr *hwaddr)
811 struct ifreq *ifr, *ifend, *ifp;
813 struct sockaddr_dl *dla;
816 struct ifreq ifs[MAX_IFS];
820 sock = socket(AF_INET, SOCK_DGRAM, 0);
824 ifc.ifc_len = sizeof(ifs);
826 if (ioctl(sock, SIOCGIFCONF, &ifc) < 0) {
827 xo_warnx("ioctl(SIOCGIFCONF)");
832 ((struct ifreq *)((char *)&(i)->ifr_addr \
833 + MAX((i)->ifr_addr.sa_len, sizeof((i)->ifr_addr))) )
836 * Scan through looking for an interface with an Internet
837 * address on the same subnet as `ipaddr'.
839 ifend = (struct ifreq *)(ifc.ifc_buf + ifc.ifc_len);
840 for (ifr = ifc.ifc_req; ifr < ifend; ifr = NEXTIFR(ifr) ) {
841 if (ifr->ifr_addr.sa_family != AF_INET)
843 strncpy(ifreq.ifr_name, ifr->ifr_name,
844 sizeof(ifreq.ifr_name));
845 ifreq.ifr_addr = ifr->ifr_addr;
847 * Check that the interface is up,
848 * and not point-to-point or loopback.
850 if (ioctl(sock, SIOCGIFFLAGS, &ifreq) < 0)
852 if ((ifreq.ifr_flags &
853 (IFF_UP|IFF_BROADCAST|IFF_POINTOPOINT|
854 IFF_LOOPBACK|IFF_NOARP)) != (IFF_UP|IFF_BROADCAST))
856 /* Get its netmask and check that it's on the right subnet. */
857 if (ioctl(sock, SIOCGIFNETMASK, &ifreq) < 0)
859 mask = ((struct sockaddr_in *)
860 &ifreq.ifr_addr)->sin_addr.s_addr;
861 ina = ((struct sockaddr_in *)
862 &ifr->ifr_addr)->sin_addr.s_addr;
863 if ((ipaddr & mask) == (ina & mask))
864 break; /* ok, we got it! */
871 * Now scan through again looking for a link-level address
872 * for this interface.
875 for (ifr = ifc.ifc_req; ifr < ifend; ifr = NEXTIFR(ifr))
876 if (strcmp(ifp->ifr_name, ifr->ifr_name) == 0 &&
877 ifr->ifr_addr.sa_family == AF_LINK)
882 * Found the link-level address - copy it out
884 dla = (struct sockaddr_dl *) &ifr->ifr_addr;
885 memcpy(hwaddr, LLADDR(dla), dla->sdl_alen);
886 printf("using interface %s for proxy with address %s\n", ifp->ifr_name,
888 retval = dla->sdl_alen;