Skip to contentSkip to conversation

rockchip: make it possible to sign the u-boot.itb

PATCH Superseded Heiko Stuebner 4 participants 17 messages Apr 17, 2020 – Apr 20, 2020

Subsystems (4)

v1 of 4 Superseded Latest is v4 →

lore
Share & tools
lore

Heiko Stuebner

author maintainer
#0 lore raw

cover rockchip: make it possible to sign the u-boot.itb

From: Heiko Stuebner <[email protected]>

This series fixes some issues I found with SPL_FIT_SIGNATURE enabled and then makes it possible to sign a generated u-boot.itb automatically even if the its-source got created by a generator script.

To let the SPL know about the key, the -K option for mkimage points to the dts/dt-spl.dtb which can then get included into the spl binary.

Tested on Rockchip PX30 with a TPL -> SPL -> U-Boot.itb bootchain.

Heiko Stuebner (7):
spl: fit: select SPL_HASH_SUPPORT for SPL_FIT_SIGNATURE
spl: fit: select SPL_CRYPTO_SUPPORT for SPL_FIT_SIGNATURE
lib: rsa: distinguish between tpl and spl for CONFIG_RSA_VERIFY
mkimage: fit_image: handle multiple errors when writing signatures
spl: fit: enable signing a generated u-boot.itb
spl: fit: add Kconfig option to specify key-hint for fit_generator
rockchip: make_fit_atf: add signature handling

 Kconfig                                | 18 +++++++++
 Makefile                               | 11 +++++-
 arch/arm/mach-rockchip/make_fit_atf.py | 51 +++++++++++++++++++++++++-
 lib/rsa/Makefile                       |  2 +-
 tools/image-host.c                     |  2 +-
 5 files changed, 80 insertions(+), 4 deletions(-)
Signature · 1 line
2.24.1
author maintainer
#1 lore raw

PATCH 1/7 spl: fit: select SPL_HASH_SUPPORT for SPL_FIT_SIGNATURE

From: Heiko Stuebner <[email protected]>

rsa-checsum needs support for hash functions or else will run into compile errors like:
u-boot/lib/rsa/rsa-checksum.c:28: undefined reference to `hash_progressive_lookup_algo'

So similar to the main FIT_SIGNATURE entry selects HASH, select SPL_HASH_SUPPORT for SPL_FIT_SIGNATURE.

Cc Heinrich Schuchardt <[email protected]>
---
 Kconfig | 1 +
 1 file changed, 1 insertion(+)
Kconfig +1 -0
index 1b0b6999d8..2b84402baa 100644
@@ -445,6 +445,7 @@ config SPL_FIT_SIGNATURE
 	bool "Enable signature verification of FIT firmware within SPL"
 	depends on SPL_DM
 	select SPL_FIT
+	select SPL_HASH_SUPPORT
 	select SPL_RSA
 	select SPL_RSA_VERIFY
 	select IMAGE_SIGN_INFO
Signature · 1 line
2.24.1
#2 lore raw

PATCH 1/7 spl: fit: select SPL_HASH_SUPPORT for SPL_FIT_SIGNATURE

Quoted 10 lines · Heiko Stuebner

From: Heiko Stuebner <[email protected]>

rsa-checsum needs support for hash functions or else will run into compile errors like:
u-boot/lib/rsa/rsa-checksum.c:28: undefined reference to `hash_progressive_lookup_algo'

Quoted 5 lines

So similar to the main FIT_SIGNATURE entry selects HASH, select SPL_HASH_SUPPORT for SPL_FIT_SIGNATURE.

Cc Heinrich Schuchardt <[email protected]>
author maintainer
#3 lore raw

PATCH 2/7 spl: fit: select SPL_CRYPTO_SUPPORT for SPL_FIT_SIGNATURE

In reply to Heiko Stuebner

From: Heiko Stuebner <[email protected]>

