Bump to version 1.22.1
[platform/upstream/busybox.git] / networking / ether-wake.c
index b4fb0c2..c38547d 100644 (file)
@@ -2,7 +2,7 @@
 /*
  * ether-wake.c - Send a magic packet to wake up sleeping machines.
  *
- * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
+ * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  *
  * Author:      Donald Becker, http://www.scyld.com/"; http://www.scyld.com/wakeonlan.html
  * Busybox port: Christian Volkmann <haveaniceday@online.de>
@@ -49,9 +49,9 @@
  *     Copyright 1999-2003 Donald Becker and Scyld Computing Corporation.
  *
  *     The author may be reached as becker@scyld, or C/O
- *      Scyld Computing Corporation
- *      914 Bay Ridge Road, Suite 220
- *      Annapolis MD 21403
+ *     Scyld Computing Corporation
+ *     914 Bay Ridge Road, Suite 220
+ *     Annapolis MD 21403
  *
  *   Notes:
  *   On some systems dropping root capability allows the process to be
  *   An alternative to needing 'root' is using a UDP broadcast socket, however
  *   doing so only works with adapters configured for unicast+broadcast Rx
  *   filter.  That configuration consumes more power.
-*/
-
-
-#include <unistd.h>
-#include <stdlib.h>
-#include <stdio.h>
-#include <errno.h>
-#include <ctype.h>
-#include <string.h>
+ */
 
-#include <sys/socket.h>
-#include <sys/types.h>
-#include <sys/ioctl.h>
-#include <features.h>
+//usage:#define ether_wake_trivial_usage
+//usage:       "[-b] [-i IFACE] [-p aa:bb:cc:dd[:ee:ff]/a.b.c.d] MAC"
+//usage:#define ether_wake_full_usage "\n\n"
+//usage:       "Send a magic packet to wake up sleeping machines.\n"
+//usage:       "MAC must be a station address (00:11:22:33:44:55) or\n"
+//usage:       "a hostname with a known 'ethers' entry.\n"
+//usage:     "\n       -b              Broadcast the packet"
+//usage:     "\n       -i IFACE        Interface to use (default eth0)"
+//usage:     "\n       -p PASSWORD     Append four or six byte PASSWORD to the packet"
+
+#include "libbb.h"
 #include <netpacket/packet.h>
-#include <net/ethernet.h>
-#include <netdb.h>
 #include <netinet/ether.h>
-
-#ifdef __linux__
 #include <linux/if.h>
-#endif
-
-#include "busybox.h"
 
 /* Note: PF_INET, SOCK_DGRAM, IPPROTO_UDP would allow SIOCGIFHWADDR to
  * work as non-root, but we need SOCK_PACKET to specify the Ethernet
  */
 #ifdef PF_PACKET
 # define whereto_t sockaddr_ll
-# define make_socket() bb_xsocket(PF_PACKET, SOCK_RAW, 0)
+# define make_socket() xsocket(PF_PACKET, SOCK_RAW, 0)
 #else
 # define whereto_t sockaddr
-# define make_socket() bb_xsocket(AF_INET, SOCK_PACKET, SOCK_PACKET)
+# define make_socket() xsocket(AF_INET, SOCK_PACKET, SOCK_PACKET)
 #endif
 
 #ifdef DEBUG
@@ -107,51 +99,126 @@ void bb_debug_dump_packet(unsigned char *outpack, int pktsize)
        printf("packet dump:\n");
        for (i = 0; i < pktsize; ++i) {
                printf("%2.2x ", outpack[i]);
-               if (i % 20 == 19) printf("\n");
+               if (i % 20 == 19) bb_putchar('\n');
        }
        printf("\n\n");
 }
 #else
-# define bb_debug_msg(fmt, args...)
-# define bb_debug_dump_packet(outpack, pktsize)
+# define bb_debug_msg(fmt, args...)             ((void)0)
+# define bb_debug_dump_packet(outpack, pktsize) ((void)0)
 #endif
 
