]> git.kernelconcepts.de Git - karo-tx-uboot.git/blobdiff - tools/image-host.c
dm: pmic: max77686: Correct two typos in a comment
[karo-tx-uboot.git] / tools / image-host.c
index d944d0ff4e3cc1f2363b9e5fce2653ee986e0607..7effb6cea59e2a084e253e26661949f058c8b534 100644 (file)
@@ -6,32 +6,13 @@
  * (C) Copyright 2000-2006
  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  *
- * See file CREDITS for list of people who contributed to this
- * project.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
- * published by the Free Software Foundation; either version 2 of
- * the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
- * MA 02111-1307 USA
+ * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #include "mkimage.h"
-#include <bootstage.h>
+#include <bootm.h>
 #include <image.h>
-#include <sha1.h>
-#include <time.h>
-#include <u-boot/crc.h>
-#include <u-boot/md5.h>
+#include <version.h>
 
 /**
  * fit_set_hash_value - set hash value in requested has node
@@ -108,9 +89,167 @@ static int fit_image_process_hash(void *fit, const char *image_name,
 }
 
 /**
- * fit_image_add_verification_data() - calculate/set hash data for image node
+ * fit_image_write_sig() - write the signature to a FIT
  *
- * This adds hash values for a component image node.
+ * This writes the signature and signer data to the FIT.
+ *
+ * @fit: pointer to the FIT format image header
+ * @noffset: hash node offset
+ * @value: signature value to be set
+ * @value_len: signature value length
+ * @comment: Text comment to write (NULL for none)
+ *
+ * returns
+ *     0, on success
+ *     -FDT_ERR_..., on failure
+ */
+static int fit_image_write_sig(void *fit, int noffset, uint8_t *value,
+               int value_len, const char *comment, const char *region_prop,
+               int region_proplen)
+{
+       int string_size;
+       int ret;
+
+       /*
+        * Get the current string size, before we update the FIT and add
+        * more
+        */
+       string_size = fdt_size_dt_strings(fit);
+
+       ret = fdt_setprop(fit, noffset, FIT_VALUE_PROP, value, value_len);
+       if (!ret) {
+               ret = fdt_setprop_string(fit, noffset, "signer-name",
+                                        "mkimage");
+       }
+       if (!ret) {
+               ret = fdt_setprop_string(fit, noffset, "signer-version",
+                                 PLAIN_VERSION);
+       }
+       if (comment && !ret)
+               ret = fdt_setprop_string(fit, noffset, "comment", comment);
+       if (!ret)
+               ret = fit_set_timestamp(fit, noffset, time(NULL));
+       if (region_prop && !ret) {
+               uint32_t strdata[2];
+
+               ret = fdt_setprop(fit, noffset, "hashed-nodes",
+                                  region_prop, region_proplen);
+               strdata[0] = 0;
+               strdata[1] = cpu_to_fdt32(string_size);
+               if (!ret) {
+                       ret = fdt_setprop(fit, noffset, "hashed-strings",
+                                         strdata, sizeof(strdata));
+               }
+       }
+
+       return ret;
+}
+
+static int fit_image_setup_sig(struct image_sign_info *info,
+               const char *keydir, void *fit, const char *image_name,
+               int noffset, const char *require_keys)
+{
+       const char *node_name;
+       char *algo_name;
+
+       node_name = fit_get_name(fit, noffset, NULL);
+       if (fit_image_hash_get_algo(fit, noffset, &algo_name)) {
+               printf("Can't get algo property for '%s' signature node in '%s' image node\n",
+                      node_name, image_name);
+               return -1;
+       }
+
+       memset(info, '\0', sizeof(*info));
+       info->keydir = keydir;
+       info->keyname = fdt_getprop(fit, noffset, "key-name-hint", NULL);
+       info->fit = fit;
+       info->node_offset = noffset;
+       info->algo = image_get_sig_algo(algo_name);
+       info->require_keys = require_keys;
+       if (!info->algo) {
+               printf("Unsupported signature algorithm (%s) for '%s' signature node in '%s' image node\n",
+                      algo_name, node_name, image_name);
+               return -1;
+       }
+
+       return 0;
+}
+
+/**
+ * fit_image_process_sig- Process a single subnode of the images/ node
+ *
+ * Check each subnode and process accordingly. For signature nodes we
+ * generate a signed hash of the supplised data and store it in the node.
+ *
+ * @keydir:    Directory containing keys to use for signing
+ * @keydest:   Destination FDT blob to write public keys into
+ * @fit:       pointer to the FIT format image header
+ * @image_name:        name of image being processes (used to display errors)
+ * @noffset:   subnode offset
+ * @data:      data to process
+ * @size:      size of data in bytes
+ * @comment:   Comment to add to signature nodes
+ * @require_keys: Mark all keys as 'required'
+ * @return 0 if ok, -1 on error
+ */
+static int fit_image_process_sig(const char *keydir, void *keydest,
+               void *fit, const char *image_name,
+               int noffset, const void *data, size_t size,
+               const char *comment, int require_keys)
+{
+       struct image_sign_info info;
+       struct image_region region;
+       const char *node_name;
+       uint8_t *value;
+       uint value_len;
+       int ret;
+
+       if (fit_image_setup_sig(&info, keydir, fit, image_name, noffset,
+                               require_keys ? "image" : NULL))
+               return -1;
+
+       node_name = fit_get_name(fit, noffset, NULL);
+       region.data = data;
+       region.size = size;
+       ret = info.algo->sign(&info, &region, 1, &value, &value_len);
+       if (ret) {
+               printf("Failed to sign '%s' signature node in '%s' image node: %d\n",
+                      node_name, image_name, ret);
+
+               /* We allow keys to be missing */
+               if (ret == -ENOENT)
+                       return 0;
+               return -1;
+       }
+
+       ret = fit_image_write_sig(fit, noffset, value, value_len, comment,
+                       NULL, 0);
+       if (ret) {
+               if (ret == -FDT_ERR_NOSPACE)
+                       return -ENOSPC;
+               printf("Can't write signature for '%s' signature node in '%s' conf node: %s\n",
+                      node_name, image_name, fdt_strerror(ret));
+               return -1;
+       }
+       free(value);
+
+       /* Get keyname again, as FDT has changed and invalidated our pointer */
+       info.keyname = fdt_getprop(fit, noffset, "key-name-hint", NULL);
+
+       /* Write the public key into the supplied FDT file */
+       if (keydest && info.algo->add_verify_data(&info, keydest)) {
+               printf("Failed to add verification data for '%s' signature node in '%s' image node\n",
+                      node_name, image_name);
+               return -1;
+       }
+
+       return 0;
+}
+
+/**
+ * fit_image_add_verification_data() - calculate/set verig. data for image node
+ *
+ * This adds hash and signature values for an component image node.
  *
  * All existing hash subnodes are checked, if algorithm property is set to
  * one of the supported hash algorithms, hash value is computed and
@@ -133,11 +272,17 @@ static int fit_image_process_hash(void *fit, const char *image_name,
  *
  * For signature details, please see doc/uImage.FIT/signature.txt
  *
+ * @keydir     Directory containing *.key and *.crt files (or NULL)
+ * @keydest    FDT Blob to write public keys into (NULL if none)
  * @fit:       Pointer to the FIT format image header
  * @image_noffset: Requested component image node
+ * @comment:   Comment to add to signature nodes
+ * @require_keys: Mark all keys as 'required'
  * @return: 0 on success, <0 on failure
  */
