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