Beginnings of DHCP protocol implementation
[people/andreif/gpxe.git] / src / net / udp / dhcp.c
1 /*
2  * Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <string.h>
20 #include <errno.h>
21 #include <assert.h>
22 #include <byteswap.h>
23 #include <gpxe/if_ether.h>
24 #include <gpxe/netdevice.h>
25 #include <gpxe/dhcp.h>
26
27 /** @file
28  *
29  * Dynamic Host Configuration Protocol
30  *
31  */
32
33 /** DHCP operation types
34  *
35  * This table maps from DHCP message types (i.e. values of the @c
36  * DHCP_MESSAGE_TYPE option) to values of the "op" field within a DHCP
37  * packet.
38  */
39 static const uint8_t dhcp_op[] = {
40         [DHCPDISCOVER]  = BOOTP_REQUEST,
41         [DHCPOFFER]     = BOOTP_REPLY,
42         [DHCPREQUEST]   = BOOTP_REQUEST,
43         [DHCPDECLINE]   = BOOTP_REQUEST,
44         [DHCPACK]       = BOOTP_REPLY,
45         [DHCPNAK]       = BOOTP_REPLY,
46         [DHCPRELEASE]   = BOOTP_REQUEST,
47         [DHCPINFORM]    = BOOTP_REQUEST,
48 };
49
50 /** Raw option data for options common to all DHCP requests */
51 static uint8_t dhcp_request_options_data[] = {
52         DHCP_MAX_MESSAGE_SIZE, DHCP_WORD ( ETH_MAX_MTU ),
53         DHCP_VENDOR_CLASS_ID,
54         DHCP_STRING (  'E', 't', 'h', 'e', 'r', 'b', 'o', 'o', 't' ),
55         DHCP_PARAMETER_REQUEST_LIST,
56         DHCP_OPTION ( DHCP_SUBNET_MASK, DHCP_ROUTERS, DHCP_HOST_NAME ),
57         DHCP_END
58 };
59
60 /** Options common to all DHCP requests */
61 static struct dhcp_option_block dhcp_request_options = {
62         .data = dhcp_request_options_data,
63         .max_len = sizeof ( dhcp_request_options_data ),
64         .len = sizeof ( dhcp_request_options_data ),
65 };
66
67 /**
68  * Set option within DHCP packet
69  *
70  * @v dhcppkt           DHCP packet
71  * @v tag               DHCP option tag
72  * @v data              New value for DHCP option
73  * @v len               Length of value, in bytes
74  * @ret rc              Return status code
75  *
76  * Sets the option within the first available options block within the
77  * DHCP packet.  Option blocks are tried in the order specified by @c
78  * dhcp_option_block_fill_order.
79  *
80  * The magic options @c DHCP_EB_YIADDR and @c DHCP_EB_SIADDR are
81  * intercepted and inserted into the appropriate fixed fields within
82  * the DHCP packet.  The option @c DHCP_OPTION_OVERLOAD is silently
83  * ignored, since our DHCP packet assembly method relies on always
84  * having option overloading in use.
85  */
86 static int set_dhcp_packet_option ( struct dhcp_packet *dhcppkt,
87                                     unsigned int tag, const void *data,
88                                     size_t len ) {
89         struct dhcphdr *dhcphdr = dhcppkt->dhcphdr;
90         struct dhcp_option_block *options;
91         struct dhcp_option *option = NULL;
92
93         /* Special-case the magic options */
94         switch ( tag ) {
95         case DHCP_OPTION_OVERLOAD:
96                 /* Hard-coded in packets we create; always ignore */
97                 return 0;
98         case DHCP_EB_YIADDR:
99                 memcpy ( &dhcphdr->yiaddr, data, sizeof ( dhcphdr->yiaddr ) );
100                 return 0;
101         case DHCP_EB_SIADDR:
102                 memcpy ( &dhcphdr->siaddr, data, sizeof ( dhcphdr->siaddr ) );
103                 return 0;
104         default:
105                 /* Continue processing as normal */
106                 break;
107         }
108                 
109         /* Set option in first available options block */
110         for ( options = dhcppkt->options ;
111               options < &dhcppkt->options[NUM_OPT_BLOCKS] ; options++ ) {
112                 option = set_dhcp_option ( options, tag, data, len );
113                 if ( option )
114                         break;
115         }
116
117         /* Update DHCP packet length */
118         dhcppkt->len = ( offsetof ( typeof ( *dhcppkt->dhcphdr ), options )
119                          + dhcppkt->options[OPTS_MAIN].len );
120
121         return ( option ? 0 : -ENOSPC );
122 }
123
124 /**
125  * Set options within DHCP packet
126  *
127  * @v dhcppkt           DHCP packet
128  * @v options           DHCP option block, or NULL
129  * @v encapsulator      Encapsulating option, or zero
130  * @ret rc              Return status code
131  * 
132  * Copies options with the specified encapsulator from DHCP options
133  * blocks into a DHCP packet.  Most options are copied verbatim.
134  * Recognised encapsulated options fields are handled as such.
135  *
136  * @c options may specify a single options block, or be left as NULL
137  * in order to copy options from all registered options blocks.
138  */
139 static int set_dhcp_packet_encap_options ( struct dhcp_packet *dhcppkt,
140                                            struct dhcp_option_block *options,
141                                            unsigned int encapsulator ) {
142         unsigned int subtag;
143         unsigned int tag;
144         struct dhcp_option *option;
145         int rc;
146
147         for ( subtag = DHCP_MIN_OPTION; subtag <= DHCP_MAX_OPTION; subtag++ ) {
148                 tag = DHCP_ENCAP_OPT ( encapsulator, subtag );
149                 switch ( tag ) {
150                 case DHCP_EB_ENCAP:
151                 case DHCP_VENDOR_ENCAP:
152                         /* Process encapsulated options field */
153                         if ( ( rc = set_dhcp_packet_encap_options ( dhcppkt,
154                                                                     options,
155                                                                     tag )) !=0)
156                                 return rc;
157                         break;
158                 default:
159                         /* Copy option to reassembled packet */
160                         option = find_dhcp_option ( options, tag );
161                         if ( ! option )
162                                 break;
163                         if ( ( rc = set_dhcp_packet_option ( dhcppkt, tag,
164                                                              &option->data,
165                                                              option->len)) !=0)
166                                 return rc;
167                         break;
168                 };
169         }
170
171         return 0;
172 }
173
174 /**
175  * Set options within DHCP packet
176  *
177  * @v dhcppkt           DHCP packet
178  * @v options           DHCP option block, or NULL
179  * @ret rc              Return status code
180  * 
181  * Copies options from DHCP options blocks into a DHCP packet.  Most
182  * options are copied verbatim.  Recognised encapsulated options
183  * fields are handled as such.
184  *
185  * @c options may specify a single options block, or be left as NULL
186  * in order to copy options from all registered options blocks.
187  */
188 static int set_dhcp_packet_options ( struct dhcp_packet *dhcppkt,
189                                      struct dhcp_option_block *options ) {
190         return set_dhcp_packet_encap_options ( dhcppkt, options, 0 );
191 }
192
193 /**
194  * Create a DHCP packet
195  *
196  * @v dhcp              DHCP session
197  * @v msgtype           DHCP message type
198  * @v data              Buffer for DHCP packet
199  * @v max_len           Size of DHCP packet buffer
200  * @v dhcppkt           DHCP packet structure to fill in
201  * @ret rc              Return status code
202  *
203  * Creates a DHCP packet in the specified buffer, and fills out a @c
204  * dhcp_packet structure that can be passed to
205  * set_dhcp_packet_option() or set_dhcp_packet_options().
206  */
207 static int create_dhcp_packet ( struct dhcp_session *dhcp, uint8_t msgtype,
208                                 void *data, size_t max_len,
209                                 struct dhcp_packet *dhcppkt ) {
210         struct dhcphdr *dhcphdr = data;
211         static const uint8_t overloading = ( DHCP_OPTION_OVERLOAD_FILE |
212                                              DHCP_OPTION_OVERLOAD_SNAME );
213
214         /* Initialise DHCP packet structure */
215         dhcppkt->dhcphdr = dhcphdr;
216         dhcppkt->max_len = max_len;
217         init_dhcp_options ( &dhcppkt->options[OPTS_MAIN], dhcphdr->options,
218                             ( max_len -
219                               offsetof ( typeof ( *dhcphdr ), options ) ) );
220         init_dhcp_options ( &dhcppkt->options[OPTS_FILE], dhcphdr->file,
221                             sizeof ( dhcphdr->file ) );
222         init_dhcp_options ( &dhcppkt->options[OPTS_SNAME], dhcphdr->sname,
223                             sizeof ( dhcphdr->sname ) );
224         
225         /* Initialise DHCP packet content */
226         memset ( dhcphdr, 0, max_len );
227         dhcphdr->xid = dhcp->xid;
228         dhcphdr->magic = htonl ( DHCP_MAGIC_COOKIE );
229         dhcphdr->htype = ntohs ( dhcp->netdev->ll_protocol->ll_proto );
230         dhcphdr->hlen = dhcp->netdev->ll_protocol->ll_addr_len;
231         memcpy ( dhcphdr->chaddr, dhcp->netdev->ll_addr, dhcphdr->hlen );
232         dhcphdr->op = dhcp_op[msgtype];
233
234         /* Set DHCP_OPTION_OVERLOAD option within the main options block */
235         if ( ! set_dhcp_option ( &dhcppkt->options[OPTS_MAIN],
236                                  DHCP_OPTION_OVERLOAD, &overloading,
237                                  sizeof ( overloading ) ) )
238                 return -ENOSPC;
239
240         /* Set DHCP_MESSAGE_TYPE option */
241         if ( ! set_dhcp_packet_option ( dhcppkt, DHCP_MESSAGE_TYPE,
242                                         &msgtype, sizeof ( msgtype ) ) )
243                 return -ENOSPC;
244
245         return 0;
246 }
247
248 /**
249  * Calculate used length of a field containing DHCP options
250  *
251  * @v data              Field containing DHCP options
252  * @v max_len           Field length
253  * @ret len             Used length (excluding the @c DHCP_END tag)
254  */
255 static size_t dhcp_field_len ( const void *data, size_t max_len ) {
256         struct dhcp_option_block options;
257         struct dhcp_option *end;
258
259         options.data = ( ( void * ) data );
260         options.len = max_len;
261         end = find_dhcp_option ( &options, DHCP_END );
262         return ( end ? ( ( ( void * ) end ) - data ) : 0 );
263 }
264
265 /**
266  * Merge field containing DHCP options or string into DHCP options block
267  *
268  * @v options           DHCP option block
269  * @v data              Field containing DHCP options
270  * @v max_len           Field length
271  * @v tag               DHCP option tag, or 0
272  *
273  * If @c tag is non-zero, the field will be treated as a
274  * NUL-terminated string representing the value of the specified DHCP
275  * option.  If @c tag is zero, the field will be treated as a block of
276  * DHCP options, and simply appended to the existing options in the
277  * option block.
278  *
279  * The caller must ensure that there is enough space in the options
280  * block to perform the merge.
281  */
282 static void merge_dhcp_field ( struct dhcp_option_block *options,
283                                const void *data, size_t max_len,
284                                unsigned int tag ) {
285         size_t len;
286         void *dest;
287         struct dhcp_option *end;
288
289         if ( tag ) {
290                 set_dhcp_option ( options, tag, data, strlen ( data ) );
291         } else {
292                 len = dhcp_field_len ( data, max_len );
293                 dest = ( options->data + options->len - 1 );
294                 memcpy ( dest, data, len );
295                 options->len += len;
296                 end = ( dest + len );
297                 end->tag = DHCP_END;
298         }
299 }
300
301 /**
302  * Parse DHCP packet and construct DHCP options block
303  *
304  * @v data              DHCP packet
305  * @v len               Length of DHCP packet
306  * @ret options         DHCP options block, or NULL
307  *
308  * Parses a received DHCP packet and canonicalises its contents into a
309  * single DHCP options block.  The "file" and "sname" fields are
310  * converted into the corresponding DHCP options (@c
311  * DHCP_BOOTFILE_NAME and @c DHCP_TFTP_SERVER_NAME respectively).  If
312  * these fields are used for option overloading, their options are
313  * merged in to the options block.
314  *
315  * The values of the "yiaddr" and "siaddr" fields will be stored
316  * within the options block as the magic options @c DHCP_EB_YIADDR and
317  * @c DHCP_EB_SIADDR.
318  * 
319  * Note that this call allocates new memory for the constructed DHCP
320  * options block; it is the responsibility of the caller to eventually
321  * free this memory.
322  */
323 struct dhcp_option_block * dhcp_parse ( const void *data, size_t len ) {
324         const struct dhcphdr *dhcphdr = data;
325         struct dhcp_option_block *options;
326         size_t options_len;
327         unsigned int overloading;
328
329         /* Sanity check */
330         if ( len < sizeof ( *dhcphdr ) )
331                 return NULL;
332
333         /* Calculate size of resulting concatenated option block:
334          *
335          *   The "options" field : length of the field minus the DHCP_END tag.
336          *
337          *   The "file" field : maximum length of the field minus the
338          *   NUL terminator, plus a 2-byte DHCP header or, if used for
339          *   option overloading, the length of the field minus the
340          *   DHCP_END tag.
341          *
342          *   The "sname" field : as for the "file" field.
343          *
344          *   15 bytes for an encapsulated options field to contain the
345          *   value of the "yiaddr" and "siaddr" fields
346          *
347          *   1 byte for a final terminating DHCP_END tag.
348          */
349         options_len = ( ( len - offsetof ( typeof ( *dhcphdr ), options ) ) - 1
350                         + ( sizeof ( dhcphdr->file ) + 1 )
351                         + ( sizeof ( dhcphdr->sname ) + 1 )
352                         + 15 /* yiaddr and siaddr */
353                         + 1 /* DHCP_END tag */ );
354         
355         /* Allocate empty options block of required size */
356         options = alloc_dhcp_options ( options_len );
357         if ( ! options ) {
358                 DBG ( "DHCP could not allocate %d-byte option block\n",
359                       options_len );
360                 return NULL;
361         }
362         
363         /* Merge in "options" field, if this is a DHCP packet */
364         if ( dhcphdr->magic == htonl ( DHCP_MAGIC_COOKIE ) ) {
365                 merge_dhcp_field ( options, dhcphdr->options,
366                                    ( len -
367                                      offsetof ( typeof (*dhcphdr), options ) ),
368                                    0 /* Always contains options */ );
369         }
370
371         /* Identify overloaded fields */
372         overloading = find_dhcp_num_option ( options, DHCP_OPTION_OVERLOAD );
373         
374         /* Merge in "file" and "sname" fields */
375         merge_dhcp_field ( options, dhcphdr->file, sizeof ( dhcphdr->file ),
376                            ( ( overloading & DHCP_OPTION_OVERLOAD_FILE ) ?
377                              DHCP_BOOTFILE_NAME : 0 ) );
378         merge_dhcp_field ( options, dhcphdr->sname, sizeof ( dhcphdr->sname ),
379                            ( ( overloading & DHCP_OPTION_OVERLOAD_SNAME ) ?
380                              DHCP_TFTP_SERVER_NAME : 0 ) );
381
382         /* Set magic options for "yiaddr" and "siaddr", if present */
383         if ( dhcphdr->yiaddr.s_addr ) {
384                 set_dhcp_option ( options, DHCP_EB_YIADDR,
385                                   &dhcphdr->yiaddr, sizeof (dhcphdr->yiaddr) );
386         }
387         if ( dhcphdr->siaddr.s_addr ) {
388                 set_dhcp_option ( options, DHCP_EB_SIADDR,
389                                   &dhcphdr->siaddr, sizeof (dhcphdr->siaddr) );
390         }
391         
392         assert ( options->len <= options->max_len );
393
394         return options;
395 }
396
397 /****************************************************************************
398  *
399  * DHCP to UDP interface
400  *
401  */
402
403 static inline struct dhcp_session *
404 udp_to_dhcp ( struct udp_connection *conn ) {
405         return container_of ( conn, struct dhcp_session, udp );
406 }
407
408 /**
409  * Transmit DHCP request
410  *
411  * @v conn              UDP connection
412  * @v buf               Temporary data buffer
413  * @v len               Length of temporary data buffer
414  */
415 static void dhcp_senddata ( struct udp_connection *conn,
416                             void *buf, size_t len ) {
417         struct dhcp_session *dhcp = udp_to_dhcp ( conn );
418         struct dhcp_packet dhcppkt;
419         int rc;
420         
421         assert ( ( dhcp->state == DHCPDISCOVER ) ||
422                  ( dhcp->state == DHCPREQUEST ) );
423
424         /* Create DHCP packet in temporary buffer */
425         if ( ( rc = create_dhcp_packet ( dhcp, dhcp->state, buf, len,
426                                          &dhcppkt ) ) != 0 ) {
427                 DBG ( "Could not create DHCP packet\n" );
428                 return;
429         }
430
431         /* Copy in options common to all requests */
432         if ( ( rc = set_dhcp_packet_options ( &dhcppkt,
433                                               &dhcp_request_options ) ) != 0 ){
434                 DBG ( "Could not set common DHCP options\n" );
435                 return;
436         }
437
438         
439 }
440
441 /**
442  * Receive new data
443  *
444  * @v udp               UDP connection
445  * @v data              Received data
446  * @v len               Length of received data
447  */
448 static void dhcp_newdata ( struct udp_connection *conn,
449                            void *data, size_t len ) {
450         struct dhcp_session *dhcp = udp_to_dhcp ( conn );
451 }
452
453 /** DHCP UDP operations */
454 static struct udp_operations dhcp_udp_operations = {
455         .senddata       = dhcp_senddata,
456         .newdata        = dhcp_newdata,
457 };