Verifying FIT images obviously needs the rsa parts of crypto support and while main uboot always compiles crypto support, it's optional for SPL and we should thus select the necessary option to not end up in compile errors like:

u-boot/lib/rsa/rsa-verify.c:328: undefined reference to `rsa_mod_exp'

So select SPL_CRYPTO_SUPPORT in SPL_FIT_SIGNATURE.

---
 Kconfig | 1 +
 1 file changed, 1 insertion(+)
Kconfig +1 -0
index 2b84402baa..4051746319 100644
@@ -445,6 +445,7 @@ config SPL_FIT_SIGNATURE
 	bool "Enable signature verification of FIT firmware within SPL"
 	depends on SPL_DM
 	select SPL_FIT
+	select SPL_CRYPTO_SUPPORT
 	select SPL_HASH_SUPPORT
 	select SPL_RSA
 	select SPL_RSA_VERIFY
Signature · 1 line
2.24.1
#4 lore raw

PATCH 2/7 spl: fit: select SPL_CRYPTO_SUPPORT for SPL_FIT_SIGNATURE

Quoted 11 lines · Heiko Stuebner

From: Heiko Stuebner <[email protected]>

Verifying FIT images obviously needs the rsa parts of crypto support and while main uboot always compiles crypto support, it's optional for SPL and we should thus select the necessary option to not end up in compile errors like:

Quoted 5 lines

u-boot/lib/rsa/rsa-verify.c:328: undefined reference to `rsa_mod_exp'

So select SPL_CRYPTO_SUPPORT in SPL_FIT_SIGNATURE.

author maintainer
#5 lore raw

PATCH 3/7 lib: rsa: distinguish between tpl and spl for CONFIG_RSA_VERIFY

In reply to Heiko Stuebner

From: Heiko Stuebner <[email protected]>

While the SPL may want to do signature checking this won't be the case for TPL in all cases, as TPL is mostly used when the amound of initial memory is not enough for a full SPL.

So on a system where SPL uses DM but TPL does not we currently end up with a TPL compile error of:

lib/rsa/rsa-verify.c:48:25: error: dereferencing pointer to incomplete type ?struct checksum_algo?

To prevent that change the $(SPL_) to $(SPL_TPL_) to distinguis between both. If someone really needs FIT signature checking in TPL as well, a new TPL_RSA_VERIFY config symbol needs to be added.

---
 lib/rsa/Makefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
lib/rsa/Makefile +1 -1
index 14ed3cb401..c61ebfd79e 100644
@@ -5,6 +5,6 @@
 # (C) Copyright 2000-2007
 # Wolfgang Denk, DENX Software Engineering, wd at denx.de.
 
-obj-$(CONFIG_$(SPL_)RSA_VERIFY) += rsa-verify.o rsa-checksum.o
+obj-$(CONFIG_$(SPL_TPL_)RSA_VERIFY) += rsa-verify.o rsa-checksum.o
 obj-$(CONFIG_RSA_VERIFY_WITH_PKEY) += rsa-keyprop.o
 obj-$(CONFIG_RSA_SOFTWARE_EXP) += rsa-mod-exp.o
Signature · 1 line
2.24.1
#6 lore raw

PATCH 3/7 lib: rsa: distinguish between tpl and spl for CONFIG_RSA_VERIFY

Quoted 9 lines · Heiko Stuebner

From: Heiko Stuebner <[email protected]>

While the SPL may want to do signature checking this won't be the case for TPL in all cases, as TPL is mostly used when the amound of initial memory is not enough for a full SPL.

Quoted 6 lines

So on a system where SPL uses DM but TPL does not we currently end up with a TPL compile error of:

lib/rsa/rsa-verify.c:48:25: error: dereferencing pointer to incomplete type ?struct checksum_algo?

To prevent that change the $(SPL_) to $(SPL_TPL_) to distinguis

nit: distinguis -> distinguish

Quoted 4 lines

