Skip to contentSkip to conversation

tools: add fdt_add_pubkey

PATCH In review Roman Kopytin 3 participants 5 messages Aug 3, 2021 – Aug 6, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 tools: add fdt_add_pubkey

Having to use the -K option to mkimage to populate U-Boot's .dtb with the public key while signing the kernel FIT image is often a little awkward. In particular, when using a meta-build system such as bitbake/Yocto, having the tasks of the kernel and U-Boot recipes intertwined, modifying deployed artifacts and rebuilding U-Boot with an updated .dtb is quite cumbersome. Also, in some scenarios one may wish to build U-Boot complete with the public key(s) embedded in the .dtb without the corresponding private keys being present on the same build host.

So this adds a simple tool that allows one to disentangle the kernel and U-Boot builds, by simply copy-pasting just enough of the mkimage code to allow one to add a public key to a .dtb. When using mkimage, some of the information is taken from the .its used to build the kernel (algorithm and key name), so that of course needs to be supplied on the command line.

Cc Rasmus Villemoes <[email protected]>

From f4dd0edaec5fdac5d355eb5bef3f917b35d6c091 Mon Sep 17 00:00:00 2001
From: Roman Kopytin <[email protected]>
Date: Tue, 3 Aug 2021 12:48:15 +0300
Subject: [PATCH] tools: add fdt_add_pubkey

Having to use the -K option to mkimage to populate U-Boot's .dtb with the public key while signing the kernel FIT image is often a little awkward. In particular, when using a meta-build system such as bitbake/Yocto, having the tasks of the kernel and U-Boot recipes intertwined, modifying deployed artifacts and rebuilding U-Boot with an updated .dtb is quite cumbersome. Also, in some scenarios one may wish to build U-Boot complete with the public key(s) embedded in the .dtb without the corresponding private keys being present on the same build host.

So this adds a simple tool that allows one to disentangle the kernel and U-Boot builds, by simply copy-pasting just enough of the mkimage code to allow one to add a public key to a .dtb. When using mkimage, some of the information is taken from the .its used to build the kernel (algorithm and key name), so that of course needs to be supplied on the command line.

Cc Rasmus Villemoes <[email protected]>
---
 tools/.gitignore       |  1 +
 tools/Makefile         |  3 ++
 tools/fdt_add_pubkey.c | 97 ++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 101 insertions(+)
 create mode 100755 tools/fdt_add_pubkey.c
tools/.gitignore +1 -0
index a88453f64d..f312b760e4 100644
@@ -6,6 +6,7 @@
 /dumpimage
 /easylogo/easylogo
 /envcrc
+/fdt_add_pubkey
 /fdtgrep
 /file2include
 /fit_check_sign
tools/Makefile +3 -0
index 4a86321f64..44f25dda18 100644
@@ -73,6 +73,7 @@ mkenvimage-objs := mkenvimage.o os_support.o lib/crc32.o
 
 hostprogs-y += dumpimage mkimage
 hostprogs-$(CONFIG_TOOLS_LIBCRYPTO) += fit_info fit_check_sign
+hostprogs-$(CONFIG_TOOLS_LIBCRYPTO) += fdt_add_pubkey
 
 hostprogs-$(CONFIG_CMD_BOOTEFI_SELFTEST) += file2include
 
@@ -153,6 +154,7 @@ dumpimage-objs := $(dumpimage-mkimage-objs) dumpimage.o
 mkimage-objs   := $(dumpimage-mkimage-objs) mkimage.o
 fit_info-objs   := $(dumpimage-mkimage-objs) fit_info.o
 fit_check_sign-objs   := $(dumpimage-mkimage-objs) fit_check_sign.o
+fdt_add_pubkey-objs   := $(dumpimage-mkimage-objs) fdt_add_pubkey.o
 file2include-objs := file2include.o
 
 ifneq ($(CONFIG_MX23)$(CONFIG_MX28)$(CONFIG_TOOLS_LIBCRYPTO),)
@@ -190,6 +192,7 @@ HOSTCFLAGS_fit_image.o += -DMKIMAGE_DTC=\"$(CONFIG_MKIMAGE_DTC_PATH)\"
 HOSTLDLIBS_dumpimage := $(HOSTLDLIBS_mkimage)
 HOSTLDLIBS_fit_info := $(HOSTLDLIBS_mkimage)
 HOSTLDLIBS_fit_check_sign := $(HOSTLDLIBS_mkimage)
