Fix forgotten license comments
[platform/upstream/busybox.git] / networking / udhcp / options.c
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         /* MSIE's "Web Proxy Autodiscovery Protocol" support */
52         { OPTION_STRING                           , 0xfc }, /* wpad               */
53
54         /* Options below have no match in dhcp_option_strings[],
55          * are not passed to dhcpc scripts, and cannot be specified
56          * with "option XXX YYY" syntax in dhcpd config file. */
57
58         { OPTION_U16                              , 0x39 }, /* DHCP_MAX_SIZE      */
59         { } /* zeroed terminating entry */
60 };
61
62 /* Used for converting options from incoming packets to env variables
63  * for udhcpc stript */
64 /* Must match dhcp_options[] order */
65 const char dhcp_option_strings[] ALIGN1 =
66         "subnet" "\0"      /* DHCP_SUBNET         */
67         "timezone" "\0"    /* DHCP_TIME_OFFSET    */
68         "router" "\0"      /* DHCP_ROUTER         */
69         "timesrv" "\0"     /* DHCP_TIME_SERVER    */
70         "namesrv" "\0"     /* DHCP_NAME_SERVER    */
71         "dns" "\0"         /* DHCP_DNS_SERVER     */
72         "logsrv" "\0"      /* DHCP_LOG_SERVER     */
73         "cookiesrv" "\0"   /* DHCP_COOKIE_SERVER  */
74         "lprsrv" "\0"      /* DHCP_LPR_SERVER     */
75         "hostname" "\0"    /* DHCP_HOST_NAME      */
76         "bootsize" "\0"    /* DHCP_BOOT_SIZE      */
77         "domain" "\0"      /* DHCP_DOMAIN_NAME    */
78         "swapsrv" "\0"     /* DHCP_SWAP_SERVER    */
79         "rootpath" "\0"    /* DHCP_ROOT_PATH      */
80         "ipttl" "\0"       /* DHCP_IP_TTL         */
81         "mtu" "\0"         /* DHCP_MTU            */
82         "broadcast" "\0"   /* DHCP_BROADCAST      */
83         "nisdomain" "\0"   /*                     */
84         "nissrv" "\0"      /*                     */
85         "ntpsrv" "\0"      /* DHCP_NTP_SERVER     */
86         "wins" "\0"        /* DHCP_WINS_SERVER    */
87         "requestip" "\0"   /* DHCP_REQUESTED_IP   */
88         "lease" "\0"       /* DHCP_LEASE_TIME     */
89         "dhcptype" "\0"    /*                     */
90         "serverid" "\0"    /* DHCP_SERVER_ID      */
91         "message" "\0"     /* DHCP_MESSAGE        */
92         "vendorclass" "\0" /* DHCP_VENDOR         */
93         "clientid" "\0"    /* DHCP_CLIENT_ID      */
94         "tftp" "\0"
95         "bootfile" "\0"
96         "userclass" "\0"
97 #if ENABLE_FEATURE_UDHCP_RFC3397
98         "search" "\0"
99 #endif
100         /* MSIE's "Web Proxy Autodiscovery Protocol" support */
101         "wpad" "\0"
102         ;
103
104
105 /* Lengths of the different option types */
106 const uint8_t dhcp_option_lengths[] ALIGN1 = {
107         [OPTION_IP] =      4,
108         [OPTION_IP_PAIR] = 8,
109         [OPTION_BOOLEAN] = 1,
110         [OPTION_STRING] =  1,
111 #if ENABLE_FEATURE_UDHCP_RFC3397
112         [OPTION_STR1035] = 1,
113 #endif
114         [OPTION_U8] =      1,
115         [OPTION_U16] =     2,
116         [OPTION_S16] =     2,
117         [OPTION_U32] =     4,
118         [OPTION_S32] =     4
119 };
120
121
122 /* get an option with bounds checking (warning, not aligned). */
123 uint8_t* FAST_FUNC get_option(struct dhcpMessage *packet, int code)
124 {
125         int i, length;
126         uint8_t *optionptr;
127         int over = 0;
128         int curr = OPTION_FIELD;
129
130         optionptr = packet->options;
131         i = 0;
132         length = sizeof(packet->options);
133         while (1) {
134                 if (i >= length) {
135                         bb_error_msg("bogus packet, option fields too long");
136                         return NULL;
137                 }
138                 if (optionptr[i + OPT_CODE] == code) {
139                         if (i + 1 + optionptr[i + OPT_LEN] >= length) {
140                                 bb_error_msg("bogus packet, option fields too long");
141                                 return NULL;
142                         }
143                         return optionptr + i + 2;
144                 }
145                 switch (optionptr[i + OPT_CODE]) {
146                 case DHCP_PADDING:
147                         i++;
148                         break;
149                 case DHCP_OPTION_OVER:
150                         if (i + 1 + optionptr[i + OPT_LEN] >= length) {
151                                 bb_error_msg("bogus packet, option fields too long");
152                                 return NULL;
153                         }
154                         over = optionptr[i + 3];
155                         i += optionptr[OPT_LEN] + 2;
156                         break;
157                 case DHCP_END:
158                         if (curr == OPTION_FIELD && (over & FILE_FIELD)) {
159                                 optionptr = packet->file;
160                                 i = 0;
161                                 length = sizeof(packet->file);
162                                 curr = FILE_FIELD;
163                         } else if (curr == FILE_FIELD && (over & SNAME_FIELD)) {
164                                 optionptr = packet->sname;
165                                 i = 0;
166                                 length = sizeof(packet->sname);
167                                 curr = SNAME_FIELD;
168                         } else
169                                 return NULL;
170                         break;
171                 default:
172                         i += optionptr[OPT_LEN + i] + 2;
173                 }
174         }
175         return NULL;
176 }
177
178
179 /* return the position of the 'end' option (no bounds checking) */
180 int FAST_FUNC end_option(uint8_t *optionptr)
181 {
182         int i = 0;
183
184         while (optionptr[i] != DHCP_END) {
185                 if (optionptr[i] == DHCP_PADDING)
186                         i++;
187                 else
188                         i += optionptr[i + OPT_LEN] + 2;
189         }
190         return i;
191 }
192
193
194 /* add an option string to the options (an option string contains an option code,
195  * length, then data) */
196 int FAST_FUNC add_option_string(uint8_t *optionptr, uint8_t *string)
197 {
198         int end = end_option(optionptr);
199
200         /* end position + string length + option code/length + end option */
201         if (end + string[OPT_LEN] + 2 + 1 >= DHCP_OPTIONS_BUFSIZE) {
202                 bb_error_msg("option 0x%02x did not fit into the packet",
203                                 string[OPT_CODE]);
204                 return 0;
205         }
206         DEBUG("adding option 0x%02x", string[OPT_CODE]);
207         memcpy(optionptr + end, string, string[OPT_LEN] + 2);
208         optionptr[end + string[OPT_LEN] + 2] = DHCP_END;
209         return string[OPT_LEN] + 2;
210 }
211
212
213 /* add a one to four byte option to a packet */
214 int FAST_FUNC add_simple_option(uint8_t *optionptr, uint8_t code, uint32_t data)
215 {
216         const struct dhcp_option *dh;
217
218         for (dh = dhcp_options; dh->code; dh++) {
219                 if (dh->code == code) {
220                         uint8_t option[6], len;
221
222                         option[OPT_CODE] = code;
223                         len = dhcp_option_lengths[dh->flags & TYPE_MASK];
224                         option[OPT_LEN] = len;
225                         if (BB_BIG_ENDIAN)
226                                 data <<= 8 * (4 - len);
227                         /* This memcpy is for processors which can't
228                          * handle a simple unaligned 32-bit assignment */
229                         memcpy(&option[OPT_DATA], &data, 4);
230                         return add_option_string(optionptr, option);
231                 }
232         }
233
234         bb_error_msg("cannot add option 0x%02x", code);
235         return 0;
236 }