between both. If someone really needs FIT signature checking in TPL as well, a new TPL_RSA_VERIFY config symbol needs to be added.

author maintainer
#7 lore raw

PATCH 4/7 mkimage: fit_image: handle multiple errors when writing signatures

In reply to Heiko Stuebner

From: Heiko Stuebner <[email protected]>

fit_image_write_sig() contains mostly functions from libfdt that return FDT_ERR_foo errors but also a call to fit_set_timestamp() which returns a regular error.

When handling the size increase via multiple iterations, check for both -FDT_ERR_NOSPACE but also for -ENOSPC.

There is no real conflict, as FDT_ERR_NOSPACE = 3 = ESRCH (No such process) and ENOSPC = 28 which is above any FDT_ERR_*.

---
 tools/image-host.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
tools/image-host.c +1 -1
index 4e57ddea96..355ceb4591 100644
@@ -240,7 +240,7 @@ static int fit_image_process_sig(const char *keydir, void *keydest,
 	ret = fit_image_write_sig(fit, noffset, value, value_len, comment,
 			NULL, 0, cmdname);
 	if (ret) {
-		if (ret == -FDT_ERR_NOSPACE)
+		if (ret == -FDT_ERR_NOSPACE || ret == -ENOSPC)
 			return -ENOSPC;
 		printf("Can't write signature for '%s' signature node in '%s' conf node: %s\n",
 		       node_name, image_name, fdt_strerror(ret));
Signature · 1 line
2.24.1
#8 lore raw

PATCH 4/7 mkimage: fit_image: handle multiple errors when writing signatures

Quoted 10 lines · Heiko Stuebner

From: Heiko Stuebner <[email protected]>

fit_image_write_sig() contains mostly functions from libfdt that return FDT_ERR_foo errors but also a call to fit_set_timestamp() which returns a regular error.

When handling the size increase via multiple iterations, check for both -FDT_ERR_NOSPACE but also for -ENOSPC.

Quoted 8 lines

There is no real conflict, as FDT_ERR_NOSPACE = 3 = ESRCH (No such process) and ENOSPC = 28 which is above any FDT_ERR_*.

---
 tools/image-host.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
author maintainer
#9 lore raw

PATCH 5/7 spl: fit: enable signing a generated u-boot.itb

In reply to Heiko Stuebner

From: Heiko Stuebner <[email protected]>

With SPL_FIT_SIGNATURE enabled we will likely want a generated u-boot.itb to be signed and the key stores so that the spl can reach it.

So add a SPL_FIT_SIGNATURE_KEY_DIR option and suitable hooks into the Makefile to have mkimage sign the .itb and store the used key into the spl dtb file.

The added dependencies should make sure that the u-boot.itb gets generated before the spl-binary gets build, so that there is the necessary space for the key to get included.

---
 Kconfig  |  8 ++++++++
 Makefile | 11 ++++++++++-
 2 files changed, 18 insertions(+), 1 deletion(-)
Kconfig +8 -0
index 4051746319..15a783a67d 100644
@@ -451,6 +451,14 @@ config SPL_FIT_SIGNATURE
 	select SPL_RSA_VERIFY
 	select IMAGE_SIGN_INFO
 
+config SPL_FIT_SIGNATURE_KEY_DIR
+	string "key directory for signing U-Boot FIT image"
+	depends on SPL_FIT_SIGNATURE
+	default "keys"
+	help
+	  The directory to give to mkimage to retrieve keys from when
+	  generating a signed U-Boot FIT image.
+
 config SPL_LOAD_FIT
 	bool "Enable SPL loading U-Boot as a FIT (basic fitImage features)"
 	select SPL_FIT
Makefile +10 -1
index 26307fd4a6..8e7a7cb50e 100644
@@ -1394,6 +1394,14 @@ MKIMAGEFLAGS_u-boot.itb =
 else
 MKIMAGEFLAGS_u-boot.itb = -E
 endif
+ifdef CONFIG_SPL_FIT_SIGNATURE
+ifdef CONFIG_SPL_OF_CONTROL
+MKIMAGEFLAGS_u-boot.itb += -K dts/dt-spl.dtb -r
+ifneq ($(CONFIG_SPL_FIT_SIGNATURE_KEY_DIR),"")
+MKIMAGEFLAGS_u-boot.itb += -k $(CONFIG_SPL_FIT_SIGNATURE_KEY_DIR)
+endif
+endif
+endif
 
 u-boot.itb: u-boot-nodtb.bin \
 		$(if $(CONFIG_OF_SEPARATE)$(CONFIG_OF_EMBED)$(CONFIG_OF_HOSTFILE),dts/dt.dtb) \
@@ -1913,7 +1921,8 @@ spl/u-boot-spl.bin: spl/u-boot-spl
 
 spl/u-boot-spl: tools prepare \
 		$(if $(CONFIG_OF_SEPARATE)$(CONFIG_OF_EMBED)$(CONFIG_SPL_OF_PLATDATA),dts/dt.dtb) \
-		$(if $(CONFIG_OF_SEPARATE)$(CONFIG_OF_EMBED)$(CONFIG_TPL_OF_PLATDATA),dts/dt.dtb)
+		$(if $(CONFIG_OF_SEPARATE)$(CONFIG_OF_EMBED)$(CONFIG_TPL_OF_PLATDATA),dts/dt.dtb) \
+		$(if $(CONFIG_SPL_FIT_GENERATOR),u-boot.itb FORCE)
 	$(Q)$(MAKE) obj=spl -f $(srctree)/scripts/Makefile.spl all
 
 spl/sunxi-spl.bin: spl/u-boot-spl
Signature · 1 line
2.24.1
#10 lore raw

PATCH 5/7 spl: fit: enable signing a generated u-boot.itb

Quoted 14 lines · Heiko Stuebner

From: Heiko Stuebner <[email protected]>

With SPL_FIT_SIGNATURE enabled we will likely want a generated u-boot.itb to be signed and the key stores so that the spl can reach it.

So add a SPL_FIT_SIGNATURE_KEY_DIR option and suitable hooks into the Makefile to have mkimage sign the .itb and store the used key into the spl dtb file.

Quoted 5 lines

The added dependencies should make sure that the u-boot.itb gets generated before the spl-binary gets build, so that there is the necessary space for the key to get included.

author maintainer
#11 lore raw

PATCH 6/7 spl: fit: add Kconfig option to specify key-hint for fit_generator

In reply to Heiko Stuebner

From: Heiko Stuebner <[email protected]>

The u-boot.itb can be generated either from a static .its that can simply include the needed signature nodes with key-hints or from a fit-generator script referenced in CONFIG_SPL_FIT_GENERATOR.

In the script-case it will need to know what key to include for the key-hint and specified algorithm, so add an option for that key-name.

---
 Kconfig | 8 ++++++++
 1 file changed, 8 insertions(+)
Kconfig +8 -0
index 15a783a67d..703762d740 100644
@@ -534,6 +534,14 @@ config SPL_FIT_GENERATOR
 	  passed a list of supported device tree file stub names to
 	  include in the generated image.
 
+config SPL_FIT_GENERATOR_KEY_HINT
+	string "key hint for signing U-Boot FIT image"
+	depends on SPL_FIT_SIGNATURE
+	default "dev"
+	help
+	  The key hint to store in both the generated .its file as well as
+	  u-boot-key.dtb generated separately and embedded into the SPL.
+
 endif # SPL
 
 endif # FIT
Signature · 1 line
2.24.1
#12 lore raw

PATCH 6/7 spl: fit: add Kconfig option to specify key-hint for fit_generator

Quoted 14 lines · Heiko Stuebner

From: Heiko Stuebner <[email protected]>

The u-boot.itb can be generated either from a static .its that can simply include the needed signature nodes with key-hints or from a fit-generator script referenced in CONFIG_SPL_FIT_GENERATOR.

In the script-case it will need to know what key to include for the key-hint and specified algorithm, so add an option for that key-name.

#13 lore raw

PATCH 6/7 spl: fit: add Kconfig option to specify key-hint for fit_generator

In reply to Heiko Stuebner
Quoted 8 lines · Heiko Stuebner

From: Heiko Stuebner <[email protected]>

The u-boot.itb can be generated either from a static .its that can simply include the needed signature nodes with key-hints or from a fit-generator script referenced in CONFIG_SPL_FIT_GENERATOR.

In the script-case it will need to know what key to include for the key-hint and specified algorithm, so add an option for that key-name.

I am missing a file in doc/ describing how this is used.

Best regards

Heinrich

Quoted 26 lines
---
 Kconfig | 8 ++++++++
 1 file changed, 8 insertions(+)
Kconfig +8 -0
index 15a783a67d..703762d740 100644
@@ -534,6 +534,14 @@ config SPL_FIT_GENERATOR
 	  passed a list of supported device tree file stub names to
 	  include in the generated image.
 
+config SPL_FIT_GENERATOR_KEY_HINT
+	string "key hint for signing U-Boot FIT image"
+	depends on SPL_FIT_SIGNATURE
+	default "dev"
+	help
+	  The key hint to store in both the generated .its file as well as
+	  u-boot-key.dtb generated separately and embedded into the SPL.
+
 endif # SPL
 
 endif # FIT
author maintainer
#14 lore raw

PATCH 7/7 rockchip: make_fit_atf: add signature handling

In reply to Heiko Stuebner

From: Heiko Stuebner <[email protected]>

If the newly added fit-generator key-options are found, append needed signature nodes to all generated image blocks, so that they can get signed when mkimage later compiles the .itb from the generated .its.

---
 arch/arm/mach-rockchip/make_fit_atf.py | 51 +++++++++++++++++++++++++-
 1 file changed, 50 insertions(+), 1 deletion(-)
arch/arm/mach-rockchip/make_fit_atf.py +50 -1
index d15c32b303..5b353f9d0a 100755
@@ -14,6 +14,8 @@ import sys
 import getopt
 import logging
 import struct
+import Crypto
+from Crypto.PublicKey import RSA
 
 DT_HEADER = """
 /*
@@ -37,7 +39,9 @@ DT_UBOOT = """
 			arch = "arm64";
 			compression = "none";
 			load = <0x%08x>;
-		};
+"""
+
+DT_UBOOT_NODE_END = """		};
 
 """
 
@@ -47,6 +51,46 @@ DT_IMAGES_NODE_END = """	};
 
 DT_END = "};"
 
