uboot-sign: Make SPL DTB public key injection optional
cover uboot-sign: Make SPL DTB public key injection optional
v1
- uboot-sign: Make SPL DTB public key injection optional
Jamin Lin (2):
uboot-sign: Avoid symlink and install errors when SPL DTB is missing
uboot-sign: Make SPL DTB public key injection optional
meta/classes-recipe/uboot-sign.bbclass | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-)
Signature · 1 line
2.43.0
PATCH 1/2 uboot-sign: Avoid symlink and install errors when SPL DTB is missing
Fix potential errors during do_deploy and deploy_spl_dtb when SPL_DTB_BINARY or SPL_BINARY is not present.
Wrapped install command in deploy_spl_dtb() with a file existence check. Improved condition in do_deploy to check for actual existence of ${SPL_DIR}/${SPL_DTB_BINARY} instead of only relying on variable non-emptiness. Prevents "install: missing destination file operand" and invalid symlink creation.
--- meta/classes-recipe/uboot-sign.bbclass | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
meta/classes-recipe/uboot-sign.bbclass +4 -2
@@ -275,7 +275,9 @@ deploy_spl_dtb() { fi # For backwards compatibility... - install -Dm644 ${SPL_BINARY} ${DEPLOYDIR}/${SPL_IMAGE} + if [ -e "${SPL_BINARY}" ]; then + install -Dm644 ${SPL_BINARY} ${DEPLOYDIR}/${SPL_IMAGE} + fi } do_uboot_generate_rsa_keys() {
@@ -600,7 +602,7 @@ do_deploy:prepend() { ln -sf ${UBOOT_FITIMAGE_IMAGE} ${DEPLOYDIR}/${UBOOT_FITIMAGE_SYMLINK} fi - if [ "${SPL_SIGN_ENABLE}" = "1" -a -n "${SPL_DTB_BINARY}" ] ; then + if [ "${SPL_SIGN_ENABLE}" = "1" -a -e "${SPL_DIR}/${SPL_DTB_BINARY}" ] ; then ln -sf ${SPL_DTB_IMAGE} ${DEPLOYDIR}/${SPL_DTB_SYMLINK} ln -sf ${SPL_DTB_IMAGE} ${DEPLOYDIR}/${SPL_DTB_BINARY} ln -sf ${SPL_NODTB_IMAGE} ${DEPLOYDIR}/${SPL_NODTB_SYMLINK}
Signature · 1 line
2.43.0
Re: [OE-core] [PATCH v1 1/2] uboot-sign: Avoid symlink and install errors when SPL DTB is missing
Quoted 4 lines · Jamin Lin via lists.openembedded.org
Fix potential errors during
do_deployanddeploy_spl_dtbwhenSPL_DTB_BINARYorSPL_BINARYis not present.
Quoted 8 lines
Wrapped install command in
deploy_spl_dtb()with a file existence check.
Improved condition indo_deployto check for actual existence of ${SPL_DIR}/${SPL_DTB_BINARY} instead of only relying on variable non- emptiness.
Prevents "install: missing destination file operand" and invalid symlink
creation.
The commit message describes the code changes, but lacks the crucial context of why these changes are necessary. Could you please add some background information explaining the motivation or problem this change is solving? What's the use case where the code should proceed without finding the ${SPL_BINARY} file?
This would help future maintainers better understand the rationale behind this modification.
Quoted 15 lines
Signed-off-by Jamin Lin <[email protected]>---
meta/classes-recipe/uboot-sign.bbclass | 6 ++++--1 file changed, 4 insertions(+), 2 deletions(-)meta/classes- renamed from meta/classes-recipe/uboot-sign.bbclass +0
-0recipe/uboot-sign.bbclass
index73e9ce3f11..6ee1874cd6100644meta/classes-recipe/uboot-sign.bbclass +0
-0@@ -275,7 +275,9 @@ deploy_spl_dtb() {fi
# For backwards compatibility...
meta/classes-recipe/uboot-sign.bbclass deploy_spl_dtb() { · line 278
Quoted 2 lines
meta/classes-recipe/uboot-sign.bbclass +1
-1- install -Dm644 ${SPL_BINARY} ${DEPLOYDIR}/${SPL_IMAGE} + if [ -e "${SPL_BINARY}" ]; then
If possible, these kinds of checks should rely solely on BitBake variables. Checking for files in the filesystem is very fragile. There are many scenarios where a file might not be in its expected location due to a bug. When this happens, debugging becomes much harder if the code silently continues running instead of failing with a clear error message about the missing file. While file-based checks might allow code to continue running with wrong assumptions, variable-based checks will fail immediately with clear error conditions, making debugging more straightforward and issues more apparent.
I know there are similar examples in the existing code.
Quoted 14 lines
meta/classes-recipe/uboot-sign.bbclass +1
-0+ install -Dm644 ${SPL_BINARY}${DEPLOYDIR}/${SPL_IMAGE}
meta/classes-recipe/uboot-sign.bbclass +1
-0+ fi}
do_uboot_generate_rsa_keys() {meta/classes-recipe/uboot-sign.bbclass +0
-0@@ -600,7 +602,7 @@ do_deploy:prepend() { ln -sf ${UBOOT_FITIMAGE_IMAGE} ${DEPLOYDIR}/${UBOOT_FITIMAGE_SYMLINK}fi
meta/classes-recipe/uboot-sign.bbclass +0
-1- if [ "${SPL_SIGN_ENABLE}" = "1" -a -n "${SPL_DTB_BINARY}" ]; then
meta/classes-recipe/uboot-sign.bbclass +1
-0+ if [ "${SPL_SIGN_ENABLE}" = "1" -a -e
Quoted 1 line
"${SPL_DIR}/${SPL_DTB_BINARY}" ] ; then
Same as above.
Adrian
Quoted 18 lines
ln -sf ${SPL_DTB_IMAGE}
${DEPLOYDIR}/${SPL_DTB_SYMLINK}
ln -sf ${SPL_DTB_IMAGE}
${DEPLOYDIR}/${SPL_DTB_BINARY}
ln -sf ${SPL_NODTB_IMAGE}
${DEPLOYDIR}/${SPL_NODTB_SYMLINK}-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group. View/Reply Online (#218113):
https://lists.openembedded.org/g/openembedded-core/message/218113
Mute This Topic: https://lists.openembedded.org/mt/113499584/3616858
Group Owner: [email protected] Unsubscribe:
https://lists.openembedded.org/g/openembedded-core/unsub [
[email protected]]
-=-=-=-=-=-=-=-=-=-=-=-
RE: [OE-core] [PATCH v1 1/2] uboot-sign: Avoid symlink and install errors when SPL DTB is missing
Hi Adrian,
Quoted 16 lines
Subject: Re: [OE-core] [PATCH v1 1/2] uboot-sign: Avoid symlink and install errors when SPL DTB is missing
Quoted 10 lines · Jamin Lin via lists.openembedded.org
Fix potential errors during
do_deployanddeploy_spl_dtbwhenSPL_DTB_BINARYorSPL_BINARYis not present.Wrapped install command in
deploy_spl_dtb()with a file existence check.
Improved condition indo_deployto check for actual existence of ${SPL_DIR}/${SPL_DTB_BINARY} instead of only relying on variable non- emptiness.
Prevents "install: missing destination file operand" and invalid symlink creation.
Quoted 8 lines
The commit message describes the code changes, but lacks the crucial context of why these changes are necessary. Could you please add some background information explaining the motivation or problem this change is solving? What's the use case where the code should proceed without finding the ${SPL_BINARY} file?
This would help future maintainers better understand the rationale behind this modification.
Thanks for suggestion. How about the following commit messages?
Commit Message:
Fix potential errors during do_deploy and deploy_spl_dtb when SPL_DTB_BINARY or SPL_BINARY is not present.
Wrapped the install command in deploy_spl_dtb() with a file existence check.
Improved the condition in do_deploy to check for actual existence of ${SPL_DIR}/${SPL_DTB_BINARY} instead of only relying on variable non-emptiness. This prevents issues such as "install: missing destination file operand" and creation of invalid symbolic links.
Motivation and Use Case
In certain scenarios, users may want to sign only the U-Boot FIT image, without using SPL. In such cases, SPL_SIGN_ENABLE should be set to 1 to enable generation of a FIT ITS file with signature nodes. However, when only U-Boot is built (no SPL), the following problems can occur:
1. SPL_BINARY is never set.
The following line fails because ${SPL_BINARY} is empty
```
install -Dm644 ${SPL_BINARY} ${DEPLOYDIR}/${SPL_IMAGE}
```This results in a build error.
2. This condition: will evaluate to true, because the default value of SPL_DTB_BINARY is u-boot-spl.dtb. But in a U-Boot-only build, this file does not exist, which leads to creation invalid symlinks.
```
if [ "${SPL_SIGN_ENABLE}" = "1" -a -n "${SPL_DTB_BINARY}" ]
```Fix Summary
The updated logic now:
Skips the install step unless ${SPL_BINARY} exists.
Avoids creating symlinks unless ${SPL_DTB_BINARY} actually exists on disk.
This ensures that U-Boot-only builds with signature support do not fail due to missing SPL artifacts.
Thanks-Jamin
Quoted 63 lines
Quoted 14 lines
Signed-off-by Jamin Lin <[email protected]>---
meta/classes-recipe/uboot-sign.bbclass | 6 ++++--1 file changed, 4 insertions(+), 2 deletions(-)meta/classes- renamed from meta/classes-recipe/uboot-sign.bbclass +0
-0recipe/uboot-sign.bbclass index
73e9ce3f11..6ee1874cd6100644meta/classes-recipe/uboot-sign.bbclass +0
-0@@ -275,7 +275,9 @@ deploy_spl_dtb() {fi
# For backwards compatibility...
meta/classes-recipe/uboot-sign.bbclass deploy_spl_dtb() { · line 278
Quoted 2 lines
meta/classes-recipe/uboot-sign.bbclass +1
-1- install -Dm644 ${SPL_BINARY} ${DEPLOYDIR}/${SPL_IMAGE} + if [ -e "${SPL_BINARY}" ]; thenIf possible, these kinds of checks should rely solely on BitBake variables. Checking for files in the filesystem is very fragile. There are many scenarios where a file might not be in its expected location due to a bug. When this happens, debugging becomes much harder if the code silently continues running instead of failing with a clear error message about the missing file. While file-based checks might allow code to continue running with wrong assumptions, variable-based checks will fail immediately with clear error conditions, making debugging more straightforward and issues more apparent. I know there are similar examples in the existing code.
Quoted 14 lines
meta/classes-recipe/uboot-sign.bbclass +1
-0+ install -Dm644 ${SPL_BINARY}${DEPLOYDIR}/${SPL_IMAGE}
meta/classes-recipe/uboot-sign.bbclass +1
-0+ fi}
do_uboot_generate_rsa_keys() {
meta/classes-recipe/uboot-sign.bbclass +0
-0@@ -600,7 +602,7 @@ do_deploy:prepend() { ln -sf ${UBOOT_FITIMAGE_IMAGE} ${DEPLOYDIR}/${UBOOT_FITIMAGE_SYMLINK}fi
meta/classes-recipe/uboot-sign.bbclass +0
-1- if [ "${SPL_SIGN_ENABLE}" = "1" -a -n "${SPL_DTB_BINARY}" ]; then
meta/classes-recipe/uboot-sign.bbclass +1
-0+ if [ "${SPL_SIGN_ENABLE}" = "1" -a -eQuoted 1 line
"${SPL_DIR}/${SPL_DTB_BINARY}" ] ; then
Same as above.
Adrian
Quoted 18 lines
ln -sf ${SPL_DTB_IMAGE}
${DEPLOYDIR}/${SPL_DTB_SYMLINK}
ln -sf ${SPL_DTB_IMAGE}
${DEPLOYDIR}/${SPL_DTB_BINARY}
ln -sf ${SPL_NODTB_IMAGE}
${DEPLOYDIR}/${SPL_NODTB_SYMLINK}-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group. View/Reply Online (#218113):
https://lists.openembedded.org/g/openembedded-core/message/218113
Mute This Topic: https://lists.openembedded.org/mt/113499584/3616858
Group Owner: [email protected] Unsubscribe:
https://lists.openembedded.org/g/openembedded-core/unsub [
[email protected]]
-=-=-=-=-=-=-=-=-=-=-=-
PATCH 2/2 uboot-sign: Make SPL DTB public key injection optional
In reply to Jamin LinIntroduce SPL_SIGN_ADD_PUBKEY to control whether the public key is added into the SPL device tree and whether FIT signature verification is performed after signing.
Key changes:
- Added SPL_SIGN_ADD_PUBKEY variable (default = "1")
- Conditionally apply '-K <dtb>' to mkimage only if adding key is enabled
- Skip fit_check_sign when public key injection is disabled
- Suppress concat_spl_dtb() warnings if key adding is turned off
This allows U-Boot FIT images to be signed without modifying the SPL DTB, useful in scenarios where public key management is handled elsewhere or post-processing will be done separately.
--- meta/classes-recipe/uboot-sign.bbclass | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-)
meta/classes-recipe/uboot-sign.bbclass +15 -5
@@ -34,6 +34,12 @@ UBOOT_FITIMAGE_ENABLE ?= "0" # Signature activation - this requires UBOOT_FITIMAGE_ENABLE = "1" SPL_SIGN_ENABLE ?= "0" +# Whether to add (embed) the public key into the SPL Device Tree (.dtb). +# If set to "1", the key will be inserted into the /signature node of the DTB +# and fit_check_sign will be used to verify the signature. +# If set to "0", only signing will be performed, without modifying the DTB. +SPL_SIGN_ADD_PUBKEY ?= "1" + # Default value for deployment filenames. UBOOT_DTB_IMAGE ?= "u-boot-${MACHINE}-${PV}-${PR}.dtb" UBOOT_DTB_BINARY ?= "u-boot.dtb"
@@ -245,7 +251,9 @@ concat_spl_dtb() { if [ -e "${SPL_DIR}/${SPL_NODTB_BINARY}" -a -e "${SPL_DIR}/${SPL_DTB_BINARY}" ] ; then cat ${SPL_DIR}/${SPL_NODTB_BINARY} ${SPL_DIR}/${SPL_DTB_SIGNED} > "${SPL_BINARY}" else - bbwarn "Failure while adding public key to spl binary. Verified U-Boot boot won't be available." + if [ "${SPL_SIGN_ADD_PUBKEY}" = "1" ]; then + bbwarn "Failure while adding public key to spl binary. Verified U-Boot boot won't be available." + fi fi }
@@ -474,15 +482,17 @@ EOF ${UBOOT_MKIMAGE_SIGN} \ ${@'-D "${SPL_MKIMAGE_DTCOPTS}"' if len('${SPL_MKIMAGE_DTCOPTS}') else ''} \ -F -k "${SPL_SIGN_KEYDIR}" \ - -K "${SPL_DIR}/${SPL_DTB_BINARY}" \ + ${@'-K "${SPL_DIR}/${SPL_DTB_BINARY}"' if d.getVar("SPL_SIGN_ADD_PUBKEY") == "1" else ''} \ -r ${UBOOT_FITIMAGE_BINARY} \ ${SPL_MKIMAGE_SIGN_ARGS} # # Verify the U-boot FIT image and SPL dtb # - ${UBOOT_FIT_CHECK_SIGN} \ - -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ - -f ${UBOOT_FITIMAGE_BINARY} + if [ "${SPL_SIGN_ADD_PUBKEY}" = "1" ]; then + ${UBOOT_FIT_CHECK_SIGN} \ + -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ + -f ${UBOOT_FITIMAGE_BINARY} + fi fi if [ -e "${SPL_DIR}/${SPL_DTB_BINARY}" ]; then
Signature · 1 line
2.43.0
Quoted 12 lines · Jamin Lin via lists.openembedded.org
Introduce
SPL_SIGN_ADD_PUBKEYto control whether the public key is added into the SPL device tree and whether FIT signature verification is
performed after signing.Key changes:
- AddedSPL_SIGN_ADD_PUBKEYvariable (default = "1")
- Conditionally apply '-K <dtb>' to mkimage only if adding key is enabled
- Skipfit_check_signwhen public key injection is disabled
- Suppressconcat_spl_dtb()warnings if key adding is turned off
Quoted 5 lines
This allows U-Boot FIT images to be signed without modifying the SPL DTB,
useful in scenarios where public key management is handled elsewhere or
post-processing will be done separately.
Thank you for the patch.
Introducing a new variable is one way to solve your issue, but it increases complexity and requires additional test coverage and documentation. So I would like to ask if this is extra complexity is really needed to achieve your goal.
For a similar use case, we use this approach:
* bitbake always signs with a development key (no build variant needed, no extra test matrix)
* Then we test the firmware
* For release, we use a script to replace the development signature with a production signature (without rebuilding with bitbake)
This seems similar to your approach, but I don't understand why injecting the development public key is problematic for your workflow. Would it be better to have a post-processing step that simply replaces the public key, rather than requiring an empty DTB without any public key? That would mean that this patch would not be needed at all.
Adrian
Quoted 78 lines
Signed-off-by Jamin Lin <[email protected]>---
meta/classes-recipe/uboot-sign.bbclass | 20 +++++++++++++++-----1 file changed, 15 insertions(+), 5 deletions(-)meta/classes- renamed from meta/classes-recipe/uboot-sign.bbclass +0
-0recipe/uboot-sign.bbclass
index6ee1874cd6..3bcf47dd33100644meta/classes-recipe/uboot-sign.bbclass +0
-0@@ -34,6 +34,12 @@ UBOOT_FITIMAGE_ENABLE ?= "0" # Signature activation - this requires UBOOT_FITIMAGE_ENABLE = "1"SPL_SIGN_ENABLE ?= "0"
+# Whether to add (embed) the public key into the SPL Device Tree (.dtb).
+# If set to "1", the key will be inserted into the /signature node of the DTBmeta/classes-recipe/uboot-sign.bbclass +2
-0+# and fit_check_sign will be used to verify the signature. +# If set to "0", only signing will be performed, without modifyingthe DTB.
meta/classes-recipe/uboot-sign.bbclass +2
-0+SPL_SIGN_ADD_PUBKEY ?= "1" +# Default value for deployment filenames.
UBOOT_DTB_IMAGE?= "u-boot-${MACHINE}-${PV}-${PR}.dtb"UBOOT_DTB_BINARY?= "u-boot.dtb"meta/classes-recipe/uboot-sign.bbclass +0
-0@@ -245,7 +251,9 @@ concat_spl_dtb() {if [ -e "${SPL_DIR}/${SPL_NODTB_BINARY}" -a -e "${SPL_DIR}/${SPL_DTB_BINARY}" ] ; then
cat ${SPL_DIR}/${SPL_NODTB_BINARY} ${SPL_DIR}/${SPL_DTB_SIGNED} > "${SPL_BINARY}"
else
- bbwarn "Failure while adding public key to spl binary. Verified U- Boot boot won't be available."
+ if [ "${SPL_SIGN_ADD_PUBKEY}" = "1" ]; then
+ bbwarn "Failure while adding public key to spl binary. Verified U- Boot boot won't be available."
+ fi
fi
}meta/classes-recipe/uboot-sign.bbclass +6
-4@@ -474,15 +482,17 @@ EOF ${UBOOT_MKIMAGE_SIGN} \ ${@'-D "${SPL_MKIMAGE_DTCOPTS}"' if len('${SPL_MKIMAGE_DTCOPTS}') else ''} \ -F -k "${SPL_SIGN_KEYDIR}" \ - -K "${SPL_DIR}/${SPL_DTB_BINARY}" \ + ${@'-K "${SPL_DIR}/${SPL_DTB_BINARY}"' if d.getVar("SPL_SIGN_ADD_PUBKEY") == "1" else ''} \ -r ${UBOOT_FITIMAGE_BINARY} \ ${SPL_MKIMAGE_SIGN_ARGS} # # Verify the U-boot FIT image and SPL dtb # - ${UBOOT_FIT_CHECK_SIGN} \ - -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ - -f ${UBOOT_FITIMAGE_BINARY} + if [ "${SPL_SIGN_ADD_PUBKEY}" = "1" ]; then + ${UBOOT_FIT_CHECK_SIGN} \ + -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ + -f ${UBOOT_FITIMAGE_BINARY} + fifi
if [ -e "${SPL_DIR}/${SPL_DTB_BINARY}" ]; then-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group. View/Reply Online (#218114):
https://lists.openembedded.org/g/openembedded-core/message/218114
Mute This Topic: https://lists.openembedded.org/mt/113499585/3616858
Group Owner: [email protected] Unsubscribe:
https://lists.openembedded.org/g/openembedded-core/unsub [
[email protected]]
-=-=-=-=-=-=-=-=-=-=-=-
Hi Adrian,
Quoted 35 lines
Subject: Re: [OE-core] [PATCH v1 2/2] uboot-sign: Make SPL DTB public key injection optional
Quoted 11 lines · Jamin Lin via lists.openembedded.org
Introduce
SPL_SIGN_ADD_PUBKEYto control whether the public key is added into the SPL device tree and whether FIT signature verification is performed after signing.Key changes:
- AddedSPL_SIGN_ADD_PUBKEYvariable (default = "1")
- Conditionally apply '-K <dtb>' to mkimage only if adding key is enabled
- Skipfit_check_signwhen public key injection is disabled
- Suppressconcat_spl_dtb()warnings if key adding is turned offQuoted 3 lines
This allows U-Boot FIT images to be signed without modifying the SPL DTB, useful in scenarios where public key management is handled elsewhere or post-processing will be done separately.
Thank you for the patch.
Introducing a new variable is one way to solve your issue, but it increases complexity and requires additional test coverage and documentation. So I would like to ask if this is extra complexity is really needed to achieve your goal.
For a similar use case, we use this approach:
* bitbake always signs with a development key (no build variant needed, no extra test matrix)
* Then we test the firmware
* For release, we use a script to replace the development signature with a production signature (without rebuilding with bitbake)
Quoted 7 lines
This seems similar to your approach, but I don't understand why injecting the development public key is problematic for your workflow.
Would it be better to have a post-processing step that simply replaces the public key, rather than requiring an empty DTB without any public key? That would mean that this patch would not be needed at all.Adrian
Thanks for your reply.
Let me clarify the motivation behind this patch.
In our project, we only use "U-Boot and do not have an SPL". Our goal is to sign the U-Boot FIT image only, without modifying or involving any SPL DTB. However, the current design in uboot-sign.bbclass assumes that SPL is always present and forces the public key to be added into the SPL DTB, followed by a verification step involving that DTB.
Here’s what I ran into:
We set SPL_SIGN_ENABLE = "1" to enable signing, which correctly generates the ITS with a signature node for U-Boot. But enabling SPL_SIGN_ENABLE also triggers these additional steps in uboot-sign.bbclass:
a. The call to mkimage with -K ${SPL_DTB_BINARY} tries to inject the public key into the SPL DTB. b. Then fit_check_sign tries to verify the FIT image using the SPL DTB.
This fails for us because:
1. We don't have ${SPL_DTB_BINARY} at all.
2. The build breaks during the verification step due to this missing SPL DTB.
3. Even setting an invalid SPL_SIGN_KEYDIR to skip actual signing does not bypass the verification step.
Instead of introducing a new variable like SPL_SIGN_ADD_PUBKEY, we could consider modifying the logic to gracefully handle the absence of SPL DTBs. Here’s the idea:
1. Only concat SPL binary if both parts exist:
if [ -e "${SPL_DIR}/${SPL_NODTB_BINARY}" -a -e "${SPL_DIR}/${SPL_DTB_BINARY}" ]; then
cat ${SPL_DIR}/${SPL_NODTB_BINARY} ${SPL_DIR}/${SPL_DTB_SIGNED} > "${SPL_BINARY}"else
if [ -f ${SPL_DIR}/${SPL_DTB_BINARY} ]; then
bbwarn "Failure while adding public key to spl binary. Verified U-Boot boot won't be available."
fi
fi
2. Conditionally apply -K only if SPL DTB exists:
${UBOOT_MKIMAGE_SIGN} \
${@'-D "${SPL_MKIMAGE_DTCOPTS}"' if len('${SPL_MKIMAGE_DTCOPTS}') else ''} \
-F -k "${SPL_SIGN_KEYDIR}" \
${@'-K "${SPL_DIR}/${SPL_DTB_BINARY}"' if d.getVar("SPL_SIGN_ADD_PUBKEY") == "1" else ''} \
-r ${UBOOT_FITIMAGE_BINARY} \
${SPL_MKIMAGE_SIGN_ARGS}3. Only run fit_check_sign if SPL DTB exists:
if [ -f ${SPL_DIR}/${SPL_DTB_BINARY} ]; then
${UBOOT_FIT_CHECK_SIGN} \
-k "${SPL_DIR}/${SPL_DTB_BINARY}" \
-f ${UBOOT_FITIMAGE_BINARY}fi
Could you please give me any suggestion?
Thanks-Jamin
Quoted 76 lines
Quoted 44 lines
Signed-off-by Jamin Lin <[email protected]>---
meta/classes-recipe/uboot-sign.bbclass | 20 +++++++++++++++-----1 file changed, 15 insertions(+), 5 deletions(-)meta/classes- renamed from meta/classes-recipe/uboot-sign.bbclass +0
-0recipe/uboot-sign.bbclass index
6ee1874cd6..3bcf47dd33100644meta/classes-recipe/uboot-sign.bbclass +0
-0@@ -34,6 +34,12 @@ UBOOT_FITIMAGE_ENABLE ?= "0" # Signature activation - this requires UBOOT_FITIMAGE_ENABLE = "1"SPL_SIGN_ENABLE ?= "0"
+# Whether to add (embed) the public key into the SPL Device Tree (.dtb).
+# If set to "1", the key will be inserted into the /signature node of the DTBmeta/classes-recipe/uboot-sign.bbclass +2
-0+# and fit_check_sign will be used to verify the signature. +# If set to "0", only signing will be performed, without modifyingthe DTB.
meta/classes-recipe/uboot-sign.bbclass +2
-0+SPL_SIGN_ADD_PUBKEY ?= "1" +# Default value for deployment filenames.
UBOOT_DTB_IMAGE?= "u-boot-${MACHINE}-${PV}-${PR}.dtb"UBOOT_DTB_BINARY?= "u-boot.dtb"meta/classes-recipe/uboot-sign.bbclass +0
-0@@ -245,7 +251,9 @@ concat_spl_dtb() {if [ -e "${SPL_DIR}/${SPL_NODTB_BINARY}" -a -e "${SPL_DIR}/${SPL_DTB_BINARY}" ] ; then
cat ${SPL_DIR}/${SPL_NODTB_BINARY} ${SPL_DIR}/${SPL_DTB_SIGNED} > "${SPL_BINARY}"
else
- bbwarn "Failure while adding public key to spl binary. Verified U- Boot boot won't be available."
+ if [ "${SPL_SIGN_ADD_PUBKEY}" = "1" ]; then bbwarn "Failure while
+ adding public key to spl binary. Verified U-
Boot boot won't be available."
+ fi
fi
}meta/classes-recipe/uboot-sign.bbclass +0
-0@@ -474,15 +482,17 @@ EOF ${UBOOT_MKIMAGE_SIGN} \Quoted 1 line
${@'-D "${SPL_MKIMAGE_DTCOPTS}"' if
len('${SPL_MKIMAGE_DTCOPTS}')Quoted 30 lines
else ''} \
-F -k "${SPL_SIGN_KEYDIR}" \
- -K "${SPL_DIR}/${SPL_DTB_BINARY}" \
+ ${@'-K "${SPL_DIR}/${SPL_DTB_BINARY}"' ifd.getVar("SPL_SIGN_ADD_PUBKEY")== "1" else ''} \
-r ${UBOOT_FITIMAGE_BINARY} \
${SPL_MKIMAGE_SIGN_ARGS}
#
# Verify the U-boot FIT image and SPL dtb
#
- ${UBOOT_FIT_CHECK_SIGN} \
- -k "${SPL_DIR}/${SPL_DTB_BINARY}" \
- -f ${UBOOT_FITIMAGE_BINARY}
+ if [ "${SPL_SIGN_ADD_PUBKEY}" = "1" ]; then ${UBOOT_FIT_CHECK_SIGN}
+ \ -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ -f ${UBOOT_FITIMAGE_BINARY} fi fiif [ -e "${SPL_DIR}/${SPL_DTB_BINARY}" ]; then
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group. View/Reply Online (#218114):
https://lists.openembedded.org/g/openembedded-core/message/218114
Mute This Topic: https://lists.openembedded.org/mt/113499585/3616858
Group Owner: [email protected] Unsubscribe:
https://lists.openembedded.org/g/openembedded-core/unsub [
[email protected]]
-=-=-=-=-=-=-=-=-=-=-=-
Quoted 68 lines · Jamin Lin
Hi Adrian,
Quoted 53 lines
Subject: Re: [OE-core] [PATCH v1 2/2] uboot-sign: Make SPL DTB public key
injection optionalQuoted 13 lines · Jamin Lin via lists.openembedded.org
Introduce
SPL_SIGN_ADD_PUBKEYto control whether the public key is
added into the SPL device tree and whether FIT signature verification
is performed after signing.Key changes:
- AddedSPL_SIGN_ADD_PUBKEYvariable (default = "1")
- Conditionally apply '-K <dtb>' to mkimage only if adding key is enabled
- Skipfit_check_signwhen public key injection is disabled
- Suppressconcat_spl_dtb()warnings if key adding is turned offQuoted 4 lines
This allows U-Boot FIT images to be signed without modifying the SPL
DTB, useful in scenarios where public key management is handled elsewhere or post-processing will be done separately.Thank you for the patch.
Introducing a new variable is one way to solve your issue, but it increases
complexity and requires additional test coverage and documentation. So I
would like to ask if this is extra complexity is really needed to achieve your
goal.For a similar use case, we use this approach:
* bitbake always signs with a development key (no build variant needed, no extra test matrix)
* Then we test the firmware
* For release, we use a script to replace the development
signature
with a production signature (without rebuilding with bitbake)This seems similar to your approach, but I don't understand why injecting the
development public key is problematic for your workflow. Would it be better to have a post-processing step that simply replaces the
public key, rather than requiring an empty DTB without any public key? That
would mean that this patch would not be needed at all.Quoted 1 line
Adrian
Thanks for your reply.
Let me clarify the motivation behind this patch.In our project, we only use "U-Boot and do not have an SPL". Our goal is to sign the U-Boot FIT image only,
without modifying or involving any SPL DTB. However, the current design in uboot-sign.bbclass assumes that
SPL is always present and forces the public key to be added into the SPL DTB, followed by a verification step
involving that DTB.
Quoted 9 lines
Here’s what I ran into:
We setSPL_SIGN_ENABLE= "1" to enable signing, which correctly generates the ITS with a signature node for U-Boot.
But enablingSPL_SIGN_ENABLEalso triggers these additional steps in uboot-sign.bbclass:
a. The call to mkimage with -K ${SPL_DTB_BINARY} tries to inject the public key into the SPL DTB.
b. Thenfit_check_signtries to verify the FIT image using the SPL DTB.
The explanation has helped me to understand the actual use case. But we need to capture this understanding in the code, the documentation and the commit message. (The updated commit message looks already good to me).
I suggest to explicitly cover your use case in the code. The real scenario isn't that you don't want to sign the SPL or inject the key into the SPL's devicetree - it's that you don't compile an SPL at all. That means that the implementation and the documentation should transparently handle this use case. Introducing a variable SPL_SIGN_ADD_PUBKEY looks like working around that in a misleading way to me. It is simply confusing (for me) that we compile and sign an SPL but do not add the public key to the DTB.
What about setting the SPL_DTB_BINARY (or some of the SPL* variables) to an empty string? The source code could then check for [ -z "${SPL_DTB_BINARY}" ] or [ -n "${SPL_DTB_BINARY}" ] and fail if SPL_DTB_BINARY is expected but missing.
This would also allow us to document the use case by extending the SPL_DTB_BINARY variable documentation with something like:
"If SPL_DTB_BINARY is set to empty string, the uboot-sign class assumes that no SPL is built and all the related post-processing steps are skipped."
Quoted 34 lines
This fails for us because:
1. We don't have ${SPL_DTB_BINARY} at all.
2. The build breaks during the verification step due to this missing SPL DTB.
3. Even setting an invalidSPL_SIGN_KEYDIRto skip actual signing does not bypass the verification step.Instead of introducing a new variable like
SPL_SIGN_ADD_PUBKEY, we could consider modifying the logic to gracefully handle the absence of SPL DTBs.
Here’s the idea:
1. Only concat SPL binary if both parts exist:
if [ -e "${SPL_DIR}/${SPL_NODTB_BINARY}" -a -e "${SPL_DIR}/${SPL_DTB_BINARY}" ]; thencat ${SPL_DIR}/${SPL_NODTB_BINARY} ${SPL_DIR}/${SPL_DTB_SIGNED} >"${SPL_BINARY}"
else
if [ -f ${SPL_DIR}/${SPL_DTB_BINARY} ]; then
bbwarn "Failure while adding public key to spl binary.
Verified U-Boot boot won't be available."
fi
fi2. Conditionally apply -K only if SPL DTB exists:
${UBOOT_MKIMAGE_SIGN} \ ${@'-D "${SPL_MKIMAGE_DTCOPTS}"' if len('${SPL_MKIMAGE_DTCOPTS}') else ''} \ -F -k "${SPL_SIGN_KEYDIR}" \ ${@'-K "${SPL_DIR}/${SPL_DTB_BINARY}"' if d.getVar("SPL_SIGN_ADD_PUBKEY") == "1" else ''} \ -r ${UBOOT_FITIMAGE_BINARY} \ ${SPL_MKIMAGE_SIGN_ARGS}
Quoted 8 lines
3. Only run
fit_check_signif SPL DTB exists:
if [ -f ${SPL_DIR}/${SPL_DTB_BINARY} ]; then${UBOOT_FIT_CHECK_SIGN} \ -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ -f ${UBOOT_FITIMAGE_BINARY}fi
Could you please give me any suggestion?
"Gracefully handle the absence of SPL DTBs" is fragile. A file might be missing due to various bugs or build issues. If the code fails immediately when a file is expected but missing, related bugs would likely be caught by the Yocto autobuilder and problematic patches could be immediately rejected.
Depending on the details, such graceful file checks can also become very problematic when it comes to builds from sstate-cache versus full builds. When the build comes from the sstate-cache, there is simply no build folder at all - only the sysroots and the deploy folder are restored from the cache. This creates another possibility for various corner cases which we should avoid by design.
Therefore, I prefer an implementation that relies on if statements checking BitBake variables (-z, -n) over an implementation that relies on if statements checking the state of a potentially broken or absent build directory (-f, -e, -x, -d).
Is it possible to come up with an implementation which does, for example:
if [ -n "${SPL_DTB_BINARY}" ]; then
instead of
if [ -f "${SPL_DTB_BINARY}" ]; then
Thanks for the clarification
Adrian
Quoted 90 lines
Thanks-Jamin
Quoted 87 lines
Quoted 50 lines
Signed-off-by Jamin Lin <[email protected]>--- meta/classes-recipe/uboot-sign.bbclass | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-)meta/classes- renamed from meta/classes-recipe/uboot-sign.bbclass +0
-0recipe/uboot-sign.bbclass index
6ee1874cd6..3bcf47dd33100644meta/classes-recipe/uboot-sign.bbclass +0
-0@@ -34,6 +34,12 @@ UBOOT_FITIMAGE_ENABLE ?= "0" # Signature activation - this requires UBOOT_FITIMAGE_ENABLE ="1"
SPL_SIGN_ENABLE?= "0"+# Whether to add (embed) the public key into the SPL Device Tree (.dtb).
+# If set to "1", the key will be inserted into the /signature node
of the DTBmeta/classes-recipe/uboot-sign.bbclass +2
-0+# and fit_check_sign will be used to verify the signature. +# If set to "0", only signing will be performed, withoutmodifying
the DTB.meta/classes-recipe/uboot-sign.bbclass +2
-0+SPL_SIGN_ADD_PUBKEY ?= "1" + # Default value for deployment filenames. UBOOT_DTB_IMAGE ?= "u-boot-${MACHINE}-${PV}-${PR}.dtb" UBOOT_DTB_BINARY ?= "u-boot.dtb"@@ -245,7 +251,9 @@ concat_spl_dtb() { if [ -e "${SPL_DIR}/${SPL_NODTB_BINARY}" -a -e"${SPL_DIR}/${SPL_DTB_BINARY}" ] ; then
cat ${SPL_DIR}/${SPL_NODTB_BINARY} ${SPL_DIR}/${SPL_DTB_SIGNED}Quoted 1 line
"${SPL_BINARY}"
else
- bbwarn "Failure while adding public key to spl binary. Verified U-
Boot boot won't be available."
+ if [ "${SPL_SIGN_ADD_PUBKEY}" = "1" ]; then bbwarn "Failure while
+ adding public key to spl binary. Verified U-
Boot boot won't be available."
+ fi
fi
}meta/classes-recipe/uboot-sign.bbclass EOF · line 483
Quoted 2 lines
meta/classes-recipe/uboot-sign.bbclass +0
-0@@ -474,15 +482,17 @@ EOF ${UBOOT_MKIMAGE_SIGN} \ ${@'-D "${SPL_MKIMAGE_DTCOPTS}"' if
len('${SPL_MKIMAGE_DTCOPTS}')Quoted 34 lines
meta/classes-recipe/uboot-sign.bbclass +3
-4else ''} \ -F -k "${SPL_SIGN_KEYDIR}" \ - -K "${SPL_DIR}/${SPL_DTB_BINARY}" \ + ${@'-K "${SPL_DIR}/${SPL_DTB_BINARY}"' if d.getVar("SPL_SIGN_ADD_PUBKEY") == "1" else ''} \ -r ${UBOOT_FITIMAGE_BINARY} \ ${SPL_MKIMAGE_SIGN_ARGS} # # Verify the U-boot FIT image and SPL dtb # - ${UBOOT_FIT_CHECK_SIGN} \ - -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ - -f ${UBOOT_FITIMAGE_BINARY} + if [ "${SPL_SIGN_ADD_PUBKEY}" = "1" ]; then ${UBOOT_FIT_CHECK_SIGN} + \ -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ -f${UBOOT_FITIMAGE_BINARY} fi
fiif [ -e "${SPL_DIR}/${SPL_DTB_BINARY}" ]; then-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group. View/Reply Online (#218114):
https://lists.openembedded.org/g/openembedded-core/message/218114
Mute This Topic:
https://lists.openembedded.org/mt/113499585/3616858
Group Owner: [email protected] Unsubscribe:
https://lists.openembedded.org/g/openembedded-core/unsub
[
[email protected]]
-=-=-=-=-=-=-=-=-=-=-=-
Hi Adrian,
Quoted 161 lines
Subject: Re: [OE-core] [PATCH v1 2/2] uboot-sign: Make SPL DTB public key injection optional
Quoted 59 lines · Jamin Lin
Hi Adrian,
Quoted 46 lines
Subject: Re: [OE-core] [PATCH v1 2/2] uboot-sign: Make SPL DTB public key injection optional
Quoted 11 lines · Jamin Lin via lists.openembedded.org
Introduce
SPL_SIGN_ADD_PUBKEYto control whether the public key is added into the SPL device tree and whether FIT signature verification is performed after signing.Key changes:
- AddedSPL_SIGN_ADD_PUBKEYvariable (default = "1")
- Conditionally apply '-K <dtb>' to mkimage only if adding key is enabled
- Skipfit_check_signwhen public key injection is disabled
- Suppressconcat_spl_dtb()warnings if key adding is turned offQuoted 3 lines
This allows U-Boot FIT images to be signed without modifying the SPL DTB, useful in scenarios where public key management is handled elsewhere or post-processing will be done separately.
Thank you for the patch.
Introducing a new variable is one way to solve your issue, but it increases complexity and requires additional test coverage and documentation.
So I
would like to ask if this is extra complexity is really needed to achieve your goal.For a similar use case, we use this approach:
* bitbake always signs with a development key (no build variant needed, no extra test matrix)
* Then we test the firmware
* For release, we use a script to replace the development signature with a production signature (without rebuilding with bitbake)This seems similar to your approach, but I don't understand why injecting the development public key is problematic for your workflow.
Would it be better to have a post-processing step that simply replaces the public key, rather than requiring an empty DTB without any public key? That would mean that this patch would not be needed at all.Quoted 1 line
Adrian
Thanks for your reply.
Let me clarify the motivation behind this patch.In our project, we only use "U-Boot and do not have an SPL". Our goal is to sign the U-Boot FIT image only, without modifying or involving any SPL DTB. However, the current design in uboot-sign.bbclass assumes that SPL is always present and forces the public key to be added into the SPL DTB, followed by a verification step involving that DTB.
Quoted 9 lines
Here’s what I ran into:
We setSPL_SIGN_ENABLE= "1" to enable signing, which correctly generates the ITS with a signature node for U-Boot.
But enablingSPL_SIGN_ENABLEalso triggers these additional steps in uboot-sign.bbclass:
a. The call to mkimage with -K ${SPL_DTB_BINARY} tries to inject the public key into the SPL DTB.
b. Thenfit_check_signtries to verify the FIT image using the SPL DTB.The explanation has helped me to understand the actual use case. But we need to capture this understanding in the code, the documentation and the commit message. (The updated commit message looks already good to me).
I suggest to explicitly cover your use case in the code. The real scenario isn't that you don't want to sign the SPL or inject the key into the SPL's devicetree - it's that you don't compile an SPL at all.
That means that the implementation and the documentation should transparently handle this use case. Introducing a variableSPL_SIGN_ADD_PUBKEYlooks like working around that in a misleading way to me. It is simply confusing (for me) that we compile and sign an SPL but do not add the public key to the DTB.What about setting the
SPL_DTB_BINARY(or some of the SPL* variables) to an empty string? The source code could then check for [ -z "${SPL_DTB_BINARY}" ] or [ -n "${SPL_DTB_BINARY}" ] and fail ifSPL_DTB_BINARYis expected but missing.This would also allow us to document the use case by extending the
SPL_DTB_BINARYvariable documentation with something like:
"IfSPL_DTB_BINARYis set to empty string, the uboot-sign class assumes that no SPL is built and all the related post-processing steps are skipped."Quoted 25 lines
This fails for us because:
1. We don't have ${SPL_DTB_BINARY} at all.
2. The build breaks during the verification step due to this missing SPL DTB.
3. Even setting an invalidSPL_SIGN_KEYDIRto skip actual signing does not bypass the verification step.Instead of introducing a new variable like
SPL_SIGN_ADD_PUBKEY, we could consider modifying the logic to gracefully handle the absence of SPL DTBs.
Here’s the idea:
1. Only concat SPL binary if both parts exist:
if [ -e "${SPL_DIR}/${SPL_NODTB_BINARY}" -a -e "${SPL_DIR}/${SPL_DTB_BINARY}" ]; thencat ${SPL_DIR}/${SPL_NODTB_BINARY} ${SPL_DIR}/${SPL_DTB_SIGNED}"${SPL_BINARY}"
else
if [ -f ${SPL_DIR}/${SPL_DTB_BINARY} ]; then
bbwarn "Failure while adding public key to spl binary.
Verified U-Boot boot won't be available."
fi
fiQuoted 3 lines
2. Conditionally apply -K only if SPL DTB exists:
${UBOOT_MKIMAGE_SIGN} \ ${@'-D "${SPL_MKIMAGE_DTCOPTS}"' if
len('${SPL_MKIMAGE_DTCOPTS}')Quoted 7 lines
else ''} \ -F -k "${SPL_SIGN_KEYDIR}" \ ${@'-K "${SPL_DIR}/${SPL_DTB_BINARY}"' if d.getVar("SPL_SIGN_ADD_PUBKEY") == "1" else ''} \ -r ${UBOOT_FITIMAGE_BINARY} \ ${SPL_MKIMAGE_SIGN_ARGS}Quoted 8 lines
3. Only run
fit_check_signif SPL DTB exists:
if [ -f ${SPL_DIR}/${SPL_DTB_BINARY} ]; then${UBOOT_FIT_CHECK_SIGN} \ -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ -f ${UBOOT_FITIMAGE_BINARY}fi
Could you please give me any suggestion?
"Gracefully handle the absence of SPL DTBs" is fragile. A file might be missing due to various bugs or build issues. If the code fails immediately when a file is expected but missing, related bugs would likely be caught by the Yocto autobuilder and problematic patches could be immediately rejected.
Depending on the details, such graceful file checks can also become very problematic when it comes to builds from sstate-cache versus full builds. When the build comes from the sstate-cache, there is simply no build folder at all - only the sysroots and the deploy folder are restored from the cache. This creates another possibility for various corner cases which we should avoid by design.
Therefore, I prefer an implementation that relies on if statements checking BitBake variables (-z, -n) over an implementation that relies on if statements checking the state of a potentially broken or absent build directory (-f, -e, -x, -d).
Is it possible to come up with an implementation which does, for example:
Quoted 10 lines
if [ -n "${SPL_DTB_BINARY}" ]; then
instead of
if [ -f "${SPL_DTB_BINARY}" ]; then
Thanks for the clarification
Adrian
Thank you very much for your suggestion and detailed feedback.
Based on your advice, I have updated the code and the related variables accordingly. Here’s a summary of what I changed and my rationale:
Updated Variables
I set the variables like this to clearly represent the case where we do not build an SPL:
SPL_SIGN_ENABLE ?= "1"SPL_SIGN_KEYDIR ?= "${STAGING_DATADIR_NATIVE}/aspeed-secure-config/keys" SPL_DTB_BINARY = ""UBOOT_FITIMAGE_ENABLE = "1"
SPL_DTB_BINARY is explicitly set to an empty string, which means no SPL is built. UBOOT_FITIMAGE_ENABLE is still 1 to ensure that the U-Boot FIT image is generated as usual. SPL_SIGN_ENABLE controls whether the FIT image gets signed.
Code Changes
1. Removed redundant SPL_DTB_BINARY checks for FIT image generation and deployment
I dropped the checks for -n ${SPL_DTB_BINARY} in the FIT image assembly and deploy helpers because the FIT image generation should proceed as long as UBOOT_FITIMAGE_ENABLE is 1, regardless of whether the SPL exists or not.
- if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" -a -n "${SPL_DTB_BINARY}" ]; then
+ if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" ]; then
2. Simplified deploy condition
Similarly, I updated the deploy helper to deploy the ITS and FIT image when UBOOT_FITIMAGE_ENABLE is enabled.
- if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" -a -n "${SPL_DTB_BINARY}" ]; then
+ if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" ]; then
if [ -n "${type}" ]; then
uboot_its_image="u-boot-its-${type}-${PV}-${PR}"
uboot_fitimage_image="u-boot-fitImage-${type}-${PV}-${PR}"3. Adjusted SPL DTB deploy condition
I unified the check to reuse SPL_DTB_BINARY instead of having an extra SPL_DTB_SIGNED variable. So if SPL_DTB_BINARY is empty, we skip deploying the SPL DTB.
- if [ "${SPL_SIGN_ENABLE}" = "1" -a -n "${SPL_DTB_SIGNED}" ] ; then
+ if [ "${SPL_SIGN_ENABLE}" = "1" -a -n "${SPL_DTB_BINARY}" ] ; then
deploy_spl_dtb $type
fi
4. Improved the sign logic
Now the sign step checks if SPL_DTB_BINARY is empty:
If present, it signs the FIT image and injects the public key into the SPL DTB, then verifies both.
If empty, it only signs the FIT image and generates the ITS with the signature node, but does not attempt to verify or add the key to a non-existent SPL DTB.
Key Behavior Explained
If SPL_DTB_BINARY is empty, we assume there is no SPL.
If UBOOT_FITIMAGE_ENABLE=1, we always create the FIT image and ITS.
If SPL_SIGN_ENABLE=1, we always sign the FIT image, but only inject the key into the SPL DTB if it exists.
Please let me know if this approach aligns with what you had in mind, or if you have any further suggestions to refine it! Thanks again for your valuable input.
Thanks-Jamin
meta/classes-recipe/uboot-sign.bbclass +26 -18
@@ -466,21 +466,29 @@ EOF ${UBOOT_FITIMAGE_BINARY} if [ "${SPL_SIGN_ENABLE}" = "1" ] ; then - # - # Sign the U-boot FIT image and add public key to SPL dtb - # - ${UBOOT_MKIMAGE_SIGN} \ - ${@'-D "${SPL_MKIMAGE_DTCOPTS}"' if len('${SPL_MKIMAGE_DTCOPTS}') else ''} \ - -F -k "${SPL_SIGN_KEYDIR}" \ - -K "${SPL_DIR}/${SPL_DTB_BINARY}" \ - -r ${UBOOT_FITIMAGE_BINARY} \ - ${SPL_MKIMAGE_SIGN_ARGS} - # - # Verify the U-boot FIT image and SPL dtb - # - ${UBOOT_FIT_CHECK_SIGN} \ - -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ - -f ${UBOOT_FITIMAGE_BINARY} + if [ -n "${SPL_DTB_BINARY}" ] ; then + # + # Sign the U-boot FIT image and add public key to SPL dtb + # + ${UBOOT_MKIMAGE_SIGN} \ + ${@'-D "${SPL_MKIMAGE_DTCOPTS}"' if len('${SPL_MKIMAGE_DTCOPTS}') else ''} \ + -F -k "${SPL_SIGN_KEYDIR}" \ + -K "${SPL_DIR}/${SPL_DTB_BINARY}" \ + -r ${UBOOT_FITIMAGE_BINARY} \ + ${SPL_MKIMAGE_SIGN_ARGS} + + # Verify the U-boot FIT image and SPL dtb + ${UBOOT_FIT_CHECK_SIGN} \ + -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ + -f ${UBOOT_FITIMAGE_BINARY} + else + # Sign the U-boot FIT image + ${UBOOT_MKIMAGE_SIGN} \ + ${@'-D "${SPL_MKIMAGE_DTCOPTS}"' if len('${SPL_MKIMAGE_DTCOPTS}') else ''} \ + -F -k "${SPL_SIGN_KEYDIR}" \ + -r ${UBOOT_FITIMAGE_BINARY} \ + ${SPL_MKIMAGE_SIGN_ARGS} + fi fi if [ -e "${SPL_DIR}/${SPL_DTB_BINARY}" ]; then
@@ -496,7 +504,7 @@ uboot_assemble_fitimage_helper() { concat_dtb "$type" "$binary" fi - if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" -a -n "${SPL_DTB_BINARY}" ]; then + if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" ]; then uboot_fitimage_assemble fi
@@ -543,7 +551,7 @@ deploy_helper() { deploy_dtb $type fi - if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" -a -n "${SPL_DTB_BINARY}" ]; then + if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" ]; then if [ -n "${type}" ]; then uboot_its_image="u-boot-its-${type}-${PV}-${PR}" uboot_fitimage_image="u-boot-fitImage-${type}-${PV}-${PR}"
@@ -561,7 +569,7 @@ deploy_helper() { fi fi - if [ "${SPL_SIGN_ENABLE}" = "1" -a -n "${SPL_DTB_SIGNED}" ] ; then + if [ "${SPL_SIGN_ENABLE}" = "1" -a -n "${SPL_DTB_BINARY}" ] ; then deploy_spl_dtb $type fi }
Quoted 93 lines
Quoted 31 lines
Thanks-Jamin
Quoted 27 lines
Quoted 27 lines
Signed-off-by Jamin Lin <[email protected]>--- meta/classes-recipe/uboot-sign.bbclass | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-)meta/classes- renamed from meta/classes-recipe/uboot-sign.bbclass +0
-0recipe/uboot-sign.bbclass index
6ee1874cd6..3bcf47dd33100644meta/classes-recipe/uboot-sign.bbclass +0
-0@@ -34,6 +34,12 @@ UBOOT_FITIMAGE_ENABLE ?= "0" # Signature activation - this requires UBOOT_FITIMAGE_ENABLE ="1"
SPL_SIGN_ENABLE?= "0"+# Whether to add (embed) the public key into the SPL Device Tree (.dtb).
+# If set to "1", the key will be inserted into the /signature node
of the DTBmeta/classes-recipe/uboot-sign.bbclass +2
-0+# and fit_check_sign will be used to verify the signature. +# If set to "0", only signing will be performed, withoutmodifying
the DTB.
+SPL_SIGN_ADD_PUBKEY ?= "1"Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
meta/classes-recipe/uboot-sign.bbclass +1
-0+ # Default value for deployment filenames. UBOOT_DTB_IMAGE ?= "u-boot-${MACHINE}-${PV}-${PR}.dtb" UBOOT_DTB_BINARY ?= "u-boot.dtb"@@ -245,7 +251,9 @@ concat_spl_dtb() { if [ -e "${SPL_DIR}/${SPL_NODTB_BINARY}" -a -e"${SPL_DIR}/${SPL_DTB_BINARY}" ] ; then
cat ${SPL_DIR}/${SPL_NODTB_BINARY}${SPL_DIR}/${SPL_DTB_SIGNED}
Quoted 53 lines
Quoted 52 lines
Quoted 15 lines
Quoted 1 line
"${SPL_BINARY}"
else
- bbwarn "Failure while adding public key to spl binary. Verified U-
Boot boot won't be available."
+ if [ "${SPL_SIGN_ADD_PUBKEY}" = "1" ]; then bbwarn "Failure while
+ adding public key to spl binary. Verified U-
Boot boot won't be available."
+ fi
fi
}meta/classes-recipe/uboot-sign.bbclass EOF · line 483
Quoted 2 lines
meta/classes-recipe/uboot-sign.bbclass +0
-0@@ -474,15 +482,17 @@ EOF ${UBOOT_MKIMAGE_SIGN} \ ${@'-D "${SPL_MKIMAGE_DTCOPTS}"' if
len('${SPL_MKIMAGE_DTCOPTS}')Quoted 34 lines
meta/classes-recipe/uboot-sign.bbclass +3
-4else ''} \ -F -k "${SPL_SIGN_KEYDIR}" \ - -K "${SPL_DIR}/${SPL_DTB_BINARY}" \ + ${@'-K "${SPL_DIR}/${SPL_DTB_BINARY}"' if d.getVar("SPL_SIGN_ADD_PUBKEY") == "1" else ''} \ -r ${UBOOT_FITIMAGE_BINARY} \ ${SPL_MKIMAGE_SIGN_ARGS} # # Verify the U-boot FIT image and SPL dtb # - ${UBOOT_FIT_CHECK_SIGN} \ - -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ - -f ${UBOOT_FITIMAGE_BINARY} + if [ "${SPL_SIGN_ADD_PUBKEY}" = "1" ]; then ${UBOOT_FIT_CHECK_SIGN} + \ -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ -f${UBOOT_FITIMAGE_BINARY} fi
fiif [ -e "${SPL_DIR}/${SPL_DTB_BINARY}" ]; then-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group. View/Reply Online (#218114):
https://lists.openembedded.org/g/openembedded-core/message/218114
Mute This Topic:
https://lists.openembedded.org/mt/113499585/3616858
Group Owner: [email protected] Unsubscribe:
https://lists.openembedded.org/g/openembedded-core/unsub
[
[email protected]]
-=-=-=-=-=-=-=-=-=-=-=-
Hi Jamin
Thank you for these improvements. To me it looks much more understandable, robust and also test-able now.
Regarding test-able, would it be possible to add a test case to oe- selftest for this use case? E.g. here:
https://git.yoctoproject.org/poky/tree/meta/lib/oeqa/selftest/cases/fitimage.py#n1125
it should be relatively straight forward to add something like this:
def test_sign_uboot_fit_without_spl(self):
"""
Summary: Test building and signing u-boot without SPL
...
"""
config = """
# There's no U-boot defconfig with CONFIG_FIT_SIGNATURE yet, so we need
at
# least CONFIG_SPL_LOAD_FIT and CONFIG_SPL_OF_CONTROL set
MACHINE = "qemuarm"
UBOOT_MACHINE = "am57xx_evm_defconfig"
SPL_BINARY = ""
# Enable creation and signing of the U-Boot fitImage
UBOOT_FITIMAGE_ENABLE = "1"
SPL_SIGN_ENABLE = "1"
SPL_SIGN_KEYNAME = "spl-oe-selftest"
SPL_SIGN_KEYDIR = "${TOPDIR}/signing-keys"
...
"""
self.write_config(config)
bb_vars = self._fit_get_bb_vars()
self._test_fitimage(bb_vars)You can run the oe-selftest suite with a local.conf file from the template (without modifications) and this additional line:
SANITY_TESTED_DISTROS = ""
Then you can execute the test by
oe-selftest -v -K -r fitimage.UBootFitImageTests.test_sign_uboot_fit_without_spl
With -v the log file in build/tmp/log/oe-selftest-results.log shows a log of details which is helpful for understanding how the test suite works.
One more detail: shellcheck complains against lines like this:
if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" -a -n "${SPL_DTB_BINARY}" ];
We should change such lines to become:
if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" ] && [ -n "${SPL_DTB_BINARY}" ];
if we need to touch them anyway.
Thank you and regards,
Adrian
Quoted 482 lines · Jamin Lin
Hi Adrian,
Quoted 207 lines
Subject: Re: [OE-core] [PATCH v1 2/2] uboot-sign: Make SPL DTB public key
injection optionalQuoted 74 lines · Jamin Lin
Hi Adrian,
Quoted 57 lines
Subject: Re: [OE-core] [PATCH v1 2/2] uboot-sign: Make SPL DTB public key injection optional
Quoted 14 lines · Jamin Lin via lists.openembedded.org
Introduce
SPL_SIGN_ADD_PUBKEYto control whether the public key is
added into the SPL device tree and whether FIT signature verification is performed after signing.Key changes:
- AddedSPL_SIGN_ADD_PUBKEYvariable (default = "1")
- Conditionally apply '-K <dtb>' to mkimage only if adding key is
enabled
- Skipfit_check_signwhen public key injection is disabled
- Suppressconcat_spl_dtb()warnings if key adding is turned offQuoted 4 lines
This allows U-Boot FIT images to be signed without modifying the
SPL DTB, useful in scenarios where public key management is handled elsewhere or post-processing will be done separately.Thank you for the patch.
Introducing a new variable is one way to solve your issue, but it
increases complexity and requires additional test coverage and documentation.
So I
would like to ask if this is extra complexity is really needed to
achieve your goal.For a similar use case, we use this approach:
* bitbake always signs with a development key (no build
variant
needed, no extra test matrix)
* Then we test the firmware
* For release, we use a script to replace the development
signature
with a production signature (without rebuilding with
bitbake)This seems similar to your approach, but I don't understand why injecting the development public key is problematic for your workflow.
Would it be better to have a post-processing step that simply replaces the public key, rather than requiring an empty DTB without
any public key? That would mean that this patch would not be needed
at all.Quoted 1 line
Adrian
Thanks for your reply.
Let me clarify the motivation behind this patch.In our project, we only use "U-Boot and do not have an SPL". Our goal
is to sign the U-Boot FIT image only, without modifying or involving
any SPL DTB. However, the current design in uboot-sign.bbclass assumes
that SPL is always present and forces the public key to be added into
the SPL DTB, followed by a verification step involving that DTB.Quoted 12 lines
Here’s what I ran into:
We setSPL_SIGN_ENABLE= "1" to enable signing, which correctly generates the ITS with a signature node for U-Boot.
But enablingSPL_SIGN_ENABLEalso triggers these additional steps in
uboot-sign.bbclass:
a. The call to mkimage with -K ${SPL_DTB_BINARY} tries to inject the
public key into the SPL DTB.
b. Thenfit_check_signtries to verify the FIT image using the SPL
DTB.The explanation has helped me to understand the actual use case. But we need
to capture this understanding in the code, the documentation and the commit
message. (The updated commit message looks already good to me).I suggest to explicitly cover your use case in the code. The real scenario isn't
that you don't want to sign the SPL or inject the key into the SPL's devicetree -
it's that you don't compile an SPL at all.
That means that the implementation and the documentation should transparently handle this use case. Introducing a variableSPL_SIGN_ADD_PUBKEYlooks like working around that in a misleading way to
me. It is simply confusing (for me) that we compile and sign an SPL but do not
add the public key to the DTB.What about setting the
SPL_DTB_BINARY(or some of the SPL* variables) to an
empty string? The source code could then check for [ -z "${SPL_DTB_BINARY}" ]
or [ -n "${SPL_DTB_BINARY}" ] and fail ifSPL_DTB_BINARYis expected but
missing.This would also allow us to document the use case by extending the
SPL_DTB_BINARYvariable documentation with something like:
"IfSPL_DTB_BINARYis set to empty string, the uboot-sign class assumes that
no SPL is built and all the related post-processing steps are skipped."Quoted 30 lines
This fails for us because:
1. We don't have ${SPL_DTB_BINARY} at all.
2. The build breaks during the verification step due to this missing
SPL DTB.
3. Even setting an invalidSPL_SIGN_KEYDIRto skip actual signing does
not bypass the verification step.Instead of introducing a new variable like
SPL_SIGN_ADD_PUBKEY, we
could consider modifying the logic to gracefully handle the absence of
SPL DTBs.
Here’s the idea:
1. Only concat SPL binary if both parts exist:
if [ -e "${SPL_DIR}/${SPL_NODTB_BINARY}" -a -e "${SPL_DIR}/${SPL_DTB_BINARY}" ]; thencat ${SPL_DIR}/${SPL_NODTB_BINARY}${SPL_DIR}/${SPL_DTB_SIGNED}
"${SPL_BINARY}"
else
if [ -f ${SPL_DIR}/${SPL_DTB_BINARY} ]; then
bbwarn "Failure while adding public key to spl binary.
Verified U-Boot boot won't be available."
fi
fiQuoted 3 lines
2. Conditionally apply -K only if SPL DTB exists:
${UBOOT_MKIMAGE_SIGN} \ ${@'-D "${SPL_MKIMAGE_DTCOPTS}"' if
len('${SPL_MKIMAGE_DTCOPTS}')Quoted 7 lines
else ''} \ -F -k "${SPL_SIGN_KEYDIR}" \ ${@'-K "${SPL_DIR}/${SPL_DTB_BINARY}"' if d.getVar("SPL_SIGN_ADD_PUBKEY") == "1" else ''} \ -r ${UBOOT_FITIMAGE_BINARY} \ ${SPL_MKIMAGE_SIGN_ARGS}Quoted 8 lines
3. Only run
fit_check_signif SPL DTB exists:
if [ -f ${SPL_DIR}/${SPL_DTB_BINARY} ]; then${UBOOT_FIT_CHECK_SIGN} \ -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ -f ${UBOOT_FITIMAGE_BINARY}fi
Could you please give me any suggestion?
"Gracefully handle the absence of SPL DTBs" is fragile. A file might be missing
due to various bugs or build issues. If the code fails immediately when a file is
expected but missing, related bugs would likely be caught by the Yocto
autobuilder and problematic patches could be immediately rejected.Depending on the details, such graceful file checks can also become very
problematic when it comes to builds from sstate-cache versus full builds. When
the build comes from the sstate-cache, there is simply no build folder at all -
only the sysroots and the deploy folder are restored from the cache. This
creates another possibility for various corner cases which we should avoid by
design.Therefore, I prefer an implementation that relies on if statements checking
BitBake variables (-z, -n) over an implementation that relies on if statements
checking the state of a potentially broken or absent build directory (-f, -e, -x,
-d).Is it possible to come up with an implementation which does, for example:
Quoted 10 lines
if [ -n "${SPL_DTB_BINARY}" ]; then
instead of
if [ -f "${SPL_DTB_BINARY}" ]; then
Thanks for the clarification
AdrianThank you very much for your suggestion and detailed feedback. Based on your advice, I have updated the code and the related variables accordingly. Here’s a summary of what I changed and my rationale:
Updated Variables
I set the variables like this to clearly represent the case where we do not build an SPL:
SPL_SIGN_ENABLE?= "1"SPL_SIGN_KEYDIR?= "${STAGING_DATADIR_NATIVE}/aspeed-secure- config/keys"SPL_DTB_BINARY= ""UBOOT_FITIMAGE_ENABLE= "1"
SPL_DTB_BINARYis explicitly set to an empty string, which means no SPL is built.UBOOT_FITIMAGE_ENABLEis still 1 to ensure that the U-Boot FIT image is generated as usual.SPL_SIGN_ENABLEcontrols whether the FIT image gets signed.Code Changes
1. Removed redundantSPL_DTB_BINARYchecks for FIT image generation and deployment
I dropped the checks for -n ${SPL_DTB_BINARY} in the FIT image assembly and deploy helpers because the FIT image generation should proceed as long asUBOOT_FITIMAGE_ENABLEis 1, regardless of whether the SPL exists or not.- if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" -a -n "${SPL_DTB_BINARY}" ]; then
+ if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" ]; then2. Simplified deploy condition
Similarly, I updated the deploy helper to deploy the ITS and FIT image whenUBOOT_FITIMAGE_ENABLEis enabled.
- if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" -a -n
"${SPL_DTB_BINARY}" ]; then
+ if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" ]; thenif [ -n "${type}" ]; then uboot_its_image="u-boot-its-${type}-${PV}-${PR}"
uboot_fitimage_image="u-boot-fitImage-
${type}-${PV}-${PR}"3. Adjusted SPL DTB deploy condition
I unified the check to reuseSPL_DTB_BINARYinstead of having an extraSPL_DTB_SIGNEDvariable. So ifSPL_DTB_BINARYis empty, we skip deploying the SPL DTB.
- if [ "${SPL_SIGN_ENABLE}" = "1" -a -n "${SPL_DTB_SIGNED}" ] ;
then
+ if [ "${SPL_SIGN_ENABLE}" = "1" -a -n "${SPL_DTB_BINARY}" ] ;
then
deploy_spl_dtb$type
fi4. Improved the sign logic
Now the sign step checks ifSPL_DTB_BINARYis empty:
If present, it signs the FIT image and injects the public key into the SPL DTB, then verifies both.
If empty, it only signs the FIT image and generates the ITS with the signature node, but does not attempt to verify or add the key to a non-existent SPL DTB.Key Behavior Explained
IfSPL_DTB_BINARYis empty, we assume there is no SPL. If UBOOT_FITIMAGE_ENABLE=1, we always create the FIT image and ITS. If SPL_SIGN_ENABLE=1, we always sign the FIT image, but only inject the key into the SPL DTB if it exists.Please let me know if this approach aligns with what you had in mind, or if you have any further suggestions to refine it! Thanks again for your valuable input.
Thanks-Jaminmeta/classes- renamed from meta/classes-recipe/uboot-sign.bbclass +0
-0recipe/uboot-sign.bbclass
index73e9ce3f11..67f14ac92f100644meta/classes-recipe/uboot-sign.bbclass +0
-2@@ -466,21 +466,29 @@ EOF ${UBOOT_FITIMAGE_BINARY} if [ "${SPL_SIGN_ENABLE}" = "1" ] ; then - # - # Sign the U-boot FIT image and add public key to SPLdtb
meta/classes-recipe/uboot-sign.bbclass +0
-3- # - ${UBOOT_MKIMAGE_SIGN} \ - ${@'-D "${SPL_MKIMAGE_DTCOPTS}"' if
len('${SPL_MKIMAGE_DTCOPTS}')else ''} \meta/classes-recipe/uboot-sign.bbclass +3
-10- -F -k "${SPL_SIGN_KEYDIR}" \ - -K "${SPL_DIR}/${SPL_DTB_BINARY}" \ - -r ${UBOOT_FITIMAGE_BINARY} \ - ${SPL_MKIMAGE_SIGN_ARGS} - # - # Verify the U-boot FIT image and SPL dtb - # - ${UBOOT_FIT_CHECK_SIGN} \ - -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ - -f ${UBOOT_FITIMAGE_BINARY} + if [ -n "${SPL_DTB_BINARY}" ] ; then + # + # Sign the U-boot FIT image and add publickey to SPL dtb
meta/classes-recipe/uboot-sign.bbclass +3
-0+ # + ${UBOOT_MKIMAGE_SIGN} \ + ${@'-D "${SPL_MKIMAGE_DTCOPTS}"' if
len('${SPL_MKIMAGE_DTCOPTS}')else ''} \meta/classes-recipe/uboot-sign.bbclass +13
-0+ -F -k "${SPL_SIGN_KEYDIR}" \ + -K "${SPL_DIR}/${SPL_DTB_BINARY}" \ + -r ${UBOOT_FITIMAGE_BINARY} \ + ${SPL_MKIMAGE_SIGN_ARGS} + + # Verify the U-boot FIT image and SPL dtb + ${UBOOT_FIT_CHECK_SIGN} \ + -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ + -f ${UBOOT_FITIMAGE_BINARY} + else + # Sign the U-boot FIT image + ${UBOOT_MKIMAGE_SIGN} \ + ${@'-D "${SPL_MKIMAGE_DTCOPTS}"' if
len('${SPL_MKIMAGE_DTCOPTS}')else ''} \meta/classes-recipe/uboot-sign.bbclass +4
-1+ -F -k "${SPL_SIGN_KEYDIR}" \ + -r ${UBOOT_FITIMAGE_BINARY} \ + ${SPL_MKIMAGE_SIGN_ARGS} + fi fi if [ -e "${SPL_DIR}/${SPL_DTB_BINARY}" ]; then@@ -496,7 +504,7 @@ uboot_assemble_fitimage_helper() { concat_dtb "$type" "$binary" fi - if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" -a -n"${SPL_DTB_BINARY}" ]; then
meta/classes-recipe/uboot-sign.bbclass +1
-1+ if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" ]; then uboot_fitimage_assemble fi@@ -543,7 +551,7 @@ deploy_helper() { deploy_dtb $type fi - if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" -a -n"${SPL_DTB_BINARY}" ]; then
+ if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" ]; thenif [ -n "${type}" ]; then uboot_its_image="u-boot-its-${type}-${PV}-${PR}"
uboot_fitimage_image="u-boot-fitImage-
${type}-${PV}-${PR}"meta/classes-recipe/uboot-sign.bbclass +0
-1@@ -561,7 +569,7 @@ deploy_helper() { fi fi - if [ "${SPL_SIGN_ENABLE}" = "1" -a -n "${SPL_DTB_SIGNED}" ] ;then
+ if [ "${SPL_SIGN_ENABLE}" = "1" -a -n "${SPL_DTB_BINARY}" ] ;
then
deploy_spl_dtb$type
fi
}Quoted 98 lines
Quoted 35 lines
Thanks-Jamin
Quoted 31 lines
Quoted 31 lines
Signed-off-by Jamin Lin <[email protected]>--- meta/classes-recipe/uboot-sign.bbclass | 20 +++++++++++++++- ---- 1 file changed, 15 insertions(+), 5 deletions(-)meta/classes- renamed from meta/classes-recipe/uboot-sign.bbclass +0
-0recipe/uboot-sign.bbclass index
6ee1874cd6..3bcf47dd33100644meta/classes-recipe/uboot-sign.bbclass +0
-0@@ -34,6 +34,12 @@ UBOOT_FITIMAGE_ENABLE ?= "0" # Signature activation - this requires UBOOT_FITIMAGE_ENABLE=
"1"
SPL_SIGN_ENABLE?= "0"+# Whether to add (embed) the public key into the SPL Device Tree
(.dtb).
+# If set to "1", the key will be inserted into the /signature
node
of the DTBmeta/classes-recipe/uboot-sign.bbclass +2
-0+# and fit_check_sign will be used to verify the signature. +# If set to "0", only signing will be performed, withoutmodifying
the DTB.
+SPL_SIGN_ADD_PUBKEY ?= "1"Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
meta/classes-recipe/uboot-sign.bbclass +1
-0+ # Default value for deployment filenames. UBOOT_DTB_IMAGE ?= "u-boot-${MACHINE}-${PV}-${PR}.dtb" UBOOT_DTB_BINARY ?= "u-boot.dtb"@@ -245,7 +251,9 @@ concat_spl_dtb() { if [ -e "${SPL_DIR}/${SPL_NODTB_BINARY}" -a -e"${SPL_DIR}/${SPL_DTB_BINARY}" ] ; then
cat ${SPL_DIR}/${SPL_NODTB_BINARY}${SPL_DIR}/${SPL_DTB_SIGNED}
Quoted 54 lines
Quoted 53 lines
Quoted 16 lines
Quoted 1 line
"${SPL_BINARY}"
else
- bbwarn "Failure while adding public key to spl binary. Verified
U-
Boot boot won't be available."
+ if [ "${SPL_SIGN_ADD_PUBKEY}" = "1" ]; then bbwarn "Failure while
+ adding public key to spl binary. Verified U-
Boot boot won't be available."
+ fi
fi
}meta/classes-recipe/uboot-sign.bbclass EOF · line 483
Quoted 2 lines
meta/classes-recipe/uboot-sign.bbclass +0
-0@@ -474,15 +482,17 @@ EOF ${UBOOT_MKIMAGE_SIGN} \ ${@'-D "${SPL_MKIMAGE_DTCOPTS}"' if
len('${SPL_MKIMAGE_DTCOPTS}')Quoted 34 lines
meta/classes-recipe/uboot-sign.bbclass +3
-4else ''} \ -F -k "${SPL_SIGN_KEYDIR}" \ - -K "${SPL_DIR}/${SPL_DTB_BINARY}" \ + ${@'-K "${SPL_DIR}/${SPL_DTB_BINARY}"' if d.getVar("SPL_SIGN_ADD_PUBKEY") == "1" else ''} \ -r ${UBOOT_FITIMAGE_BINARY} \ ${SPL_MKIMAGE_SIGN_ARGS} # # Verify the U-boot FIT image and SPL dtb # - ${UBOOT_FIT_CHECK_SIGN} \ - -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ - -f ${UBOOT_FITIMAGE_BINARY} + if [ "${SPL_SIGN_ADD_PUBKEY}" = "1" ]; then ${UBOOT_FIT_CHECK_SIGN} + \ -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ -f${UBOOT_FITIMAGE_BINARY} fi
fiif [ -e "${SPL_DIR}/${SPL_DTB_BINARY}" ]; then-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group. View/Reply Online (#218114):
https://lists.openembedded.org/g/openembedded-core/message/218114
Mute This Topic:
https://lists.openembedded.org/mt/113499585/3616858
Group Owner: [email protected] Unsubscribe:
https://lists.openembedded.org/g/openembedded-core/unsub
[
[email protected]]
-=-=-=-=-=-=-=-=-=-=-=-
Hi Adrian,
Quoted 54 lines
Subject: Re: [OE-core] [PATCH v1 2/2] uboot-sign: Make SPL DTB public key injection optional
Hi Jamin
Thank you for these improvements. To me it looks much more understandable, robust and also test-able now.
Regarding test-able, would it be possible to add a test case to oe- selftest for this use case? E.g. here:
https://git.yoctoproject.org/poky/tree/meta/lib/oeqa/selftest/cases/fitimage.p
y#n1125
it should be relatively straight forward to add something like this:def test_sign_uboot_fit_without_spl(self): """ Summary: Test building and signing u-boot without SPL ... """ config = """ # There's no U-boot defconfig with CONFIG_FIT_SIGNATURE yet, so we need at # least CONFIG_SPL_LOAD_FIT and CONFIG_SPL_OF_CONTROL set MACHINE = "qemuarm" UBOOT_MACHINE = "am57xx_evm_defconfig" SPL_BINARY = "" # Enable creation and signing of the U-Boot fitImage UBOOT_FITIMAGE_ENABLE = "1" SPL_SIGN_ENABLE = "1" SPL_SIGN_KEYNAME = "spl-oe-selftest" SPL_SIGN_KEYDIR = "${TOPDIR}/signing-keys" ... """ self.write_config(config) bb_vars = self._fit_get_bb_vars() self._test_fitimage(bb_vars)You can run the oe-selftest suite with a local.conf file from the template (without modifications) and this additional line:
SANITY_TESTED_DISTROS= ""Then you can execute the test by
oe-selftest -v -K -r fitimage.UBootFitImageTests.test_sign_uboot_fit_without_splWith -v the log file in build/tmp/log/oe-selftest-results.log shows a log of details which is helpful for understanding how the test suite works.
One more detail: shellcheck complains against lines like this:
Quoted 8 lines
if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" -a -n "${SPL_DTB_BINARY}" ];
We should change such lines to become:
if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" ] && [ -n "${SPL_DTB_BINARY}" ];
if we need to touch them anyway.
Thanks for the suggestion and review.
I re-send v2 here,
https://patchwork.yoctoproject.org/project/oe-core/list/?series=35521
https://patchwork.yoctoproject.org/project/oe-core/cover/[email protected]/
Thanks-Jamin
Quoted 444 lines
Thank you and regards,
AdrianQuoted 288 lines · Jamin Lin
Hi Adrian,
Quoted 173 lines
Subject: Re: [OE-core] [PATCH v1 2/2] uboot-sign: Make SPL DTB public key injection optional
Quoted 64 lines · Jamin Lin
Hi Adrian,
Quoted 50 lines
Subject: Re: [OE-core] [PATCH v1 2/2] uboot-sign: Make SPL DTB public key injection optional
Quoted 12 lines · Jamin Lin via lists.openembedded.org
Introduce
SPL_SIGN_ADD_PUBKEYto control whether the public key is added into the SPL device tree and whether FIT signature verification is performed after signing.Key changes:
- AddedSPL_SIGN_ADD_PUBKEYvariable (default = "1")
- Conditionally apply '-K <dtb>' to mkimage only if adding key is enabled
- Skipfit_check_signwhen public key injection is disabled
- Suppressconcat_spl_dtb()warnings if key adding is turned offQuoted 4 lines
This allows U-Boot FIT images to be signed without modifying the SPL DTB, useful in scenarios where public key management is handled elsewhere or post-processing will be done separately.
Thank you for the patch.
Introducing a new variable is one way to solve your issue, but it increases complexity and requires additional test coverage and documentation.
So I
would like to ask if this is extra complexity is really needed to achieve your goal.For a similar use case, we use this approach:
* bitbake always signs with a development key (no build variant needed, no extra test matrix)
* Then we test the firmware
* For release, we use a script to replace the development
signature
with a production signature (without rebuilding with
bitbake)This seems similar to your approach, but I don't understand why injecting the development public key is problematic for your workflow.
Would it be better to have a post-processing step that simply replaces the public key, rather than requiring an empty DTB without any public key? That would mean that this patch would not be needed at all.Quoted 1 line
Adrian
Thanks for your reply.
Let me clarify the motivation behind this patch.In our project, we only use "U-Boot and do not have an SPL". Our goal is to sign the U-Boot FIT image only, without modifying or involving any SPL DTB. However, the current design in uboot-sign.bbclass assumes that SPL is always present and forces the public key to be added into the SPL DTB, followed by a verification step involving that DTB.
Quoted 10 lines
Here’s what I ran into:
We setSPL_SIGN_ENABLE= "1" to enable signing, which correctly generates the ITS with a signature node for U-Boot.
But enablingSPL_SIGN_ENABLEalso triggers these additional steps in
uboot-sign.bbclass:
a. The call to mkimage with -K ${SPL_DTB_BINARY} tries to inject the public key into the SPL DTB.
b. Thenfit_check_signtries to verify the FIT image using the SPL DTB.The explanation has helped me to understand the actual use case. But we need
to capture this understanding in the code, the documentation and the commit message. (The updated commit message looks already good to me).I suggest to explicitly cover your use case in the code. The real scenario isn't that you don't want to sign the SPL or inject the key into the SPL's devicetree - it's that you don't compile an SPL at all.
That means that the implementation and the documentation should transparently handle this use case. Introducing a variableSPL_SIGN_ADD_PUBKEYlooks like working around that in a misleading way to me. It is simply confusing (for me) that we compile and sign an SPL but do not add the public key to the DTB.What about setting the
SPL_DTB_BINARY(or some of the SPL* variables) to an
empty string? The source code could then check for [ -z "${SPL_DTB_BINARY}" ] or [ -n "${SPL_DTB_BINARY}" ] and fail ifSPL_DTB_BINARYis expected but missing.This would also allow us to document the use case by extending the
SPL_DTB_BINARYvariable documentation with something like:
"IfSPL_DTB_BINARYis set to empty string, the uboot-sign class assumes that no SPL is built and all the related post-processing steps are skipped."Quoted 26 lines
This fails for us because:
1. We don't have ${SPL_DTB_BINARY} at all.
2. The build breaks during the verification step due to this missing SPL DTB.
3. Even setting an invalidSPL_SIGN_KEYDIRto skip actual signing does not bypass the verification step.Instead of introducing a new variable like
SPL_SIGN_ADD_PUBKEY, we could consider modifying the logic to gracefully handle the absence of SPL DTBs.
Here’s the idea:
1. Only concat SPL binary if both parts exist:
if [ -e "${SPL_DIR}/${SPL_NODTB_BINARY}" -a -e "${SPL_DIR}/${SPL_DTB_BINARY}" ]; thencat ${SPL_DIR}/${SPL_NODTB_BINARY}${SPL_DIR}/${SPL_DTB_SIGNED}
"${SPL_BINARY}"
else
if [ -f ${SPL_DIR}/${SPL_DTB_BINARY} ]; then
bbwarn "Failure while adding public key to spl binary.
Verified U-Boot boot won't be available."
fi
fiQuoted 3 lines
2. Conditionally apply -K only if SPL DTB exists:
${UBOOT_MKIMAGE_SIGN} \ ${@'-D "${SPL_MKIMAGE_DTCOPTS}"' if
len('${SPL_MKIMAGE_DTCOPTS}')Quoted 7 lines
else ''} \ -F -k "${SPL_SIGN_KEYDIR}" \ ${@'-K "${SPL_DIR}/${SPL_DTB_BINARY}"' if d.getVar("SPL_SIGN_ADD_PUBKEY") == "1" else ''} \ -r ${UBOOT_FITIMAGE_BINARY} \ ${SPL_MKIMAGE_SIGN_ARGS}Quoted 7 lines
3. Only run
fit_check_signif SPL DTB exists:
if [ -f ${SPL_DIR}/${SPL_DTB_BINARY} ]; then${UBOOT_FIT_CHECK_SIGN} \ -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ -f ${UBOOT_FITIMAGE_BINARY} fiCould you please give me any suggestion?
"Gracefully handle the absence of SPL DTBs" is fragile. A file might be missing due to various bugs or build issues. If the code fails immediately when a file is expected but missing, related bugs would likely be caught by the Yocto autobuilder and problematic patches could be immediately rejected.
Depending on the details, such graceful file checks can also become very problematic when it comes to builds from sstate-cache versus full builds. When the build comes from the sstate-cache, there is simply no build folder at all - only the sysroots and the deploy folder are restored from the cache. This creates another possibility for various corner cases which we should avoid by design.
Therefore, I prefer an implementation that relies on if statements checking BitBake variables (-z, -n) over an implementation that relies on if statements checking the state of a potentially broken or absent build directory (-f, -e, -x, -d).
Is it possible to come up with an implementation which does, for example:
Quoted 10 lines
if [ -n "${SPL_DTB_BINARY}" ]; then
instead of
if [ -f "${SPL_DTB_BINARY}" ]; then
Thanks for the clarification
AdrianThank you very much for your suggestion and detailed feedback. Based on your advice, I have updated the code and the related variables accordingly. Here’s a summary of what I changed and my rationale:
Updated Variables
I set the variables like this to clearly represent the case where we do not build an SPL:
SPL_SIGN_ENABLE?= "1"SPL_SIGN_KEYDIR?= "${STAGING_DATADIR_NATIVE}/aspeed-secure- config/keys"SPL_DTB_BINARY= ""UBOOT_FITIMAGE_ENABLE= "1"
SPL_DTB_BINARYis explicitly set to an empty string, which means no SPL is built.UBOOT_FITIMAGE_ENABLEis still 1 to ensure that the U-Boot FIT image is generated as usual.SPL_SIGN_ENABLEcontrols whether the FIT image gets signed.Code Changes
1. Removed redundantSPL_DTB_BINARYchecks for FIT image generation and deployment I dropped the checks for -n ${SPL_DTB_BINARY} in the FIT image assembly and deploy helpers because the FIT image generation should proceed as long asUBOOT_FITIMAGE_ENABLEis 1, regardless of whether the SPL exists or not.- if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" -a -n "${SPL_DTB_BINARY}" ]; then
+ if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" ]; then2. Simplified deploy condition
Similarly, I updated the deploy helper to deploy the ITS and FIT image whenUBOOT_FITIMAGE_ENABLEis enabled.
- if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" -a -n
"${SPL_DTB_BINARY}" ]; then
+ if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" ]; thenif [ -n "${type}" ]; then uboot_its_image="u-boot-its-${type}-${PV}-${PR}"
uboot_fitimage_image="u-boot-fitImage-
${type}-${PV}-${PR}"3. Adjusted SPL DTB deploy condition
I unified the check to reuseSPL_DTB_BINARYinstead of having an extraSPL_DTB_SIGNEDvariable. So ifSPL_DTB_BINARYis empty, we skip deploying the SPL DTB.
- if [ "${SPL_SIGN_ENABLE}" = "1" -a -n "${SPL_DTB_SIGNED}" ] ;
then
+ if [ "${SPL_SIGN_ENABLE}" = "1" -a -n "${SPL_DTB_BINARY}" ] ;
then
deploy_spl_dtb$type
fi4. Improved the sign logic
Now the sign step checks ifSPL_DTB_BINARYis empty:
If present, it signs the FIT image and injects the public key into the SPL DTB, then verifies both.
If empty, it only signs the FIT image and generates the ITS with the signature node, but does not attempt to verify or add the key to a non-existent SPL DTB.Key Behavior Explained
IfSPL_DTB_BINARYis empty, we assume there is no SPL. If UBOOT_FITIMAGE_ENABLE=1, we always create the FIT image and ITS. If SPL_SIGN_ENABLE=1, we always sign the FIT image, but only inject the key into the SPL DTB if it exists.Please let me know if this approach aligns with what you had in mind, or if you have any further suggestions to refine it! Thanks again for your valuable input.
Thanks-Jaminmeta/classes- renamed from meta/classes-recipe/uboot-sign.bbclass +0
-0recipe/uboot-sign.bbclass index
73e9ce3f11..67f14ac92f100644meta/classes-recipe/uboot-sign.bbclass +0
-2@@ -466,21 +466,29 @@ EOF ${UBOOT_FITIMAGE_BINARY} if [ "${SPL_SIGN_ENABLE}" = "1" ] ; then - # - # Sign the U-boot FIT image and add public key to SPLdtb
meta/classes-recipe/uboot-sign.bbclass +0
-3- # - ${UBOOT_MKIMAGE_SIGN} \ - ${@'-D "${SPL_MKIMAGE_DTCOPTS}"' if
len('${SPL_MKIMAGE_DTCOPTS}')else ''} \meta/classes-recipe/uboot-sign.bbclass +3
-10- -F -k "${SPL_SIGN_KEYDIR}" \ - -K "${SPL_DIR}/${SPL_DTB_BINARY}" \ - -r ${UBOOT_FITIMAGE_BINARY} \ - ${SPL_MKIMAGE_SIGN_ARGS} - # - # Verify the U-boot FIT image and SPL dtb - # - ${UBOOT_FIT_CHECK_SIGN} \ - -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ - -f ${UBOOT_FITIMAGE_BINARY} + if [ -n "${SPL_DTB_BINARY}" ] ; then + # + # Sign the U-boot FIT image and add publickey to SPL dtb
meta/classes-recipe/uboot-sign.bbclass EOF
Quoted 3 lines
meta/classes-recipe/uboot-sign.bbclass +3
-0+ # + ${UBOOT_MKIMAGE_SIGN} \ + ${@'-D"${SPL_MKIMAGE_DTCOPTS}"' if
meta/classes-recipe/uboot-sign.bbclass
Quoted 3 lines
len('${SPL_MKIMAGE_DTCOPTS}')else ''} \meta/classes-recipe/uboot-sign.bbclass +2
-0+ -F -k "${SPL_SIGN_KEYDIR}" \ + -K "${SPL_DIR}/${SPL_DTB_BINARY}"\
meta/classes-recipe/uboot-sign.bbclass EOF
Quoted 6 lines
meta/classes-recipe/uboot-sign.bbclass +6
-0+ -r ${UBOOT_FITIMAGE_BINARY} \ + ${SPL_MKIMAGE_SIGN_ARGS} + + # Verify the U-boot FIT image and SPL dtb + ${UBOOT_FIT_CHECK_SIGN} \ + -k "${SPL_DIR}/${SPL_DTB_BINARY}"\
meta/classes-recipe/uboot-sign.bbclass EOF
Quoted 5 lines
meta/classes-recipe/uboot-sign.bbclass +5
-0+ -f ${UBOOT_FITIMAGE_BINARY} + else + # Sign the U-boot FIT image + ${UBOOT_MKIMAGE_SIGN} \ + ${@'-D"${SPL_MKIMAGE_DTCOPTS}"' if
Quoted 129 lines
len('${SPL_MKIMAGE_DTCOPTS}')else ''} \meta/classes-recipe/uboot-sign.bbclass +5
-1+ -F -k "${SPL_SIGN_KEYDIR}" \ + -r ${UBOOT_FITIMAGE_BINARY} \ + ${SPL_MKIMAGE_SIGN_ARGS} + fi fi if [ -e "${SPL_DIR}/${SPL_DTB_BINARY}" ]; then @@ -496,7 +504,7 @@ uboot_assemble_fitimage_helper() { concat_dtb "$type" "$binary" fi - if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" -a -n"${SPL_DTB_BINARY}" ]; then
meta/classes-recipe/uboot-sign.bbclass +1
-1+ if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" ]; then uboot_fitimage_assemble fi@@ -543,7 +551,7 @@ deploy_helper() { deploy_dtb $type fi - if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" -a -n"${SPL_DTB_BINARY}" ]; then
+ if [ "${UBOOT_FITIMAGE_ENABLE}" = "1" ]; thenif [ -n "${type}" ]; then uboot_its_image="u-boot-its-${type}-${PV}-${PR}"
uboot_fitimage_image="u-boot-fitImage-
${type}-${PV}-${PR}"meta/classes-recipe/uboot-sign.bbclass +0
-1@@ -561,7 +569,7 @@ deploy_helper() { fi fi - if [ "${SPL_SIGN_ENABLE}" = "1" -a -n "${SPL_DTB_SIGNED}" ] ;then
+ if [ "${SPL_SIGN_ENABLE}" = "1" -a -n "${SPL_DTB_BINARY}" ] ;
then
deploy_spl_dtb$type
fi
}Quoted 86 lines
Quoted 34 lines
Thanks-Jamin
Quoted 30 lines
Quoted 30 lines
Signed-off-by Jamin Lin <[email protected]>--- meta/classes-recipe/uboot-sign.bbclass | 20 +++++++++++++++- ---- 1 file changed, 15 insertions(+), 5 deletions(-)meta/classes- renamed from meta/classes-recipe/uboot-sign.bbclass +0
-0recipe/uboot-sign.bbclass index
6ee1874cd6..3bcf47dd33100644meta/classes-recipe/uboot-sign.bbclass +0
-0@@ -34,6 +34,12 @@ UBOOT_FITIMAGE_ENABLE ?= "0" # Signature activation - this requires UBOOT_FITIMAGE_ENABLE= "1"
SPL_SIGN_ENABLE?= "0"+# Whether to add (embed) the public key into the SPL Device Tree
(.dtb).
+# If set to "1", the key will be inserted into the /signature
node
of the DTBmeta/classes-recipe/uboot-sign.bbclass +2
-0+# and fit_check_sign will be used to verify the signature. +# If set to "0", only signing will be performed, withoutmodifying
the DTB.
+SPL_SIGN_ADD_PUBKEY ?= "1"Quoted 8 lines
Quoted 8 lines
Quoted 8 lines
meta/classes-recipe/uboot-sign.bbclass +1
-0+ # Default value for deployment filenames. UBOOT_DTB_IMAGE ?= "u-boot-${MACHINE}-${PV}-${PR}.dtb" UBOOT_DTB_BINARY ?= "u-boot.dtb"@@ -245,7 +251,9 @@ concat_spl_dtb() { if [ -e "${SPL_DIR}/${SPL_NODTB_BINARY}" -a -e"${SPL_DIR}/${SPL_DTB_BINARY}" ] ; then
cat ${SPL_DIR}/${SPL_NODTB_BINARY}${SPL_DIR}/${SPL_DTB_SIGNED}
Quoted 43 lines
Quoted 42 lines
Quoted 16 lines
Quoted 1 line
"${SPL_BINARY}"
else
- bbwarn "Failure while adding public key to spl binary. Verified
U-
Boot boot won't be available."
+ if [ "${SPL_SIGN_ADD_PUBKEY}" = "1" ]; then bbwarn "Failure while
+ adding public key to spl binary. Verified U-
Boot boot won't be available."
+ fi
fi
}meta/classes-recipe/uboot-sign.bbclass EOF · line 483
Quoted 2 lines
meta/classes-recipe/uboot-sign.bbclass +0
-0@@ -474,15 +482,17 @@ EOF ${UBOOT_MKIMAGE_SIGN} \ ${@'-D "${SPL_MKIMAGE_DTCOPTS}"' if
len('${SPL_MKIMAGE_DTCOPTS}')Quoted 23 lines
meta/classes-recipe/uboot-sign.bbclass +3
-4else ''} \ -F -k "${SPL_SIGN_KEYDIR}" \ - -K "${SPL_DIR}/${SPL_DTB_BINARY}" \ + ${@'-K "${SPL_DIR}/${SPL_DTB_BINARY}"' if d.getVar("SPL_SIGN_ADD_PUBKEY") == "1" else ''} \ -r ${UBOOT_FITIMAGE_BINARY} \ ${SPL_MKIMAGE_SIGN_ARGS} # # Verify the U-boot FIT image and SPL dtb # - ${UBOOT_FIT_CHECK_SIGN} \ - -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ - -f ${UBOOT_FITIMAGE_BINARY} + if [ "${SPL_SIGN_ADD_PUBKEY}" = "1" ]; then ${UBOOT_FIT_CHECK_SIGN} + \ -k "${SPL_DIR}/${SPL_DTB_BINARY}" \ -f${UBOOT_FITIMAGE_BINARY} fi
fiif [ -e "${SPL_DIR}/${SPL_DTB_BINARY}" ]; then
Hi Jamin
Thank you for the improvements. It looks good to me now.
Adrian