From: "MaxF (Code Review)" Date: Tue, 20 May 2025 13:06:24 +0000 References: Reply-To: max@...2606..., arne-openvpn@...1227..., openvpn-devel@lists.sourceforge.net, frank@...2641... Message-ID: <034d2350aff4f6b4b471ee552d0d263ba0ed8dde-HTML@...2715...> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Disposition: inline Content-Type: multipart/alternative; boundary="t+Zbfjmgvlk="; charset=UTF-8 Subject: [Openvpn-devel] [M] Change in openvpn[master]: Use mbedtls_ssl_export_keying_material() List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: plaisthos , flichtenheld Cc: openvpn-devel --t+Zbfjmgvlk= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Attention is currently required from: flichtenheld, plaisthos. Hello plaisthos, flichtenheld, I'd like you to do a code review. Please visit http://gerrit.openvpn.net/c/openvpn/+/1041?usp=3Demail to review the following change. Change subject: Use mbedtls_ssl_export_keying_material() ...................................................................... Use mbedtls_ssl_export_keying_material() Mbed TLS now has an implementation of the TLS-Exporter feature (though not yet in a released version). Use it if it's available. Change-Id: I1204bc2ff85952160a86f0b9d1caae90e5065bc4 Signed-off-by: Max Fillinger --- M CMakeLists.txt M configure.ac M src/openvpn/ssl_mbedtls.c M src/openvpn/ssl_mbedtls.h 4 files changed, 48 insertions(+), 18 deletions(-) git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/41/1041/1 diff --git a/CMakeLists.txt b/CMakeLists.txt index 40bffd4..0744eb4 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -302,6 +302,7 @@ check_symbol_exists(mbedtls_ctr_drbg_update_ret mbedtls/ctr_drbg.h HAV= E_MBEDTLS_CTR_DRBG_UPDATE_RET) check_symbol_exists(mbedtls_ssl_conf_export_keys_ext_cb mbedtls/ssl.h = HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB) check_symbol_exists(mbedtls_ssl_set_export_keys_cb mbedtls/ssl.h HAVE_= MBEDTLS_SSL_SET_EXPORT_KEYS_CB) + check_symbol_exists(mbedtls_ssl_export_keying_material mbedtls/ssl.h H= AVE_MBEDTLS_SSL_EXPORT_KEYING_MATERIAL) check_include_files(psa/crypto.h HAVE_MBEDTLS_PSA_CRYPTO_H) endfunction() diff --git a/configure.ac b/configure.ac index 75367e8..daaf202 100644 --- a/configure.ac +++ b/configure.ac @@ -1065,19 +1065,28 @@ ) have_export_keying_material=3D"yes" + AC_CHECK_FUNC( - [mbedtls_ssl_conf_export_keys_ext_cb], - [AC_DEFINE([HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB], [1], [yes])], - [AC_DEFINE([HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB], [0], [no])] + [mbedtls_ssl_export_keying_material], + AC_DEFINE([HAVE_MBEDTLS_SSL_EXPORT_KEYING_MATERIAL], [1], + [Have mbedtls_ssl_export_keying_material]) ) - if test "x$ac_cv_func_mbedtls_ssl_conf_export_keys_ext_cb" !=3D xyes; then + + if test "x$ac_cv_func_mbedtls_ssl_export_keying_material" !=3D xyes; then AC_CHECK_FUNC( - [mbedtls_ssl_set_export_keys_cb], - [AC_DEFINE([HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB], [1], [yes])], - [AC_DEFINE([HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB], [0], [no])] + [mbedtls_ssl_conf_export_keys_ext_cb], + [AC_DEFINE([HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB], [1], [yes])], + [AC_DEFINE([HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB], [0], [no])] ) - if test "x$ac_cv_func_mbedtls_ssl_set_export_keys_cb" !=3D xyes; then - have_export_keying_material=3D"no" + if test "x$ac_cv_func_mbedtls_ssl_conf_export_keys_ext_cb" !=3D xyes; th= en + AC_CHECK_FUNC( + [mbedtls_ssl_set_export_keys_cb], + [AC_DEFINE([HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB], [1], [yes])], + [AC_DEFINE([HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB], [0], [no])] + ) + if test "x$ac_cv_func_mbedtls_ssl_set_export_keys_cb" !=3D xyes; then + have_export_keying_material=3D"no" + fi fi fi diff --git a/src/openvpn/ssl_mbedtls.c b/src/openvpn/ssl_mbedtls.c index ec3135a..ab4b20c 100644 --- a/src/openvpn/ssl_mbedtls.c +++ b/src/openvpn/ssl_mbedtls.c @@ -253,8 +253,8 @@ memcpy(cache->master_secret, secret, sizeof(cache->master_secret)); cache->tls_prf_type =3D tls_prf_type; } -#else /* if HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB */ -#error either HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB or HAVE_MBEDTLS_SSL= _SET_EXPORT_KEYS_CB must be defined when HAVE_EXPORT_KEYING_MATERIAL is def= ined +#elif !HAVE_MBEDTLS_SSL_EXPORT_KEYING_MATERIAL +#error HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB, HAVE_MBEDTLS_SSL_SET_EXPO= RT_KEYS_CB or HAVE_MBEDTLS_SSL_EXPORT_KEYING_MATERIAL must be set when HAVE= _EXPORT_KEYING_MATERIAL is defined #endif /* HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB */ bool @@ -264,6 +264,20 @@ { ASSERT(strlen(label) =3D=3D label_size); +#if HAVE_MBEDTLS_SSL_EXPORT_KEYING_MATERIAL + /* Our version of mbed TLS has a built-in TLS-Exporter. */ + + mbedtls_ssl_context *ctx =3D session->key[KS_PRIMARY].ks_ssl.ctx; + if (mbed_ok(mbedtls_ssl_export_keying_material(ctx, ekm, ekm_size, lab= el, label_size, NULL, 0, 0))) + { + return true; + } + else + { + return false; + } + +#else struct tls_key_cache *cache =3D &session->key[KS_PRIMARY].ks_ssl.tls_k= ey_cache; /* If the type is NONE, we either have no cached secrets or @@ -288,7 +302,9 @@ secure_memzero(ekm, session->opt->ekm_size); return false; } +#endif /* HAVE_MBEDTLS_SSL_EXPORT_KEYING_MATERIAL */ } + #else /* ifdef HAVE_EXPORT_KEYING_MATERIAL */ bool key_state_export_keying_material(struct tls_session *session, @@ -1238,7 +1254,7 @@ mbedtls_ssl_conf_max_tls_version(ks_ssl->ssl_config, version); } -#if HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB +#if HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB && !HAVE_MBEDTLS_SSL_EXPORT_K= EYING_MATERIAL /* Initialize keying material exporter, old style. */ mbedtls_ssl_conf_export_keys_ext_cb(ks_ssl->ssl_config, mbedtls_ssl_export_keys_cb, sessio= n); @@ -1253,7 +1269,7 @@ * verification. */ ASSERT(mbed_ok(mbedtls_ssl_set_hostname(ks_ssl->ctx, NULL))); -#if HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB +#if HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB && !HAVE_MBEDTLS_SSL_EXPORT_KEYING= _MATERIAL /* Initialize keying material exporter, new style. */ mbedtls_ssl_set_export_keys_cb(ks_ssl->ctx, mbedtls_ssl_export_keys_cb= , session); #endif diff --git a/src/openvpn/ssl_mbedtls.h b/src/openvpn/ssl_mbedtls.h index ec30bb5..309dc7ce 100644 --- a/src/openvpn/ssl_mbedtls.h +++ b/src/openvpn/ssl_mbedtls.h @@ -85,16 +85,20 @@ void *sign_ctx; }; -#ifdef HAVE_EXPORT_KEYING_MATERIAL -/** struct to cache TLS secrets for keying material exporter (RFC 5705). - * The constants (64 and 48) are inherent to TLS version and - * the whole keying material export will likely change when they change */ +#if defined(HAVE_EXPORT_KEYING_MATERIAL) && !HAVE_MBEDTLS_SSL_EXPORT_KEYIN= G_MATERIAL +/** + * struct to cache TLS secrets for keying material exporter (RFC 5705). + * Not needed if the library itself implements the keying material exporte= r, + * or if we can't obtain the secrets anyway. + * + * The constants 64 and 48 are inherent to TLS 1.2. For TLS 1.3, it is not + * possible to obtain the exporter master secret from mbed TLS. */ struct tls_key_cache { unsigned char client_server_random[64]; mbedtls_tls_prf_types tls_prf_type; unsigned char master_secret[48]; }; -#else /* ifdef HAVE_EXPORT_KEYING_MATERIAL */ +#else /* if defined(HAVE_EXPORT_KEYING_MATERIAL) && !HAVE_MBEDTLS_SSL_EXP= ORT_KEYING_MATERIAL */ struct tls_key_cache { }; #endif -- To view, visit http://gerrit.openvpn.net/c/openvpn/+/1041?usp=3Demail To unsubscribe, or for help writing mail filters, visit http://gerrit.openv= pn.net/settings Gerrit-Project: openvpn Gerrit-Branch: master Gerrit-Change-Id: I1204bc2ff85952160a86f0b9d1caae90e5065bc4 Gerrit-Change-Number: 1041 Gerrit-PatchSet: 1 Gerrit-Owner: MaxF Gerrit-Reviewer: flichtenheld Gerrit-Reviewer: plaisthos Gerrit-CC: openvpn-devel Gerrit-Attention: plaisthos Gerrit-Attention: flichtenheld Gerrit-MessageType: newchange --t+Zbfjmgvlk= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

