zcip: fix link-local IP conflict detection
[oweals/busybox.git] / networking / zcip.c
index ef9aa2186324aaebdf5751f8c09a65865447b90e..45d1f7c1c25cf148825052075a0d20ea15eb9751 100644 (file)
@@ -6,7 +6,7 @@
  * Copyright (C) 2003 by Arthur van Hoff (avh@strangeberry.com)
  * Copyright (C) 2004 by David Brownell
  *
- * Licensed under the GPL v2 or later, see the file LICENSE in this tarball.
+ * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
 
 /*
 // - avoid silent script failures, especially under load...
 // - link status monitoring (restart on link-up; stop on link-down)
 
-#include <syslog.h>
-#include <poll.h>
-#include <sys/wait.h>
+//usage:#define zcip_trivial_usage
+//usage:       "[OPTIONS] IFACE SCRIPT"
+//usage:#define zcip_full_usage "\n\n"
+//usage:       "Manage a ZeroConf IPv4 link-local address\n"
+//usage:     "\n       -f              Run in foreground"
+//usage:     "\n       -q              Quit after obtaining address"
+//usage:     "\n       -r 169.254.x.x  Request this address first"
+//usage:     "\n       -v              Verbose"
+//usage:     "\n"
+//usage:     "\nWith no -q, runs continuously monitoring for ARP conflicts,"
+//usage:     "\nexits only on I/O errors (link down etc)"
+
+#include "libbb.h"
 #include <netinet/ether.h>
-#include <net/ethernet.h>
 #include <net/if.h>
 #include <net/if_arp.h>
-#include <linux/if_packet.h>
 #include <linux/sockios.h>
 
-#include "libbb.h"
+#include <syslog.h>
 
 /* We don't need more than 32 bits of the counter */
 #define MONOTONIC_US() ((unsigned)monotonic_us())
@@ -41,7 +49,7 @@
 struct arp_packet {
        struct ether_header eth;
        struct ether_arp arp;
-} ATTRIBUTE_PACKED;
+} PACKED;
 
 enum {
 /* 169.254.0.0 */
@@ -77,35 +85,41 @@ enum {
 };
 
 struct globals {
-       char *intf;
        struct sockaddr saddr;
-};
+       struct ether_addr eth_addr;
+} FIX_ALIASING;
 #define G (*(struct globals*)&bb_common_bufsiz1)
-#define intf  (G.intf )
-#define saddr (G.saddr)
+#define saddr    (G.saddr   )
+#define eth_addr (G.eth_addr)
+#define INIT_G() do { } while (0)
 
 
 /**
  * Pick a random link local IP address on 169.254/16, except that
  * the first and last 256 addresses are reserved.
  */
-static void pick(struct in_addr *ip)
+static uint32_t pick(void)
 {
        unsigned tmp;
 
        do {
                tmp = rand() & IN_CLASSB_HOST;
        } while (tmp > (IN_CLASSB_HOST - 0x0200));
-       ip->s_addr = htonl((LINKLOCAL_ADDR + 0x0100) + tmp);
+       return htonl((LINKLOCAL_ADDR + 0x0100) + tmp);
 }
 
 /**
  * Broadcast an ARP packet.
  */
