networking/udhcp/dhcpc.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * udhcp client
   4  *
   5  * Russ Dill <Russ.Dill@asu.edu> July 2001
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  */
  21 #include <syslog.h>
  22 /* Override ENABLE_FEATURE_PIDFILE - ifupdown needs our pidfile to always exist */
  23 #define WANT_PIDFILE 1
  24 #include "common.h"
  25 #include "dhcpd.h"
  26 #include "dhcpc.h"
  27
  28 #include <netinet/if_ether.h>
  29 #include <netpacket/packet.h>
  30 #include <linux/filter.h>
  31
  32 /* struct client_config_t client_config is in bb_common_bufsiz1 */
  33
  34
  35 #if ENABLE_LONG_OPTS
  36 static const char udhcpc_longopts[] ALIGN1 =
  37         "clientid-none\0"  No_argument       "C"
  38         "vendorclass\0"    Required_argument "V"
  39         "hostname\0"       Required_argument "H"
  40         "fqdn\0"           Required_argument "F"
  41         "interface\0"      Required_argument "i"
  42         "now\0"            No_argument       "n"
  43         "pidfile\0"        Required_argument "p"
  44         "quit\0"           No_argument       "q"
  45         "release\0"        No_argument       "R"
  46         "request\0"        Required_argument "r"
  47         "script\0"         Required_argument "s"
  48         "timeout\0"        Required_argument "T"
  49         "version\0"        No_argument       "v"
  50         "retries\0"        Required_argument "t"
  51         "tryagain\0"       Required_argument "A"
  52         "syslog\0"         No_argument       "S"
  53         "request-option\0" Required_argument "O"
  54         "no-default-options\0" No_argument   "o"
  55         "foreground\0"     No_argument       "f"
  56         "background\0"     No_argument       "b"
  57         "broadcast\0"      No_argument       "B"
  58         IF_FEATURE_UDHCPC_ARPING("arping\0"     No_argument       "a")
  59         IF_FEATURE_UDHCP_PORT("client-port\0"   Required_argument "P")
  60         ;
  61 #endif
  62 /* Must match getopt32 option string order */
  63 enum {
  64         OPT_C = 1 << 0,
  65         OPT_V = 1 << 1,
  66         OPT_H = 1 << 2,
  67         OPT_h = 1 << 3,
  68         OPT_F = 1 << 4,
  69         OPT_i = 1 << 5,
  70         OPT_n = 1 << 6,
  71         OPT_p = 1 << 7,
  72         OPT_q = 1 << 8,
  73         OPT_R = 1 << 9,
  74         OPT_r = 1 << 10,
  75         OPT_s = 1 << 11,
  76         OPT_T = 1 << 12,
  77         OPT_t = 1 << 13,
  78         OPT_S = 1 << 14,
  79         OPT_A = 1 << 15,
  80         OPT_O = 1 << 16,
  81         OPT_o = 1 << 17,
  82         OPT_x = 1 << 18,
  83         OPT_f = 1 << 19,
  84         OPT_B = 1 << 20,
  85 /* The rest has variable bit positions, need to be clever */
  86         OPTBIT_B = 20,
  87         USE_FOR_MMU(             OPTBIT_b,)
  88         IF_FEATURE_UDHCPC_ARPING(OPTBIT_a,)
  89         IF_FEATURE_UDHCP_PORT(   OPTBIT_P,)
  90         USE_FOR_MMU(             OPT_b = 1 << OPTBIT_b,)
  91         IF_FEATURE_UDHCPC_ARPING(OPT_a = 1 << OPTBIT_a,)
  92         IF_FEATURE_UDHCP_PORT(   OPT_P = 1 << OPTBIT_P,)
  93 };
  94
  95
  96 /*** Script execution code ***/
  97
  98 /* get a rough idea of how long an option will be (rounding up...) */
  99 static const uint8_t len_of_option_as_string[] = {
 100         [OPTION_IP              ] = sizeof("255.255.255.255 "),
 101         [OPTION_IP_PAIR         ] = sizeof("255.255.255.255 ") * 2,
 102         [OPTION_STATIC_ROUTES   ] = sizeof("255.255.255.255/32 255.255.255.255 "),
 103         [OPTION_6RD             ] = sizeof("32 128 ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff 255.255.255.255 "),
 104         [OPTION_STRING          ] = 1,
 105 #if ENABLE_FEATURE_UDHCP_RFC3397
 106         [OPTION_DNS_STRING      ] = 1, /* unused */
 107         /* Hmmm, this severely overestimates size if SIP_SERVERS option
 108          * is in domain name form: N-byte option in binary form
 109          * mallocs ~16*N bytes. But it is freed almost at once.
 110          */
 111         [OPTION_SIP_SERVERS     ] = sizeof("255.255.255.255 "),
 112 #endif
 113 //      [OPTION_BOOLEAN         ] = sizeof("yes "),
 114         [OPTION_U8              ] = sizeof("255 "),
 115         [OPTION_U16             ] = sizeof("65535 "),
 116 //      [OPTION_S16             ] = sizeof("-32768 "),
 117         [OPTION_U32             ] = sizeof("4294967295 "),
 118         [OPTION_S32             ] = sizeof("-2147483684 "),
 119 };
 120
 121 /* note: ip is a pointer to an IP in network order, possibly misaliged */
 122 static int sprint_nip(char *dest, const char *pre, const uint8_t *ip)
 123 {
 124         return sprintf(dest, "%s%u.%u.%u.%u", pre, ip[0], ip[1], ip[2], ip[3]);
 125 }
 126
 127 static int sprint_nip6(char *dest, /*const char *pre,*/ const uint8_t *ip)
 128 {
 129         char hexstrbuf[16 * 2];
 130         bin2hex(hexstrbuf, (void*)ip, 16);
 131         return sprintf(dest, /* "%s" */
 132                 "%.4s:%.4s:%.4s:%.4s:%.4s:%.4s:%.4s:%.4s",
 133                 /* pre, */
 134                 hexstrbuf + 0 * 4,
 135                 hexstrbuf + 1 * 4,
 136                 hexstrbuf + 2 * 4,
 137                 hexstrbuf + 3 * 4,
 138                 hexstrbuf + 4 * 4,
 139                 hexstrbuf + 5 * 4,
 140                 hexstrbuf + 6 * 4,
 141                 hexstrbuf + 7 * 4
 142         );
 143 }
 144
 145 /* really simple implementation, just count the bits */
 146 static int mton(uint32_t mask)
 147 {
 148         int i = 0;
 149         mask = ntohl(mask); /* 111110000-like bit pattern */
 150         while (mask) {
 151                 i++;
 152                 mask <<= 1;
 153         }
 154         return i;
 155 }
 156
 157 /* Create "opt_name=opt_value" string */
 158 static NOINLINE char *xmalloc_optname_optval(uint8_t *option, const struct dhcp_optflag *optflag, const char *opt_name)
 159 {
 160         unsigned upper_length;
 161         int len, type, optlen;
 162         char *dest, *ret;
 163
 164         /* option points to OPT_DATA, need to go back to get OPT_LEN */
 165         len = option[-OPT_DATA + OPT_LEN];
 166
 167         type = optflag->flags & OPTION_TYPE_MASK;
 168         optlen = dhcp_option_lengths[type];
 169         upper_length = len_of_option_as_string[type]
 170                 * ((unsigned)(len + optlen - 1) / (unsigned)optlen);
 171
 172         dest = ret = xmalloc(upper_length + strlen(opt_name) + 2);
 173         dest += sprintf(ret, "%s=", opt_name);
 174
 175         while (len >= optlen) {
 176                 switch (type) {
 177                 case OPTION_IP:
 178                 case OPTION_IP_PAIR:
 179                         dest += sprint_nip(dest, "", option);
 180                         if (type == OPTION_IP)
 181                                 break;
 182                         dest += sprint_nip(dest, "/", option + 4);
 183                         break;
 184 //              case OPTION_BOOLEAN:
 185 //                      dest += sprintf(dest, *option ? "yes" : "no");
 186 //                      break;
 187                 case OPTION_U8:
 188                         dest += sprintf(dest, "%u", *option);
 189                         break;
 190 //              case OPTION_S16:
 191                 case OPTION_U16: {
 192                         uint16_t val_u16;
 193                         move_from_unaligned16(val_u16, option);
 194                         dest += sprintf(dest, "%u", ntohs(val_u16));
 195                         break;
 196                 }
 197                 case OPTION_S32:
 198                 case OPTION_U32: {
 199                         uint32_t val_u32;
 200                         move_from_unaligned32(val_u32, option);
 201                         dest += sprintf(dest, type == OPTION_U32 ? "%lu" : "%ld", (unsigned long) ntohl(val_u32));
 202                         break;
 203                 }
 204                 /* Note: options which use 'return' instead of 'break'
 205                  * (for example, OPTION_STRING) skip the code which handles
 206                  * the case of list of options.
 207                  */
 208                 case OPTION_STRING:
 209                         memcpy(dest, option, len);
 210                         dest[len] = '\0';
 211                         return ret;
 212                 case OPTION_STATIC_ROUTES: {
 213                         /* Option binary format:
 214                          * mask [one byte, 0..32]
 215                          * ip [big endian, 0..4 bytes depending on mask]
 216                          * router [big endian, 4 bytes]
 217                          * may be repeated
 218                          *
 219                          * We convert it to a string "IP/MASK ROUTER IP2/MASK2 ROUTER2"
 220                          */
 221                         const char *pfx = "";
 222
 223                         while (len >= 1 + 4) { /* mask + 0-byte ip + router */
 224                                 uint32_t nip;
 225                                 uint8_t *p;
 226                                 unsigned mask;
 227                                 int bytes;
 228
 229                                 mask = *option++;
 230                                 if (mask > 32)
 231                                         break;
 232                                 len--;
 233
 234                                 nip = 0;
 235                                 p = (void*) &nip;
 236                                 bytes = (mask + 7) / 8; /* 0 -> 0, 1..8 -> 1, 9..16 -> 2 etc */
 237                                 while (--bytes >= 0) {
 238                                         *p++ = *option++;
 239                                         len--;
 240                                 }
 241                                 if (len < 4)
 242                                         break;
 243
 244                                 /* print ip/mask */
 245                                 dest += sprint_nip(dest, pfx, (void*) &nip);
 246                                 pfx = " ";
 247                                 dest += sprintf(dest, "/%u ", mask);
 248                                 /* print router */
 249                                 dest += sprint_nip(dest, "", option);
 250                                 option += 4;
 251                                 len -= 4;
 252                         }
 253
 254                         return ret;
 255                 }
 256                 case OPTION_6RD:
 257                         /* Option binary format (see RFC 5969):
 258                          *  0                   1                   2                   3
 259                          *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 260                          * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 261                          * |  OPTION_6RD   | option-length |  IPv4MaskLen  |  6rdPrefixLen |
 262                          * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 263                          * |                           6rdPrefix                           |
 264                          * ...                        (16 octets)                        ...
 265                          * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 266                          * ...                   6rdBRIPv4Address(es)                    ...
 267                          * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 268                          * We convert it to a string
 269                          * "IPv4MaskLen 6rdPrefixLen 6rdPrefix 6rdBRIPv4Address..."
 270                          *
 271                          * Sanity check: ensure that our length is at least 22 bytes, that
 272                          * IPv4MaskLen <= 32,
 273                          * 6rdPrefixLen <= 128,
 274                          * 6rdPrefixLen + (32 - IPv4MaskLen) <= 128
 275                          * (2nd condition need no check - it follows from 1st and 3rd).
 276                          * Else, return envvar with empty value ("optname=")
 277                          */
 278                         if (len >= (1 + 1 + 16 + 4)
 279                          && option[0] <= 32
 280                          && (option[1] + 32 - option[0]) <= 128
 281                         ) {
 282                                 /* IPv4MaskLen */
 283                                 dest += sprintf(dest, "%u ", *option++);
 284                                 /* 6rdPrefixLen */
 285                                 dest += sprintf(dest, "%u ", *option++);
 286                                 /* 6rdPrefix */
 287                                 dest += sprint_nip6(dest, /* "", */ option);
 288                                 option += 16;
 289                                 len -= 1 + 1 + 16 + 4;
 290                                 /* "+ 4" above corresponds to the length of IPv4 addr
 291                                  * we consume in the loop below */
 292                                 while (1) {
 293                                         /* 6rdBRIPv4Address(es) */
 294                                         dest += sprint_nip(dest, " ", option);
 295                                         option += 4;
 296                                         len -= 4; /* do we have yet another 4+ bytes? */
 297                                         if (len < 0)
 298                                                 break; /* no */
 299                                 }
 300                         }
 301
 302                         return ret;
 303 #if ENABLE_FEATURE_UDHCP_RFC3397
 304                 case OPTION_DNS_STRING:
 305                         /* unpack option into dest; use ret for prefix (i.e., "optname=") */
 306                         dest = dname_dec(option, len, ret);
 307                         if (dest) {
 308                                 free(ret);
 309                                 return dest;
 310                         }
 311                         /* error. return "optname=" string */
 312                         return ret;
 313                 case OPTION_SIP_SERVERS:
 314                         /* Option binary format:
 315                          * type: byte
 316                          * type=0: domain names, dns-compressed
 317                          * type=1: IP addrs
 318                          */
 319                         option++;
 320                         len--;
 321                         if (option[-1] == 0) {
 322                                 dest = dname_dec(option, len, ret);
 323                                 if (dest) {
 324                                         free(ret);
 325                                         return dest;
 326                                 }
 327                         } else
 328                         if (option[-1] == 1) {
 329                                 const char *pfx = "";
 330                                 while (1) {
 331                                         len -= 4;
 332                                         if (len < 0)
 333                                                 break;
 334                                         dest += sprint_nip(dest, pfx, option);
 335                                         pfx = " ";
 336                                         option += 4;
 337                                 }
 338                         }
 339                         return ret;
 340 #endif
 341                 } /* switch */
 342
 343                 /* If we are here, try to format any remaining data
 344                  * in the option as another, similarly-formatted option
 345                  */
 346                 option += optlen;
 347                 len -= optlen;
 348 // TODO: it can be a list only if (optflag->flags & OPTION_LIST).
 349 // Should we bail out/warn if we see multi-ip option which is
 350 // not allowed to be such (for example, DHCP_BROADCAST)? -
 351                 if (len < optlen /* || !(optflag->flags & OPTION_LIST) */)
 352                         break;
 353                 *dest++ = ' ';
 354                 *dest = '\0';
 355         } /* while */
 356
 357         return ret;
 358 }
 359
 360 /* put all the parameters into the environment */
 361 static char **fill_envp(struct dhcp_packet *packet)
 362 {
 363         int envc;
 364         int i;
 365         char **envp, **curr;
 366         const char *opt_name;
 367         uint8_t *temp;
 368         uint8_t overload = 0;
 369
 370 #define BITMAP unsigned
 371 #define BBITS (sizeof(BITMAP) * 8)
 372 #define BMASK(i) (1 << (i & (sizeof(BITMAP) * 8 - 1)))
 373 #define FOUND_OPTS(i) (found_opts[(unsigned)i / BBITS])
 374         BITMAP found_opts[256 / BBITS];
 375
 376         memset(found_opts, 0, sizeof(found_opts));
 377
 378         /* We need 6 elements for:
 379          * "interface=IFACE"
 380          * "ip=N.N.N.N" from packet->yiaddr
 381          * "siaddr=IP" from packet->siaddr_nip (unless 0)
 382          * "boot_file=FILE" from packet->file (unless overloaded)
 383          * "sname=SERVER_HOSTNAME" from packet->sname (unless overloaded)
 384          * terminating NULL
 385          */
 386         envc = 6;
 387         /* +1 element for each option, +2 for subnet option: */
 388         if (packet) {
 389                 /* note: do not search for "pad" (0) and "end" (255) options */
 390                 for (i = 1; i < 255; i++) {
 391                         temp = udhcp_get_option(packet, i);
 392                         if (temp) {
 393                                 if (i == DHCP_OPTION_OVERLOAD)
 394                                         overload = *temp;
 395                                 else if (i == DHCP_SUBNET)
 396                                         envc++; /* for $mask */
 397                                 envc++;
 398                                 /*if (i != DHCP_MESSAGE_TYPE)*/
 399                                 FOUND_OPTS(i) |= BMASK(i);
 400                         }
 401                 }
 402         }
 403         curr = envp = xzalloc(sizeof(envp[0]) * envc);
 404
 405         *curr = xasprintf("interface=%s", client_config.interface);
 406         putenv(*curr++);
 407
 408         if (!packet)
 409                 return envp;
 410
 411         /* Export BOOTP fields. Fields we don't (yet?) export:
 412          * uint8_t op;      // always BOOTREPLY
 413          * uint8_t htype;   // hardware address type. 1 = 10mb ethernet
 414          * uint8_t hlen;    // hardware address length
 415          * uint8_t hops;    // used by relay agents only
 416          * uint32_t xid;
 417          * uint16_t secs;   // elapsed since client began acquisition/renewal
 418          * uint16_t flags;  // only one flag so far: bcast. Never set by server
 419          * uint32_t ciaddr; // client IP (usually == yiaddr. can it be different
 420          *                  // if during renew server wants to give us differn IP?)
 421          * uint32_t gateway_nip; // relay agent IP address
 422          * uint8_t chaddr[16]; // link-layer client hardware address (MAC)
 423          * TODO: export gateway_nip as $giaddr?
 424          */
 425         /* Most important one: yiaddr as $ip */
 426         *curr = xmalloc(sizeof("ip=255.255.255.255"));
 427         sprint_nip(*curr, "ip=", (uint8_t *) &packet->yiaddr);
 428         putenv(*curr++);
 429         if (packet->siaddr_nip) {
 430                 /* IP address of next server to use in bootstrap */
 431                 *curr = xmalloc(sizeof("siaddr=255.255.255.255"));
 432                 sprint_nip(*curr, "siaddr=", (uint8_t *) &packet->siaddr_nip);
 433                 putenv(*curr++);
 434         }
 435         if (!(overload & FILE_FIELD) && packet->file[0]) {
 436                 /* watch out for invalid packets */
 437                 *curr = xasprintf("boot_file=%."DHCP_PKT_FILE_LEN_STR"s", packet->file);
 438                 putenv(*curr++);
 439         }
 440         if (!(overload & SNAME_FIELD) && packet->sname[0]) {
 441                 /* watch out for invalid packets */
 442                 *curr = xasprintf("sname=%."DHCP_PKT_SNAME_LEN_STR"s", packet->sname);
 443                 putenv(*curr++);
 444         }
 445
 446         /* Export known DHCP options */
 447         opt_name = dhcp_option_strings;
 448         i = 0;
 449         while (*opt_name) {
 450                 uint8_t code = dhcp_optflags[i].code;
 451                 BITMAP *found_ptr = &FOUND_OPTS(code);
 452                 BITMAP found_mask = BMASK(code);
 453                 if (!(*found_ptr & found_mask))
 454                         goto next;
 455                 *found_ptr &= ~found_mask; /* leave only unknown options */
 456                 temp = udhcp_get_option(packet, code);
 457                 *curr = xmalloc_optname_optval(temp, &dhcp_optflags[i], opt_name);
 458                 putenv(*curr++);
 459                 if (code == DHCP_SUBNET) {
 460                         /* Subnet option: make things like "$ip/$mask" possible */
 461                         uint32_t subnet;
 462                         move_from_unaligned32(subnet, temp);
 463                         *curr = xasprintf("mask=%u", mton(subnet));
 464                         putenv(*curr++);
 465                 }
 466  next:
 467                 opt_name += strlen(opt_name) + 1;
 468                 i++;
 469         }
 470         /* Export unknown options */
 471         for (i = 0; i < 256;) {
 472                 BITMAP bitmap = FOUND_OPTS(i);
 473                 if (!bitmap) {
 474                         i += BBITS;
 475                         continue;
 476                 }
 477                 if (bitmap & BMASK(i)) {
 478                         unsigned len, ofs;
 479
 480                         temp = udhcp_get_option(packet, i);
 481                         /* udhcp_get_option returns ptr to data portion,
 482                          * need to go back to get len
 483                          */
 484                         len = temp[-OPT_DATA + OPT_LEN];
 485                         *curr = xmalloc(sizeof("optNNN=") + 1 + len*2);
 486                         ofs = sprintf(*curr, "opt%u=", i);
 487                         *bin2hex(*curr + ofs, (void*) temp, len) = '\0';
 488                         putenv(*curr++);
 489                 }
 490                 i++;
 491         }
 492
 493         return envp;
 494 }
 495
 496 /* Call a script with a par file and env vars */
 497 static void udhcp_run_script(struct dhcp_packet *packet, const char *name)
 498 {
 499         char **envp, **curr;
 500         char *argv[3];
 501
 502         if (client_config.script == NULL)
 503                 return;
 504
 505         envp = fill_envp(packet);
 506
 507         /* call script */
 508         log1("Executing %s %s", client_config.script, name);
 509         argv[0] = (char*) client_config.script;
 510         argv[1] = (char*) name;
 511         argv[2] = NULL;
 512         spawn_and_wait(argv);
 513
 514         for (curr = envp; *curr; curr++) {
 515                 log2(" %s", *curr);
 516                 bb_unsetenv_and_free(*curr);
 517         }
 518         free(envp);
 519 }
 520
 521
 522 /*** Sending/receiving packets ***/
 523
 524 static ALWAYS_INLINE uint32_t random_xid(void)
 525 {
 526         return rand();
 527 }
 528
 529 /* Initialize the packet with the proper defaults */
 530 static void init_packet(struct dhcp_packet *packet, char type)
 531 {
 532         uint16_t secs;
 533
 534         /* Fill in: op, htype, hlen, cookie fields; message type option: */
 535         udhcp_init_header(packet, type);
 536
 537         packet->xid = random_xid();
 538
 539         client_config.last_secs = monotonic_sec();
 540         if (client_config.first_secs == 0)
 541                 client_config.first_secs = client_config.last_secs;
 542         secs = client_config.last_secs - client_config.first_secs;
 543         packet->secs = htons(secs);
 544
 545         memcpy(packet->chaddr, client_config.client_mac, 6);
 546         if (client_config.clientid)
 547                 udhcp_add_binary_option(packet, client_config.clientid);
 548 }
 549
 550 static void add_client_options(struct dhcp_packet *packet)
 551 {
 552         uint8_t c;
 553         int i, end, len;
 554
 555         udhcp_add_simple_option(packet, DHCP_MAX_SIZE, htons(IP_UDP_DHCP_SIZE));
 556
 557         /* Add a "param req" option with the list of options we'd like to have
 558          * from stubborn DHCP servers. Pull the data from the struct in common.c.
 559          * No bounds checking because it goes towards the head of the packet. */
 560         end = udhcp_end_option(packet->options);
 561         len = 0;
 562         for (i = 0; (c = dhcp_optflags[i].code) != 0; i++) {
 563                 if ((   (dhcp_optflags[i].flags & OPTION_REQ)
 564                      && !client_config.no_default_options
 565                     )
 566                  || (client_config.opt_mask[c >> 3] & (1 << (c & 7)))
 567                 ) {
 568                         packet->options[end + OPT_DATA + len] = c;
 569                         len++;
 570                 }
 571         }
 572         if (len) {
 573                 packet->options[end + OPT_CODE] = DHCP_PARAM_REQ;
 574                 packet->options[end + OPT_LEN] = len;
 575                 packet->options[end + OPT_DATA + len] = DHCP_END;
 576         }
 577
 578         if (client_config.vendorclass)
 579                 udhcp_add_binary_option(packet, client_config.vendorclass);
 580         if (client_config.hostname)
 581                 udhcp_add_binary_option(packet, client_config.hostname);
 582         if (client_config.fqdn)
 583                 udhcp_add_binary_option(packet, client_config.fqdn);
 584
 585         /* Request broadcast replies if we have no IP addr */
 586         if ((option_mask32 & OPT_B) && packet->ciaddr == 0)
 587                 packet->flags |= htons(BROADCAST_FLAG);
 588
 589         /* Add -x options if any */
 590         {
 591                 struct option_set *curr = client_config.options;
 592                 while (curr) {
 593                         udhcp_add_binary_option(packet, curr->data);
 594                         curr = curr->next;
 595                 }
 596 //              if (client_config.sname)
 597 //                      strncpy((char*)packet->sname, client_config.sname, sizeof(packet->sname) - 1);
 598 //              if (client_config.boot_file)
 599 //                      strncpy((char*)packet->file, client_config.boot_file, sizeof(packet->file) - 1);
 600         }
 601 }
 602
 603 /* RFC 2131
 604  * 4.4.4 Use of broadcast and unicast
 605  *
 606  * The DHCP client broadcasts DHCPDISCOVER, DHCPREQUEST and DHCPINFORM
 607  * messages, unless the client knows the address of a DHCP server.
 608  * The client unicasts DHCPRELEASE messages to the server. Because
 609  * the client is declining the use of the IP address supplied by the server,
 610  * the client broadcasts DHCPDECLINE messages.
 611  *
 612  * When the DHCP client knows the address of a DHCP server, in either
 613  * INIT or REBOOTING state, the client may use that address
 614  * in the DHCPDISCOVER or DHCPREQUEST rather than the IP broadcast address.
 615  * The client may also use unicast to send DHCPINFORM messages
 616  * to a known DHCP server. If the client receives no response to DHCP
 617  * messages sent to the IP address of a known DHCP server, the DHCP
 618  * client reverts to using the IP broadcast address.
 619  */
 620
 621 static int raw_bcast_from_client_config_ifindex(struct dhcp_packet *packet)
 622 {
 623         return udhcp_send_raw_packet(packet,
 624                 /*src*/ INADDR_ANY, CLIENT_PORT,
 625                 /*dst*/ INADDR_BROADCAST, SERVER_PORT, MAC_BCAST_ADDR,
 626                 client_config.ifindex);
 627 }
 628
 629 /* Broadcast a DHCP discover packet to the network, with an optionally requested IP */
 630 /* NOINLINE: limit stack usage in caller */
 631 static NOINLINE int send_discover(uint32_t xid, uint32_t requested)
 632 {
 633         struct dhcp_packet packet;
 634
 635         /* Fill in: op, htype, hlen, cookie, chaddr fields,
 636          * random xid field (we override it below),
 637          * client-id option (unless -C), message type option:
 638          */
 639         init_packet(&packet, DHCPDISCOVER);
 640
 641         packet.xid = xid;
 642         if (requested)
 643                 udhcp_add_simple_option(&packet, DHCP_REQUESTED_IP, requested);
 644
 645         /* Add options: maxsize,
 646          * optionally: hostname, fqdn, vendorclass,
 647          * "param req" option according to -O, options specified with -x
 648          */
 649         add_client_options(&packet);
 650
 651         bb_info_msg("Sending discover...");
 652         return raw_bcast_from_client_config_ifindex(&packet);
 653 }
 654
 655 /* Broadcast a DHCP request message */
 656 /* RFC 2131 3.1 paragraph 3:
 657  * "The client _broadcasts_ a DHCPREQUEST message..."
 658  */
 659 /* NOINLINE: limit stack usage in caller */
 660 static NOINLINE int send_select(uint32_t xid, uint32_t server, uint32_t requested)
 661 {
 662         struct dhcp_packet packet;
 663         struct in_addr addr;
 664
 665 /*
 666  * RFC 2131 4.3.2 DHCPREQUEST message
 667  * ...
 668  * If the DHCPREQUEST message contains a 'server identifier'
 669  * option, the message is in response to a DHCPOFFER message.
 670  * Otherwise, the message is a request to verify or extend an
 671  * existing lease. If the client uses a 'client identifier'
 672  * in a DHCPREQUEST message, it MUST use that same 'client identifier'
 673  * in all subsequent messages. If the client included a list
 674  * of requested parameters in a DHCPDISCOVER message, it MUST
 675  * include that list in all subsequent messages.
 676  */
 677         /* Fill in: op, htype, hlen, cookie, chaddr fields,
 678          * random xid field (we override it below),
 679          * client-id option (unless -C), message type option:
 680          */
 681         init_packet(&packet, DHCPREQUEST);
 682
 683         packet.xid = xid;
 684         udhcp_add_simple_option(&packet, DHCP_REQUESTED_IP, requested);
 685
 686         udhcp_add_simple_option(&packet, DHCP_SERVER_ID, server);
 687
 688         /* Add options: maxsize,
 689          * optionally: hostname, fqdn, vendorclass,
 690          * "param req" option according to -O, and options specified with -x
 691          */
 692         add_client_options(&packet);
 693
 694         addr.s_addr = requested;
 695         bb_info_msg("Sending select for %s...", inet_ntoa(addr));
 696         return raw_bcast_from_client_config_ifindex(&packet);
 697 }
 698
 699 /* Unicast or broadcast a DHCP renew message */
 700 /* NOINLINE: limit stack usage in caller */
 701 static NOINLINE int send_renew(uint32_t xid, uint32_t server, uint32_t ciaddr)
 702 {
 703         struct dhcp_packet packet;
 704
 705 /*
 706  * RFC 2131 4.3.2 DHCPREQUEST message
 707  * ...
 708  * DHCPREQUEST generated during RENEWING state:
 709  *
 710  * 'server identifier' MUST NOT be filled in, 'requested IP address'
 711  * option MUST NOT be filled in, 'ciaddr' MUST be filled in with
 712  * client's IP address. In this situation, the client is completely
 713  * configured, and is trying to extend its lease. This message will
 714  * be unicast, so no relay agents will be involved in its
 715  * transmission.  Because 'giaddr' is therefore not filled in, the
 716  * DHCP server will trust the value in 'ciaddr', and use it when
 717  * replying to the client.
 718  */
 719         /* Fill in: op, htype, hlen, cookie, chaddr fields,
 720          * random xid field (we override it below),
 721          * client-id option (unless -C), message type option:
 722          */
 723         init_packet(&packet, DHCPREQUEST);
 724
 725         packet.xid = xid;
 726         packet.ciaddr = ciaddr;
 727
 728         /* Add options: maxsize,
 729          * optionally: hostname, fqdn, vendorclass,
 730          * "param req" option according to -O, and options specified with -x
 731          */
 732         add_client_options(&packet);
 733
 734         bb_info_msg("Sending renew...");
 735         if (server)
 736                 return udhcp_send_kernel_packet(&packet,
 737                         ciaddr, CLIENT_PORT,
 738                         server, SERVER_PORT);
 739         return raw_bcast_from_client_config_ifindex(&packet);
 740 }
 741
 742 #if ENABLE_FEATURE_UDHCPC_ARPING
 743 /* Broadcast a DHCP decline message */
 744 /* NOINLINE: limit stack usage in caller */
 745 static NOINLINE int send_decline(uint32_t xid, uint32_t server, uint32_t requested)
 746 {
 747         struct dhcp_packet packet;
 748
 749         /* Fill in: op, htype, hlen, cookie, chaddr, random xid fields,
 750          * client-id option (unless -C), message type option:
 751          */
 752         init_packet(&packet, DHCPDECLINE);
 753
 754         /* RFC 2131 says DHCPDECLINE's xid is randomly selected by client,
 755          * but in case the server is buggy and wants DHCPDECLINE's xid
 756          * to match the xid which started entire handshake,
 757          * we use the same xid we used in initial DHCPDISCOVER:
 758          */
 759         packet.xid = xid;
 760         /* DHCPDECLINE uses "requested ip", not ciaddr, to store offered IP */
 761         udhcp_add_simple_option(&packet, DHCP_REQUESTED_IP, requested);
 762
 763         udhcp_add_simple_option(&packet, DHCP_SERVER_ID, server);
 764
 765         bb_info_msg("Sending decline...");
 766         return raw_bcast_from_client_config_ifindex(&packet);
 767 }
 768 #endif
 769
 770 /* Unicast a DHCP release message */
 771 static int send_release(uint32_t server, uint32_t ciaddr)
 772 {
 773         struct dhcp_packet packet;
 774
 775         /* Fill in: op, htype, hlen, cookie, chaddr, random xid fields,
 776          * client-id option (unless -C), message type option:
 777          */
 778         init_packet(&packet, DHCPRELEASE);
 779
 780         /* DHCPRELEASE uses ciaddr, not "requested ip", to store IP being released */
 781         packet.ciaddr = ciaddr;
 782
 783         udhcp_add_simple_option(&packet, DHCP_SERVER_ID, server);
 784
 785         bb_info_msg("Sending release...");
 786         return udhcp_send_kernel_packet(&packet, ciaddr, CLIENT_PORT, server, SERVER_PORT);
 787 }
 788
 789 /* Returns -1 on errors that are fatal for the socket, -2 for those that aren't */
 790 /* NOINLINE: limit stack usage in caller */
 791 static NOINLINE int udhcp_recv_raw_packet(struct dhcp_packet *dhcp_pkt, int fd)
 792 {
 793         int bytes;
 794         struct ip_udp_dhcp_packet packet;
 795         uint16_t check;
 796
 797         memset(&packet, 0, sizeof(packet));
 798         bytes = safe_read(fd, &packet, sizeof(packet));
 799         if (bytes < 0) {
 800                 log1("Packet read error, ignoring");
 801                 /* NB: possible down interface, etc. Caller should pause. */
 802                 return bytes; /* returns -1 */
 803         }
 804
 805         if (bytes < (int) (sizeof(packet.ip) + sizeof(packet.udp))) {
 806                 log1("Packet is too short, ignoring");
 807                 return -2;
 808         }
 809
 810         if (bytes < ntohs(packet.ip.tot_len)) {
 811                 /* packet is bigger than sizeof(packet), we did partial read */
 812                 log1("Oversized packet, ignoring");
 813                 return -2;
 814         }
 815
 816         /* ignore any extra garbage bytes */
 817         bytes = ntohs(packet.ip.tot_len);
 818
 819         /* make sure its the right packet for us, and that it passes sanity checks */
 820         if (packet.ip.protocol != IPPROTO_UDP
 821          || packet.ip.version != IPVERSION
 822          || packet.ip.ihl != (sizeof(packet.ip) >> 2)
 823          || packet.udp.dest != htons(CLIENT_PORT)
 824         /* || bytes > (int) sizeof(packet) - can't happen */
 825          || ntohs(packet.udp.len) != (uint16_t)(bytes - sizeof(packet.ip))
 826         ) {
 827                 log1("Unrelated/bogus packet, ignoring");
 828                 return -2;
 829         }
 830
 831         /* verify IP checksum */
 832         check = packet.ip.check;
 833         packet.ip.check = 0;
 834         if (check != inet_cksum((uint16_t *)&packet.ip, sizeof(packet.ip))) {
 835                 log1("Bad IP header checksum, ignoring");
 836                 return -2;
 837         }
 838
 839         /* verify UDP checksum. IP header has to be modified for this */
 840         memset(&packet.ip, 0, offsetof(struct iphdr, protocol));
 841         /* ip.xx fields which are not memset: protocol, check, saddr, daddr */
 842         packet.ip.tot_len = packet.udp.len; /* yes, this is needed */
 843         check = packet.udp.check;
 844         packet.udp.check = 0;
 845         if (check && check != inet_cksum((uint16_t *)&packet, bytes)) {
 846                 log1("Packet with bad UDP checksum received, ignoring");
 847                 return -2;
 848         }
 849
 850         if (packet.data.cookie != htonl(DHCP_MAGIC)) {
 851                 bb_info_msg("Packet with bad magic, ignoring");
 852                 return -2;
 853         }
 854
 855         log1("Got valid DHCP packet");
 856         udhcp_dump_packet(&packet.data);
 857
 858         bytes -= sizeof(packet.ip) + sizeof(packet.udp);
 859         memcpy(dhcp_pkt, &packet.data, bytes);
 860         return bytes;
 861 }
 862
 863
 864 /*** Main ***/
 865
 866 static int sockfd = -1;
 867
 868 #define LISTEN_NONE   0
 869 #define LISTEN_KERNEL 1
 870 #define LISTEN_RAW    2
 871 static smallint listen_mode;
 872
 873 /* initial state: (re)start DHCP negotiation */
 874 #define INIT_SELECTING  0
 875 /* discover was sent, DHCPOFFER reply received */
 876 #define REQUESTING      1
 877 /* select/renew was sent, DHCPACK reply received */
 878 #define BOUND           2
 879 /* half of lease passed, want to renew it by sending unicast renew requests */
 880 #define RENEWING        3
 881 /* renew requests were not answered, lease is almost over, send broadcast renew */
 882 #define REBINDING       4
 883 /* manually requested renew (SIGUSR1) */
 884 #define RENEW_REQUESTED 5
 885 /* release, possibly manually requested (SIGUSR2) */
 886 #define RELEASED        6
 887 static smallint state;
 888
 889 static int udhcp_raw_socket(int ifindex)
 890 {
 891         int fd;
 892         struct sockaddr_ll sock;
 893
 894         /*
 895          * Comment:
 896          *
 897          *      I've selected not to see LL header, so BPF doesn't see it, too.
 898          *      The filter may also pass non-IP and non-ARP packets, but we do
 899          *      a more complete check when receiving the message in userspace.
 900          *
 901          * and filter shamelessly stolen from:
 902          *
 903          *      http://www.flamewarmaster.de/software/dhcpclient/
 904          *
 905          * There are a few other interesting ideas on that page (look under
 906          * "Motivation").  Use of netlink events is most interesting.  Think
 907          * of various network servers listening for events and reconfiguring.
 908          * That would obsolete sending HUP signals and/or make use of restarts.
 909          *
 910          * Copyright: 2006, 2007 Stefan Rompf <sux@loplof.de>.
 911          * License: GPL v2.
 912          *
 913          * TODO: make conditional?
 914          */
 915         static const struct sock_filter filter_instr[] = {
 916                 /* load 9th byte (protocol) */
 917                 BPF_STMT(BPF_LD|BPF_B|BPF_ABS, 9),
 918                 /* jump to L1 if it is IPPROTO_UDP, else to L4 */
 919                 BPF_JUMP(BPF_JMP|BPF_JEQ|BPF_K, IPPROTO_UDP, 0, 6),
 920                 /* L1: load halfword from offset 6 (flags and frag offset) */
 921                 BPF_STMT(BPF_LD|BPF_H|BPF_ABS, 6),
 922                 /* jump to L4 if any bits in frag offset field are set, else to L2 */
 923                 BPF_JUMP(BPF_JMP|BPF_JSET|BPF_K, 0x1fff, 4, 0),
 924                 /* L2: skip IP header (load index reg with header len) */
 925                 BPF_STMT(BPF_LDX|BPF_B|BPF_MSH, 0),
 926                 /* load udp destination port from halfword[header_len + 2] */
 927                 BPF_STMT(BPF_LD|BPF_H|BPF_IND, 2),
 928                 /* jump to L3 if udp dport is CLIENT_PORT, else to L4 */
 929                 BPF_JUMP(BPF_JMP|BPF_JEQ|BPF_K, 68, 0, 1),
 930                 /* L3: accept packet */
 931                 BPF_STMT(BPF_RET|BPF_K, 0xffffffff),
 932                 /* L4: discard packet */
 933                 BPF_STMT(BPF_RET|BPF_K, 0),
 934         };
 935         static const struct sock_fprog filter_prog = {
 936                 .len = sizeof(filter_instr) / sizeof(filter_instr[0]),
 937                 /* casting const away: */
 938                 .filter = (struct sock_filter *) filter_instr,
 939         };
 940
 941         log1("Opening raw socket on ifindex %d", ifindex); //log2?
 942
 943         fd = xsocket(PF_PACKET, SOCK_DGRAM, htons(ETH_P_IP));
 944         log1("Got raw socket fd %d", fd); //log2?
 945
 946         sock.sll_family = AF_PACKET;
 947         sock.sll_protocol = htons(ETH_P_IP);
 948         sock.sll_ifindex = ifindex;
 949         xbind(fd, (struct sockaddr *) &sock, sizeof(sock));
 950
 951         if (CLIENT_PORT == 68) {
 952                 /* Use only if standard port is in use */
 953                 /* Ignoring error (kernel may lack support for this) */
 954                 if (setsockopt(fd, SOL_SOCKET, SO_ATTACH_FILTER, &filter_prog,
 955                                 sizeof(filter_prog)) >= 0)
 956                         log1("Attached filter to raw socket fd %d", fd); // log?
 957         }
 958
 959         log1("Created raw socket");
 960
 961         return fd;
 962 }
 963
 964 static void change_listen_mode(int new_mode)
 965 {
 966         log1("Entering listen mode: %s",
 967                 new_mode != LISTEN_NONE
 968                         ? (new_mode == LISTEN_KERNEL ? "kernel" : "raw")
 969                         : "none"
 970         );
 971
 972         listen_mode = new_mode;
 973         if (sockfd >= 0) {
 974                 close(sockfd);
 975                 sockfd = -1;
 976         }
 977         if (new_mode == LISTEN_KERNEL)
 978                 sockfd = udhcp_listen_socket(/*INADDR_ANY,*/ CLIENT_PORT, client_config.interface);
 979         else if (new_mode != LISTEN_NONE)
 980                 sockfd = udhcp_raw_socket(client_config.ifindex);
 981         /* else LISTEN_NONE: sockfd stays closed */
 982 }
 983
 984 /* Called only on SIGUSR1 */
 985 static void perform_renew(void)
 986 {
 987         bb_info_msg("Performing a DHCP renew");
 988         switch (state) {
 989         case BOUND:
 990                 change_listen_mode(LISTEN_KERNEL);
 991         case RENEWING:
 992         case REBINDING:
 993                 state = RENEW_REQUESTED;
 994                 break;
 995         case RENEW_REQUESTED: /* impatient are we? fine, square 1 */
 996                 udhcp_run_script(NULL, "deconfig");
 997         case REQUESTING:
 998         case RELEASED:
 999                 change_listen_mode(LISTEN_RAW);
1000                 state = INIT_SELECTING;
1001                 break;
1002         case INIT_SELECTING:
1003                 break;
1004         }
1005 }
1006
1007 static void perform_release(uint32_t requested_ip, uint32_t server_addr)
1008 {
1009         char buffer[sizeof("255.255.255.255")];
1010         struct in_addr temp_addr;
1011
1012         /* send release packet */
1013         if (state == BOUND || state == RENEWING || state == REBINDING) {
1014                 temp_addr.s_addr = server_addr;
1015                 strcpy(buffer, inet_ntoa(temp_addr));
1016                 temp_addr.s_addr = requested_ip;
1017                 bb_info_msg("Unicasting a release of %s to %s",
1018                                 inet_ntoa(temp_addr), buffer);
1019                 send_release(server_addr, requested_ip); /* unicast */
1020                 udhcp_run_script(NULL, "deconfig");
1021         }
1022         bb_info_msg("Entering released state");
1023
1024         change_listen_mode(LISTEN_NONE);
1025         state = RELEASED;
1026 }
1027
1028 static uint8_t* alloc_dhcp_option(int code, const char *str, int extra)
1029 {
1030         uint8_t *storage;
1031         int len = strnlen(str, 255);
1032         storage = xzalloc(len + extra + OPT_DATA);
1033         storage[OPT_CODE] = code;
1034         storage[OPT_LEN] = len + extra;
1035         memcpy(storage + extra + OPT_DATA, str, len);
1036         return storage;
1037 }
1038
1039 #if BB_MMU
1040 static void client_background(void)
1041 {
1042         bb_daemonize(0);
1043         logmode &= ~LOGMODE_STDIO;
1044         /* rewrite pidfile, as our pid is different now */
1045         write_pidfile(client_config.pidfile);
1046 }
1047 #endif
1048
1049 //usage:#if defined CONFIG_UDHCP_DEBUG && CONFIG_UDHCP_DEBUG >= 1
1050 //usage:# define IF_UDHCP_VERBOSE(...) __VA_ARGS__
1051 //usage:#else
1052 //usage:# define IF_UDHCP_VERBOSE(...)
1053 //usage:#endif
1054 //usage:#define udhcpc_trivial_usage
1055 //usage:       "[-fbnq"IF_UDHCP_VERBOSE("v")"oCRB] [-i IFACE] [-r IP] [-s PROG] [-p PIDFILE]\n"
1056 //usage:       "        [-H HOSTNAME] [-V VENDOR] [-x OPT:VAL]... [-O OPT]..." IF_FEATURE_UDHCP_PORT(" [-P N]")
1057 //usage:#define udhcpc_full_usage "\n"
1058 //usage:        IF_LONG_OPTS(
1059 //usage:     "\n        -i,--interface IFACE    Interface to use (default eth0)"
1060 //usage:     "\n        -p,--pidfile FILE       Create pidfile"
1061 //usage:     "\n        -s,--script PROG        Run PROG at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")"
1062 //usage:     "\n        -B,--broadcast          Request broadcast replies"
1063 //usage:     "\n        -t,--retries N          Send up to N discover packets"
1064 //usage:     "\n        -T,--timeout N          Pause between packets (default 3 seconds)"
1065 //usage:     "\n        -A,--tryagain N         Wait N seconds after failure (default 20)"
1066 //usage:     "\n        -f,--foreground         Run in foreground"
1067 //usage:        USE_FOR_MMU(
1068 //usage:     "\n        -b,--background         Background if lease is not obtained"
1069 //usage:        )
1070 //usage:     "\n        -n,--now                Exit if lease is not obtained"
1071 //usage:     "\n        -q,--quit               Exit after obtaining lease"
1072 //usage:     "\n        -R,--release            Release IP on exit"
1073 //usage:     "\n        -S,--syslog             Log to syslog too"
1074 //usage:        IF_FEATURE_UDHCP_PORT(
1075 //usage:     "\n        -P,--client-port N      Use port N (default 68)"
1076 //usage:        )
1077 //usage:        IF_FEATURE_UDHCPC_ARPING(
1078 //usage:     "\n        -a,--arping             Use arping to validate offered address"
1079 //usage:        )
1080 //usage:     "\n        -O,--request-option OPT Request option OPT from server (cumulative)"
1081 //usage:     "\n        -o,--no-default-options Don't request any options (unless -O is given)"
1082 //usage:     "\n        -r,--request IP         Request this IP address"
1083 //usage:     "\n        -x OPT:VAL              Include option OPT in sent packets (cumulative)"
1084 //usage:     "\n                                Examples of string, numeric, and hex byte opts:"
1085 //usage:     "\n                                -x hostname:bbox - option 12"
1086 //usage:     "\n                                -x lease:3600 - option 51 (lease time)"
1087 //usage:     "\n                                -x 0x3d:0100BEEFC0FFEE - option 61 (client id)"
1088 //usage:     "\n        -F,--fqdn NAME          Ask server to update DNS mapping for NAME"
1089 //usage:     "\n        -H,-h,--hostname NAME   Send NAME as client hostname (default none)"
1090 //usage:     "\n        -V,--vendorclass VENDOR Vendor identifier (default 'udhcp VERSION')"
1091 //usage:     "\n        -C,--clientid-none      Don't send MAC as client identifier"
1092 //usage:        IF_UDHCP_VERBOSE(
1093 //usage:     "\n        -v                      Verbose"
1094 //usage:        )
1095 //usage:        )
1096 //usage:        IF_NOT_LONG_OPTS(
1097 //usage:     "\n        -i IFACE        Interface to use (default eth0)"
1098 //usage:     "\n        -p FILE         Create pidfile"
1099 //usage:     "\n        -s PROG         Run PROG at DHCP events (default "CONFIG_UDHCPC_DEFAULT_SCRIPT")"
1100 //usage:     "\n        -B              Request broadcast replies"
1101 //usage:     "\n        -t N            Send up to N discover packets"
1102 //usage:     "\n        -T N            Pause between packets (default 3 seconds)"
1103 //usage:     "\n        -A N            Wait N seconds (default 20) after failure"
1104 //usage:     "\n        -f              Run in foreground"
1105 //usage:        USE_FOR_MMU(
1106 //usage:     "\n        -b              Background if lease is not obtained"
1107 //usage:        )
1108 //usage:     "\n        -n              Exit if lease is not obtained"
1109 //usage:     "\n        -q              Exit after obtaining lease"
1110 //usage:     "\n        -R              Release IP on exit"
1111 //usage:     "\n        -S              Log to syslog too"
1112 //usage:        IF_FEATURE_UDHCP_PORT(
1113 //usage:     "\n        -P N            Use port N (default 68)"
1114 //usage:        )
1115 //usage:        IF_FEATURE_UDHCPC_ARPING(
1116 //usage:     "\n        -a              Use arping to validate offered address"
1117 //usage:        )
1118 //usage:     "\n        -O OPT          Request option OPT from server (cumulative)"
1119 //usage:     "\n        -o              Don't request any options (unless -O is given)"
1120 //usage:     "\n        -r IP           Request this IP address"
1121 //usage:     "\n        -x OPT:VAL      Include option OPT in sent packets (cumulative)"
1122 //usage:     "\n                        Examples of string, numeric, and hex byte opts:"
1123 //usage:     "\n                        -x hostname:bbox - option 12"
1124 //usage:     "\n                        -x lease:3600 - option 51 (lease time)"
1125 //usage:     "\n                        -x 0x3d:0100BEEFC0FFEE - option 61 (client id)"
1126 //usage:     "\n        -F NAME         Ask server to update DNS mapping for NAME"
1127 //usage:     "\n        -H,-h NAME      Send NAME as client hostname (default none)"
1128 //usage:     "\n        -V VENDOR       Vendor identifier (default 'udhcp VERSION')"
1129 //usage:     "\n        -C              Don't send MAC as client identifier"
1130 //usage:        IF_UDHCP_VERBOSE(
1131 //usage:     "\n        -v              Verbose"
1132 //usage:        )
1133 //usage:        )
1134 //usage:     "\nSignals:"
1135 //usage:     "\n        USR1    Renew current lease"
1136 //usage:     "\n        USR2    Release current lease"
1137
1138
1139 int udhcpc_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
1140 int udhcpc_main(int argc UNUSED_PARAM, char **argv)
1141 {
1142         uint8_t *temp, *message;
1143         const char *str_V, *str_h, *str_F, *str_r;
1144         IF_FEATURE_UDHCP_PORT(char *str_P;)
1145         void *clientid_mac_ptr;
1146         llist_t *list_O = NULL;
1147         llist_t *list_x = NULL;
1148         int tryagain_timeout = 20;
1149         int discover_timeout = 3;
1150         int discover_retries = 3;
1151         uint32_t server_addr = server_addr; /* for compiler */
1152         uint32_t requested_ip = 0;
1153         uint32_t xid = 0;
1154         uint32_t lease_seconds = 0; /* can be given as 32-bit quantity */
1155         int packet_num;
1156         int timeout; /* must be signed */
1157         unsigned already_waited_sec;
1158         unsigned opt;
1159         int max_fd;
1160         int retval;
1161         struct timeval tv;
1162         struct dhcp_packet packet;
1163         fd_set rfds;
1164
1165         /* Default options */
1166         IF_FEATURE_UDHCP_PORT(SERVER_PORT = 67;)
1167         IF_FEATURE_UDHCP_PORT(CLIENT_PORT = 68;)
1168         client_config.interface = "eth0";
1169         client_config.script = CONFIG_UDHCPC_DEFAULT_SCRIPT;
1170         str_V = "udhcp "BB_VER;
1171
1172         /* Parse command line */
1173         /* O,x: list; -T,-t,-A take numeric param */
1174         opt_complementary = "O::x::T+:t+:A+" IF_UDHCP_VERBOSE(":vv") ;
1175         IF_LONG_OPTS(applet_long_options = udhcpc_longopts;)
1176         opt = getopt32(argv, "CV:H:h:F:i:np:qRr:s:T:t:SA:O:ox:fB"
1177                 USE_FOR_MMU("b")
1178                 IF_FEATURE_UDHCPC_ARPING("a")
1179                 IF_FEATURE_UDHCP_PORT("P:")
1180                 "v"
1181                 , &str_V, &str_h, &str_h, &str_F
1182                 , &client_config.interface, &client_config.pidfile, &str_r /* i,p */
1183                 , &client_config.script /* s */
1184                 , &discover_timeout, &discover_retries, &tryagain_timeout /* T,t,A */
1185                 , &list_O
1186                 , &list_x
1187                 IF_FEATURE_UDHCP_PORT(, &str_P)
1188                 IF_UDHCP_VERBOSE(, &dhcp_verbose)
1189                 );
1190         if (opt & (OPT_h|OPT_H))
1191                 client_config.hostname = alloc_dhcp_option(DHCP_HOST_NAME, str_h, 0);
1192         if (opt & OPT_F) {
1193                 /* FQDN option format: [0x51][len][flags][0][0]<fqdn> */
1194                 client_config.fqdn = alloc_dhcp_option(DHCP_FQDN, str_F, 3);
1195                 /* Flag bits: 0000NEOS
1196                  * S: 1 = Client requests server to update A RR in DNS as well as PTR
1197                  * O: 1 = Server indicates to client that DNS has been updated regardless
1198                  * E: 1 = Name is in DNS format, i.e. <4>host<6>domain<3>com<0>,
1199                  *    not "host.domain.com". Format 0 is obsolete.
1200                  * N: 1 = Client requests server to not update DNS (S must be 0 then)
1201                  * Two [0] bytes which follow are deprecated and must be 0.
1202                  */
1203                 client_config.fqdn[OPT_DATA + 0] = 0x1;
1204                 /*client_config.fqdn[OPT_DATA + 1] = 0; - xzalloc did it */
1205                 /*client_config.fqdn[OPT_DATA + 2] = 0; */
1206         }
1207         if (opt & OPT_r)
1208                 requested_ip = inet_addr(str_r);
1209 #if ENABLE_FEATURE_UDHCP_PORT
1210         if (opt & OPT_P) {
1211                 CLIENT_PORT = xatou16(str_P);
1212                 SERVER_PORT = CLIENT_PORT - 1;
1213         }
1214 #endif
1215         if (opt & OPT_o)
1216                 client_config.no_default_options = 1;
1217         while (list_O) {
1218                 char *optstr = llist_pop(&list_O);
1219                 unsigned n = bb_strtou(optstr, NULL, 0);
1220                 if (errno || n > 254) {
1221                         n = udhcp_option_idx(optstr);
1222                         n = dhcp_optflags[n].code;
1223                 }
1224                 client_config.opt_mask[n >> 3] |= 1 << (n & 7);
1225         }
1226         while (list_x) {
1227                 char *optstr = llist_pop(&list_x);
1228                 char *colon = strchr(optstr, ':');
1229                 if (colon)
1230                         *colon = ' ';
1231                 /* now it looks similar to udhcpd's config file line:
1232                  * "optname optval", using the common routine: */
1233                 udhcp_str2optset(optstr, &client_config.options);
1234         }
1235
1236         if (udhcp_read_interface(client_config.interface,
1237                         &client_config.ifindex,
1238                         NULL,
1239                         client_config.client_mac)
1240         ) {
1241                 return 1;
1242         }
1243
1244         clientid_mac_ptr = NULL;
1245         if (!(opt & OPT_C) && !udhcp_find_option(client_config.options, DHCP_CLIENT_ID)) {
1246                 /* not suppressed and not set, set the default client ID */
1247                 client_config.clientid = alloc_dhcp_option(DHCP_CLIENT_ID, "", 7);
1248                 client_config.clientid[OPT_DATA] = 1; /* type: ethernet */
1249                 clientid_mac_ptr = client_config.clientid + OPT_DATA+1;
1250                 memcpy(clientid_mac_ptr, client_config.client_mac, 6);
1251         }
1252         if (str_V[0] != '\0')
1253                 client_config.vendorclass = alloc_dhcp_option(DHCP_VENDOR, str_V, 0);
1254 #if !BB_MMU
1255         /* on NOMMU reexec (i.e., background) early */
1256         if (!(opt & OPT_f)) {
1257                 bb_daemonize_or_rexec(0 /* flags */, argv);
1258                 logmode = LOGMODE_NONE;
1259         }
1260 #endif
1261         if (opt & OPT_S) {
1262                 openlog(applet_name, LOG_PID, LOG_DAEMON);
1263                 logmode |= LOGMODE_SYSLOG;
1264         }
1265
1266         /* Make sure fd 0,1,2 are open */
1267         bb_sanitize_stdio();
1268         /* Equivalent of doing a fflush after every \n */
1269         setlinebuf(stdout);
1270         /* Create pidfile */
1271         write_pidfile(client_config.pidfile);
1272         /* Goes to stdout (unless NOMMU) and possibly syslog */
1273         bb_info_msg("%s (v"BB_VER") started", applet_name);
1274         /* Set up the signal pipe */
1275         udhcp_sp_setup();
1276         /* We want random_xid to be random... */
1277         srand(monotonic_us());
1278
1279         state = INIT_SELECTING;
1280         udhcp_run_script(NULL, "deconfig");
1281         change_listen_mode(LISTEN_RAW);
1282         packet_num = 0;
1283         timeout = 0;
1284         already_waited_sec = 0;
1285
1286         /* Main event loop. select() waits on signal pipe and possibly
1287          * on sockfd.
1288          * "continue" statements in code below jump to the top of the loop.
1289          */
1290         for (;;) {
1291                 /* silence "uninitialized!" warning */
1292                 unsigned timestamp_before_wait = timestamp_before_wait;
1293
1294                 //bb_error_msg("sockfd:%d, listen_mode:%d", sockfd, listen_mode);
1295
1296                 /* Was opening raw or udp socket here
1297                  * if (listen_mode != LISTEN_NONE && sockfd < 0),
1298                  * but on fast network renew responses return faster
1299                  * than we open sockets. Thus this code is moved
1300                  * to change_listen_mode(). Thus we open listen socket
1301                  * BEFORE we send renew request (see "case BOUND:"). */
1302
1303                 max_fd = udhcp_sp_fd_set(&rfds, sockfd);
1304
1305                 tv.tv_sec = timeout - already_waited_sec;
1306                 tv.tv_usec = 0;
1307                 retval = 0;
1308                 /* If we already timed out, fall through with retval = 0, else... */
1309                 if ((int)tv.tv_sec > 0) {
1310                         timestamp_before_wait = (unsigned)monotonic_sec();
1311                         log1("Waiting on select...");
1312                         retval = select(max_fd + 1, &rfds, NULL, NULL, &tv);
1313                         if (retval < 0) {
1314                                 /* EINTR? A signal was caught, don't panic */
1315                                 if (errno == EINTR) {
1316                                         already_waited_sec += (unsigned)monotonic_sec() - timestamp_before_wait;
1317                                         continue;
1318                                 }
1319                                 /* Else: an error occured, panic! */
1320                                 bb_perror_msg_and_die("select");
1321                         }
1322                 }
1323
1324                 /* If timeout dropped to zero, time to become active:
1325                  * resend discover/renew/whatever
1326                  */
1327                 if (retval == 0) {
1328                         /* When running on a bridge, the ifindex may have changed
1329                          * (e.g. if member interfaces were added/removed
1330                          * or if the status of the bridge changed).
1331                          * Refresh ifindex and client_mac:
1332                          */
1333                         if (udhcp_read_interface(client_config.interface,
1334                                         &client_config.ifindex,
1335                                         NULL,
1336                                         client_config.client_mac)
1337                         ) {
1338                                 return 1; /* iface is gone? */
1339                         }
1340                         if (clientid_mac_ptr)
1341                                 memcpy(clientid_mac_ptr, client_config.client_mac, 6);
1342
1343                         /* We will restart the wait in any case */
1344                         already_waited_sec = 0;
1345
1346                         switch (state) {
1347                         case INIT_SELECTING:
1348                                 if (packet_num < discover_retries) {
1349                                         if (packet_num == 0)
1350                                                 xid = random_xid();
1351                                         /* broadcast */
1352                                         send_discover(xid, requested_ip);
1353                                         timeout = discover_timeout;
1354                                         packet_num++;
1355                                         continue;
1356                                 }
1357  leasefail:
1358                                 udhcp_run_script(NULL, "leasefail");
1359 #if BB_MMU /* -b is not supported on NOMMU */
1360                                 if (opt & OPT_b) { /* background if no lease */
1361                                         bb_info_msg("No lease, forking to background");
1362                                         client_background();
1363                                         /* do not background again! */
1364                                         opt = ((opt & ~OPT_b) | OPT_f);
1365                                 } else
1366 #endif
1367                                 if (opt & OPT_n) { /* abort if no lease */
1368                                         bb_info_msg("No lease, failing");
1369                                         retval = 1;
1370                                         goto ret;
1371                                 }
1372                                 /* wait before trying again */
1373                                 timeout = tryagain_timeout;
1374                                 packet_num = 0;
1375                                 continue;
1376                         case REQUESTING:
1377                                 if (packet_num < discover_retries) {
1378                                         /* send broadcast select packet */
1379                                         send_select(xid, server_addr, requested_ip);
1380                                         timeout = discover_timeout;
1381                                         packet_num++;
1382                                         continue;
1383                                 }
1384                                 /* Timed out, go back to init state.
1385                                  * "discover...select...discover..." loops
1386                                  * were seen in the wild. Treat them similarly
1387                                  * to "no response to discover" case */
1388                                 change_listen_mode(LISTEN_RAW);
1389                                 state = INIT_SELECTING;
1390                                 goto leasefail;
1391                         case BOUND:
1392                                 /* 1/2 lease passed, enter renewing state */
1393                                 state = RENEWING;
1394                                 client_config.first_secs = 0; /* make secs field count from 0 */
1395                                 change_listen_mode(LISTEN_KERNEL);
1396                                 log1("Entering renew state");
1397                                 /* fall right through */
1398                         case RENEW_REQUESTED: /* manual (SIGUSR1) renew */
1399                         case_RENEW_REQUESTED:
1400                         case RENEWING:
1401                                 if (timeout > 60) {
1402                                         /* send an unicast renew request */
1403                         /* Sometimes observed to fail (EADDRNOTAVAIL) to bind
1404                          * a new UDP socket for sending inside send_renew.
1405                          * I hazard to guess existing listening socket
1406                          * is somehow conflicting with it, but why is it
1407                          * not deterministic then?! Strange.
1408                          * Anyway, it does recover by eventually failing through
1409                          * into INIT_SELECTING state.
1410                          */
1411                                         send_renew(xid, server_addr, requested_ip);
1412                                         timeout >>= 1;
1413                                         continue;
1414                                 }
1415                                 /* Timed out, enter rebinding state */
1416                                 log1("Entering rebinding state");
1417                                 state = REBINDING;
1418                                 /* fall right through */
1419                         case REBINDING:
1420                                 /* Switch to bcast receive */
1421                                 change_listen_mode(LISTEN_RAW);
1422                                 /* Lease is *really* about to run out,
1423                                  * try to find DHCP server using broadcast */
1424                                 if (timeout > 0) {
1425                                         /* send a broadcast renew request */
1426                                         send_renew(xid, 0 /*INADDR_ANY*/, requested_ip);
1427                                         timeout >>= 1;
1428                                         continue;
1429                                 }
1430                                 /* Timed out, enter init state */
1431                                 bb_info_msg("Lease lost, entering init state");
1432                                 udhcp_run_script(NULL, "deconfig");
1433                                 state = INIT_SELECTING;
1434                                 client_config.first_secs = 0; /* make secs field count from 0 */
1435                                 /*timeout = 0; - already is */
1436                                 packet_num = 0;
1437                                 continue;
1438                         /* case RELEASED: */
1439                         }
1440                         /* yah, I know, *you* say it would never happen */
1441                         timeout = INT_MAX;
1442                         continue; /* back to main loop */
1443                 } /* if select timed out */
1444
1445                 /* select() didn't timeout, something happened */
1446
1447                 /* Is it a signal? */
1448                 /* note: udhcp_sp_read checks FD_ISSET before reading */
1449                 switch (udhcp_sp_read(&rfds)) {
1450                 case SIGUSR1:
1451                         client_config.first_secs = 0; /* make secs field count from 0 */
1452                         already_waited_sec = 0;
1453                         perform_renew();
1454                         if (state == RENEW_REQUESTED) {
1455                                 /* We might be either on the same network
1456                                  * (in which case renew might work),
1457                                  * or we might be on a completely different one
1458                                  * (in which case renew won't ever succeed).
1459                                  * For the second case, must make sure timeout
1460                                  * is not too big, or else we can send
1461                                  * futile renew requests for hours.
1462                                  * (Ab)use -A TIMEOUT value (usually 20 sec)
1463                                  * as a cap on the timeout.
1464                                  */
1465                                 if (timeout > tryagain_timeout)
1466                                         timeout = tryagain_timeout;
1467                                 goto case_RENEW_REQUESTED;
1468                         }
1469                         /* Start things over */
1470                         packet_num = 0;
1471                         /* Kill any timeouts, user wants this to hurry along */
1472                         timeout = 0;
1473                         continue;
1474                 case SIGUSR2:
1475                         perform_release(requested_ip, server_addr);
1476                         timeout = INT_MAX;
1477                         continue;
1478                 case SIGTERM:
1479                         bb_info_msg("Received SIGTERM");
1480                         if (opt & OPT_R) /* release on quit */
1481                                 perform_release(requested_ip, server_addr);
1482                         goto ret0;
1483                 }
1484
1485                 /* Is it a packet? */
1486                 if (listen_mode == LISTEN_NONE || !FD_ISSET(sockfd, &rfds))
1487                         continue; /* no */
1488
1489                 {
1490                         int len;
1491
1492                         /* A packet is ready, read it */
1493                         if (listen_mode == LISTEN_KERNEL)
1494                                 len = udhcp_recv_kernel_packet(&packet, sockfd);
1495                         else
1496                                 len = udhcp_recv_raw_packet(&packet, sockfd);
1497                         if (len == -1) {
1498                                 /* Error is severe, reopen socket */
1499                                 bb_info_msg("Read error: %s, reopening socket", strerror(errno));
1500                                 sleep(discover_timeout); /* 3 seconds by default */
1501                                 change_listen_mode(listen_mode); /* just close and reopen */
1502                         }
1503                         /* If this packet will turn out to be unrelated/bogus,
1504                          * we will go back and wait for next one.
1505                          * Be sure timeout is properly decreased. */
1506                         already_waited_sec += (unsigned)monotonic_sec() - timestamp_before_wait;
1507                         if (len < 0)
1508                                 continue;
1509                 }
1510
1511                 if (packet.xid != xid) {
1512                         log1("xid %x (our is %x), ignoring packet",
1513                                 (unsigned)packet.xid, (unsigned)xid);
1514                         continue;
1515                 }
1516
1517                 /* Ignore packets that aren't for us */
1518                 if (packet.hlen != 6
1519                  || memcmp(packet.chaddr, client_config.client_mac, 6) != 0
1520                 ) {
1521 //FIXME: need to also check that last 10 bytes are zero
1522                         log1("chaddr does not match, ignoring packet"); // log2?
1523                         continue;
1524                 }
1525
1526                 message = udhcp_get_option(&packet, DHCP_MESSAGE_TYPE);
1527                 if (message == NULL) {
1528                         bb_error_msg("no message type option, ignoring packet");
1529                         continue;
1530                 }
1531
1532                 switch (state) {
1533                 case INIT_SELECTING:
1534                         /* Must be a DHCPOFFER to one of our xid's */
1535                         if (*message == DHCPOFFER) {
1536                 /* TODO: why we don't just fetch server's IP from IP header? */
1537                                 temp = udhcp_get_option(&packet, DHCP_SERVER_ID);
1538                                 if (!temp) {
1539                                         bb_error_msg("no server ID, ignoring packet");
1540                                         continue;
1541                                         /* still selecting - this server looks bad */
1542                                 }
1543                                 /* it IS unaligned sometimes, don't "optimize" */
1544                                 move_from_unaligned32(server_addr, temp);
1545                                 /*xid = packet.xid; - already is */
1546                                 requested_ip = packet.yiaddr;
1547
1548                                 /* enter requesting state */
1549                                 state = REQUESTING;
1550                                 timeout = 0;
1551                                 packet_num = 0;
1552                                 already_waited_sec = 0;
1553                         }
1554                         continue;
1555                 case REQUESTING:
1556                 case RENEWING:
1557                 case RENEW_REQUESTED:
1558                 case REBINDING:
1559                         if (*message == DHCPACK) {
1560                                 temp = udhcp_get_option(&packet, DHCP_LEASE_TIME);
1561                                 if (!temp) {
1562                                         bb_error_msg("no lease time with ACK, using 1 hour lease");
1563                                         lease_seconds = 60 * 60;
1564                                 } else {
1565                                         /* it IS unaligned sometimes, don't "optimize" */
1566                                         move_from_unaligned32(lease_seconds, temp);
1567                                         lease_seconds = ntohl(lease_seconds);
1568                                         lease_seconds &= 0x0fffffff; /* paranoia: must not be prone to overflows */
1569                                         if (lease_seconds < 10) /* and not too small */
1570                                                 lease_seconds = 10;
1571                                 }
1572 #if ENABLE_FEATURE_UDHCPC_ARPING
1573                                 if (opt & OPT_a) {
1574 /* RFC 2131 3.1 paragraph 5:
1575  * "The client receives the DHCPACK message with configuration
1576  * parameters. The client SHOULD perform a final check on the
1577  * parameters (e.g., ARP for allocated network address), and notes
1578  * the duration of the lease specified in the DHCPACK message. At this
1579  * point, the client is configured. If the client detects that the
1580  * address is already in use (e.g., through the use of ARP),
1581  * the client MUST send a DHCPDECLINE message to the server and restarts
1582  * the configuration process..." */
1583                                         if (!arpping(packet.yiaddr,
1584                                                         NULL,
1585                                                         (uint32_t) 0,
1586                                                         client_config.client_mac,
1587                                                         client_config.interface)
1588                                         ) {
1589                                                 bb_info_msg("Offered address is in use "
1590                                                         "(got ARP reply), declining");
1591                                                 send_decline(xid, server_addr, packet.yiaddr);
1592
1593                                                 if (state != REQUESTING)
1594                                                         udhcp_run_script(NULL, "deconfig");
1595                                                 change_listen_mode(LISTEN_RAW);
1596                                                 state = INIT_SELECTING;
1597                                                 client_config.first_secs = 0; /* make secs field count from 0 */
1598                                                 requested_ip = 0;
1599                                                 timeout = tryagain_timeout;
1600                                                 packet_num = 0;
1601                                                 already_waited_sec = 0;
1602                                                 continue; /* back to main loop */
1603                                         }
1604                                 }
1605 #endif
1606                                 /* enter bound state */
1607                                 timeout = lease_seconds / 2;
1608                                 {
1609                                         struct in_addr temp_addr;
1610                                         temp_addr.s_addr = packet.yiaddr;
1611                                         bb_info_msg("Lease of %s obtained, lease time %u",
1612                                                 inet_ntoa(temp_addr), (unsigned)lease_seconds);
1613                                 }
1614                                 requested_ip = packet.yiaddr;
1615                                 udhcp_run_script(&packet, state == REQUESTING ? "bound" : "renew");
1616
1617                                 state = BOUND;
1618                                 change_listen_mode(LISTEN_NONE);
1619                                 if (opt & OPT_q) { /* quit after lease */
1620                                         if (opt & OPT_R) /* release on quit */
1621                                                 perform_release(requested_ip, server_addr);
1622                                         goto ret0;
1623                                 }
1624                                 /* future renew failures should not exit (JM) */
1625                                 opt &= ~OPT_n;
1626 #if BB_MMU /* NOMMU case backgrounded earlier */
1627                                 if (!(opt & OPT_f)) {
1628                                         client_background();
1629                                         /* do not background again! */
1630                                         opt = ((opt & ~OPT_b) | OPT_f);
1631                                 }
1632 #endif
1633                                 already_waited_sec = 0;
1634                                 continue; /* back to main loop */
1635                         }
1636                         if (*message == DHCPNAK) {
1637                                 /* return to init state */
1638                                 bb_info_msg("Received DHCP NAK");
1639                                 udhcp_run_script(&packet, "nak");
1640                                 if (state != REQUESTING)
1641                                         udhcp_run_script(NULL, "deconfig");
1642                                 change_listen_mode(LISTEN_RAW);
1643                                 sleep(3); /* avoid excessive network traffic */
1644                                 state = INIT_SELECTING;
1645                                 client_config.first_secs = 0; /* make secs field count from 0 */
1646                                 requested_ip = 0;
1647                                 timeout = 0;
1648                                 packet_num = 0;
1649                                 already_waited_sec = 0;
1650                         }
1651                         continue;
1652                 /* case BOUND: - ignore all packets */
1653                 /* case RELEASED: - ignore all packets */
1654                 }
1655                 /* back to main loop */
1656         } /* for (;;) - main loop ends */
1657
1658  ret0:
1659         retval = 0;
1660  ret:
1661         /*if (client_config.pidfile) - remove_pidfile has its own check */
1662                 remove_pidfile(client_config.pidfile);
1663         return retval;
1664 }