Attention is currently required from: flichtenheld, plaisthos.

MaxF would like plaisthos and flichtenheld to review th= is change.

V= iew Change

Use mbedtls_ssl_export_keying_material()

Mbed TLS now= has an implementation of the TLS-Exporter feature (though
not yet in a = released version). Use it if it's available.

Change-Id: I1204bc2= ff85952160a86f0b9d1caae90e5065bc4
Signed-off-by: Max Fillinger <maxim= ilian.fillinger@...2507...>
---
M CMakeLists.txt
M configure.ac=
M src/openvpn/ssl_mbedtls.c
M src/openvpn/ssl_mbedtls.h
4 files c= hanged, 48 insertions(+), 18 deletions(-)

git pull ssh://gerrit.o=
penvpn.net:29418/openvpn refs/changes/41/1041/1
diff --git a/CMakeL=
ists.txt b/CMakeLists.txt
index 40bffd4..0744eb4 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -302,6 +302,7 @@
check_symbol_exists(mb= edtls_ctr_drbg_update_ret mbedtls/ctr_drbg.h HAVE_MBEDTLS_CTR_DRBG_UPDATE_R= ET)
check_symbol_exists(mbedtls_ssl_conf_export_keys_e= xt_cb mbedtls/ssl.h HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB)
check_symbol_exists(mbedtls_ssl_set_export_keys_cb mbedtls/ssl.h HA= VE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB)

