networking/ether-wake.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * ether-wake.c - Send a magic packet to wake up sleeping machines.
   4  *
   5  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
   6  *
   7  * Author:      Donald Becker, http://www.scyld.com/"; http://www.scyld.com/wakeonlan.html
   8  * Busybox port: Christian Volkmann <haveaniceday@online.de>
   9  *               Used version of ether-wake.c: v1.09 11/12/2003 Donald Becker, http://www.scyld.com/";
  10  */
  11
  12 /* full usage according Donald Becker
  13  * usage: ether-wake [-i <ifname>] [-p aa:bb:cc:dd[:ee:ff]] 00:11:22:33:44:55\n"
  14  *
  15  *      This program generates and transmits a Wake-On-LAN (WOL)\n"
  16  *      \"Magic Packet\", used for restarting machines that have been\n"
  17  *      soft-powered-down (ACPI D3-warm state).\n"
  18  *      It currently generates the standard AMD Magic Packet format, with\n"
  19  *      an optional password appended.\n"
  20  *
  21  *      The single required parameter is the Ethernet MAC (station) address\n"
  22  *      of the machine to wake or a host ID with known NSS 'ethers' entry.\n"
  23  *      The MAC address may be found with the 'arp' program while the target\n"
  24  *      machine is awake.\n"
  25  *
  26  *      Options:\n"
  27  *              -b      Send wake-up packet to the broadcast address.\n"
  28  *              -D      Increase the debug level.\n"
  29  *              -i ifname       Use interface IFNAME instead of the default 'eth0'.\n"
  30  *              -p <pw>         Append the four or six byte password PW to the packet.\n"
  31  *                                      A password is only required for a few adapter types.\n"
  32  *                                      The password may be specified in ethernet hex format\n"
  33  *                                      or dotted decimal (Internet address)\n"
  34  *              -p 00:22:44:66:88:aa\n"
  35  *              -p 192.168.1.1\n";
  36  *
  37  *
  38  *      This program generates and transmits a Wake-On-LAN (WOL) "Magic Packet",
  39  *      used for restarting machines that have been soft-powered-down
  40  *      (ACPI D3-warm state).  It currently generates the standard AMD Magic Packet
  41  *      format, with an optional password appended.
  42  *
  43  *      This software may be used and distributed according to the terms
  44  *      of the GNU Public License, incorporated herein by reference.
  45  *      Contact the author for use under other terms.
  46  *
  47  *      This source file was originally part of the network tricks package, and
  48  *      is now distributed to support the Scyld Beowulf system.
  49  *      Copyright 1999-2003 Donald Becker and Scyld Computing Corporation.
  50  *
  51  *      The author may be reached as becker@scyld, or C/O
  52  *       Scyld Computing Corporation
  53  *       914 Bay Ridge Road, Suite 220
  54  *       Annapolis MD 21403
  55  *
  56  *   Notes:
  57  *   On some systems dropping root capability allows the process to be
  58  *   dumped, traced or debugged.
  59  *   If someone traces this program, they get control of a raw socket.
  60  *   Linux handles this safely, but beware when porting this program.
  61  *
  62  *   An alternative to needing 'root' is using a UDP broadcast socket, however
  63  *   doing so only works with adapters configured for unicast+broadcast Rx
  64  *   filter.  That configuration consumes more power.
  65 */
  66
  67 //usage:#define ether_wake_trivial_usage
  68 //usage:       "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC"
  69 //usage:#define ether_wake_full_usage "\n\n"
  70 //usage:       "Send a magic packet to wake up sleeping machines.\n"
  71 //usage:       "MAC must be a station address (00:11:22:33:44:55) or\n"
  72 //usage:       "a hostname with a known 'ethers' entry.\n"
  73 //usage:     "\nOptions:"
  74 //usage:     "\n        -b              Send wake-up packet to the broadcast address"
  75 //usage:     "\n        -i iface        Interface to use (default eth0)"
  76 //usage:     "\n        -p pass         Append four or six byte password PW to the packet"
  77
  78 #include <netpacket/packet.h>
  79 #include <net/ethernet.h>
  80 #include <netinet/ether.h>
  81 #include <linux/if.h>
  82
  83 #include "libbb.h"
  84
  85 /* Note: PF_INET, SOCK_DGRAM, IPPROTO_UDP would allow SIOCGIFHWADDR to
  86  * work as non-root, but we need SOCK_PACKET to specify the Ethernet
  87  * destination address.
  88  */
  89 #ifdef PF_PACKET
  90 # define whereto_t sockaddr_ll
  91 # define make_socket() xsocket(PF_PACKET, SOCK_RAW, 0)
  92 #else
  93 # define whereto_t sockaddr
  94 # define make_socket() xsocket(AF_INET, SOCK_PACKET, SOCK_PACKET)
  95 #endif
  96
  97 #ifdef DEBUG
  98 # define bb_debug_msg(fmt, args...) fprintf(stderr, fmt, ## args)
  99 void bb_debug_dump_packet(unsigned char *outpack, int pktsize)
 100 {
 101         int i;
 102         printf("packet dump:\n");
 103         for (i = 0; i < pktsize; ++i) {
 104                 printf("%2.2x ", outpack[i]);
 105                 if (i % 20 == 19) bb_putchar('\n');
 106         }
 107         printf("\n\n");
 108 }
 109 #else
 110 # define bb_debug_msg(fmt, args...)             ((void)0)
 111 # define bb_debug_dump_packet(outpack, pktsize) ((void)0)
 112 #endif
 113
 114 /* Convert the host ID string to a MAC address.
 115  * The string may be a:
 116  *    Host name
 117  *    IP address string
 118  *    MAC address string
 119 */
 120 static void get_dest_addr(const char *hostid, struct ether_addr *eaddr)
 121 {
 122         struct ether_addr *eap;
 123
 124         eap = ether_aton_r(hostid, eaddr);
 125         if (eap) {
 126                 bb_debug_msg("The target station address is %s\n\n", ether_ntoa(eap));
 127 #if !defined(__UCLIBC_MAJOR__) \
 128  || __UCLIBC_MAJOR__ > 0 \
 129  || __UCLIBC_MINOR__ > 9 \
 130  || (__UCLIBC_MINOR__ == 9 && __UCLIBC_SUBLEVEL__ >= 30)
 131         } else if (ether_hostton(hostid, eaddr) == 0) {
 132                 bb_debug_msg("Station address for hostname %s is %s\n\n", hostid, ether_ntoa(eaddr));
 133 #endif
 134         } else {
 135                 bb_show_usage();
 136         }
 137 }
 138
 139 static int get_fill(unsigned char *pkt, struct ether_addr *eaddr, int broadcast)
 140 {
 141         int i;
 142         unsigned char *station_addr = eaddr->ether_addr_octet;
 143
 144         memset(pkt, 0xff, 6);
 145         if (!broadcast)
 146                 memcpy(pkt, station_addr, 6);
 147         pkt += 6;
 148
 149         memcpy(pkt, station_addr, 6); /* 6 */
 150         pkt += 6;
 151
 152         *pkt++ = 0x08; /* 12 */ /* Or 0x0806 for ARP, 0x8035 for RARP */
 153         *pkt++ = 0x42; /* 13 */
 154
 155         memset(pkt, 0xff, 6); /* 14 */
 156
 157         for (i = 0; i < 16; ++i) {
 158                 pkt += 6;
 159                 memcpy(pkt, station_addr, 6); /* 20,26,32,... */
 160         }
 161
 162         return 20 + 16*6; /* length of packet */
 163 }
 164
 165 static int get_wol_pw(const char *ethoptarg, unsigned char *wol_passwd)
 166 {
 167         unsigned passwd[6];
 168         int byte_cnt, i;
 169
 170         /* handle MAC format */
 171         byte_cnt = sscanf(ethoptarg, "%2x:%2x:%2x:%2x:%2x:%2x",
 172                           &passwd[0], &passwd[1], &passwd[2],
 173                           &passwd[3], &passwd[4], &passwd[5]);
 174         /* handle IP format */
 175 // FIXME: why < 4?? should it be < 6?
 176         if (byte_cnt < 4)
 177                 byte_cnt = sscanf(ethoptarg, "%u.%u.%u.%u",
 178                                   &passwd[0], &passwd[1], &passwd[2], &passwd[3]);
 179         if (byte_cnt < 4) {
 180                 bb_error_msg("can't read Wake-On-LAN pass");
 181                 return 0;
 182         }
 183 // TODO: check invalid numbers >255??
 184         for (i = 0; i < byte_cnt; ++i)
 185                 wol_passwd[i] = passwd[i];
 186
 187         bb_debug_msg("password: %2.2x %2.2x %2.2x %2.2x (%d)\n\n",
 188                      wol_passwd[0], wol_passwd[1], wol_passwd[2], wol_passwd[3],
 189                      byte_cnt);
 190
 191         return byte_cnt;
 192 }
 193
 194 int ether_wake_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 195 int ether_wake_main(int argc UNUSED_PARAM, char **argv)
 196 {
 197         const char *ifname = "eth0";
 198         char *pass;
 199         unsigned flags;
 200         unsigned char wol_passwd[6];
 201         int wol_passwd_sz = 0;
 202         int s;  /* Raw socket */
 203         int pktsize;
 204         unsigned char outpack[1000];
 205
 206         struct ether_addr eaddr;
 207         struct whereto_t whereto;  /* who to wake up */
 208
 209         /* handle misc user options */
 210         opt_complementary = "=1";
 211         flags = getopt32(argv, "bi:p:", &ifname, &pass);
 212         if (flags & 4) /* -p */
 213                 wol_passwd_sz = get_wol_pw(pass, wol_passwd);
 214         flags &= 1; /* we further interested only in -b [bcast] flag */
 215
 216         /* create the raw socket */
 217         s = make_socket();
 218
 219         /* now that we have a raw socket we can drop root */
 220         /* xsetuid(getuid()); - but save on code size... */
 221
 222         /* look up the dest mac address */
 223         get_dest_addr(argv[optind], &eaddr);
 224
 225         /* fill out the header of the packet */
 226         pktsize = get_fill(outpack, &eaddr, flags /* & 1 OPT_BROADCAST */);
 227
 228         bb_debug_dump_packet(outpack, pktsize);
 229
 230         /* Fill in the source address, if possible. */
 231 #ifdef __linux__
 232         {
 233                 struct ifreq if_hwaddr;
 234
 235                 strncpy_IFNAMSIZ(if_hwaddr.ifr_name, ifname);
 236                 ioctl_or_perror_and_die(s, SIOCGIFHWADDR, &if_hwaddr, "SIOCGIFHWADDR on %s failed", ifname);
 237
 238                 memcpy(outpack+6, if_hwaddr.ifr_hwaddr.sa_data, 6);
 239
 240 # ifdef DEBUG
 241                 {
 242                         unsigned char *hwaddr = if_hwaddr.ifr_hwaddr.sa_data;
 243                         printf("The hardware address (SIOCGIFHWADDR) of %s is type %d  "
 244                                    "%2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x\n\n", ifname,
 245                                    if_hwaddr.ifr_hwaddr.sa_family, hwaddr[0], hwaddr[1],
 246                                    hwaddr[2], hwaddr[3], hwaddr[4], hwaddr[5]);
 247                 }
 248 # endif
 249         }
 250 #endif /* __linux__ */
 251
 252         bb_debug_dump_packet(outpack, pktsize);
 253
 254         /* append the password if specified */
 255         if (wol_passwd_sz > 0) {
 256                 memcpy(outpack+pktsize, wol_passwd, wol_passwd_sz);
 257                 pktsize += wol_passwd_sz;
 258         }
 259
 260         bb_debug_dump_packet(outpack, pktsize);
 261
 262         /* This is necessary for broadcasts to work */
 263         if (flags /* & 1 OPT_BROADCAST */) {
 264                 if (setsockopt_broadcast(s) != 0)
 265                         bb_perror_msg("SO_BROADCAST");
 266         }
 267
 268 #if defined(PF_PACKET)
 269         {
 270                 struct ifreq ifr;
 271                 strncpy_IFNAMSIZ(ifr.ifr_name, ifname);
 272                 xioctl(s, SIOCGIFINDEX, &ifr);
 273                 memset(&whereto, 0, sizeof(whereto));
 274                 whereto.sll_family = AF_PACKET;
 275                 whereto.sll_ifindex = ifr.ifr_ifindex;
 276                 /* The manual page incorrectly claims the address must be filled.
 277                    We do so because the code may change to match the docs. */
 278                 whereto.sll_halen = ETH_ALEN;
 279                 memcpy(whereto.sll_addr, outpack, ETH_ALEN);
 280         }
 281 #else
 282         whereto.sa_family = 0;
 283         strcpy(whereto.sa_data, ifname);
 284 #endif
 285         xsendto(s, outpack, pktsize, (struct sockaddr *)&whereto, sizeof(whereto));
 286         if (ENABLE_FEATURE_CLEAN_UP)
 287                 close(s);
 288         return EXIT_SUCCESS;
 289 }