Simplify key material exporter backend API
PATCH 1/1 Simplify key material exporter backend API
Just pass pointer and length, instead of a gc and return (possibly) allocated memory. Saves us some gc instantiations and memcpy()s. Exact same functionality, 19 lines less code.
(Didn't want to delay the TLS EKM reviews for this, so submitted as a patch afterwards.)
--- src/openvpn/ssl.c | 26 ++++++++------------------ src/openvpn/ssl_backend.h | 14 +++++--------- src/openvpn/ssl_mbedtls.c | 12 +++++------- src/openvpn/ssl_openssl.c | 11 ++++------- 4 files changed, 22 insertions(+), 41 deletions(-)
src/openvpn/ssl.c +8 -18
@@ -1786,23 +1786,14 @@ init_key_contexts(struct key_ctx_bi *key,static bool generate_key_expansion_tls_export (struct tls_session *session,struct key2 *key2) { -struct gc_arena gc =gc_new (); -unsigned char *key2data; - - key2data =key_state_export_keying_material (session, -EXPORT_KEY_DATA_LABEL , -strlen (EXPORT_KEY_DATA_LABEL ), -sizeof (key2->keys), - &gc); -if (!key2data) +if (!key_state_export_keying_material (session,EXPORT_KEY_DATA_LABEL , +strlen (EXPORT_KEY_DATA_LABEL ), + key2->keys,sizeof (key2->keys))) {return false; } -memcpy (key2->keys, key2data,sizeof (key2->keys)); -secure_memzero (key2data,sizeof (key2->keys)); key2->n =2 ; -gc_free (&gc);return true; }
@@ -2499,12 +2490,11 @@ export_user_keying_material(struct key_state_ssl *ssl,unsigned int size = session->opt->ekm_size;struct gc_arena gc =gc_new (); -unsigned char *ekm; -if ((ekm =key_state_export_keying_material (session, - session->opt->ekm_label, - session->opt->ekm_label_size, - session->opt->ekm_size, - &gc))) +unsigned char *ekm =gc_malloc (session->opt->ekm_size, true, &gc); +if (key_state_export_keying_material (session, + session->opt->ekm_label, + session->opt->ekm_label_size, + ekm, session->opt->ekm_size)) {unsigned int len = (size *2 ) +2 ;
src/openvpn/ssl_backend.h +5 -9
@@ -398,18 +398,14 @@ void backend_tls_ctx_reload_crl(struct tls_root_ctx *ssl_ctx,* @param session The session associated with the given key_state * @param label The label to use when exporting the key * @param label_size The size of the label to use when exporting the key -* @param ekm_size THe size of the exported/returned key material -* @param gc gc_arena that might be used to allocate the string -* returned -* @returns The exported key material, the caller may zero the -* string but should not free it +* @param ekm Buffer to return the exported key material in +* @param ekm_size The size of ekm, in bytes +* @returns true if exporting succeeded, false otherwise */ - -unsigned char * +bool key_state_export_keying_material (struct tls_session *session,const char * label,size_t label_size, -size_t ekm_size, -struct gc_arena *gc) __attribute__((nonnull)); +void *ekm,size_t ekm_size);/**************************************************************************/ /** @addtogroup control_tls
src/openvpn/ssl_mbedtls.c +5 -7
@@ -219,11 +219,10 @@ mbedtls_ssl_export_keys_cb(void *p_expkey, const unsigned char *ms,return true; } -unsigned char * +bool key_state_export_keying_material (struct tls_session *session,const char * label,size_t label_size, -size_t ekm_size, -struct gc_arena *gc) +void *ekm,size_t ekm_size) {ASSERT (strlen (label) == label_size);
@@ -233,10 +232,9 @@ key_state_export_keying_material(struct tls_session *session,* there is no PRF, in both cases we cannot generate key material */ if (cache->tls_prf_type ==MBEDTLS_SSL_TLS_PRF_NONE ) { -return NULL ; +return false; } -unsigned char *ekm = (unsigned char *)gc_malloc (ekm_size, true, gc); int ret = mbedtls_ssl_tls_prf(cache->tls_prf_type, cache->master_secret, sizeof(cache->master_secret), label, cache->client_server_random,
@@ -245,12 +243,12 @@ key_state_export_keying_material(struct tls_session *session,if (mbed_ok (ret)) { -return ekm; +return true; }else {secure_memzero (ekm, session->opt->ekm_size); -return NULL ; +return false; } }#else
src/openvpn/ssl_openssl.c +4 -7
@@ -158,26 +158,23 @@ tls_ctx_initialised(struct tls_root_ctx *ctx)return NULL != ctx->ctx; } -unsigned char * +bool key_state_export_keying_material (struct tls_session *session,const char * label,size_t label_size, -size_t ekm_size, -struct gc_arena *gc) +void *ekm,size_t ekm_size) { -unsigned char *ekm = (unsigned char *)gc_malloc (ekm_size, true, gc); -SSL * ssl = session->key[KS_PRIMARY ].ks_ssl.ssl;if (SSL_export_keying_material (ssl, ekm, ekm_size, label, label_size,NULL ,0 ,0 ) ==1 ) { -return ekm; +return true; }else {secure_memzero (ekm, ekm_size); -return NULL ; +return false; } }
Signature · 1 line
2.25.1
Am 09.10.20 um 16:47 schrieb Steffan Karger:
Quoted 7 lines
Just pass pointer and length, instead of a gc and return (possibly) allocated memory. Saves us some gc instantiations and memcpy()s. Exact same functionality, 19 lines less code.
(Didn't want to delay the TLS EKM reviews for this, so submitted as a patch afterwards.)
I have stared at the code a bit ("amazingly straightforward, no crypto convolutions at all :-)") and tortured the result a bit on the server and client test bed. No complaints.
(I have excercised the "key-derivation tls-ekm" path, but not the generic EKM path - no test case for that one yet... need to add one, it seems)
Your patch has been applied to the master branch.
commit f0734e499562175a6ebbefbfa12b730c976e2507
Author: Steffan Karger Date: Fri Oct 9 16:47:55 2020 +0200
Simplify key material exporter backend API
Signed-off-by: Steffan Karger <[email protected]...>
Acked-by: Arne Schwabe <[email protected]...>
Message-Id: <[email protected]...>
URL: https://www.mail-archive.com/search?l=mid&[email protected]...
Signed-off-by: Gert Doering <[email protected]...>--
kind regards,
Gert Doering