Fix creation of the htype field; the ll_proto field from which it is
[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 /** DHCP packet option block fill order
50  *
51  * This is the order in which option blocks are filled when
52  * reassembling a DHCP packet.  We fill the smallest field ("sname")
53  * first, to maximise the chances of being able to fit large options
54  * within fields which are large enough to contain them.
55  */
56 enum dhcp_packet_option_block_fill_order {
57         OPTS_SNAME = 0,
58         OPTS_FILE,
59         OPTS_MAIN,
60         NUM_OPT_BLOCKS
61 };
62
63 /** DHCP option blocks within a DHCP packet
64  *
65  * A DHCP packet contains three fields which can be used to contain
66  * options: the actual "options" field plus the "file" and "sname"
67  * fields (which can be overloaded to contain options).
68  */
69 struct dhcp_packet_option_blocks {
70         struct dhcp_option_block options[NUM_OPT_BLOCKS];
71 };
72
73 /**
74  * Set option within DHCP packet
75  *
76  * @v optblocks         DHCP packet option blocks
77  * @v tag               DHCP option tag
78  * @v data              New value for DHCP option
79  * @v len               Length of value, in bytes
80  * @ret option          DHCP option, or NULL
81  *
82  * Sets the option within the first available options block within the
83  * DHCP packet.  Option blocks are tried in the order specified by @c
84  * dhcp_option_block_fill_order.
85  */
86 static struct dhcp_option *
87 set_dhcp_packet_option ( struct dhcp_packet_option_blocks *optblocks,
88                          unsigned int tag, const void *data, size_t len ) {
89         struct dhcp_option_block *options;
90         struct dhcp_option *option;
91
92         for ( options = optblocks->options ;
93               options < &optblocks->options[NUM_OPT_BLOCKS] ; options++ ) {
94                 option = set_dhcp_option ( options, tag, data, len );
95                 if ( option )
96                         return option;
97         }
98         return NULL;
99 }
100
101 /**
102  * Copy options to DHCP packet
103  *
104  * @v optblocks         DHCP packet option blocks
105  * @v encapsulator      Encapsulating option, or zero
106  * @ret rc              Return status code
107  * 
108  * Copies options from DHCP options blocks into a DHCP packet.  Most
109  * options are copied verbatim.  Recognised encapsulated options
110  * fields are handled as such.  Selected options (e.g. @c
111  * DHCP_OPTION_OVERLOAD) are always ignored, since these special cases
112  * are handled by other code.
113  */
114 static int
115 copy_dhcp_options_to_packet ( struct dhcp_packet_option_blocks *optblocks,
116                               unsigned int encapsulator ) {
117         unsigned int subtag;
118         unsigned int tag;
119         struct dhcp_option *option;
120         struct dhcp_option *copied;
121         int rc;
122
123         for ( subtag = DHCP_MIN_OPTION; subtag <= DHCP_MAX_OPTION; subtag++ ) {
124                 tag = DHCP_ENCAP_OPT ( encapsulator, subtag );
125                 switch ( tag ) {
126                 case DHCP_OPTION_OVERLOAD:
127                         /* Hard-coded in packets we reassemble; skip
128                          * this option
129                          */
130                         break;
131                 case DHCP_EB_ENCAP:
132                 case DHCP_VENDOR_ENCAP:
133                         /* Process encapsulated options field */
134                         if ( ( rc = copy_dhcp_options_to_packet ( optblocks,
135                                                                   tag ) ) != 0)
136                                 return rc;
137                         break;
138                 default:
139                         /* Copy option to reassembled packet */
140                         option = find_global_dhcp_option ( tag );
141                         if ( ! option )
142                                 break;
143                         copied = set_dhcp_packet_option ( optblocks, tag,
144                                                           &option->data,
145                                                           option->len );
146                         if ( ! copied )
147                                 return -ENOSPC;
148                         break;
149                 };
150         }
151
152         return 0;
153 }
154
155 /**
156  * Assemble a DHCP packet
157  *
158  * @v dhcp              DHCP session
159  * @v data              Packet to be filled in
160  * @v max_len           Length of packet buffer
161  * @ret len             Length of assembled packet
162  *
163  * Reconstruct a DHCP packet from a DHCP options list.
164  */
165 size_t dhcp_assemble ( struct dhcp_session *dhcp, void *data,
166                        size_t max_len ) {
167         struct dhcp_packet *dhcppkt = data;
168         struct dhcp_option *option;
169         struct dhcp_packet_option_blocks optblocks;
170         unsigned int dhcp_message_type;
171         static const uint8_t overloading = ( DHCP_OPTION_OVERLOAD_FILE |
172                                              DHCP_OPTION_OVERLOAD_SNAME );
173
174         /* Fill in constant fields */
175         memset ( dhcppkt, 0, max_len );
176         dhcppkt->xid = dhcp->xid;
177         dhcppkt->magic = htonl ( DHCP_MAGIC_COOKIE );
178
179         /* Derive "op" field from DHCP_MESSAGE_TYPE option value */
180         dhcp_message_type = find_global_dhcp_num_option ( DHCP_MESSAGE_TYPE );
181         dhcppkt->op = dhcp_op[dhcp_message_type];
182
183         /* Fill in NIC details */
184         dhcppkt->htype = ntohs ( dhcp->netdev->ll_protocol->ll_proto );
185         dhcppkt->hlen = dhcp->netdev->ll_protocol->ll_addr_len;
186         memcpy ( dhcppkt->chaddr, dhcp->netdev->ll_addr, dhcppkt->hlen );
187
188         /* Fill in IP addresses if present */
189         option = find_global_dhcp_option ( DHCP_EB_YIADDR );
190         if ( option ) {
191                 memcpy ( &dhcppkt->yiaddr, &option->data,
192                          sizeof ( dhcppkt->yiaddr ) );
193         }
194         option = find_global_dhcp_option ( DHCP_EB_SIADDR );
195         if ( option ) {
196                 memcpy ( &dhcppkt->siaddr, &option->data,
197                          sizeof ( dhcppkt->siaddr ) );
198         }
199
200         /* Initialise option blocks */
201         init_dhcp_options ( &optblocks.options[OPTS_MAIN], dhcppkt->options,
202                             ( max_len -
203                               offsetof ( typeof ( *dhcppkt ), options ) ) );
204         init_dhcp_options ( &optblocks.options[OPTS_FILE], dhcppkt->file,
205                             sizeof ( dhcppkt->file ) );
206         init_dhcp_options ( &optblocks.options[OPTS_SNAME], dhcppkt->sname,
207                             sizeof ( dhcppkt->sname ) );
208         set_dhcp_option ( &optblocks.options[OPTS_MAIN], DHCP_OPTION_OVERLOAD,
209                           &overloading, sizeof ( overloading ) );
210
211         /* Populate option blocks */
212         copy_dhcp_options_to_packet ( &optblocks, 0 );
213
214         return ( offsetof ( typeof ( *dhcppkt ), options )
215                  + optblocks.options[OPTS_MAIN].len );
216 }
217
218 /**
219  * Calculate used length of a field containing DHCP options
220  *
221  * @v data              Field containing DHCP options
222  * @v max_len           Field length
223  * @ret len             Used length (excluding the @c DHCP_END tag)
224  */
225 static size_t dhcp_field_len ( const void *data, size_t max_len ) {
226         struct dhcp_option_block options;
227         struct dhcp_option *end;
228
229         options.data = ( ( void * ) data );
230         options.len = max_len;
231         end = find_dhcp_option ( &options, DHCP_END );
232         return ( end ? ( ( ( void * ) end ) - data ) : 0 );
233 }
234
235 /**
236  * Merge field containing DHCP options or string into DHCP options block
237  *
238  * @v options           DHCP option block
239  * @v data              Field containing DHCP options
240  * @v max_len           Field length
241  * @v tag               DHCP option tag, or 0
242  *
243  * If @c tag is non-zero, the field will be treated as a
244  * NUL-terminated string representing the value of the specified DHCP
245  * option.  If @c tag is zero, the field will be treated as a block of
246  * DHCP options, and simply appended to the existing options in the
247  * option block.
248  *
249  * The caller must ensure that there is enough space in the options
250  * block to perform the merge.
251  */
252 static void merge_dhcp_field ( struct dhcp_option_block *options,
253                                const void *data, size_t max_len,
254                                unsigned int tag ) {
255         size_t len;
256         void *dest;
257         struct dhcp_option *end;
258
259         if ( tag ) {
260                 set_dhcp_option ( options, tag, data, strlen ( data ) );
261         } else {
262                 len = dhcp_field_len ( data, max_len );
263                 dest = ( options->data + options->len - 1 );
264                 memcpy ( dest, data, len );
265                 options->len += len;
266                 end = ( dest + len );
267                 end->tag = DHCP_END;
268         }
269 }
270
271 /**
272  * Parse DHCP packet and construct DHCP options block
273  *
274  * @v data              DHCP packet
275  * @v len               Length of DHCP packet
276  * @ret options         DHCP options block, or NULL
277  *
278  * Parses a received DHCP packet and canonicalises its contents into a
279  * single DHCP options block.  The "file" and "sname" fields are
280  * converted into the corresponding DHCP options (@c
281  * DHCP_BOOTFILE_NAME and @c DHCP_TFTP_SERVER_NAME respectively).  If
282  * these fields are used for option overloading, their options are
283  * merged in to the options block.  The values of the "yiaddr" and
284  * "siaddr" fields will be stored within the options block as the
285  * options @c DHCP_EB_YIADDR and @c DHCP_EB_SIADDR.
286  * 
287  * Note that this call allocates new memory for the constructed DHCP
288  * options block; it is the responsibility of the caller to eventually
289  * free this memory.
290  */
291 struct dhcp_option_block * dhcp_parse ( const void *data, size_t len ) {
292         const struct dhcp_packet *dhcppkt = data;
293         struct dhcp_option_block *options;
294         size_t options_len;
295         unsigned int overloading;
296
297         /* Sanity check */
298         if ( len < sizeof ( *dhcppkt ) )
299                 return NULL;
300
301         /* Calculate size of resulting concatenated option block:
302          *
303          *   The "options" field : length of the field minus the DHCP_END tag.
304          *
305          *   The "file" field : maximum length of the field minus the
306          *   NUL terminator, plus a 2-byte DHCP header or, if used for
307          *   option overloading, the length of the field minus the
308          *   DHCP_END tag.
309          *
310          *   The "sname" field : as for the "file" field.
311          *
312          *   15 bytes for an encapsulated options field to contain the
313          *   value of the "yiaddr" and "siaddr" fields
314          *
315          *   1 byte for a final terminating DHCP_END tag.
316          */
317         options_len = ( ( len - offsetof ( typeof ( *dhcppkt ), options ) ) - 1
318                         + ( sizeof ( dhcppkt->file ) + 1 )
319                         + ( sizeof ( dhcppkt->sname ) + 1 )
320                         + 15 /* yiaddr and siaddr */
321                         + 1 /* DHCP_END tag */ );
322         
323         /* Allocate empty options block of required size */
324         options = alloc_dhcp_options ( options_len );
325         if ( ! options ) {
326                 DBG ( "DHCP could not allocate %d-byte option block\n",
327                       options_len );
328                 return NULL;
329         }
330         
331         /* Merge in "options" field, if this is a DHCP packet */
332         if ( dhcppkt->magic == htonl ( DHCP_MAGIC_COOKIE ) ) {
333                 merge_dhcp_field ( options, dhcppkt->options,
334                                    ( len -
335                                      offsetof ( typeof (*dhcppkt), options ) ),
336                                    0 /* Always contains options */ );
337         }
338
339         /* Identify overloaded fields */
340         overloading = find_dhcp_num_option ( options, DHCP_OPTION_OVERLOAD );
341         
342         /* Merge in "file" and "sname" fields */
343         merge_dhcp_field ( options, dhcppkt->file, sizeof ( dhcppkt->file ),
344                            ( ( overloading & DHCP_OPTION_OVERLOAD_FILE ) ?
345                              DHCP_BOOTFILE_NAME : 0 ) );
346         merge_dhcp_field ( options, dhcppkt->sname, sizeof ( dhcppkt->sname ),
347                            ( ( overloading & DHCP_OPTION_OVERLOAD_SNAME ) ?
348                              DHCP_TFTP_SERVER_NAME : 0 ) );
349
350         /* Set options for "yiaddr" and "siaddr", if present */
351         if ( dhcppkt->yiaddr.s_addr ) {
352                 set_dhcp_option ( options, DHCP_EB_YIADDR,
353                                   &dhcppkt->yiaddr, sizeof (dhcppkt->yiaddr) );
354         }
355         if ( dhcppkt->siaddr.s_addr ) {
356                 set_dhcp_option ( options, DHCP_EB_SIADDR,
357                                   &dhcppkt->siaddr, sizeof (dhcppkt->siaddr) );
358         }
359         
360         assert ( options->len <= options->max_len );
361
362         return options;
363 }