-static void arp(int op,
-       const struct ether_addr *source_eth, struct in_addr source_ip,
+static void arp(
+       /* int op, - always ARPOP_REQUEST */
+       /* const struct ether_addr *source_eth, - always &eth_addr */
+                                       struct in_addr source_ip,
        const struct ether_addr *target_eth, struct in_addr target_ip)
 {
+       enum { op = ARPOP_REQUEST };
+#define source_eth (&eth_addr)
+
        struct arp_packet p;
        memset(&p, 0, sizeof(p));
 
@@ -126,45 +140,51 @@ static void arp(int op,
        memcpy(&p.arp.arp_tpa, &target_ip, sizeof(p.arp.arp_tpa));
 
        // send it
+       // Even though sock_fd is already bound to saddr, just send()
+       // won't work, because "socket is not connected"
+       // (and connect() won't fix that, "operation not supported").
+       // Thus we sendto() to saddr. I wonder which sockaddr
+       // (from bind() or from sendto()?) kernel actually uses
+       // to determine iface to emit the packet from...
        xsendto(sock_fd, &p, sizeof(p), &saddr, sizeof(saddr));
-
-       // Currently all callers ignore errors, that's why returns are
-       // commented out...
-       //return 0;
+#undef source_eth
 }
 
 /**
- * Run a script. argv[2] is already NULL.
+ * Run a script.
+ * argv[0]:intf argv[1]:script_name argv[2]:junk argv[3]:NULL
  */
-static int run(char *argv[3], struct in_addr *ip)
+static int run(char *argv[3], const char *param, struct in_addr *ip)
 {
        int status;
        char *addr = addr; /* for gcc */
        const char *fmt = "%s %s %s" + 3;
 
-       VDBG("%s run %s %s\n", intf, argv[0], argv[1]);
+       argv[2] = (char*)param;
+
+       VDBG("%s run %s %s\n", argv[0], argv[1], argv[2]);
 
        if (ip) {
                addr = inet_ntoa(*ip);
-               setenv("ip", addr, 1);
+               xsetenv("ip", addr);
                fmt -= 3;
        }
-       bb_info_msg(fmt, argv[1], intf, addr);
+       bb_info_msg(fmt, argv[2], argv[0], addr);
 
-       status = wait4pid(spawn(argv));
+       status = spawn_and_wait(argv + 1);
        if (status < 0) {
-               bb_perror_msg("%s %s %s" + 3, argv[1], intf);
+               bb_perror_msg("%s %s %s" + 3, argv[2], argv[0]);
                return -errno;
        }
        if (status != 0)
-               bb_error_msg("script %s %s failed, exitcode=%d", argv[0], argv[1], status);
+               bb_error_msg("script %s %s failed, exitcode=%d", argv[1], argv[2], status & 0xff);
        return status;
 }
 
 /**
  * Return milliseconds of random delay, up to "secs" seconds.
  */
-static unsigned ALWAYS_INLINE random_delay_ms(unsigned secs)
+static ALWAYS_INLINE unsigned random_delay_ms(unsigned secs)
 {
        return rand() % (secs * 1000);
 }
@@ -173,20 +193,18 @@ static unsigned ALWAYS_INLINE random_delay_ms(unsigned secs)
  * main program
  */
 int zcip_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
-int zcip_main(int argc, char **argv)
+int zcip_main(int argc UNUSED_PARAM, char **argv)
 {
-       int state = PROBE;
-       struct ether_addr eth_addr;
+       int state;
        char *r_opt;
        unsigned opts;
 
-       /* Ugly trick, but I want these zeroed in one go */
+       // ugly trick, but I want these zeroed in one go
        struct {
                const struct in_addr null_ip;
                const struct ether_addr null_addr;
                struct in_addr ip;
                struct ifreq ifr;
-               char *script_av[3];
                int timeout_ms; /* must be signed */
                unsigned conflicts;
                unsigned nprobes;
@@ -198,7 +216,6 @@ int zcip_main(int argc, char **argv)
 #define null_addr  (L.null_addr )
 #define ip         (L.ip        )
 #define ifr        (L.ifr       )
-#define script_av  (L.script_av )
 #define timeout_ms (L.timeout_ms)
 #define conflicts  (L.conflicts )
 #define nprobes    (L.nprobes   )
@@ -207,6 +224,7 @@ int zcip_main(int argc, char **argv)
 #define verbose    (L.verbose   )
 
        memset(&L, 0, sizeof(L));
+       INIT_G();
 
 #define FOREGROUND (opts & 1)
 #define QUIT       (opts & 2)
@@ -214,8 +232,17 @@ int zcip_main(int argc, char **argv)
        // exactly 2 args; -v accumulates and implies -f
        opt_complementary = "=2:vv:vf";
        opts = getopt32(argv, "fqr:v", &r_opt, &verbose);
+#if !BB_MMU
+       // on NOMMU reexec early (or else we will rerun things twice)
+       if (!FOREGROUND)
+               bb_daemonize_or_rexec(0 /*was: DAEMON_CHDIR_ROOT*/, argv);
+#endif
+       // open an ARP socket
+       // (need to do it before openlog to prevent openlog from taking
+       // fd 3 (sock_fd==3))
+       xmove_fd(xsocket(AF_PACKET, SOCK_PACKET, htons(ETH_P_ARP)), sock_fd);
        if (!FOREGROUND) {
-               /* Do it early, before all bb_xx_msg calls */
+               // do it before all bb_xx_msg calls
                openlog(applet_name, 0, LOG_DAEMON);
                logmode |= LOGMODE_SYSLOG;
        }
@@ -226,37 +253,33 @@ int zcip_main(int argc, char **argv)
                        bb_error_msg_and_die("invalid link address");
                }
        }
-       // On NOMMU reexec early (or else we will rerun things twice)
-#if !BB_MMU
-       if (!FOREGROUND)
-               bb_daemonize_or_rexec(DAEMON_CHDIR_ROOT, argv);
-#endif
-       argc -= optind;
-       argv += optind;
+       argv += optind - 1;
 
-       intf = argv[0];
-       script_av[0] = argv[1];
-       setenv("interface", intf, 1);
+       /* Now: argv[0]:junk argv[1]:intf argv[2]:script argv[3]:NULL */
+       /* We need to make space for script argument: */
+       argv[0] = argv[1];
+       argv[1] = argv[2];
+       /* Now: argv[0]:intf argv[1]:script argv[2]:junk argv[3]:NULL */
+#define argv_intf (argv[0])
+
+       xsetenv("interface", argv_intf);
 
        // initialize the interface (modprobe, ifup, etc)
-       script_av[1] = (char*)"init";
-       if (run(script_av, NULL))
+       if (run(argv, "init", NULL))
                return EXIT_FAILURE;
 
        // initialize saddr
        // saddr is: { u16 sa_family; u8 sa_data[14]; }
        //memset(&saddr, 0, sizeof(saddr));
        //TODO: are we leaving sa_family == 0 (AF_UNSPEC)?!
-       safe_strncpy(saddr.sa_data, intf, sizeof(saddr.sa_data));
+       safe_strncpy(saddr.sa_data, argv_intf, sizeof(saddr.sa_data));
 
-       // open an ARP socket
-       xmove_fd(xsocket(AF_PACKET, SOCK_PACKET, htons(ETH_P_ARP)), sock_fd);
        // bind to the interface's ARP socket
        xbind(sock_fd, &saddr, sizeof(saddr));
 
        // get the interface's ethernet address
        //memset(&ifr, 0, sizeof(ifr));
-       strncpy(ifr.ifr_name, intf, sizeof(ifr.ifr_name));
+       strncpy_IFNAMSIZ(ifr.ifr_name, argv_intf);
        xioctl(sock_fd, SIOCGIFHWADDR, &ifr);
        memcpy(&eth_addr, &ifr.ifr_hwaddr.sa_data, ETH_ALEN);
 
@@ -268,11 +291,11 @@ int zcip_main(int argc, char **argv)
        // depending on when we detect conflicts.
        {
                uint32_t t;
-               memcpy(&t, (char*)&eth_addr + 2, 4);
+               move_from_unaligned32(t, ((char *)&eth_addr + 2));
                srand(t);
        }
        if (ip.s_addr == 0)
-               pick(&ip);
+               ip.s_addr = pick();
 
        // FIXME cases to handle:
        //  - zcip already running!
@@ -281,19 +304,27 @@ int zcip_main(int argc, char **argv)
        // daemonize now; don't delay system startup
        if (!FOREGROUND) {
 #if BB_MMU
-               bb_daemonize(DAEMON_CHDIR_ROOT);
+               bb_daemonize(0 /*was: DAEMON_CHDIR_ROOT*/);
 #endif
-               bb_info_msg("start, interface %s", intf);
+               bb_info_msg("start, interface %s", argv_intf);
        }
 
        // run the dynamic address negotiation protocol,
        // restarting after address conflicts:
        //  - start with some address we want to try
        //  - short random delay
-       //  - arp probes to see if another host else uses it
+       //  - arp probes to see if another host uses it
        //  - arp announcements that we're claiming it
        //  - use it
        //  - defend it, within limits
+       // exit if:
+       // - address is successfully obtained and -q was given:
+       //   run "<script> config", then exit with exitcode 0
+       // - poll error (when does this happen?)
+       // - read error (when does this happen?)
+       // - sendto error (in arp()) (when does this happen?)
+       // - revents & POLLERR (link down). run "<script> deconfig" first
+       state = PROBE;
        while (1) {
                struct pollfd fds[1];
                unsigned deadline_us;
@@ -316,12 +347,12 @@ int zcip_main(int argc, char **argv)
                deadline_us = MONOTONIC_US() + timeout_ms * 1000;
 
                VDBG("...wait %d %s nprobes=%u, nclaims=%u\n",
-                               timeout_ms, intf, nprobes, nclaims);
+                               timeout_ms, argv_intf, nprobes, nclaims);
 
                switch (safe_poll(fds, 1, timeout_ms)) {
 
                default:
-                       /*bb_perror_msg("poll"); - done in safe_poll */
+                       //bb_perror_msg("poll"); - done in safe_poll
                        return EXIT_FAILURE;
 
                // timeout
@@ -334,23 +365,23 @@ int zcip_main(int argc, char **argv)
                                if (nprobes < PROBE_NUM) {
                                        nprobes++;
                                        VDBG("probe/%u %s@%s\n",
-                                                       nprobes, intf, inet_ntoa(ip));
-                                       arp(ARPOP_REQUEST,
-                                                       &eth_addr, null_ip,
-                                                       &null_addr, ip);
+                                                       nprobes, argv_intf, inet_ntoa(ip));
                                        timeout_ms = PROBE_MIN * 1000;
                                        timeout_ms += random_delay_ms(PROBE_MAX - PROBE_MIN);
+                                       arp(/* ARPOP_REQUEST, */
+                                                       /* &eth_addr, */ null_ip,
+                                                       &null_addr, ip);
                                }
                                else {
                                        // Switch to announce state.
                                        state = ANNOUNCE;
                                        nclaims = 0;
                                        VDBG("announce/%u %s@%s\n",
-                                                       nclaims, intf, inet_ntoa(ip));
-                                       arp(ARPOP_REQUEST,
-                                                       &eth_addr, ip,
-                                                       &eth_addr, ip);
+                                                       nclaims, argv_intf, inet_ntoa(ip));
                                        timeout_ms = ANNOUNCE_INTERVAL * 1000;
+                                       arp(/* ARPOP_REQUEST, */
+                                                       /* &eth_addr, */ ip,
+                                                       &eth_addr, ip);
                                }
                                break;
                        case RATE_LIMIT_PROBE:
@@ -359,11 +390,11 @@ int zcip_main(int argc, char **argv)
                                state = ANNOUNCE;
                                nclaims = 0;
                                VDBG("announce/%u %s@%s\n",
-                                               nclaims, intf, inet_ntoa(ip));
-                               arp(ARPOP_REQUEST,
-                                               &eth_addr, ip,
-                                               &eth_addr, ip);
+                                               nclaims, argv_intf, inet_ntoa(ip));
                                timeout_ms = ANNOUNCE_INTERVAL * 1000;
