Deprecate sign_hash and add provider support
cover Deprecate sign_hash and add provider support
This series deprecates the sign_hash function and introduces imaevm_signhash that requires the necessary parameters to be passed rather than relying on the global imaevm_params variable. This way we can get rid of the usage of imaevm_params for the OpenSSL engine and the keyid. Then add support for an OpenSSL provider. The choice of engine versus provider is implemented using a struct imaevm_ossl_access that wraps the engine or provider parameters. It also provides a type field where the user can choose on or the other. imaevm_signhash takes this structure as an optional parameter to support engines and providers.
Also extend existing test cases with tests with a pkcs11 provider.
Regards,
Stefan
Stefan Berger (6):
headers: Remove usage of CONFIG_IMA_EVM_ENGINE from public header Pass ENGINE and keyid through to function using them
evmctl: Replace deprecated sign_hash with imaevm_signhash Add support for OpenSSL provider to the library and evmctl
tests: Add pkcs11 test using provider
ci: Install pkcs11-provider where available
ci/alt.sh | 2 + ci/debian.sh | 1 + ci/fedora.sh | 1 + ci/tumbleweed.sh | 2 + configure.ac | 6 ++ src/Makefile.am | 21 +++- src/evmctl.c | 124 ++++++++++++++++++------ src/imaevm.h | 39 +++++++- src/libimaevm.c | 215 ++++++++++++++++++++++++++++++++++------- tests/functions.sh | 1 - tests/sign_verify.test | 19 +++- 11 files changed, 354 insertions(+), 77 deletions(-)
Signature · 1 line
2.43.0
PATCH 1/6 headers: Remove usage of CONFIG_IMA_EVM_ENGINE from public header
An application including the public header imaevm.h won't know whether CONFIG_IMA_EVM_ENGINE was set during compilation of the library, so remove the usage of CONFIG_IMA_EVM_ENGINE from it.
An application wanting to use the engine will have to find out whether engine support is compiled-in by invoking library functions and possibly dealing with errors if there's no engine support .
--- src/imaevm.h | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-)
src/imaevm.h +3 -5
@@ -48,12 +48,10 @@#include <errno.h> #include <sys/types.h> #include <openssl/rsa.h> -#ifdef CONFIG_IMA_EVM_ENGINE -#include <openssl/engine.h> -#endif +#include <openssl/opensslconf.h> -#if defined(OPENSSL_NO_ENGINE ) || defined(OPENSSL_NO_DYNAMIC_ENGINE ) -#undef CONFIG_IMA_EVM_ENGINE +#if !defined(OPENSSL_NO_ENGINE ) && !defined(OPENSSL_NO_DYNAMIC_ENGINE ) +#include <openssl/engine.h> #endif #ifdef USE_FPRINTF
Signature · 1 line
2.43.0
PATCH 2/6 Pass ENGINE and keyid through to function using them
In reply to Stefan BergerPass the ENGINE and keyid all the way through to the function that is using them and deprecate sign_hash since it needs to pass these parameters from the global imaevm_params.
In anticipation of support for OpenSSL providers, wrap the ENGINE in a union inside a struct imaevm_ossl_access and add a type file dfor the selection of the ENGINE or provider later on.
--- src/imaevm.h | 26 ++++++++- src/libimaevm.c | 142 ++++++++++++++++++++++++++++++++++++------------ 2 files changed, 132 insertions(+), 36 deletions(-)
src/imaevm.h +24 -2
@@ -51,7 +51,10 @@#include <openssl/opensslconf.h> #if !defined(OPENSSL_NO_ENGINE ) && !defined(OPENSSL_NO_DYNAMIC_ENGINE ) -#include <openssl/engine.h> +# include <openssl/engine.h> +#else +struct engine_st ; +typedef struct engine_st ENGINE ;/* unused when no engine support */ #endif #ifdef USE_FPRINTF
@@ -250,7 +253,9 @@ void calc_keyid_v2(uint32_t *keyid, char *str, EVP_PKEY *pkey);int key2bin (RSA *key,unsigned char *pub);uint32_t imaevm_read_keyid (const char *certfile); -int sign_hash (const char *algo,const unsigned char *hash,int size,const char *keyfile,const char *keypass,unsigned char *sig); +IMAEVM_DEPRECATED int sign_hash(const char *algo, const unsigned char *hash, +int size,const char *keyfile,const char *keypass, +unsigned char *sig); IMAEVM_DEPRECATED int ima_calc_hash(const char *file, uint8_t *hash); IMAEVM_DEPRECATED int verify_hash(const char *file, const unsigned char *hash,int size,unsigned char *sig,int siglen);
@@ -259,7 +264,24 @@ IMAEVM_DEPRECATED int ima_verify_signature(const char *file, unsigned char *sig, int digestlen); IMAEVM_DEPRECATED void init_public_keys(const char *keyfiles); +struct imaevm_ossl_access { +int type; +#define IMAEVM_OSSL_ACCESS_TYPE_NONE 0 +#define IMAEVM_OSSL_ACCESS_TYPE_ENGINE 1/* also: engine field exists */ +union { +ENGINE *engine; + } u; +}; + +#define IMAEVM_SIGFLAG_SIGNATURE_V1 (1 << 0)/* v1 signature; deprecated */ +#define IMAEVM_SIGFLAGS_SUPPORT (1 << 0)/* mask of all supported flags */ +int ima_calc_hash2 (const char *file,const char *hash_algo,uint8_t *hash); +int imaevm_signhash (const char *hashalgo,const unsigned char *hash,int size, +const char *keyfile,const char *keypass, +unsigned char *sig,long sigflags, +const struct imaevm_ossl_access *access_info, +uint32_t keyid);int imaevm_verify_hash (struct public_key_entry *public_keys,const char *file,const char *hash_algo,const unsigned char *hash,int size,unsigned char *sig,int siglen);
src/libimaevm.c +108 -34
219 lines not on this page · raw message
Signature · 1 line
2.43.0
PATCH 3/6 evmctl: Replace deprecated sign_hash with imaevm_signhash
In reply to Stefan BergerReplace the deprecated sign_hash with imaevm_signhash.
--- src/evmctl.c | 74 +++++++++++++++++++++++++++++++--------------------- 1 file changed, 44 insertions(+), 30 deletions(-)
src/evmctl.c +44 -30
@@ -147,6 +147,13 @@ static char *g_keypass;#define HMAC_FLAG_CAPS_SET 0x0002static unsigned long hmac_flags; +static uint32_t imaevm_keyid; +static struct imaevm_ossl_access access_info; +static long sigflags; + +static inline bool use_x509 (long sigflags) { +return (sigflags &IMAEVM_SIGFLAG_SIGNATURE_V1 ) ==0 ; +}typedef int (*find_cb_t )(const char *path);static int find (const char *path,int dts,find_cb_t func);
@@ -577,7 +584,8 @@ static int sign_evm(const char *file, char *hash_algo, const char *key)return len;assert (len <=sizeof (hash)); - len =sign_hash (hash_algo, hash, len, key, g_keypass, sig +1 ); + len =imaevm_signhash (hash_algo, hash, len, key, g_keypass, + sig +1 , sigflags, &access_info, imaevm_keyid);if (len <=1 )return len;assert (len <sizeof (sig));
@@ -663,7 +671,8 @@ static int sign_ima(const char *file, char *hash_algo, const char *key)return len;assert (len <=sizeof (hash)); - len =sign_hash (hash_algo, hash, len, key, g_keypass, sig +1 ); + len =imaevm_signhash (hash_algo, hash, len, key, g_keypass, + sig +1 , sigflags, &access_info, imaevm_keyid);if (len <=1 )return len;assert (len <sizeof (sig));
@@ -844,8 +853,9 @@ static int cmd_sign_hash(struct command *cmd)continue ; } - siglen =sign_hash (algo, sigv3_hash, hashlen /2 , - key, g_keypass, sig +1 ); + siglen =imaevm_signhash (algo, sigv3_hash, hashlen /2 , + key, g_keypass, sig +1 , sigflags, + &access_info, imaevm_keyid); sig[0 ] =IMA_VERITY_DIGSIG ; sig[1 ] =DIGSIG_VERSION_3 ;/* sigv3 */
@@ -856,8 +866,10 @@ static int cmd_sign_hash(struct command *cmd)assert (hashlen /2 <=sizeof (hash));hex2bin (hash, line, hashlen /2 ); - siglen =sign_hash (g_hash_algo, hash, - hashlen /2 , key, g_keypass, sig +1 ); + siglen =imaevm_signhash (g_hash_algo, hash, + hashlen /2 , key, g_keypass, + sig +1 , sigflags, + &access_info, imaevm_keyid); sig[0 ] =EVM_IMA_XATTR_DIGSIG ; }
@@ -963,7 +975,7 @@ static int cmd_verify_evm(struct command *cmd)return -1 ; } -if (imaevm_params.x509) { +if (use_x509 (sigflags)) {if (imaevm_params.keyfile)/* Support multiple public keys */ err =imaevm_init_public_keys (imaevm_params.keyfile, &public_keys);
@@ -1026,7 +1038,7 @@ static int cmd_verify_ima(struct command *cmd)return -1 ; } -if (imaevm_params.x509) { +if (use_x509 (sigflags)) {if (imaevm_params.keyfile)/* Support multiple public keys */ err =imaevm_init_public_keys (imaevm_params.keyfile, &public_keys);
@@ -1061,15 +1073,12 @@ static int cmd_convert(struct command *cmd)uint8_t keyid[8 ];RSA *key; - imaevm_params.x509 =0 ; - inkey = g_argv[optind++];if (!inkey) { - inkey = imaevm_params.x509 ?"/etc/keys/x509_evm.der" : -"/etc/keys/pubkey_evm.pem" ; + inkey ="/etc/keys/pubkey_evm.pem" ; } - key =read_pub_key (inkey, imaevm_params.x509); + key =read_pub_key (inkey,0 );if (!key)return 1 ;
@@ -1094,7 +1103,7 @@ static int cmd_import(struct command *cmd) inkey = g_argv[optind++];if (!inkey) { - inkey = imaevm_params.x509 ?"/etc/keys/x509_evm.der" : + inkey =use_x509 (sigflags) ?"/etc/keys/x509_evm.der" :"/etc/keys/pubkey_evm.pem" ; }else ring = g_argv[optind++];
@@ -1124,8 +1133,8 @@ static int cmd_import(struct command *cmd) } } -if (imaevm_params.x509) { -EVP_PKEY *pkey =read_pub_pkey (inkey, imaevm_params.x509); +if (use_x509 (sigflags)) { +EVP_PKEY *pkey =read_pub_pkey (inkey,1 );if (!pkey)return 1 ;
@@ -1138,7 +1147,7 @@ static int cmd_import(struct command *cmd)EVP_PKEY_free (pkey); }else {#if CONFIG_SIGV1 -RSA *key =read_pub_key (inkey, imaevm_params.x509); +RSA *key =read_pub_key (inkey,0 );if (!key)return 1 ;
@@ -1153,8 +1162,8 @@ static int cmd_import(struct command *cmd)log_info ("Importing public key %s from file %s into keyring %d\n" , name, inkey, id); - id =add_key (imaevm_params.x509 ?"asymmetric" :"user" , - imaevm_params.x509 ?NULL : name, pub, len, id); + id =add_key (use_x509 (sigflags) ?"asymmetric" :"user" , +use_x509 (sigflags) ?NULL : name, pub, len, id);if (id <0 ) {log_err ("add_key failed\n" ); err = id;
@@ -3106,7 +3115,7 @@ int main(int argc, char *argv[]) hmac_flags |=HMAC_FLAG_NO_UUID ;break ;case '1' : - imaevm_params.x509 =0 ; + sigflags |=IMAEVM_SIGFLAG_SIGNATURE_V1 ;break ;case 'k' : imaevm_params.keyfile = optarg;
@@ -3172,11 +3181,12 @@ int main(int argc, char *argv[])break ;#if CONFIG_IMA_EVM_ENGINE case 139 :/* --engine e */ - imaevm_params.eng =setup_engine (optarg); -if (!imaevm_params.eng) { + access_info.u.engine =setup_engine (optarg); +if (!access_info.u.engine) {log_info ("setup_engine failed\n" ); goto error; } + access_info.type =IMAEVM_OSSL_ACCESS_TYPE_ENGINE ;break ;#endif case 140 :/* --xattr-user */
@@ -3210,7 +3220,7 @@ int main(int argc, char *argv[])log_err ("Invalid keyid value.\n" );exit (1 ); } - imaevm_params.keyid = keyid; + imaevm_keyid = keyid;break ;case 145 : keyid =imaevm_read_keyid (optarg);
@@ -3218,7 +3228,7 @@ int main(int argc, char *argv[])log_err ("Error reading keyid.\n" );exit (1 ); } - imaevm_params.keyid = keyid; + imaevm_keyid = keyid;break ;case 146 : veritysig =1 ;
@@ -3241,12 +3251,16 @@ int main(int argc, char *argv[]) g_keypass =getenv ("EVMCTL_KEY_PASSWORD" );if (imaevm_params.keyfile !=NULL && - imaevm_params.eng ==NULL && + access_info.type ==IMAEVM_OSSL_ACCESS_TYPE_NONE && !strncmp (imaevm_params.keyfile,"pkcs11:" ,7 )) {#if CONFIG_IMA_EVM_ENGINE - imaevm_params.eng =setup_engine ("pkcs11" ); +if (access_info.type ==IMAEVM_OSSL_ACCESS_TYPE_NONE ) { + access_info.u.engine =setup_engine ("pkcs11" ); +if (access_info.u.engine) + access_info.type =IMAEVM_OSSL_ACCESS_TYPE_ENGINE ; + }#endif -if (!imaevm_params.eng) +if (access_info.type ==IMAEVM_OSSL_ACCESS_TYPE_NONE ) goto error; }
@@ -3272,9 +3286,9 @@ int main(int argc, char *argv[]) error:#if CONFIG_IMA_EVM_ENGINE -if (imaevm_params.eng) { -ENGINE_finish (imaevm_params.eng); -ENGINE_free (imaevm_params.eng); +if (access_info.type ==IMAEVM_OSSL_ACCESS_TYPE_ENGINE ) { +ENGINE_finish (access_info.u.engine); +ENGINE_free (access_info.u.engine);#if OPENSSL_API_COMPAT <0x10100000L ENGINE_cleanup ();#endif
Signature · 1 line
2.43.0
PATCH 4/6 Add support for OpenSSL provider to the library and evmctl
In reply to Stefan BergerAlso implement the --provider option that is useful for testing with provider. It also helps a user to select whether to use an engine or a provider.
--- configure.ac | 6 ++++ src/Makefile.am | 21 +++++++++++--- src/evmctl.c | 50 +++++++++++++++++++++++++++++++++ src/imaevm.h | 9 ++++++ src/libimaevm.c | 73 +++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 155 insertions(+), 4 deletions(-)
configure.ac +6 -0
@@ -61,6 +61,11 @@ AC_ARG_ENABLE(engine, AC_CHECK_LIB([crypto], [ENGINE_init],, [enable_engine=no]) AM_CONDITIONAL([CONFIG_IMA_EVM_ENGINE], [test "x$enable_engine" = "xyes"]) +AC_ARG_ENABLE(provider, + [AS_HELP_STRING([--disable-provider], [build ima-evm-utils without OpenSSL providre support])],,[enable_provider=yes]) + AC_CHECK_LIB([crypto], [OSSL_PROVIDER_load],, [enable_provider=no]) + AM_CONDITIONAL([CONFIG_IMA_EVM_PROVIDER], [test "x$enable_provider" = "xyes"]) + #debug support - yes for a while PKG_ARG_ENABLE(debug, "yes", DEBUG, [Enable Debug support]) if test $pkg_cv_enable_debug = yes; then
@@ -99,6 +104,7 @@ echo " tss2-rc-decode: $ac_cv_lib_tss2_rc_Tss2_RC_Decode" echo " ibmtss: $ac_cv_header_ibmtss_tss_h" echo " sigv1: $enable_sigv1" echo " engine: $enable_engine" +echo " provider: $enable_provider" echo " doc: $have_doc" echo " pandoc: $have_pandoc" echo
src/Makefile.am +17 -4
@@ -7,12 +7,18 @@ libimaevm_la_CPPFLAGS = $(AM_CPPFLAGS) $(LIBCRYPTO_CFLAGS) libimaevm_la_LDFLAGS = -version-info 4:0:0 libimaevm_la_LIBADD = $(LIBCRYPTO_LIBS) +libimaevm_la_CFLAGS = + if CONFIG_SIGV1 -libimaevm_la_CFLAGS = -DCONFIG_SIGV1 +libimaevm_la_CFLAGS += -DCONFIG_SIGV1 endif if CONFIG_IMA_EVM_ENGINE -libimaevm_la_CFLAGS = -DCONFIG_IMA_EVM_ENGINE +libimaevm_la_CFLAGS += -DCONFIG_IMA_EVM_ENGINE +endif + +if CONFIG_IMA_EVM_PROVIDER +libimaevm_la_CFLAGS += -DCONFIG_IMA_EVM_PROVIDER endif include_HEADERS = imaevm.h
@@ -30,14 +36,21 @@ evmctl_CPPFLAGS = $(AM_CPPFLAGS) $(LIBCRYPTO_CFLAGS) evmctl_LDFLAGS = $(LDFLAGS_READLINE) evmctl_LDADD = $(LIBCRYPTO_LIBS) -lkeyutils libimaevm.la +evmctl_CFLAGS = + # Enable IMA signature version 1 if CONFIG_SIGV1 -evmctl_CFLAGS = -DCONFIG_SIGV1 +evmctl_CFLAGS += -DCONFIG_SIGV1 endif # Enable "--engine" support if CONFIG_IMA_EVM_ENGINE -evmctl_CFLAGS = -DCONFIG_IMA_EVM_ENGINE +evmctl_CFLAGS += -DCONFIG_IMA_EVM_ENGINE +endif + +# Enable "--provider" support +if CONFIG_IMA_EVM_PROVIDER +evmctl_CFLAGS += -DCONFIG_IMA_EVM_PROVIDER endif # USE_PCRTSS uses the Intel TSS
src/evmctl.c +50 -0
92 lines not on this page · raw message
src/imaevm.h +9 -0
@@ -57,6 +57,13 @@ struct engine_st;typedef struct engine_st ENGINE ;/* unused when no engine support */ #endif +#if OPENSSL_VERSION_NUMBER >=0x30000000 +# include <openssl/provider.h> +#else +struct ossl_provider_st ; +typedef struct ossl_provider_st OSSL_PROVIDER ; +#endif +#ifdef USE_FPRINTF #define do_log(level, fmt, args...) \ ({ if (level <= imaevm_params.verbose) fprintf(stderr, fmt, ##args); })
@@ -268,8 +275,10 @@ struct imaevm_ossl_access {int type;#define IMAEVM_OSSL_ACCESS_TYPE_NONE 0#define IMAEVM_OSSL_ACCESS_TYPE_ENGINE 1/* also: engine field exists */ +#define IMAEVM_OSSL_ACCESS_TYPE_PROVIDER 2/* also: provider field exists */ union {ENGINE *engine; +OSSL_PROVIDER *provider; } u; };
src/libimaevm.c +73 -0
97 lines not on this page · raw message
Signature · 1 line
2.43.0
Re: [PATCH v1 ima-evm-utils 4/6] Add support for OpenSSL provider to the library and evmctl
Quoted 3 lines · Stefan Berger
Also implement the --provider option that is useful for testing with provider. It also helps a user to select whether to use an engine or a provider.
FYI: When running with provider one may see messages from p11-kit like these here:
# evmctl ima_sign --key 'pkcs11:model=SoftHSM%20v2;manufacturer=SoftHSM%20project;serial=d7ac797325116907;token=swtpm-test;id=%17%C1%25%A7%AF%05%9D%A5%B7%33%79%C1%61%FE%F6%66%10%33%34%C3;object=mykey;type=private?pin-value=1234' --keyid 0x12 --provider pkcs11 --xattr-user testfile hash(sha256): e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855 evm/ima signature: 264 bytes 03020400000012010029e1f64950bd3f86c8bf088231f02fe56edfcd9b7f49c9e1db6bf02ab0239d98c78d875097d66c7bedd94632d1c6a0f3cb4ae620b06a3e32d2a93727a24a6a695367acdfcb6e4eab9d0b59d91c285fe228c9b7b49c2fb423a2c29595e0b07945f8644ba17e958d3352474af9815556d32a484384c278e3d7f981e5bb5eea22133b1be85a86296fdff93461d275074bb3f9b4eac0adc685f49c6a025818b558d6b8fdd5e5102b8a041068dd015009b813a453b2b964437e7e9188c5e09438945480252e1f6cd073621592996a3275372fb92188bd7fb29143e7984ddc3ace634bacc1b7e450b7a20f59066f2bf7ede4f408eaf0db33c4ae407204b24eadb6275d p11-kit: 'bound != NULL' not true at fixed1_C_CloseSession p11-kit: 'bound != NULL' not true at fixed1_C_CloseSession p11-kit: 'bound != NULL' not true at fixed1_C_Finalize
They have also been reported here and I would consider them as harmless: https://github.com/p11-glue/p11-kit/issues/495
Quoted 320 lines
Signed-off-by Stefan Berger <[email protected]>--- configure.ac | 6 ++++ src/Makefile.am | 21 +++++++++++--- src/evmctl.c | 50 +++++++++++++++++++++++++++++++++ src/imaevm.h | 9 ++++++ src/libimaevm.c | 73 +++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 155 insertions(+), 4 deletions(-)configure.ac +6
-0@@ -61,6 +61,11 @@ AC_ARG_ENABLE(engine, AC_CHECK_LIB([crypto], [ENGINE_init],, [enable_engine=no]) AM_CONDITIONAL([CONFIG_IMA_EVM_ENGINE], [test "x$enable_engine" = "xyes"]) +AC_ARG_ENABLE(provider, + [AS_HELP_STRING([--disable-provider], [build ima-evm-utils without OpenSSL providre support])],,[enable_provider=yes]) + AC_CHECK_LIB([crypto], [OSSL_PROVIDER_load],, [enable_provider=no]) + AM_CONDITIONAL([CONFIG_IMA_EVM_PROVIDER], [test "x$enable_provider" = "xyes"]) + #debug support - yes for a while PKG_ARG_ENABLE(debug, "yes", DEBUG, [Enable Debug support]) if test $pkg_cv_enable_debug = yes; then@@ -99,6 +104,7 @@ echo " tss2-rc-decode: $ac_cv_lib_tss2_rc_Tss2_RC_Decode" echo " ibmtss: $ac_cv_header_ibmtss_tss_h" echo " sigv1: $enable_sigv1" echo " engine: $enable_engine" +echo " provider: $enable_provider" echo " doc: $have_doc" echo " pandoc: $have_pandoc" echosrc/Makefile.am +17
-4@@ -7,12 +7,18 @@ libimaevm_la_CPPFLAGS = $(AM_CPPFLAGS) $(LIBCRYPTO_CFLAGS) libimaevm_la_LDFLAGS = -version-info 4:0:0 libimaevm_la_LIBADD = $(LIBCRYPTO_LIBS) +libimaevm_la_CFLAGS = + if CONFIG_SIGV1 -libimaevm_la_CFLAGS = -DCONFIG_SIGV1 +libimaevm_la_CFLAGS += -DCONFIG_SIGV1 endif if CONFIG_IMA_EVM_ENGINE -libimaevm_la_CFLAGS = -DCONFIG_IMA_EVM_ENGINE +libimaevm_la_CFLAGS += -DCONFIG_IMA_EVM_ENGINE +endif + +if CONFIG_IMA_EVM_PROVIDER +libimaevm_la_CFLAGS += -DCONFIG_IMA_EVM_PROVIDER endif include_HEADERS = imaevm.h@@ -30,14 +36,21 @@ evmctl_CPPFLAGS = $(AM_CPPFLAGS) $(LIBCRYPTO_CFLAGS) evmctl_LDFLAGS = $(LDFLAGS_READLINE) evmctl_LDADD = $(LIBCRYPTO_LIBS) -lkeyutils libimaevm.la +evmctl_CFLAGS = + # Enable IMA signature version 1 if CONFIG_SIGV1 -evmctl_CFLAGS = -DCONFIG_SIGV1 +evmctl_CFLAGS += -DCONFIG_SIGV1 endif # Enable "--engine" support if CONFIG_IMA_EVM_ENGINE -evmctl_CFLAGS = -DCONFIG_IMA_EVM_ENGINE +evmctl_CFLAGS += -DCONFIG_IMA_EVM_ENGINE +endif + +# Enable "--provider" support +if CONFIG_IMA_EVM_PROVIDER +evmctl_CFLAGS += -DCONFIG_IMA_EVM_PROVIDER endif # USE_PCRTSS uses the Intel TSSsrc/evmctl.c +50
-0@@ -68,6 +68,9 @@#if CONFIG_IMA_EVM_ENGINE #include <openssl/engine.h> #endif +#if CONFIG_IMA_EVM_PROVIDER +#include <openssl/provider.h> +#endif #include <openssl/x509v3.h> #include "hash_info.h" #include "pcr.h" @@ -2913,6 +2916,9 @@ static void usage(void) " --verify-sig verify measurement list signatures\n" #if CONFIG_IMA_EVM_ENGINE " --engine e preload OpenSSL engine e (such as: gost) is deprecated\n" +#endif +#if CONFIG_IMA_EVM_PROVIDER +" --provider p preload OpenSSL provider (such as: pkcs11)\n" #endif" --ignore-violations ignore ToMToU measurement violations\n" #ifdef DEBUG@@ -2990,6 +2996,9 @@ static struct option opts[] = { {"veritysig", 0, 0, 146}, {"hwtpm", 0, 0, 147}, {"hmackey", 1, 0, 148}, +#if CONFIG_IMA_EVM_PROVIDER + {"provider", 1, 0, 149}, +#endif {} };@@ -3035,6 +3044,25 @@ static char *get_password(void)return password; } + +#if CONFIG_IMA_EVM_PROVIDER +static OSSL_PROVIDER *setup_provider (const char *name) +{ +OSSL_PROVIDER *p =OSSL_PROVIDER_load (NULL , name); + +if (!p) { +log_err ("provider %s isn't available\n" , optarg); +ERR_print_errors_fp (stderr); + }else if (!OSSL_PROVIDER_self_test (p)) { +log_err ("provider %s self test failed\n" , optarg); +ERR_print_errors_fp (stderr); +OSSL_PROVIDER_unload (p); + p =NULL ; + } +return p; +} +#endif +#if CONFIG_IMA_EVM_ENGINE static ENGINE *setup_engine (const char *engine_id) {@@ -3239,6 +3267,16 @@ int main(int argc, char *argv[])case 148 : imaevm_params.hmackeyfile = optarg;break ; +#if CONFIG_IMA_EVM_PROVIDER +case 149 :/* --provider p */ + access_info.u.provider =setup_provider (optarg); +if (!access_info.u.provider) { +log_info ("setup_provider failed\n" ); + goto error; + } + access_info.type =IMAEVM_OSSL_ACCESS_TYPE_PROVIDER ; +break ; +#endif case '?' :exit (1 );break ;@@ -3253,6 +3291,13 @@ int main(int argc, char *argv[])if (imaevm_params.keyfile !=NULL && access_info.type ==IMAEVM_OSSL_ACCESS_TYPE_NONE && !strncmp (imaevm_params.keyfile,"pkcs11:" ,7 )) { +#if CONFIG_IMA_EVM_PROVIDER +if (access_info.type ==IMAEVM_OSSL_ACCESS_TYPE_NONE ) { + access_info.u.provider =setup_provider ("pkcs11" ); +if (access_info.u.provider) + access_info.type =IMAEVM_OSSL_ACCESS_TYPE_PROVIDER ; + } +#endif #if CONFIG_IMA_EVM_ENGINE if (access_info.type ==IMAEVM_OSSL_ACCESS_TYPE_NONE ) { access_info.u.engine =setup_engine ("pkcs11" );@@ -3293,6 +3338,11 @@ error:ENGINE_cleanup (); #endif } +#endif +#if CONFIG_IMA_EVM_PROVIDER +if (access_info.type ==IMAEVM_OSSL_ACCESS_TYPE_PROVIDER ) { +OSSL_PROVIDER_unload (access_info.u.provider); + }#endif ERR_free_strings ();EVP_cleanup ();src/imaevm.h +9
-0@@ -57,6 +57,13 @@ struct engine_st;typedef struct engine_st ENGINE ;/* unused when no engine support */ #endif +#if OPENSSL_VERSION_NUMBER >=0x30000000 +# include <openssl/provider.h> +#else +struct ossl_provider_st ; +typedef struct ossl_provider_st OSSL_PROVIDER ; +#endif +#ifdef USE_FPRINTF #define do_log(level, fmt, args...) \ ({ if (level <= imaevm_params.verbose) fprintf(stderr, fmt, ##args); })@@ -268,8 +275,10 @@ struct imaevm_ossl_access {int type;#define IMAEVM_OSSL_ACCESS_TYPE_NONE 0#define IMAEVM_OSSL_ACCESS_TYPE_ENGINE 1/* also: engine field exists */ +#define IMAEVM_OSSL_ACCESS_TYPE_PROVIDER 2/* also: provider field exists */ union {ENGINE *engine; +OSSL_PROVIDER *provider; } u; };src/libimaevm.c +73
-0@@ -62,6 +62,12 @@#include <openssl/err.h> #include <openssl/engine.h> +#if CONFIG_IMA_EVM_PROVIDER +#include <openssl/provider.h> +#include <openssl/ui.h> +#include <openssl/store.h> +#endif +#include "imaevm.h" #include "hash_info.h" @@ -1064,6 +1070,64 @@ err_engine:#endif } +#ifdef CONFIG_IMA_EVM_PROVIDER +static int ui_get_pin (UI *ui,UI_STRING *uis) +{ +return UI_set_result (ui, uis,UI_get0_user_data (ui)); +} + +static EVP_PKEY *read_priv_pkey_provider (OSSL_PROVIDER *p,const char *keyfile, +const char *keypass,uint32_t keyid) +{ +UI_METHOD *ui_method =NULL ; +OSSL_STORE_INFO *info; +OSSL_STORE_CTX *store; +EVP_PKEY *pkey =NULL ; +int typ; + +if (!keyid) { +log_err ("When using a pkcs11 URI you must provide the keyid with an option\n" ); +return NULL ; + } + +if (keypass) { + ui_method =UI_create_method ("PIN reader" ); +if (!ui_method) +return NULL ; +UI_method_set_reader (ui_method, ui_get_pin); + } + store =OSSL_STORE_open_ex (keyfile,NULL ,"provider=pkcs11" , ui_method, + (void *)keypass,NULL ,NULL ,NULL ); +if (!store) { +log_err ("Failed to open store for provider=pkcs11\n" ); + goto err_provider; + } +for (info =OSSL_STORE_load (store); + info !=NULL && pkey ==NULL ; + info =OSSL_STORE_load (store)) { + typ =OSSL_STORE_INFO_get_type (info); + +switch (typ) { +case OSSL_STORE_INFO_PKEY : + pkey =OSSL_STORE_INFO_get1_PKEY (info); +break ; + } +OSSL_STORE_INFO_free (info); + } +OSSL_STORE_close (store); + +if (!pkey) { +log_err ("Failed to load private key %s\n" , keyfile); + goto err_provider; + } +return pkey; + +err_provider: +output_openssl_errors (); +return NULL ; +} +#endif +static EVP_PKEY *read_priv_pkey (const char *keyfile,const char *keypass,const struct imaevm_ossl_access *access_info,uint32_t keyid)@@ -1077,6 +1141,12 @@ static EVP_PKEY *read_priv_pkey(const char *keyfile, const char *keypass, pkey =read_priv_pkey_engine (access_info->u.engine, keyfile, keypass, keyid);break ; +#ifdef CONFIG_IMA_EVM_PROVIDER +case IMAEVM_OSSL_ACCESS_TYPE_PROVIDER : + pkey =read_priv_pkey_provider (access_info->u.provider, + keyfile, keypass, keyid); +break ; +#endif } }else { fp =fopen (keyfile,"r" );@@ -1331,6 +1401,9 @@ static int check_ossl_access(const struct imaevm_ossl_access *access_info)case IMAEVM_OSSL_ACCESS_TYPE_NONE :#ifdef CONFIG_IMA_EVM_ENGINE case IMAEVM_OSSL_ACCESS_TYPE_ENGINE : +#endif +#ifdef CONFIG_IMA_EVM_PROVIDER +case IMAEVM_OSSL_ACCESS_TYPE_PROVIDER :#endif return 0 ;
PATCH 5/6 tests: Add pkcs11 test using provider
In reply to Stefan BergerAdjust the existing pkcs11 engine test cases to pass --engine pkcs11 via an option (OPTS) to evmctl rather than using a global variable. Then duplicate the pkcs11 engine tests and pass --provider pkcs11 to run the same tests using OpenSSL provider. Also check whether evmctl was compiled with provider support and if the pkcs11 provider is installed.
--- tests/functions.sh | 1 - tests/sign_verify.test | 19 ++++++++++++++++--- 2 files changed, 16 insertions(+), 4 deletions(-)
tests/functions.sh +0 -1
@@ -373,7 +373,6 @@ _softhsm_setup() { PKCS11_KEYURI=$(echo "$msg" | sed -n 's|^keyuri: \(.*\)|\1|p') export PKCS11_KEYURI - export EVMCTL_ENGINE="--engine pkcs11" export OPENSSL_ENGINE="-engine pkcs11" export OPENSSL_KEYFORM="-keyform engine" else
tests/sign_verify.test +16 -3
@@ -439,11 +439,24 @@ expect_fail \ # Test signing with key described by pkcs11 URI _softhsm_setup "${WORKDIR}" if [ -n "${PKCS11_KEYURI}" ]; then - expect_pass check_sign FILE=pkcs11test TYPE=ima KEY="${PKCS11_KEYURI}" ALG=sha256 PREFIX=0x030204aabbccdd0100 OPTS=--keyid=aabbccdd - expect_pass check_sign FILE=pkcs11test TYPE=ima KEY="${PKCS11_KEYURI}" ALG=sha1 PREFIX=0x030202aabbccdd0100 OPTS=--keyid=aabbccdd + expect_pass check_sign FILE=pkcs11test TYPE=ima KEY="${PKCS11_KEYURI}" ALG=sha256 PREFIX=0x030204aabbccdd0100 OPTS="--keyid=aabbccdd --engine pkcs11" + expect_pass check_sign FILE=pkcs11test TYPE=ima KEY="${PKCS11_KEYURI}" ALG=sha1 PREFIX=0x030202aabbccdd0100 OPTS="--keyid=aabbccdd --engine pkcs11" + + # provider may not be supported or pkcs11 provider not installed + if evmctl --help 2>/dev/null | grep -q provider && \ + openssl list -providers -provider pkcs11 ; then + PKCS11_PRIVKEYURI=${PKCS11_KEYURI//type=public/type=private} + + expect_pass check_sign FILE=pkcs11test TYPE=ima KEY="${PKCS11_PRIVKEYURI}" ALG=sha256 PREFIX=0x030204aabbccdd0100 OPTS="--keyid=aabbccdd --provider pkcs11" + expect_pass check_sign FILE=pkcs11test TYPE=ima KEY="${PKCS11_PRIVKEYURI}" ALG=sha1 PREFIX=0x030202aabbccdd0100 OPTS="--keyid=aabbccdd --provider pkcs11" + else + __skip() { echo "pkcs11 test with provider is skipped since no provider support or pkcs11 not installed"; return "$SKIP"; } + expect_pass __skip + expect_pass __skip + fi else # to have a constant number of tests, skip these two tests - __skip() { echo "pkcs11 test is skipped: could not setup softhsm"; return $SKIP; } + __skip() { echo "pkcs11 test is skipped: could not setup softhsm"; return "$SKIP"; } expect_pass __skip expect_pass __skip fi
Signature · 1 line
2.43.0
PATCH 6/6 ci: Install pkcs11-provider where available
In reply to Stefan BergerInstall the pkcs11-provider package. For it to be useful softhsm and gnutls are also needed, so in some cases install them together so that if one of the packages cannot be installed then none of them are installed.
--- ci/alt.sh | 2 ++ ci/debian.sh | 1 + ci/fedora.sh | 1 + ci/tumbleweed.sh | 2 ++ 4 files changed, 6 insertions(+)
ci/alt.sh +2 -0
@@ -27,3 +27,5 @@ apt-get install -y \ xsltproc \ xxd \ && control openssl-gost enabled + +apt-get install -y pkcs11-provider || true
ci/debian.sh +1 -0
@@ -59,3 +59,4 @@ $apt \ $apt xxd || $apt vim-common $apt libengine-gost-openssl1.1$ARCH || true $apt softhsm gnutls-bin libengine-pkcs11-openssl1.1$ARCH || true +$apt softhsm gnutls-bin pkcs11-provider || true
ci/fedora.sh +1 -0
@@ -60,6 +60,7 @@ if [ -f /etc/centos-release ]; then yum -y install epel-release fi yum -y install softhsm || true +yum -y install softhsm pkcs11-provider || true # haveged is available via EPEL on CentOS stream8. yum -y install haveged || true
ci/tumbleweed.sh +2 -0
@@ -48,6 +48,8 @@ zypper --non-interactive install --force-resolution --no-recommends \ zypper --non-interactive install --force-resolution --no-recommends \ gnutls openssl-engine-libp11 softhsm || true +zypper --non-interactive install --force-resolution --no-recommends \ + gnutls pkcs11-provider softhsm || true if [ -f /usr/lib/ibmtss/tpm_server -a ! -e /usr/local/bin/tpm_server ]; then ln -s /usr/lib/ibmtss/tpm_server /usr/local/bin
Signature · 1 line
2.43.0