networking/udhcp/options.c

/* vi: set sw=4 ts=4: */
/*
 * options.c -- DHCP server option packet tools
 * Rewrite by Russ Dill <Russ.Dill@asu.edu> July 2001
 *
 * Licensed under GPLv2, see file LICENSE in this tarball for details.
 */

#include "common.h"
#include "dhcpd.h"
#include "options.h"


/* Supported options are easily added here */
const struct dhcp_option dhcp_options[] = {
	/* flags                                    code */
	{ OPTION_IP                   | OPTION_REQ, 0x01 }, /* DHCP_SUBNET        */
	{ OPTION_S32                              , 0x02 }, /* DHCP_TIME_OFFSET   */
	{ OPTION_IP | OPTION_LIST     | OPTION_REQ, 0x03 }, /* DHCP_ROUTER        */
	{ OPTION_IP | OPTION_LIST                 , 0x04 }, /* DHCP_TIME_SERVER   */
	{ OPTION_IP | OPTION_LIST                 , 0x05 }, /* DHCP_NAME_SERVER   */
	{ OPTION_IP | OPTION_LIST     | OPTION_REQ, 0x06 }, /* DHCP_DNS_SERVER    */
	{ OPTION_IP | OPTION_LIST                 , 0x07 }, /* DHCP_LOG_SERVER    */
	{ OPTION_IP | OPTION_LIST                 , 0x08 }, /* DHCP_COOKIE_SERVER */
	{ OPTION_IP | OPTION_LIST                 , 0x09 }, /* DHCP_LPR_SERVER    */
	{ OPTION_STRING               | OPTION_REQ, 0x0c }, /* DHCP_HOST_NAME     */
	{ OPTION_U16                              , 0x0d }, /* DHCP_BOOT_SIZE     */
	{ OPTION_STRING | OPTION_LIST | OPTION_REQ, 0x0f }, /* DHCP_DOMAIN_NAME   */
	{ OPTION_IP                               , 0x10 }, /* DHCP_SWAP_SERVER   */
	{ OPTION_STRING                           , 0x11 }, /* DHCP_ROOT_PATH     */
	{ OPTION_U8                               , 0x17 }, /* DHCP_IP_TTL        */
	{ OPTION_U16                              , 0x1a }, /* DHCP_MTU           */
	{ OPTION_IP                   | OPTION_REQ, 0x1c }, /* DHCP_BROADCAST     */
	{ OPTION_STRING                           , 0x28 }, /* nisdomain          */
	{ OPTION_IP | OPTION_LIST                 , 0x29 }, /* nissrv             */
	{ OPTION_IP | OPTION_LIST     | OPTION_REQ, 0x2a }, /* DHCP_NTP_SERVER    */
	{ OPTION_IP | OPTION_LIST                 , 0x2c }, /* DHCP_WINS_SERVER   */
	{ OPTION_IP                               , 0x32 }, /* DHCP_REQUESTED_IP  */
	{ OPTION_U32                              , 0x33 }, /* DHCP_LEASE_TIME    */
	{ OPTION_U8                               , 0x35 }, /* dhcptype           */
	{ OPTION_IP                               , 0x36 }, /* DHCP_SERVER_ID     */
	{ OPTION_STRING                           , 0x38 }, /* DHCP_MESSAGE       */
	{ OPTION_STRING                           , 0x3C }, /* DHCP_VENDOR        */
	{ OPTION_STRING                           , 0x3D }, /* DHCP_CLIENT_ID     */
	{ OPTION_STRING                           , 0x42 }, /* tftp               */
	{ OPTION_STRING                           , 0x43 }, /* bootfile           */
	{ OPTION_STRING                           , 0x4D }, /* userclass          */
#if ENABLE_FEATURE_UDHCP_RFC3397
	{ OPTION_STR1035 | OPTION_LIST            , 0x77 }, /* search             */
#endif
	{ OPTION_STATIC_ROUTES                    , 0x79 }, /* DHCP_STATIC_ROUTES */
	/* MSIE's "Web Proxy Autodiscovery Protocol" support */
	{ OPTION_STRING                           , 0xfc }, /* wpad               */

	/* Options below have no match in dhcp_option_strings[],
	 * are not passed to dhcpc scripts, and cannot be specified
	 * with "option XXX YYY" syntax in dhcpd config file. */

	{ OPTION_U16                              , 0x39 }, /* DHCP_MAX_SIZE      */
	{ 0, 0 } /* zeroed terminating entry */
};