+def append_signature(file):
+    if not os.path.exists("u-boot.cfg"):
+        return
+
+    config = {}
+    with open("u-boot.cfg") as fd:
+        for line in fd:
+            line = line.strip()
+            values = line[8:].split(' ', 1)
+            if len(values) > 1:
+                key, value = values
+                value = value.strip('"')
+            else:
+                key = values[0]
+                value = '1'
+            if not key.startswith('CONFIG_'):
+                continue
+            config[key] = value
+
+    try:
+        keyhint = config["CONFIG_SPL_FIT_GENERATOR_KEY_HINT"]
+    except KeyError:
+        return
+
+    try:
+        keyfile = os.path.join(config["CONFIG_SPL_FIT_SIGNATURE_KEY_DIR"], keyhint)
+    except KeyError:
+        keyfile = keyhint
+
+    if not os.path.exists('%s.key' % keyfile):
+        return
+
+    f = open('%s.key' % keyfile,'r')
+    key = RSA.importKey(f.read())
+
+    file.write('\t\t\tsignature {\n')
+    file.write('\t\t\t\talgo = "sha256,rsa%s";\n' % key.n.bit_length())
+    file.write('\t\t\t\tkey-name-hint = "%s";\n' % keyhint)
+    file.write('\t\t\t};\n')
+
 def append_bl31_node(file, atf_index, phy_addr, elf_entry):
     # Append BL31 DT node to input FIT dts file.
     data = 'bl31_0x%08x.bin' % phy_addr