-static inline void get_dest_addr(const char *arg, struct ether_addr *eaddr);
-static inline int get_fill(unsigned char *pkt, struct ether_addr *eaddr, int broadcast);
-static inline int get_wol_pw(const char *ethoptarg, unsigned char *wol_passwd);
+/* Convert the host ID string to a MAC address.
+ * The string may be a:
+ *    Host name
+ *    IP address string
+ *    MAC address string
+ */
+static void get_dest_addr(const char *hostid, struct ether_addr *eaddr)
+{
+       struct ether_addr *eap;
+
+       eap = ether_aton_r(hostid, eaddr);
+       if (eap) {
+               bb_debug_msg("The target station address is %s\n\n", ether_ntoa(eap));
+#if !defined(__UCLIBC__) || UCLIBC_VERSION >= KERNEL_VERSION(0, 9, 30)
+       } else if (ether_hostton(hostid, eaddr) == 0) {
+               bb_debug_msg("Station address for hostname %s is %s\n\n", hostid, ether_ntoa(eaddr));
+#endif
+       } else {
+               bb_show_usage();
+       }
+}
+
+#define PKT_HEADER_SIZE (20 + 16*6)
+static int fill_pkt_header(unsigned char *pkt, struct ether_addr *eaddr, int broadcast)
+{
+       int i;
+       unsigned char *station_addr = eaddr->ether_addr_octet;
+
+       memset(pkt, 0xff, 6);
+       if (!broadcast)
+               memcpy(pkt, station_addr, 6);
+       pkt += 6;
+
+       memcpy(pkt, station_addr, 6); /* 6 */
+       pkt += 6;
+
+       *pkt++ = 0x08; /* 12 */ /* Or 0x0806 for ARP, 0x8035 for RARP */
+       *pkt++ = 0x42; /* 13 */
+
+       memset(pkt, 0xff, 6); /* 14 */
+
+       for (i = 0; i < 16; ++i) {
+               pkt += 6;
+               memcpy(pkt, station_addr, 6); /* 20,26,32,... */
+       }
+
+       return PKT_HEADER_SIZE; /* length of packet */
+}
+
+static int get_wol_pw(const char *ethoptarg, unsigned char *wol_passwd)
+{
+       unsigned passwd[6];
+       int byte_cnt, i;
+
+       /* handle MAC format */
+       byte_cnt = sscanf(ethoptarg, "%2x:%2x:%2x:%2x:%2x:%2x",
+                         &passwd[0], &passwd[1], &passwd[2],
+                         &passwd[3], &passwd[4], &passwd[5]);
+       /* handle IP format */
+// FIXME: why < 4?? should it be < 6?
+       if (byte_cnt < 4)
+               byte_cnt = sscanf(ethoptarg, "%u.%u.%u.%u",
+                                 &passwd[0], &passwd[1], &passwd[2], &passwd[3]);
+       if (byte_cnt < 4) {
+               bb_error_msg("can't read Wake-On-LAN pass");
+               return 0;
+       }
+// TODO: check invalid numbers >255??
+       for (i = 0; i < byte_cnt; ++i)
+               wol_passwd[i] = passwd[i];
+
+       bb_debug_msg("password: %2.2x %2.2x %2.2x %2.2x (%d)\n\n",
+                    wol_passwd[0], wol_passwd[1], wol_passwd[2], wol_passwd[3],
+                    byte_cnt);
+
+       return byte_cnt;
+}
 