/* Used for converting options from incoming packets to env variables
 * for udhcpc stript */
/* Must match dhcp_options[] order */
const char dhcp_option_strings[] ALIGN1 =
	"subnet" "\0"      /* DHCP_SUBNET         */
	"timezone" "\0"    /* DHCP_TIME_OFFSET    */
	"router" "\0"      /* DHCP_ROUTER         */
	"timesrv" "\0"     /* DHCP_TIME_SERVER    */
	"namesrv" "\0"     /* DHCP_NAME_SERVER    */
	"dns" "\0"         /* DHCP_DNS_SERVER     */
	"logsrv" "\0"      /* DHCP_LOG_SERVER     */
	"cookiesrv" "\0"   /* DHCP_COOKIE_SERVER  */
	"lprsrv" "\0"      /* DHCP_LPR_SERVER     */
	"hostname" "\0"    /* DHCP_HOST_NAME      */
	"bootsize" "\0"    /* DHCP_BOOT_SIZE      */
	"domain" "\0"      /* DHCP_DOMAIN_NAME    */
	"swapsrv" "\0"     /* DHCP_SWAP_SERVER    */
	"rootpath" "\0"    /* DHCP_ROOT_PATH      */
	"ipttl" "\0"       /* DHCP_IP_TTL         */
	"mtu" "\0"         /* DHCP_MTU            */
	"broadcast" "\0"   /* DHCP_BROADCAST      */
	"nisdomain" "\0"   /*                     */
	"nissrv" "\0"      /*                     */
	"ntpsrv" "\0"      /* DHCP_NTP_SERVER     */
	"wins" "\0"        /* DHCP_WINS_SERVER    */
	"requestip" "\0"   /* DHCP_REQUESTED_IP   */
	"lease" "\0"       /* DHCP_LEASE_TIME     */
	"dhcptype" "\0"    /*                     */
	"serverid" "\0"    /* DHCP_SERVER_ID      */
	"message" "\0"     /* DHCP_MESSAGE        */
	"vendorclass" "\0" /* DHCP_VENDOR         */
	"clientid" "\0"    /* DHCP_CLIENT_ID      */
	"tftp" "\0"
	"bootfile" "\0"
	"userclass" "\0"
#if ENABLE_FEATURE_UDHCP_RFC3397
	"search" "\0"
#endif
	"staticroutes" "\0" /* DHCP_STATIC_ROUTES  */
	/* MSIE's "Web Proxy Autodiscovery Protocol" support */
	"wpad" "\0"
	;


/* Lengths of the different option types */
const uint8_t dhcp_option_lengths[] ALIGN1 = {
	[OPTION_IP] =      4,
	[OPTION_IP_PAIR] = 8,
	[OPTION_BOOLEAN] = 1,
	[OPTION_STRING] =  1,
#if ENABLE_FEATURE_UDHCP_RFC3397
	[OPTION_STR1035] = 1,
#endif
	[OPTION_U8] =      1,
	[OPTION_U16] =     2,
	[OPTION_S16] =     2,
	[OPTION_U32] =     4,
	[OPTION_S32] =     4,
	/* Just like OPTION_STRING, we use minimum length here */
	[OPTION_STATIC_ROUTES] = 5,
};


#if defined CONFIG_UDHCP_DEBUG && CONFIG_UDHCP_DEBUG >= 2
static void log_option(const char *pfx, const uint8_t *opt)
{
	if (dhcp_verbose >= 2) {
		char buf[256 * 2 + 2];
		*bin2hex(buf, (void*) (opt + OPT_DATA), opt[OPT_LEN]) = '\0';
		bb_info_msg("%s: 0x%02x %s", pfx, opt[OPT_CODE], buf);
	}
}
#else
# define log_option(pfx, opt) ((void)0)
#endif


