add engine keys keys
v2 cover add engine keys keys
Engine keys are an openssl concept for a key file which can only be understood by an engine (usually because it's been wrapped by the engine itself). We use this for TPM engine keys, so you can either generate them within your TPM or wrap them from existing private keys.
Once wrapped, the keys will only function in the TPM that generated
them, so it means the VPN keys are tied to the physical platform, which is very useful. Engine keys have to be loaded via a specific callback, so use this as a fallback in openvpn if an engine is specified and if the PEM read of the private key fails.
James Bottomley (1):
openssl: add engine method for loading the key
src/openvpn/crypto_openssl.c | 55 ++++++++++++++++++++++++++++++++++++++++++++ src/openvpn/crypto_openssl.h | 12 ++++++++++ src/openvpn/ssl_openssl.c | 6 ++++- 3 files changed, 72 insertions(+), 1 deletion(-)
Signature · 1 line
2.12.3
PATCH v2 1/1 openssl: add engine method for loading the key
As well as doing crypto acceleration, engines can also be used to load key files. If the engine is set, and the private key loading fails for bio methods, this patch makes openvpn try to get the engine to load the key. If that succeeds, we end up using an engine based key. This can be used with the openssl tpm engines to make openvpn use a TPM wrapped key file.
---
v2: add better configuration guarding
--- src/openvpn/crypto_openssl.c | 55 ++++++++++++++++++++++++++++++++++++++++++++ src/openvpn/crypto_openssl.h | 12 ++++++++++ src/openvpn/ssl_openssl.c | 6 ++++- 3 files changed, 72 insertions(+), 1 deletion(-)
src/openvpn/crypto_openssl.c +55 -0
@@ -969,4 +969,59 @@ hmac_ctx_final(HMAC_CTX *ctx, uint8_t *dst)HMAC_Final (ctx, dst, &in_hmac_len); } +#if HAVE_OPENSSL_ENGINE +static int +ui_read (UI *ui,UI_STRING *uis) +{ +SSL_CTX *ctx =UI_get0_user_data (ui); + +if (UI_get_string_type (uis) ==UIT_PROMPT ) { +pem_password_cb *cb =SSL_CTX_get_default_passwd_cb (ctx); +void *d =SSL_CTX_get_default_passwd_cb_userdata (ctx); +char password[64 ]; + +cb (password,sizeof (password),0 , d); +UI_set_result (ui, uis, password); + +return 1 ; + } +return 0 ; +} +#endif + +EVP_PKEY * +engine_load_key (const char *file,SSL_CTX *ctx) +{ +#if HAVE_OPENSSL_ENGINE +UI_METHOD *ui; +EVP_PKEY *pkey; + +if (!engine_persist) +return NULL ; + + ui =UI_create_method ("openvpn" ); + +if (!ui) +return NULL ; + +UI_method_set_reader (ui, ui_read); + +ERR_clear_error ();/* BIO read failure */ +if (!ENGINE_init (engine_persist)) { +ERR_print_errors_fp (stderr); + pkey =NULL ; + goto out; + } + pkey =ENGINE_load_private_key (engine_persist, file, ui, ctx); +ENGINE_finish (engine_persist); +if (!pkey) +ERR_print_errors_fp (stderr); + out: +UI_destroy_method (ui); +return pkey; +#else +return NULL ; +#endif +} +#endif /* ENABLE_CRYPTO_OPENSSL */
src/openvpn/crypto_openssl.h +12 -0
@@ -101,5 +101,17 @@ void crypto_print_openssl_errors(const unsigned int flags);msg ((flags), __VA_ARGS__); \ } while (false) +/** +* Load a key file from an engine +* +* @param file The engine file to load +* @param ui The UI method for the password prompt +* @param data The data to pass to the UI method +* +* @return The private key if successful or NULL if not +*/ +EVP_PKEY * +engine_load_key(const char *file, SSL_CTX *ctx); +#endif /* CRYPTO_OPENSSL_H_ */
src/openvpn/ssl_openssl.c +5 -1
@@ -873,7 +873,11 @@ tls_ctx_load_priv_file(struct tls_root_ctx *ctx, const char *priv_key_file, SSL_CTX_get_default_passwd_cb_userdata(ctx->ctx));if (!pkey) { - goto end; + pkey =engine_load_key (priv_key_file, ctx->ctx); +if (!pkey) + { + goto end; + } }if (!SSL_CTX_use_PrivateKey (ssl_ctx, pkey))
Signature · 1 line
2.12.3