1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2013, Google Inc.
5 * (C) Copyright 2008 Semihalf
7 * (C) Copyright 2000-2006
8 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
17 * fit_set_hash_value - set hash value in requested has node
18 * @fit: pointer to the FIT format image header
19 * @noffset: hash node offset
20 * @value: hash value to be set
21 * @value_len: hash value length
23 * fit_set_hash_value() attempts to set hash value in a node at offset
24 * given and returns operation status to the caller.
30 static int fit_set_hash_value(void *fit, int noffset, uint8_t *value,
35 ret = fdt_setprop(fit, noffset, FIT_VALUE_PROP, value, value_len);
37 printf("Can't set hash '%s' property for '%s' node(%s)\n",
38 FIT_VALUE_PROP, fit_get_name(fit, noffset, NULL),
40 return ret == -FDT_ERR_NOSPACE ? -ENOSPC : -EIO;
47 * fit_image_process_hash - Process a single subnode of the images/ node
49 * Check each subnode and process accordingly. For hash nodes we generate
50 * a hash of the supplised data and store it in the node.
52 * @fit: pointer to the FIT format image header
53 * @image_name: name of image being processes (used to display errors)
54 * @noffset: subnode offset
55 * @data: data to process
56 * @size: size of data in bytes
57 * @return 0 if ok, -1 on error
59 static int fit_image_process_hash(void *fit, const char *image_name,
60 int noffset, const void *data, size_t size)
62 uint8_t value[FIT_MAX_HASH_LEN];
63 const char *node_name;
68 node_name = fit_get_name(fit, noffset, NULL);
70 if (fit_image_hash_get_algo(fit, noffset, &algo)) {
71 printf("Can't get hash algo property for '%s' hash node in '%s' image node\n",
72 node_name, image_name);
76 if (calculate_hash(data, size, algo, value, &value_len)) {
77 printf("Unsupported hash algorithm (%s) for '%s' hash node in '%s' image node\n",
78 algo, node_name, image_name);
79 return -EPROTONOSUPPORT;
82 ret = fit_set_hash_value(fit, noffset, value, value_len);
84 printf("Can't set hash value for '%s' hash node in '%s' image node\n",
85 node_name, image_name);
93 * fit_image_write_sig() - write the signature to a FIT
95 * This writes the signature and signer data to the FIT.
97 * @fit: pointer to the FIT format image header
98 * @noffset: hash node offset
99 * @value: signature value to be set
100 * @value_len: signature value length
101 * @comment: Text comment to write (NULL for none)
105 * -FDT_ERR_..., on failure
107 static int fit_image_write_sig(void *fit, int noffset, uint8_t *value,
108 int value_len, const char *comment, const char *region_prop,
109 int region_proplen, const char *cmdname)
115 * Get the current string size, before we update the FIT and add
118 string_size = fdt_size_dt_strings(fit);
120 ret = fdt_setprop(fit, noffset, FIT_VALUE_PROP, value, value_len);
122 ret = fdt_setprop_string(fit, noffset, "signer-name",
126 ret = fdt_setprop_string(fit, noffset, "signer-version",
130 ret = fdt_setprop_string(fit, noffset, "comment", comment);
132 time_t timestamp = imagetool_get_source_date(cmdname,
135 ret = fit_set_timestamp(fit, noffset, timestamp);
137 if (region_prop && !ret) {
140 ret = fdt_setprop(fit, noffset, "hashed-nodes",
141 region_prop, region_proplen);
142 /* This is a legacy offset, it is unused, and must remain 0. */
144 strdata[1] = cpu_to_fdt32(string_size);
146 ret = fdt_setprop(fit, noffset, "hashed-strings",
147 strdata, sizeof(strdata));
154 static int fit_image_setup_sig(struct image_sign_info *info,
155 const char *keydir, void *fit, const char *image_name,
156 int noffset, const char *require_keys, const char *engine_id)
158 const char *node_name;
160 const char *padding_name;
162 node_name = fit_get_name(fit, noffset, NULL);
163 if (fit_image_hash_get_algo(fit, noffset, &algo_name)) {
164 printf("Can't get algo property for '%s' signature node in '%s' image node\n",
165 node_name, image_name);
169 padding_name = fdt_getprop(fit, noffset, "padding", NULL);
171 memset(info, '\0', sizeof(*info));
172 info->keydir = keydir;
173 info->keyname = fdt_getprop(fit, noffset, "key-name-hint", NULL);
175 info->node_offset = noffset;
176 info->name = strdup(algo_name);
177 info->checksum = image_get_checksum_algo(algo_name);
178 info->crypto = image_get_crypto_algo(algo_name);
179 info->padding = image_get_padding_algo(padding_name);
180 info->require_keys = require_keys;
181 info->engine_id = engine_id;
182 if (!info->checksum || !info->crypto) {
183 printf("Unsupported signature algorithm (%s) for '%s' signature node in '%s' image node\n",
184 algo_name, node_name, image_name);
192 * fit_image_process_sig- Process a single subnode of the images/ node
194 * Check each subnode and process accordingly. For signature nodes we
195 * generate a signed hash of the supplised data and store it in the node.
197 * @keydir: Directory containing keys to use for signing
198 * @keydest: Destination FDT blob to write public keys into
199 * @fit: pointer to the FIT format image header
200 * @image_name: name of image being processes (used to display errors)
201 * @noffset: subnode offset
202 * @data: data to process
203 * @size: size of data in bytes
204 * @comment: Comment to add to signature nodes
205 * @require_keys: Mark all keys as 'required'
206 * @engine_id: Engine to use for signing
207 * @return 0 if ok, -1 on error
209 static int fit_image_process_sig(const char *keydir, void *keydest,
210 void *fit, const char *image_name,
211 int noffset, const void *data, size_t size,
212 const char *comment, int require_keys, const char *engine_id,
215 struct image_sign_info info;
216 struct image_region region;
217 const char *node_name;
222 if (fit_image_setup_sig(&info, keydir, fit, image_name, noffset,
223 require_keys ? "image" : NULL, engine_id))
226 node_name = fit_get_name(fit, noffset, NULL);
229 ret = info.crypto->sign(&info, ®ion, 1, &value, &value_len);
231 printf("Failed to sign '%s' signature node in '%s' image node: %d\n",
232 node_name, image_name, ret);
234 /* We allow keys to be missing */
240 ret = fit_image_write_sig(fit, noffset, value, value_len, comment,
243 if (ret == -FDT_ERR_NOSPACE)
245 printf("Can't write signature for '%s' signature node in '%s' conf node: %s\n",
246 node_name, image_name, fdt_strerror(ret));
251 /* Get keyname again, as FDT has changed and invalidated our pointer */
252 info.keyname = fdt_getprop(fit, noffset, "key-name-hint", NULL);
255 * Write the public key into the supplied FDT file; this might fail
256 * several times, since we try signing with successively increasing
260 ret = info.crypto->add_verify_data(&info, keydest);
262 printf("Failed to add verification data for '%s' signature node in '%s' image node\n",
263 node_name, image_name);
272 * fit_image_add_verification_data() - calculate/set verig. data for image node
274 * This adds hash and signature values for an component image node.
276 * All existing hash subnodes are checked, if algorithm property is set to
277 * one of the supported hash algorithms, hash value is computed and
278 * corresponding hash node property is set, for example:
280 * Input component image node structure:
282 * o image-1 (at image_noffset)
283 * | - data = [binary data]
287 * Output component image node structure:
289 * o image-1 (at image_noffset)
290 * | - data = [binary data]
293 * |- value = sha1(data)
295 * For signature details, please see doc/uImage.FIT/signature.txt
297 * @keydir Directory containing *.key and *.crt files (or NULL)
298 * @keydest FDT Blob to write public keys into (NULL if none)
299 * @fit: Pointer to the FIT format image header
300 * @image_noffset: Requested component image node
301 * @comment: Comment to add to signature nodes
302 * @require_keys: Mark all keys as 'required'
303 * @engine_id: Engine to use for signing
304 * @return: 0 on success, <0 on failure
306 int fit_image_add_verification_data(const char *keydir, void *keydest,
307 void *fit, int image_noffset, const char *comment,
308 int require_keys, const char *engine_id, const char *cmdname)
310 const char *image_name;
315 /* Get image data and data length */
316 if (fit_image_get_data(fit, image_noffset, &data, &size)) {
317 printf("Can't get image data/size\n");
321 image_name = fit_get_name(fit, image_noffset, NULL);
323 /* Process all hash subnodes of the component image node */
324 for (noffset = fdt_first_subnode(fit, image_noffset);
326 noffset = fdt_next_subnode(fit, noffset)) {
327 const char *node_name;
331 * Check subnode name, must be equal to "hash" or "signature".
332 * Multiple hash nodes require unique unit node
333 * names, e.g. hash-1, hash-2, signature-1, etc.
335 node_name = fit_get_name(fit, noffset, NULL);
336 if (!strncmp(node_name, FIT_HASH_NODENAME,
337 strlen(FIT_HASH_NODENAME))) {
338 ret = fit_image_process_hash(fit, image_name, noffset,
340 } else if (IMAGE_ENABLE_SIGN && keydir &&
341 !strncmp(node_name, FIT_SIG_NODENAME,
342 strlen(FIT_SIG_NODENAME))) {
343 ret = fit_image_process_sig(keydir, keydest,
344 fit, image_name, noffset, data, size,
345 comment, require_keys, engine_id, cmdname);
359 static void strlist_init(struct strlist *list)
361 memset(list, '\0', sizeof(*list));
364 static void strlist_free(struct strlist *list)
368 for (i = 0; i < list->count; i++)
369 free(list->strings[i]);
373 static int strlist_add(struct strlist *list, const char *str)
378 list->strings = realloc(list->strings,
379 (list->count + 1) * sizeof(char *));
382 list->strings[list->count++] = dup;
387 static const char *fit_config_get_image_list(void *fit, int noffset,
388 int *lenp, int *allow_missingp)
390 static const char default_list[] = FIT_KERNEL_PROP "\0"
394 /* If there is an "image" property, use that */
395 prop = fdt_getprop(fit, noffset, "sign-images", lenp);
398 return *lenp ? prop : NULL;
401 /* Default image list */
403 *lenp = sizeof(default_list);
408 static int fit_config_get_hash_list(void *fit, int conf_noffset,
409 int sig_offset, struct strlist *node_inc)
412 const char *prop, *iname, *end;
413 const char *conf_name, *sig_name;
414 char name[200], path[200];
418 conf_name = fit_get_name(fit, conf_noffset, NULL);
419 sig_name = fit_get_name(fit, sig_offset, NULL);
422 * Build a list of nodes we need to hash. We always need the root
423 * node and the configuration.
425 strlist_init(node_inc);
426 snprintf(name, sizeof(name), "%s/%s", FIT_CONFS_PATH, conf_name);
427 if (strlist_add(node_inc, "/") ||
428 strlist_add(node_inc, name))
431 /* Get a list of images that we intend to sign */
432 prop = fit_config_get_image_list(fit, sig_offset, &len,
437 /* Locate the images */
440 for (iname = prop; iname < end; iname += strlen(iname) + 1) {
445 image_noffset = fit_conf_get_prop_node(fit, conf_noffset,
447 if (image_noffset < 0) {
448 printf("Failed to find image '%s' in configuration '%s/%s'\n",
449 iname, conf_name, sig_name);
456 ret = fdt_get_path(fit, image_noffset, path, sizeof(path));
459 if (strlist_add(node_inc, path))
462 snprintf(name, sizeof(name), "%s/%s", FIT_CONFS_PATH,
465 /* Add all this image's hashes */
467 for (noffset = fdt_first_subnode(fit, image_noffset);
469 noffset = fdt_next_subnode(fit, noffset)) {
470 const char *name = fit_get_name(fit, noffset, NULL);
472 if (strncmp(name, FIT_HASH_NODENAME,
473 strlen(FIT_HASH_NODENAME)))
475 ret = fdt_get_path(fit, noffset, path, sizeof(path));
478 if (strlist_add(node_inc, path))
484 printf("Failed to find any hash nodes in configuration '%s/%s' image '%s' - without these it is not possible to verify this image\n",
485 conf_name, sig_name, iname);
493 printf("Failed to find any images for configuration '%s/%s'\n",
494 conf_name, sig_name);
501 printf("Out of memory processing configuration '%s/%s'\n", conf_name,
506 printf("Failed to get path for image '%s' in configuration '%s/%s': %s\n",
507 iname, conf_name, sig_name, fdt_strerror(ret));
511 static int fit_config_get_data(void *fit, int conf_noffset, int noffset,
512 struct image_region **regionp, int *region_countp,
513 char **region_propp, int *region_proplen)
515 char * const exc_prop[] = {"data"};
516 struct strlist node_inc;
517 struct image_region *region;
518 struct fdt_region fdt_regions[100];
519 const char *conf_name, *sig_name;
525 conf_name = fit_get_name(fit, conf_noffset, NULL);
526 sig_name = fit_get_name(fit, noffset, NULL);
527 debug("%s: conf='%s', sig='%s'\n", __func__, conf_name, sig_name);
529 /* Get a list of nodes we want to hash */
530 ret = fit_config_get_hash_list(fit, conf_noffset, noffset, &node_inc);
534 /* Get a list of regions to hash */
535 count = fdt_find_regions(fit, node_inc.strings, node_inc.count,
536 exc_prop, ARRAY_SIZE(exc_prop),
537 fdt_regions, ARRAY_SIZE(fdt_regions),
538 path, sizeof(path), 1);
540 printf("Failed to hash configuration '%s/%s': %s\n", conf_name,
541 sig_name, fdt_strerror(ret));
545 printf("No data to hash for configuration '%s/%s': %s\n",
546 conf_name, sig_name, fdt_strerror(ret));
550 /* Build our list of data blocks */
551 region = fit_region_make_list(fit, fdt_regions, count, NULL);
553 printf("Out of memory hashing configuration '%s/%s'\n",
554 conf_name, sig_name);
558 /* Create a list of all hashed properties */
559 debug("Hash nodes:\n");
560 for (i = len = 0; i < node_inc.count; i++) {
561 debug(" %s\n", node_inc.strings[i]);
562 len += strlen(node_inc.strings[i]) + 1;
564 region_prop = malloc(len);
566 printf("Out of memory setting up regions for configuration '%s/%s'\n",
567 conf_name, sig_name);
570 for (i = len = 0; i < node_inc.count;
571 len += strlen(node_inc.strings[i]) + 1, i++)
572 strcpy(region_prop + len, node_inc.strings[i]);
573 strlist_free(&node_inc);
575 *region_countp = count;
577 *region_propp = region_prop;
578 *region_proplen = len;
583 static int fit_config_process_sig(const char *keydir, void *keydest,
584 void *fit, const char *conf_name, int conf_noffset,
585 int noffset, const char *comment, int require_keys,
586 const char *engine_id, const char *cmdname)
588 struct image_sign_info info;
589 const char *node_name;
590 struct image_region *region;
598 node_name = fit_get_name(fit, noffset, NULL);
599 if (fit_config_get_data(fit, conf_noffset, noffset, ®ion,
600 ®ion_count, ®ion_prop, ®ion_proplen))
603 if (fit_image_setup_sig(&info, keydir, fit, conf_name, noffset,
604 require_keys ? "conf" : NULL, engine_id))
607 ret = info.crypto->sign(&info, region, region_count, &value,
611 printf("Failed to sign '%s' signature node in '%s' conf node\n",
612 node_name, conf_name);
614 /* We allow keys to be missing */
620 ret = fit_image_write_sig(fit, noffset, value, value_len, comment,
621 region_prop, region_proplen, cmdname);
623 if (ret == -FDT_ERR_NOSPACE)
625 printf("Can't write signature for '%s' signature node in '%s' conf node: %s\n",
626 node_name, conf_name, fdt_strerror(ret));
632 /* Get keyname again, as FDT has changed and invalidated our pointer */
633 info.keyname = fdt_getprop(fit, noffset, "key-name-hint", NULL);
635 /* Write the public key into the supplied FDT file */
637 ret = info.crypto->add_verify_data(&info, keydest);
639 printf("Failed to add verification data for '%s' signature node in '%s' configuration node\n",
640 node_name, conf_name);
648 static int fit_config_add_verification_data(const char *keydir, void *keydest,
649 void *fit, int conf_noffset, const char *comment,
650 int require_keys, const char *engine_id, const char *cmdname)
652 const char *conf_name;
655 conf_name = fit_get_name(fit, conf_noffset, NULL);
657 /* Process all hash subnodes of the configuration node */
658 for (noffset = fdt_first_subnode(fit, conf_noffset);
660 noffset = fdt_next_subnode(fit, noffset)) {
661 const char *node_name;
664 node_name = fit_get_name(fit, noffset, NULL);
665 if (!strncmp(node_name, FIT_SIG_NODENAME,
666 strlen(FIT_SIG_NODENAME))) {
667 ret = fit_config_process_sig(keydir, keydest,
668 fit, conf_name, conf_noffset, noffset, comment,
669 require_keys, engine_id, cmdname);
678 int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
679 const char *comment, int require_keys,
680 const char *engine_id, const char *cmdname)
682 int images_noffset, confs_noffset;
686 /* Find images parent node offset */
687 images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
688 if (images_noffset < 0) {
689 printf("Can't find images parent node '%s' (%s)\n",
690 FIT_IMAGES_PATH, fdt_strerror(images_noffset));
691 return images_noffset;
694 /* Process its subnodes, print out component images details */
695 for (noffset = fdt_first_subnode(fit, images_noffset);
697 noffset = fdt_next_subnode(fit, noffset)) {
699 * Direct child node of the images parent node,
700 * i.e. component image node.
702 ret = fit_image_add_verification_data(keydir, keydest,
703 fit, noffset, comment, require_keys, engine_id,
709 /* If there are no keys, we can't sign configurations */
710 if (!IMAGE_ENABLE_SIGN || !keydir)
713 /* Find configurations parent node offset */
714 confs_noffset = fdt_path_offset(fit, FIT_CONFS_PATH);
715 if (confs_noffset < 0) {
716 printf("Can't find images parent node '%s' (%s)\n",
717 FIT_CONFS_PATH, fdt_strerror(confs_noffset));
721 /* Process its subnodes, print out component images details */
722 for (noffset = fdt_first_subnode(fit, confs_noffset);
724 noffset = fdt_next_subnode(fit, noffset)) {
725 ret = fit_config_add_verification_data(keydir, keydest,
726 fit, noffset, comment,
736 #ifdef CONFIG_FIT_SIGNATURE
737 int fit_check_sign(const void *fit, const void *key)
742 cfg_noffset = fit_conf_get_node(fit, NULL);
746 printf("Verifying Hash Integrity ... ");
747 ret = fit_config_verify(fit, cfg_noffset);
750 ret = bootm_host_load_images(fit, cfg_noffset);