+                               arp(/* ARPOP_REQUEST, */
+                                               /* &eth_addr, */ ip,
+                                               &eth_addr, ip);
                                break;
                        case ANNOUNCE:
                                // timeouts in the ANNOUNCE state mean no conflicting ARP packets
@@ -371,19 +402,18 @@ int zcip_main(int argc, char **argv)
                                if (nclaims < ANNOUNCE_NUM) {
                                        nclaims++;
                                        VDBG("announce/%u %s@%s\n",
-                                                       nclaims, intf, inet_ntoa(ip));
-                                       arp(ARPOP_REQUEST,
-                                                       &eth_addr, ip,
-                                                       &eth_addr, ip);
+                                                       nclaims, argv_intf, inet_ntoa(ip));
                                        timeout_ms = ANNOUNCE_INTERVAL * 1000;
+                                       arp(/* ARPOP_REQUEST, */
+                                                       /* &eth_addr, */ ip,
+                                                       &eth_addr, ip);
                                }
                                else {
                                        // Switch to monitor state.
                                        state = MONITOR;
                                        // link is ok to use earlier
                                        // FIXME update filters
-                                       script_av[1] = (char*)"config";
-                                       run(script_av, &ip);
+                                       run(argv, "config", &ip);
                                        ready = 1;
                                        conflicts = 0;
                                        timeout_ms = -1; // Never timeout in the monitor state.
@@ -403,7 +433,7 @@ int zcip_main(int argc, char **argv)
                        default:
                                // Invalid, should never happen.  Restart the whole protocol.
                                state = PROBE;
-                               pick(&ip);
+                               ip.s_addr = pick();
                                timeout_ms = 0;
                                nprobes = 0;
                                nclaims = 0;
@@ -432,10 +462,9 @@ int zcip_main(int argc, char **argv)
                                if (fds[0].revents & POLLERR) {
                                        // FIXME: links routinely go down;
                                        // this shouldn't necessarily exit.
-                                       bb_error_msg("iface %s is down", intf);
+                                       bb_error_msg("iface %s is down", argv_intf);
                                        if (ready) {
-                                               script_av[1] = (char*)"deconfig";
-                                               run(script_av, &ip);
+                                               run(argv, "deconfig", &ip);
                                        }
                                        return EXIT_FAILURE;
                                }
@@ -455,7 +484,7 @@ int zcip_main(int argc, char **argv)
                                struct in_addr *spa = (struct in_addr *) p.arp.arp_spa;
                                struct in_addr *tpa = (struct in_addr *) p.arp.arp_tpa;
                                VDBG("%s recv arp type=%d, op=%d,\n",
-                                       intf, ntohs(p.eth.ether_type),
+                                       argv_intf, ntohs(p.eth.ether_type),
                                        ntohs(p.arp.arp_op));
                                VDBG("\tsource=%s %s\n",
                                        ether_ntoa(sha),
@@ -466,22 +495,28 @@ int zcip_main(int argc, char **argv)
                        }
 #endif
                        if (p.arp.arp_op != htons(ARPOP_REQUEST)
-                        && p.arp.arp_op != htons(ARPOP_REPLY))
+                        && p.arp.arp_op != htons(ARPOP_REPLY)
+                       ) {
                                continue;
+                       }
 
                        source_ip_conflict = 0;
                        target_ip_conflict = 0;
 
