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