[DHCP] Treat empty fields in DHCP packets as non-existent.
[people/dverkamp/gpxe.git] / src / net / dhcppkt.c
1 /*
2  * Copyright (C) 2008 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 <stdint.h>
20 #include <stdlib.h>
21 #include <stdio.h>
22 #include <errno.h>
23 #include <string.h>
24 #include <gpxe/netdevice.h>
25 #include <gpxe/dhcp.h>
26 #include <gpxe/dhcpopts.h>
27 #include <gpxe/dhcppkt.h>
28
29 /** @file
30  *
31  * DHCP packets
32  *
33  */
34
35 /**
36  * Calculate used length of an IPv4 field within a DHCP packet
37  *
38  * @v data              Field data
39  * @v len               Length of field
40  * @ret used            Used length of field
41  */
42 static size_t used_len_ipv4 ( const void *data, size_t len __unused ) {
43         const struct in_addr *in = data;
44
45         return ( in->s_addr ? sizeof ( *in ) : 0 );
46 }
47
48 /**
49  * Calculate used length of a string field within a DHCP packet
50  *
51  * @v data              Field data
52  * @v len               Length of field
53  * @ret used            Used length of field
54  */
55 static size_t used_len_string ( const void *data, size_t len ) {
56         return strnlen ( data, len );
57 }
58
59 /** A dedicated field within a DHCP packet */
60 struct dhcp_packet_field {
61         /** Settings tag number */
62         unsigned int tag;
63         /** Offset within DHCP packet */
64         uint16_t offset;
65         /** Length of field */
66         uint16_t len;
67         /** Calculate used length of field
68          *
69          * @v data      Field data
70          * @v len       Length of field
71          * @ret used    Used length of field
72          */
73         size_t ( * used_len ) ( const void *data, size_t len );
74 };
75
76 /** Declare a dedicated field within a DHCP packet
77  *
78  * @v _tag              Settings tag number
79  * @v _field            Field name
80  * @v _used_len         Function to calculate used length of field
81  */
82 #define DHCP_PACKET_FIELD( _tag, _field, _used_len ) {                  \
83                 .tag = (_tag),                                          \
84                 .offset = offsetof ( struct dhcphdr, _field ),          \
85                 .len = sizeof ( ( ( struct dhcphdr * ) 0 )->_field ),   \
86                 .used_len = _used_len,                                  \
87         }
88
89 /** Dedicated fields within a DHCP packet */
90 static struct dhcp_packet_field dhcp_packet_fields[] = {
91         DHCP_PACKET_FIELD ( DHCP_EB_YIADDR, yiaddr, used_len_ipv4 ),
92         DHCP_PACKET_FIELD ( DHCP_EB_SIADDR, siaddr, used_len_ipv4 ),
93         DHCP_PACKET_FIELD ( DHCP_TFTP_SERVER_NAME, sname, used_len_string ),
94         DHCP_PACKET_FIELD ( DHCP_BOOTFILE_NAME, file, used_len_string ),
95 };
96
97 /**
98  * Get address of a DHCP packet field
99  *
100  * @v dhcphdr           DHCP packet header
101  * @v field             DHCP packet field
102  * @ret data            Packet field data
103  */
104 static inline void * dhcp_packet_field ( struct dhcphdr *dhcphdr,
105                                          struct dhcp_packet_field *field ) {
106         return ( ( ( void * ) dhcphdr ) + field->offset );
107 }
108
109 /**
110  * Find DHCP packet field corresponding to settings tag number
111  *
112  * @v tag               Settings tag number
113  * @ret field           DHCP packet field, or NULL
114  */
115 static struct dhcp_packet_field *
116 find_dhcp_packet_field ( unsigned int tag ) {
117         struct dhcp_packet_field *field;
118         unsigned int i;
119
120         for ( i = 0 ; i < ( sizeof ( dhcp_packet_fields ) /
121                             sizeof ( dhcp_packet_fields[0] ) ) ; i++ ) {
122                 field = &dhcp_packet_fields[i];
123                 if ( field->tag == tag )
124                         return field;
125         }
126         return NULL;
127 }
128
129 /**
130  * Store value of DHCP packet setting
131  *
132  * @v dhcppkt           DHCP packet
133  * @v tag               Setting tag number
134  * @v data              Setting data, or NULL to clear setting
135  * @v len               Length of setting data
136  * @ret rc              Return status code
137  */
138 int dhcppkt_store ( struct dhcp_packet *dhcppkt, unsigned int tag,
139                     const void *data, size_t len ) {
140         struct dhcp_packet_field *field;
141         int rc;
142
143         /* If this is a special field, fill it in */
144         if ( ( field = find_dhcp_packet_field ( tag ) ) != NULL ) {
145                 if ( len > field->len )
146                         return -ENOSPC;
147                 memcpy ( dhcp_packet_field ( dhcppkt->dhcphdr, field ),
148                          data, len );
149                 return 0;
150         }
151
152         /* Otherwise, use the generic options block */
153         rc = dhcpopt_store ( &dhcppkt->options, tag, data, len );
154
155         /* Update our used-length field */
156         dhcppkt->len = ( offsetof ( struct dhcphdr, options ) +
157                          dhcppkt->options.len );
158
159         return rc;
160 }
161
162 /**
163  * Fetch value of DHCP packet setting
164  *
165  * @v dhcppkt           DHCP packet
166  * @v tag               Setting tag number
167  * @v data              Buffer to fill with setting data
168  * @v len               Length of buffer
169  * @ret len             Length of setting data, or negative error
170  */
171 int dhcppkt_fetch ( struct dhcp_packet *dhcppkt, unsigned int tag,
172                     void *data, size_t len ) {
173         struct dhcp_packet_field *field;
174         void *field_data;
175         size_t field_len;
176         
177         /* If this is a special field, return it */
178         if ( ( field = find_dhcp_packet_field ( tag ) ) != NULL ) {
179                 field_data = dhcp_packet_field ( dhcppkt->dhcphdr, field );
180                 field_len = field->used_len ( field_data, field->len );
181                 if ( ! field_len )
182                         return -ENOENT;
183                 if ( len > field_len )
184                         len = field_len;
185                 memcpy ( data, field_data, len );
186                 return field_len;
187         }
188
189         /* Otherwise, use the generic options block */
190         return dhcpopt_fetch ( &dhcppkt->options, tag, data, len );
191 }
192
193 /**
194  * Initialise prepopulated DHCP packet
195  *
196  * @v dhcppkt           Uninitialised DHCP packet
197  * @v data              Memory for DHCP packet data
198  * @v max_len           Length of memory for DHCP packet data
199  *
200  * The memory content must already be filled with valid DHCP options.
201  * A zeroed block counts as a block of valid DHCP options.
202  */
203 void dhcppkt_init ( struct dhcp_packet *dhcppkt, void *data, size_t len ) {
204         dhcppkt->dhcphdr = data;
205         dhcppkt->max_len = len;
206         dhcpopt_init ( &dhcppkt->options, &dhcppkt->dhcphdr->options,
207                        ( len - offsetof ( struct dhcphdr, options ) ) );
208         dhcppkt->len = ( offsetof ( struct dhcphdr, options ) +
209                          dhcppkt->options.len );
210 }