+ check_symbol_exists(mbedtls_ssl_export_keying_material m= bedtls/ssl.h HAVE_MBEDTLS_SSL_EXPORT_KEYING_MATERIAL)
= check_include_files(psa/crypto.h HAVE_MBEDTLS_PSA_CRYPTO_H)
endfunction()


diff --git a/configure.ac= b/configure.ac
index 75367e8..daaf202 100644
--- a/configure.ac
+++ b/configure.ac
@@= -1065,19 +1065,28 @@
)

have_export_keying_material=3D"yes"
+
AC_CHECK_FUNC(
- [mbedtls_ssl_conf_export_keys_ex= t_cb],
- [AC_DEFINE([H= AVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB], [1], [yes])],
- [AC_DEFINE([HAVE_MBEDTLS_SSL_CONF_EXPOR= T_KEYS_EXT_CB], [0], [no])]
+ [mbedtls_ssl_export_keying_material],
+ AC_DEFINE([HAVE_MBEDTLS_SSL_EXPORT_KEYING_MAT= ERIAL], [1],
+ [Hav= e mbedtls_ssl_export_keying_material])
)
- if test "x$ac_cv_func_mbedtls_ss= l_conf_export_keys_ext_cb" !=3D xyes; then
+
+ if test "x$ac_cv_func_mbedtls_ssl_export_keying_material&quo= t; !=3D xyes; then
AC_CHECK_FUNC(
- [mbedtls_ssl_set_export_keys_cb],=
- [AC_DEFINE([HAVE_MBEDTLS_= SSL_SET_EXPORT_KEYS_CB], [1], [yes])],
- [AC_DEFINE([HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB], [0], = [no])]
+ [mbedtls_s= sl_conf_export_keys_ext_cb],
+ [AC_DEFINE([HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB], [1], [ye= s])],
+ [AC_DEFINE(= [HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB], [0], [no])]
= )
- if test "x$ac= _cv_func_mbedtls_ssl_set_export_keys_cb" !=3D xyes; then
- have_export_keying_material=3D&q= uot;no"
+ if te= st "x$ac_cv_func_mbedtls_ssl_conf_export_keys_ext_cb" !=3D xyes; = then
+ AC_CHECK_FUN= C(
+ [mbedtls_ssl_= set_export_keys_cb],
= + [AC_DEFINE([HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB], [1], [yes])],=
+ [AC_DEFINE([HAVE_MBEDT= LS_SSL_SET_EXPORT_KEYS_CB], [0], [no])]
+ )
+ if test "x$ac_cv_func_mbedtls_ssl_set_export_keys_cb" != =3D xyes; then
+ h= ave_export_keying_material=3D"no"
+ fi
fi
fi