-int fit_image_add_verification_data(void *fit, int image_noffset)
+int fit_image_add_verification_data(const char *keydir, void *keydest,
+               void *fit, int image_noffset, const char *comment,
+               int require_keys)
 {
        const char *image_name;
        const void *data;
@@ -169,6 +314,12 @@ int fit_image_add_verification_data(void *fit, int image_noffset)
                             strlen(FIT_HASH_NODENAME))) {
                        ret = fit_image_process_hash(fit, image_name, noffset,
                                                data, size);
+               } else if (IMAGE_ENABLE_SIGN && keydir &&
+                          !strncmp(node_name, FIT_SIG_NODENAME,
+                               strlen(FIT_SIG_NODENAME))) {
+                       ret = fit_image_process_sig(keydir, keydest,
+                               fit, image_name, noffset, data, size,
+                               comment, require_keys);
                }
                if (ret)
                        return -1;
@@ -177,9 +328,334 @@ int fit_image_add_verification_data(void *fit, int image_noffset)
        return 0;
 }
 
-int fit_add_verification_data(void *fit)
+struct strlist {
+       int count;
+       char **strings;
+};
+
+static void strlist_init(struct strlist *list)
+{
+       memset(list, '\0', sizeof(*list));
+}
+
+static void strlist_free(struct strlist *list)
 {
-       int images_noffset;
+       int i;
+
+       for (i = 0; i < list->count; i++)
+               free(list->strings[i]);
+       free(list->strings);
+}
+
+static int strlist_add(struct strlist *list, const char *str)
+{
+       char *dup;
+
+       dup = strdup(str);
+       list->strings = realloc(list->strings,
+                               (list->count + 1) * sizeof(char *));
+       if (!list || !str)
+               return -1;
+       list->strings[list->count++] = dup;
+
+       return 0;
+}
+
+static const char *fit_config_get_image_list(void *fit, int noffset,
+               int *lenp, int *allow_missingp)
+{
+       static const char default_list[] = FIT_KERNEL_PROP "\0"
+                       FIT_FDT_PROP;
+       const char *prop;
+
+       /* If there is an "image" property, use that */
+       prop = fdt_getprop(fit, noffset, "sign-images", lenp);
+       if (prop) {
+               *allow_missingp = 0;
+               return *lenp ? prop : NULL;
+       }
+
+       /* Default image list */
+       *allow_missingp = 1;
+       *lenp = sizeof(default_list);
+
+       return default_list;
+}
+
+static int fit_config_get_hash_list(void *fit, int conf_noffset,
+                                   int sig_offset, struct strlist *node_inc)
+{
+       int allow_missing;
+       const char *prop, *iname, *end;
+       const char *conf_name, *sig_name;
+       char name[200], path[200];
+       int image_count;
+       int ret, len;
+
+       conf_name = fit_get_name(fit, conf_noffset, NULL);
+       sig_name = fit_get_name(fit, sig_offset, NULL);
+
+       /*
+        * Build a list of nodes we need to hash. We always need the root
+        * node and the configuration.
+        */
+       strlist_init(node_inc);
+       snprintf(name, sizeof(name), "%s/%s", FIT_CONFS_PATH, conf_name);
+       if (strlist_add(node_inc, "/") ||
+           strlist_add(node_inc, name))
+               goto err_mem;
+
+       /* Get a list of images that we intend to sign */
+       prop = fit_config_get_image_list(fit, sig_offset, &len,
+                                       &allow_missing);
+       if (!prop)
+               return 0;
+
+       /* Locate the images */
+       end = prop + len;
+       image_count = 0;
+       for (iname = prop; iname < end; iname += strlen(iname) + 1) {
+               int noffset;
+               int image_noffset;
+               int hash_count;
+
+               image_noffset = fit_conf_get_prop_node(fit, conf_noffset,
+                                                      iname);
+               if (image_noffset < 0) {
+                       printf("Failed to find image '%s' in  configuration '%s/%s'\n",
+                              iname, conf_name, sig_name);
+                       if (allow_missing)
+                               continue;
+
+                       return -ENOENT;
+               }
+
+               ret = fdt_get_path(fit, image_noffset, path, sizeof(path));
+               if (ret < 0)
+                       goto err_path;
+               if (strlist_add(node_inc, path))
+                       goto err_mem;
+
+               snprintf(name, sizeof(name), "%s/%s", FIT_CONFS_PATH,
+                        conf_name);
+
+               /* Add all this image's hashes */
+               hash_count = 0;
+               for (noffset = fdt_first_subnode(fit, image_noffset);
+                    noffset >= 0;
+                    noffset = fdt_next_subnode(fit, noffset)) {
+                       const char *name = fit_get_name(fit, noffset, NULL);
+
+                       if (strncmp(name, FIT_HASH_NODENAME,
+                                   strlen(FIT_HASH_NODENAME)))
+                               continue;
+                       ret = fdt_get_path(fit, noffset, path, sizeof(path));
+                       if (ret < 0)
+                               goto err_path;
+                       if (strlist_add(node_inc, path))
+                               goto err_mem;
+                       hash_count++;
+               }
+
+               if (!hash_count) {
+                       printf("Failed to find any hash nodes in configuration '%s/%s' image '%s' - without these it is not possible to verify this image\n",
+                              conf_name, sig_name, iname);
+                       return -ENOMSG;
+               }
+
+               image_count++;
+       }
+
+       if (!image_count) {
+               printf("Failed to find any images for configuration '%s/%s'\n",
+                      conf_name, sig_name);
+               return -ENOMSG;
+       }
+
+       return 0;
+
+err_mem:
+       printf("Out of memory processing configuration '%s/%s'\n", conf_name,
+              sig_name);
+       return -ENOMEM;
+
+err_path:
+       printf("Failed to get path for image '%s' in configuration '%s/%s': %s\n",
+              iname, conf_name, sig_name, fdt_strerror(ret));
+       return -ENOENT;
+}
+
+static int fit_config_get_data(void *fit, int conf_noffset, int noffset,
+               struct image_region **regionp, int *region_countp,
+               char **region_propp, int *region_proplen)
+{
+       char * const exc_prop[] = {"data"};
+       struct strlist node_inc;
+       struct image_region *region;
+       struct fdt_region fdt_regions[100];
+       const char *conf_name, *sig_name;
+       char path[200];
+       int count, i;
+       char *region_prop;
+       int ret, len;
+
+       conf_name = fit_get_name(fit, conf_noffset, NULL);
+       sig_name = fit_get_name(fit, conf_noffset, NULL);
+       debug("%s: conf='%s', sig='%s'\n", __func__, conf_name, sig_name);
+
+       /* Get a list of nodes we want to hash */
+       ret = fit_config_get_hash_list(fit, conf_noffset, noffset, &node_inc);
+       if (ret)
+               return ret;
+
+       /* Get a list of regions to hash */
+       count = fdt_find_regions(fit, node_inc.strings, node_inc.count,
+                       exc_prop, ARRAY_SIZE(exc_prop),
+                       fdt_regions, ARRAY_SIZE(fdt_regions),
+                       path, sizeof(path), 1);
+       if (count < 0) {
+               printf("Failed to hash configuration '%s/%s': %s\n", conf_name,
+                      sig_name, fdt_strerror(ret));
+               return -EIO;
+       }
+       if (count == 0) {
+               printf("No data to hash for configuration '%s/%s': %s\n",
+                      conf_name, sig_name, fdt_strerror(ret));
+               return -EINVAL;
+       }
+
+       /* Build our list of data blocks */
+       region = fit_region_make_list(fit, fdt_regions, count, NULL);
+       if (!region) {
+               printf("Out of memory hashing configuration '%s/%s'\n",
+                      conf_name, sig_name);
+               return -ENOMEM;
+       }
+
+       /* Create a list of all hashed properties */
+       debug("Hash nodes:\n");
+       for (i = len = 0; i < node_inc.count; i++) {
+               debug("   %s\n", node_inc.strings[i]);
+               len += strlen(node_inc.strings[i]) + 1;
+       }
+       region_prop = malloc(len);
+       if (!region_prop) {
+               printf("Out of memory setting up regions for configuration '%s/%s'\n",
+                      conf_name, sig_name);
+               return -ENOMEM;
+       }
+       for (i = len = 0; i < node_inc.count;
+            len += strlen(node_inc.strings[i]) + 1, i++)
+               strcpy(region_prop + len, node_inc.strings[i]);
+       strlist_free(&node_inc);
+
+       *region_countp = count;
+       *regionp = region;
+       *region_propp = region_prop;
+       *region_proplen = len;
+
+       return 0;
+}
+
+static int fit_config_process_sig(const char *keydir, void *keydest,
+               void *fit, const char *conf_name, int conf_noffset,
+               int noffset, const char *comment, int require_keys)
+{
+       struct image_sign_info info;
+       const char *node_name;
+       struct image_region *region;
+       char *region_prop;
+       int region_proplen;
+       int region_count;
+       uint8_t *value;
+       uint value_len;
+       int ret;
+
+       node_name = fit_get_name(fit, noffset, NULL);
+       if (fit_config_get_data(fit, conf_noffset, noffset, &region,
+                               &region_count, &region_prop, &region_proplen))
+               return -1;
+
+       if (fit_image_setup_sig(&info, keydir, fit, conf_name, noffset,
+                               require_keys ? "conf" : NULL))
+               return -1;
+
+       ret = info.algo->sign(&info, region, region_count, &value, &value_len);
+       free(region);
+       if (ret) {
+               printf("Failed to sign '%s' signature node in '%s' conf node\n",
+                      node_name, conf_name);
+
+               /* We allow keys to be missing */
+               if (ret == -ENOENT)
+                       return 0;
+               return -1;
+       }
+
+       ret = fit_image_write_sig(fit, noffset, value, value_len, comment,
+                               region_prop, region_proplen);
+       if (ret) {
+               if (ret == -FDT_ERR_NOSPACE)
+                       return -ENOSPC;
+               printf("Can't write signature for '%s' signature node in '%s' conf node: %s\n",
+                      node_name, conf_name, fdt_strerror(ret));
+               return -1;
+       }
+       free(value);
+       free(region_prop);
+
+       /* Get keyname again, as FDT has changed and invalidated our pointer */
+       info.keyname = fdt_getprop(fit, noffset, "key-name-hint", NULL);
+
+       /* Write the public key into the supplied FDT file */
+       if (keydest) {
+               ret = info.algo->add_verify_data(&info, keydest);
+               if (ret == -ENOSPC)
+                       return -ENOSPC;
+               if (ret) {
+                       printf("Failed to add verification data for '%s' signature node in '%s' image node\n",
+                              node_name, conf_name);
+               }
+               return ret;
+       }
+
+       return 0;
+}
+
+static int fit_config_add_verification_data(const char *keydir, void *keydest,
+               void *fit, int conf_noffset, const char *comment,
+               int require_keys)
+{
+       const char *conf_name;
+       int noffset;
+
+       conf_name = fit_get_name(fit, conf_noffset, NULL);
+
+       /* Process all hash subnodes of the configuration node */
+       for (noffset = fdt_first_subnode(fit, conf_noffset);
+            noffset >= 0;
+            noffset = fdt_next_subnode(fit, noffset)) {
+               const char *node_name;
+               int ret = 0;
+
+               node_name = fit_get_name(fit, noffset, NULL);
+               if (!strncmp(node_name, FIT_SIG_NODENAME,
+                            strlen(FIT_SIG_NODENAME))) {
+                       ret = fit_config_process_sig(keydir, keydest,
+                               fit, conf_name, conf_noffset, noffset, comment,
+                               require_keys);
+               }
+               if (ret)
+                       return ret;
+       }
+
+       return 0;
+}
+
+int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
+                             const char *comment, int require_keys)
+{
+       int images_noffset, confs_noffset;
        int noffset;
        int ret;
 
@@ -199,10 +675,54 @@ int fit_add_verification_data(void *fit)
                 * Direct child node of the images parent node,
                 * i.e. component image node.
                 */
-               ret = fit_image_add_verification_data(fit, noffset);
+               ret = fit_image_add_verification_data(keydir, keydest,
+                               fit, noffset, comment, require_keys);
+               if (ret)
+                       return ret;
+       }
+
+       /* If there are no keys, we can't sign configurations */
+       if (!IMAGE_ENABLE_SIGN || !keydir)
+               return 0;
+
+       /* Find configurations parent node offset */
+       confs_noffset = fdt_path_offset(fit, FIT_CONFS_PATH);
+       if (confs_noffset < 0) {
+               printf("Can't find images parent node '%s' (%s)\n",
+                      FIT_CONFS_PATH, fdt_strerror(confs_noffset));
+               return -ENOENT;
+       }
+
+       /* Process its subnodes, print out component images details */
+       for (noffset = fdt_first_subnode(fit, confs_noffset);
+            noffset >= 0;
+            noffset = fdt_next_subnode(fit, noffset)) {
+               ret = fit_config_add_verification_data(keydir, keydest,
+                                                      fit, noffset, comment,
+                                                      require_keys);
                if (ret)
                        return ret;
        }
 
        return 0;
 }
+
+#ifdef CONFIG_FIT_SIGNATURE
+int fit_check_sign(const void *fit, const void *key)
+{
+       int cfg_noffset;
+       int ret;
+
+       cfg_noffset = fit_conf_get_node(fit, NULL);
+       if (!cfg_noffset)
+               return -1;
+
+       printf("Verifying Hash Integrity ... ");
+       ret = fit_config_verify(fit, cfg_noffset);
+       if (ret)
+               return ret;
+       ret = bootm_host_load_images(fit, cfg_noffset);
+
+       return ret;
+}
+#endif