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 tarball for details.
   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
  68 #include <unistd.h>
  69 #include <stdlib.h>
  70 #include <stdio.h>
  71 #include <errno.h>
  72 #include <ctype.h>
  73 #include <string.h>
  74
  75 #include <sys/socket.h>
  76 #include <sys/types.h>
  77 #include <sys/ioctl.h>
  78 #include <features.h>
  79 #include <netpacket/packet.h>
  80 #include <net/ethernet.h>
  81 #include <netdb.h>
  82 #include <netinet/ether.h>
  83
  84 #ifdef __linux__
  85 #include <linux/if.h>
  86 #endif
  87
  88 #include "busybox.h"
  89
  90 /* Note: PF_INET, SOCK_DGRAM, IPPROTO_UDP would allow SIOCGIFHWADDR to
  91  * work as non-root, but we need SOCK_PACKET to specify the Ethernet
  92  * destination address.
  93  */
  94 #ifdef PF_PACKET
  95 # define whereto_t sockaddr_ll
  96 # define make_socket() bb_xsocket(PF_PACKET, SOCK_RAW, 0)
  97 #else
  98 # define whereto_t sockaddr
  99 # define make_socket() bb_xsocket(AF_INET, SOCK_PACKET, SOCK_PACKET)
 100 #endif
 101
 102 #ifdef DEBUG
 103 # define bb_debug_msg(fmt, args...) fprintf(stderr, fmt, ## args)
 104 void bb_debug_dump_packet(unsigned char *outpack, int pktsize)
 105 {
 106         int i;
 107         printf("packet dump:\n");
 108         for (i = 0; i < pktsize; ++i) {
 109                 printf("%2.2x ", outpack[i]);
 110                 if (i % 20 == 19) printf("\n");
 111         }
 112         printf("\n\n");
 113 }
 114 #else
 115 # define bb_debug_msg(fmt, args...)
 116 # define bb_debug_dump_packet(outpack, pktsize)
 117 #endif
 118
 119 static inline void get_dest_addr(const char *arg, struct ether_addr *eaddr);
 120 static inline int get_fill(unsigned char *pkt, struct ether_addr *eaddr, int broadcast);
 121 static inline int get_wol_pw(const char *ethoptarg, unsigned char *wol_passwd);
 122
 123 int etherwake_main(int argc, char *argv[])
 124 {
 125         char *ifname = "eth0", *pass = NULL;
 126         unsigned long flags;
 127         unsigned char wol_passwd[6];
 128         int wol_passwd_sz = 0;
 129
 130         int s;                                          /* Raw socket */
 131         int pktsize;
 132         unsigned char outpack[1000];
 133
 134         struct ether_addr eaddr;
 135         struct whereto_t whereto;       /* who to wake up */
 136
 137         /* handle misc user options */
 138         flags = bb_getopt_ulflags(argc, argv, "bi:p:", &ifname, &pass);
 139         if (optind == argc)
 140                 bb_show_usage();
 141         if (pass)
 142                 wol_passwd_sz = get_wol_pw(pass, wol_passwd);
 143
 144         /* create the raw socket */
 145         s = make_socket();
 146
 147         /* now that we have a raw socket we can drop root */
 148         xsetuid(getuid());
 149
 150         /* look up the dest mac address */
 151         get_dest_addr(argv[optind], &eaddr);
 152
 153         /* fill out the header of the packet */
 154         pktsize = get_fill(outpack, &eaddr, flags /*& 1 [OPT_BROADCAST]*/);
 155
 156         bb_debug_dump_packet(outpack, pktsize);
 157
 158         /* Fill in the source address, if possible. */
 159 #ifdef __linux__
 160         {
 161                 struct ifreq if_hwaddr;
 162
 163                 strcpy(if_hwaddr.ifr_name, ifname);
 164                 if (ioctl(s, SIOCGIFHWADDR, &if_hwaddr) < 0)
 165                         bb_perror_msg_and_die("SIOCGIFHWADDR on %s failed", ifname);
 166
 167                 memcpy(outpack+6, if_hwaddr.ifr_hwaddr.sa_data, 6);
 168
 169 # ifdef DEBUG
 170                 {
 171                         unsigned char *hwaddr = if_hwaddr.ifr_hwaddr.sa_data;
 172                         printf("The hardware address (SIOCGIFHWADDR) of %s is type %d  "
 173                                    "%2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x\n\n", ifname,
 174                                    if_hwaddr.ifr_hwaddr.sa_family, hwaddr[0], hwaddr[1],
 175                                    hwaddr[2], hwaddr[3], hwaddr[4], hwaddr[5]);
 176                 }
 177 # endif
 178         }
 179 #endif /* __linux__ */
 180
 181         bb_debug_dump_packet(outpack, pktsize);
 182
 183         /* append the password if specified */
 184         if (wol_passwd_sz > 0) {
 185                 memcpy(outpack+pktsize, wol_passwd, wol_passwd_sz);
 186                 pktsize += wol_passwd_sz;
 187         }
 188
 189         bb_debug_dump_packet(outpack, pktsize);
 190
 191         /* This is necessary for broadcasts to work */
 192         if (flags /*& 1 [OPT_BROADCAST]*/) {
 193                 int one = 1;
 194                 if (setsockopt(s, SOL_SOCKET, SO_BROADCAST, (void *)&one, sizeof(one)) < 0)
 195                         bb_perror_msg("SO_BROADCAST");
 196         }
 197
 198 #if defined(PF_PACKET)
 199         {
 200                 struct ifreq ifr;
 201                 strncpy(ifr.ifr_name, ifname, sizeof(ifr.ifr_name));
 202                 if (ioctl(s, SIOCGIFINDEX, &ifr) == -1)
 203                         bb_perror_msg_and_die("SIOCGIFINDEX");
 204                 memset(&whereto, 0, sizeof(whereto));
 205                 whereto.sll_family = AF_PACKET;
 206                 whereto.sll_ifindex = ifr.ifr_ifindex;
 207                 /* The manual page incorrectly claims the address must be filled.
 208                    We do so because the code may change to match the docs. */
 209                 whereto.sll_halen = ETH_ALEN;
 210                 memcpy(whereto.sll_addr, outpack, ETH_ALEN);
 211         }
 212 #else
 213         whereto.sa_family = 0;
 214         strcpy(whereto.sa_data, ifname);
 215 #endif
 216
 217         if (sendto(s, outpack, pktsize, 0, (struct sockaddr *)&whereto, sizeof(whereto)) < 0)
 218                 bb_perror_msg(bb_msg_write_error);
 219
 220         close(s);
 221
 222         return EXIT_SUCCESS;
 223 }
 224
 225 /* Convert the host ID string to a MAC address.
 226  * The string may be a:
 227  *    Host name
 228  *    IP address string
 229  *    MAC address string
 230 */
 231 static inline void get_dest_addr(const char *hostid, struct ether_addr *eaddr)
 232 {
 233         struct ether_addr *eap;
 234
 235         eap = ether_aton(hostid);
 236         if (eap) {
 237                 *eaddr = *eap;
 238                 bb_debug_msg("The target station address is %s\n\n", ether_ntoa(eaddr));
 239 #if !defined(__UCLIBC__)
 240         } else if (ether_hostton(hostid, eaddr) == 0) {
 241                 bb_debug_msg("Station address for hostname %s is %s\n\n", hostid, ether_ntoa(eaddr));
 242 #else
 243 # warning Need to implement ether_hostton() for uClibc
 244 #endif
 245         } else
 246                 bb_show_usage();
 247 }
 248
 249 static inline int get_fill(unsigned char *pkt, struct ether_addr *eaddr, int broadcast)
 250 {
 251         int offset, i;
 252         unsigned char *station_addr = eaddr->ether_addr_octet;
 253
 254         if (broadcast)
 255                 memset(pkt+0, 0xff, 6);
 256         else
 257                 memcpy(pkt, station_addr, 6);
 258         memcpy(pkt+6, station_addr, 6);
 259         pkt[12] = 0x08;                         /* Or 0x0806 for ARP, 0x8035 for RARP */
 260         pkt[13] = 0x42;
 261         offset = 14;
 262
 263         memset(pkt+offset, 0xff, 6);
 264         offset += 6;
 265
 266         for (i = 0; i < 16; ++i) {
 267                 memcpy(pkt+offset, station_addr, 6);
 268                 offset += 6;
 269         }
 270
 271         return offset;
 272 }
 273
 274 static inline int get_wol_pw(const char *ethoptarg, unsigned char *wol_passwd)
 275 {
 276         int passwd[6];
 277         int byte_cnt, i;
 278
 279         /* handle MAC format */
 280         byte_cnt = sscanf(ethoptarg, "%2x:%2x:%2x:%2x:%2x:%2x",
 281                           &passwd[0], &passwd[1], &passwd[2],
 282                           &passwd[3], &passwd[4], &passwd[5]);
 283         /* handle IP format */
 284         if (byte_cnt < 4)
 285                 byte_cnt = sscanf(ethoptarg, "%d.%d.%d.%d",
 286                                   &passwd[0], &passwd[1], &passwd[2], &passwd[3]);
 287         if (byte_cnt < 4) {
 288                 bb_error_msg("Unable to read the Wake-On-LAN pass");
 289                 return 0;
 290         }
 291
 292         for (i = 0; i < byte_cnt; ++i)
 293                 wol_passwd[i] = passwd[i];
 294
 295         bb_debug_msg("password: %2.2x %2.2x %2.2x %2.2x (%d)\n\n",
 296                      wol_passwd[0], wol_passwd[1], wol_passwd[2], wol_passwd[3],
 297                      byte_cnt);
 298
 299         return byte_cnt;
 300 }