/* get an option with bounds checking (warning, result is not aligned). */
uint8_t* FAST_FUNC get_option(struct dhcp_packet *packet, int code)
{
	uint8_t *optionptr;
	int len;
	int rem;
	int overload = 0;
	enum {
		FILE_FIELD101  = FILE_FIELD  * 0x101,
		SNAME_FIELD101 = SNAME_FIELD * 0x101,
	};

	/* option bytes: [code][len][data1][data2]..[dataLEN] */
	optionptr = packet->options;
	rem = sizeof(packet->options);
	while (1) {
		if (rem <= 0) {
			bb_error_msg("bogus packet, malformed option field");
			return NULL;
		}
		if (optionptr[OPT_CODE] == DHCP_PADDING) {
			rem--;
			optionptr++;
			continue;
		}
		if (optionptr[OPT_CODE] == DHCP_END) {
			if ((overload & FILE_FIELD101) == FILE_FIELD) {
				/* can use packet->file, and didn't look at it yet */
				overload |= FILE_FIELD101; /* "we looked at it" */
				optionptr = packet->file;
				rem = sizeof(packet->file);
				continue;
			}
			if ((overload & SNAME_FIELD101) == SNAME_FIELD) {
				/* can use packet->sname, and didn't look at it yet */
				overload |= SNAME_FIELD101; /* "we looked at it" */
				optionptr = packet->sname;
				rem = sizeof(packet->sname);
				continue;
			}
			break;
		}
		len = 2 + optionptr[OPT_LEN];
		rem -= len;
		if (rem < 0)
			continue; /* complain and return NULL */

		if (optionptr[OPT_CODE] == code) {
			log_option("Option found", optionptr);
			return optionptr + OPT_DATA;
		}

		if (optionptr[OPT_CODE] == DHCP_OPTION_OVERLOAD) {
			overload |= optionptr[OPT_DATA];
			/* fall through */
		}
		optionptr += len;
	}

	/* log3 because udhcpc uses it a lot - very noisy */
	log3("Option 0x%02x not found", code);
	return NULL;
}


/* return the position of the 'end' option (no bounds checking) */
int FAST_FUNC end_option(uint8_t *optionptr)
{
	int i = 0;

	while (optionptr[i] != DHCP_END) {
		if (optionptr[i] != DHCP_PADDING)
			i += optionptr[i + OPT_LEN] + 1;
		i++;
	}
	return i;
}


/* add an option string to the options */
/* option bytes: [code][len][data1][data2]..[dataLEN] */
int FAST_FUNC add_option_string(uint8_t *optionptr, uint8_t *string)
{
	int end = end_option(optionptr);

	/* end position + string length + option code/length + end option */
	if (end + string[OPT_LEN] + 2 + 1 >= DHCP_OPTIONS_BUFSIZE) {
		bb_error_msg("option 0x%02x did not fit into the packet",
				string[OPT_CODE]);
		return 0;
	}
	log_option("Adding option", string);
	memcpy(optionptr + end, string, string[OPT_LEN] + 2);
	optionptr[end + string[OPT_LEN] + 2] = DHCP_END;
	return string[OPT_LEN] + 2;
}


