cmpClient.c: add support for ML-DSA and TPM2-held keys referenced via handle

Author: DDvO

doc/Generic_CMP_client_API.odt

@@ -50,9 +50,9 @@ Generic message options:
 
 Certificate enrollment options:
 
-[B<-newkeytype> EC:I<curve>|RSA-I<len>]
+[B<-newkeytype> EC:I<curve>|RSA-I<len>|ML-DSA-<level>]
 [B<-centralkeygen>]
-[B<-newkey> I<filename>]
+[B<-newkey> I<filename>|I<url>]
 [B<-newkeypass> I<arg>]
 [B<-subject> I<name>]
 [B<-issuer> I<name>]
@@ -360,13 +360,21 @@ Note: any keySpec field contents received are logged as INFO.
 =item B<-newkeytype> I<spec>
 
 In case of IR, CR, or KUR,
-generate or request a new key of the given type for the requested certificate.
-The I<spec> may be of the form C<EC:>I<curve> or C<RSA->I<length>.
-The key will be saved in the file specified with the B<-newkey> option.
-
-This option cannot be used to create a key pair via a provider.
-For use with a provider, the key pair must be generated beforehand
-and then can be referenced via B<-newkey>.
+generate or request a new key pair of the given type for the requested certificate.
+The I<spec> may be of the form C<EC:>I<curve>, C<RSA:>I<length>, C<RSA->I<length>, or simply I<length>.
+Everything else is considered an ECC curve name if the OpenSSL version is below 3.5,
+while for OpenSSL 3.5+, it is taken as an algorithm name, potentially including parameters,
+such as C<ED25519> or C<ML-DSA->I<level>.
+For the full list of available algorithms see the output of C<openssl list -public-key-algorithms>.
+The RSA key length must be between 1024 and 8192 bits.
+The available ECC curves can be shown with the command C<openssl ecparam -list_curves>.
+The new key will be saved in the file specified with the B<-newkey> option,
+unless the key is generated on a hardware secure element such as TPM 2.0.
+
+For key generation via the L<tpm2-openssl|https://github.com/tpm2-software/tpm2-openssl> provider, use this option in conjunction
+with the B<-newkey> option having an argument of the form C<tpm2:handle=0x>I<hex-string>.
+The B<-newkeytype> option so far cannot be used to create a key pair via other non-default providers,
+so such a key pair must be generated beforehand and then can be referenced via B<-newkey>.
 
 =item B<-centralkeygen>
 
@@ -375,15 +383,21 @@ This implies B<-popo> C<-1> = NONE.
 All other B<-popo> values are not consistent with this option.
 Default is local key generation.
 
-=item B<-newkey> I<filename>
+=item B<-newkey> I<filename>|I<url>
 
-The file to save the newly generated key
+This option is used only when requesting a certificate via IR, CR, or KUR.
+When a I<filename> or a I<url> in the C<file:> scheme is given,
+this specifies the file to save the newly generated key
 in case B<-newkeytype> or B<-centralkeygen> is given.
-Otherwise the file to read the private or public key from
-for the certificate requested in IR, CR or KUR.
-Defaults to the public key in the PKCS#10 CSR given with the B<-csr> option,
+Otherwise this gives the location (which may be handled by a provider)
+to read the private or public key from for the certificate requested.
+The key defaults to the public key in the PKCS#10 CSR given with the B<-csr> option,
 the public key of the reference certificate, or the current client key.
 
+In conjunction with the B<-newkeytype> option,
+if a I<url> of the form C<tpm2:handle=0x>I<hex-string> is given,
+this specifies key generation and storage via the `tpm2-openssl` provider.
+
 =item B<-newkeypass> I<arg>
 
 Pass phrase source for the key file given with the B<-newkey> option.
@@ -1044,7 +1058,7 @@ Specifies name of supported digest to use in RFC 9810's MSG_SIG_ALG
 and as the one-way function (OWF) in MSG_MAC_ALG.
 If applicable, this is used for message protection and
 Proof-of-Possession (POPO) signatures.
-To see the list of supported digests, use B<openssl list -digest-commands>.
+To see the list of supported digests, use C<openssl list -digest-commands>.
 Defaults to C<sha256>.
 
 =item B<-mac> I<name>

doc/Generic_CMP_client_API.pdf

@@ -269,6 +269,13 @@ void CMPclient_finish(OPTIONAL CMP_CTX *ctx);
 #   include <secutils/credentials/key.h>
 #  endif
 
+/* EVP_PKEY helpers */
+EVP_PKEY *KEY_new(const char *spec); /* may be "RSA:<length>","EC:<curve>","ML-DSA-<level>" */
+EVP_PKEY *KEY_new_ex(const char *spec,
+                     OPTIONAL const char *location, /* may be "tpm2:handle=0x<hex-string>" */
+                     OPTIONAL OSSL_LIB_CTX *libctx);
+void KEY_free(OPTIONAL EVP_PKEY *pkey);
+
 /* X509_STORE helpers */
 EVP_PKEY *KEY_load(OPTIONAL const char *file, OPTIONAL const char *pass,
                    OPTIONAL const char *engine, OPTIONAL const char *desc);

