2 * Copyright (c) 2013, Google Inc.
4 * (C) Copyright 2008 Semihalf
6 * (C) Copyright 2000-2006
7 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
9 * SPDX-License-Identifier: GPL-2.0+
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),
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;
67 node_name = fit_get_name(fit, noffset, NULL);
69 if (fit_image_hash_get_algo(fit, noffset, &algo)) {
70 printf("Can't get hash algo property for '%s' hash node in '%s' image node\n",
71 node_name, image_name);
75 if (calculate_hash(data, size, algo, value, &value_len)) {
76 printf("Unsupported hash algorithm (%s) for '%s' hash node in '%s' image node\n",
77 algo, node_name, image_name);
81 if (fit_set_hash_value(fit, noffset, value, value_len)) {
82 printf("Can't set hash value for '%s' hash node in '%s' image node\n",
83 node_name, image_name);
91 * fit_image_write_sig() - write the signature to a FIT
93 * This writes the signature and signer data to the FIT.
95 * @fit: pointer to the FIT format image header
96 * @noffset: hash node offset
97 * @value: signature value to be set
98 * @value_len: signature value length
99 * @comment: Text comment to write (NULL for none)
103 * -FDT_ERR_..., on failure
105 static int fit_image_write_sig(void *fit, int noffset, uint8_t *value,
106 int value_len, const char *comment, const char *region_prop,
113 * Get the current string size, before we update the FIT and add
116 string_size = fdt_size_dt_strings(fit);
118 ret = fdt_setprop(fit, noffset, FIT_VALUE_PROP, value, value_len);
120 ret = fdt_setprop_string(fit, noffset, "signer-name",
124 ret = fdt_setprop_string(fit, noffset, "signer-version",
128 ret = fdt_setprop_string(fit, noffset, "comment", comment);
130 ret = fit_set_timestamp(fit, noffset, time(NULL));
131 if (region_prop && !ret) {
134 ret = fdt_setprop(fit, noffset, "hashed-nodes",
135 region_prop, region_proplen);
137 strdata[1] = cpu_to_fdt32(string_size);
139 ret = fdt_setprop(fit, noffset, "hashed-strings",
140 strdata, sizeof(strdata));
147 static int fit_image_setup_sig(struct image_sign_info *info,
148 const char *keydir, void *fit, const char *image_name,
149 int noffset, const char *require_keys)
151 const char *node_name;
154 node_name = fit_get_name(fit, noffset, NULL);
155 if (fit_image_hash_get_algo(fit, noffset, &algo_name)) {
156 printf("Can't get algo property for '%s' signature node in '%s' image node\n",
157 node_name, image_name);
161 memset(info, '\0', sizeof(*info));
162 info->keydir = keydir;
163 info->keyname = fdt_getprop(fit, noffset, "key-name-hint", NULL);
165 info->node_offset = noffset;
166 info->algo = image_get_sig_algo(algo_name);
167 info->require_keys = require_keys;
169 printf("Unsupported signature algorithm (%s) for '%s' signature node in '%s' image node\n",
170 algo_name, node_name, image_name);
178 * fit_image_process_sig- Process a single subnode of the images/ node
180 * Check each subnode and process accordingly. For signature nodes we
181 * generate a signed hash of the supplised data and store it in the node.
183 * @keydir: Directory containing keys to use for signing
184 * @keydest: Destination FDT blob to write public keys into
185 * @fit: pointer to the FIT format image header
186 * @image_name: name of image being processes (used to display errors)
187 * @noffset: subnode offset
188 * @data: data to process
189 * @size: size of data in bytes
190 * @comment: Comment to add to signature nodes
191 * @require_keys: Mark all keys as 'required'
192 * @return 0 if ok, -1 on error
194 static int fit_image_process_sig(const char *keydir, void *keydest,
195 void *fit, const char *image_name,
196 int noffset, const void *data, size_t size,
197 const char *comment, int require_keys)
199 struct image_sign_info info;
200 struct image_region region;
201 const char *node_name;
206 if (fit_image_setup_sig(&info, keydir, fit, image_name, noffset,
207 require_keys ? "image" : NULL))
210 node_name = fit_get_name(fit, noffset, NULL);
213 ret = info.algo->sign(&info, ®ion, 1, &value, &value_len);
215 printf("Failed to sign '%s' signature node in '%s' image node: %d\n",
216 node_name, image_name, ret);
218 /* We allow keys to be missing */
224 ret = fit_image_write_sig(fit, noffset, value, value_len, comment,
227 if (ret == -FDT_ERR_NOSPACE)
229 printf("Can't write signature for '%s' signature node in '%s' conf node: %s\n",
230 node_name, image_name, fdt_strerror(ret));
235 /* Get keyname again, as FDT has changed and invalidated our pointer */
236 info.keyname = fdt_getprop(fit, noffset, "key-name-hint", NULL);
238 /* Write the public key into the supplied FDT file */
239 if (keydest && info.algo->add_verify_data(&info, keydest)) {
240 printf("Failed to add verification data for '%s' signature node in '%s' image node\n",
241 node_name, image_name);
249 * fit_image_add_verification_data() - calculate/set verig. data for image node
251 * This adds hash and signature values for an component image node.
253 * All existing hash subnodes are checked, if algorithm property is set to
254 * one of the supported hash algorithms, hash value is computed and
255 * corresponding hash node property is set, for example:
257 * Input component image node structure:
259 * o image@1 (at image_noffset)
260 * | - data = [binary data]
264 * Output component image node structure:
266 * o image@1 (at image_noffset)
267 * | - data = [binary data]
270 * |- value = sha1(data)
272 * For signature details, please see doc/uImage.FIT/signature.txt
274 * @keydir Directory containing *.key and *.crt files (or NULL)
275 * @keydest FDT Blob to write public keys into (NULL if none)
276 * @fit: Pointer to the FIT format image header
277 * @image_noffset: Requested component image node
278 * @comment: Comment to add to signature nodes
279 * @require_keys: Mark all keys as 'required'
280 * @return: 0 on success, <0 on failure
282 int fit_image_add_verification_data(const char *keydir, void *keydest,
283 void *fit, int image_noffset, const char *comment,
286 const char *image_name;
291 /* Get image data and data length */
292 if (fit_image_get_data(fit, image_noffset, &data, &size)) {
293 printf("Can't get image data/size\n");
297 image_name = fit_get_name(fit, image_noffset, NULL);
299 /* Process all hash subnodes of the component image node */
300 for (noffset = fdt_first_subnode(fit, image_noffset);
302 noffset = fdt_next_subnode(fit, noffset)) {
303 const char *node_name;
307 * Check subnode name, must be equal to "hash" or "signature".
308 * Multiple hash nodes require unique unit node
309 * names, e.g. hash@1, hash@2, signature@1, etc.
311 node_name = fit_get_name(fit, noffset, NULL);
312 if (!strncmp(node_name, FIT_HASH_NODENAME,
313 strlen(FIT_HASH_NODENAME))) {
314 ret = fit_image_process_hash(fit, image_name, noffset,
316 } else if (IMAGE_ENABLE_SIGN && keydir &&
317 !strncmp(node_name, FIT_SIG_NODENAME,
318 strlen(FIT_SIG_NODENAME))) {
319 ret = fit_image_process_sig(keydir, keydest,
320 fit, image_name, noffset, data, size,
321 comment, require_keys);
335 static void strlist_init(struct strlist *list)
337 memset(list, '\0', sizeof(*list));
340 static void strlist_free(struct strlist *list)
344 for (i = 0; i < list->count; i++)
345 free(list->strings[i]);
349 static int strlist_add(struct strlist *list, const char *str)
354 list->strings = realloc(list->strings,
355 (list->count + 1) * sizeof(char *));
358 list->strings[list->count++] = dup;
363 static const char *fit_config_get_image_list(void *fit, int noffset,
364 int *lenp, int *allow_missingp)
366 static const char default_list[] = FIT_KERNEL_PROP "\0"
370 /* If there is an "image" property, use that */
371 prop = fdt_getprop(fit, noffset, "sign-images", lenp);
374 return *lenp ? prop : NULL;
377 /* Default image list */
379 *lenp = sizeof(default_list);
384 static int fit_config_get_hash_list(void *fit, int conf_noffset,
385 int sig_offset, struct strlist *node_inc)
388 const char *prop, *iname, *end;
389 const char *conf_name, *sig_name;
390 char name[200], path[200];
394 conf_name = fit_get_name(fit, conf_noffset, NULL);
395 sig_name = fit_get_name(fit, sig_offset, NULL);
398 * Build a list of nodes we need to hash. We always need the root
399 * node and the configuration.
401 strlist_init(node_inc);
402 snprintf(name, sizeof(name), "%s/%s", FIT_CONFS_PATH, conf_name);
403 if (strlist_add(node_inc, "/") ||
404 strlist_add(node_inc, name))
407 /* Get a list of images that we intend to sign */
408 prop = fit_config_get_image_list(fit, sig_offset, &len,
413 /* Locate the images */
416 for (iname = prop; iname < end; iname += strlen(iname) + 1) {
421 image_noffset = fit_conf_get_prop_node(fit, conf_noffset,
423 if (image_noffset < 0) {
424 printf("Failed to find image '%s' in configuration '%s/%s'\n",
425 iname, conf_name, sig_name);
432 ret = fdt_get_path(fit, image_noffset, path, sizeof(path));
435 if (strlist_add(node_inc, path))
438 snprintf(name, sizeof(name), "%s/%s", FIT_CONFS_PATH,
441 /* Add all this image's hashes */
443 for (noffset = fdt_first_subnode(fit, image_noffset);
445 noffset = fdt_next_subnode(fit, noffset)) {
446 const char *name = fit_get_name(fit, noffset, NULL);
448 if (strncmp(name, FIT_HASH_NODENAME,
449 strlen(FIT_HASH_NODENAME)))
451 ret = fdt_get_path(fit, noffset, path, sizeof(path));
454 if (strlist_add(node_inc, path))
460 printf("Failed to find any hash nodes in configuration '%s/%s' image '%s' - without these it is not possible to verify this image\n",
461 conf_name, sig_name, iname);
469 printf("Failed to find any images for configuration '%s/%s'\n",
470 conf_name, sig_name);
477 printf("Out of memory processing configuration '%s/%s'\n", conf_name,
482 printf("Failed to get path for image '%s' in configuration '%s/%s': %s\n",
483 iname, conf_name, sig_name, fdt_strerror(ret));
487 static int fit_config_get_data(void *fit, int conf_noffset, int noffset,
488 struct image_region **regionp, int *region_countp,
489 char **region_propp, int *region_proplen)
491 char * const exc_prop[] = {"data"};
492 struct strlist node_inc;
493 struct image_region *region;
494 struct fdt_region fdt_regions[100];
495 const char *conf_name, *sig_name;
501 conf_name = fit_get_name(fit, conf_noffset, NULL);
502 sig_name = fit_get_name(fit, conf_noffset, NULL);
503 debug("%s: conf='%s', sig='%s'\n", __func__, conf_name, sig_name);
505 /* Get a list of nodes we want to hash */
506 ret = fit_config_get_hash_list(fit, conf_noffset, noffset, &node_inc);
510 /* Get a list of regions to hash */
511 count = fdt_find_regions(fit, node_inc.strings, node_inc.count,
512 exc_prop, ARRAY_SIZE(exc_prop),
513 fdt_regions, ARRAY_SIZE(fdt_regions),
514 path, sizeof(path), 1);
516 printf("Failed to hash configuration '%s/%s': %s\n", conf_name,
517 sig_name, fdt_strerror(ret));
521 printf("No data to hash for configuration '%s/%s': %s\n",
522 conf_name, sig_name, fdt_strerror(ret));
526 /* Build our list of data blocks */
527 region = fit_region_make_list(fit, fdt_regions, count, NULL);
529 printf("Out of memory hashing configuration '%s/%s'\n",
530 conf_name, sig_name);
534 /* Create a list of all hashed properties */
535 debug("Hash nodes:\n");
536 for (i = len = 0; i < node_inc.count; i++) {
537 debug(" %s\n", node_inc.strings[i]);
538 len += strlen(node_inc.strings[i]) + 1;
540 region_prop = malloc(len);
542 printf("Out of memory setting up regions for configuration '%s/%s'\n",
543 conf_name, sig_name);
546 for (i = len = 0; i < node_inc.count;
547 len += strlen(node_inc.strings[i]) + 1, i++)
548 strcpy(region_prop + len, node_inc.strings[i]);
549 strlist_free(&node_inc);
551 *region_countp = count;
553 *region_propp = region_prop;
554 *region_proplen = len;
559 static int fit_config_process_sig(const char *keydir, void *keydest,
560 void *fit, const char *conf_name, int conf_noffset,
561 int noffset, const char *comment, int require_keys)
563 struct image_sign_info info;
564 const char *node_name;
565 struct image_region *region;
573 node_name = fit_get_name(fit, noffset, NULL);
574 if (fit_config_get_data(fit, conf_noffset, noffset, ®ion,
575 ®ion_count, ®ion_prop, ®ion_proplen))
578 if (fit_image_setup_sig(&info, keydir, fit, conf_name, noffset,
579 require_keys ? "conf" : NULL))
582 ret = info.algo->sign(&info, region, region_count, &value, &value_len);
585 printf("Failed to sign '%s' signature node in '%s' conf node\n",
586 node_name, conf_name);
588 /* We allow keys to be missing */
594 ret = fit_image_write_sig(fit, noffset, value, value_len, comment,
595 region_prop, region_proplen);
597 if (ret == -FDT_ERR_NOSPACE)
599 printf("Can't write signature for '%s' signature node in '%s' conf node: %s\n",
600 node_name, conf_name, fdt_strerror(ret));
606 /* Get keyname again, as FDT has changed and invalidated our pointer */
607 info.keyname = fdt_getprop(fit, noffset, "key-name-hint", NULL);
609 /* Write the public key into the supplied FDT file */
611 ret = info.algo->add_verify_data(&info, keydest);
615 printf("Failed to add verification data for '%s' signature node in '%s' image node\n",
616 node_name, conf_name);
624 static int fit_config_add_verification_data(const char *keydir, void *keydest,
625 void *fit, int conf_noffset, const char *comment,
628 const char *conf_name;
631 conf_name = fit_get_name(fit, conf_noffset, NULL);
633 /* Process all hash subnodes of the configuration node */
634 for (noffset = fdt_first_subnode(fit, conf_noffset);
636 noffset = fdt_next_subnode(fit, noffset)) {
637 const char *node_name;
640 node_name = fit_get_name(fit, noffset, NULL);
641 if (!strncmp(node_name, FIT_SIG_NODENAME,
642 strlen(FIT_SIG_NODENAME))) {
643 ret = fit_config_process_sig(keydir, keydest,
644 fit, conf_name, conf_noffset, noffset, comment,
654 int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
655 const char *comment, int require_keys)
657 int images_noffset, confs_noffset;
661 /* Find images parent node offset */
662 images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
663 if (images_noffset < 0) {
664 printf("Can't find images parent node '%s' (%s)\n",
665 FIT_IMAGES_PATH, fdt_strerror(images_noffset));
666 return images_noffset;
669 /* Process its subnodes, print out component images details */
670 for (noffset = fdt_first_subnode(fit, images_noffset);
672 noffset = fdt_next_subnode(fit, noffset)) {
674 * Direct child node of the images parent node,
675 * i.e. component image node.
677 ret = fit_image_add_verification_data(keydir, keydest,
678 fit, noffset, comment, require_keys);
683 /* If there are no keys, we can't sign configurations */
684 if (!IMAGE_ENABLE_SIGN || !keydir)
687 /* Find configurations parent node offset */
688 confs_noffset = fdt_path_offset(fit, FIT_CONFS_PATH);
689 if (confs_noffset < 0) {
690 printf("Can't find images parent node '%s' (%s)\n",
691 FIT_IMAGES_PATH, fdt_strerror(confs_noffset));
695 /* Process its subnodes, print out component images details */
696 for (noffset = fdt_first_subnode(fit, confs_noffset);
698 noffset = fdt_next_subnode(fit, noffset)) {
699 ret = fit_config_add_verification_data(keydir, keydest,
700 fit, noffset, comment,
709 #ifdef CONFIG_FIT_SIGNATURE
710 int fit_check_sign(const void *working_fdt, const void *key)
715 cfg_noffset = fit_conf_get_node(working_fdt, NULL);
719 ret = fit_config_verify(working_fdt, cfg_noffset);