lib/dhcp.c

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 #include <config.h>
  35 #include "dhcp.h"
  36 #include <arpa/inet.h>
  37 #include <assert.h>
  38 #include <ctype.h>
  39 #include <errno.h>
  40 #include <inttypes.h>
  41 #include <stdlib.h>
  42 #include "buffer.h"
  43 #include "dynamic-string.h"
  44
  45 #define THIS_MODULE VLM_dhcp
  46 #include "vlog.h"
  47
  48 /* Information about a DHCP argument type. */
  49 struct arg_type {
  50     const char *name;           /* Name. */
  51     size_t size;                /* Number of bytes per argument. */
  52 };
  53
  54 static struct arg_type types[] = {
  55 #define DHCP_ARG(NAME, SIZE) [DHCP_ARG_##NAME] = {#NAME, SIZE},
  56     DHCP_ARGS
  57 #undef DHCP_ARG
  58 };
  59
  60 /* Information about a DHCP option. */
  61 struct option_class {
  62     const char *name;           /* Name. */
  63     enum dhcp_arg_type type;    /* Argument type. */
  64     size_t min_args;            /* Minimum number of arguments. */
  65     size_t max_args;            /* Maximum number of arguments. */
  66 };
  67
  68 static struct option_class classes[DHCP_N_OPTIONS] = {
  69     [0 ... 255] = {NULL, DHCP_ARG_UINT8, 0, SIZE_MAX},
  70 #define DHCP_OPT(NAME, CODE, TYPE, MIN, MAX) \
  71     [CODE] = {#NAME, DHCP_ARG_##TYPE, MIN, MAX},
  72     DHCP_OPTS
  73 #undef DHCP_OPT
  74 };
  75
  76 static void copy_data(struct dhcp_msg *);
  77
  78 const char *
  79 dhcp_type_name(enum dhcp_msg_type type)
  80 {
  81     switch (type) {
  82 #define DHCP_MSG(NAME, VALUE) case NAME: return #NAME;
  83         DHCP_MSGS
  84 #undef DHCP_MSG
  85     }
  86     return "<<unknown DHCP message type>>";
  87 }
  88
  89 /* Initializes 'msg' as a DHCP message.  The message should be freed with
  90  * dhcp_msg_uninit() when it is no longer needed. */
  91 void
  92 dhcp_msg_init(struct dhcp_msg *msg)
  93 {
  94     memset(msg, 0, sizeof *msg);
  95 }
  96
  97 /* Frees the contents of 'msg'.  The caller is responsible for freeing 'msg',
  98  * if necessary. */
  99 void
 100 dhcp_msg_uninit(struct dhcp_msg *msg)
 101 {
 102     if (msg) {
 103         free(msg->data);
 104     }
 105 }
 106
 107 /* Initializes 'dst' as a copy of 'src'.  'dst' (and 'src') should be freed
 108  * with dhcp_msg_uninit() when it is no longer needed. */
 109 void
 110 dhcp_msg_copy(struct dhcp_msg *dst, const struct dhcp_msg *src)
 111 {
 112     *dst = *src;
 113     dst->data_allocated = src->data_used;
 114     dst->data_used = 0;
 115     dst->data = xmalloc(dst->data_allocated);
 116     copy_data(dst);
 117 }
 118
 119 static void
 120 prealloc_data(struct dhcp_msg *msg, size_t n)
 121 {
 122     size_t needed = msg->data_used + n;
 123     if (needed > msg->data_allocated) {
 124         uint8_t *old_data = msg->data;
 125         msg->data_allocated = MAX(needed * 2, 64);
 126         msg->data = xmalloc(msg->data_allocated);
 127         if (old_data) {
 128             copy_data(msg);
 129             free(old_data);
 130         }
 131     }
 132 }
 133
 134 static void *
 135 append_data(struct dhcp_msg *msg, const void *data, size_t n)
 136 {
 137     uint8_t *p = &msg->data[msg->data_used];
 138     memcpy(p, data, n);
 139     msg->data_used += n;
 140     return p;
 141 }
 142
 143 static void
 144 copy_data(struct dhcp_msg *msg)
 145 {
 146     int code;
 147
 148     msg->data_used = 0;
 149     for (code = 0; code < DHCP_N_OPTIONS; code++) {
 150         struct dhcp_option *opt = &msg->options[code];
 151         if (opt->data) {
 152             assert(msg->data_used + opt->n <= msg->data_allocated);
 153             opt->data = append_data(msg, opt->data, opt->n);
 154         }
 155     }
 156 }
 157
 158 /* Appends the 'n' bytes in 'data' to the DHCP option in 'msg' represented by
 159  * 'code' (which must be in the range 0...DHCP_N_OPTIONS). */
 160 void
 161 dhcp_msg_put(struct dhcp_msg *msg, int code,
 162              const void *data, size_t n)
 163 {
 164     struct dhcp_option *opt;
 165     if (code == DHCP_CODE_PAD || code == DHCP_CODE_END) {
 166         return;
 167     }
 168
 169     opt = &msg->options[code];
 170     prealloc_data(msg, n + opt->n);
 171     if (opt->n) {
 172         if (&msg->data[msg->data_used - opt->n] != opt->data) {
 173             opt->data = append_data(msg, opt->data, opt->n);
 174         }
 175         append_data(msg, data, n);
 176     } else {
 177         opt->data = append_data(msg, data, n);
 178     }
 179     opt->n += n;
 180 }
 181
 182 /* Appends the boolean value 'b', as a octet with value 0 (false) or 1 (true),
 183  * to the DHCP option in 'msg' represented by 'code' (which must be in the
 184  * range 0...DHCP_N_OPTIONS). */
 185 void
 186 dhcp_msg_put_bool(struct dhcp_msg *msg, int code, bool b_)
 187 {
 188     char b = !!b_;
 189     dhcp_msg_put(msg, code, &b, 1);
 190 }
 191
 192 /* Appends the number of seconds 'secs', as a 32-bit number in network byte
 193  * order, to the DHCP option in 'msg' represented by 'code' (which must be in
 194  * the range 0...DHCP_N_OPTIONS). */
 195 void
 196 dhcp_msg_put_secs(struct dhcp_msg *msg, int code, uint32_t secs_)
 197 {
 198     uint32_t secs = htonl(secs_);
 199     dhcp_msg_put(msg, code, &secs, sizeof secs);
 200 }
 201
 202 /* Appends the IP address 'ip', as a 32-bit number in network byte order, to
 203  * the DHCP option in 'msg' represented by 'code' (which must be in the range
 204  * 0...DHCP_N_OPTIONS). */
 205 void
 206 dhcp_msg_put_ip(struct dhcp_msg *msg, int code, uint32_t ip)
 207 {
 208     dhcp_msg_put(msg, code, &ip, sizeof ip);
 209 }
 210
 211 /* Appends the ASCII string 'string', to the DHCP option in 'msg' represented
 212  * by 'code' (which must be in the range 0...DHCP_N_OPTIONS). */
 213 void
 214 dhcp_msg_put_string(struct dhcp_msg *msg, int code, const char *string)
 215 {
 216     dhcp_msg_put(msg, code, string, strlen(string));
 217 }
 218
 219 /* Appends octet 'x' to DHCP option in 'msg' represented by 'code' (which must
 220  * be in the range 0...DHCP_N_OPTIONS). */
 221 void
 222 dhcp_msg_put_uint8(struct dhcp_msg *msg, int code, uint8_t x)
 223 {
 224     dhcp_msg_put(msg, code, &x, sizeof x);
 225 }
 226
 227 /* Appends the 'n' octets in 'data' to DHCP option in 'msg' represented by
 228  * 'code' (which must be in the range 0...DHCP_N_OPTIONS). */
 229 void dhcp_msg_put_uint8_array(struct dhcp_msg *msg, int code,
 230                               const uint8_t data[], size_t n)
 231 {
 232     dhcp_msg_put(msg, code, data, n);
 233 }
 234
 235 /* Appends the 16-bit value in 'x', in network byte order, to DHCP option in
 236  * 'msg' represented by 'code' (which must be in the range
 237  * 0...DHCP_N_OPTIONS). */
 238 void
 239 dhcp_msg_put_uint16(struct dhcp_msg *msg, int code, uint16_t x_)
 240 {
 241     uint16_t x = htons(x_);
 242     dhcp_msg_put(msg, code, &x, sizeof x);
 243 }
 244
 245
 246 /* Appends the 'n' 16-bit values in 'data', in network byte order, to DHCP
 247  * option in 'msg' represented by 'code' (which must be in the range
 248  * 0...DHCP_N_OPTIONS). */
 249 void
 250 dhcp_msg_put_uint16_array(struct dhcp_msg *msg, int code,
 251                           const uint16_t data[], size_t n)
 252 {
 253     size_t i;
 254
 255     for (i = 0; i < n; i++) {
 256         dhcp_msg_put_uint16(msg, code, data[i]);
 257     }
 258 }
 259
 260 /* Returns a pointer to the 'size' bytes starting at byte offset 'offset' in
 261  * the DHCP option in 'msg' represented by 'code' (which must be in the range
 262  * 0...DHCP_N_OPTIONS).  If the option has fewer than 'offset + size' bytes,
 263  * returns a null pointer. */
 264 const void *
 265 dhcp_msg_get(const struct dhcp_msg *msg, int code,
 266              size_t offset, size_t size)
 267 {
 268     const struct dhcp_option *opt = &msg->options[code];
 269     return offset + size <= opt->n ? (const char *) opt->data + offset : NULL;
 270 }
 271
 272 /* Stores in '*out' the boolean value at byte offset 'offset' in the DHCP
 273  * option in 'msg' represented by 'code' (which must be in the range
 274  * 0...DHCP_N_OPTIONS).  Returns true if successful, false if the option has
 275  * fewer than 'offset + 1' bytes. */
 276 bool
 277 dhcp_msg_get_bool(const struct dhcp_msg *msg, int code, size_t offset,
 278                   bool *out)
 279 {
 280     const uint8_t *uint8 = dhcp_msg_get(msg, code, offset, sizeof *uint8);
 281     if (uint8) {
 282         *out = *uint8 != 0;
 283         return true;
 284     } else {
 285         return false;
 286     }
 287 }
 288
 289 /* Stores in '*out' the 32-bit count of seconds at offset 'offset' (in
 290  * 4-byte increments) in the DHCP option in 'msg' represented by 'code'
 291  * (which must be in the range 0...DHCP_N_OPTIONS).  The value is converted to
 292  * native byte order.  Returns true if successful, false if the option has
 293  * fewer than '4 * (offset + 1)' bytes. */
 294 bool
 295 dhcp_msg_get_secs(const struct dhcp_msg *msg, int code, size_t offset,
 296                   uint32_t *out)
 297 {
 298     const uint32_t *uint32 = dhcp_msg_get(msg, code, offset * sizeof *uint32,
 299                                           sizeof *uint32);
 300     if (uint32) {
 301         *out = ntohl(*uint32);
 302         return true;
 303     } else {
 304         return false;
 305     }
 306 }
 307
 308 /* Stores in '*out' the IP address at offset 'offset' (in 4-byte increments) in
 309  * the DHCP option in 'msg' represented by 'code' (which must be in the range
 310  * 0...DHCP_N_OPTIONS).  The IP address is stored in network byte order.
 311  * Returns true if successful, false if the option has fewer than '4 * (offset
 312  * + 1)' bytes. */
 313 bool
 314 dhcp_msg_get_ip(const struct dhcp_msg *msg, int code,
 315                 size_t offset, uint32_t *out)
 316 {
 317     const uint32_t *uint32 = dhcp_msg_get(msg, code, offset * sizeof *uint32,
 318                                           sizeof *uint32);
 319     if (uint32) {
 320         *out = *uint32;
 321         return true;
 322     } else {
 323         return false;
 324     }
 325 }
 326
 327 /* Returns the string in the DHCP option in 'msg' represented by 'code' (which
 328  * must be in the range 0...DHCP_N_OPTIONS).  The caller is responsible for
 329  * freeing the string with free().
 330  *
 331  * If 'msg' has no option represented by 'code', returns a null pointer.  (If
 332  * the option was specified but had no content, then an empty string is
 333  * returned, not a null pointer.) */
 334 char *
 335 dhcp_msg_get_string(const struct dhcp_msg *msg, int code)
 336 {
 337     const struct dhcp_option *opt = &msg->options[code];
 338     return opt->data ? xmemdup0(opt->data, opt->n) : NULL;
 339 }
 340
 341 /* Stores in '*out' the octet at byte offset 'offset' in the DHCP option in
 342  * 'msg' represented by 'code' (which must be in the range 0...DHCP_N_OPTIONS).
 343  * Returns true if successful, false if the option has fewer than 'offset + 1'
 344  * bytes. */
 345 bool
 346 dhcp_msg_get_uint8(const struct dhcp_msg *msg, int code,
 347                    size_t offset, uint8_t *out)
 348 {
 349     const uint8_t *uint8 = dhcp_msg_get(msg, code, offset, sizeof *uint8);
 350     if (uint8) {
 351         *out = *uint8;
 352         return true;
 353     } else {
 354         return false;
 355     }
 356 }
 357
 358 /* Stores in '*out' the 16-bit value at offset 'offset' (in 2-byte units) in
 359  * the DHCP option in 'msg' represented by 'code' (which must be in the range
 360  * 0...DHCP_N_OPTIONS).  The value is converted to native byte order.  Returns
 361  * true if successful, false if the option has fewer than '2 * (offset + 1)'
 362  * bytes. */
 363 bool
 364 dhcp_msg_get_uint16(const struct dhcp_msg *msg, int code,
 365                     size_t offset, uint16_t *out)
 366 {
 367     const uint16_t *uint16 = dhcp_msg_get(msg, code, offset * sizeof *uint16,
 368                                           sizeof *uint16);
 369     if (uint16) {
 370         *out = ntohs(*uint16);
 371         return true;
 372     } else {
 373         return false;
 374     }
 375 }
 376
 377 /* Appends a string representing 'duration' seconds to 'ds'. */
 378 static void
 379 put_duration(struct ds *ds, unsigned int duration)
 380 {
 381     if (duration) {
 382         if (duration >= 86400) {
 383             ds_put_format(ds, "%ud", duration / 86400);
 384             duration %= 86400;
 385         }
 386         if (duration >= 3600) {
 387             ds_put_format(ds, "%uh", duration / 3600);
 388             duration %= 3600;
 389         }
 390         if (duration >= 60) {
 391             ds_put_format(ds, "%umin", duration / 60);
 392             duration %= 60;
 393         }
 394         if (duration > 0) {
 395             ds_put_format(ds, "%us", duration);
 396         }
 397     } else {
 398         ds_put_cstr(ds, "0s");
 399     }
 400 }
 401
 402 /* Appends a string representation of 'opt', which has the given 'code', to
 403  * 'ds'. */
 404 const char *
 405 dhcp_option_to_string(const struct dhcp_option *opt, int code, struct ds *ds)
 406 {
 407     struct option_class *class = &classes[code];
 408     const struct arg_type *type = &types[class->type];
 409     size_t offset;
 410
 411     if (class->name) {
 412         const char *cp;
 413         for (cp = class->name; *cp; cp++) {
 414             unsigned char c = *cp;
 415             ds_put_char(ds, c == '_' ? '-' : tolower(c));
 416         }
 417     } else {
 418         ds_put_format(ds, "option-%d", code);
 419     }
 420     ds_put_char(ds, '=');
 421
 422     if (class->type == DHCP_ARG_STRING) {
 423         ds_put_char(ds, '"');
 424     }
 425     for (offset = 0; offset + type->size <= opt->n; offset += type->size) {
 426         const void *p = (const char *) opt->data + offset;
 427         const uint8_t *uint8 = p;
 428         const uint32_t *uint32 = p;
 429         const uint16_t *uint16 = p;
 430         const char *cp = p;
 431         unsigned char c;
 432
 433         if (offset && class->type != DHCP_ARG_STRING) {
 434             ds_put_cstr(ds, class->type == DHCP_ARG_UINT8 ? ":" : ", ");
 435         }
 436         switch (class->type) {
 437         case DHCP_ARG_FIXED:
 438             NOT_REACHED();
 439         case DHCP_ARG_IP:
 440             ds_put_format(ds, IP_FMT, IP_ARGS(uint32));
 441             break;
 442         case DHCP_ARG_UINT8:
 443             ds_put_format(ds, "%02"PRIx8, *uint8);
 444             break;
 445         case DHCP_ARG_UINT16:
 446             ds_put_format(ds, "%"PRIu16, ntohs(*uint16));
 447             break;
 448         case DHCP_ARG_UINT32:
 449             ds_put_format(ds, "%"PRIu32, ntohl(*uint32));
 450             break;
 451         case DHCP_ARG_SECS:
 452             put_duration(ds, ntohl(*uint32));
 453             break;
 454         case DHCP_ARG_STRING:
 455             c = *cp;
 456             if (isprint(c) && (!isspace(c) || c == ' ') && c != '\\') {
 457                 ds_put_char(ds, *cp);
 458             } else {
 459                 ds_put_format(ds, "\\%03o", (int) c);
 460             }
 461             break;
 462         case DHCP_ARG_BOOLEAN:
 463             if (*uint8 == 0) {
 464                 ds_put_cstr(ds, "false");
 465             } else if (*uint8 == 1) {
 466                 ds_put_cstr(ds, "true");
 467             } else {
 468                 ds_put_format(ds, "**%"PRIu8"**", *uint8);
 469             }
 470             break;
 471         }
 472     }
 473     if (class->type == DHCP_ARG_STRING) {
 474         ds_put_char(ds, '"');
 475     }
 476     if (offset != opt->n) {
 477         if (offset) {
 478             ds_put_cstr(ds, ", ");
 479         }
 480         ds_put_cstr(ds, "**leftovers:");
 481         for (; offset < opt->n; offset++) {
 482             const void *p = (const char *) opt->data + offset;
 483             const uint8_t *uint8 = p;
 484             ds_put_format(ds, " %"PRIu8, *uint8);
 485         }
 486         ds_put_cstr(ds, "**");
 487     }
 488     return ds_cstr(ds);
 489 }
 490
 491 /* Replaces 'ds' by a string representation of 'msg'.  If 'multiline' is
 492  * false, 'ds' receives a single-line representation of 'msg', otherwise a
 493  * multiline representation. */
 494 const char *
 495 dhcp_msg_to_string(const struct dhcp_msg *msg, bool multiline, struct ds *ds)
 496 {
 497     char separator = multiline ? '\n' : ' ';
 498     int code;
 499
 500     ds_clear(ds);
 501     ds_put_format(ds, "op=%s",
 502                   (msg->op == DHCP_BOOTREQUEST ? "request"
 503                    : msg->op == DHCP_BOOTREPLY ? "reply"
 504                    : "error"));
 505     ds_put_format(ds, "%ctype=%s", separator, dhcp_type_name(msg->type));
 506     ds_put_format(ds, "%cxid=0x%08"PRIx32, separator, msg->xid);
 507     ds_put_format(ds, "%csecs=", separator);
 508     put_duration(ds, msg->secs);
 509     if (msg->flags) {
 510         ds_put_format(ds, "%cflags=", separator);
 511         if (msg->flags & DHCP_FLAGS_BROADCAST) {
 512             ds_put_cstr(ds, "[BROADCAST]");
 513         }
 514         if (msg->flags & DHCP_FLAGS_MBZ) {
 515             ds_put_format(ds, "[0x%04"PRIx16"]", msg->flags & DHCP_FLAGS_MBZ);
 516         }
 517     }
 518     if (msg->ciaddr) {
 519         ds_put_format(ds, "%cciaddr="IP_FMT, separator, IP_ARGS(&msg->ciaddr));
 520     }
 521     if (msg->yiaddr) {
 522         ds_put_format(ds, "%cyiaddr="IP_FMT, separator, IP_ARGS(&msg->yiaddr));
 523     }
 524     if (msg->siaddr) {
 525         ds_put_format(ds, "%csiaddr="IP_FMT, separator, IP_ARGS(&msg->siaddr));
 526     }
 527     if (msg->giaddr) {
 528         ds_put_format(ds, "%cgiaddr="IP_FMT, separator, IP_ARGS(&msg->giaddr));
 529     }
 530     ds_put_format(ds, "%cchaddr="ETH_ADDR_FMT,
 531                   separator, ETH_ADDR_ARGS(msg->chaddr));
 532
 533     for (code = 0; code < DHCP_N_OPTIONS; code++) {
 534         const struct dhcp_option *opt = &msg->options[code];
 535         if (opt->data) {
 536             ds_put_char(ds, separator);
 537             dhcp_option_to_string(opt, code, ds);
 538         }
 539     }
 540     if (multiline) {
 541         ds_put_char(ds, separator);
 542     }
 543     return ds_cstr(ds);
 544 }
 545
 546 static void
 547 parse_options(struct dhcp_msg *msg, const char *name, void *data, size_t size,
 548               int option_offset)
 549 {
 550     struct buffer b;
 551
 552     b.data = data;
 553     b.size = size;
 554     for (;;) {
 555         uint8_t *code, *len;
 556         void *payload;
 557
 558         code = buffer_try_pull(&b, 1);
 559         if (!code || *code == DHCP_CODE_END) {
 560             break;
 561         } else if (*code == DHCP_CODE_PAD) {
 562             continue;
 563         }
 564
 565         len = buffer_try_pull(&b, 1);
 566         if (!len) {
 567             VLOG_DBG("reached end of %s expecting length byte", name);
 568             break;
 569         }
 570
 571         payload = buffer_try_pull(&b, *len);
 572         if (!payload) {
 573             VLOG_DBG("expected %"PRIu8" bytes of option-%"PRIu8" payload "
 574                      "with only %zu bytes of %s left",
 575                      *len, *code, b.size, name);
 576             break;
 577         }
 578         dhcp_msg_put(msg, *code + option_offset, payload, *len);
 579     }
 580 }
 581
 582 static void
 583 validate_options(struct dhcp_msg *msg)
 584 {
 585     int code;
 586
 587     for (code = 0; code < DHCP_N_OPTIONS; code++) {
 588         struct dhcp_option *opt = &msg->options[code];
 589         struct option_class *class = &classes[code];
 590         struct arg_type *type = &types[class->type];
 591         if (opt->data) {
 592             size_t n_elems = opt->n / type->size;
 593             size_t remainder = opt->n % type->size;
 594             bool ok = true;
 595             if (remainder) {
 596                 VLOG_DBG("%s option has %zu %zu-byte %s arguments with "
 597                          "%zu bytes left over",
 598                          class->name, n_elems, type->size,
 599                          type->name, remainder);
 600                 ok = false;
 601             }
 602             if (n_elems < class->min_args || n_elems > class->max_args) {
 603                 VLOG_DBG("%s option has %zu %zu-byte %s arguments but "
 604                          "between %zu and %zu are required",
 605                          class->name, n_elems, type->size, type->name,
 606                          class->min_args, class->max_args);
 607                 ok = false;
 608             }
 609             if (!ok) {
 610                 struct ds ds = DS_EMPTY_INITIALIZER;
 611                 VLOG_DBG("%s option contains: %s",
 612                          class->name, dhcp_option_to_string(opt, code, &ds));
 613                 ds_destroy(&ds);
 614
 615                 opt->n = 0;
 616                 opt->data = NULL;
 617             }
 618         }
 619     }
 620 }
 621
 622 /* Attempts to parse 'b' as a DHCP message.  If successful, initializes '*msg'
 623  * to the parsed message and returns 0.  Otherwise, returns a positive errno
 624  * value and '*msg' is indeterminate. */
 625 int
 626 dhcp_parse(struct dhcp_msg *msg, const struct buffer *b_)
 627 {
 628     struct buffer b = *b_;
 629     struct dhcp_header *dhcp;
 630     uint32_t *cookie;
 631     uint8_t type;
 632     char *vendor_class;
 633
 634     dhcp = buffer_try_pull(&b, sizeof *dhcp);
 635     if (!dhcp) {
 636         VLOG_DBG("buffer too small for DHCP header (%zu bytes)", b.size);
 637         goto error;
 638     }
 639
 640     if (dhcp->op != DHCP_BOOTREPLY && dhcp->op != DHCP_BOOTREQUEST) {
 641         VLOG_DBG("invalid DHCP op (%"PRIu8")", dhcp->op);
 642         goto error;
 643     }
 644     if (dhcp->htype != ARP_HRD_ETHERNET) {
 645         VLOG_DBG("invalid DHCP htype (%"PRIu8")", dhcp->htype);
 646         goto error;
 647     }
 648     if (dhcp->hlen != ETH_ADDR_LEN) {
 649         VLOG_DBG("invalid DHCP hlen (%"PRIu8")", dhcp->hlen);
 650         goto error;
 651     }
 652
 653     dhcp_msg_init(msg);
 654     msg->op = dhcp->op;
 655     msg->xid = ntohl(dhcp->xid);
 656     msg->secs = ntohs(dhcp->secs);
 657     msg->flags = ntohs(dhcp->flags);
 658     msg->ciaddr = dhcp->ciaddr;
 659     msg->yiaddr = dhcp->yiaddr;
 660     msg->siaddr = dhcp->siaddr;
 661     msg->giaddr = dhcp->giaddr;
 662     memcpy(msg->chaddr, dhcp->chaddr, ETH_ADDR_LEN);
 663
 664     cookie = buffer_try_pull(&b, sizeof cookie);
 665     if (cookie) {
 666         if (ntohl(*cookie) == DHCP_OPTS_COOKIE) {
 667             uint8_t overload;
 668
 669             parse_options(msg, "options", b.data, b.size, 0);
 670             if (dhcp_msg_get_uint8(msg, DHCP_CODE_OPTION_OVERLOAD,
 671                                    0, &overload)) {
 672                 if (overload & 1) {
 673                     parse_options(msg, "file", dhcp->file, sizeof dhcp->file,
 674                                   0);
 675                 }
 676                 if (overload & 2) {
 677                     parse_options(msg, "sname",
 678                                   dhcp->sname, sizeof dhcp->sname, 0);
 679                 }
 680             }
 681         } else {
 682             VLOG_DBG("bad DHCP options cookie: %08"PRIx32, ntohl(*cookie));
 683         }
 684     } else {
 685         VLOG_DBG("DHCP packet has no options");
 686     }
 687
 688     vendor_class = dhcp_msg_get_string(msg, DHCP_CODE_VENDOR_CLASS);
 689     if (vendor_class && !strcmp(vendor_class, "OpenFlow")) {
 690         parse_options(msg, "vendor-specific",
 691                       msg->options[DHCP_CODE_VENDOR_SPECIFIC].data,
 692                       msg->options[DHCP_CODE_VENDOR_SPECIFIC].n,
 693                       DHCP_VENDOR_OFS);
 694     }
 695     free(vendor_class);
 696
 697     validate_options(msg);
 698     if (!dhcp_msg_get_uint8(msg, DHCP_CODE_DHCP_MSG_TYPE, 0, &type)) {
 699         VLOG_DBG("missing DHCP message type");
 700         dhcp_msg_uninit(msg);
 701         goto error;
 702     }
 703     msg->type = type;
 704     return 0;
 705
 706 error:
 707     if (VLOG_IS_DBG_ENABLED()) {
 708         struct ds ds;
 709
 710         ds_init(&ds);
 711         ds_put_hex_dump(&ds, b_->data, b_->size, 0, true);
 712         VLOG_DBG("invalid DHCP message dump:\n%s", ds_cstr(&ds));
 713
 714         ds_clear(&ds);
 715         dhcp_msg_to_string(msg, false, &ds);
 716         VLOG_DBG("partially dissected DHCP message: %s", ds_cstr(&ds));
 717
 718         ds_destroy(&ds);
 719     }
 720     return EPROTO;
 721 }
 722
 723 static void
 724 put_option_chunk(struct buffer *b, uint8_t code, void *data, size_t n)
 725 {
 726     uint8_t header[2];
 727
 728     assert(n < 256);
 729     header[0] = code;
 730     header[1] = n;
 731     buffer_put(b, header, sizeof header);
 732     buffer_put(b, data, n);
 733 }
 734
 735 static void
 736 put_option(struct buffer *b, uint8_t code, void *data, size_t n)
 737 {
 738     if (data) {
 739         if (n) {
 740             /* Divide the data into chunks of 255 bytes or less.  Make
 741              * intermediate chunks multiples of 8 bytes in case the
 742              * recipient validates a chunk at a time instead of the
 743              * concatenated value. */
 744             uint8_t *p = data;
 745             while (n) {
 746                 size_t chunk = n > 255 ? 248 : n;
 747                 put_option_chunk(b, code, p, chunk);
 748                 p += chunk;
 749                 n -= chunk;
 750             }
 751         } else {
 752             /* Option should be present but carry no data. */
 753             put_option_chunk(b, code, NULL, 0);
 754         }
 755     }
 756 }
 757
 758 /* Appends to 'b' the DHCP message represented by 'msg'. */
 759 void
 760 dhcp_assemble(const struct dhcp_msg *msg, struct buffer *b)
 761 {
 762     const uint8_t end = DHCP_CODE_END;
 763     uint32_t cookie = htonl(DHCP_OPTS_COOKIE);
 764     struct buffer vnd_data;
 765     struct dhcp_header dhcp;
 766     int i;
 767
 768     memset(&dhcp, 0, sizeof dhcp);
 769     dhcp.op = msg->op;
 770     dhcp.htype = ARP_HRD_ETHERNET;
 771     dhcp.hlen = ETH_ADDR_LEN;
 772     dhcp.hops = 0;
 773     dhcp.xid = htonl(msg->xid);
 774     dhcp.secs = htons(msg->secs);
 775     dhcp.flags = htons(msg->flags);
 776     dhcp.ciaddr = msg->ciaddr;
 777     dhcp.yiaddr = msg->yiaddr;
 778     dhcp.siaddr = msg->siaddr;
 779     dhcp.giaddr = msg->giaddr;
 780     memcpy(dhcp.chaddr, msg->chaddr, ETH_ADDR_LEN);
 781     buffer_put(b, &dhcp, sizeof dhcp);
 782     buffer_put(b, &cookie, sizeof cookie);
 783
 784     /* Put DHCP message type first.  (The ordering is not required but it
 785      * seems polite.) */
 786     if (msg->type) {
 787         uint8_t type = msg->type;
 788         put_option(b, DHCP_CODE_DHCP_MSG_TYPE, &type, 1);
 789     }
 790
 791     /* Put the standard options. */
 792     for (i = 0; i < DHCP_VENDOR_OFS; i++) {
 793         const struct dhcp_option *option = &msg->options[i];
 794         put_option(b, i, option->data, option->n);
 795     }
 796
 797     /* Assemble vendor specific option and put it. */
 798     buffer_init(&vnd_data, 0);
 799     for (i = DHCP_VENDOR_OFS; i < DHCP_N_OPTIONS; i++) {
 800         const struct dhcp_option *option = &msg->options[i];
 801         put_option(&vnd_data, i - DHCP_VENDOR_OFS, option->data, option->n);
 802     }
 803     if (vnd_data.size) {
 804         put_option(b, DHCP_CODE_VENDOR_SPECIFIC, vnd_data.data, vnd_data.size);
 805     }
 806     buffer_uninit(&vnd_data);
 807
 808     /* Put end-of-options option. */
 809     buffer_put(b, &end, sizeof end);
 810 }
 811