]> www.infradead.org Git - users/jedix/linux-maple.git/commitdiff
Documentation/module-signing.txt: bring up to date
authorDimitri John Ledkov <dimitri.ledkov@canonical.com>
Sun, 22 Oct 2023 18:22:08 +0000 (19:22 +0100)
committerHerbert Xu <herbert@gondor.apana.org.au>
Fri, 27 Oct 2023 10:04:30 +0000 (18:04 +0800)
Update the documentation to mention that ECC NIST P-384 automatic
keypair generation is available to use ECDSA signature type, in
addition to the RSA.

Drop mentions of the now removed SHA-1 and SHA-224 options.

Add the just added FIPS 202 SHA-3 module signature hashes.

Signed-off-by: Dimitri John Ledkov <dimitri.ledkov@canonical.com>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
Documentation/admin-guide/module-signing.rst

index 2898b270329785b57f4525b986d62259210018d4..a8667a777490a8047e5cc3d0a6dba0bcd443eb82 100644 (file)
@@ -28,10 +28,10 @@ trusted userspace bits.
 
 This facility uses X.509 ITU-T standard certificates to encode the public keys
 involved.  The signatures are not themselves encoded in any industrial standard
-type.  The facility currently only supports the RSA public key encryption
-standard (though it is pluggable and permits others to be used).  The possible
-hash algorithms that can be used are SHA-1, SHA-224, SHA-256, SHA-384, and
-SHA-512 (the algorithm is selected by data in the signature).
+type.  The built-in facility currently only supports the RSA & NIST P-384 ECDSA
+public key signing standard (though it is pluggable and permits others to be
+used).  The possible hash algorithms that can be used are SHA-2 and SHA-3 of
+sizes 256, 384, and 512 (the algorithm is selected by data in the signature).
 
 
 ==========================
@@ -81,11 +81,12 @@ This has a number of options available:
      sign the modules with:
 
         =============================== ==========================================
-       ``CONFIG_MODULE_SIG_SHA1``      :menuselection:`Sign modules with SHA-1`
-       ``CONFIG_MODULE_SIG_SHA224``    :menuselection:`Sign modules with SHA-224`
        ``CONFIG_MODULE_SIG_SHA256``    :menuselection:`Sign modules with SHA-256`
        ``CONFIG_MODULE_SIG_SHA384``    :menuselection:`Sign modules with SHA-384`
        ``CONFIG_MODULE_SIG_SHA512``    :menuselection:`Sign modules with SHA-512`
+       ``CONFIG_MODULE_SIG_SHA3_256``  :menuselection:`Sign modules with SHA3-256`
+       ``CONFIG_MODULE_SIG_SHA3_384``  :menuselection:`Sign modules with SHA3-384`
+       ``CONFIG_MODULE_SIG_SHA3_512``  :menuselection:`Sign modules with SHA3-512`
         =============================== ==========================================
 
      The algorithm selected here will also be built into the kernel (rather
@@ -145,6 +146,10 @@ into vmlinux) using parameters in the::
 
 file (which is also generated if it does not already exist).
 
+One can select between RSA (``MODULE_SIG_KEY_TYPE_RSA``) and ECDSA
+(``MODULE_SIG_KEY_TYPE_ECDSA``) to generate either RSA 4k or NIST
+P-384 keypair.
+
 It is strongly recommended that you provide your own x509.genkey file.
 
 Most notably, in the x509.genkey file, the req_distinguished_name section