Add support for ML-DSA signing and verification
Subsystems (2)
cover Add support for ML-DSA signing and verification
This series adds support for ML-DSA signing and verification for EVM and IMA using ML-DSA in pure mode and IMA's sigv3 signature format. Evmctl will prevent users from trying to use sigv2 signatures with ML-DSA and therefore ML-DSA requires the usage of --v3. Test cases for IMA and EVM sigv3 are added using ML-DSA-44 (2420 bytes) and ML-DSA-65 (3309 bytes) type of keys since those are more likely to fit into xattrs on most filesystems than the even larger ML-DSA-87 signatures (4627 bytes).
Stefan
Stefan Berger (5):
checkpatch: Remove warning when function name is found in output
string
Set size of xattr_value to MAX_SIGNATURE_SIZE
Support signing with ML-DSA keys when OpenSSL >=3.5 is available
examples: Implement script to create ML-DSA-65 CA and signing keys
test: Add tests for signing and verifying with ML-DSA keys
README | 3 +- examples/ima-gen-local-ca-mldsa65.sh | 29 +++ examples/ima-genkey-mldsa65.sh | 34 ++++ examples/ima-genkey-mldsa87.sh | 34 ++++ scripts/checkpatch.pl | 14 +- src/evmctl.c | 6 +- src/imaevm.h | 5 +- src/libimaevm.c | 258 +++++++++++++++++++++++++-- tests/gen-keys.sh | 22 +++ tests/sign_verify.test | 40 ++++- 10 files changed, 417 insertions(+), 28 deletions(-) create mode 100755 examples/ima-gen-local-ca-mldsa65.sh create mode 100755 examples/ima-genkey-mldsa65.sh create mode 100755 examples/ima-genkey-mldsa87.sh
Signature · 1 line
2.53.0
PATCH 1/5 checkpatch: Remove warning when function name is found in output string
Remove the following type of warning:
WARNING: Prefer using '"%s...", __func__' to using 'create_sigv3_mldsa', \
this function's name, in a string
--- scripts/checkpatch.pl | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-)
scripts/checkpatch.pl +7 -7
@@ -6285,13 +6285,13 @@ sub process { # This does not work very well for -f --file checking as it depends on patch # context providing the function name or a single line form for in-file # function declarations - if ($line =~ /^\+.*$String/ && - defined($context_function) && - get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && - length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { - WARN("EMBEDDED_FUNCTION_NAME", - "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); - } +# if ($line =~ /^\+.*$String/ && +# defined($context_function) && +# get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && +# length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { +# WARN("EMBEDDED_FUNCTION_NAME", +# "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); +# } # check for unnecessary function tracing like uses # This does not use $logFunctions because there are many instances like
Signature · 1 line
2.53.0
PATCH 2/5 Set size of xattr_value to MAX_SIGNATURE_SIZE
In reply to Stefan BergerSet the size of an xattr_value that can be read to MAX_SIGNATURE_SIZE so that ML-DSA keys can also be read once enabled (and MAX_SIGNATURE_SIZE gets a larger value).
--- src/evmctl.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
src/evmctl.c +1 -1
@@ -347,7 +347,7 @@ static int calc_evm_hash(const char *file, const char *hash_algo,EVP_MD_CTX *pctx;unsigned int mdlen;char **xattrname; -char xattr_value[1024 ]; +char xattr_value[MAX_SIGNATURE_SIZE ];char list[1024 ];ssize_t list_size;char uuid[16 ];
Signature · 1 line
2.53.0
PATCH 3/5 Support signing with ML-DSA keys when OpenSSL >=3.5 is available
In reply to Stefan BergerOpenSSL >= v3.5.0 supports signing with ML-DSA-44/65/87. Add support for it to the imaevm_create_sigv3 library function. Since the ML-DSA signatures require a lot more space for the signature now, increase the size of the array where the signatures are stored. The following are the sizes of ML-DSA signatures by key type:
- ML-DSA-44: 2420
- ML-DSA-65: 3309
- ML-DSA-87: 4627
Prevent signature V2 from being created with any other key types than 'RSA', 'EC', 'GOST' (ECRDSA), or 'SM2'.
In the functions that created a v2 signature, only RSA, ECDSA, and ECRDSA signatures are created and they can easily work with the old buffer size of less than 1024 bytes.
The size available for extended attributes may be smaller than what is required by the ML-DSA signature size, and therefore may not be possible to store for example ML-DSA-87 signatures (depends on type of filesystem). Nevertheless, extend the MAX_SIGNATURE_SIZE to the required size of ML-DSA-87 and display an error if writing the signature of a size larger than 4k did not work.
--- README | 3 +- src/evmctl.c | 4 + src/imaevm.h | 5 +- src/libimaevm.c | 258 ++++++++++++++++++++++++++++++++++++++++++++++-- 4 files changed, 258 insertions(+), 12 deletions(-)
README +2 -1
@@ -153,7 +153,8 @@ in the kernel (since kernel 3.9). CONFIG_INTEGRITY_ASYMMETRIC_KEYS must be enabl For v2 and v3 signatures x509 certificate (containing the public key) could be appended to the private key (they both are in PEM format) to automatically extract keyid from its Subject -Key Identifier (SKID). +Key Identifier (SKID). v3 signatures can be created with the --v3 option. This signature format +is required for signing with ML-DSA keys. Integrity keyrings ----------------
src/evmctl.c +4 -0
@@ -617,6 +617,10 @@ static int sign_evm(const char *file, char *hash_algo, const char *key)if (err <0 ) {log_errno_reset (LOG_ERR ,"Setting EVM xattr failed: %s" , file); +if (len >=4096 ) +log_err ("The signature with %zu bytes is likely too large for the file " +"extended attribute. Consider using a different key type.\n" , + len);return err; } }
src/imaevm.h +4 -1
@@ -74,8 +74,11 @@ typedef struct ossl_provider_st OSSL_PROVIDER;#define DATA_SIZE 4096#define SHA1_HASH_LEN 20 +#define ML_DSA_87_SIGNATURE_SIZE 4627 +#define MAX_DIGEST_SIZE 64 -#define MAX_SIGNATURE_SIZE 1024 +#define MAX_SIGNATURE_SIZE (1 + sizeof(struct signature_v2_hdr) + \ + ML_DSA_87_SIGNATURE_SIZE)/* * The maximum template data size is dependent on the template format. For
src/libimaevm.c +248 -10
326 lines not on this page · raw message
Signature · 1 line
2.53.0
PATCH 4/5 examples: Implement script to create ML-DSA-65 CA and signing keys
In reply to Stefan Bergerima-gen-local-ca-mldsa65.sh creates a CA with an ML-DSA-65 key and ima-genkey-mldsa65.sh creates an ML-DSA-65 IMA file signing key along with its certificate.
Also add a script for creating an ML-DSA-87 IMA file signing key. This key type is good for local testing with the largest possible signature.
--- examples/ima-gen-local-ca-mldsa65.sh | 29 ++++++++++++++++++++++++ examples/ima-genkey-mldsa65.sh | 34 ++++++++++++++++++++++++++++ examples/ima-genkey-mldsa87.sh | 34 ++++++++++++++++++++++++++++ 3 files changed, 97 insertions(+) create mode 100755 examples/ima-gen-local-ca-mldsa65.sh create mode 100755 examples/ima-genkey-mldsa65.sh create mode 100755 examples/ima-genkey-mldsa87.sh
examples/ima-gen-local-ca-mldsa65.sh new file +29 -0
@@ -0,0 +1,29 @@ +#!/bin/sh +# SPDX-License-Identifier: GPL-2.0-or-later + +GENKEY=ima-local-ca.genkey + +cat << __EOF__ >$GENKEY +[ req ] +distinguished_name = req_distinguished_name +prompt = no +string_mask = utf8only +x509_extensions = v3_ca + +[ req_distinguished_name ] +O = IMA-CA +CN = IMA/EVM certificate signing key +emailAddress = ca@ima-ca + +[ v3_ca ] +basicConstraints=CA:TRUE +subjectKeyIdentifier=hash +authorityKeyIdentifier=keyid:always,issuer +keyUsage = cRLSign, keyCertSign +__EOF__ + +openssl req -new -x509 -utf8 -sha256 -days 3650 -batch -config $GENKEY \ + -outform DER -out ima-local-ca.x509 -keyout ima-local-ca.priv \ + -newkey mldsa65 + +openssl x509 -inform DER -in ima-local-ca.x509 -out ima-local-ca.pem
examples/ima-genkey-mldsa65.sh new file +34 -0
@@ -0,0 +1,34 @@ +#!/bin/sh +# SPDX-License-Identifier: GPL-2.0-or-later + +GENKEY=ima.genkey + +cat << __EOF__ >$GENKEY +[ req ] +distinguished_name = req_distinguished_name +prompt = no +string_mask = utf8only +x509_extensions = v3_usr + +[ req_distinguished_name ] +O = `hostname` +CN = `whoami` signing key +emailAddress = `whoami`@`hostname` + +[ v3_usr ] +basicConstraints=critical,CA:FALSE +#basicConstraints=CA:FALSE +keyUsage=digitalSignature +#keyUsage = nonRepudiation, digitalSignature, keyEncipherment +extendedKeyUsage=critical,codeSigning +subjectKeyIdentifier=hash +authorityKeyIdentifier=keyid +#authorityKeyIdentifier=keyid,issuer +__EOF__ + +openssl req -new -nodes -utf8 -sha256 -days 365 -batch -config $GENKEY \ + -out csr_ima.pem -keyout privkey_ima.pem \ + -newkey mldsa65 +openssl x509 -req -in csr_ima.pem -days 365 -extfile $GENKEY -extensions v3_usr \ + -CA ima-local-ca.pem -CAkey ima-local-ca.priv -CAcreateserial \ + -outform DER -out x509_ima.der
examples/ima-genkey-mldsa87.sh new file +34 -0
@@ -0,0 +1,34 @@ +#!/bin/sh +# SPDX-License-Identifier: GPL-2.0-or-later + +GENKEY=ima.genkey + +cat << __EOF__ >$GENKEY +[ req ] +distinguished_name = req_distinguished_name +prompt = no +string_mask = utf8only +x509_extensions = v3_usr + +[ req_distinguished_name ] +O = `hostname` +CN = `whoami` signing key +emailAddress = `whoami`@`hostname` + +[ v3_usr ] +basicConstraints=critical,CA:FALSE +#basicConstraints=CA:FALSE +keyUsage=digitalSignature +#keyUsage = nonRepudiation, digitalSignature, keyEncipherment +extendedKeyUsage=critical,codeSigning +subjectKeyIdentifier=hash +authorityKeyIdentifier=keyid +#authorityKeyIdentifier=keyid,issuer +__EOF__ + +openssl req -new -nodes -utf8 -sha256 -days 365 -batch -config $GENKEY \ + -out csr_ima.pem -keyout privkey_ima.pem \ + -newkey mldsa87 +openssl x509 -req -in csr_ima.pem -days 365 -extfile $GENKEY -extensions v3_usr \ + -CA ima-local-ca.pem -CAkey ima-local-ca.priv -CAcreateserial \ + -outform DER -out x509_ima.der
Signature · 1 line
2.53.0
PATCH 5/5 test: Add tests for signing and verifying with ML-DSA keys
In reply to Stefan BergerCreate ML-DSA-44 & ML-DSA-65 keys if ML-DSA-44 can be created with the installed version of OpenSSL. Add test cases for signing and verifying with these types of keys.
Do not test with ML-DSA-87 keys since the signatures they create may be too large for some filesystems' xattrs. On Btrfs for example it would be possible to store the large signatures.
--- tests/gen-keys.sh | 22 ++++++++++++++++++++++ tests/sign_verify.test | 40 ++++++++++++++++++++++++++++++++-------- 2 files changed, 54 insertions(+), 8 deletions(-)
tests/gen-keys.sh +22 -0
@@ -148,6 +148,28 @@ if [ -x /opt/openssl3/bin/openssl ]; then done) fi +# If creating mldsa44 key works, create all ML-DSA sizes +if openssl genpkey -algorithm mldsa44 &>/dev/null; then + for mldsa in mldsa44 mldsa65; do + if [ "$1" = clean ] || [ "$1" = force ]; then + rm -f test-$mldsa.cer test-$mldsa.key test-$mldsa.pub + fi + if [ "$1" = clean ]; then + continue + fi + if [ ! -e test-$mldsa.key ]; then + log openssl req -verbose -new -nodes -utf8 -sha256 -days 10000 -batch -x509 \ + -config test-ca.conf \ + -newkey "$mldsa" \ + -out test-$mldsa.cer -outform DER \ + -keyout test-$mldsa.key + if [ -s test-$mldsa.key ]; then + log openssl pkey -in test-$mldsa.key -out test-$mldsa.pub -pubout + fi + fi + done +fi + # This script leaves test-ca.conf, *.cer, *.pub, *.key files for sing/verify tests. # They are never deleted except by `make distclean'.
tests/sign_verify.test +32 -8
@@ -166,8 +166,15 @@ check_sign() { fi # Can openssl sign with this digest and key? - cmd="openssl dgst $OPENSSL_ENGINE $OPENSSL_KEYFORM -$ALG -sign $key -hex $FILE" - echo - "$cmd" + case "${KEY:0:10}" in + "test-mldsa") + cmd="openssl pkeyutl -sign -inkey $key -in $FILE" + echo >> "$FILE" # need at least 1 byte in the file for signing to work + ;; + *) + cmd="openssl dgst $OPENSSL_ENGINE $OPENSSL_KEYFORM -$ALG -sign $key -hex $FILE" + ;; + esac if ! $cmd >/dev/null; then echo "${CYAN}$ALG ($key) test is skipped (openssl is unable to sign)$NORM" return "$SKIP"
@@ -216,11 +223,21 @@ check_sign() { if [[ "$OPTS" =~ "--v3" ]]; then # In case of v3 signatures we need to create ima_file_id now. # All data for it can be found in PREFIX and by hashing $FILE. - echo -en "\x${PREFIX:2:2}\x${PREFIX:6:2}" > "$FILE.tmp" + echo -en "\x${PREFIX:2:2}\x${PREFIX:6:2}" > "$FILE.ima_file_id" # shellcheck disable=SC2086 - openssl dgst $OPENSSL_ENGINE $OPENSSL_KEYFORM -"$ALG" -binary "$FILE" >> "$FILE.tmp" - cmd="openssl dgst $OPENSSL_ENGINE $OPENSSL_KEYFORM -$ALG -verify ${verifykey} \ - -signature $FILE.sig2 $FILE.tmp" + openssl dgst $OPENSSL_ENGINE $OPENSSL_KEYFORM -"$ALG" -binary "$FILE" \ + >> "$FILE.ima_file_id" + + case "${KEY:0:10}" in + "test-mldsa") + # ML-DSA does not accept a hash algorithm on command line + cmd="openssl dgst $OPENSSL_ENGINE $OPENSSL_KEYFORM -verify ${verifykey} \ + -signature $FILE.sig2 $FILE.ima_file_id" + ;; + *) + cmd="openssl dgst $OPENSSL_ENGINE $OPENSSL_KEYFORM -$ALG -verify ${verifykey} \ + -signature $FILE.sig2 $FILE.ima_file_id" + esac sigver=3 else cmd="openssl dgst $OPENSSL_ENGINE $OPENSSL_KEYFORM -$ALG -verify ${verifykey} \
@@ -232,11 +249,11 @@ check_sign() { color_red_on_failure echo "Signature v${sigver} verification with openssl is failed." color_restore - rm "$FILE.sig2" "$FILE.tmp" + rm "$FILE.sig2" "$FILE.ima_file_id" return "$FAIL" fi - rm "$FILE.sig2" "$FILE.tmp" + rm "$FILE.sig2" "$FILE.ima_file_id" return "$OK" }
@@ -424,6 +441,13 @@ sign_verify prime256v1 sha256 0x030304:K:004[345678] --v3 sign_verify prime256v1 sha384 0x030305:K:004[345678] --v3 sign_verify prime256v1 sha512 0x030306:K:004[345678] --v3 +sign_verify mldsa44 sha256 0x030304:K:0974 --v3 +sign_verify mldsa44 sha384 0x030305:K:0974 --v3 +sign_verify mldsa44 sha512 0x030306:K:0974 --v3 +sign_verify mldsa65 sha256 0x030304:K:0ced --v3 +sign_verify mldsa65 sha384 0x030305:K:0ced --v3 +sign_verify mldsa65 sha512 0x030306:K:0ced --v3 + # If openssl 3.0 is installed, test the SM2/3 algorithm combination ssl_major_version=$(openssl version | sed -n 's/^OpenSSL \([^\.]\).*/\1/p') if [ "${ssl_major_version}" = 3 ]; then
Signature · 1 line
2.53.0