-int etherwake_main(int argc, char *argv[])
+int ether_wake_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
+int ether_wake_main(int argc UNUSED_PARAM, char **argv)
 {
-       char *ifname = "eth0", *pass = NULL;
-       unsigned long flags;
+       const char *ifname = "eth0";
+       char *pass;
+       unsigned flags;
        unsigned char wol_passwd[6];
        int wol_passwd_sz = 0;
-
-       int s;                                          /* Raw socket */
+       int s;  /* Raw socket */
        int pktsize;
-       unsigned char outpack[1000];
+       unsigned char outpack[PKT_HEADER_SIZE + 6 /* max passwd size */ + 16 /* paranoia */];
 
        struct ether_addr eaddr;
-       struct whereto_t whereto;       /* who to wake up */
+       struct whereto_t whereto;  /* who to wake up */
 
        /* handle misc user options */
-       flags = bb_getopt_ulflags(argc, argv, "bi:p:", &ifname, &pass);
-       if (optind == argc)
-               bb_show_usage();
-       if (pass)
+       opt_complementary = "=1";
+       flags = getopt32(argv, "bi:p:", &ifname, &pass);
+       if (flags & 4) /* -p */
                wol_passwd_sz = get_wol_pw(pass, wol_passwd);
+       flags &= 1; /* we further interested only in -b [bcast] flag */
 
        /* create the raw socket */
        s = make_socket();
 
        /* now that we have a raw socket we can drop root */
-       setuid(getuid());
+       /* xsetuid(getuid()); - but save on code size... */
 
        /* look up the dest mac address */
        get_dest_addr(argv[optind], &eaddr);
 
        /* fill out the header of the packet */
-       pktsize = get_fill(outpack, &eaddr, flags /*& 1 [OPT_BROADCAST]*/);
+       pktsize = fill_pkt_header(outpack, &eaddr, flags /* & 1 OPT_BROADCAST */);
 
        bb_debug_dump_packet(outpack, pktsize);
 
@@ -160,9 +227,8 @@ int etherwake_main(int argc, char *argv[])
        {
                struct ifreq if_hwaddr;
 
-               strcpy(if_hwaddr.ifr_name, ifname);
-               if (ioctl(s, SIOCGIFHWADDR, &if_hwaddr) < 0)
-                       bb_perror_msg_and_die("SIOCGIFHWADDR on %s failed", ifname);
+               strncpy_IFNAMSIZ(if_hwaddr.ifr_name, ifname);
+               ioctl_or_perror_and_die(s, SIOCGIFHWADDR, &if_hwaddr, "SIOCGIFHWADDR on %s failed", ifname);
 
                memcpy(outpack+6, if_hwaddr.ifr_hwaddr.sa_data, 6);
 
@@ -170,9 +236,9 @@ int etherwake_main(int argc, char *argv[])
                {
                        unsigned char *hwaddr = if_hwaddr.ifr_hwaddr.sa_data;
                        printf("The hardware address (SIOCGIFHWADDR) of %s is type %d  "
-                                  "%2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x\n\n", ifname,
-                                  if_hwaddr.ifr_hwaddr.sa_family, hwaddr[0], hwaddr[1],
-                                  hwaddr[2], hwaddr[3], hwaddr[4], hwaddr[5]);
+                               "%2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x\n\n", ifname,
+                               if_hwaddr.ifr_hwaddr.sa_family, hwaddr[0], hwaddr[1],
+                               hwaddr[2], hwaddr[3], hwaddr[4], hwaddr[5]);
                }
 # endif
        }
@@ -189,18 +255,16 @@ int etherwake_main(int argc, char *argv[])
        bb_debug_dump_packet(outpack, pktsize);
 
        /* This is necessary for broadcasts to work */
