]> git.dujemihanovic.xyz Git - u-boot.git/commitdiff
mkimage: Add a 'keyfile' argument for image signing
authorAlexandru Gagniuc <mr.nuke.me@gmail.com>
Fri, 19 Feb 2021 18:45:17 +0000 (12:45 -0600)
committerTom Rini <trini@konsulko.com>
Wed, 14 Apr 2021 19:23:01 +0000 (15:23 -0400)
It's not always desirable to use 'keydir' and some ad-hoc heuristics
to get the filename of the signing key. More often, just passing the
filename is the simpler, easier, and logical thing to do.

Since mkimage doesn't use long options, we're slowly running out of
letters. I've chosen '-G' because it was available.

Signed-off-by: Alexandru Gagniuc <mr.nuke.me@gmail.com>
Reviewed-by: Simon Glass <sjg@chromium.org>
include/image.h
tools/fit_image.c
tools/image-host.c
tools/imagetool.h
tools/mkimage.c

index f172b1224df8cf773dac7d25d967b3e58f98e981..3ff3c035a78a3e4b0ef64f81afc68e152881b2e9 100644 (file)
@@ -1136,9 +1136,10 @@ int fit_cipher_data(const char *keydir, void *keydest, void *fit,
  *     0, on success
  *     libfdt error code, on failure
  */
-int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
-                             const char *comment, int require_keys,
-                             const char *engine_id, const char *cmdname);
+int fit_add_verification_data(const char *keydir, const char *keyfile,
+                             void *keydest, void *fit, const char *comment,
+                             int require_keys, const char *engine_id,
+                             const char *cmdname);
 
 int fit_image_verify_with_data(const void *fit, int image_noffset,
                               const void *data, size_t size);
@@ -1256,10 +1257,17 @@ void image_set_host_blob(void *host_blob);
 #endif
 #endif /* IMAGE_ENABLE_FIT */
 
