[iscsi] Include credentials in iBFT only if used during iSCSI login
[people/peper/gpxe.git] / src / arch / i386 / interface / pcbios / ibft.c
1 /*
2  * Copyright Fen Systems Ltd. 2007.  Portions of this code are derived
3  * from IBM Corporation Sample Programs.  Copyright IBM Corporation
4  * 2004, 2007.  All rights reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person
7  * obtaining a copy of this software and associated documentation
8  * files (the "Software"), to deal in the Software without
9  * restriction, including without limitation the rights to use, copy,
10  * modify, merge, publish, distribute, sublicense, and/or sell copies
11  * of the Software, and to permit persons to whom the Software is
12  * furnished to do so, subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be
15  * included in all copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
21  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
22  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
23  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24  * SOFTWARE.
25  *
26  */
27
28 #include <stdint.h>
29 #include <stdio.h>
30 #include <string.h>
31 #include <errno.h>
32 #include <byteswap.h>
33 #include <realmode.h>
34 #include <gpxe/pci.h>
35 #include <gpxe/acpi.h>
36 #include <gpxe/in.h>
37 #include <gpxe/netdevice.h>
38 #include <gpxe/dhcp.h>
39 #include <gpxe/iscsi.h>
40 #include <gpxe/ibft.h>
41
42 /** @file
43  *
44  * iSCSI boot firmware table
45  *
46  * The information in this file is derived from the document "iSCSI
47  * Boot Firmware Table (iBFT)" as published by IBM at
48  *
49  * ftp://ftp.software.ibm.com/systems/support/system_x_pdf/ibm_iscsi_boot_firmware_table_v1.02.pdf
50  *
51  */
52
53 #define ibftab __use_data16 ( ibftab )
54 /** The iBFT used by gPXE */
55 struct gpxe_ibft __data16 ( ibftab ) = {
56         /* Table header */
57         .table = {
58                 /* ACPI header */
59                 .acpi = {
60                         .signature = IBFT_SIG,
61                         .length = sizeof ( ibftab ),
62                         .revision = 1,
63                         .oem_id = "FENSYS",
64                         .oem_table_id = "gPXE",
65                 },
66                 /* Control block */
67                 .control = {
68                         .header = {
69                                 .structure_id = IBFT_STRUCTURE_ID_CONTROL,
70                                 .version = 1,
71                                 .length = sizeof ( ibftab.table.control ),
72                                 .flags = 0,
73                         },
74                         .initiator = offsetof ( typeof ( ibftab ), initiator ),
75                         .nic_0 = offsetof ( typeof ( ibftab ), nic ),
76                         .target_0 = offsetof ( typeof ( ibftab ), target ),
77                 },
78         },
79         /* iSCSI initiator information */
80         .initiator = {
81                 .header = {
82                         .structure_id = IBFT_STRUCTURE_ID_INITIATOR,
83                         .version = 1,
84                         .length = sizeof ( ibftab.initiator ),
85                         .flags = ( IBFT_FL_INITIATOR_BLOCK_VALID |
86                                    IBFT_FL_INITIATOR_FIRMWARE_BOOT_SELECTED ),
87                 },
88         },
89         /* NIC information */
90         .nic = {
91                 .header = {
92                         .structure_id = IBFT_STRUCTURE_ID_NIC,
93                         .version = 1,
94                         .length = sizeof ( ibftab.nic ),
95                         .flags = ( IBFT_FL_NIC_BLOCK_VALID |
96                                    IBFT_FL_NIC_FIRMWARE_BOOT_SELECTED ),
97                 },
98         },
99         /* iSCSI target information */
100         .target = {
101                 .header = {
102                         .structure_id = IBFT_STRUCTURE_ID_TARGET,
103                         .version = 1,
104                         .length = sizeof ( ibftab.target ),
105                         .flags = ( IBFT_FL_TARGET_BLOCK_VALID |
106                                    IBFT_FL_TARGET_FIRMWARE_BOOT_SELECTED ),
107                 },
108         },
109 };
110
111 /**
112  * Fill in an IP address field within iBFT
113  *
114  * @v ipaddr            IP address field
115  * @v in                IPv4 address
116  */
117 static void ibft_set_ipaddr ( struct ibft_ipaddr *ipaddr, struct in_addr in ) {
118         memset ( ipaddr, 0, sizeof ( ipaddr ) );
119         if ( in.s_addr ) {
120                 ipaddr->in = in;
121                 ipaddr->ones = 0xffff;
122         }
123 }
124
125 /**
126  * Fill in an IP address within iBFT from configuration setting
127  *
128  * @v ipaddr            IP address field
129  * @v setting           Configuration setting
130  * @v tag               DHCP option tag
131  */
132 static void ibft_set_ipaddr_option ( struct ibft_ipaddr *ipaddr,
133                                      struct setting *setting ) {
134         struct in_addr in = { 0 };
135         fetch_ipv4_setting ( NULL, setting, &in );
136         ibft_set_ipaddr ( ipaddr, in );
137 }
138
139 /**
140  * Read IP address from iBFT (for debugging)
141  *
142  * @v strings           iBFT string block descriptor
143  * @v string            String field
144  * @ret ipaddr          IP address string
145  */
146 static const char * ibft_ipaddr ( struct ibft_ipaddr *ipaddr ) {
147         return inet_ntoa ( ipaddr->in );
148 }
149
150 /**
151  * Allocate a string within iBFT
152  *
153  * @v strings           iBFT string block descriptor
154  * @v string            String field to fill in
155  * @v len               Length of string to allocate (excluding NUL)
156  * @ret rc              Return status code
157  */
158 static int ibft_alloc_string ( struct ibft_string_block *strings,
159                                struct ibft_string *string, size_t len ) {
160         char *dest;
161         unsigned int remaining;
162
163         dest = ( ( ( char * ) strings->table ) + strings->offset );
164         remaining = ( strings->table->acpi.length - strings->offset );
165         if ( len >= remaining )
166                 return -ENOMEM;
167
168         string->offset = strings->offset;
169         string->length = len;
170         strings->offset += ( len + 1 );
171         return 0;
172 }
173
174 /**
175  * Fill in a string field within iBFT
176  *
177  * @v strings           iBFT string block descriptor
178  * @v string            String field
179  * @v data              String to fill in, or NULL
180  * @ret rc              Return status code
181  */
182 static int ibft_set_string ( struct ibft_string_block *strings,
183                              struct ibft_string *string, const char *data ) {
184         char *dest;
185         int rc;
186
187         if ( ! data )
188                 return 0;
189
190         if ( ( rc = ibft_alloc_string ( strings, string,
191                                         strlen ( data ) ) ) != 0 )
192                 return rc;
193         dest = ( ( ( char * ) strings->table ) + string->offset );
194         strcpy ( dest, data );
195
196         return 0;
197 }
198
199 /**
200  * Fill in a string field within iBFT from configuration setting
201  *
202  * @v strings           iBFT string block descriptor
203  * @v string            String field
204  * @v setting           Configuration setting
205  * @ret rc              Return status code
206  */
207 static int ibft_set_string_option ( struct ibft_string_block *strings,
208                                     struct ibft_string *string,
209                                     struct setting *setting ) {
210         int len;
211         char *dest;
212         int rc;
213
214         len = fetch_setting_len ( NULL, setting );
215         if ( len < 0 ) {
216                 string->offset = 0;
217                 string->length = 0;
218                 return 0;
219         }
220
221         if ( ( rc = ibft_alloc_string ( strings, string, len ) ) != 0 )
222                 return rc;
223         dest = ( ( ( char * ) strings->table ) + string->offset );
224         fetch_string_setting ( NULL, setting, dest, ( len + 1 ) );
225         return 0;
226 }
227
228 /**
229  * Read string from iBFT (for debugging)
230  *
231  * @v strings           iBFT string block descriptor
232  * @v string            String field
233  * @ret data            String content (or "<empty>")
234  */
235 static const char * ibft_string ( struct ibft_string_block *strings,
236                                   struct ibft_string *string ) {
237         return ( ( ( char * ) strings->table ) + string->offset );
238 }
239
240 /**
241  * Fill in NIC portion of iBFT
242  *
243  * @v nic               NIC portion of iBFT
244  * @v strings           iBFT string block descriptor
245  * @v netdev            Network device
246  * @ret rc              Return status code
247  */
248 static int ibft_fill_nic ( struct ibft_nic *nic,
249                            struct ibft_string_block *strings,
250                            struct net_device *netdev ) {
251         struct in_addr netmask_addr = { 0 };
252         unsigned int netmask_count = 0;
253         int rc;
254
255         /* Extract values from DHCP configuration */
256         ibft_set_ipaddr_option ( &nic->ip_address, &ip_setting );
257         DBG ( "iBFT NIC IP = %s\n", ibft_ipaddr ( &nic->ip_address ) );
258         ibft_set_ipaddr_option ( &nic->gateway, &gateway_setting );
259         DBG ( "iBFT NIC gateway = %s\n", ibft_ipaddr ( &nic->gateway ) );
260         ibft_set_ipaddr_option ( &nic->dns[0], &dns_setting );
261         DBG ( "iBFT NIC DNS = %s\n", ibft_ipaddr ( &nic->dns[0] ) );
262         if ( ( rc = ibft_set_string_option ( strings, &nic->hostname,
263                                              &hostname_setting ) ) != 0 )
264                 return rc;
265         DBG ( "iBFT NIC hostname = %s\n",
266               ibft_string ( strings, &nic->hostname ) );
267
268         /* Derive subnet mask prefix from subnet mask */
269         fetch_ipv4_setting ( NULL, &netmask_setting, &netmask_addr );
270         while ( netmask_addr.s_addr ) {
271                 if ( netmask_addr.s_addr & 0x1 )
272                         netmask_count++;
273                 netmask_addr.s_addr >>= 1;
274         }
275         nic->subnet_mask_prefix = netmask_count;
276         DBG ( "iBFT NIC subnet = /%d\n", nic->subnet_mask_prefix );
277
278         /* Extract values from net-device configuration */
279         memcpy ( nic->mac_address, netdev->ll_addr,
280                  sizeof ( nic->mac_address ) );
281         DBG ( "iBFT NIC MAC = %s\n",
282               netdev->ll_protocol->ntoa ( nic->mac_address ) );
283         nic->pci_bus_dev_func = netdev->dev->desc.location;
284         DBG ( "iBFT NIC PCI = %04x\n", nic->pci_bus_dev_func );
285
286         return 0;
287 }
288
289 /**
290  * Fill in Initiator portion of iBFT
291  *
292  * @v initiator         Initiator portion of iBFT
293  * @v strings           iBFT string block descriptor
294  * @ret rc              Return status code
295  */
296 static int ibft_fill_initiator ( struct ibft_initiator *initiator,
297                                  struct ibft_string_block *strings ) {
298         const char *initiator_iqn = iscsi_initiator_iqn();
299         int rc;
300
301         if ( ( rc = ibft_set_string ( strings, &initiator->initiator_name,
302                                       initiator_iqn ) ) != 0 )
303                 return rc;
304         DBG ( "iBFT initiator hostname = %s\n",
305               ibft_string ( strings, &initiator->initiator_name ) );
306
307         return 0;
308 }
309
310 /**
311  * Fill in Target CHAP portion of iBFT
312  *
313  * @v target            Target portion of iBFT
314  * @v strings           iBFT string block descriptor
315  * @v iscsi             iSCSI session
316  * @ret rc              Return status code
317  */
318 static int ibft_fill_target_chap ( struct ibft_target *target,
319                                    struct ibft_string_block *strings,
320                                    struct iscsi_session *iscsi ) {
321         int rc;
322
323         if ( ! ( iscsi->status & ISCSI_STATUS_AUTH_FORWARD_REQUIRED ) )
324                 return 0;
325
326         assert ( iscsi->initiator_username );
327         assert ( iscsi->initiator_password );
328
329         target->chap_type = IBFT_CHAP_ONE_WAY;
330         if ( ( rc = ibft_set_string ( strings, &target->chap_name,
331                                       iscsi->initiator_username ) ) != 0 )
332                 return rc;
333         DBG ( "iBFT target username = %s\n",
334               ibft_string ( strings, &target->chap_name ) );
335         if ( ( rc = ibft_set_string ( strings, &target->chap_secret,
336                                       iscsi->initiator_password ) ) != 0 )
337                 return rc;
338         DBG ( "iBFT target password = <redacted>\n" );
339
340         return 0;
341 }
342
343 /**
344  * Fill in Target Reverse CHAP portion of iBFT
345  *
346  * @v target            Target portion of iBFT
347  * @v strings           iBFT string block descriptor
348  * @v iscsi             iSCSI session
349  * @ret rc              Return status code
350  */
351 static int ibft_fill_target_reverse_chap ( struct ibft_target *target,
352                                            struct ibft_string_block *strings,
353                                            struct iscsi_session *iscsi ) {
354         int rc;
355
356         if ( ! ( iscsi->status & ISCSI_STATUS_AUTH_REVERSE_REQUIRED ) )
357                 return 0;
358
359         assert ( iscsi->initiator_username );
360         assert ( iscsi->initiator_password );
361         assert ( iscsi->target_username );
362         assert ( iscsi->target_password );
363
364         target->chap_type = IBFT_CHAP_MUTUAL;
365         if ( ( rc = ibft_set_string ( strings, &target->reverse_chap_name,
366                                       iscsi->target_username ) ) != 0 )
367                 return rc;
368         DBG ( "iBFT target reverse username = %s\n",
369               ibft_string ( strings, &target->chap_name ) );
370         if ( ( rc = ibft_set_string ( strings, &target->reverse_chap_secret,
371                                       iscsi->target_password ) ) != 0 )
372                 return rc;
373         DBG ( "iBFT target reverse password = <redacted>\n" );
374
375         return 0;
376 }
377
378 /**
379  * Fill in Target portion of iBFT
380  *
381  * @v target            Target portion of iBFT
382  * @v strings           iBFT string block descriptor
383  * @v iscsi             iSCSI session
384  * @ret rc              Return status code
385  */
386 static int ibft_fill_target ( struct ibft_target *target,
387                               struct ibft_string_block *strings,
388                               struct iscsi_session *iscsi ) {
389         struct sockaddr_in *sin_target =
390                 ( struct sockaddr_in * ) &iscsi->target_sockaddr;
391         int rc;
392
393         /* Fill in Target values */
394         ibft_set_ipaddr ( &target->ip_address, sin_target->sin_addr );
395         DBG ( "iBFT target IP = %s\n", ibft_ipaddr ( &target->ip_address ) );
396         target->socket = ntohs ( sin_target->sin_port );
397         DBG ( "iBFT target port = %d\n", target->socket );
398         if ( ( rc = ibft_set_string ( strings, &target->target_name,
399                                       iscsi->target_iqn ) ) != 0 )
400                 return rc;
401         DBG ( "iBFT target name = %s\n",
402               ibft_string ( strings, &target->target_name ) );
403         if ( ( rc = ibft_fill_target_chap ( target, strings, iscsi ) ) != 0 )
404                 return rc;
405         if ( ( rc = ibft_fill_target_reverse_chap ( target, strings,
406                                                     iscsi ) ) != 0 )
407                 return rc;
408
409         return 0;
410 }
411
412 /**
413  * Fill in all variable portions of iBFT
414  *
415  * @v netdev            Network device
416  * @v initiator_iqn     Initiator IQN
417  * @v st_target         Target socket address
418  * @v target_iqn        Target IQN
419  * @ret rc              Return status code
420  *
421  */
422 int ibft_fill_data ( struct net_device *netdev,
423                      struct iscsi_session *iscsi ) {
424         struct ibft_string_block strings = {
425                 .table = &ibftab.table,
426                 .offset = offsetof ( typeof ( ibftab ), strings ),
427         };
428         int rc;
429
430         /* Fill in NIC, Initiator and Target portions */
431         if ( ( rc = ibft_fill_nic ( &ibftab.nic, &strings, netdev ) ) != 0 )
432                 return rc;
433         if ( ( rc = ibft_fill_initiator ( &ibftab.initiator,
434                                           &strings ) ) != 0 )
435                 return rc;
436         if ( ( rc = ibft_fill_target ( &ibftab.target, &strings,
437                                        iscsi ) ) != 0 )
438                 return rc;
439
440         /* Update checksum */
441         acpi_fix_checksum ( &ibftab.table.acpi );
442
443         return 0;
444 }