@@ -60,6 +104,7 @@ def append_bl31_node(file, atf_index, phy_addr, elf_entry):
     file.write('\t\t\tload = <0x%08x>;\n' % phy_addr)
     if atf_index == 1:
         file.write('\t\t\tentry = <0x%08x>;\n' % elf_entry)
+    append_signature(file);
     file.write('\t\t};\n')
     file.write('\n')
 
@@ -75,6 +120,7 @@ def append_tee_node(file, atf_index, phy_addr, elf_entry):
     file.write('\t\t\tcompression = "none";\n')
     file.write('\t\t\tload = <0x%08x>;\n' % phy_addr)
     file.write('\t\t\tentry = <0x%08x>;\n' % elf_entry)
+    append_signature(file);
     file.write('\t\t};\n')
     file.write('\n')
 
@@ -88,6 +134,7 @@ def append_fdt_node(file, dtbs):
         file.write('\t\t\tdata = /incbin/("%s");\n' % dtb)
         file.write('\t\t\ttype = "flat_dt";\n')
         file.write('\t\t\tcompression = "none";\n')
+        append_signature(file);
         file.write('\t\t};\n')
         file.write('\n')
         cnt = cnt + 1
@@ -129,6 +176,8 @@ def generate_atf_fit_dts_uboot(fit_file, uboot_file_name):
         raise ValueError("Invalid u-boot ELF image '%s'" % uboot_file_name)
     index, entry, p_paddr, data = segments[0]
     fit_file.write(DT_UBOOT % p_paddr)
