blob: e5417beee529df809d23bfe0b3e1064d56379a78 [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
Simon Glass10a1eca2013-05-07 06:11:54 +00002/*
3 * Copyright (c) 2013, Google Inc.
4 *
5 * (C) Copyright 2008 Semihalf
6 *
7 * (C) Copyright 2000-2006
8 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
Simon Glass10a1eca2013-05-07 06:11:54 +00009 */
10
11#include "mkimage.h"
Simon Glassa51991d2014-06-12 07:24:53 -060012#include <bootm.h>
Masahiro Yamada6dd10522020-04-16 18:30:18 +090013#include <fdt_region.h>
Simon Glass10a1eca2013-05-07 06:11:54 +000014#include <image.h>
Simon Glassfbabc0f2013-06-13 15:10:01 -070015#include <version.h>
Simon Glass10a1eca2013-05-07 06:11:54 +000016
17/**
Simon Glass0ce6e3d2013-05-07 06:11:56 +000018 * fit_set_hash_value - set hash value in requested has node
19 * @fit: pointer to the FIT format image header
20 * @noffset: hash node offset
21 * @value: hash value to be set
22 * @value_len: hash value length
23 *
24 * fit_set_hash_value() attempts to set hash value in a node at offset
25 * given and returns operation status to the caller.
26 *
27 * returns
28 * 0, on success
29 * -1, on failure
30 */
31static int fit_set_hash_value(void *fit, int noffset, uint8_t *value,
32 int value_len)
33{
34 int ret;
35
36 ret = fdt_setprop(fit, noffset, FIT_VALUE_PROP, value, value_len);
37 if (ret) {
38 printf("Can't set hash '%s' property for '%s' node(%s)\n",
39 FIT_VALUE_PROP, fit_get_name(fit, noffset, NULL),
40 fdt_strerror(ret));
Simon Glassec539f72016-07-03 09:40:44 -060041 return ret == -FDT_ERR_NOSPACE ? -ENOSPC : -EIO;
Simon Glass0ce6e3d2013-05-07 06:11:56 +000042 }
43
44 return 0;
45}
46
47/**
Simon Glass25d6e6b2013-05-07 06:11:55 +000048 * fit_image_process_hash - Process a single subnode of the images/ node
49 *
50 * Check each subnode and process accordingly. For hash nodes we generate
51 * a hash of the supplised data and store it in the node.
52 *
53 * @fit: pointer to the FIT format image header
54 * @image_name: name of image being processes (used to display errors)
55 * @noffset: subnode offset
56 * @data: data to process
57 * @size: size of data in bytes
58 * @return 0 if ok, -1 on error
59 */
60static int fit_image_process_hash(void *fit, const char *image_name,
61 int noffset, const void *data, size_t size)
62{
63 uint8_t value[FIT_MAX_HASH_LEN];
Simon Glassee382652013-05-07 06:12:01 +000064 const char *node_name;
Simon Glass25d6e6b2013-05-07 06:11:55 +000065 int value_len;
66 char *algo;
Simon Glassec539f72016-07-03 09:40:44 -060067 int ret;
Simon Glass25d6e6b2013-05-07 06:11:55 +000068
Simon Glassee382652013-05-07 06:12:01 +000069 node_name = fit_get_name(fit, noffset, NULL);
Simon Glass25d6e6b2013-05-07 06:11:55 +000070
71 if (fit_image_hash_get_algo(fit, noffset, &algo)) {
72 printf("Can't get hash algo property for '%s' hash node in '%s' image node\n",
Simon Glassee382652013-05-07 06:12:01 +000073 node_name, image_name);
Simon Glassec539f72016-07-03 09:40:44 -060074 return -ENOENT;
Simon Glass25d6e6b2013-05-07 06:11:55 +000075 }
76
77 if (calculate_hash(data, size, algo, value, &value_len)) {
78 printf("Unsupported hash algorithm (%s) for '%s' hash node in '%s' image node\n",
Simon Glassee382652013-05-07 06:12:01 +000079 algo, node_name, image_name);
Simon Glassec539f72016-07-03 09:40:44 -060080 return -EPROTONOSUPPORT;
Simon Glass25d6e6b2013-05-07 06:11:55 +000081 }
82
Simon Glassec539f72016-07-03 09:40:44 -060083 ret = fit_set_hash_value(fit, noffset, value, value_len);
84 if (ret) {
Simon Glass25d6e6b2013-05-07 06:11:55 +000085 printf("Can't set hash value for '%s' hash node in '%s' image node\n",
Simon Glassee382652013-05-07 06:12:01 +000086 node_name, image_name);
Simon Glassec539f72016-07-03 09:40:44 -060087 return ret;
Simon Glass25d6e6b2013-05-07 06:11:55 +000088 }
89
90 return 0;
91}
92
93/**
Simon Glassfbabc0f2013-06-13 15:10:01 -070094 * fit_image_write_sig() - write the signature to a FIT
Simon Glass10a1eca2013-05-07 06:11:54 +000095 *
Simon Glassfbabc0f2013-06-13 15:10:01 -070096 * This writes the signature and signer data to the FIT.
97 *
98 * @fit: pointer to the FIT format image header
99 * @noffset: hash node offset
100 * @value: signature value to be set
101 * @value_len: signature value length
102 * @comment: Text comment to write (NULL for none)
103 *
104 * returns
105 * 0, on success
106 * -FDT_ERR_..., on failure
107 */
108static int fit_image_write_sig(void *fit, int noffset, uint8_t *value,
109 int value_len, const char *comment, const char *region_prop,
Alex Kiernan697fcdc2018-06-20 20:10:52 +0000110 int region_proplen, const char *cmdname)
Simon Glassfbabc0f2013-06-13 15:10:01 -0700111{
112 int string_size;
113 int ret;
114
115 /*
116 * Get the current string size, before we update the FIT and add
117 * more
118 */
119 string_size = fdt_size_dt_strings(fit);
120
121 ret = fdt_setprop(fit, noffset, FIT_VALUE_PROP, value, value_len);
122 if (!ret) {
123 ret = fdt_setprop_string(fit, noffset, "signer-name",
124 "mkimage");
125 }
126 if (!ret) {
127 ret = fdt_setprop_string(fit, noffset, "signer-version",
128 PLAIN_VERSION);
129 }
130 if (comment && !ret)
131 ret = fdt_setprop_string(fit, noffset, "comment", comment);
Alex Kiernan697fcdc2018-06-20 20:10:52 +0000132 if (!ret) {
133 time_t timestamp = imagetool_get_source_date(cmdname,
134 time(NULL));
135
136 ret = fit_set_timestamp(fit, noffset, timestamp);
137 }
Simon Glassfbabc0f2013-06-13 15:10:01 -0700138 if (region_prop && !ret) {
139 uint32_t strdata[2];
140
141 ret = fdt_setprop(fit, noffset, "hashed-nodes",
142 region_prop, region_proplen);
Teddy Reed9767bf42018-06-09 11:45:20 -0400143 /* This is a legacy offset, it is unused, and must remain 0. */
Simon Glassfbabc0f2013-06-13 15:10:01 -0700144 strdata[0] = 0;
145 strdata[1] = cpu_to_fdt32(string_size);
146 if (!ret) {
147 ret = fdt_setprop(fit, noffset, "hashed-strings",
148 strdata, sizeof(strdata));
149 }
150 }
151
152 return ret;
153}
154
155static int fit_image_setup_sig(struct image_sign_info *info,
156 const char *keydir, void *fit, const char *image_name,
George McCollister23d14892017-01-06 13:14:17 -0600157 int noffset, const char *require_keys, const char *engine_id)
Simon Glassfbabc0f2013-06-13 15:10:01 -0700158{
159 const char *node_name;
160 char *algo_name;
Philippe Reynes12468352018-11-14 13:51:00 +0100161 const char *padding_name;
Simon Glassfbabc0f2013-06-13 15:10:01 -0700162
163 node_name = fit_get_name(fit, noffset, NULL);
164 if (fit_image_hash_get_algo(fit, noffset, &algo_name)) {
165 printf("Can't get algo property for '%s' signature node in '%s' image node\n",
166 node_name, image_name);
167 return -1;
168 }
169
Philippe Reynes12468352018-11-14 13:51:00 +0100170 padding_name = fdt_getprop(fit, noffset, "padding", NULL);
171
Simon Glassfbabc0f2013-06-13 15:10:01 -0700172 memset(info, '\0', sizeof(*info));
173 info->keydir = keydir;
Simon Glassd7aabcc2020-03-18 11:44:06 -0600174 info->keyname = fdt_getprop(fit, noffset, FIT_KEY_HINT, NULL);
Simon Glassfbabc0f2013-06-13 15:10:01 -0700175 info->fit = fit;
176 info->node_offset = noffset;
Masahiro Yamadac1f137b2017-10-27 13:25:21 +0900177 info->name = strdup(algo_name);
Andrew Duda6616c822016-11-08 18:53:41 +0000178 info->checksum = image_get_checksum_algo(algo_name);
179 info->crypto = image_get_crypto_algo(algo_name);
Philippe Reynes12468352018-11-14 13:51:00 +0100180 info->padding = image_get_padding_algo(padding_name);
Simon Glassfbabc0f2013-06-13 15:10:01 -0700181 info->require_keys = require_keys;
George McCollister23d14892017-01-06 13:14:17 -0600182 info->engine_id = engine_id;
Andrew Duda6616c822016-11-08 18:53:41 +0000183 if (!info->checksum || !info->crypto) {
Simon Glassfbabc0f2013-06-13 15:10:01 -0700184 printf("Unsupported signature algorithm (%s) for '%s' signature node in '%s' image node\n",
185 algo_name, node_name, image_name);
186 return -1;
187 }
188
189 return 0;
190}
191
192/**
193 * fit_image_process_sig- Process a single subnode of the images/ node
194 *
195 * Check each subnode and process accordingly. For signature nodes we
196 * generate a signed hash of the supplised data and store it in the node.
197 *
198 * @keydir: Directory containing keys to use for signing
199 * @keydest: Destination FDT blob to write public keys into
200 * @fit: pointer to the FIT format image header
201 * @image_name: name of image being processes (used to display errors)
202 * @noffset: subnode offset
203 * @data: data to process
204 * @size: size of data in bytes
205 * @comment: Comment to add to signature nodes
206 * @require_keys: Mark all keys as 'required'
George McCollister23d14892017-01-06 13:14:17 -0600207 * @engine_id: Engine to use for signing
Simon Glassfbabc0f2013-06-13 15:10:01 -0700208 * @return 0 if ok, -1 on error
209 */
210static int fit_image_process_sig(const char *keydir, void *keydest,
211 void *fit, const char *image_name,
212 int noffset, const void *data, size_t size,
Alex Kiernan697fcdc2018-06-20 20:10:52 +0000213 const char *comment, int require_keys, const char *engine_id,
214 const char *cmdname)
Simon Glassfbabc0f2013-06-13 15:10:01 -0700215{
216 struct image_sign_info info;
217 struct image_region region;
218 const char *node_name;
219 uint8_t *value;
220 uint value_len;
221 int ret;
222
223 if (fit_image_setup_sig(&info, keydir, fit, image_name, noffset,
George McCollister23d14892017-01-06 13:14:17 -0600224 require_keys ? "image" : NULL, engine_id))
Simon Glassfbabc0f2013-06-13 15:10:01 -0700225 return -1;
226
227 node_name = fit_get_name(fit, noffset, NULL);
228 region.data = data;
229 region.size = size;
Andrew Duda6616c822016-11-08 18:53:41 +0000230 ret = info.crypto->sign(&info, &region, 1, &value, &value_len);
Simon Glassfbabc0f2013-06-13 15:10:01 -0700231 if (ret) {
232 printf("Failed to sign '%s' signature node in '%s' image node: %d\n",
233 node_name, image_name, ret);
234
235 /* We allow keys to be missing */
236 if (ret == -ENOENT)
237 return 0;
238 return -1;
239 }
240
241 ret = fit_image_write_sig(fit, noffset, value, value_len, comment,
Alex Kiernan697fcdc2018-06-20 20:10:52 +0000242 NULL, 0, cmdname);
Simon Glassfbabc0f2013-06-13 15:10:01 -0700243 if (ret) {
Simon Glass802aa822014-06-02 22:04:53 -0600244 if (ret == -FDT_ERR_NOSPACE)
245 return -ENOSPC;
246 printf("Can't write signature for '%s' signature node in '%s' conf node: %s\n",
Simon Glassfbabc0f2013-06-13 15:10:01 -0700247 node_name, image_name, fdt_strerror(ret));
248 return -1;
249 }
250 free(value);
251
252 /* Get keyname again, as FDT has changed and invalidated our pointer */
Simon Glassd7aabcc2020-03-18 11:44:06 -0600253 info.keyname = fdt_getprop(fit, noffset, FIT_KEY_HINT, NULL);
Simon Glassfbabc0f2013-06-13 15:10:01 -0700254
mario.six@gdsys.ccdc4053a2016-07-22 08:58:40 +0200255 /*
256 * Write the public key into the supplied FDT file; this might fail
mario.six@gdsys.ccd019e152016-07-19 11:07:06 +0200257 * several times, since we try signing with successively increasing
mario.six@gdsys.ccdc4053a2016-07-22 08:58:40 +0200258 * size values
259 */
Masahiro Yamada01486762017-10-27 15:04:20 +0900260 if (keydest) {
261 ret = info.crypto->add_verify_data(&info, keydest);
262 if (ret) {
263 printf("Failed to add verification data for '%s' signature node in '%s' image node\n",
264 node_name, image_name);
265 return ret;
266 }
267 }
Simon Glassfbabc0f2013-06-13 15:10:01 -0700268
269 return 0;
270}
271
Philippe Reynes3148e422019-12-18 18:25:41 +0100272static int fit_image_read_data(char *filename, unsigned char *data,
273 int expected_size)
274{
275 struct stat sbuf;
276 int fd, ret = -1;
277 ssize_t n;
278
279 /* Open file */
280 fd = open(filename, O_RDONLY | O_BINARY);
281 if (fd < 0) {
282 printf("Can't open file %s (err=%d => %s)\n",
283 filename, errno, strerror(errno));
284 return -1;
285 }
286
287 /* Compute file size */
288 if (fstat(fd, &sbuf) < 0) {
289 printf("Can't fstat file %s (err=%d => %s)\n",
290 filename, errno, strerror(errno));
291 goto err;
292 }
293
294 /* Check file size */
295 if (sbuf.st_size != expected_size) {
296 printf("File %s don't have the expected size (size=%ld, expected=%d)\n",
297 filename, sbuf.st_size, expected_size);
298 goto err;
299 }
300
301 /* Read data */
302 n = read(fd, data, sbuf.st_size);
303 if (n < 0) {
304 printf("Can't read file %s (err=%d => %s)\n",
305 filename, errno, strerror(errno));
306 goto err;
307 }
308
309 /* Check that we have read all the file */
310 if (n != sbuf.st_size) {
Heinrich Schuchardt6495fe02020-04-11 18:36:04 +0200311 printf("Can't read all file %s (read %zd bytes, expexted %ld)\n",
Philippe Reynes3148e422019-12-18 18:25:41 +0100312 filename, n, sbuf.st_size);
313 goto err;
314 }
315
316 ret = 0;
317
318err:
319 close(fd);
320 return ret;
321}
322
323static int fit_image_setup_cipher(struct image_cipher_info *info,
324 const char *keydir, void *fit,
325 const char *image_name, int image_noffset,
Patrick Oppenlanderd586fc32020-07-30 14:22:13 +1000326 int noffset)
Philippe Reynes3148e422019-12-18 18:25:41 +0100327{
328 char *algo_name;
329 char filename[128];
330 int ret = -1;
331
332 if (fit_image_cipher_get_algo(fit, noffset, &algo_name)) {
Patrick Oppenlanderd586fc32020-07-30 14:22:13 +1000333 printf("Can't get algo name for cipher in image '%s'\n",
334 image_name);
Philippe Reynes3148e422019-12-18 18:25:41 +0100335 goto out;
336 }
337
338 info->keydir = keydir;
339
340 /* Read the key name */
Simon Glassd7aabcc2020-03-18 11:44:06 -0600341 info->keyname = fdt_getprop(fit, noffset, FIT_KEY_HINT, NULL);
Philippe Reynes3148e422019-12-18 18:25:41 +0100342 if (!info->keyname) {
Patrick Oppenlanderd586fc32020-07-30 14:22:13 +1000343 printf("Can't get key name for cipher in image '%s'\n",
344 image_name);
Philippe Reynes3148e422019-12-18 18:25:41 +0100345 goto out;
346 }
347
348 /* Read the IV name */
349 info->ivname = fdt_getprop(fit, noffset, "iv-name-hint", NULL);
350 if (!info->ivname) {
Patrick Oppenlanderd586fc32020-07-30 14:22:13 +1000351 printf("Can't get iv name for cipher in image '%s'\n",
352 image_name);
Philippe Reynes3148e422019-12-18 18:25:41 +0100353 goto out;
354 }
355
356 info->fit = fit;
357 info->node_noffset = noffset;
358 info->name = algo_name;
359
360 info->cipher = image_get_cipher_algo(algo_name);
361 if (!info->cipher) {
362 printf("Can't get algo for cipher '%s'\n", image_name);
363 goto out;
364 }
365
366 /* Read the key in the file */
367 snprintf(filename, sizeof(filename), "%s/%s%s",
368 info->keydir, info->keyname, ".bin");
369 info->key = malloc(info->cipher->key_len);
370 if (!info->key) {
371 printf("Can't allocate memory for key\n");
372 ret = -1;
373 goto out;
374 }
375 ret = fit_image_read_data(filename, (unsigned char *)info->key,
376 info->cipher->key_len);
377 if (ret < 0)
378 goto out;
379
380 /* Read the IV in the file */
381 snprintf(filename, sizeof(filename), "%s/%s%s",
382 info->keydir, info->ivname, ".bin");
383 info->iv = malloc(info->cipher->iv_len);
384 if (!info->iv) {
385 printf("Can't allocate memory for iv\n");
386 ret = -1;
387 goto out;
388 }
389 ret = fit_image_read_data(filename, (unsigned char *)info->iv,
390 info->cipher->iv_len);
391
392 out:
393 return ret;
394}
395
396int fit_image_write_cipher(void *fit, int image_noffset, int noffset,
397 const void *data, size_t size,
398 unsigned char *data_ciphered, int data_ciphered_len)
399{
400 int ret = -1;
401
Patrick Oppenlanderbe472112020-07-30 14:22:14 +1000402 /* Replace data with ciphered data */
Philippe Reynes3148e422019-12-18 18:25:41 +0100403 ret = fdt_setprop(fit, image_noffset, FIT_DATA_PROP,
404 data_ciphered, data_ciphered_len);
Patrick Oppenlanderbe472112020-07-30 14:22:14 +1000405 if (ret == -FDT_ERR_NOSPACE) {
406 ret = -ENOSPC;
407 goto out;
408 }
Philippe Reynes3148e422019-12-18 18:25:41 +0100409 if (ret) {
Patrick Oppenlanderbe472112020-07-30 14:22:14 +1000410 printf("Can't replace data with ciphered data (err = %d)\n", ret);
Philippe Reynes3148e422019-12-18 18:25:41 +0100411 goto out;
412 }
413
414 /* add non ciphered data size */
415 ret = fdt_setprop_u32(fit, image_noffset, "data-size-unciphered", size);
Patrick Oppenlanderbe472112020-07-30 14:22:14 +1000416 if (ret == -FDT_ERR_NOSPACE) {
417 ret = -ENOSPC;
418 goto out;
419 }
Philippe Reynes3148e422019-12-18 18:25:41 +0100420 if (ret) {
421 printf("Can't add unciphered data size (err = %d)\n", ret);
422 goto out;
423 }
424
425 out:
426 return ret;
427}
428
429static int
430fit_image_process_cipher(const char *keydir, void *keydest, void *fit,
431 const char *image_name, int image_noffset,
Patrick Oppenlanderd586fc32020-07-30 14:22:13 +1000432 int node_noffset, const void *data, size_t size,
Philippe Reynes3148e422019-12-18 18:25:41 +0100433 const char *cmdname)
434{
435 struct image_cipher_info info;
436 unsigned char *data_ciphered = NULL;
437 int data_ciphered_len;
438 int ret;
439
440 memset(&info, 0, sizeof(info));
441
442 ret = fit_image_setup_cipher(&info, keydir, fit, image_name,
Patrick Oppenlanderd586fc32020-07-30 14:22:13 +1000443 image_noffset, node_noffset);
Philippe Reynes3148e422019-12-18 18:25:41 +0100444 if (ret)
445 goto out;
446
447 ret = info.cipher->encrypt(&info, data, size,
448 &data_ciphered, &data_ciphered_len);
449 if (ret)
450 goto out;
451
452 /*
453 * Write the public key into the supplied FDT file; this might fail
454 * several times, since we try signing with successively increasing
455 * size values
456 */
457 if (keydest) {
458 ret = info.cipher->add_cipher_data(&info, keydest);
459 if (ret) {
460 printf("Failed to add verification data for cipher '%s' in image '%s'\n",
461 info.keyname, image_name);
462 goto out;
463 }
464 }
465
466 ret = fit_image_write_cipher(fit, image_noffset, node_noffset,
467 data, size,
468 data_ciphered, data_ciphered_len);
469
470 out:
471 free(data_ciphered);
472 free((void *)info.key);
473 free((void *)info.iv);
474 return ret;
475}
476
477int fit_image_cipher_data(const char *keydir, void *keydest,
478 void *fit, int image_noffset, const char *comment,
479 int require_keys, const char *engine_id,
480 const char *cmdname)
481{
482 const char *image_name;
483 const void *data;
484 size_t size;
Patrick Oppenlandera4fafb32020-07-30 14:22:15 +1000485 int cipher_node_offset, len;
Philippe Reynes3148e422019-12-18 18:25:41 +0100486
487 /* Get image name */
488 image_name = fit_get_name(fit, image_noffset, NULL);
489 if (!image_name) {
490 printf("Can't get image name\n");
491 return -1;
492 }
493
494 /* Get image data and data length */
495 if (fit_image_get_data(fit, image_noffset, &data, &size)) {
496 printf("Can't get image data/size\n");
497 return -1;
498 }
499
Patrick Oppenlandera4fafb32020-07-30 14:22:15 +1000500 /*
501 * Don't cipher ciphered data.
502 *
503 * If the data-size-unciphered property is present the data for this
504 * image is already encrypted. This is important as 'mkimage -F' can be
505 * run multiple times on a FIT image.
506 */
507 if (fdt_getprop(fit, image_noffset, "data-size-unciphered", &len))
508 return 0;
509 if (len != -FDT_ERR_NOTFOUND) {
510 printf("Failure testing for data-size-unciphered\n");
511 return -1;
512 }
Philippe Reynes3148e422019-12-18 18:25:41 +0100513
Patrick Oppenlanderd586fc32020-07-30 14:22:13 +1000514 /* Process cipher node if present */
515 cipher_node_offset = fdt_subnode_offset(fit, image_noffset,
516 FIT_CIPHER_NODENAME);
517 if (cipher_node_offset == -FDT_ERR_NOTFOUND)
518 return 0;
519 if (cipher_node_offset < 0) {
520 printf("Failure getting cipher node\n");
521 return -1;
Philippe Reynes3148e422019-12-18 18:25:41 +0100522 }
Patrick Oppenlanderd586fc32020-07-30 14:22:13 +1000523 if (!IMAGE_ENABLE_ENCRYPT || !keydir)
524 return 0;
525 return fit_image_process_cipher(keydir, keydest, fit, image_name,
526 image_noffset, cipher_node_offset, data, size, cmdname);
Philippe Reynes3148e422019-12-18 18:25:41 +0100527}
528
Simon Glassfbabc0f2013-06-13 15:10:01 -0700529/**
530 * fit_image_add_verification_data() - calculate/set verig. data for image node
531 *
532 * This adds hash and signature values for an component image node.
Simon Glassee382652013-05-07 06:12:01 +0000533 *
534 * All existing hash subnodes are checked, if algorithm property is set to
535 * one of the supported hash algorithms, hash value is computed and
536 * corresponding hash node property is set, for example:
Simon Glass10a1eca2013-05-07 06:11:54 +0000537 *
538 * Input component image node structure:
539 *
Andre Przywara3234ecd2017-12-04 02:05:10 +0000540 * o image-1 (at image_noffset)
Simon Glass10a1eca2013-05-07 06:11:54 +0000541 * | - data = [binary data]
Andre Przywara3234ecd2017-12-04 02:05:10 +0000542 * o hash-1
Simon Glass10a1eca2013-05-07 06:11:54 +0000543 * |- algo = "sha1"
544 *
545 * Output component image node structure:
546 *
Andre Przywara3234ecd2017-12-04 02:05:10 +0000547 * o image-1 (at image_noffset)
Simon Glass10a1eca2013-05-07 06:11:54 +0000548 * | - data = [binary data]
Andre Przywara3234ecd2017-12-04 02:05:10 +0000549 * o hash-1
Simon Glass10a1eca2013-05-07 06:11:54 +0000550 * |- algo = "sha1"
551 * |- value = sha1(data)
552 *
Simon Glassee382652013-05-07 06:12:01 +0000553 * For signature details, please see doc/uImage.FIT/signature.txt
554 *
Simon Glassfbabc0f2013-06-13 15:10:01 -0700555 * @keydir Directory containing *.key and *.crt files (or NULL)
556 * @keydest FDT Blob to write public keys into (NULL if none)
Simon Glassee382652013-05-07 06:12:01 +0000557 * @fit: Pointer to the FIT format image header
558 * @image_noffset: Requested component image node
Simon Glassfbabc0f2013-06-13 15:10:01 -0700559 * @comment: Comment to add to signature nodes
560 * @require_keys: Mark all keys as 'required'
George McCollister23d14892017-01-06 13:14:17 -0600561 * @engine_id: Engine to use for signing
Simon Glassee382652013-05-07 06:12:01 +0000562 * @return: 0 on success, <0 on failure
Simon Glass10a1eca2013-05-07 06:11:54 +0000563 */
Simon Glassfbabc0f2013-06-13 15:10:01 -0700564int fit_image_add_verification_data(const char *keydir, void *keydest,
565 void *fit, int image_noffset, const char *comment,
Alex Kiernan697fcdc2018-06-20 20:10:52 +0000566 int require_keys, const char *engine_id, const char *cmdname)
Simon Glass10a1eca2013-05-07 06:11:54 +0000567{
Simon Glassee382652013-05-07 06:12:01 +0000568 const char *image_name;
Simon Glass10a1eca2013-05-07 06:11:54 +0000569 const void *data;
570 size_t size;
Simon Glass10a1eca2013-05-07 06:11:54 +0000571 int noffset;
Simon Glass10a1eca2013-05-07 06:11:54 +0000572
573 /* Get image data and data length */
574 if (fit_image_get_data(fit, image_noffset, &data, &size)) {
575 printf("Can't get image data/size\n");
576 return -1;
577 }
578
Simon Glass25d6e6b2013-05-07 06:11:55 +0000579 image_name = fit_get_name(fit, image_noffset, NULL);
580
Simon Glass10a1eca2013-05-07 06:11:54 +0000581 /* Process all hash subnodes of the component image node */
Simon Glassee382652013-05-07 06:12:01 +0000582 for (noffset = fdt_first_subnode(fit, image_noffset);
583 noffset >= 0;
584 noffset = fdt_next_subnode(fit, noffset)) {
585 const char *node_name;
586 int ret = 0;
587
588 /*
589 * Check subnode name, must be equal to "hash" or "signature".
590 * Multiple hash nodes require unique unit node
Andre Przywara3234ecd2017-12-04 02:05:10 +0000591 * names, e.g. hash-1, hash-2, signature-1, etc.
Simon Glassee382652013-05-07 06:12:01 +0000592 */
593 node_name = fit_get_name(fit, noffset, NULL);
594 if (!strncmp(node_name, FIT_HASH_NODENAME,
595 strlen(FIT_HASH_NODENAME))) {
596 ret = fit_image_process_hash(fit, image_name, noffset,
597 data, size);
Simon Glassfbabc0f2013-06-13 15:10:01 -0700598 } else if (IMAGE_ENABLE_SIGN && keydir &&
599 !strncmp(node_name, FIT_SIG_NODENAME,
600 strlen(FIT_SIG_NODENAME))) {
601 ret = fit_image_process_sig(keydir, keydest,
602 fit, image_name, noffset, data, size,
Alex Kiernan697fcdc2018-06-20 20:10:52 +0000603 comment, require_keys, engine_id, cmdname);
Simon Glass10a1eca2013-05-07 06:11:54 +0000604 }
Simon Glassee382652013-05-07 06:12:01 +0000605 if (ret)
Simon Glassec539f72016-07-03 09:40:44 -0600606 return ret;
Simon Glassee382652013-05-07 06:12:01 +0000607 }
608
609 return 0;
610}
611
Simon Glass56ab8d62013-06-13 15:10:09 -0700612struct strlist {
613 int count;
614 char **strings;
615};
616
617static void strlist_init(struct strlist *list)
618{
619 memset(list, '\0', sizeof(*list));
620}
621
622static void strlist_free(struct strlist *list)
623{
624 int i;
625
626 for (i = 0; i < list->count; i++)
627 free(list->strings[i]);
628 free(list->strings);
629}
630
631static int strlist_add(struct strlist *list, const char *str)
632{
633 char *dup;
634
635 dup = strdup(str);
636 list->strings = realloc(list->strings,
637 (list->count + 1) * sizeof(char *));
638 if (!list || !str)
639 return -1;
640 list->strings[list->count++] = dup;
641
642 return 0;
643}
644
645static const char *fit_config_get_image_list(void *fit, int noffset,
646 int *lenp, int *allow_missingp)
647{
648 static const char default_list[] = FIT_KERNEL_PROP "\0"
649 FIT_FDT_PROP;
650 const char *prop;
651
652 /* If there is an "image" property, use that */
653 prop = fdt_getprop(fit, noffset, "sign-images", lenp);
654 if (prop) {
655 *allow_missingp = 0;
656 return *lenp ? prop : NULL;
657 }
658
659 /* Default image list */
660 *allow_missingp = 1;
661 *lenp = sizeof(default_list);
662
663 return default_list;
664}
665
666static int fit_config_get_hash_list(void *fit, int conf_noffset,
667 int sig_offset, struct strlist *node_inc)
668{
669 int allow_missing;
670 const char *prop, *iname, *end;
671 const char *conf_name, *sig_name;
672 char name[200], path[200];
673 int image_count;
674 int ret, len;
675
676 conf_name = fit_get_name(fit, conf_noffset, NULL);
677 sig_name = fit_get_name(fit, sig_offset, NULL);
678
679 /*
680 * Build a list of nodes we need to hash. We always need the root
681 * node and the configuration.
682 */
683 strlist_init(node_inc);
684 snprintf(name, sizeof(name), "%s/%s", FIT_CONFS_PATH, conf_name);
685 if (strlist_add(node_inc, "/") ||
686 strlist_add(node_inc, name))
687 goto err_mem;
688
689 /* Get a list of images that we intend to sign */
Heiko Schocherfdfd5202014-03-03 12:19:23 +0100690 prop = fit_config_get_image_list(fit, sig_offset, &len,
Simon Glass56ab8d62013-06-13 15:10:09 -0700691 &allow_missing);
692 if (!prop)
693 return 0;
694
695 /* Locate the images */
696 end = prop + len;
697 image_count = 0;
698 for (iname = prop; iname < end; iname += strlen(iname) + 1) {
699 int noffset;
700 int image_noffset;
701 int hash_count;
702
703 image_noffset = fit_conf_get_prop_node(fit, conf_noffset,
704 iname);
705 if (image_noffset < 0) {
706 printf("Failed to find image '%s' in configuration '%s/%s'\n",
707 iname, conf_name, sig_name);
708 if (allow_missing)
709 continue;
710
711 return -ENOENT;
712 }
713
714 ret = fdt_get_path(fit, image_noffset, path, sizeof(path));
715 if (ret < 0)
716 goto err_path;
717 if (strlist_add(node_inc, path))
718 goto err_mem;
719
720 snprintf(name, sizeof(name), "%s/%s", FIT_CONFS_PATH,
721 conf_name);
722
723 /* Add all this image's hashes */
724 hash_count = 0;
725 for (noffset = fdt_first_subnode(fit, image_noffset);
726 noffset >= 0;
727 noffset = fdt_next_subnode(fit, noffset)) {
728 const char *name = fit_get_name(fit, noffset, NULL);
729
730 if (strncmp(name, FIT_HASH_NODENAME,
731 strlen(FIT_HASH_NODENAME)))
732 continue;
733 ret = fdt_get_path(fit, noffset, path, sizeof(path));
734 if (ret < 0)
735 goto err_path;
736 if (strlist_add(node_inc, path))
737 goto err_mem;
738 hash_count++;
739 }
740
741 if (!hash_count) {
742 printf("Failed to find any hash nodes in configuration '%s/%s' image '%s' - without these it is not possible to verify this image\n",
743 conf_name, sig_name, iname);
744 return -ENOMSG;
745 }
746
747 image_count++;
748 }
749
750 if (!image_count) {
751 printf("Failed to find any images for configuration '%s/%s'\n",
752 conf_name, sig_name);
753 return -ENOMSG;
754 }
755
756 return 0;
757
758err_mem:
759 printf("Out of memory processing configuration '%s/%s'\n", conf_name,
760 sig_name);
761 return -ENOMEM;
762
763err_path:
764 printf("Failed to get path for image '%s' in configuration '%s/%s': %s\n",
765 iname, conf_name, sig_name, fdt_strerror(ret));
766 return -ENOENT;
767}
768
769static int fit_config_get_data(void *fit, int conf_noffset, int noffset,
770 struct image_region **regionp, int *region_countp,
771 char **region_propp, int *region_proplen)
772{
773 char * const exc_prop[] = {"data"};
774 struct strlist node_inc;
775 struct image_region *region;
776 struct fdt_region fdt_regions[100];
777 const char *conf_name, *sig_name;
778 char path[200];
779 int count, i;
780 char *region_prop;
781 int ret, len;
782
783 conf_name = fit_get_name(fit, conf_noffset, NULL);
Masahiro Yamada2fc6b6f2017-10-19 19:16:21 +0900784 sig_name = fit_get_name(fit, noffset, NULL);
Simon Glass56ab8d62013-06-13 15:10:09 -0700785 debug("%s: conf='%s', sig='%s'\n", __func__, conf_name, sig_name);
786
787 /* Get a list of nodes we want to hash */
788 ret = fit_config_get_hash_list(fit, conf_noffset, noffset, &node_inc);
789 if (ret)
790 return ret;
791
792 /* Get a list of regions to hash */
793 count = fdt_find_regions(fit, node_inc.strings, node_inc.count,
794 exc_prop, ARRAY_SIZE(exc_prop),
795 fdt_regions, ARRAY_SIZE(fdt_regions),
796 path, sizeof(path), 1);
797 if (count < 0) {
798 printf("Failed to hash configuration '%s/%s': %s\n", conf_name,
799 sig_name, fdt_strerror(ret));
800 return -EIO;
801 }
802 if (count == 0) {
803 printf("No data to hash for configuration '%s/%s': %s\n",
804 conf_name, sig_name, fdt_strerror(ret));
805 return -EINVAL;
806 }
807
808 /* Build our list of data blocks */
809 region = fit_region_make_list(fit, fdt_regions, count, NULL);
810 if (!region) {
811 printf("Out of memory hashing configuration '%s/%s'\n",
812 conf_name, sig_name);
813 return -ENOMEM;
814 }
815
816 /* Create a list of all hashed properties */
817 debug("Hash nodes:\n");
818 for (i = len = 0; i < node_inc.count; i++) {
819 debug(" %s\n", node_inc.strings[i]);
820 len += strlen(node_inc.strings[i]) + 1;
821 }
822 region_prop = malloc(len);
823 if (!region_prop) {
824 printf("Out of memory setting up regions for configuration '%s/%s'\n",
825 conf_name, sig_name);
826 return -ENOMEM;
827 }
828 for (i = len = 0; i < node_inc.count;
829 len += strlen(node_inc.strings[i]) + 1, i++)
830 strcpy(region_prop + len, node_inc.strings[i]);
831 strlist_free(&node_inc);
832
833 *region_countp = count;
834 *regionp = region;
835 *region_propp = region_prop;
836 *region_proplen = len;
837
838 return 0;
839}
840
841static int fit_config_process_sig(const char *keydir, void *keydest,
842 void *fit, const char *conf_name, int conf_noffset,
George McCollister23d14892017-01-06 13:14:17 -0600843 int noffset, const char *comment, int require_keys,
Alex Kiernan697fcdc2018-06-20 20:10:52 +0000844 const char *engine_id, const char *cmdname)
Simon Glass56ab8d62013-06-13 15:10:09 -0700845{
846 struct image_sign_info info;
847 const char *node_name;
848 struct image_region *region;
849 char *region_prop;
850 int region_proplen;
851 int region_count;
852 uint8_t *value;
853 uint value_len;
854 int ret;
855
856 node_name = fit_get_name(fit, noffset, NULL);
857 if (fit_config_get_data(fit, conf_noffset, noffset, &region,
858 &region_count, &region_prop, &region_proplen))
859 return -1;
860
861 if (fit_image_setup_sig(&info, keydir, fit, conf_name, noffset,
George McCollister23d14892017-01-06 13:14:17 -0600862 require_keys ? "conf" : NULL, engine_id))
Simon Glass56ab8d62013-06-13 15:10:09 -0700863 return -1;
864
Andrew Duda6616c822016-11-08 18:53:41 +0000865 ret = info.crypto->sign(&info, region, region_count, &value,
866 &value_len);
Simon Glass56ab8d62013-06-13 15:10:09 -0700867 free(region);
868 if (ret) {
869 printf("Failed to sign '%s' signature node in '%s' conf node\n",
870 node_name, conf_name);
871
872 /* We allow keys to be missing */
873 if (ret == -ENOENT)
874 return 0;
875 return -1;
876 }
877
Simon Glass802aa822014-06-02 22:04:53 -0600878 ret = fit_image_write_sig(fit, noffset, value, value_len, comment,
Alex Kiernan697fcdc2018-06-20 20:10:52 +0000879 region_prop, region_proplen, cmdname);
Simon Glass802aa822014-06-02 22:04:53 -0600880 if (ret) {
881 if (ret == -FDT_ERR_NOSPACE)
882 return -ENOSPC;
883 printf("Can't write signature for '%s' signature node in '%s' conf node: %s\n",
884 node_name, conf_name, fdt_strerror(ret));
Simon Glass56ab8d62013-06-13 15:10:09 -0700885 return -1;
886 }
887 free(value);
888 free(region_prop);
889
890 /* Get keyname again, as FDT has changed and invalidated our pointer */
Simon Glassd7aabcc2020-03-18 11:44:06 -0600891 info.keyname = fdt_getprop(fit, noffset, FIT_KEY_HINT, NULL);
Simon Glass56ab8d62013-06-13 15:10:09 -0700892
893 /* Write the public key into the supplied FDT file */
Simon Glass802aa822014-06-02 22:04:53 -0600894 if (keydest) {
Andrew Duda6616c822016-11-08 18:53:41 +0000895 ret = info.crypto->add_verify_data(&info, keydest);
Simon Glass802aa822014-06-02 22:04:53 -0600896 if (ret) {
Masahiro Yamadafe391a72017-10-27 15:04:21 +0900897 printf("Failed to add verification data for '%s' signature node in '%s' configuration node\n",
Simon Glass802aa822014-06-02 22:04:53 -0600898 node_name, conf_name);
Simon Glass802aa822014-06-02 22:04:53 -0600899 }
Simon Glass9423bad2014-06-12 07:24:42 -0600900 return ret;
Simon Glass56ab8d62013-06-13 15:10:09 -0700901 }
902
903 return 0;
904}
905
906static int fit_config_add_verification_data(const char *keydir, void *keydest,
907 void *fit, int conf_noffset, const char *comment,
Alex Kiernan697fcdc2018-06-20 20:10:52 +0000908 int require_keys, const char *engine_id, const char *cmdname)
Simon Glass56ab8d62013-06-13 15:10:09 -0700909{
910 const char *conf_name;
911 int noffset;
912
913 conf_name = fit_get_name(fit, conf_noffset, NULL);
914
915 /* Process all hash subnodes of the configuration node */
916 for (noffset = fdt_first_subnode(fit, conf_noffset);
917 noffset >= 0;
918 noffset = fdt_next_subnode(fit, noffset)) {
919 const char *node_name;
920 int ret = 0;
921
922 node_name = fit_get_name(fit, noffset, NULL);
923 if (!strncmp(node_name, FIT_SIG_NODENAME,
924 strlen(FIT_SIG_NODENAME))) {
925 ret = fit_config_process_sig(keydir, keydest,
926 fit, conf_name, conf_noffset, noffset, comment,
Alex Kiernan697fcdc2018-06-20 20:10:52 +0000927 require_keys, engine_id, cmdname);
Simon Glass56ab8d62013-06-13 15:10:09 -0700928 }
929 if (ret)
930 return ret;
931 }
932
933 return 0;
934}
935
Philippe Reynes3148e422019-12-18 18:25:41 +0100936int fit_cipher_data(const char *keydir, void *keydest, void *fit,
937 const char *comment, int require_keys,
938 const char *engine_id, const char *cmdname)
939{
940 int images_noffset;
941 int noffset;
942 int ret;
943
944 /* Find images parent node offset */
945 images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
946 if (images_noffset < 0) {
947 printf("Can't find images parent node '%s' (%s)\n",
948 FIT_IMAGES_PATH, fdt_strerror(images_noffset));
949 return images_noffset;
950 }
951
952 /* Process its subnodes, print out component images details */
953 for (noffset = fdt_first_subnode(fit, images_noffset);
954 noffset >= 0;
955 noffset = fdt_next_subnode(fit, noffset)) {
956 /*
957 * Direct child node of the images parent node,
958 * i.e. component image node.
959 */
960 ret = fit_image_cipher_data(keydir, keydest,
961 fit, noffset, comment,
962 require_keys, engine_id,
963 cmdname);
964 if (ret)
965 return ret;
966 }
967
968 return 0;
969}
970
Simon Glassfbabc0f2013-06-13 15:10:01 -0700971int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
George McCollister23d14892017-01-06 13:14:17 -0600972 const char *comment, int require_keys,
Alex Kiernan697fcdc2018-06-20 20:10:52 +0000973 const char *engine_id, const char *cmdname)
Simon Glassee382652013-05-07 06:12:01 +0000974{
Simon Glass56ab8d62013-06-13 15:10:09 -0700975 int images_noffset, confs_noffset;
Simon Glassee382652013-05-07 06:12:01 +0000976 int noffset;
977 int ret;
978
979 /* Find images parent node offset */
980 images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
981 if (images_noffset < 0) {
982 printf("Can't find images parent node '%s' (%s)\n",
983 FIT_IMAGES_PATH, fdt_strerror(images_noffset));
984 return images_noffset;
985 }
986
987 /* Process its subnodes, print out component images details */
988 for (noffset = fdt_first_subnode(fit, images_noffset);
989 noffset >= 0;
990 noffset = fdt_next_subnode(fit, noffset)) {
991 /*
992 * Direct child node of the images parent node,
993 * i.e. component image node.
994 */
Simon Glassfbabc0f2013-06-13 15:10:01 -0700995 ret = fit_image_add_verification_data(keydir, keydest,
Alex Kiernan697fcdc2018-06-20 20:10:52 +0000996 fit, noffset, comment, require_keys, engine_id,
997 cmdname);
Simon Glassee382652013-05-07 06:12:01 +0000998 if (ret)
999 return ret;
Simon Glass10a1eca2013-05-07 06:11:54 +00001000 }
1001
Simon Glass56ab8d62013-06-13 15:10:09 -07001002 /* If there are no keys, we can't sign configurations */
1003 if (!IMAGE_ENABLE_SIGN || !keydir)
1004 return 0;
1005
1006 /* Find configurations parent node offset */
1007 confs_noffset = fdt_path_offset(fit, FIT_CONFS_PATH);
1008 if (confs_noffset < 0) {
1009 printf("Can't find images parent node '%s' (%s)\n",
Heiko Schocher441f48d2014-08-11 11:02:17 +02001010 FIT_CONFS_PATH, fdt_strerror(confs_noffset));
Simon Glass56ab8d62013-06-13 15:10:09 -07001011 return -ENOENT;
1012 }
1013
1014 /* Process its subnodes, print out component images details */
1015 for (noffset = fdt_first_subnode(fit, confs_noffset);
1016 noffset >= 0;
1017 noffset = fdt_next_subnode(fit, noffset)) {
1018 ret = fit_config_add_verification_data(keydir, keydest,
1019 fit, noffset, comment,
George McCollister23d14892017-01-06 13:14:17 -06001020 require_keys,
Alex Kiernan697fcdc2018-06-20 20:10:52 +00001021 engine_id, cmdname);
Simon Glass56ab8d62013-06-13 15:10:09 -07001022 if (ret)
1023 return ret;
1024 }
1025
Simon Glass10a1eca2013-05-07 06:11:54 +00001026 return 0;
1027}
Heiko Schocherd7b42322014-03-03 12:19:30 +01001028
1029#ifdef CONFIG_FIT_SIGNATURE
Simon Glass05712322020-03-18 11:44:03 -06001030int fit_check_sign(const void *fit, const void *key,
1031 const char *fit_uname_config)
Heiko Schocherd7b42322014-03-03 12:19:30 +01001032{
1033 int cfg_noffset;
1034 int ret;
1035
Simon Glass05712322020-03-18 11:44:03 -06001036 cfg_noffset = fit_conf_get_node(fit, fit_uname_config);
Heiko Schocherd7b42322014-03-03 12:19:30 +01001037 if (!cfg_noffset)
1038 return -1;
1039
Simon Glassa559bb22020-03-18 11:43:56 -06001040 printf("Verifying Hash Integrity for node '%s'... ",
1041 fdt_get_name(fit, cfg_noffset, NULL));
Simon Glassa51991d2014-06-12 07:24:53 -06001042 ret = fit_config_verify(fit, cfg_noffset);
1043 if (ret)
1044 return ret;
Simon Glass05712322020-03-18 11:44:03 -06001045 printf("Verified OK, loading images\n");
Simon Glassa51991d2014-06-12 07:24:53 -06001046 ret = bootm_host_load_images(fit, cfg_noffset);
1047
Heiko Schocherd7b42322014-03-03 12:19:30 +01001048 return ret;
1049}
1050#endif