-       if (flags /*& 1 [OPT_BROADCAST]*/) {
-               int one = 1;
-               if (setsockopt(s, SOL_SOCKET, SO_BROADCAST, (void *)&one, sizeof(one)) < 0)
+       if (flags /* & 1 OPT_BROADCAST */) {
+               if (setsockopt_broadcast(s) != 0)
                        bb_perror_msg("SO_BROADCAST");
        }
 
 #if defined(PF_PACKET)
        {
                struct ifreq ifr;
-               strncpy(ifr.ifr_name, ifname, sizeof(ifr.ifr_name));
-               if (ioctl(s, SIOCGIFINDEX, &ifr) == -1)
-                       bb_perror_msg_and_die("SIOCGIFINDEX");
+               strncpy_IFNAMSIZ(ifr.ifr_name, ifname);
+               xioctl(s, SIOCGIFINDEX, &ifr);
                memset(&whereto, 0, sizeof(whereto));
                whereto.sll_family = AF_PACKET;
                whereto.sll_ifindex = ifr.ifr_ifindex;
@@ -213,88 +277,8 @@ int etherwake_main(int argc, char *argv[])
        whereto.sa_family = 0;
        strcpy(whereto.sa_data, ifname);
 #endif
-
-       if (sendto(s, outpack, pktsize, 0, (struct sockaddr *)&whereto, sizeof(whereto)) < 0)
-               bb_perror_msg(bb_msg_write_error);
-
-       close(s);
-
+       xsendto(s, outpack, pktsize, (struct sockaddr *)&whereto, sizeof(whereto));
+       if (ENABLE_FEATURE_CLEAN_UP)
+               close(s);
        return EXIT_SUCCESS;
 }
-
-/* Convert the host ID string to a MAC address.
- * The string may be a:
- *    Host name
- *    IP address string
- *    MAC address string
-*/
-static inline void get_dest_addr(const char *hostid, struct ether_addr *eaddr)
-{
-       struct ether_addr *eap;
-
-       eap = ether_aton(hostid);
-       if (eap) {
-               *eaddr = *eap;
-               bb_debug_msg("The target station address is %s\n\n", ether_ntoa(eaddr));
-#if !defined(__UCLIBC__)
-       } else if (ether_hostton(hostid, eaddr) == 0) {
-               bb_debug_msg("Station address for hostname %s is %s\n\n", hostid, ether_ntoa(eaddr));
-#else
-# warning Need to implement ether_hostton() for uClibc
-#endif
-       } else
-               bb_show_usage();
-}
-
-static inline int get_fill(unsigned char *pkt, struct ether_addr *eaddr, int broadcast)
-{
-       int offset, i;
-       unsigned char *station_addr = eaddr->ether_addr_octet;
-
-       if (broadcast)
-               memset(pkt+0, 0xff, 6);
-       else
-               memcpy(pkt, station_addr, 6);
-       memcpy(pkt+6, station_addr, 6);
-       pkt[12] = 0x08;                         /* Or 0x0806 for ARP, 0x8035 for RARP */
-       pkt[13] = 0x42;
-       offset = 14;
-
-       memset(pkt+offset, 0xff, 6);
-       offset += 6;
-
-       for (i = 0; i < 16; ++i) {
-               memcpy(pkt+offset, station_addr, 6);
-               offset += 6;
-       }
-
-       return offset;
-}
-
-static inline int get_wol_pw(const char *ethoptarg, unsigned char *wol_passwd)
-{
-       int passwd[6];
-       int byte_cnt, i;
-
-       /* handle MAC format */
-       byte_cnt = sscanf(ethoptarg, "%2x:%2x:%2x:%2x:%2x:%2x",
-                         &passwd[0], &passwd[1], &passwd[2],
-                         &passwd[3], &passwd[4], &passwd[5]);
-       /* handle IP format */
-       if (byte_cnt < 4)
-               byte_cnt = sscanf(ethoptarg, "%d.%d.%d.%d",
-                                 &passwd[0], &passwd[1], &passwd[2], &passwd[3]);
-       if (byte_cnt < 4) {
-               bb_error_msg("Unable to read the Wake-On-LAN pass");
-               return 0;
-       }
-
-       for (i = 0; i < byte_cnt; ++i)
-               wol_passwd[i] = passwd[i];
-
-       bb_debug_msg("password: %2.2x %2.2x %2.2x %2.2x (%d)\n\n",
-                    wol_passwd[0], wol_passwd[1], wol_passwd[2], wol_passwd[3],
-                    byte_cnt);
-
-       return byte_cnt;
-}