+    append_signature(fit_file)
+    fit_file.write(DT_UBOOT_NODE_END)
 
 def generate_atf_fit_dts_bl31(fit_file, bl31_file_name, tee_file_name, dtbs_file_name):
     segments = unpack_elf(bl31_file_name)
Signature · 1 line
2.24.1
#15 lore raw

PATCH 7/7 rockchip: make_fit_atf: add signature handling

Hi Heiko,

Quoted 11 lines · Heiko Stuebner

From: Heiko Stuebner <[email protected]>

If the newly added fit-generator key-options are found, append needed signature nodes to all generated image blocks, so that they can get signed when mkimage later compiles the .itb from the generated .its.

---
 arch/arm/mach-rockchip/make_fit_atf.py | 51 +++++++++++++++++++++++++-
 1 file changed, 50 insertions(+), 1 deletion(-)

Was there an effort to move this to binman?

Regards,
Simon

author maintainer
#16 lore raw

PATCH 7/7 rockchip: make_fit_atf: add signature handling

Hi Simon,

Am Montag, 20. April 2020, 01:38:20 CEST schrieb Simon Glass:

Quoted 8 lines · Heiko Stuebner
Quoted 7 lines

From: Heiko Stuebner <[email protected]>

If the newly added fit-generator key-options are found, append needed signature nodes to all generated image blocks, so that they can get signed when mkimage later compiles the .itb from the generated .its.

Quoted 6 lines
Quoted 4 lines
---
 arch/arm/mach-rockchip/make_fit_atf.py | 51 +++++++++++++++++++++++++-
 1 file changed, 50 insertions(+), 1 deletion(-)

Was there an effort to move this to binman?

The generation really is part of the core build process.
When creating the u-boot.itb with signed entries, mkimage -K writes the data of the used key to dt-spl.dtb which then gets put into the spl binary. [spl needs the key-data in its dtb to verify the signatures]

So I don't really see how this would work without moving the whole spl generation to binman.

Heiko