/* add a one to four byte option to a packet */
int FAST_FUNC add_simple_option(uint8_t *optionptr, uint8_t code, uint32_t data)
{
	const struct dhcp_option *dh;

	for (dh = dhcp_options; dh->code; dh++) {
		if (dh->code == code) {
			uint8_t option[6], len;

			option[OPT_CODE] = code;
			len = dhcp_option_lengths[dh->flags & TYPE_MASK];
			option[OPT_LEN] = len;
			if (BB_BIG_ENDIAN)
				data <<= 8 * (4 - len);
			/* Assignment is unaligned! */
			move_to_unaligned32(&option[OPT_DATA], data);
			return add_option_string(optionptr, option);
		}
	}

	bb_error_msg("can't add option 0x%02x", code);
	return 0;
}
1	/* vi: set sw=4 ts=4: */
2	/*
3	* options.c -- DHCP server option packet tools
4	* Rewrite by Russ Dill <Russ.Dill@asu.edu> July 2001
5	*
6	* Licensed under GPLv2, see file LICENSE in this tarball for details.
7	*/
8
9	#include "common.h"
10	#include "dhcpd.h"
11	#include "options.h"
12
13
14	/* Supported options are easily added here */
15	const struct dhcp_option dhcp_options[] = {
16	/* flags code */
17	{ OPTION_IP \| OPTION_REQ, 0x01 }, /* DHCP_SUBNET */
18	{ OPTION_S32 , 0x02 }, /* DHCP_TIME_OFFSET */
19	{ OPTION_IP \| OPTION_LIST \| OPTION_REQ, 0x03 }, /* DHCP_ROUTER */
20	{ OPTION_IP \| OPTION_LIST , 0x04 }, /* DHCP_TIME_SERVER */
21	{ OPTION_IP \| OPTION_LIST , 0x05 }, /* DHCP_NAME_SERVER */
22	{ OPTION_IP \| OPTION_LIST \| OPTION_REQ, 0x06 }, /* DHCP_DNS_SERVER */
23	{ OPTION_IP \| OPTION_LIST , 0x07 }, /* DHCP_LOG_SERVER */
24	{ OPTION_IP \| OPTION_LIST , 0x08 }, /* DHCP_COOKIE_SERVER */
25	{ OPTION_IP \| OPTION_LIST , 0x09 }, /* DHCP_LPR_SERVER */
26	{ OPTION_STRING \| OPTION_REQ, 0x0c }, /* DHCP_HOST_NAME */
27	{ OPTION_U16 , 0x0d }, /* DHCP_BOOT_SIZE */
28	{ OPTION_STRING \| OPTION_LIST \| OPTION_REQ, 0x0f }, /* DHCP_DOMAIN_NAME */
29	{ OPTION_IP , 0x10 }, /* DHCP_SWAP_SERVER */
30	{ OPTION_STRING , 0x11 }, /* DHCP_ROOT_PATH */
31	{ OPTION_U8 , 0x17 }, /* DHCP_IP_TTL */
32	{ OPTION_U16 , 0x1a }, /* DHCP_MTU */
33	{ OPTION_IP \| OPTION_REQ, 0x1c }, /* DHCP_BROADCAST */
34	{ OPTION_STRING , 0x28 }, /* nisdomain */
35	{ OPTION_IP \| OPTION_LIST , 0x29 }, /* nissrv */
36	{ OPTION_IP \| OPTION_LIST \| OPTION_REQ, 0x2a }, /* DHCP_NTP_SERVER */
37	{ OPTION_IP \| OPTION_LIST , 0x2c }, /* DHCP_WINS_SERVER */
38	{ OPTION_IP , 0x32 }, /* DHCP_REQUESTED_IP */
39	{ OPTION_U32 , 0x33 }, /* DHCP_LEASE_TIME */
40	{ OPTION_U8 , 0x35 }, /* dhcptype */
41	{ OPTION_IP , 0x36 }, /* DHCP_SERVER_ID */
42	{ OPTION_STRING , 0x38 }, /* DHCP_MESSAGE */
43	{ OPTION_STRING , 0x3C }, /* DHCP_VENDOR */
44	{ OPTION_STRING , 0x3D }, /* DHCP_CLIENT_ID */
45	{ OPTION_STRING , 0x42 }, /* tftp */
46	{ OPTION_STRING , 0x43 }, /* bootfile */
47	{ OPTION_STRING , 0x4D }, /* userclass */
48	#if ENABLE_FEATURE_UDHCP_RFC3397
49	{ OPTION_STR1035 \| OPTION_LIST , 0x77 }, /* search */
50	#endif
51	{ OPTION_STATIC_ROUTES , 0x79 }, /* DHCP_STATIC_ROUTES */
52	/* MSIE's "Web Proxy Autodiscovery Protocol" support */
53	{ OPTION_STRING , 0xfc }, /* wpad */
54
55	/* Options below have no match in dhcp_option_strings[],
56	* are not passed to dhcpc scripts, and cannot be specified
57	* with "option XXX YYY" syntax in dhcpd config file. */
58
59	{ OPTION_U16 , 0x39 }, /* DHCP_MAX_SIZE */
60	{ 0, 0 } /* zeroed terminating entry */
61	};
62
63	/* Used for converting options from incoming packets to env variables
64	* for udhcpc stript */
65	/* Must match dhcp_options[] order */
66	const char dhcp_option_strings[] ALIGN1 =
67	"subnet" "\0" /* DHCP_SUBNET */
68	"timezone" "\0" /* DHCP_TIME_OFFSET */
69	"router" "\0" /* DHCP_ROUTER */
70	"timesrv" "\0" /* DHCP_TIME_SERVER */
71	"namesrv" "\0" /* DHCP_NAME_SERVER */
72	"dns" "\0" /* DHCP_DNS_SERVER */
73	"logsrv" "\0" /* DHCP_LOG_SERVER */
74	"cookiesrv" "\0" /* DHCP_COOKIE_SERVER */
75	"lprsrv" "\0" /* DHCP_LPR_SERVER */
76	"hostname" "\0" /* DHCP_HOST_NAME */
77	"bootsize" "\0" /* DHCP_BOOT_SIZE */
78	"domain" "\0" /* DHCP_DOMAIN_NAME */
79	"swapsrv" "\0" /* DHCP_SWAP_SERVER */
80	"rootpath" "\0" /* DHCP_ROOT_PATH */
81	"ipttl" "\0" /* DHCP_IP_TTL */
82	"mtu" "\0" /* DHCP_MTU */
83	"broadcast" "\0" /* DHCP_BROADCAST */
84	"nisdomain" "\0" /* */
85	"nissrv" "\0" /* */
86	"ntpsrv" "\0" /* DHCP_NTP_SERVER */
87	"wins" "\0" /* DHCP_WINS_SERVER */
88	"requestip" "\0" /* DHCP_REQUESTED_IP */
89	"lease" "\0" /* DHCP_LEASE_TIME */
90	"dhcptype" "\0" /* */
91	"serverid" "\0" /* DHCP_SERVER_ID */
92	"message" "\0" /* DHCP_MESSAGE */
93	"vendorclass" "\0" /* DHCP_VENDOR */
94	"clientid" "\0" /* DHCP_CLIENT_ID */
95	"tftp" "\0"
96	"bootfile" "\0"
97	"userclass" "\0"
98	#if ENABLE_FEATURE_UDHCP_RFC3397
99	"search" "\0"
100	#endif
101	"staticroutes" "\0" /* DHCP_STATIC_ROUTES */
102	/* MSIE's "Web Proxy Autodiscovery Protocol" support */
103	"wpad" "\0"
104	;
105
106
107	/* Lengths of the different option types */
108	const uint8_t dhcp_option_lengths[] ALIGN1 = {
109	[OPTION_IP] = 4,
110	[OPTION_IP_PAIR] = 8,
111	[OPTION_BOOLEAN] = 1,
112	[OPTION_STRING] = 1,
113	#if ENABLE_FEATURE_UDHCP_RFC3397
114	[OPTION_STR1035] = 1,
115	#endif
116	[OPTION_U8] = 1,
117	[OPTION_U16] = 2,
118	[OPTION_S16] = 2,
119	[OPTION_U32] = 4,
120	[OPTION_S32] = 4,
121	/* Just like OPTION_STRING, we use minimum length here */
122	[OPTION_STATIC_ROUTES] = 5,
123	};
124
125
126	#if defined CONFIG_UDHCP_DEBUG && CONFIG_UDHCP_DEBUG >= 2
127	static void log_option(const char pfx, const uint8_t opt)
128	{
129	if (dhcp_verbose >= 2) {
130	char buf[256 * 2 + 2];
131	bin2hex(buf, (void) (opt + OPT_DATA), opt[OPT_LEN]) = '\0';
132	bb_info_msg("%s: 0x%02x %s", pfx, opt[OPT_CODE], buf);
133	}
134	}
135	#else
136	# define log_option(pfx, opt) ((void)0)
137	#endif
138
139
140	/* get an option with bounds checking (warning, result is not aligned). */
141	uint8_t* FAST_FUNC get_option(struct dhcp_packet *packet, int code)
142	{
143	uint8_t *optionptr;
144	int len;
145	int rem;
146	int overload = 0;
147	enum {
148	FILE_FIELD101 = FILE_FIELD * 0x101,
149	SNAME_FIELD101 = SNAME_FIELD * 0x101,
150	};
151
152	/* option bytes: [code][len][data1][data2]..[dataLEN] */
153	optionptr = packet->options;
154	rem = sizeof(packet->options);
155	while (1) {
156	if (rem <= 0) {
157	bb_error_msg("bogus packet, malformed option field");
158	return NULL;
159	}
160	if (optionptr[OPT_CODE] == DHCP_PADDING) {
161	rem--;
162	optionptr++;
163	continue;
164	}
165	if (optionptr[OPT_CODE] == DHCP_END) {
166	if ((overload & FILE_FIELD101) == FILE_FIELD) {
167	/* can use packet->file, and didn't look at it yet */
168	overload \|= FILE_FIELD101; /* "we looked at it" */
169	optionptr = packet->file;
170	rem = sizeof(packet->file);
171	continue;
172	}
173	if ((overload & SNAME_FIELD101) == SNAME_FIELD) {
174	/* can use packet->sname, and didn't look at it yet */
175	overload \|= SNAME_FIELD101; /* "we looked at it" */
176	optionptr = packet->sname;
177	rem = sizeof(packet->sname);
178	continue;
179	}
180	break;
181	}
182	len = 2 + optionptr[OPT_LEN];
183	rem -= len;
184	if (rem < 0)
185	continue; /* complain and return NULL */
186
187	if (optionptr[OPT_CODE] == code) {
188	log_option("Option found", optionptr);
189	return optionptr + OPT_DATA;
190	}
191
192	if (optionptr[OPT_CODE] == DHCP_OPTION_OVERLOAD) {
193	overload \|= optionptr[OPT_DATA];
194	/* fall through */
195	}
196	optionptr += len;
197	}
198
199	/* log3 because udhcpc uses it a lot - very noisy */
200	log3("Option 0x%02x not found", code);
201	return NULL;
202	}
203
204
205	/* return the position of the 'end' option (no bounds checking) */
206	int FAST_FUNC end_option(uint8_t *optionptr)
207	{
208	int i = 0;
209
210	while (optionptr[i] != DHCP_END) {
211	if (optionptr[i] != DHCP_PADDING)
212	i += optionptr[i + OPT_LEN] + 1;
213	i++;
214	}
215	return i;
216	}
217
218
219	/* add an option string to the options */
220	/* option bytes: [code][len][data1][data2]..[dataLEN] */
221	int FAST_FUNC add_option_string(uint8_t optionptr, uint8_t string)
222	{
223	int end = end_option(optionptr);
224
225	/* end position + string length + option code/length + end option */
226	if (end + string[OPT_LEN] + 2 + 1 >= DHCP_OPTIONS_BUFSIZE) {
227	bb_error_msg("option 0x%02x did not fit into the packet",
228	string[OPT_CODE]);
229	return 0;
230	}
231	log_option("Adding option", string);
232	memcpy(optionptr + end, string, string[OPT_LEN] + 2);
233	optionptr[end + string[OPT_LEN] + 2] = DHCP_END;
234	return string[OPT_LEN] + 2;
235	}
236
237
238	/* add a one to four byte option to a packet */
239	int FAST_FUNC add_simple_option(uint8_t *optionptr, uint8_t code, uint32_t data)
240	{
241	const struct dhcp_option *dh;
242
243	for (dh = dhcp_options; dh->code; dh++) {
244	if (dh->code == code) {
245	uint8_t option[6], len;
246
247	option[OPT_CODE] = code;
248	len = dhcp_option_lengths[dh->flags & TYPE_MASK];
249	option[OPT_LEN] = len;
250	if (BB_BIG_ENDIAN)
251	data <<= 8 * (4 - len);
252	/* Assignment is unaligned! */
253	move_to_unaligned32(&option[OPT_DATA], data);
254	return add_option_string(optionptr, option);
255	}
256	}
257
258	bb_error_msg("can't add option 0x%02x", code);
259	return 0;
260	}