2 * Copyright (c) 1992 Regents of the University of California.
5 * This software was developed by the Computer Systems Engineering group
6 * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
7 * contributed to Berkeley.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 #include <sys/cdefs.h>
37 #include <sys/types.h>
38 #include <sys/limits.h>
39 #include <sys/endian.h>
40 #include <netinet/in.h>
41 #include <netinet/in_systm.h>
48 #define DHCP_ENV_NOVENDOR 1 /* do not parse vendor options */
49 #define DHCP_ENV_PXE 10 /* assume pxe vendor options */
50 #define DHCP_ENV_FREEBSD 11 /* assume freebsd vendor options */
51 /* set DHCP_ENV to one of the values above to export dhcp options to kenv */
52 #define DHCP_ENV DHCP_ENV_NO_VENDOR
60 struct in_addr servip
;
64 static char vm_rfc1048
[4] = VM_RFC1048
;
66 static char vm_cmu
[4] = VM_CMU
;
70 static ssize_t
bootpsend(struct iodesc
*, void *, size_t);
71 static ssize_t
bootprecv(struct iodesc
*, void **, void **, time_t);
72 static int vend_rfc1048(u_char
*, u_int
);
74 static void vend_cmu(u_char
*);
77 #ifdef DHCP_ENV /* export the dhcp response to kenv */
79 static void setenv_(u_char
*cp
, u_char
*ep
, struct dhcp_opt
*opts
);
81 #define setenv_(a, b, c)
85 static char expected_dhcpmsgtype
= -1, dhcp_ok
;
86 struct in_addr dhcp_serverip
;
88 struct bootp
*bootp_response
;
89 size_t bootp_response_size
;
92 bootp_fill_request(unsigned char *bp_vend
)
95 * We are booting from PXE, we want to send the string
96 * 'PXEClient' to the DHCP server so you have the option of
97 * only responding to PXE aware dhcp requests.
99 bp_vend
[0] = TAG_CLASSID
;
101 bcopy("PXEClient", &bp_vend
[2], 9);
102 bp_vend
[11] = TAG_USER_CLASS
;
103 /* len of each user class + number of user class */
105 /* len of the first user class */
107 bcopy("illumos", &bp_vend
[14], 7);
108 bp_vend
[21] = TAG_PARAM_REQ
;
110 bp_vend
[23] = TAG_SUBNET_MASK
;
111 bp_vend
[24] = TAG_GATEWAY
;
112 bp_vend
[25] = TAG_HOSTNAME
;
113 bp_vend
[26] = TAG_SWAPSERVER
;
114 bp_vend
[27] = TAG_ROOTPATH
;
115 bp_vend
[28] = TAG_INTF_MTU
;
116 bp_vend
[29] = TAG_SERVERID
;
117 bp_vend
[30] = TAG_END
;
120 /* Fetch required bootp infomation */
128 u_char header
[HEADER_SIZE
];
131 struct bootp
*rbootp
;
135 printf("bootp: socket=%d\n", sock
);
140 if (!(d
= socktodesc(sock
))) {
141 printf("bootp: bad socket. %d\n", sock
);
146 printf("bootp: d=%lx\n", (long)d
);
150 bzero(bp
, sizeof(*bp
));
152 bp
->bp_op
= BOOTREQUEST
;
153 bp
->bp_htype
= 1; /* 10Mb Ethernet (48 bits) */
155 bp
->bp_xid
= htonl(d
->xid
);
156 MACPY(d
->myea
, bp
->bp_chaddr
);
157 strncpy(bp
->bp_file
, bootfile
, sizeof(bp
->bp_file
));
158 bcopy(vm_rfc1048
, bp
->bp_vend
, sizeof(vm_rfc1048
));
160 bp
->bp_vend
[4] = TAG_DHCP_MSGTYPE
;
162 bp
->bp_vend
[6] = DHCPDISCOVER
;
163 bootp_fill_request(&bp
->bp_vend
[7]);
165 bp
->bp_vend
[4] = TAG_END
;
168 d
->myip
.s_addr
= INADDR_ANY
;
169 d
->myport
= htons(IPPORT_BOOTPC
);
170 d
->destip
.s_addr
= INADDR_BROADCAST
;
171 d
->destport
= htons(IPPORT_BOOTPS
);
174 expected_dhcpmsgtype
= DHCPOFFER
;
179 bootpsend
, bp
, sizeof(*bp
),
180 bootprecv
, &pkt
, (void **)&rbootp
) == -1) {
181 printf("bootp: no reply\n");
188 bp
->bp_vend
[6] = DHCPREQUEST
;
189 bp
->bp_vend
[7] = TAG_REQ_ADDR
;
191 bcopy(&rbootp
->bp_yiaddr
, &bp
->bp_vend
[9], 4);
192 bp
->bp_vend
[13] = TAG_SERVERID
;
194 bcopy(&dhcp_serverip
.s_addr
, &bp
->bp_vend
[15], 4);
195 bp
->bp_vend
[19] = TAG_LEASETIME
;
197 leasetime
= htonl(300);
198 bcopy(&leasetime
, &bp
->bp_vend
[21], 4);
199 bootp_fill_request(&bp
->bp_vend
[25]);
201 expected_dhcpmsgtype
= DHCPACK
;
205 bootpsend
, bp
, sizeof(*bp
),
206 bootprecv
, &pkt
, (void **)&rbootp
) == -1) {
207 printf("DHCPREQUEST failed\n");
213 myip
= d
->myip
= rbootp
->bp_yiaddr
;
214 servip
= rbootp
->bp_siaddr
;
215 if (rootip
.s_addr
== INADDR_ANY
)
217 bcopy(rbootp
->bp_file
, bootfile
, sizeof(bootfile
));
218 bootfile
[sizeof(bootfile
) - 1] = '\0';
221 if (IN_CLASSA(ntohl(myip
.s_addr
)))
222 netmask
= htonl(IN_CLASSA_NET
);
223 else if (IN_CLASSB(ntohl(myip
.s_addr
)))
224 netmask
= htonl(IN_CLASSB_NET
);
226 netmask
= htonl(IN_CLASSC_NET
);
229 printf("'native netmask' is %s\n", intoa(netmask
));
235 printf("mask: %s\n", intoa(netmask
));
238 /* We need a gateway if root is on a different net */
239 if (!SAMENET(myip
, rootip
, netmask
)) {
242 printf("need gateway for root ip\n");
246 /* Toss gateway if on a different net */
247 if (!SAMENET(myip
, gateip
, netmask
)) {
250 printf("gateway ip (%s) bad\n", inet_ntoa(gateip
));
255 /* Bump xid so next request will be unique. */
260 /* Transmit a bootp request */
262 bootpsend(struct iodesc
*d
, void *pkt
, size_t len
)
268 printf("bootpsend: d=%lx called.\n", (long)d
);
272 bp
->bp_secs
= htons((u_short
)(getsecs() - bot
));
276 printf("bootpsend: calling sendudp\n");
279 return (sendudp(d
, pkt
, len
));
283 bootprecv(struct iodesc
*d
, void **pkt
, void **payload
, time_t tleft
)
291 printf("bootp_recvoffer: called\n");
295 n
= readudp(d
, &ptr
, (void **)&bp
, tleft
);
296 if (n
== -1 || n
< sizeof(struct bootp
) - BOOTP_VENDSIZE
)
301 printf("bootprecv: checked. bp = %p, n = %zd\n", bp
, n
);
303 if (bp
->bp_xid
!= htonl(d
->xid
)) {
306 printf("bootprecv: expected xid 0x%lx, got 0x%x\n",
307 d
->xid
, ntohl(bp
->bp_xid
));
315 printf("bootprecv: got one!\n");
318 /* Suck out vendor info */
319 if (bcmp(vm_rfc1048
, bp
->bp_vend
, sizeof(vm_rfc1048
)) == 0) {
320 int vsize
= n
- offsetof(struct bootp
, bp_vend
);
321 if(vend_rfc1048(bp
->bp_vend
, vsize
) != 0)
324 /* Save copy of bootp reply or DHCP ACK message */
325 if (bp
->bp_op
== BOOTREPLY
&&
326 ((dhcp_ok
== 1 && expected_dhcpmsgtype
== DHCPACK
) ||
328 free(bootp_response
);
329 bootp_response
= malloc(n
);
330 if (bootp_response
!= NULL
) {
331 bootp_response_size
= n
;
332 bcopy(bp
, bootp_response
, bootp_response_size
);
336 #ifdef BOOTP_VEND_CMU
337 else if (bcmp(vm_cmu
, bp
->bp_vend
, sizeof(vm_cmu
)) == 0)
338 vend_cmu(bp
->bp_vend
);
341 printf("bootprecv: unknown vendor 0x%lx\n", (long)bp
->bp_vend
);
353 dhcp_try_rfc1048(uint8_t *cp
, size_t len
)
356 expected_dhcpmsgtype
= DHCPACK
;
357 if (bcmp(vm_rfc1048
, cp
, sizeof (vm_rfc1048
)) == 0) {
358 return (vend_rfc1048(cp
, len
));
364 vend_rfc1048(u_char
*cp
, u_int len
)
373 printf("vend_rfc1048 bootp info. len=%d\n", len
);
377 /* Step over magic cookie */
380 setenv_(cp
, ep
, NULL
);
388 if (tag
== TAG_SUBNET_MASK
) {
389 bcopy(cp
, &netmask
, sizeof(netmask
));
391 if (tag
== TAG_GATEWAY
) {
392 bcopy(cp
, &gateip
.s_addr
, sizeof(gateip
.s_addr
));
394 if (tag
== TAG_SWAPSERVER
) {
395 /* let it override bp_siaddr */
396 bcopy(cp
, &rootip
.s_addr
, sizeof(rootip
.s_addr
));
398 if (tag
== TAG_ROOTPATH
) {
399 if ((val
= getenv("dhcp.root-path")) == NULL
)
400 val
= (const char *)cp
;
401 strlcpy(rootpath
, val
, sizeof(rootpath
));
403 if (tag
== TAG_HOSTNAME
) {
404 if ((val
= getenv("dhcp.host-name")) == NULL
)
405 val
= (const char *)cp
;
406 strlcpy(hostname
, val
, sizeof(hostname
));
408 if (tag
== TAG_INTF_MTU
) {
410 if ((val
= getenv("dhcp.interface-mtu")) != NULL
) {
416 * Do not allow MTU to exceed max IPv4 packet
417 * size, max value of 16-bit word.
419 tmp
= strtoul(val
, &end
, 0);
421 *val
== '\0' || *end
!= '\0' ||
423 printf("%s: bad value: \"%s\", "
425 "dhcp.interface-mtu", val
);
427 intf_mtu
= (u_int
)tmp
;
431 intf_mtu
= be16dec(cp
);
434 if (tag
== TAG_DHCP_MSGTYPE
) {
435 if(*cp
!= expected_dhcpmsgtype
)
439 if (tag
== TAG_SERVERID
) {
440 bcopy(cp
, &dhcp_serverip
.s_addr
,
441 sizeof(dhcp_serverip
.s_addr
));
449 #ifdef BOOTP_VEND_CMU
457 printf("vend_cmu bootp info.\n");
459 vp
= (struct cmu_vend
*)cp
;
461 if (vp
->v_smask
.s_addr
!= 0) {
462 netmask
= vp
->v_smask
.s_addr
;
464 if (vp
->v_dgate
.s_addr
!= 0) {
465 gateip
= vp
->v_dgate
;
472 * Parse DHCP options and store them into kenv variables.
473 * Original code from Danny Braniss, modifications by Luigi Rizzo.
475 * The parser is driven by tables which specify the type and name of
476 * each dhcp option and how it appears in kenv.
477 * The first entry in the list contains the prefix used to set the kenv
478 * name (including the . if needed), the last entry must have a 0 tag.
479 * Entries do not need to be sorted though it helps for readability.
481 * Certain vendor-specific tables can be enabled according to DHCP_ENV.
482 * Set it to 0 if you don't want any.
484 enum opt_fmt
{ __NONE
= 0,
485 __8
= 1, __16
= 2, __32
= 4, /* Unsigned fields, value=size */
486 __IP
, /* IPv4 address */
487 __TXT
, /* C string */
488 __BYTES
, /* byte sequence, printed %02x */
489 __INDIR
, /* name=value */
490 __ILIST
, /* name=value;name=value ... */
491 __VE
, /* vendor specific, recurse */
500 static struct dhcp_opt vndr_opt
[] = { /* Vendor Specific Options */
501 #if DHCP_ENV == DHCP_ENV_FREEBSD /* FreeBSD table in the original code */
502 {0, 0, "FreeBSD"}, /* prefix */
503 {1, __TXT
, "kernel"},
504 {2, __TXT
, "kernelname"},
505 {3, __TXT
, "kernel_options"},
507 {5, __TXT
, "conf-path"},
508 {6, __TXT
, "rc.conf0"},
509 {7, __TXT
, "rc.conf1"},
510 {8, __TXT
, "rc.conf2"},
511 {9, __TXT
, "rc.conf3"},
512 {10, __TXT
, "rc.conf4"},
513 {11, __TXT
, "rc.conf5"},
514 {12, __TXT
, "rc.conf6"},
515 {13, __TXT
, "rc.conf7"},
516 {14, __TXT
, "rc.conf8"},
517 {15, __TXT
, "rc.conf9"},
519 {20, __TXT
, "boot.nfsroot.options"},
532 #elif DHCP_ENV == DHCP_ENV_PXE /* some pxe options, RFC4578 */
533 {0, 0, "pxe"}, /* prefix */
534 {93, __16
, "system-architecture"},
535 {94, __BYTES
, "network-interface"},
536 {97, __BYTES
, "machine-identifier"},
537 #else /* default (empty) table */
538 {0, 0, "dhcp.vendor."}, /* prefix */
540 {0, __TXT
, "%soption-%d"}
543 static struct dhcp_opt dhcp_opt
[] = {
544 /* DHCP Option names, formats and codes, from RFC2132. */
545 {0, 0, "dhcp."}, // prefix
546 {1, __IP
, "subnet-mask"},
547 {2, __32
, "time-offset"}, /* this is signed */
548 {3, __IP
, "routers"},
549 {4, __IP
, "time-servers"},
550 {5, __IP
, "ien116-name-servers"},
551 {6, __IP
, "domain-name-servers"},
552 {7, __IP
, "log-servers"},
553 {8, __IP
, "cookie-servers"},
554 {9, __IP
, "lpr-servers"},
555 {10, __IP
, "impress-servers"},
556 {11, __IP
, "resource-location-servers"},
557 {12, __TXT
, "host-name"},
558 {13, __16
, "boot-size"},
559 {14, __TXT
, "merit-dump"},
560 {15, __TXT
, "domain-name"},
561 {16, __IP
, "swap-server"},
562 {17, __TXT
, "root-path"},
563 {18, __TXT
, "extensions-path"},
564 {19, __8
, "ip-forwarding"},
565 {20, __8
, "non-local-source-routing"},
566 {21, __IP
, "policy-filter"},
567 {22, __16
, "max-dgram-reassembly"},
568 {23, __8
, "default-ip-ttl"},
569 {24, __32
, "path-mtu-aging-timeout"},
570 {25, __16
, "path-mtu-plateau-table"},
571 {26, __16
, "interface-mtu"},
572 {27, __8
, "all-subnets-local"},
573 {28, __IP
, "broadcast-address"},
574 {29, __8
, "perform-mask-discovery"},
575 {30, __8
, "mask-supplier"},
576 {31, __8
, "perform-router-discovery"},
577 {32, __IP
, "router-solicitation-address"},
578 {33, __IP
, "static-routes"},
579 {34, __8
, "trailer-encapsulation"},
580 {35, __32
, "arp-cache-timeout"},
581 {36, __8
, "ieee802-3-encapsulation"},
582 {37, __8
, "default-tcp-ttl"},
583 {38, __32
, "tcp-keepalive-interval"},
584 {39, __8
, "tcp-keepalive-garbage"},
585 {40, __TXT
, "nis-domain"},
586 {41, __IP
, "nis-servers"},
587 {42, __IP
, "ntp-servers"},
588 {43, __VE
, "vendor-encapsulated-options"},
589 {44, __IP
, "netbios-name-servers"},
590 {45, __IP
, "netbios-dd-server"},
591 {46, __8
, "netbios-node-type"},
592 {47, __TXT
, "netbios-scope"},
593 {48, __IP
, "x-font-servers"},
594 {49, __IP
, "x-display-managers"},
595 {50, __IP
, "dhcp-requested-address"},
596 {51, __32
, "dhcp-lease-time"},
597 {52, __8
, "dhcp-option-overload"},
598 {53, __8
, "dhcp-message-type"},
599 {54, __IP
, "dhcp-server-identifier"},
600 {55, __8
, "dhcp-parameter-request-list"},
601 {56, __TXT
, "dhcp-message"},
602 {57, __16
, "dhcp-max-message-size"},
603 {58, __32
, "dhcp-renewal-time"},
604 {59, __32
, "dhcp-rebinding-time"},
605 {60, __TXT
, "vendor-class-identifier"},
606 {61, __TXT
, "dhcp-client-identifier"},
607 {64, __TXT
, "nisplus-domain"},
608 {65, __IP
, "nisplus-servers"},
609 {66, __TXT
, "tftp-server-name"},
610 {67, __TXT
, "bootfile-name"},
611 {68, __IP
, "mobile-ip-home-agent"},
612 {69, __IP
, "smtp-server"},
613 {70, __IP
, "pop-server"},
614 {71, __IP
, "nntp-server"},
615 {72, __IP
, "www-server"},
616 {73, __IP
, "finger-server"},
617 {74, __IP
, "irc-server"},
618 {75, __IP
, "streettalk-server"},
619 {76, __IP
, "streettalk-directory-assistance-server"},
620 {77, __TXT
, "user-class"},
621 {85, __IP
, "nds-servers"},
622 {86, __TXT
, "nds-tree-name"},
623 {87, __TXT
, "nds-context"},
624 {210, __TXT
, "authenticate"},
626 /* use the following entries for arbitrary variables */
636 {0, __TXT
, "%soption-%d"}
640 * parse a dhcp response, set environment variables translating options
641 * names and values according to the tables above. Also set dhcp.tags
642 * to the list of selected tags.
645 setenv_(u_char
*cp
, u_char
*ep
, struct dhcp_opt
*opts
)
649 char tags
[512], *tp
; /* the list of tags */
651 #define FLD_SEP ',' /* separator in list of elements */
658 unsigned int size
; /* option size */
659 char *vp
, *endv
, buf
[256]; /* the value buffer */
662 tag
= *ncp
++; /* extract tag and size */
664 cp
= ncp
; /* current payload */
665 ncp
+= size
; /* point to the next option */
672 for (op
= opts
+1; op
->tag
&& op
->tag
!= tag
; op
++)
674 /* if not found we end up on the default entry */
677 * Copy data into the buffer. libstand does not have snprintf so we
678 * need to be careful with sprintf(). With strings, the source is
679 * always <256 char so shorter than the buffer so we are safe; with
680 * other arguments, the longest string is inet_ntoa which is 16 bytes
681 * so we make sure to have always enough room in the string before
686 endv
= buf
+ sizeof(buf
) - 1 - 16; /* last valid write position */
690 break; /* should not happen */
692 case __VE
: /* recurse, vendor specific */
693 setenv_(cp
, cp
+size
, vndr_opt
);
696 case __IP
: /* ip address */
697 for (; size
> 0 && vp
< endv
; size
-= 4, cp
+= 4) {
698 struct in_addr in_ip
; /* ip addresses */
701 bcopy(cp
, &in_ip
.s_addr
, sizeof(in_ip
.s_addr
));
702 sprintf(vp
, "%s", inet_ntoa(in_ip
));
707 case __BYTES
: /* opaque byte string */
708 for (; size
> 0 && vp
< endv
; size
-= 1, cp
+= 1) {
709 sprintf(vp
, "%02x", *cp
);
715 bcopy(cp
, buf
, size
); /* cannot overflow */
721 case __8
: /* op->fmt is also the length of each field */
722 for (; size
> 0 && vp
< endv
; size
-= op
->fmt
, cp
+= op
->fmt
) {
725 v
= (cp
[0]<<24) + (cp
[1]<<16) + (cp
[2]<<8) + cp
[3];
726 else if (op
->fmt
== __16
)
727 v
= (cp
[0]<<8) + cp
[1];
732 sprintf(vp
, "%u", v
);
737 case __INDIR
: /* name=value */
738 case __ILIST
: /* name=value;name=value... */
739 bcopy(cp
, buf
, size
); /* cannot overflow */
741 for (endv
= buf
; endv
; endv
= vp
) {
742 u_char
*s
= NULL
; /* semicolon ? */
744 /* skip leading whitespace */
745 while (*endv
&& strchr(" \t\n\r", *endv
))
747 vp
= strchr(endv
, '='); /* find name=value separator */
751 if (op
->fmt
== __ILIST
&& (s
= strchr(vp
, ';')))
754 vp
= s
; /* prepare for next round */
756 buf
[0] = '\0'; /* option already done */
759 if (tp
- tags
< sizeof(tags
) - 5) { /* add tag to the list */
762 sprintf(tp
, "%d", tag
);
766 char env
[128]; /* the string name */
769 sprintf(env
, op
->desc
, opts
[0].desc
, tag
);
771 sprintf(env
, "%s%s", opts
[0].desc
, op
->desc
);
773 * Do not replace existing values in the environment, so that
774 * locally-obtained values can override server-provided values.
780 char env
[128]; /* the string name */
781 sprintf(env
, "%stags", opts
[0].desc
);
782 setenv(env
, tags
, 1);
785 #endif /* additional dhcp */