1 /* $NetBSD: bootp.c,v 1.14 1998/02/16 11:10:54 drochner Exp $ */
4 * Copyright (c) 1992 Regents of the University of California.
7 * This software was developed by the Computer Systems Engineering group
8 * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
9 * contributed to Berkeley.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 4. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 * @(#) Header: bootp.c,v 1.4 93/09/11 03:13:51 leres Exp (LBL)
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
41 #include <sys/types.h>
42 #include <sys/endian.h>
43 #include <netinet/in.h>
44 #include <netinet/in_systm.h>
51 #define DHCP_ENV_NOVENDOR 1 /* do not parse vendor options */
52 #define DHCP_ENV_PXE 10 /* assume pxe vendor options */
53 #define DHCP_ENV_FREEBSD 11 /* assume freebsd vendor options */
54 /* set DHCP_ENV to one of the values above to export dhcp options to kenv */
55 #define DHCP_ENV DHCP_ENV_NO_VENDOR
63 struct in_addr servip;
67 static char vm_rfc1048[4] = VM_RFC1048;
69 static char vm_cmu[4] = VM_CMU;
73 static ssize_t bootpsend(struct iodesc *, void *, size_t);
74 static ssize_t bootprecv(struct iodesc *, void *, size_t, time_t);
75 static int vend_rfc1048(u_char *, u_int);
77 static void vend_cmu(u_char *);
80 #ifdef DHCP_ENV /* export the dhcp response to kenv */
82 static void setenv_(u_char *cp, u_char *ep, struct dhcp_opt *opts);
84 #define setenv_(a, b, c)
88 static char expected_dhcpmsgtype = -1, dhcp_ok;
89 struct in_addr dhcp_serverip;
92 /* Fetch required bootp infomation */
101 u_char header[HEADER_SIZE];
105 u_char header[HEADER_SIZE];
111 printf("bootp: socket=%d\n", sock);
116 if (!(d = socktodesc(sock))) {
117 printf("bootp: bad socket. %d\n", sock);
122 printf("bootp: d=%lx\n", (long)d);
126 bzero(bp, sizeof(*bp));
128 bp->bp_op = BOOTREQUEST;
129 bp->bp_htype = 1; /* 10Mb Ethernet (48 bits) */
131 bp->bp_xid = htonl(d->xid);
132 MACPY(d->myea, bp->bp_chaddr);
133 strncpy(bp->bp_file, bootfile, sizeof(bp->bp_file));
134 bcopy(vm_rfc1048, bp->bp_vend, sizeof(vm_rfc1048));
136 bp->bp_vend[4] = TAG_DHCP_MSGTYPE;
138 bp->bp_vend[6] = DHCPDISCOVER;
141 * If we are booting from PXE, we want to send the string
142 * 'PXEClient' to the DHCP server so you have the option of
143 * only responding to PXE aware dhcp requests.
145 if (flag & BOOTP_PXE) {
146 bp->bp_vend[7] = TAG_CLASSID;
148 bcopy("PXEClient", &bp->bp_vend[9], 9);
149 bp->bp_vend[18] = TAG_PARAM_REQ;
151 bp->bp_vend[20] = TAG_ROOTPATH;
152 bp->bp_vend[21] = TAG_TFTP_SERVER;
153 bp->bp_vend[22] = TAG_HOSTNAME;
154 bp->bp_vend[23] = TAG_SWAPSERVER;
155 bp->bp_vend[24] = TAG_GATEWAY;
156 bp->bp_vend[25] = TAG_SUBNET_MASK;
157 bp->bp_vend[26] = TAG_INTF_MTU;
158 bp->bp_vend[27] = TAG_SERVERID;
159 bp->bp_vend[28] = TAG_END;
161 bp->bp_vend[7] = TAG_END;
163 bp->bp_vend[4] = TAG_END;
166 d->myip.s_addr = INADDR_ANY;
167 d->myport = htons(IPPORT_BOOTPC);
168 d->destip.s_addr = INADDR_BROADCAST;
169 d->destport = htons(IPPORT_BOOTPS);
172 expected_dhcpmsgtype = DHCPOFFER;
177 bootpsend, bp, sizeof(*bp),
178 bootprecv, &rbuf.rbootp, sizeof(rbuf.rbootp))
180 printf("bootp: no reply\n");
187 bp->bp_vend[6] = DHCPREQUEST;
188 bp->bp_vend[7] = TAG_REQ_ADDR;
190 bcopy(&rbuf.rbootp.bp_yiaddr, &bp->bp_vend[9], 4);
191 bp->bp_vend[13] = TAG_SERVERID;
193 bcopy(&dhcp_serverip.s_addr, &bp->bp_vend[15], 4);
194 bp->bp_vend[19] = TAG_LEASETIME;
196 leasetime = htonl(300);
197 bcopy(&leasetime, &bp->bp_vend[21], 4);
198 if (flag & BOOTP_PXE) {
199 bp->bp_vend[25] = TAG_CLASSID;
201 bcopy("PXEClient", &bp->bp_vend[27], 9);
202 bp->bp_vend[36] = TAG_END;
204 bp->bp_vend[25] = TAG_END;
206 expected_dhcpmsgtype = DHCPACK;
209 bootpsend, bp, sizeof(*bp),
210 bootprecv, &rbuf.rbootp, sizeof(rbuf.rbootp))
212 printf("DHCPREQUEST failed\n");
218 myip = d->myip = rbuf.rbootp.bp_yiaddr;
219 servip = rbuf.rbootp.bp_siaddr;
220 if(rootip.s_addr == INADDR_ANY) rootip = servip;
221 bcopy(rbuf.rbootp.bp_file, bootfile, sizeof(bootfile));
222 bootfile[sizeof(bootfile) - 1] = '\0';
225 if (IN_CLASSA(ntohl(myip.s_addr)))
226 netmask = htonl(IN_CLASSA_NET);
227 else if (IN_CLASSB(ntohl(myip.s_addr)))
228 netmask = htonl(IN_CLASSB_NET);
230 netmask = htonl(IN_CLASSC_NET);
233 printf("'native netmask' is %s\n", intoa(netmask));
239 printf("mask: %s\n", intoa(netmask));
242 /* We need a gateway if root is on a different net */
243 if (!SAMENET(myip, rootip, netmask)) {
246 printf("need gateway for root ip\n");
250 /* Toss gateway if on a different net */
251 if (!SAMENET(myip, gateip, netmask)) {
254 printf("gateway ip (%s) bad\n", inet_ntoa(gateip));
259 /* Bump xid so next request will be unique. */
263 /* Transmit a bootp request */
265 bootpsend(d, pkt, len)
274 printf("bootpsend: d=%lx called.\n", (long)d);
278 bp->bp_secs = htons((u_short)(getsecs() - bot));
282 printf("bootpsend: calling sendudp\n");
285 return (sendudp(d, pkt, len));
289 bootprecv(d, pkt, len, tleft)
300 printf("bootp_recvoffer: called\n");
303 n = readudp(d, pkt, len, tleft);
304 if (n == -1 || n < sizeof(struct bootp) - BOOTP_VENDSIZE)
307 bp = (struct bootp *)pkt;
311 printf("bootprecv: checked. bp = 0x%lx, n = %d\n",
314 if (bp->bp_xid != htonl(d->xid)) {
317 printf("bootprecv: expected xid 0x%lx, got 0x%x\n",
318 d->xid, ntohl(bp->bp_xid));
326 printf("bootprecv: got one!\n");
329 /* Suck out vendor info */
330 if (bcmp(vm_rfc1048, bp->bp_vend, sizeof(vm_rfc1048)) == 0) {
331 if(vend_rfc1048(bp->bp_vend, sizeof(bp->bp_vend)) != 0)
334 #ifdef BOOTP_VEND_CMU
335 else if (bcmp(vm_cmu, bp->bp_vend, sizeof(vm_cmu)) == 0)
336 vend_cmu(bp->bp_vend);
339 printf("bootprecv: unknown vendor 0x%lx\n", (long)bp->bp_vend);
348 vend_rfc1048(cp, len)
359 printf("vend_rfc1048 bootp info. len=%d\n", len);
363 /* Step over magic cookie */
366 setenv_(cp, ep, NULL);
374 if (tag == TAG_SUBNET_MASK) {
375 bcopy(cp, &netmask, sizeof(netmask));
377 if (tag == TAG_GATEWAY) {
378 bcopy(cp, &gateip.s_addr, sizeof(gateip.s_addr));
380 if (tag == TAG_SWAPSERVER) {
381 /* let it override bp_siaddr */
382 bcopy(cp, &rootip.s_addr, sizeof(rootip.s_addr));
384 if (tag == TAG_ROOTPATH) {
385 if ((val = getenv("dhcp.root-path")) == NULL)
386 val = (const char *)cp;
387 strlcpy(rootpath, val, sizeof(rootpath));
389 if (tag == TAG_HOSTNAME) {
390 if ((val = getenv("dhcp.host-name")) == NULL)
391 val = (const char *)cp;
392 strlcpy(hostname, val, sizeof(hostname));
394 if (tag == TAG_INTF_MTU) {
395 if ((val = getenv("dhcp.interface-mtu")) != NULL) {
396 intf_mtu = (u_int)strtoul(val, NULL, 0);
398 intf_mtu = be16dec(cp);
402 if (tag == TAG_DHCP_MSGTYPE) {
403 if(*cp != expected_dhcpmsgtype)
407 if (tag == TAG_SERVERID) {
408 bcopy(cp, &dhcp_serverip.s_addr,
409 sizeof(dhcp_serverip.s_addr));
411 if (tag == TAG_TFTP_SERVER) {
412 bcopy(cp, &tftpip.s_addr,
413 sizeof(tftpip.s_addr));
421 #ifdef BOOTP_VEND_CMU
430 printf("vend_cmu bootp info.\n");
432 vp = (struct cmu_vend *)cp;
434 if (vp->v_smask.s_addr != 0) {
435 netmask = vp->v_smask.s_addr;
437 if (vp->v_dgate.s_addr != 0) {
438 gateip = vp->v_dgate;
445 * Parse DHCP options and store them into kenv variables.
446 * Original code from Danny Braniss, modifications by Luigi Rizzo.
448 * The parser is driven by tables which specify the type and name of
449 * each dhcp option and how it appears in kenv.
450 * The first entry in the list contains the prefix used to set the kenv
451 * name (including the . if needed), the last entry must have a 0 tag.
452 * Entries do not need to be sorted though it helps for readability.
454 * Certain vendor-specific tables can be enabled according to DHCP_ENV.
455 * Set it to 0 if you don't want any.
457 enum opt_fmt { __NONE = 0,
458 __8 = 1, __16 = 2, __32 = 4, /* Unsigned fields, value=size */
459 __IP, /* IPv4 address */
460 __TXT, /* C string */
461 __BYTES, /* byte sequence, printed %02x */
462 __INDIR, /* name=value */
463 __ILIST, /* name=value;name=value ... */
464 __VE, /* vendor specific, recurse */
473 static struct dhcp_opt vndr_opt[] = { /* Vendor Specific Options */
474 #if DHCP_ENV == DHCP_ENV_FREEBSD /* FreeBSD table in the original code */
475 {0, 0, "FreeBSD"}, /* prefix */
476 {1, __TXT, "kernel"},
477 {2, __TXT, "kernelname"},
478 {3, __TXT, "kernel_options"},
480 {5, __TXT, "conf-path"},
481 {6, __TXT, "rc.conf0"},
482 {7, __TXT, "rc.conf1"},
483 {8, __TXT, "rc.conf2"},
484 {9, __TXT, "rc.conf3"},
485 {10, __TXT, "rc.conf4"},
486 {11, __TXT, "rc.conf5"},
487 {12, __TXT, "rc.conf6"},
488 {13, __TXT, "rc.conf7"},
489 {14, __TXT, "rc.conf8"},
490 {15, __TXT, "rc.conf9"},
492 {20, __TXT, "boot.nfsroot.options"},
505 #elif DHCP_ENV == DHCP_ENV_PXE /* some pxe options, RFC4578 */
506 {0, 0, "pxe"}, /* prefix */
507 {93, __16, "system-architecture"},
508 {94, __BYTES, "network-interface"},
509 {97, __BYTES, "machine-identifier"},
510 #else /* default (empty) table */
511 {0, 0, "dhcp.vendor."}, /* prefix */
513 {0, __TXT, "%soption-%d"}
516 static struct dhcp_opt dhcp_opt[] = {
517 /* DHCP Option names, formats and codes, from RFC2132. */
518 {0, 0, "dhcp."}, // prefix
519 {1, __IP, "subnet-mask"},
520 {2, __32, "time-offset"}, /* this is signed */
521 {3, __IP, "routers"},
522 {4, __IP, "time-servers"},
523 {5, __IP, "ien116-name-servers"},
524 {6, __IP, "domain-name-servers"},
525 {7, __IP, "log-servers"},
526 {8, __IP, "cookie-servers"},
527 {9, __IP, "lpr-servers"},
528 {10, __IP, "impress-servers"},
529 {11, __IP, "resource-location-servers"},
530 {12, __TXT, "host-name"},
531 {13, __16, "boot-size"},
532 {14, __TXT, "merit-dump"},
533 {15, __TXT, "domain-name"},
534 {16, __IP, "swap-server"},
535 {17, __TXT, "root-path"},
536 {18, __TXT, "extensions-path"},
537 {19, __8, "ip-forwarding"},
538 {20, __8, "non-local-source-routing"},
539 {21, __IP, "policy-filter"},
540 {22, __16, "max-dgram-reassembly"},
541 {23, __8, "default-ip-ttl"},
542 {24, __32, "path-mtu-aging-timeout"},
543 {25, __16, "path-mtu-plateau-table"},
544 {26, __16, "interface-mtu"},
545 {27, __8, "all-subnets-local"},
546 {28, __IP, "broadcast-address"},
547 {29, __8, "perform-mask-discovery"},
548 {30, __8, "mask-supplier"},
549 {31, __8, "perform-router-discovery"},
550 {32, __IP, "router-solicitation-address"},
551 {33, __IP, "static-routes"},
552 {34, __8, "trailer-encapsulation"},
553 {35, __32, "arp-cache-timeout"},
554 {36, __8, "ieee802-3-encapsulation"},
555 {37, __8, "default-tcp-ttl"},
556 {38, __32, "tcp-keepalive-interval"},
557 {39, __8, "tcp-keepalive-garbage"},
558 {40, __TXT, "nis-domain"},
559 {41, __IP, "nis-servers"},
560 {42, __IP, "ntp-servers"},
561 {43, __VE, "vendor-encapsulated-options"},
562 {44, __IP, "netbios-name-servers"},
563 {45, __IP, "netbios-dd-server"},
564 {46, __8, "netbios-node-type"},
565 {47, __TXT, "netbios-scope"},
566 {48, __IP, "x-font-servers"},
567 {49, __IP, "x-display-managers"},
568 {50, __IP, "dhcp-requested-address"},
569 {51, __32, "dhcp-lease-time"},
570 {52, __8, "dhcp-option-overload"},
571 {53, __8, "dhcp-message-type"},
572 {54, __IP, "dhcp-server-identifier"},
573 {55, __8, "dhcp-parameter-request-list"},
574 {56, __TXT, "dhcp-message"},
575 {57, __16, "dhcp-max-message-size"},
576 {58, __32, "dhcp-renewal-time"},
577 {59, __32, "dhcp-rebinding-time"},
578 {60, __TXT, "vendor-class-identifier"},
579 {61, __TXT, "dhcp-client-identifier"},
580 {64, __TXT, "nisplus-domain"},
581 {65, __IP, "nisplus-servers"},
582 {66, __TXT, "tftp-server-name"},
583 {67, __TXT, "bootfile-name"},
584 {68, __IP, "mobile-ip-home-agent"},
585 {69, __IP, "smtp-server"},
586 {70, __IP, "pop-server"},
587 {71, __IP, "nntp-server"},
588 {72, __IP, "www-server"},
589 {73, __IP, "finger-server"},
590 {74, __IP, "irc-server"},
591 {75, __IP, "streettalk-server"},
592 {76, __IP, "streettalk-directory-assistance-server"},
593 {77, __TXT, "user-class"},
594 {85, __IP, "nds-servers"},
595 {86, __TXT, "nds-tree-name"},
596 {87, __TXT, "nds-context"},
597 {210, __TXT, "authenticate"},
599 /* use the following entries for arbitrary variables */
609 {0, __TXT, "%soption-%d"}
613 * parse a dhcp response, set environment variables translating options
614 * names and values according to the tables above. Also set dhcp.tags
615 * to the list of selected tags.
618 setenv_(u_char *cp, u_char *ep, struct dhcp_opt *opts)
622 char tags[512], *tp; /* the list of tags */
624 #define FLD_SEP ',' /* separator in list of elements */
631 unsigned int size; /* option size */
632 char *vp, *endv, buf[256]; /* the value buffer */
635 tag = *ncp++; /* extract tag and size */
637 cp = ncp; /* current payload */
638 ncp += size; /* point to the next option */
645 for (op = opts+1; op->tag && op->tag != tag; op++)
647 /* if not found we end up on the default entry */
650 * Copy data into the buffer. libstand does not have snprintf so we
651 * need to be careful with sprintf(). With strings, the source is
652 * always <256 char so shorter than the buffer so we are safe; with
653 * other arguments, the longest string is inet_ntoa which is 16 bytes
654 * so we make sure to have always enough room in the string before
659 endv = buf + sizeof(buf) - 1 - 16; /* last valid write position */
663 break; /* should not happen */
665 case __VE: /* recurse, vendor specific */
666 setenv_(cp, cp+size, vndr_opt);
669 case __IP: /* ip address */
670 for (; size > 0 && vp < endv; size -= 4, cp += 4) {
671 struct in_addr in_ip; /* ip addresses */
674 bcopy(cp, &in_ip.s_addr, sizeof(in_ip.s_addr));
675 sprintf(vp, "%s", inet_ntoa(in_ip));
680 case __BYTES: /* opaque byte string */
681 for (; size > 0 && vp < endv; size -= 1, cp += 1) {
682 sprintf(vp, "%02x", *cp);
688 bcopy(cp, buf, size); /* cannot overflow */
694 case __8: /* op->fmt is also the length of each field */
695 for (; size > 0 && vp < endv; size -= op->fmt, cp += op->fmt) {
698 v = (cp[0]<<24) + (cp[1]<<16) + (cp[2]<<8) + cp[3];
699 else if (op->fmt == __16)
700 v = (cp[0]<<8) + cp[1];
705 sprintf(vp, "%u", v);
710 case __INDIR: /* name=value */
711 case __ILIST: /* name=value;name=value... */
712 bcopy(cp, buf, size); /* cannot overflow */
714 for (endv = buf; endv; endv = vp) {
715 u_char *s = NULL; /* semicolon ? */
717 /* skip leading whitespace */
718 while (*endv && strchr(" \t\n\r", *endv))
720 vp = strchr(endv, '='); /* find name=value separator */
724 if (op->fmt == __ILIST && (s = strchr(vp, ';')))
727 vp = s; /* prepare for next round */
729 buf[0] = '\0'; /* option already done */
732 if (tp - tags < sizeof(tags) - 5) { /* add tag to the list */
735 sprintf(tp, "%d", tag);
739 char env[128]; /* the string name */
742 sprintf(env, op->desc, opts[0].desc, tag);
744 sprintf(env, "%s%s", opts[0].desc, op->desc);
746 * Do not replace existing values in the environment, so that
747 * locally-obtained values can override server-provided values.
753 char env[128]; /* the string name */
754 sprintf(env, "%stags", opts[0].desc);
755 setenv(env, tags, 1);
758 #endif /* additional dhcp */