]>
git.ipfire.org Git - people/ms/u-boot.git/blob - tools/image-host.c
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+
18 * 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
24 * fit_set_hash_value() attempts to set hash value in a node at offset
25 * given and returns operation status to the caller.
31 static int fit_set_hash_value(void *fit
, int noffset
, uint8_t *value
,
36 ret
= fdt_setprop(fit
, noffset
, FIT_VALUE_PROP
, value
, value_len
);
38 printf("Can't set hash '%s' property for '%s' node(%s)\n",
39 FIT_VALUE_PROP
, fit_get_name(fit
, noffset
, NULL
),
41 return ret
== -FDT_ERR_NOSPACE
? -ENOSPC
: -EIO
;
48 * fit_image_process_hash - Process a single subnode of the images/ node
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.
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
60 static int fit_image_process_hash(void *fit
, const char *image_name
,
61 int noffset
, const void *data
, size_t size
)
63 uint8_t value
[FIT_MAX_HASH_LEN
];
64 const char *node_name
;
69 node_name
= fit_get_name(fit
, noffset
, NULL
);
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",
73 node_name
, image_name
);
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",
79 algo
, node_name
, image_name
);
80 return -EPROTONOSUPPORT
;
83 ret
= fit_set_hash_value(fit
, noffset
, value
, value_len
);
85 printf("Can't set hash value for '%s' hash node in '%s' image node\n",
86 node_name
, image_name
);
94 * fit_image_write_sig() - write the signature to a FIT
96 * This writes the signature and signer data to the FIT.
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)
106 * -FDT_ERR_..., on failure
108 static int fit_image_write_sig(void *fit
, int noffset
, uint8_t *value
,
109 int value_len
, const char *comment
, const char *region_prop
,
116 * Get the current string size, before we update the FIT and add
119 string_size
= fdt_size_dt_strings(fit
);
121 ret
= fdt_setprop(fit
, noffset
, FIT_VALUE_PROP
, value
, value_len
);
123 ret
= fdt_setprop_string(fit
, noffset
, "signer-name",
127 ret
= fdt_setprop_string(fit
, noffset
, "signer-version",
131 ret
= fdt_setprop_string(fit
, noffset
, "comment", comment
);
133 ret
= fit_set_timestamp(fit
, noffset
, time(NULL
));
134 if (region_prop
&& !ret
) {
137 ret
= fdt_setprop(fit
, noffset
, "hashed-nodes",
138 region_prop
, region_proplen
);
140 strdata
[1] = cpu_to_fdt32(string_size
);
142 ret
= fdt_setprop(fit
, noffset
, "hashed-strings",
143 strdata
, sizeof(strdata
));
150 static int fit_image_setup_sig(struct image_sign_info
*info
,
151 const char *keydir
, void *fit
, const char *image_name
,
152 int noffset
, const char *require_keys
, const char *engine_id
)
154 const char *node_name
;
157 node_name
= fit_get_name(fit
, noffset
, NULL
);
158 if (fit_image_hash_get_algo(fit
, noffset
, &algo_name
)) {
159 printf("Can't get algo property for '%s' signature node in '%s' image node\n",
160 node_name
, image_name
);
164 memset(info
, '\0', sizeof(*info
));
165 info
->keydir
= keydir
;
166 info
->keyname
= fdt_getprop(fit
, noffset
, "key-name-hint", NULL
);
168 info
->node_offset
= noffset
;
169 info
->name
= algo_name
;
170 info
->checksum
= image_get_checksum_algo(algo_name
);
171 info
->crypto
= image_get_crypto_algo(algo_name
);
172 info
->require_keys
= require_keys
;
173 info
->engine_id
= engine_id
;
174 if (!info
->checksum
|| !info
->crypto
) {
175 printf("Unsupported signature algorithm (%s) for '%s' signature node in '%s' image node\n",
176 algo_name
, node_name
, image_name
);
184 * fit_image_process_sig- Process a single subnode of the images/ node
186 * Check each subnode and process accordingly. For signature nodes we
187 * generate a signed hash of the supplised data and store it in the node.
189 * @keydir: Directory containing keys to use for signing
190 * @keydest: Destination FDT blob to write public keys into
191 * @fit: pointer to the FIT format image header
192 * @image_name: name of image being processes (used to display errors)
193 * @noffset: subnode offset
194 * @data: data to process
195 * @size: size of data in bytes
196 * @comment: Comment to add to signature nodes
197 * @require_keys: Mark all keys as 'required'
198 * @engine_id: Engine to use for signing
199 * @return 0 if ok, -1 on error
201 static int fit_image_process_sig(const char *keydir
, void *keydest
,
202 void *fit
, const char *image_name
,
203 int noffset
, const void *data
, size_t size
,
204 const char *comment
, int require_keys
, const char *engine_id
)
206 struct image_sign_info info
;
207 struct image_region region
;
208 const char *node_name
;
213 if (fit_image_setup_sig(&info
, keydir
, fit
, image_name
, noffset
,
214 require_keys
? "image" : NULL
, engine_id
))
217 node_name
= fit_get_name(fit
, noffset
, NULL
);
220 ret
= info
.crypto
->sign(&info
, ®ion
, 1, &value
, &value_len
);
222 printf("Failed to sign '%s' signature node in '%s' image node: %d\n",
223 node_name
, image_name
, ret
);
225 /* We allow keys to be missing */
231 ret
= fit_image_write_sig(fit
, noffset
, value
, value_len
, comment
,
234 if (ret
== -FDT_ERR_NOSPACE
)
236 printf("Can't write signature for '%s' signature node in '%s' conf node: %s\n",
237 node_name
, image_name
, fdt_strerror(ret
));
242 /* Get keyname again, as FDT has changed and invalidated our pointer */
243 info
.keyname
= fdt_getprop(fit
, noffset
, "key-name-hint", NULL
);
246 ret
= info
.crypto
->add_verify_data(&info
, keydest
);
251 * Write the public key into the supplied FDT file; this might fail
252 * several times, since we try signing with successively increasing
262 * fit_image_add_verification_data() - calculate/set verig. data for image node
264 * This adds hash and signature values for an component image node.
266 * All existing hash subnodes are checked, if algorithm property is set to
267 * one of the supported hash algorithms, hash value is computed and
268 * corresponding hash node property is set, for example:
270 * Input component image node structure:
272 * o image@1 (at image_noffset)
273 * | - data = [binary data]
277 * Output component image node structure:
279 * o image@1 (at image_noffset)
280 * | - data = [binary data]
283 * |- value = sha1(data)
285 * For signature details, please see doc/uImage.FIT/signature.txt
287 * @keydir Directory containing *.key and *.crt files (or NULL)
288 * @keydest FDT Blob to write public keys into (NULL if none)
289 * @fit: Pointer to the FIT format image header
290 * @image_noffset: Requested component image node
291 * @comment: Comment to add to signature nodes
292 * @require_keys: Mark all keys as 'required'
293 * @engine_id: Engine to use for signing
294 * @return: 0 on success, <0 on failure
296 int fit_image_add_verification_data(const char *keydir
, void *keydest
,
297 void *fit
, int image_noffset
, const char *comment
,
298 int require_keys
, const char *engine_id
)
300 const char *image_name
;
305 /* Get image data and data length */
306 if (fit_image_get_data(fit
, image_noffset
, &data
, &size
)) {
307 printf("Can't get image data/size\n");
311 image_name
= fit_get_name(fit
, image_noffset
, NULL
);
313 /* Process all hash subnodes of the component image node */
314 for (noffset
= fdt_first_subnode(fit
, image_noffset
);
316 noffset
= fdt_next_subnode(fit
, noffset
)) {
317 const char *node_name
;
321 * Check subnode name, must be equal to "hash" or "signature".
322 * Multiple hash nodes require unique unit node
323 * names, e.g. hash@1, hash@2, signature@1, etc.
325 node_name
= fit_get_name(fit
, noffset
, NULL
);
326 if (!strncmp(node_name
, FIT_HASH_NODENAME
,
327 strlen(FIT_HASH_NODENAME
))) {
328 ret
= fit_image_process_hash(fit
, image_name
, noffset
,
330 } else if (IMAGE_ENABLE_SIGN
&& keydir
&&
331 !strncmp(node_name
, FIT_SIG_NODENAME
,
332 strlen(FIT_SIG_NODENAME
))) {
333 ret
= fit_image_process_sig(keydir
, keydest
,
334 fit
, image_name
, noffset
, data
, size
,
335 comment
, require_keys
, engine_id
);
349 static void strlist_init(struct strlist
*list
)
351 memset(list
, '\0', sizeof(*list
));
354 static void strlist_free(struct strlist
*list
)
358 for (i
= 0; i
< list
->count
; i
++)
359 free(list
->strings
[i
]);
363 static int strlist_add(struct strlist
*list
, const char *str
)
368 list
->strings
= realloc(list
->strings
,
369 (list
->count
+ 1) * sizeof(char *));
372 list
->strings
[list
->count
++] = dup
;
377 static const char *fit_config_get_image_list(void *fit
, int noffset
,
378 int *lenp
, int *allow_missingp
)
380 static const char default_list
[] = FIT_KERNEL_PROP
"\0"
384 /* If there is an "image" property, use that */
385 prop
= fdt_getprop(fit
, noffset
, "sign-images", lenp
);
388 return *lenp
? prop
: NULL
;
391 /* Default image list */
393 *lenp
= sizeof(default_list
);
398 static int fit_config_get_hash_list(void *fit
, int conf_noffset
,
399 int sig_offset
, struct strlist
*node_inc
)
402 const char *prop
, *iname
, *end
;
403 const char *conf_name
, *sig_name
;
404 char name
[200], path
[200];
408 conf_name
= fit_get_name(fit
, conf_noffset
, NULL
);
409 sig_name
= fit_get_name(fit
, sig_offset
, NULL
);
412 * Build a list of nodes we need to hash. We always need the root
413 * node and the configuration.
415 strlist_init(node_inc
);
416 snprintf(name
, sizeof(name
), "%s/%s", FIT_CONFS_PATH
, conf_name
);
417 if (strlist_add(node_inc
, "/") ||
418 strlist_add(node_inc
, name
))
421 /* Get a list of images that we intend to sign */
422 prop
= fit_config_get_image_list(fit
, sig_offset
, &len
,
427 /* Locate the images */
430 for (iname
= prop
; iname
< end
; iname
+= strlen(iname
) + 1) {
435 image_noffset
= fit_conf_get_prop_node(fit
, conf_noffset
,
437 if (image_noffset
< 0) {
438 printf("Failed to find image '%s' in configuration '%s/%s'\n",
439 iname
, conf_name
, sig_name
);
446 ret
= fdt_get_path(fit
, image_noffset
, path
, sizeof(path
));
449 if (strlist_add(node_inc
, path
))
452 snprintf(name
, sizeof(name
), "%s/%s", FIT_CONFS_PATH
,
455 /* Add all this image's hashes */
457 for (noffset
= fdt_first_subnode(fit
, image_noffset
);
459 noffset
= fdt_next_subnode(fit
, noffset
)) {
460 const char *name
= fit_get_name(fit
, noffset
, NULL
);
462 if (strncmp(name
, FIT_HASH_NODENAME
,
463 strlen(FIT_HASH_NODENAME
)))
465 ret
= fdt_get_path(fit
, noffset
, path
, sizeof(path
));
468 if (strlist_add(node_inc
, path
))
474 printf("Failed to find any hash nodes in configuration '%s/%s' image '%s' - without these it is not possible to verify this image\n",
475 conf_name
, sig_name
, iname
);
483 printf("Failed to find any images for configuration '%s/%s'\n",
484 conf_name
, sig_name
);
491 printf("Out of memory processing configuration '%s/%s'\n", conf_name
,
496 printf("Failed to get path for image '%s' in configuration '%s/%s': %s\n",
497 iname
, conf_name
, sig_name
, fdt_strerror(ret
));
501 static int fit_config_get_data(void *fit
, int conf_noffset
, int noffset
,
502 struct image_region
**regionp
, int *region_countp
,
503 char **region_propp
, int *region_proplen
)
505 char * const exc_prop
[] = {"data"};
506 struct strlist node_inc
;
507 struct image_region
*region
;
508 struct fdt_region fdt_regions
[100];
509 const char *conf_name
, *sig_name
;
515 conf_name
= fit_get_name(fit
, conf_noffset
, NULL
);
516 sig_name
= fit_get_name(fit
, conf_noffset
, NULL
);
517 debug("%s: conf='%s', sig='%s'\n", __func__
, conf_name
, sig_name
);
519 /* Get a list of nodes we want to hash */
520 ret
= fit_config_get_hash_list(fit
, conf_noffset
, noffset
, &node_inc
);
524 /* Get a list of regions to hash */
525 count
= fdt_find_regions(fit
, node_inc
.strings
, node_inc
.count
,
526 exc_prop
, ARRAY_SIZE(exc_prop
),
527 fdt_regions
, ARRAY_SIZE(fdt_regions
),
528 path
, sizeof(path
), 1);
530 printf("Failed to hash configuration '%s/%s': %s\n", conf_name
,
531 sig_name
, fdt_strerror(ret
));
535 printf("No data to hash for configuration '%s/%s': %s\n",
536 conf_name
, sig_name
, fdt_strerror(ret
));
540 /* Build our list of data blocks */
541 region
= fit_region_make_list(fit
, fdt_regions
, count
, NULL
);
543 printf("Out of memory hashing configuration '%s/%s'\n",
544 conf_name
, sig_name
);
548 /* Create a list of all hashed properties */
549 debug("Hash nodes:\n");
550 for (i
= len
= 0; i
< node_inc
.count
; i
++) {
551 debug(" %s\n", node_inc
.strings
[i
]);
552 len
+= strlen(node_inc
.strings
[i
]) + 1;
554 region_prop
= malloc(len
);
556 printf("Out of memory setting up regions for configuration '%s/%s'\n",
557 conf_name
, sig_name
);
560 for (i
= len
= 0; i
< node_inc
.count
;
561 len
+= strlen(node_inc
.strings
[i
]) + 1, i
++)
562 strcpy(region_prop
+ len
, node_inc
.strings
[i
]);
563 strlist_free(&node_inc
);
565 *region_countp
= count
;
567 *region_propp
= region_prop
;
568 *region_proplen
= len
;
573 static int fit_config_process_sig(const char *keydir
, void *keydest
,
574 void *fit
, const char *conf_name
, int conf_noffset
,
575 int noffset
, const char *comment
, int require_keys
,
576 const char *engine_id
)
578 struct image_sign_info info
;
579 const char *node_name
;
580 struct image_region
*region
;
588 node_name
= fit_get_name(fit
, noffset
, NULL
);
589 if (fit_config_get_data(fit
, conf_noffset
, noffset
, ®ion
,
590 ®ion_count
, ®ion_prop
, ®ion_proplen
))
593 if (fit_image_setup_sig(&info
, keydir
, fit
, conf_name
, noffset
,
594 require_keys
? "conf" : NULL
, engine_id
))
597 ret
= info
.crypto
->sign(&info
, region
, region_count
, &value
,
601 printf("Failed to sign '%s' signature node in '%s' conf node\n",
602 node_name
, conf_name
);
604 /* We allow keys to be missing */
610 ret
= fit_image_write_sig(fit
, noffset
, value
, value_len
, comment
,
611 region_prop
, region_proplen
);
613 if (ret
== -FDT_ERR_NOSPACE
)
615 printf("Can't write signature for '%s' signature node in '%s' conf node: %s\n",
616 node_name
, conf_name
, fdt_strerror(ret
));
622 /* Get keyname again, as FDT has changed and invalidated our pointer */
623 info
.keyname
= fdt_getprop(fit
, noffset
, "key-name-hint", NULL
);
625 /* Write the public key into the supplied FDT file */
627 ret
= info
.crypto
->add_verify_data(&info
, keydest
);
631 printf("Failed to add verification data for '%s' signature node in '%s' image node\n",
632 node_name
, conf_name
);
640 static int fit_config_add_verification_data(const char *keydir
, void *keydest
,
641 void *fit
, int conf_noffset
, const char *comment
,
642 int require_keys
, const char *engine_id
)
644 const char *conf_name
;
647 conf_name
= fit_get_name(fit
, conf_noffset
, NULL
);
649 /* Process all hash subnodes of the configuration node */
650 for (noffset
= fdt_first_subnode(fit
, conf_noffset
);
652 noffset
= fdt_next_subnode(fit
, noffset
)) {
653 const char *node_name
;
656 node_name
= fit_get_name(fit
, noffset
, NULL
);
657 if (!strncmp(node_name
, FIT_SIG_NODENAME
,
658 strlen(FIT_SIG_NODENAME
))) {
659 ret
= fit_config_process_sig(keydir
, keydest
,
660 fit
, conf_name
, conf_noffset
, noffset
, comment
,
661 require_keys
, engine_id
);
670 int fit_add_verification_data(const char *keydir
, void *keydest
, void *fit
,
671 const char *comment
, int require_keys
,
672 const char *engine_id
)
674 int images_noffset
, confs_noffset
;
678 /* Find images parent node offset */
679 images_noffset
= fdt_path_offset(fit
, FIT_IMAGES_PATH
);
680 if (images_noffset
< 0) {
681 printf("Can't find images parent node '%s' (%s)\n",
682 FIT_IMAGES_PATH
, fdt_strerror(images_noffset
));
683 return images_noffset
;
686 /* Process its subnodes, print out component images details */
687 for (noffset
= fdt_first_subnode(fit
, images_noffset
);
689 noffset
= fdt_next_subnode(fit
, noffset
)) {
691 * Direct child node of the images parent node,
692 * i.e. component image node.
694 ret
= fit_image_add_verification_data(keydir
, keydest
,
695 fit
, noffset
, comment
, require_keys
, engine_id
);
700 /* If there are no keys, we can't sign configurations */
701 if (!IMAGE_ENABLE_SIGN
|| !keydir
)
704 /* Find configurations parent node offset */
705 confs_noffset
= fdt_path_offset(fit
, FIT_CONFS_PATH
);
706 if (confs_noffset
< 0) {
707 printf("Can't find images parent node '%s' (%s)\n",
708 FIT_CONFS_PATH
, fdt_strerror(confs_noffset
));
712 /* Process its subnodes, print out component images details */
713 for (noffset
= fdt_first_subnode(fit
, confs_noffset
);
715 noffset
= fdt_next_subnode(fit
, noffset
)) {
716 ret
= fit_config_add_verification_data(keydir
, keydest
,
717 fit
, noffset
, comment
,
727 #ifdef CONFIG_FIT_SIGNATURE
728 int fit_check_sign(const void *fit
, const void *key
)
733 cfg_noffset
= fit_conf_get_node(fit
, NULL
);
737 printf("Verifying Hash Integrity ... ");
738 ret
= fit_config_verify(fit
, cfg_noffset
);
741 ret
= bootm_host_load_images(fit
, cfg_noffset
);