diff --git a/src/openvpn/ssl_mbedtls.c b/sr= c/openvpn/ssl_mbedtls.c
index ec3135a..ab4b20c 100644

--- a/src/openvpn/ssl_mbedtls.c
+++ b/src/openvp= n/ssl_mbedtls.c
@@ -253,8 +253,8 @@
me= mcpy(cache->master_secret, secret, sizeof(cache->master_secret));

cache->tls_prf_type =3D tls_prf_type;
= }
-#else /* if HAVE_M= BEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB */
-#error either HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB or H= AVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB must be defined when HAVE_EXPORT_KEYING_= MATERIAL is defined
+= #elif !HAVE_MBEDTLS_SSL_EXPORT_KEYING_MATERIAL
+#error HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB,= HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB or HAVE_MBEDTLS_SSL_EXPORT_KEYING_MATE= RIAL must be set when HAVE_EXPORT_KEYING_MATERIAL is defined
#endif /* HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB */
<= /span>
bool
@@ -264,6 +264,20 @@
= {
ASSERT(strlen(label) =3D=3D label_size);
=
+#if HAVE_MBE= DTLS_SSL_EXPORT_KEYING_MATERIAL
+ /* Our version of mbed TLS has a built-in TLS-Exporter. */<= /span>
+
+ mbedtls_ssl_context *ctx =3D sessio= n->key[KS_PRIMARY].ks_ssl.ctx;
+ if (mbed_ok(mbedtls_ssl_export_keying_material(ctx, ekm, = ekm_size, label, label_size, NULL, 0, 0)))
+ {
+ return true;
+ }
+ = else
+ {+ return false;<= br>+ }
+
+#else
struct tls_key_cache *cache =3D &= amp;session->key[KS_PRIMARY].ks_ssl.tls_key_cache;

/* If the type is NONE, we either have no cached secrets = or
@@ -288,7 +302,9 @@
secure_memz= ero(ekm, session->opt->ekm_size);
return fal= se;
}
+#endif /* HAVE_MBEDTLS_SSL_EXPORT_KEYING_MATERIAL */
}

