blob: 8886beff175c3a3b0388ff8443cae6bb89e50fee [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
Philippe Reynes64d67c42020-09-17 15:01:46 +0200323static int get_random_data(void *data, int size)
324{
325 unsigned char *tmp = data;
326 struct timespec date;
327 int i, ret = 0;
328
329 if (!tmp) {
330 printf("%s: pointer data is NULL\n", __func__);
331 ret = -1;
332 goto out;
333 }
334
335 ret = clock_gettime(CLOCK_MONOTONIC, &date);
336 if (ret < 0) {
337 printf("%s: clock_gettime has failed (err=%d, str=%s)\n",
338 __func__, ret, strerror(ret));
339 goto out;
340 }
341
342 srand(date.tv_nsec);
343
344 for (i = 0; i < size; i++) {
345 *tmp = rand() & 0xff;
346 tmp++;
347 }
348
349 out:
350 return ret;
351}
352
Philippe Reynes3148e422019-12-18 18:25:41 +0100353static int fit_image_setup_cipher(struct image_cipher_info *info,
354 const char *keydir, void *fit,
355 const char *image_name, int image_noffset,
Patrick Oppenlanderd586fc32020-07-30 14:22:13 +1000356 int noffset)
Philippe Reynes3148e422019-12-18 18:25:41 +0100357{
358 char *algo_name;
359 char filename[128];
360 int ret = -1;
361
362 if (fit_image_cipher_get_algo(fit, noffset, &algo_name)) {
Patrick Oppenlanderd586fc32020-07-30 14:22:13 +1000363 printf("Can't get algo name for cipher in image '%s'\n",
364 image_name);
Philippe Reynes3148e422019-12-18 18:25:41 +0100365 goto out;
366 }
367
368 info->keydir = keydir;
369
370 /* Read the key name */
Simon Glassd7aabcc2020-03-18 11:44:06 -0600371 info->keyname = fdt_getprop(fit, noffset, FIT_KEY_HINT, NULL);
Philippe Reynes3148e422019-12-18 18:25:41 +0100372 if (!info->keyname) {
Patrick Oppenlanderd586fc32020-07-30 14:22:13 +1000373 printf("Can't get key name for cipher in image '%s'\n",
374 image_name);
Philippe Reynes3148e422019-12-18 18:25:41 +0100375 goto out;
376 }
377
Philippe Reynes64d67c42020-09-17 15:01:46 +0200378 /*
379 * Read the IV name
380 *
381 * If this property is not provided then mkimage will generate
382 * a random IV and store it in the FIT image
383 */
Philippe Reynes3148e422019-12-18 18:25:41 +0100384 info->ivname = fdt_getprop(fit, noffset, "iv-name-hint", NULL);
Philippe Reynes3148e422019-12-18 18:25:41 +0100385
386 info->fit = fit;
387 info->node_noffset = noffset;
388 info->name = algo_name;
389
390 info->cipher = image_get_cipher_algo(algo_name);
391 if (!info->cipher) {
392 printf("Can't get algo for cipher '%s'\n", image_name);
393 goto out;
394 }
395
396 /* Read the key in the file */
397 snprintf(filename, sizeof(filename), "%s/%s%s",
398 info->keydir, info->keyname, ".bin");
399 info->key = malloc(info->cipher->key_len);
400 if (!info->key) {
401 printf("Can't allocate memory for key\n");
402 ret = -1;
403 goto out;
404 }
405 ret = fit_image_read_data(filename, (unsigned char *)info->key,
406 info->cipher->key_len);
407 if (ret < 0)
408 goto out;
409
Philippe Reynes3148e422019-12-18 18:25:41 +0100410 info->iv = malloc(info->cipher->iv_len);
411 if (!info->iv) {
412 printf("Can't allocate memory for iv\n");
413 ret = -1;
414 goto out;
415 }
Philippe Reynes64d67c42020-09-17 15:01:46 +0200416
417 if (info->ivname) {
418 /* Read the IV in the file */
419 snprintf(filename, sizeof(filename), "%s/%s%s",
420 info->keydir, info->ivname, ".bin");
421 ret = fit_image_read_data(filename, (unsigned char *)info->iv,
422 info->cipher->iv_len);
423 } else {
424 /* Generate an ramdom IV */
425 ret = get_random_data((void *)info->iv, info->cipher->iv_len);
426 }
Philippe Reynes3148e422019-12-18 18:25:41 +0100427
428 out:
429 return ret;
430}
431
432int fit_image_write_cipher(void *fit, int image_noffset, int noffset,
433 const void *data, size_t size,
434 unsigned char *data_ciphered, int data_ciphered_len)
435{
436 int ret = -1;
437
Patrick Oppenlanderbe472112020-07-30 14:22:14 +1000438 /* Replace data with ciphered data */
Philippe Reynes3148e422019-12-18 18:25:41 +0100439 ret = fdt_setprop(fit, image_noffset, FIT_DATA_PROP,
440 data_ciphered, data_ciphered_len);
Patrick Oppenlanderbe472112020-07-30 14:22:14 +1000441 if (ret == -FDT_ERR_NOSPACE) {
442 ret = -ENOSPC;
443 goto out;
444 }
Philippe Reynes3148e422019-12-18 18:25:41 +0100445 if (ret) {
Patrick Oppenlanderbe472112020-07-30 14:22:14 +1000446 printf("Can't replace data with ciphered data (err = %d)\n", ret);
Philippe Reynes3148e422019-12-18 18:25:41 +0100447 goto out;
448 }
449
450 /* add non ciphered data size */
451 ret = fdt_setprop_u32(fit, image_noffset, "data-size-unciphered", size);
Patrick Oppenlanderbe472112020-07-30 14:22:14 +1000452 if (ret == -FDT_ERR_NOSPACE) {
453 ret = -ENOSPC;
454 goto out;
455 }
Philippe Reynes3148e422019-12-18 18:25:41 +0100456 if (ret) {
457 printf("Can't add unciphered data size (err = %d)\n", ret);
458 goto out;
459 }
460
461 out:
462 return ret;
463}
464
465static int
466fit_image_process_cipher(const char *keydir, void *keydest, void *fit,
467 const char *image_name, int image_noffset,
Patrick Oppenlanderd586fc32020-07-30 14:22:13 +1000468 int node_noffset, const void *data, size_t size,
Philippe Reynes3148e422019-12-18 18:25:41 +0100469 const char *cmdname)
470{
471 struct image_cipher_info info;
472 unsigned char *data_ciphered = NULL;
473 int data_ciphered_len;
474 int ret;
475
476 memset(&info, 0, sizeof(info));
477
478 ret = fit_image_setup_cipher(&info, keydir, fit, image_name,
Patrick Oppenlanderd586fc32020-07-30 14:22:13 +1000479 image_noffset, node_noffset);
Philippe Reynes3148e422019-12-18 18:25:41 +0100480 if (ret)
481 goto out;
482
483 ret = info.cipher->encrypt(&info, data, size,
484 &data_ciphered, &data_ciphered_len);
485 if (ret)
486 goto out;
487
488 /*
489 * Write the public key into the supplied FDT file; this might fail
490 * several times, since we try signing with successively increasing
491 * size values
Philippe Reynes64d67c42020-09-17 15:01:46 +0200492 * And, if needed, write the iv in the FIT file
Philippe Reynes3148e422019-12-18 18:25:41 +0100493 */
494 if (keydest) {
Philippe Reynes64d67c42020-09-17 15:01:46 +0200495 ret = info.cipher->add_cipher_data(&info, keydest, fit, node_noffset);
Philippe Reynes3148e422019-12-18 18:25:41 +0100496 if (ret) {
497 printf("Failed to add verification data for cipher '%s' in image '%s'\n",
498 info.keyname, image_name);
499 goto out;
500 }
501 }
502
503 ret = fit_image_write_cipher(fit, image_noffset, node_noffset,
504 data, size,
505 data_ciphered, data_ciphered_len);
506
507 out:
508 free(data_ciphered);
509 free((void *)info.key);
510 free((void *)info.iv);
511 return ret;
512}
513
514int fit_image_cipher_data(const char *keydir, void *keydest,
515 void *fit, int image_noffset, const char *comment,
516 int require_keys, const char *engine_id,
517 const char *cmdname)
518{
519 const char *image_name;
520 const void *data;
521 size_t size;
Patrick Oppenlandera4fafb32020-07-30 14:22:15 +1000522 int cipher_node_offset, len;
Philippe Reynes3148e422019-12-18 18:25:41 +0100523
524 /* Get image name */
525 image_name = fit_get_name(fit, image_noffset, NULL);
526 if (!image_name) {
527 printf("Can't get image name\n");
528 return -1;
529 }
530
531 /* Get image data and data length */
532 if (fit_image_get_data(fit, image_noffset, &data, &size)) {
533 printf("Can't get image data/size\n");
534 return -1;
535 }
536
Patrick Oppenlandera4fafb32020-07-30 14:22:15 +1000537 /*
538 * Don't cipher ciphered data.
539 *
540 * If the data-size-unciphered property is present the data for this
541 * image is already encrypted. This is important as 'mkimage -F' can be
542 * run multiple times on a FIT image.
543 */
544 if (fdt_getprop(fit, image_noffset, "data-size-unciphered", &len))
545 return 0;
546 if (len != -FDT_ERR_NOTFOUND) {
547 printf("Failure testing for data-size-unciphered\n");
548 return -1;
549 }
Philippe Reynes3148e422019-12-18 18:25:41 +0100550
Patrick Oppenlanderd586fc32020-07-30 14:22:13 +1000551 /* Process cipher node if present */
552 cipher_node_offset = fdt_subnode_offset(fit, image_noffset,
553 FIT_CIPHER_NODENAME);
554 if (cipher_node_offset == -FDT_ERR_NOTFOUND)
555 return 0;
556 if (cipher_node_offset < 0) {
557 printf("Failure getting cipher node\n");
558 return -1;
Philippe Reynes3148e422019-12-18 18:25:41 +0100559 }
Patrick Oppenlanderd586fc32020-07-30 14:22:13 +1000560 if (!IMAGE_ENABLE_ENCRYPT || !keydir)
561 return 0;
562 return fit_image_process_cipher(keydir, keydest, fit, image_name,
563 image_noffset, cipher_node_offset, data, size, cmdname);
Philippe Reynes3148e422019-12-18 18:25:41 +0100564}
565
Simon Glassfbabc0f2013-06-13 15:10:01 -0700566/**
567 * fit_image_add_verification_data() - calculate/set verig. data for image node
568 *
569 * This adds hash and signature values for an component image node.
Simon Glassee382652013-05-07 06:12:01 +0000570 *
571 * All existing hash subnodes are checked, if algorithm property is set to
572 * one of the supported hash algorithms, hash value is computed and
573 * corresponding hash node property is set, for example:
Simon Glass10a1eca2013-05-07 06:11:54 +0000574 *
575 * Input component image node structure:
576 *
Andre Przywara3234ecd2017-12-04 02:05:10 +0000577 * o image-1 (at image_noffset)
Simon Glass10a1eca2013-05-07 06:11:54 +0000578 * | - data = [binary data]
Andre Przywara3234ecd2017-12-04 02:05:10 +0000579 * o hash-1
Simon Glass10a1eca2013-05-07 06:11:54 +0000580 * |- algo = "sha1"
581 *
582 * Output component image node structure:
583 *
Andre Przywara3234ecd2017-12-04 02:05:10 +0000584 * o image-1 (at image_noffset)
Simon Glass10a1eca2013-05-07 06:11:54 +0000585 * | - data = [binary data]
Andre Przywara3234ecd2017-12-04 02:05:10 +0000586 * o hash-1
Simon Glass10a1eca2013-05-07 06:11:54 +0000587 * |- algo = "sha1"
588 * |- value = sha1(data)
589 *
Simon Glassee382652013-05-07 06:12:01 +0000590 * For signature details, please see doc/uImage.FIT/signature.txt
591 *
Simon Glassfbabc0f2013-06-13 15:10:01 -0700592 * @keydir Directory containing *.key and *.crt files (or NULL)
593 * @keydest FDT Blob to write public keys into (NULL if none)
Simon Glassee382652013-05-07 06:12:01 +0000594 * @fit: Pointer to the FIT format image header
595 * @image_noffset: Requested component image node
Simon Glassfbabc0f2013-06-13 15:10:01 -0700596 * @comment: Comment to add to signature nodes
597 * @require_keys: Mark all keys as 'required'
George McCollister23d14892017-01-06 13:14:17 -0600598 * @engine_id: Engine to use for signing
Simon Glassee382652013-05-07 06:12:01 +0000599 * @return: 0 on success, <0 on failure
Simon Glass10a1eca2013-05-07 06:11:54 +0000600 */
Simon Glassfbabc0f2013-06-13 15:10:01 -0700601int fit_image_add_verification_data(const char *keydir, void *keydest,
602 void *fit, int image_noffset, const char *comment,
Alex Kiernan697fcdc2018-06-20 20:10:52 +0000603 int require_keys, const char *engine_id, const char *cmdname)
Simon Glass10a1eca2013-05-07 06:11:54 +0000604{
Simon Glassee382652013-05-07 06:12:01 +0000605 const char *image_name;
Simon Glass10a1eca2013-05-07 06:11:54 +0000606 const void *data;
607 size_t size;
Simon Glass10a1eca2013-05-07 06:11:54 +0000608 int noffset;
Simon Glass10a1eca2013-05-07 06:11:54 +0000609
610 /* Get image data and data length */
611 if (fit_image_get_data(fit, image_noffset, &data, &size)) {
612 printf("Can't get image data/size\n");
613 return -1;
614 }
615
Simon Glass25d6e6b2013-05-07 06:11:55 +0000616 image_name = fit_get_name(fit, image_noffset, NULL);
617
Simon Glass10a1eca2013-05-07 06:11:54 +0000618 /* Process all hash subnodes of the component image node */
Simon Glassee382652013-05-07 06:12:01 +0000619 for (noffset = fdt_first_subnode(fit, image_noffset);
620 noffset >= 0;
621 noffset = fdt_next_subnode(fit, noffset)) {
622 const char *node_name;
623 int ret = 0;
624
625 /*
626 * Check subnode name, must be equal to "hash" or "signature".
627 * Multiple hash nodes require unique unit node
Andre Przywara3234ecd2017-12-04 02:05:10 +0000628 * names, e.g. hash-1, hash-2, signature-1, etc.
Simon Glassee382652013-05-07 06:12:01 +0000629 */
630 node_name = fit_get_name(fit, noffset, NULL);
631 if (!strncmp(node_name, FIT_HASH_NODENAME,
632 strlen(FIT_HASH_NODENAME))) {
633 ret = fit_image_process_hash(fit, image_name, noffset,
634 data, size);
Simon Glassfbabc0f2013-06-13 15:10:01 -0700635 } else if (IMAGE_ENABLE_SIGN && keydir &&
636 !strncmp(node_name, FIT_SIG_NODENAME,
637 strlen(FIT_SIG_NODENAME))) {
638 ret = fit_image_process_sig(keydir, keydest,
639 fit, image_name, noffset, data, size,
Alex Kiernan697fcdc2018-06-20 20:10:52 +0000640 comment, require_keys, engine_id, cmdname);
Simon Glass10a1eca2013-05-07 06:11:54 +0000641 }
Simon Glassee382652013-05-07 06:12:01 +0000642 if (ret)
Simon Glassec539f72016-07-03 09:40:44 -0600643 return ret;
Simon Glassee382652013-05-07 06:12:01 +0000644 }
645
646 return 0;
647}
648
Simon Glass56ab8d62013-06-13 15:10:09 -0700649struct strlist {
650 int count;
651 char **strings;
652};
653
654static void strlist_init(struct strlist *list)
655{
656 memset(list, '\0', sizeof(*list));
657}
658
659static void strlist_free(struct strlist *list)
660{
661 int i;
662
663 for (i = 0; i < list->count; i++)
664 free(list->strings[i]);
665 free(list->strings);
666}
667
668static int strlist_add(struct strlist *list, const char *str)
669{
670 char *dup;
671
672 dup = strdup(str);
673 list->strings = realloc(list->strings,
674 (list->count + 1) * sizeof(char *));
675 if (!list || !str)
676 return -1;
677 list->strings[list->count++] = dup;
678
679 return 0;
680}
681
682static const char *fit_config_get_image_list(void *fit, int noffset,
683 int *lenp, int *allow_missingp)
684{
685 static const char default_list[] = FIT_KERNEL_PROP "\0"
686 FIT_FDT_PROP;
687 const char *prop;
688
689 /* If there is an "image" property, use that */
690 prop = fdt_getprop(fit, noffset, "sign-images", lenp);
691 if (prop) {
692 *allow_missingp = 0;
693 return *lenp ? prop : NULL;
694 }
695
696 /* Default image list */
697 *allow_missingp = 1;
698 *lenp = sizeof(default_list);
699
700 return default_list;
701}
702
703static int fit_config_get_hash_list(void *fit, int conf_noffset,
704 int sig_offset, struct strlist *node_inc)
705{
706 int allow_missing;
707 const char *prop, *iname, *end;
708 const char *conf_name, *sig_name;
709 char name[200], path[200];
710 int image_count;
711 int ret, len;
712
713 conf_name = fit_get_name(fit, conf_noffset, NULL);
714 sig_name = fit_get_name(fit, sig_offset, NULL);
715
716 /*
717 * Build a list of nodes we need to hash. We always need the root
718 * node and the configuration.
719 */
720 strlist_init(node_inc);
721 snprintf(name, sizeof(name), "%s/%s", FIT_CONFS_PATH, conf_name);
722 if (strlist_add(node_inc, "/") ||
723 strlist_add(node_inc, name))
724 goto err_mem;
725
726 /* Get a list of images that we intend to sign */
Heiko Schocherfdfd5202014-03-03 12:19:23 +0100727 prop = fit_config_get_image_list(fit, sig_offset, &len,
Simon Glass56ab8d62013-06-13 15:10:09 -0700728 &allow_missing);
729 if (!prop)
730 return 0;
731
732 /* Locate the images */
733 end = prop + len;
734 image_count = 0;
735 for (iname = prop; iname < end; iname += strlen(iname) + 1) {
736 int noffset;
737 int image_noffset;
738 int hash_count;
739
740 image_noffset = fit_conf_get_prop_node(fit, conf_noffset,
741 iname);
742 if (image_noffset < 0) {
743 printf("Failed to find image '%s' in configuration '%s/%s'\n",
744 iname, conf_name, sig_name);
745 if (allow_missing)
746 continue;
747
748 return -ENOENT;
749 }
750
751 ret = fdt_get_path(fit, image_noffset, path, sizeof(path));
752 if (ret < 0)
753 goto err_path;
754 if (strlist_add(node_inc, path))
755 goto err_mem;
756
757 snprintf(name, sizeof(name), "%s/%s", FIT_CONFS_PATH,
758 conf_name);
759
760 /* Add all this image's hashes */
761 hash_count = 0;
762 for (noffset = fdt_first_subnode(fit, image_noffset);
763 noffset >= 0;
764 noffset = fdt_next_subnode(fit, noffset)) {
765 const char *name = fit_get_name(fit, noffset, NULL);
766
767 if (strncmp(name, FIT_HASH_NODENAME,
768 strlen(FIT_HASH_NODENAME)))
769 continue;
770 ret = fdt_get_path(fit, noffset, path, sizeof(path));
771 if (ret < 0)
772 goto err_path;
773 if (strlist_add(node_inc, path))
774 goto err_mem;
775 hash_count++;
776 }
777
778 if (!hash_count) {
779 printf("Failed to find any hash nodes in configuration '%s/%s' image '%s' - without these it is not possible to verify this image\n",
780 conf_name, sig_name, iname);
781 return -ENOMSG;
782 }
783
Patrick Oppenlander5964c3f2020-07-30 14:30:47 +1000784 /* Add this image's cipher node if present */
785 noffset = fdt_subnode_offset(fit, image_noffset,
786 FIT_CIPHER_NODENAME);
787 if (noffset != -FDT_ERR_NOTFOUND) {
788 if (noffset < 0) {
789 printf("Failed to get cipher node in configuration '%s/%s' image '%s': %s\n",
790 conf_name, sig_name, iname,
791 fdt_strerror(noffset));
792 return -EIO;
793 }
794 ret = fdt_get_path(fit, noffset, path, sizeof(path));
795 if (ret < 0)
796 goto err_path;
797 if (strlist_add(node_inc, path))
798 goto err_mem;
799 }
800
Simon Glass56ab8d62013-06-13 15:10:09 -0700801 image_count++;
802 }
803
804 if (!image_count) {
805 printf("Failed to find any images for configuration '%s/%s'\n",
806 conf_name, sig_name);
807 return -ENOMSG;
808 }
809
810 return 0;
811
812err_mem:
813 printf("Out of memory processing configuration '%s/%s'\n", conf_name,
814 sig_name);
815 return -ENOMEM;
816
817err_path:
818 printf("Failed to get path for image '%s' in configuration '%s/%s': %s\n",
819 iname, conf_name, sig_name, fdt_strerror(ret));
820 return -ENOENT;
821}
822
823static int fit_config_get_data(void *fit, int conf_noffset, int noffset,
824 struct image_region **regionp, int *region_countp,
825 char **region_propp, int *region_proplen)
826{
827 char * const exc_prop[] = {"data"};
828 struct strlist node_inc;
829 struct image_region *region;
830 struct fdt_region fdt_regions[100];
831 const char *conf_name, *sig_name;
832 char path[200];
833 int count, i;
834 char *region_prop;
835 int ret, len;
836
837 conf_name = fit_get_name(fit, conf_noffset, NULL);
Masahiro Yamada2fc6b6f2017-10-19 19:16:21 +0900838 sig_name = fit_get_name(fit, noffset, NULL);
Simon Glass56ab8d62013-06-13 15:10:09 -0700839 debug("%s: conf='%s', sig='%s'\n", __func__, conf_name, sig_name);
840
841 /* Get a list of nodes we want to hash */
842 ret = fit_config_get_hash_list(fit, conf_noffset, noffset, &node_inc);
843 if (ret)
844 return ret;
845
846 /* Get a list of regions to hash */
847 count = fdt_find_regions(fit, node_inc.strings, node_inc.count,
848 exc_prop, ARRAY_SIZE(exc_prop),
849 fdt_regions, ARRAY_SIZE(fdt_regions),
850 path, sizeof(path), 1);
851 if (count < 0) {
852 printf("Failed to hash configuration '%s/%s': %s\n", conf_name,
853 sig_name, fdt_strerror(ret));
854 return -EIO;
855 }
856 if (count == 0) {
857 printf("No data to hash for configuration '%s/%s': %s\n",
858 conf_name, sig_name, fdt_strerror(ret));
859 return -EINVAL;
860 }
861
862 /* Build our list of data blocks */
863 region = fit_region_make_list(fit, fdt_regions, count, NULL);
864 if (!region) {
865 printf("Out of memory hashing configuration '%s/%s'\n",
866 conf_name, sig_name);
867 return -ENOMEM;
868 }
869
870 /* Create a list of all hashed properties */
871 debug("Hash nodes:\n");
872 for (i = len = 0; i < node_inc.count; i++) {
873 debug(" %s\n", node_inc.strings[i]);
874 len += strlen(node_inc.strings[i]) + 1;
875 }
876 region_prop = malloc(len);
877 if (!region_prop) {
878 printf("Out of memory setting up regions for configuration '%s/%s'\n",
879 conf_name, sig_name);
880 return -ENOMEM;
881 }
882 for (i = len = 0; i < node_inc.count;
883 len += strlen(node_inc.strings[i]) + 1, i++)
884 strcpy(region_prop + len, node_inc.strings[i]);
885 strlist_free(&node_inc);
886
887 *region_countp = count;
888 *regionp = region;
889 *region_propp = region_prop;
890 *region_proplen = len;
891
892 return 0;
893}
894
895static int fit_config_process_sig(const char *keydir, void *keydest,
896 void *fit, const char *conf_name, int conf_noffset,
George McCollister23d14892017-01-06 13:14:17 -0600897 int noffset, const char *comment, int require_keys,
Alex Kiernan697fcdc2018-06-20 20:10:52 +0000898 const char *engine_id, const char *cmdname)
Simon Glass56ab8d62013-06-13 15:10:09 -0700899{
900 struct image_sign_info info;
901 const char *node_name;
902 struct image_region *region;
903 char *region_prop;
904 int region_proplen;
905 int region_count;
906 uint8_t *value;
907 uint value_len;
908 int ret;
909
910 node_name = fit_get_name(fit, noffset, NULL);
911 if (fit_config_get_data(fit, conf_noffset, noffset, &region,
912 &region_count, &region_prop, &region_proplen))
913 return -1;
914
915 if (fit_image_setup_sig(&info, keydir, fit, conf_name, noffset,
George McCollister23d14892017-01-06 13:14:17 -0600916 require_keys ? "conf" : NULL, engine_id))
Simon Glass56ab8d62013-06-13 15:10:09 -0700917 return -1;
918
Andrew Duda6616c822016-11-08 18:53:41 +0000919 ret = info.crypto->sign(&info, region, region_count, &value,
920 &value_len);
Simon Glass56ab8d62013-06-13 15:10:09 -0700921 free(region);
922 if (ret) {
923 printf("Failed to sign '%s' signature node in '%s' conf node\n",
924 node_name, conf_name);
925
926 /* We allow keys to be missing */
927 if (ret == -ENOENT)
928 return 0;
929 return -1;
930 }
931
Simon Glass802aa822014-06-02 22:04:53 -0600932 ret = fit_image_write_sig(fit, noffset, value, value_len, comment,
Alex Kiernan697fcdc2018-06-20 20:10:52 +0000933 region_prop, region_proplen, cmdname);
Simon Glass802aa822014-06-02 22:04:53 -0600934 if (ret) {
935 if (ret == -FDT_ERR_NOSPACE)
936 return -ENOSPC;
937 printf("Can't write signature for '%s' signature node in '%s' conf node: %s\n",
938 node_name, conf_name, fdt_strerror(ret));
Simon Glass56ab8d62013-06-13 15:10:09 -0700939 return -1;
940 }
941 free(value);
942 free(region_prop);
943
944 /* Get keyname again, as FDT has changed and invalidated our pointer */
Simon Glassd7aabcc2020-03-18 11:44:06 -0600945 info.keyname = fdt_getprop(fit, noffset, FIT_KEY_HINT, NULL);
Simon Glass56ab8d62013-06-13 15:10:09 -0700946
947 /* Write the public key into the supplied FDT file */
Simon Glass802aa822014-06-02 22:04:53 -0600948 if (keydest) {
Andrew Duda6616c822016-11-08 18:53:41 +0000949 ret = info.crypto->add_verify_data(&info, keydest);
Simon Glass802aa822014-06-02 22:04:53 -0600950 if (ret) {
Masahiro Yamadafe391a72017-10-27 15:04:21 +0900951 printf("Failed to add verification data for '%s' signature node in '%s' configuration node\n",
Simon Glass802aa822014-06-02 22:04:53 -0600952 node_name, conf_name);
Simon Glass802aa822014-06-02 22:04:53 -0600953 }
Simon Glass9423bad2014-06-12 07:24:42 -0600954 return ret;
Simon Glass56ab8d62013-06-13 15:10:09 -0700955 }
956
957 return 0;
958}
959
960static int fit_config_add_verification_data(const char *keydir, void *keydest,
961 void *fit, int conf_noffset, const char *comment,
Alex Kiernan697fcdc2018-06-20 20:10:52 +0000962 int require_keys, const char *engine_id, const char *cmdname)
Simon Glass56ab8d62013-06-13 15:10:09 -0700963{
964 const char *conf_name;
965 int noffset;
966
967 conf_name = fit_get_name(fit, conf_noffset, NULL);
968
969 /* Process all hash subnodes of the configuration node */
970 for (noffset = fdt_first_subnode(fit, conf_noffset);
971 noffset >= 0;
972 noffset = fdt_next_subnode(fit, noffset)) {
973 const char *node_name;
974 int ret = 0;
975
976 node_name = fit_get_name(fit, noffset, NULL);
977 if (!strncmp(node_name, FIT_SIG_NODENAME,
978 strlen(FIT_SIG_NODENAME))) {
979 ret = fit_config_process_sig(keydir, keydest,
980 fit, conf_name, conf_noffset, noffset, comment,
Alex Kiernan697fcdc2018-06-20 20:10:52 +0000981 require_keys, engine_id, cmdname);
Simon Glass56ab8d62013-06-13 15:10:09 -0700982 }
983 if (ret)
984 return ret;
985 }
986
987 return 0;
988}
989
Philippe Reynes3148e422019-12-18 18:25:41 +0100990int fit_cipher_data(const char *keydir, void *keydest, void *fit,
991 const char *comment, int require_keys,
992 const char *engine_id, const char *cmdname)
993{
994 int images_noffset;
995 int noffset;
996 int ret;
997
998 /* Find images parent node offset */
999 images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
1000 if (images_noffset < 0) {
1001 printf("Can't find images parent node '%s' (%s)\n",
1002 FIT_IMAGES_PATH, fdt_strerror(images_noffset));
1003 return images_noffset;
1004 }
1005
1006 /* Process its subnodes, print out component images details */
1007 for (noffset = fdt_first_subnode(fit, images_noffset);
1008 noffset >= 0;
1009 noffset = fdt_next_subnode(fit, noffset)) {
1010 /*
1011 * Direct child node of the images parent node,
1012 * i.e. component image node.
1013 */
1014 ret = fit_image_cipher_data(keydir, keydest,
1015 fit, noffset, comment,
1016 require_keys, engine_id,
1017 cmdname);
1018 if (ret)
1019 return ret;
1020 }
1021
1022 return 0;
1023}
1024
Simon Glassfbabc0f2013-06-13 15:10:01 -07001025int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
George McCollister23d14892017-01-06 13:14:17 -06001026 const char *comment, int require_keys,
Alex Kiernan697fcdc2018-06-20 20:10:52 +00001027 const char *engine_id, const char *cmdname)
Simon Glassee382652013-05-07 06:12:01 +00001028{
Simon Glass56ab8d62013-06-13 15:10:09 -07001029 int images_noffset, confs_noffset;
Simon Glassee382652013-05-07 06:12:01 +00001030 int noffset;
1031 int ret;
1032
1033 /* Find images parent node offset */
1034 images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
1035 if (images_noffset < 0) {
1036 printf("Can't find images parent node '%s' (%s)\n",
1037 FIT_IMAGES_PATH, fdt_strerror(images_noffset));
1038 return images_noffset;
1039 }
1040
1041 /* Process its subnodes, print out component images details */
1042 for (noffset = fdt_first_subnode(fit, images_noffset);
1043 noffset >= 0;
1044 noffset = fdt_next_subnode(fit, noffset)) {
1045 /*
1046 * Direct child node of the images parent node,
1047 * i.e. component image node.
1048 */
Simon Glassfbabc0f2013-06-13 15:10:01 -07001049 ret = fit_image_add_verification_data(keydir, keydest,
Alex Kiernan697fcdc2018-06-20 20:10:52 +00001050 fit, noffset, comment, require_keys, engine_id,
1051 cmdname);
Simon Glassee382652013-05-07 06:12:01 +00001052 if (ret)
1053 return ret;
Simon Glass10a1eca2013-05-07 06:11:54 +00001054 }
1055
Simon Glass56ab8d62013-06-13 15:10:09 -07001056 /* If there are no keys, we can't sign configurations */
1057 if (!IMAGE_ENABLE_SIGN || !keydir)
1058 return 0;
1059
1060 /* Find configurations parent node offset */
1061 confs_noffset = fdt_path_offset(fit, FIT_CONFS_PATH);
1062 if (confs_noffset < 0) {
1063 printf("Can't find images parent node '%s' (%s)\n",
Heiko Schocher441f48d2014-08-11 11:02:17 +02001064 FIT_CONFS_PATH, fdt_strerror(confs_noffset));
Simon Glass56ab8d62013-06-13 15:10:09 -07001065 return -ENOENT;
1066 }
1067
1068 /* Process its subnodes, print out component images details */
1069 for (noffset = fdt_first_subnode(fit, confs_noffset);
1070 noffset >= 0;
1071 noffset = fdt_next_subnode(fit, noffset)) {
1072 ret = fit_config_add_verification_data(keydir, keydest,
1073 fit, noffset, comment,
George McCollister23d14892017-01-06 13:14:17 -06001074 require_keys,
Alex Kiernan697fcdc2018-06-20 20:10:52 +00001075 engine_id, cmdname);
Simon Glass56ab8d62013-06-13 15:10:09 -07001076 if (ret)
1077 return ret;
1078 }
1079
Simon Glass10a1eca2013-05-07 06:11:54 +00001080 return 0;
1081}
Heiko Schocherd7b42322014-03-03 12:19:30 +01001082
1083#ifdef CONFIG_FIT_SIGNATURE
Simon Glass05712322020-03-18 11:44:03 -06001084int fit_check_sign(const void *fit, const void *key,
1085 const char *fit_uname_config)
Heiko Schocherd7b42322014-03-03 12:19:30 +01001086{
1087 int cfg_noffset;
1088 int ret;
1089
Simon Glass05712322020-03-18 11:44:03 -06001090 cfg_noffset = fit_conf_get_node(fit, fit_uname_config);
Heiko Schocherd7b42322014-03-03 12:19:30 +01001091 if (!cfg_noffset)
1092 return -1;
1093
Simon Glassa559bb22020-03-18 11:43:56 -06001094 printf("Verifying Hash Integrity for node '%s'... ",
1095 fdt_get_name(fit, cfg_noffset, NULL));
Simon Glassa51991d2014-06-12 07:24:53 -06001096 ret = fit_config_verify(fit, cfg_noffset);
1097 if (ret)
1098 return ret;
Simon Glass05712322020-03-18 11:44:03 -06001099 printf("Verified OK, loading images\n");
Simon Glassa51991d2014-06-12 07:24:53 -06001100 ret = bootm_host_load_images(fit, cfg_noffset);
1101
Heiko Schocherd7b42322014-03-03 12:19:30 +01001102 return ret;
1103}
1104#endif