-                       if (memcmp(p.arp.arp_spa, &ip.s_addr, sizeof(struct in_addr)) == 0
-                        && memcmp(&p.arp.arp_sha, &eth_addr, ETH_ALEN) != 0
-                       ) {
-                               source_ip_conflict = 1;
-                       }
-                       if (p.arp.arp_op == htons(ARPOP_REQUEST)
-                        && memcmp(p.arp.arp_tpa, &ip.s_addr, sizeof(struct in_addr)) == 0
-                        && memcmp(&p.arp.arp_tha, &eth_addr, ETH_ALEN) != 0
-                       ) {
-                               target_ip_conflict = 1;
+                       if (memcmp(&p.arp.arp_sha, &eth_addr, ETH_ALEN) != 0) {
+                               if (memcmp(p.arp.arp_spa, &ip.s_addr, sizeof(struct in_addr))) {
+                                       /* A probe or reply with source_ip == chosen ip */
+                                       source_ip_conflict = 1;
+                               }
+                               if (p.arp.arp_op == htons(ARPOP_REQUEST)
+                                && memcmp(p.arp.arp_spa, &null_ip, sizeof(struct in_addr)) == 0
+                                && memcmp(p.arp.arp_tpa, &ip.s_addr, sizeof(struct in_addr)) == 0
+                               ) {
+                                       /* A probe with source_ip == 0.0.0.0, target_ip == chosen ip:
+                                        * another host trying to claim this ip!
+                                        */
+                                       target_ip_conflict = 1;
+                               }
                        }
 
                        VDBG("state = %d, source ip conflict = %d, target ip conflict = %d\n",
@@ -494,13 +529,13 @@ int zcip_main(int argc, char **argv)
                                if (source_ip_conflict || target_ip_conflict) {
                                        conflicts++;
                                        if (conflicts >= MAX_CONFLICTS) {
-                                               VDBG("%s ratelimit\n", intf);
+                                               VDBG("%s ratelimit\n", argv_intf);
                                                timeout_ms = RATE_LIMIT_INTERVAL * 1000;
                                                state = RATE_LIMIT_PROBE;
                                        }
 
                                        // restart the whole protocol
-                                       pick(&ip);
+                                       ip.s_addr = pick();
                                        timeout_ms = 0;
                                        nprobes = 0;
                                        nclaims = 0;
@@ -512,8 +547,8 @@ int zcip_main(int argc, char **argv)
                                        VDBG("monitor conflict -- defending\n");
                                        state = DEFEND;
                                        timeout_ms = DEFEND_INTERVAL * 1000;
-                                       arp(ARPOP_REQUEST,
-                                               &eth_addr, ip,
+                                       arp(/* ARPOP_REQUEST, */
+                                               /* &eth_addr, */ ip,
                                                &eth_addr, ip);
                                }
                                break;
@@ -523,11 +558,10 @@ int zcip_main(int argc, char **argv)
                                        state = PROBE;
                                        VDBG("defend conflict -- starting over\n");
                                        ready = 0;
-                                       script_av[1] = (char*)"deconfig";
-                                       run(script_av, &ip);
+                                       run(argv, "deconfig", &ip);
 
                                        // restart the whole protocol
-                                       pick(&ip);
+                                       ip.s_addr = pick();
                                        timeout_ms = 0;
                                        nprobes = 0;
                                        nclaims = 0;
@@ -537,7 +571,7 @@ int zcip_main(int argc, char **argv)
                                // Invalid, should never happen.  Restart the whole protocol.
                                VDBG("invalid state -- starting over\n");
                                state = PROBE;
-                               pick(&ip);
+                               ip.s_addr = pick();
                                timeout_ms = 0;
                                nprobes = 0;
                                nclaims = 0;
@@ -546,4 +580,5 @@ int zcip_main(int argc, char **argv)
                        break; // case 1 (packets arriving)
                } // switch poll
        } // while (1)
+#undef argv_intf
 }