doc/cmpClient.pod

@@ -1840,15 +1840,16 @@ static CMP_err check_set_template_options(CMP_CTX *ctx, EVP_PKEY **new_pkey,
     } else {
         if (opt_newkeytype != NULL || opt_centralkeygen) {
             if (opt_newkey == NULL) {
-                LOG_err("Missing -newkey option specifying the file to save the new key");
+                LOG(FL_ERR, "Missing -newkey option specifying the file to save the new key%s",
+                    opt_centralkeygen ? "" : " (or TPM2 provider handle to use)");
                 return -40;
             }
             if (opt_newkeytype != NULL && *opt_newkeytype != '\0') {
                 /* TODO replace hack: gen preliminary key also when central key gen is requested to quickly get key algorithm identifier */
                 const char *key_spec = strcmp(opt_newkeytype, "ECC") == 0
                     ? "EC:secp256r1" : opt_newkeytype;
 
-                if ((*new_pkey = KEY_new(key_spec)) == NULL) {
+                if ((*new_pkey = KEY_new_ex(key_spec, opt_newkey, app_get0_libctx())) == NULL) {
                     LOG(FL_ERR, "Unable to generate new private key according to specification '%s'",
                         key_spec);
                     return CMP_R_GENERATE_KEY;

include/genericCMPClient.h

@@ -26,6 +26,13 @@ NEED_CACHE_DISABLING,0,0,1,missing chain, -section,, -cmd,ir, -newkey,new.key,,
 0,*,*,*,newkeypass invalid, -section,, -cmd,ir, -newkey,new_pass_12345.key,, -newkeypass,fp:4,,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,, -certout,test.cert.pem,, -out_trusted,root.crt,,BLANK,,BLANK,,,
 1,1,1,1,newkeypass no prefix, -section,, -cmd,ir, -newkey,new_pass_12345.key,, -newkeypass,12345,,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,, -certout,test.cert.pem,, -out_trusted,root.crt,,BLANK,,BLANK,,,
 ,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
+1,1,1,1,newkeytype RSA:2048, -section,, -cmd,ir, -newkey,_RESULT_DIR/new.key,, -newkeypass,pass:,,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,, -reqout_only,_RESULT_DIR/t.der,, -out_trusted,root.crt,,BLANK,,BLANK,,,, -newkeytype,RSA:2048
+0,0,0,0,newkeytype RSA:1023, -section,, -cmd,ir, -newkey,_RESULT_DIR/new.key,, -newkeypass,pass:,,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,, -reqout_only,_RESULT_DIR/t.der,, -out_trusted,root.crt,,BLANK,,BLANK,,,, -newkeytype,RSA:1023
+1,1,1,1,newkeytype EC:secp256r1, -section,, -cmd,ir, -newkey,_RESULT_DIR/new.key,, -newkeypass,pass:,,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,, -reqout_only,_RESULT_DIR/t.der,, -out_trusted,root.crt,,BLANK,,BLANK,,,, -newkeytype,EC:secp256r1
+0,0,0,0,newkeytype unknown-curve, -section,, -cmd,ir, -newkey,_RESULT_DIR/new.key,, -newkeypass,pass:,,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,, -reqout_only,_RESULT_DIR/t.der,, -out_trusted,root.crt,,BLANK,,BLANK,,,, -newkeytype,unknown-curve
+3.5,3.5,3.5,3.5,newkeytype ML-DSA-65, -section,, -cmd,ir, -newkey,_RESULT_DIR/new.key,, -newkeypass,pass:,,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,, -reqout_only,_RESULT_DIR/t.der,, -out_trusted,root.crt,,BLANK,,BLANK,,,, -newkeytype,ML-DSA-65
+3.5 0,3.5 0,3.5 0,3.5 0,newkeytype ML-DSA-43, -section,, -cmd,ir, -newkey,_RESULT_DIR/new.key,, -newkeypass,pass:,,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,, -reqout_only,_RESULT_DIR/t.der,, -out_trusted,root.crt,,BLANK,,BLANK,,,, -newkeytype,ML-DSA-43
+,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
 0,*,*,*,subject argument missing, -section,, -cmd,ir, -newkey,new.key,, -newkeypass,pass:, -subject,BLANK,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,, -certout,test.cert.pem,, -out_trusted,root.crt,,BLANK,,BLANK,,,
 TBD,TBD,TBD OpenSSL 3.0 still uses default,0,subject empty string, -section,, -cmd,ir, -newkey,new.key,, -newkeypass,pass:, -subject,"""",BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,, -certout,test.cert.pem,, -out_trusted,root.crt,,BLANK,,BLANK,,,
 0,0,0,Insta gives status 503 and subsequent responses are errors transactionid unmatched,subject NULL-DN, -section,, -cmd,ir, -newkey,new.key,, -newkeypass,pass:, -subject,/,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,,BLANK,, -certout,test.cert.pem,, -out_trusted,root.crt,,BLANK,,BLANK,,,, -unprotected_errors