xref: /freebsd/sbin/dhclient/dhcp.h (revision 1669d8afc64812c8d2d1d147ae1fd42ff441e1b1)
1 /*	$OpenBSD: dhcp.h,v 1.5 2004/05/04 15:49:49 deraadt Exp $	*/
2 /*	$FreeBSD$	*/
3 
4 /* Protocol structures... */
5 
6 /*
7  * Copyright (c) 1995, 1996 The Internet Software Consortium.
8  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  *
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 Internet Software Consortium nor the names
20  *    of its contributors may be used to endorse or promote products derived
21  *    from this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE INTERNET SOFTWARE CONSORTIUM AND
24  * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
25  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
26  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27  * DISCLAIMED.  IN NO EVENT SHALL THE INTERNET SOFTWARE CONSORTIUM OR
28  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
31  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
32  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
33  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
34  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  * This software has been written for the Internet Software Consortium
38  * by Ted Lemon <mellon@fugue.com> in cooperation with Vixie
39  * Enterprises.  To learn more about the Internet Software Consortium,
40  * see ``http://www.vix.com/isc''.  To learn more about Vixie
41  * Enterprises, see ``http://www.vix.com''.
42  */
43 
44 #define DHCP_UDP_OVERHEAD	(14 + /* Ethernet header */	\
45 				 20 + /* IP header */		\
46 				 8)   /* UDP header */
47 #define DHCP_SNAME_LEN		64
48 #define DHCP_FILE_LEN		128
49 #define DHCP_FIXED_NON_UDP	236
50 #define DHCP_FIXED_LEN		(DHCP_FIXED_NON_UDP + DHCP_UDP_OVERHEAD)
51 						/* Everything but options. */
52 #define DHCP_MTU_MAX		1500
53 #define DHCP_OPTION_LEN		(DHCP_MTU_MAX - DHCP_FIXED_LEN)
54 
55 #define BOOTP_MIN_LEN		300
56 #define DHCP_MIN_LEN		548
57 
58 struct dhcp_packet {
59 	u_int8_t  op;		/* Message opcode/type */
60 	u_int8_t  htype;	/* Hardware addr type (see net/if_types.h) */
61 	u_int8_t  hlen;		/* Hardware addr length */
62 	u_int8_t  hops;		/* Number of relay agent hops from client */
63 	u_int32_t xid;		/* Transaction ID */
64 	u_int16_t secs;		/* Seconds since client started looking */
65 	u_int16_t flags;	/* Flag bits */
66 	struct in_addr ciaddr;	/* Client IP address (if already in use) */
67 	struct in_addr yiaddr;	/* Client IP address */
68 	struct in_addr siaddr;	/* IP address of next server to talk to */
69 	struct in_addr giaddr;	/* DHCP relay agent IP address */
70 	unsigned char chaddr[16];	/* Client hardware address */
71 	char sname[DHCP_SNAME_LEN];	/* Server name */
72 	char file[DHCP_FILE_LEN];	/* Boot filename */
73 	unsigned char options[DHCP_OPTION_LEN];
74 				/* Optional parameters
75 				   (actual length dependent on MTU). */
76 };
77 
78 /* BOOTP (rfc951) message types */
79 #define BOOTREQUEST	1
80 #define BOOTREPLY	2
81 
82 /* Possible values for flags field... */
83 #define BOOTP_BROADCAST 32768L
84 
85 /* Possible values for hardware type (htype) field... */
86 #define HTYPE_ETHER	1		/* Ethernet			*/
87 #define HTYPE_IEEE802	6		/* IEEE 802.2 Token Ring...	*/
88 #define HTYPE_FDDI	8		/* FDDI...			*/
89 
90 /* Magic cookie validating dhcp options field (and bootp vendor
91    extensions field). */
92 #define DHCP_OPTIONS_COOKIE	"\143\202\123\143"
93 
94 /* DHCP Option codes: */
95 
96 #define DHO_PAD				0
97 #define DHO_SUBNET_MASK			1
98 #define DHO_TIME_OFFSET			2
99 #define DHO_ROUTERS			3
100 #define DHO_TIME_SERVERS		4
101 #define DHO_NAME_SERVERS		5
102 #define DHO_DOMAIN_NAME_SERVERS		6
103 #define DHO_LOG_SERVERS			7
104 #define DHO_COOKIE_SERVERS		8
105 #define DHO_LPR_SERVERS			9
106 #define DHO_IMPRESS_SERVERS		10
107 #define DHO_RESOURCE_LOCATION_SERVERS	11
108 #define DHO_HOST_NAME			12
109 #define DHO_BOOT_SIZE			13
110 #define DHO_MERIT_DUMP			14
111 #define DHO_DOMAIN_NAME			15
112 #define DHO_SWAP_SERVER			16
113 #define DHO_ROOT_PATH			17
114 #define DHO_EXTENSIONS_PATH		18
115 #define DHO_IP_FORWARDING		19
116 #define DHO_NON_LOCAL_SOURCE_ROUTING	20
117 #define DHO_POLICY_FILTER		21
118 #define DHO_MAX_DGRAM_REASSEMBLY	22
119 #define DHO_DEFAULT_IP_TTL		23
120 #define DHO_PATH_MTU_AGING_TIMEOUT	24
121 #define DHO_PATH_MTU_PLATEAU_TABLE	25
122 #define DHO_INTERFACE_MTU		26
123 #define DHO_ALL_SUBNETS_LOCAL		27
124 #define DHO_BROADCAST_ADDRESS		28
125 #define DHO_PERFORM_MASK_DISCOVERY	29
126 #define DHO_MASK_SUPPLIER		30
127 #define DHO_ROUTER_DISCOVERY		31
128 #define DHO_ROUTER_SOLICITATION_ADDRESS	32
129 #define DHO_STATIC_ROUTES		33
130 #define DHO_TRAILER_ENCAPSULATION	34
131 #define DHO_ARP_CACHE_TIMEOUT		35
132 #define DHO_IEEE802_3_ENCAPSULATION	36
133 #define DHO_DEFAULT_TCP_TTL		37
134 #define DHO_TCP_KEEPALIVE_INTERVAL	38
135 #define DHO_TCP_KEEPALIVE_GARBAGE	39
136 #define DHO_NIS_DOMAIN			40
137 #define DHO_NIS_SERVERS			41
138 #define DHO_NTP_SERVERS			42
139 #define DHO_VENDOR_ENCAPSULATED_OPTIONS	43
140 #define DHO_NETBIOS_NAME_SERVERS	44
141 #define DHO_NETBIOS_DD_SERVER		45
142 #define DHO_NETBIOS_NODE_TYPE		46
143 #define DHO_NETBIOS_SCOPE		47
144 #define DHO_FONT_SERVERS		48
145 #define DHO_X_DISPLAY_MANAGER		49
146 #define DHO_DHCP_REQUESTED_ADDRESS	50
147 #define DHO_DHCP_LEASE_TIME		51
148 #define DHO_DHCP_OPTION_OVERLOAD	52
149 #define DHO_DHCP_MESSAGE_TYPE		53
150 #define DHO_DHCP_SERVER_IDENTIFIER	54
151 #define DHO_DHCP_PARAMETER_REQUEST_LIST	55
152 #define DHO_DHCP_MESSAGE		56
153 #define DHO_DHCP_MAX_MESSAGE_SIZE	57
154 #define DHO_DHCP_RENEWAL_TIME		58
155 #define DHO_DHCP_REBINDING_TIME		59
156 #define DHO_DHCP_CLASS_IDENTIFIER	60
157 #define DHO_DHCP_CLIENT_IDENTIFIER	61
158 #define DHO_SMTP_SERVER			69
159 #define DHO_POP_SERVER			70
160 #define DHO_NNTP_SERVER			71
161 #define DHO_WWW_SERVER			72
162 #define DHO_FINGER_SERVER		73
163 #define DHO_IRC_SERVER			74
164 #define DHO_DHCP_USER_CLASS_ID		77
165 #define DHO_CLASSLESS_ROUTES		121
166 #define DHO_END				255
167 
168 /* DHCP message types. */
169 #define DHCPDISCOVER	1
170 #define DHCPOFFER	2
171 #define DHCPREQUEST	3
172 #define DHCPDECLINE	4
173 #define DHCPACK		5
174 #define DHCPNAK		6
175 #define DHCPRELEASE	7
176 #define DHCPINFORM	8
177