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 * 3. 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$");
42 #include <sys/types.h>
43 #include <sys/limits.h>
44 #include <sys/endian.h>
45 #include <netinet/in.h>
46 #include <netinet/in_systm.h>
53 #define DHCP_ENV_NOVENDOR 1 /* do not parse vendor options */
54 #define DHCP_ENV_PXE 10 /* assume pxe vendor options */
55 #define DHCP_ENV_FREEBSD 11 /* assume freebsd vendor options */
56 /* set DHCP_ENV to one of the values above to export dhcp options to kenv */
57 #define DHCP_ENV DHCP_ENV_NO_VENDOR
65 struct in_addr servip;
69 static char vm_rfc1048[4] = VM_RFC1048;
71 static char vm_cmu[4] = VM_CMU;
75 static ssize_t bootpsend(struct iodesc *, void *, size_t);
76 static ssize_t bootprecv(struct iodesc *, void **, void **, time_t, void *);
77 static int vend_rfc1048(u_char *, u_int);
79 static void vend_cmu(u_char *);
82 #ifdef DHCP_ENV /* export the dhcp response to kenv */
84 static void setenv_(u_char *cp, u_char *ep, struct dhcp_opt *opts);
86 #define setenv_(a, b, c)
90 static char expected_dhcpmsgtype = -1, dhcp_ok;
91 struct in_addr dhcp_serverip;
93 struct bootp *bootp_response;
94 size_t bootp_response_size;
97 bootp_fill_request(unsigned char *bp_vend)
100 * We are booting from PXE, we want to send the string
101 * 'PXEClient' to the DHCP server so you have the option of
102 * only responding to PXE aware dhcp requests.
104 bp_vend[0] = TAG_CLASSID;
106 bcopy("PXEClient", &bp_vend[2], 9);
107 bp_vend[11] = TAG_USER_CLASS;
108 /* len of each user class + number of user class */
110 /* len of the first user class */
112 bcopy("FreeBSD", &bp_vend[14], 7);
113 bp_vend[21] = TAG_PARAM_REQ;
115 bp_vend[23] = TAG_ROOTPATH;
116 bp_vend[24] = TAG_HOSTNAME;
117 bp_vend[25] = TAG_SWAPSERVER;
118 bp_vend[26] = TAG_GATEWAY;
119 bp_vend[27] = TAG_SUBNET_MASK;
120 bp_vend[28] = TAG_INTF_MTU;
121 bp_vend[29] = TAG_SERVERID;
122 bp_vend[30] = TAG_END;
125 /* Fetch required bootp infomation */
133 u_char header[HEADER_SIZE];
136 struct bootp *rbootp;
140 printf("bootp: socket=%d\n", sock);
145 if (!(d = socktodesc(sock))) {
146 printf("bootp: bad socket. %d\n", sock);
151 printf("bootp: d=%lx\n", (long)d);
155 bzero(bp, sizeof(*bp));
157 bp->bp_op = BOOTREQUEST;
158 bp->bp_htype = 1; /* 10Mb Ethernet (48 bits) */
160 bp->bp_xid = htonl(d->xid);
161 MACPY(d->myea, bp->bp_chaddr);
162 strncpy(bp->bp_file, bootfile, sizeof(bp->bp_file));
163 bcopy(vm_rfc1048, bp->bp_vend, sizeof(vm_rfc1048));
165 bp->bp_vend[4] = TAG_DHCP_MSGTYPE;
167 bp->bp_vend[6] = DHCPDISCOVER;
168 bootp_fill_request(&bp->bp_vend[7]);
171 bp->bp_vend[4] = TAG_END;
174 d->myip.s_addr = INADDR_ANY;
175 d->myport = htons(IPPORT_BOOTPC);
176 d->destip.s_addr = INADDR_BROADCAST;
177 d->destport = htons(IPPORT_BOOTPS);
180 expected_dhcpmsgtype = DHCPOFFER;
185 bootpsend, bp, sizeof(*bp),
186 bootprecv, &pkt, (void **)&rbootp, NULL) == -1) {
187 printf("bootp: no reply\n");
194 bp->bp_vend[6] = DHCPREQUEST;
195 bp->bp_vend[7] = TAG_REQ_ADDR;
197 bcopy(&rbootp->bp_yiaddr, &bp->bp_vend[9], 4);
198 bp->bp_vend[13] = TAG_SERVERID;
200 bcopy(&dhcp_serverip.s_addr, &bp->bp_vend[15], 4);
201 bp->bp_vend[19] = TAG_LEASETIME;
203 leasetime = htonl(300);
204 bcopy(&leasetime, &bp->bp_vend[21], 4);
205 bootp_fill_request(&bp->bp_vend[25]);
207 expected_dhcpmsgtype = DHCPACK;
211 bootpsend, bp, sizeof(*bp),
212 bootprecv, &pkt, (void **)&rbootp, NULL) == -1) {
213 printf("DHCPREQUEST failed\n");
219 myip = d->myip = rbootp->bp_yiaddr;
220 servip = rbootp->bp_siaddr;
221 if (rootip.s_addr == INADDR_ANY)
223 bcopy(rbootp->bp_file, bootfile, sizeof(bootfile));
224 bootfile[sizeof(bootfile) - 1] = '\0';
227 if (IN_CLASSA(ntohl(myip.s_addr)))
228 netmask = htonl(IN_CLASSA_NET);
229 else if (IN_CLASSB(ntohl(myip.s_addr)))
230 netmask = htonl(IN_CLASSB_NET);
232 netmask = htonl(IN_CLASSC_NET);
235 printf("'native netmask' is %s\n", intoa(netmask));
241 printf("mask: %s\n", intoa(netmask));
244 /* We need a gateway if root is on a different net */
245 if (!SAMENET(myip, rootip, netmask)) {
248 printf("need gateway for root ip\n");
252 /* Toss gateway if on a different net */
253 if (!SAMENET(myip, gateip, netmask)) {
256 printf("gateway ip (%s) bad\n", inet_ntoa(gateip));
261 /* Bump xid so next request will be unique. */
266 /* Transmit a bootp request */
268 bootpsend(struct iodesc *d, void *pkt, size_t 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(struct iodesc *d, void **pkt, void **payload, time_t tleft,
298 printf("bootp_recvoffer: called\n");
302 n = readudp(d, &ptr, (void **)&bp, tleft);
303 if (n == -1 || n < sizeof(struct bootp) - BOOTP_VENDSIZE)
308 printf("bootprecv: checked. bp = %p, n = %zd\n", bp, n);
310 if (bp->bp_xid != htonl(d->xid)) {
313 printf("bootprecv: expected xid 0x%lx, got 0x%x\n",
314 d->xid, ntohl(bp->bp_xid));
322 printf("bootprecv: got one!\n");
325 /* Suck out vendor info */
326 if (bcmp(vm_rfc1048, bp->bp_vend, sizeof(vm_rfc1048)) == 0) {
327 int vsize = n - offsetof(struct bootp, bp_vend);
328 if (vend_rfc1048(bp->bp_vend, vsize) != 0)
331 /* Save copy of bootp reply or DHCP ACK message */
332 if (bp->bp_op == BOOTREPLY &&
333 ((dhcp_ok == 1 && expected_dhcpmsgtype == DHCPACK) ||
335 free(bootp_response);
336 bootp_response = malloc(n);
337 if (bootp_response != NULL) {
338 bootp_response_size = n;
339 bcopy(bp, bootp_response, bootp_response_size);
343 #ifdef BOOTP_VEND_CMU
344 else if (bcmp(vm_cmu, bp->bp_vend, sizeof(vm_cmu)) == 0)
345 vend_cmu(bp->bp_vend);
348 printf("bootprecv: unknown vendor 0x%lx\n", (long)bp->bp_vend);
360 vend_rfc1048(u_char *cp, u_int len)
369 printf("vend_rfc1048 bootp info. len=%d\n", len);
373 /* Step over magic cookie */
376 setenv_(cp, ep, NULL);
384 if (tag == TAG_SUBNET_MASK) {
385 bcopy(cp, &netmask, sizeof(netmask));
387 if (tag == TAG_GATEWAY) {
388 bcopy(cp, &gateip.s_addr, sizeof(gateip.s_addr));
390 if (tag == TAG_SWAPSERVER) {
391 /* let it override bp_siaddr */
392 bcopy(cp, &rootip.s_addr, sizeof(rootip.s_addr));
394 if (tag == TAG_ROOTPATH) {
395 if ((val = getenv("dhcp.root-path")) == NULL)
396 val = (const char *)cp;
397 strlcpy(rootpath, val, sizeof(rootpath));
399 if (tag == TAG_HOSTNAME) {
400 if ((val = getenv("dhcp.host-name")) == NULL)
401 val = (const char *)cp;
402 strlcpy(hostname, val, sizeof(hostname));
404 if (tag == TAG_INTF_MTU) {
406 if ((val = getenv("dhcp.interface-mtu")) != NULL) {
412 * Do not allow MTU to exceed max IPv4 packet
413 * size, max value of 16-bit word.
415 tmp = strtoul(val, &end, 0);
417 *val == '\0' || *end != '\0' ||
419 printf("%s: bad value: \"%s\", "
421 "dhcp.interface-mtu", val);
423 intf_mtu = (u_int)tmp;
427 intf_mtu = be16dec(cp);
430 if (tag == TAG_DHCP_MSGTYPE) {
431 if(*cp != expected_dhcpmsgtype)
435 if (tag == TAG_SERVERID) {
436 bcopy(cp, &dhcp_serverip.s_addr,
437 sizeof(dhcp_serverip.s_addr));
445 #ifdef BOOTP_VEND_CMU
453 printf("vend_cmu bootp info.\n");
455 vp = (struct cmu_vend *)cp;
457 if (vp->v_smask.s_addr != 0) {
458 netmask = vp->v_smask.s_addr;
460 if (vp->v_dgate.s_addr != 0) {
461 gateip = vp->v_dgate;
468 * Parse DHCP options and store them into kenv variables.
469 * Original code from Danny Braniss, modifications by Luigi Rizzo.
471 * The parser is driven by tables which specify the type and name of
472 * each dhcp option and how it appears in kenv.
473 * The first entry in the list contains the prefix used to set the kenv
474 * name (including the . if needed), the last entry must have a 0 tag.
475 * Entries do not need to be sorted though it helps for readability.
477 * Certain vendor-specific tables can be enabled according to DHCP_ENV.
478 * Set it to 0 if you don't want any.
480 enum opt_fmt { __NONE = 0,
481 __8 = 1, __16 = 2, __32 = 4, /* Unsigned fields, value=size */
482 __IP, /* IPv4 address */
483 __TXT, /* C string */
484 __BYTES, /* byte sequence, printed %02x */
485 __INDIR, /* name=value */
486 __ILIST, /* name=value;name=value ... */
487 __VE, /* vendor specific, recurse */
496 static struct dhcp_opt vndr_opt[] = { /* Vendor Specific Options */
497 #if DHCP_ENV == DHCP_ENV_FREEBSD /* FreeBSD table in the original code */
498 {0, 0, "FreeBSD"}, /* prefix */
499 {1, __TXT, "kernel"},
500 {2, __TXT, "kernelname"},
501 {3, __TXT, "kernel_options"},
503 {5, __TXT, "conf-path"},
504 {6, __TXT, "rc.conf0"},
505 {7, __TXT, "rc.conf1"},
506 {8, __TXT, "rc.conf2"},
507 {9, __TXT, "rc.conf3"},
508 {10, __TXT, "rc.conf4"},
509 {11, __TXT, "rc.conf5"},
510 {12, __TXT, "rc.conf6"},
511 {13, __TXT, "rc.conf7"},
512 {14, __TXT, "rc.conf8"},
513 {15, __TXT, "rc.conf9"},
515 {20, __TXT, "boot.nfsroot.options"},
528 #elif DHCP_ENV == DHCP_ENV_PXE /* some pxe options, RFC4578 */
529 {0, 0, "pxe"}, /* prefix */
530 {93, __16, "system-architecture"},
531 {94, __BYTES, "network-interface"},
532 {97, __BYTES, "machine-identifier"},
533 #else /* default (empty) table */
534 {0, 0, "dhcp.vendor."}, /* prefix */
536 {0, __TXT, "%soption-%d"}
539 static struct dhcp_opt dhcp_opt[] = {
540 /* DHCP Option names, formats and codes, from RFC2132. */
541 {0, 0, "dhcp."}, // prefix
542 {1, __IP, "subnet-mask"},
543 {2, __32, "time-offset"}, /* this is signed */
544 {3, __IP, "routers"},
545 {4, __IP, "time-servers"},
546 {5, __IP, "ien116-name-servers"},
547 {6, __IP, "domain-name-servers"},
548 {7, __IP, "log-servers"},
549 {8, __IP, "cookie-servers"},
550 {9, __IP, "lpr-servers"},
551 {10, __IP, "impress-servers"},
552 {11, __IP, "resource-location-servers"},
553 {12, __TXT, "host-name"},
554 {13, __16, "boot-size"},
555 {14, __TXT, "merit-dump"},
556 {15, __TXT, "domain-name"},
557 {16, __IP, "swap-server"},
558 {17, __TXT, "root-path"},
559 {18, __TXT, "extensions-path"},
560 {19, __8, "ip-forwarding"},
561 {20, __8, "non-local-source-routing"},
562 {21, __IP, "policy-filter"},
563 {22, __16, "max-dgram-reassembly"},
564 {23, __8, "default-ip-ttl"},
565 {24, __32, "path-mtu-aging-timeout"},
566 {25, __16, "path-mtu-plateau-table"},
567 {26, __16, "interface-mtu"},
568 {27, __8, "all-subnets-local"},
569 {28, __IP, "broadcast-address"},
570 {29, __8, "perform-mask-discovery"},
571 {30, __8, "mask-supplier"},
572 {31, __8, "perform-router-discovery"},
573 {32, __IP, "router-solicitation-address"},
574 {33, __IP, "static-routes"},
575 {34, __8, "trailer-encapsulation"},
576 {35, __32, "arp-cache-timeout"},
577 {36, __8, "ieee802-3-encapsulation"},
578 {37, __8, "default-tcp-ttl"},
579 {38, __32, "tcp-keepalive-interval"},
580 {39, __8, "tcp-keepalive-garbage"},
581 {40, __TXT, "nis-domain"},
582 {41, __IP, "nis-servers"},
583 {42, __IP, "ntp-servers"},
584 {43, __VE, "vendor-encapsulated-options"},
585 {44, __IP, "netbios-name-servers"},
586 {45, __IP, "netbios-dd-server"},
587 {46, __8, "netbios-node-type"},
588 {47, __TXT, "netbios-scope"},
589 {48, __IP, "x-font-servers"},
590 {49, __IP, "x-display-managers"},
591 {50, __IP, "dhcp-requested-address"},
592 {51, __32, "dhcp-lease-time"},
593 {52, __8, "dhcp-option-overload"},
594 {53, __8, "dhcp-message-type"},
595 {54, __IP, "dhcp-server-identifier"},
596 {55, __8, "dhcp-parameter-request-list"},
597 {56, __TXT, "dhcp-message"},
598 {57, __16, "dhcp-max-message-size"},
599 {58, __32, "dhcp-renewal-time"},
600 {59, __32, "dhcp-rebinding-time"},
601 {60, __TXT, "vendor-class-identifier"},
602 {61, __TXT, "dhcp-client-identifier"},
603 {64, __TXT, "nisplus-domain"},
604 {65, __IP, "nisplus-servers"},
605 {66, __TXT, "tftp-server-name"},
606 {67, __TXT, "bootfile-name"},
607 {68, __IP, "mobile-ip-home-agent"},
608 {69, __IP, "smtp-server"},
609 {70, __IP, "pop-server"},
610 {71, __IP, "nntp-server"},
611 {72, __IP, "www-server"},
612 {73, __IP, "finger-server"},
613 {74, __IP, "irc-server"},
614 {75, __IP, "streettalk-server"},
615 {76, __IP, "streettalk-directory-assistance-server"},
616 {77, __TXT, "user-class"},
617 {85, __IP, "nds-servers"},
618 {86, __TXT, "nds-tree-name"},
619 {87, __TXT, "nds-context"},
620 {210, __TXT, "authenticate"},
622 /* use the following entries for arbitrary variables */
632 {0, __TXT, "%soption-%d"}
636 * parse a dhcp response, set environment variables translating options
637 * names and values according to the tables above. Also set dhcp.tags
638 * to the list of selected tags.
641 setenv_(u_char *cp, u_char *ep, struct dhcp_opt *opts)
645 char tags[512], *tp; /* the list of tags */
647 #define FLD_SEP ',' /* separator in list of elements */
654 unsigned int size; /* option size */
655 char *vp, *endv, buf[256]; /* the value buffer */
658 tag = *ncp++; /* extract tag and size */
660 cp = ncp; /* current payload */
661 ncp += size; /* point to the next option */
668 for (op = opts+1; op->tag && op->tag != tag; op++)
670 /* if not found we end up on the default entry */
673 * Copy data into the buffer. libstand does not have snprintf so we
674 * need to be careful with sprintf(). With strings, the source is
675 * always <256 char so shorter than the buffer so we are safe; with
676 * other arguments, the longest string is inet_ntoa which is 16 bytes
677 * so we make sure to have always enough room in the string before
682 endv = buf + sizeof(buf) - 1 - 16; /* last valid write position */
686 break; /* should not happen */
688 case __VE: /* recurse, vendor specific */
689 setenv_(cp, cp+size, vndr_opt);
692 case __IP: /* ip address */
693 for (; size > 0 && vp < endv; size -= 4, cp += 4) {
694 struct in_addr in_ip; /* ip addresses */
697 bcopy(cp, &in_ip.s_addr, sizeof(in_ip.s_addr));
698 sprintf(vp, "%s", inet_ntoa(in_ip));
703 case __BYTES: /* opaque byte string */
704 for (; size > 0 && vp < endv; size -= 1, cp += 1) {
705 sprintf(vp, "%02x", *cp);
711 bcopy(cp, buf, size); /* cannot overflow */
717 case __8: /* op->fmt is also the length of each field */
718 for (; size > 0 && vp < endv; size -= op->fmt, cp += op->fmt) {
721 v = (cp[0]<<24) + (cp[1]<<16) + (cp[2]<<8) + cp[3];
722 else if (op->fmt == __16)
723 v = (cp[0]<<8) + cp[1];
728 sprintf(vp, "%u", v);
733 case __INDIR: /* name=value */
734 case __ILIST: /* name=value;name=value... */
735 bcopy(cp, buf, size); /* cannot overflow */
737 for (endv = buf; endv; endv = vp) {
738 char *s = NULL; /* semicolon ? */
740 /* skip leading whitespace */
741 while (*endv && strchr(" \t\n\r", *endv))
743 vp = strchr(endv, '='); /* find name=value separator */
747 if (op->fmt == __ILIST && (s = strchr(vp, ';')))
750 vp = s; /* prepare for next round */
752 buf[0] = '\0'; /* option already done */
755 if (tp - tags < sizeof(tags) - 5) { /* add tag to the list */
758 sprintf(tp, "%d", tag);
762 char env[128]; /* the string name */
765 sprintf(env, op->desc, opts[0].desc, tag);
767 sprintf(env, "%s%s", opts[0].desc, op->desc);
769 * Do not replace existing values in the environment, so that
770 * locally-obtained values can override server-provided values.
776 char env[128]; /* the string name */
777 sprintf(env, "%stags", opts[0].desc);
778 setenv(env, tags, 1);
781 #endif /* additional dhcp */