Split DHCP packet creation into two parts: creating the basic packet
[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/netdevice.h>
24 #include <gpxe/dhcp.h>
25
26 /** @file
27  *
28  * Dynamic Host Configuration Protocol
29  *
30  */
31
32 /** DHCP operation types
33  *
34  * This table maps from DHCP message types (i.e. values of the @c
35  * DHCP_MESSAGE_TYPE option) to values of the "op" field within a DHCP
36  * packet.
37  */
38 static const uint8_t dhcp_op[] = {
39         [DHCPDISCOVER]  = BOOTP_REQUEST,
40         [DHCPOFFER]     = BOOTP_REPLY,
41         [DHCPREQUEST]   = BOOTP_REQUEST,
42         [DHCPDECLINE]   = BOOTP_REQUEST,
43         [DHCPACK]       = BOOTP_REPLY,
44         [DHCPNAK]       = BOOTP_REPLY,
45         [DHCPRELEASE]   = BOOTP_REQUEST,
46         [DHCPINFORM]    = BOOTP_REQUEST,
47 };
48
49 /**
50  * Set option within DHCP packet
51  *
52  * @v dhcppkt           DHCP packet
53  * @v tag               DHCP option tag
54  * @v data              New value for DHCP option
55  * @v len               Length of value, in bytes
56  * @ret rc              Return status code
57  *
58  * Sets the option within the first available options block within the
59  * DHCP packet.  Option blocks are tried in the order specified by @c
60  * dhcp_option_block_fill_order.
61  *
62  * The magic options @c DHCP_EB_YIADDR and @c DHCP_EB_SIADDR are
63  * intercepted and inserted into the appropriate fixed fields within
64  * the DHCP packet.  The option @c DHCP_OPTION_OVERLOAD is silently
65  * ignored, since our DHCP packet assembly method relies on always
66  * having option overloading in use.
67  */
68 static int set_dhcp_packet_option ( struct dhcp_packet *dhcppkt,
69                                     unsigned int tag, const void *data,
70                                     size_t len ) {
71         struct dhcphdr *dhcphdr = dhcppkt->dhcphdr;
72         struct dhcp_option_block *options;
73         struct dhcp_option *option = NULL;
74
75         /* Special-case the magic options */
76         switch ( tag ) {
77         case DHCP_OPTION_OVERLOAD:
78                 /* Hard-coded in packets we create; always ignore */
79                 return 0;
80         case DHCP_EB_YIADDR:
81                 memcpy ( &dhcphdr->yiaddr, data, sizeof ( dhcphdr->yiaddr ) );
82                 return 0;
83         case DHCP_EB_SIADDR:
84                 memcpy ( &dhcphdr->siaddr, data, sizeof ( dhcphdr->siaddr ) );
85                 return 0;
86         default:
87                 /* Continue processing as normal */
88                 break;
89         }
90                 
91         /* Set option in first available options block */
92         for ( options = dhcppkt->options ;
93               options < &dhcppkt->options[NUM_OPT_BLOCKS] ; options++ ) {
94                 option = set_dhcp_option ( options, tag, data, len );
95                 if ( option )
96                         break;
97         }
98
99         /* Update DHCP packet length */
100         dhcppkt->len = ( offsetof ( typeof ( *dhcppkt->dhcphdr ), options )
101                          + dhcppkt->options[OPTS_MAIN].len );
102
103         return ( option ? 0 : -ENOSPC );
104 }
105
106 /**
107  * Set options within DHCP packet
108  *
109  * @v dhcppkt           DHCP packet
110  * @v options           DHCP option block, or NULL
111  * @v encapsulator      Encapsulating option, or zero
112  * @ret rc              Return status code
113  * 
114  * Copies options with the specified encapsulator from DHCP options
115  * blocks into a DHCP packet.  Most options are copied verbatim.
116  * Recognised encapsulated options fields are handled as such.
117  *
118  * @c options may specify a single options block, or be left as NULL
119  * in order to copy options from all registered options blocks.
120  */
121 static int set_dhcp_packet_encap_options ( struct dhcp_packet *dhcppkt,
122                                            struct dhcp_option_block *options,
123                                            unsigned int encapsulator ) {
124         unsigned int subtag;
125         unsigned int tag;
126         struct dhcp_option *option;
127         int rc;
128
129         for ( subtag = DHCP_MIN_OPTION; subtag <= DHCP_MAX_OPTION; subtag++ ) {
130                 tag = DHCP_ENCAP_OPT ( encapsulator, subtag );
131                 switch ( tag ) {
132                 case DHCP_EB_ENCAP:
133                 case DHCP_VENDOR_ENCAP:
134                         /* Process encapsulated options field */
135                         if ( ( rc = set_dhcp_packet_encap_options ( dhcppkt,
136                                                                     options,
137                                                                     tag )) !=0)
138                                 return rc;
139                         break;
140                 default:
141                         /* Copy option to reassembled packet */
142                         option = find_dhcp_option ( options, tag );
143                         if ( ! option )
144                                 break;
145                         if ( ( rc = set_dhcp_packet_option ( dhcppkt, tag,
146                                                              &option->data,
147                                                              option->len)) !=0)
148                                 return rc;
149                         break;
150                 };
151         }
152
153         return 0;
154 }
155
156 /**
157  * Set options within DHCP packet
158  *
159  * @v dhcppkt           DHCP packet
160  * @v options           DHCP option block, or NULL
161  * @ret rc              Return status code
162  * 
163  * Copies options from DHCP options blocks into a DHCP packet.  Most
164  * options are copied verbatim.  Recognised encapsulated options
165  * fields are handled as such.
166  *
167  * @c options may specify a single options block, or be left as NULL
168  * in order to copy options from all registered options blocks.
169  */
170 static int set_dhcp_packet_options ( struct dhcp_packet *dhcppkt,
171                                      struct dhcp_option_block *options ) {
172         return set_dhcp_packet_encap_options ( dhcppkt, options, 0 );
173 }
174
175 /**
176  * Create a DHCP packet
177  *
178  * @v dhcp              DHCP session
179  * @v msgtype           DHCP message type
180  * @v data              Buffer for DHCP packet
181  * @v max_len           Size of DHCP packet buffer
182  * @v dhcppkt           DHCP packet structure to fill in
183  * @ret rc              Return status code
184  *
185  * Creates a DHCP packet in the specified buffer, and fills out a @c
186  * dhcp_packet structure that can be passed to
187  * set_dhcp_packet_option() or set_dhcp_packet_options().
188  */
189 int create_dhcp_packet ( struct dhcp_session *dhcp, uint8_t msgtype,
190                          void *data, size_t max_len,
191                          struct dhcp_packet *dhcppkt ) {
192         struct dhcphdr *dhcphdr = data;
193         static const uint8_t overloading = ( DHCP_OPTION_OVERLOAD_FILE |
194                                              DHCP_OPTION_OVERLOAD_SNAME );
195
196         /* Initialise DHCP packet structure */
197         dhcppkt->dhcphdr = dhcphdr;
198         dhcppkt->max_len = max_len;
199         init_dhcp_options ( &dhcppkt->options[OPTS_MAIN], dhcphdr->options,
200                             ( max_len -
201                               offsetof ( typeof ( *dhcphdr ), options ) ) );
202         init_dhcp_options ( &dhcppkt->options[OPTS_FILE], dhcphdr->file,
203                             sizeof ( dhcphdr->file ) );
204         init_dhcp_options ( &dhcppkt->options[OPTS_SNAME], dhcphdr->sname,
205                             sizeof ( dhcphdr->sname ) );
206         
207         /* Initialise DHCP packet content */
208         memset ( dhcphdr, 0, max_len );
209         dhcphdr->xid = dhcp->xid;
210         dhcphdr->magic = htonl ( DHCP_MAGIC_COOKIE );
211         dhcphdr->htype = ntohs ( dhcp->netdev->ll_protocol->ll_proto );
212         dhcphdr->hlen = dhcp->netdev->ll_protocol->ll_addr_len;
213         memcpy ( dhcphdr->chaddr, dhcp->netdev->ll_addr, dhcphdr->hlen );
214         dhcphdr->op = dhcp_op[msgtype];
215
216         /* Set DHCP_OPTION_OVERLOAD option within the main options block */
217         if ( ! set_dhcp_option ( &dhcppkt->options[OPTS_MAIN],
218                                  DHCP_OPTION_OVERLOAD, &overloading,
219                                  sizeof ( overloading ) ) )
220                 return -ENOSPC;
221
222         /* Set DHCP_MESSAGE_TYPE option */
223         if ( ! set_dhcp_packet_option ( dhcppkt, DHCP_MESSAGE_TYPE,
224                                         &msgtype, sizeof ( msgtype ) ) )
225                 return -ENOSPC;
226
227         return 0;
228 }
229
230 /**
231  * Calculate used length of a field containing DHCP options
232  *
233  * @v data              Field containing DHCP options
234  * @v max_len           Field length
235  * @ret len             Used length (excluding the @c DHCP_END tag)
236  */
237 static size_t dhcp_field_len ( const void *data, size_t max_len ) {
238         struct dhcp_option_block options;
239         struct dhcp_option *end;
240
241         options.data = ( ( void * ) data );
242         options.len = max_len;
243         end = find_dhcp_option ( &options, DHCP_END );
244         return ( end ? ( ( ( void * ) end ) - data ) : 0 );
245 }
246
247 /**
248  * Merge field containing DHCP options or string into DHCP options block
249  *
250  * @v options           DHCP option block
251  * @v data              Field containing DHCP options
252  * @v max_len           Field length
253  * @v tag               DHCP option tag, or 0
254  *
255  * If @c tag is non-zero, the field will be treated as a
256  * NUL-terminated string representing the value of the specified DHCP
257  * option.  If @c tag is zero, the field will be treated as a block of
258  * DHCP options, and simply appended to the existing options in the
259  * option block.
260  *
261  * The caller must ensure that there is enough space in the options
262  * block to perform the merge.
263  */
264 static void merge_dhcp_field ( struct dhcp_option_block *options,
265                                const void *data, size_t max_len,
266                                unsigned int tag ) {
267         size_t len;
268         void *dest;
269         struct dhcp_option *end;
270
271         if ( tag ) {
272                 set_dhcp_option ( options, tag, data, strlen ( data ) );
273         } else {
274                 len = dhcp_field_len ( data, max_len );
275                 dest = ( options->data + options->len - 1 );
276                 memcpy ( dest, data, len );
277                 options->len += len;
278                 end = ( dest + len );
279                 end->tag = DHCP_END;
280         }
281 }
282
283 /**
284  * Parse DHCP packet and construct DHCP options block
285  *
286  * @v data              DHCP packet
287  * @v len               Length of DHCP packet
288  * @ret options         DHCP options block, or NULL
289  *
290  * Parses a received DHCP packet and canonicalises its contents into a
291  * single DHCP options block.  The "file" and "sname" fields are
292  * converted into the corresponding DHCP options (@c
293  * DHCP_BOOTFILE_NAME and @c DHCP_TFTP_SERVER_NAME respectively).  If
294  * these fields are used for option overloading, their options are
295  * merged in to the options block.
296  *
297  * The values of the "yiaddr" and "siaddr" fields will be stored
298  * within the options block as the magic options @c DHCP_EB_YIADDR and
299  * @c DHCP_EB_SIADDR.
300  * 
301  * Note that this call allocates new memory for the constructed DHCP
302  * options block; it is the responsibility of the caller to eventually
303  * free this memory.
304  */
305 struct dhcp_option_block * dhcp_parse ( const void *data, size_t len ) {
306         const struct dhcphdr *dhcphdr = data;
307         struct dhcp_option_block *options;
308         size_t options_len;
309         unsigned int overloading;
310
311         /* Sanity check */
312         if ( len < sizeof ( *dhcphdr ) )
313                 return NULL;
314
315         /* Calculate size of resulting concatenated option block:
316          *
317          *   The "options" field : length of the field minus the DHCP_END tag.
318          *
319          *   The "file" field : maximum length of the field minus the
320          *   NUL terminator, plus a 2-byte DHCP header or, if used for
321          *   option overloading, the length of the field minus the
322          *   DHCP_END tag.
323          *
324          *   The "sname" field : as for the "file" field.
325          *
326          *   15 bytes for an encapsulated options field to contain the
327          *   value of the "yiaddr" and "siaddr" fields
328          *
329          *   1 byte for a final terminating DHCP_END tag.
330          */
331         options_len = ( ( len - offsetof ( typeof ( *dhcphdr ), options ) ) - 1
332                         + ( sizeof ( dhcphdr->file ) + 1 )
333                         + ( sizeof ( dhcphdr->sname ) + 1 )
334                         + 15 /* yiaddr and siaddr */
335                         + 1 /* DHCP_END tag */ );
336         
337         /* Allocate empty options block of required size */
338         options = alloc_dhcp_options ( options_len );
339         if ( ! options ) {
340                 DBG ( "DHCP could not allocate %d-byte option block\n",
341                       options_len );
342                 return NULL;
343         }
344         
345         /* Merge in "options" field, if this is a DHCP packet */
346         if ( dhcphdr->magic == htonl ( DHCP_MAGIC_COOKIE ) ) {
347                 merge_dhcp_field ( options, dhcphdr->options,
348                                    ( len -
349                                      offsetof ( typeof (*dhcphdr), options ) ),
350                                    0 /* Always contains options */ );
351         }
352
353         /* Identify overloaded fields */
354         overloading = find_dhcp_num_option ( options, DHCP_OPTION_OVERLOAD );
355         
356         /* Merge in "file" and "sname" fields */
357         merge_dhcp_field ( options, dhcphdr->file, sizeof ( dhcphdr->file ),
358                            ( ( overloading & DHCP_OPTION_OVERLOAD_FILE ) ?
359                              DHCP_BOOTFILE_NAME : 0 ) );
360         merge_dhcp_field ( options, dhcphdr->sname, sizeof ( dhcphdr->sname ),
361                            ( ( overloading & DHCP_OPTION_OVERLOAD_SNAME ) ?
362                              DHCP_TFTP_SERVER_NAME : 0 ) );
363
364         /* Set magic options for "yiaddr" and "siaddr", if present */
365         if ( dhcphdr->yiaddr.s_addr ) {
366                 set_dhcp_option ( options, DHCP_EB_YIADDR,
367                                   &dhcphdr->yiaddr, sizeof (dhcphdr->yiaddr) );
368         }
369         if ( dhcphdr->siaddr.s_addr ) {
370                 set_dhcp_option ( options, DHCP_EB_SIADDR,
371                                   &dhcphdr->siaddr, sizeof (dhcphdr->siaddr) );
372         }
373         
374         assert ( options->len <= options->max_len );
375
376         return options;
377 }