+
#else /* ifdef HAVE_EXPORT_KEYING_MATERIAL */

bool
key_state_export_keying_material(struct tls_session *session,=
@@ -1238,7 +1254,7 @@
mbedtls_ssl= _conf_max_tls_version(ks_ssl->ssl_config, version);
= }

-#= if HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB
+#if HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB &&= amp; !HAVE_MBEDTLS_SSL_EXPORT_KEYING_MATERIAL
/* Initi= alize keying material exporter, old style. */
mbedtls_= ssl_conf_export_keys_ext_cb(ks_ssl->ssl_config,
= mbedtls_ssl_export_keys_cb, session);

@@ -1253,7 +1269,7 @@
* verification. */<= /span>
ASSERT(mbed_ok(mbedtls_ssl_set_hostname(ks_ssl->ctx= , NULL)));

-#if HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB
+#if HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB &&am= p; !HAVE_MBEDTLS_SSL_EXPORT_KEYING_MATERIAL
/* Initial= ize keying material exporter, new style. */
mbedtls_ss= l_set_export_keys_cb(ks_ssl->ctx, mbedtls_ssl_export_keys_cb, session);<= /span>
#endif
diff --git a/src/openvpn/ssl_mbedtl= s.h b/src/openvpn/ssl_mbedtls.h
index ec30bb5..309dc7ce 100= 644
--- a/src/openvpn/ssl_mbedtls.h
+++ b/s= rc/openvpn/ssl_mbedtls.h
@@ -85,16 +85,20 @@
void *sign_ctx;

};

-#ifdef HAVE_EXPORT_KEYING_MATERIAL
-/** struct to cache TLS= secrets for keying material exporter (RFC 5705).
- * The constants (64 and 48) are inherent to TL= S version and
- * the w= hole keying material export will likely change when they change */+#if defined(HAVE_EXPORT_KEYI= NG_MATERIAL) && !HAVE_MBEDTLS_SSL_EXPORT_KEYING_MATERIAL
= +/**
+ * struct to cache TLS secrets for keying mate= rial exporter (RFC 5705).
+ * Not needed if the library itself implements the keying material ex= porter,
+ * or if we = can't obtain the secrets anyway.
+ *
+= * The constants 64 and 48 are inherent to TLS 1.2. For TLS 1.3, it is not<= /span>
+ * possible to obtai= n the exporter master secret from mbed TLS. */
struct tls_= key_cache {
unsigned char client_server_random[64];
mbedtls_tls_prf_types tls_prf_type;
= unsigned char master_secret[48];
};
-#else /* ifdef HAVE_EXPORT_KEYING_MATERIAL= */
+#else /* if def= ined(HAVE_EXPORT_KEYING_MATERIAL) && !HAVE_MBEDTLS_SSL_EXPORT_KEYIN= G_MATERIAL */
struct tls_key_cache { };
#= endif


To view, visit = change 1= 041. To unsubscribe, or for help writing mail filters, visit settings.

Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: I1204bc2ff85952160a86f0b9d1c= aae90e5065bc4
Gerrit-Change-Number: 1041
Gerrit-PatchSet: 1
Gerrit-Owner: MaxF <max@...2606...>
Gerrit-Reviewer: flichtenheld <frank@...2716...= 1...>
Gerrit-Reviewer: plaisthos <arne-openvpn@...1186...= .1227...>
Gerrit-CC: openvpn-devel <openvpn-devel@...1484...= ts.sourceforge.net>
Gerrit-Attention: plaisthos <arne-openvpn@...220...= ..1227...>
Gerrit-Attention: flichtenheld <frank@...2375...= 41...>
Gerrit-MessageType: newchange
--t+Zbfjmgvlk=--