ref-manual: document authentication key variables
PATCH v3 1/1 ref-manual: document authentication key variables
This documents the variables used to create keys for signing fitImage.
Signed-off-by Usama Arif <[email protected]>
--- documentation/ref-manual/ref-classes.rst | 4 +++- documentation/ref-manual/ref-variables.rst | 23 ++++++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-)
documentation/ref-manual/ref-classes.rst +3 -1
@@ -1413,7 +1413,9 @@ variables :term:`UBOOT_SIGN_ENABLE`, :term:`UBOOT_MKIMAGE_DTCOPTS`, :term:`UBOOT_SIGN_KEYDIR` and :term:`UBOOT_SIGN_KEYNAME` are set appropriately. The default values used for :term:`FIT_HASH_ALG` and :term:`FIT_SIGN_ALG` in ``kernel-fitimage`` are "sha256" and -"rsa2048" respectively. +"rsa2048" respectively. The keys for signing fitImage can be generated using +the ``kernel-fitimage`` class when both :term:`FIT_GENERATE_KEYS` and +:term:`UBOOT_SIGN_ENABLE` are set to "1". .. _ref-classes-kernel-grub:
documentation/ref-manual/ref-variables.rst +23 -0
@@ -2585,6 +2585,11 @@ system and gives an overview of their function and contents. For guidance on how to create your own file permissions settings table file, examine the existing ``fs-perms.txt``. + FIT_GENERATE_KEYS + Decides whether to generate the keys for signing fitImage if they + don't already exist. The keys are created in ``UBOOT_SIGN_KEYDIR``. + The default value is 0. + FIT_HASH_ALG Specifies the hash algorithm used in creating the FIT Image. For e.g. sha256.
@@ -2592,6 +2597,24 @@ system and gives an overview of their function and contents. Specifies the signature algorithm used in creating the FIT Image. For e.g. rsa2048. + FIT_SIGN_NUMBITS + Size of private key in number of bits used in fitImage. The default + value is "2048". + + FIT_KEY_GENRSA_ARGS + Arguments to openssl genrsa for generating RSA private key for signing + fitImage. The default value is "-F4". i.e. the public exponent 65537 to + use. + + FIT_KEY_REQ_ARGS + Arguments to openssl req for generating certificate for signing fitImage. + The default value is "-batch -new". batch for non interactive mode + and new for generating new keys. + + FIT_KEY_SIGN_PKCS + Format for public key ceritifcate used in signing fitImage. + The default value is "x509". + FONT_EXTRA_RDEPENDS When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, this variable specifies the runtime dependencies for font packages.
Signature · 1 line
2.17.1
Quoted 53 lines · Usama Arif
This documents the variables used to create keys for signing fitImage.
Signed-off-by Usama Arif <[email protected]>--- documentation/ref-manual/ref-classes.rst | 4 +++- documentation/ref-manual/ref-variables.rst | 23 ++++++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-)documentation/ref-manual/ref-classes.rst +3
-1@@ -1413,7 +1413,9 @@ variables :term:`UBOOT_SIGN_ENABLE`, :term:`UBOOT_MKIMAGE_DTCOPTS`, :term:`UBOOT_SIGN_KEYDIR` and :term:`UBOOT_SIGN_KEYNAME` are set appropriately. The default values used for :term:`FIT_HASH_ALG` and :term:`FIT_SIGN_ALG` in ``kernel-fitimage`` are "sha256" and -"rsa2048" respectively. +"rsa2048" respectively. The keys for signing fitImage can be generated using +the ``kernel-fitimage`` class when both :term:`FIT_GENERATE_KEYS` and +:term:`UBOOT_SIGN_ENABLE` are set to "1". .. _ref-classes-kernel-grub:documentation/ref-manual/ref-variables.rst +13
-0@@ -2585,6 +2585,11 @@ system and gives an overview of their function and contents. For guidance on how to create your own file permissions settings table file, examine the existing ``fs-perms.txt``. + FIT_GENERATE_KEYS + Decides whether to generate the keys for signing fitImage if they + don't already exist. The keys are created in ``UBOOT_SIGN_KEYDIR``. + The default value is 0. + FIT_HASH_ALG Specifies the hash algorithm used in creating the FIT Image. For e.g. sha256.@@ -2592,6 +2597,24 @@ system and gives an overview of their function and contents. Specifies the signature algorithm used in creating the FIT Image. For e.g. rsa2048. + FIT_SIGN_NUMBITS + Size of private key in number of bits used in fitImage. The default + value is "2048". + + FIT_KEY_GENRSA_ARGS + Arguments to openssl genrsa for generating RSA private key for signing + fitImage. The default value is "-F4". i.e. the public exponent 65537 to + use.
documentation/ref-manual/ref-variables.rst system and gives an overview of their function and contents. · line 2617
Quoted 10 lines
documentation/ref-manual/ref-variables.rst +10
-0+ + FIT_KEY_REQ_ARGS + Arguments to openssl req for generating certificate for signing fitImage. + The default value is "-batch -new". batch for non interactive mode + and new for generating new keys. + + FIT_KEY_SIGN_PKCS + Format for public key ceritifcate used in signing fitImage. + The default value is "x509". +
We probably should be sorted alphabetically.
Quoted 9 lines
documentation/ref-manual/ref-variables.rst +0
-1FONT_EXTRA_RDEPENDS When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, this variable specifies the runtime dependencies for font packages. --2.17.1
Quoted 58 lines · Nicolas Dechesne via lists.yoctoproject.org
Quoted 57 lines · Usama Arif
This documents the variables used to create keys for signing fitImage.
Signed-off-by Usama Arif <[email protected]>--- documentation/ref-manual/ref-classes.rst | 4 +++- documentation/ref-manual/ref-variables.rst | 23 ++++++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-)documentation/ref-manual/ref-classes.rst +3
-1@@ -1413,7 +1413,9 @@ variables :term:`UBOOT_SIGN_ENABLE`, :term:`UBOOT_MKIMAGE_DTCOPTS`, :term:`UBOOT_SIGN_KEYDIR` and :term:`UBOOT_SIGN_KEYNAME` are set appropriately. The default values used for :term:`FIT_HASH_ALG` and :term:`FIT_SIGN_ALG` in ``kernel-fitimage`` are "sha256" and -"rsa2048" respectively. +"rsa2048" respectively. The keys for signing fitImage can be generated using +the ``kernel-fitimage`` class when both :term:`FIT_GENERATE_KEYS` and +:term:`UBOOT_SIGN_ENABLE` are set to "1". .. _ref-classes-kernel-grub:documentation/ref-manual/ref-variables.rst +17
-0@@ -2585,6 +2585,11 @@ system and gives an overview of their function and contents. For guidance on how to create your own file permissions settings table file, examine the existing ``fs-perms.txt``. + FIT_GENERATE_KEYS + Decides whether to generate the keys for signing fitImage if they + don't already exist. The keys are created in ``UBOOT_SIGN_KEYDIR``. + The default value is 0. + FIT_HASH_ALG Specifies the hash algorithm used in creating the FIT Image. For e.g. sha256.@@ -2592,6 +2597,24 @@ system and gives an overview of their function and contents. Specifies the signature algorithm used in creating the FIT Image. For e.g. rsa2048. + FIT_SIGN_NUMBITS + Size of private key in number of bits used in fitImage. The default + value is "2048". + + FIT_KEY_GENRSA_ARGS + Arguments to openssl genrsa for generating RSA private key for signing + fitImage. The default value is "-F4". i.e. the public exponent 65537 to + use. + + FIT_KEY_REQ_ARGS + Arguments to openssl req for generating certificate for signing fitImage. + The default value is "-batch -new". batch for non interactive mode
Quoted 9 lines
documentation/ref-manual/ref-variables.rst system and gives an overview of their function and contents. · line 2617
Quoted 6 lines
documentation/ref-manual/ref-variables.rst +6
-0+ and new for generating new keys. + + FIT_KEY_SIGN_PKCS + Format for public key ceritifcate used in signing fitImage. + The default value is "x509". +We probably should be sorted alphabetically.
Thanks, fixed in v4.
Regards,
Usama
Quoted 13 lines
Quoted 13 lines
documentation/ref-manual/ref-variables.rst +0
-1FONT_EXTRA_RDEPENDS When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, this variable specifies the runtime dependencies for font packages. --2.17.1