-/* Information passed to the signing routines */
+/*
+ * Information passed to the signing routines
+ *
+ * Either 'keydir',  'keyname', or 'keyfile' can be NULL. However, either
+ * 'keyfile', or both 'keydir' and 'keyname' should have valid values. If
+ * neither are valid, some operations might fail with EINVAL.
+ */
 struct image_sign_info {
        const char *keydir;             /* Directory conaining keys */
        const char *keyname;            /* Name of key to use */
+       const char *keyfile;            /* Filename of private or public key */
        void *fit;                      /* Pointer to FIT blob */
        int node_offset;                /* Offset of signature node */
        const char *name;               /* Algorithm name */
index d440d143c6781b5ae2744f9a01b3470e0aac193a..ae30f807834927819e50a364cf615549825cc2ba 100644 (file)
@@ -68,7 +68,8 @@ static int fit_add_file_data(struct image_tool_params *params, size_t size_inc,
        }
 
        if (!ret) {
-               ret = fit_add_verification_data(params->keydir, dest_blob, ptr,
+               ret = fit_add_verification_data(params->keydir,
+                                               params->keyfile, dest_blob, ptr,
                                                params->comment,
                                                params->require_keys,
                                                params->engine_id,
index 33a224129a0d1a8f38d045ad90698ae221c3754e..270d36fe45165e7e99847a45a48db2df75f7d5cb 100644 (file)
@@ -153,8 +153,9 @@ static int fit_image_write_sig(void *fit, int noffset, uint8_t *value,
 }
 
 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 *engine_id)
+               const char *keydir, const char *keyfile, void *fit,
+               const char *image_name, int noffset, const char *require_keys,
+               const char *engine_id)
 {
        const char *node_name;
        char *algo_name;
@@ -171,6 +172,7 @@ static int fit_image_setup_sig(struct image_sign_info *info,
 
        memset(info, '\0', sizeof(*info));
        info->keydir = keydir;
+       info->keyfile = keyfile;
        info->keyname = fdt_getprop(fit, noffset, FIT_KEY_HINT, NULL);
        info->fit = fit;
        info->node_offset = noffset;
@@ -207,8 +209,8 @@ static int fit_image_setup_sig(struct image_sign_info *info,
  * @engine_id: Engine to use for signing
  * @return 0 if ok, -1 on error
  */
-static int fit_image_process_sig(const char *keydir, void *keydest,
-               void *fit, const char *image_name,
+static int fit_image_process_sig(const char *keydir, const char *keyfile,
+               void *keydest, void *fit, const char *image_name,
                int noffset, const void *data, size_t size,
                const char *comment, int require_keys, const char *engine_id,
                const char *cmdname)
@@ -220,8 +222,9 @@ static int fit_image_process_sig(const char *keydir, void *keydest,
        uint value_len;
        int ret;
 
-       if (fit_image_setup_sig(&info, keydir, fit, image_name, noffset,
-                               require_keys ? "image" : NULL, engine_id))
+       if (fit_image_setup_sig(&info, keydir, keyfile, fit, image_name,
+                               noffset, require_keys ? "image" : NULL,
+                               engine_id))
                return -1;
 
        node_name = fit_get_name(fit, noffset, NULL);
@@ -598,9 +601,10 @@ int fit_image_cipher_data(const char *keydir, void *keydest,
  * @engine_id: Engine to use for signing
  * @return: 0 on success, <0 on failure
  */
-int fit_image_add_verification_data(const char *keydir, void *keydest,
-               void *fit, int image_noffset, const char *comment,
-               int require_keys, const char *engine_id, const char *cmdname)
+int fit_image_add_verification_data(const char *keydir, const char *keyfile,
+               void *keydest, void *fit, int image_noffset,
+               const char *comment, int require_keys, const char *engine_id,
+               const char *cmdname)
 {
        const char *image_name;
        const void *data;
@@ -632,10 +636,10 @@ int fit_image_add_verification_data(const char *keydir, void *keydest,
                             strlen(FIT_HASH_NODENAME))) {
                        ret = fit_image_process_hash(fit, image_name, noffset,
                                                data, size);
-               } else if (IMAGE_ENABLE_SIGN && keydir &&
+               } else if (IMAGE_ENABLE_SIGN && (keydir || keyfile) &&
                           !strncmp(node_name, FIT_SIG_NODENAME,
                                strlen(FIT_SIG_NODENAME))) {
-                       ret = fit_image_process_sig(keydir, keydest,
+                       ret = fit_image_process_sig(keydir, keyfile, keydest,
                                fit, image_name, noffset, data, size,
                                comment, require_keys, engine_id, cmdname);
                }
@@ -918,10 +922,10 @@ static int fit_config_get_data(void *fit, int conf_noffset, int noffset,
        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,
-               const char *engine_id, const char *cmdname)
+static int fit_config_process_sig(const char *keydir, const char *keyfile,
+               void *keydest,  void *fit, const char *conf_name,
+               int conf_noffset, int noffset, const char *comment,
+               int require_keys, const char *engine_id, const char *cmdname)
 {
        struct image_sign_info info;
        const char *node_name;
@@ -938,7 +942,7 @@ static int fit_config_process_sig(const char *keydir, void *keydest,
                                &region_count, &region_prop, &region_proplen))
                return -1;
 
-       if (fit_image_setup_sig(&info, keydir, fit, conf_name, noffset,
+       if (fit_image_setup_sig(&info, keydir, keyfile, fit, conf_name, noffset,
                                require_keys ? "conf" : NULL, engine_id))
                return -1;
 
@@ -983,9 +987,10 @@ static int fit_config_process_sig(const char *keydir, void *keydest,
        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 *engine_id, const char *cmdname)
+static int fit_config_add_verification_data(const char *keydir,
+               const char *keyfile, void *keydest, void *fit, int conf_noffset,
+               const char *comment, int require_keys, const char *engine_id,
+               const char *cmdname)
 {
        const char *conf_name;
        int noffset;
@@ -1002,7 +1007,7 @@ static int fit_config_add_verification_data(const char *keydir, void *keydest,
                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,
+                       ret = fit_config_process_sig(keydir, keyfile, keydest,
                                fit, conf_name, conf_noffset, noffset, comment,
                                require_keys, engine_id, cmdname);
                }
@@ -1048,9 +1053,10 @@ int fit_cipher_data(const char *keydir, void *keydest, void *fit,
        return 0;
 }
 
-int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
-                             const char *comment, int require_keys,
-                             const char *engine_id, const char *cmdname)
+int fit_add_verification_data(const char *keydir, const char *keyfile,
+                             void *keydest, void *fit, const char *comment,
+                             int require_keys, const char *engine_id,
+                             const char *cmdname)
 {
        int images_noffset, confs_noffset;
        int noffset;
@@ -1072,7 +1078,7 @@ int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
                 * Direct child node of the images parent node,
                 * i.e. component image node.
                 */
-               ret = fit_image_add_verification_data(keydir, keydest,
+               ret = fit_image_add_verification_data(keydir, keyfile, keydest,
                                fit, noffset, comment, require_keys, engine_id,
                                cmdname);
                if (ret)
@@ -1080,7 +1086,7 @@ int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
        }
 
        /* If there are no keys, we can't sign configurations */
-       if (!IMAGE_ENABLE_SIGN || !keydir)
+       if (!IMAGE_ENABLE_SIGN || !(keydir || keyfile))
                return 0;
 
        /* Find configurations parent node offset */
@@ -1095,7 +1101,7 @@ int fit_add_verification_data(const char *keydir, void *keydest, void *fit,
        for (noffset = fdt_first_subnode(fit, confs_noffset);
             noffset >= 0;
             noffset = fdt_next_subnode(fit, noffset)) {
-               ret = fit_config_add_verification_data(keydir, keydest,
+               ret = fit_config_add_verification_data(keydir, keyfile, keydest,
                                                       fit, noffset, comment,
                                                       require_keys,
                                                       engine_id, cmdname);
index 2801ea9e9f9607198edc15029208f6aadc8d14bc..e229a34ffc5793121fbf362596a7178dde5d108a 100644 (file)
@@ -67,6 +67,7 @@ struct image_tool_params {
        const char *outfile;    /* Output filename */
        const char *keydir;     /* Directory holding private keys */
        const char *keydest;    /* Destination .dtb for public key */
+       const char *keyfile;    /* Filename of private or public key */
        const char *comment;    /* Comment to add to signature node */
        int require_keys;       /* 1 to mark signing keys as 'required' */
        int file_size;          /* Total size of output file */
index 68d5206cb4fd80b3e0e5735b9208b54d9aae7874..cc7b242faf223c929b02a77a8d7df09717b6e4b7 100644 (file)
@@ -108,6 +108,7 @@ static void usage(const char *msg)
                "Signing / verified boot options: [-k keydir] [-K dtb] [ -c <comment>] [-p addr] [-r] [-N engine]\n"
                "          -k => set directory containing private keys\n"
                "          -K => write public keys to this .dtb file\n"
+               "          -G => use this signing key (in lieu of -k)\n"
                "          -c => add comment in signature node\n"
                "          -F => re-sign existing FIT image\n"
                "          -p => place external data at a static position\n"
@@ -151,7 +152,7 @@ static void process_args(int argc, char **argv)
        int opt;
 
        while ((opt = getopt(argc, argv,
-                  "a:A:b:B:c:C:d:D:e:Ef:Fk:i:K:ln:N:p:O:rR:qstT:vVx")) != -1) {
+                  "a:A:b:B:c:C:d:D:e:Ef:FG:k:i:K:ln:N:p:O:rR:qstT:vVx")) != -1) {
                switch (opt) {
                case 'a':
                        params.addr = strtoull(optarg, &ptr, 16);
@@ -226,6 +227,9 @@ static void process_args(int argc, char **argv)
                        params.type = IH_TYPE_FLATDT;
                        params.fflag = 1;
                        break;
+               case 'G':
+                       params.keyfile = optarg;
+                       break;
                case 'i':
                        params.fit_ramdisk = optarg;
                        break;