+HOSTLDLIBS_fdt_add_pubkey := $(HOSTLDLIBS_mkimage)
 
 hostprogs-$(CONFIG_EXYNOS5250) += mkexynosspl
 hostprogs-$(CONFIG_EXYNOS5420) += mkexynosspl
tools/fdt_add_pubkey.c new file +97 -0

97 lines not on this page · raw message

Signature · 1 line
2.25.1
#1 lore raw

On 03/08/2021 13.00, Roman Kopytin wrote:

Hi Roman

Thanks for picking this up. A few notes on the process:

- Don't attach the patch, it must be inline in the email. But do not copy-paste it in to your mail client, that will most likely make it whitespace-damaged. git send-email is your friend.

- Sending it to [email protected] is correct, but you should also cc "interested parties", e.g. at least me (for obvious reasons) and anybody who participated in the earlier thread. If you had used git send-email, your "Cc: " line in the patch would actually automatically have included me on cc. Other people are just as easy to add (with the --cc option to "git send-email"). Very few people, if any, read every message on the U-Boot mailing list.

- It would be good if you could also add a test and ensure that it works. I think my original submission had three commits, of which the first is now moot, but that last patch was a test case. It may need some adjustments to apply nowadays, but it should give you a starting point.

Rasmus

#2 lore raw

Thanks a lot.
Can I create 1 patch with tool + test?

-----Original Message-----
From: Rasmus Villemoes <[email protected]>
Sent: Thursday, August 5, 2021 10:56 AM
To: Roman Kopytin <[email protected]>; U-Boot-Denx <[email protected]>
Subject: Re: [PATCH] tools: add fdt_add_pubkey

Caution: This is an external email. Be cautious while opening links or attachments.

On 03/08/2021 13.00, Roman Kopytin wrote:

Hi Roman

Thanks for picking this up. A few notes on the process:

- Don't attach the patch, it must be inline in the email. But do not copy-paste it in to your mail client, that will most likely make it whitespace-damaged. git send-email is your friend.

- Sending it to [email protected] is correct, but you should also cc "interested parties", e.g. at least me (for obvious reasons) and anybody who participated in the earlier thread. If you had used git send-email, your "Cc: " line in the patch would actually automatically have included me on cc. Other people are just as easy to add (with the --cc option to "git send-email"). Very few people, if any, read every message on the U-Boot mailing list.

- It would be good if you could also add a test and ensure that it works. I think my original submission had three commits, of which the first is now moot, but that last patch was a test case. It may need some adjustments to apply nowadays, but it should give you a starting point.

Rasmus

#3 lore raw
Quoted 2 lines · Roman Kopytin

Thanks a lot.
Can I create 1 patch with tool + test?

Preferably not. Each patch should be its own logical entity, doing one thing. Yes, sometimes the lines are a bit blurred, but adding a new tool and adding one or more tests of that tool are clearly separate things. It also makes review easier.

Rasmus

#4 lore raw
In reply to Rasmus Villemoes

Roman,

Quoted 18 lines · Rasmus Villemoes

On 03/08/2021 13.00, Roman Kopytin wrote:

Hi Roman

Thanks for picking this up. A few notes on the process:

- Don't attach the patch, it must be inline in the email. But do not copy-paste it in to your mail client, that will most likely make it whitespace-damaged. git send-email is your friend.

- Sending it to [email protected] is correct, but you should also cc "interested parties", e.g. at least me (for obvious reasons) and anybody who participated in the earlier thread. If you had used git send-email, your "Cc: " line in the patch would actually automatically have included me on cc. Other people are just as easy to add (with the --cc option to "git send-email"). Very few people, if any, read every message on the U-Boot mailing list.

Quoted 6 lines

- It would be good if you could also add a test and ensure that it works. I think my original submission had three commits, of which the first is now moot, but that last patch was a test case. It may need some adjustments to apply nowadays, but it should give you a starting point.

Rasmus

I don't remember where exactly I found the information initially but patman is your friend when submitting patches. c.f. [0] resp. [1] for more information.

Cheers,
Steffen

[0] ./tools/patman/patman -H
[1] tools/patman/README