From: "plaisthos (Code Review)" Date: Mon, 14 Jul 2025 12:41:25 +0000 In-Reply-To: References: Reply-To: arne-openvpn@...1227..., openvpn-devel@lists.sourceforge.net, frank@...2641... Message-ID: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Disposition: inline Content-Type: multipart/alternative; boundary="CcX2FtxJNQE="; charset=UTF-8 Subject: [Openvpn-devel] [M] Change in openvpn[master]: Cleanup/simplify mbed TLS related define from autoconf List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: flichtenheld Cc: openvpn-devel --CcX2FtxJNQE= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Attention is currently required from: flichtenheld, plaisthos. Hello flichtenheld, I'd like you to reexamine a change. Please visit http://gerrit.openvpn.net/c/openvpn/+/1081?usp=3Demail to look at the new patch set (#5). Change subject: Cleanup/simplify mbed TLS related define from autoconf ...................................................................... Cleanup/simplify mbed TLS related define from autoconf Instead of a custom logic using 0/1 to be defined when the functions are present or not, use the standard check and adjust the source code accordingly. Also not compile mbed key helper with MBEDTLS_SSL_KEYING_MATERIAL_EXPORT The helper methods are only used when we don't have MBEDTLS_SSL_KEYING_MATERIAL_EXPORT and mbedtls_ssl_export_keying_material. Remove AEAD check that tests for presence of mbedtls_cipher_write_tag and mbedtls_cipher_check_tag. Having an mbed TLS version that does not support that is highly unlikely. It might have been a good check in PolarSSL's time but is not today anymore. Change-Id: I0f325800ebeb20bd5ef3ff78e5c5fcf0f6f74efd Signed-off-by: Arne Schwabe --- M config.h.cmake.in M configure.ac M src/openvpn/mbedtls_compat.h M src/openvpn/ssl_mbedtls.c 4 files changed, 18 insertions(+), 36 deletions(-) git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/81/1081/5 diff --git a/config.h.cmake.in b/config.h.cmake.in index 5df0ac8..48807ee 100644 --- a/config.h.cmake.in +++ b/config.h.cmake.in @@ -370,10 +370,10 @@ #undef HAVE_VFORK_H /* Availability of different mbed TLS features and APIs */ -#cmakedefine01 HAVE_MBEDTLS_PSA_CRYPTO_H -#define HAVE_MBEDTLS_SSL_TLS_PRF 1 -#cmakedefine01 HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB -#cmakedefine01 HAVE_MBEDTLS_CTR_DRBG_UPDATE_RET +#cmakedefine HAVE_MBEDTLS_PSA_CRYPTO_H +#cmakedefine HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB +#cmakedefine HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB +#cmakedefine HAVE_MBEDTLS_CTR_DRBG_UPDATE_RET /* Path to ifconfig tool */ #define IFCONFIG_PATH "@IFCONFIG_PATH@" diff --git a/configure.ac b/configure.ac index 02b45f8..51c20ef 100644 --- a/configure.ac +++ b/configure.ac @@ -1044,31 +1044,11 @@ [AC_DEFINE([HAVE_MBEDTLS_PSA_CRYPTO_H], [0], [no])] ) - AC_CHECK_FUNCS( - [ \ - mbedtls_cipher_write_tag \ - mbedtls_cipher_check_tag \ - ], - , - [AC_MSG_ERROR([mbed TLS check for AEAD support failed])] - ) + AC_CHECK_FUNCS([mbedtls_ssl_tls_prf mbedtls_ssl_conf_export_keys_ext_cb]) - AC_CHECK_FUNC( - [mbedtls_ssl_tls_prf], - [AC_DEFINE([HAVE_MBEDTLS_SSL_TLS_PRF], [1], [yes])], - [AC_DEFINE([HAVE_MBEDTLS_SSL_TLS_PRF], [0], [no])] - ) - - 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])] - ) if test "x$ac_cv_func_mbedtls_ssl_conf_export_keys_ext_cb" !=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_set_export_keys_cb] ) if test "x$ac_cv_func_mbedtls_ssl_set_export_keys_cb" !=3D xyes; then AC_CHECK_FUNC([mbedtls_ssl_export_keying_material]) diff --git a/src/openvpn/mbedtls_compat.h b/src/openvpn/mbedtls_compat.h index 145a7ae..68c4cc3 100644 --- a/src/openvpn/mbedtls_compat.h +++ b/src/openvpn/mbedtls_compat.h @@ -48,7 +48,7 @@ #include #include -#if HAVE_MBEDTLS_PSA_CRYPTO_H +#ifdef HAVE_MBEDTLS_PSA_CRYPTO_H #include #endif @@ -61,14 +61,14 @@ static inline void mbedtls_compat_psa_crypto_init(void) { -#if HAVE_MBEDTLS_PSA_CRYPTO_H && defined(MBEDTLS_PSA_CRYPTO_C) +#if defined(HAVE_MBEDTLS_PSA_CRYPTO_H) && defined(MBEDTLS_PSA_CRYPTO_C) if (psa_crypto_init() !=3D PSA_SUCCESS) { msg(M_FATAL, "mbedtls: psa_crypto_init() failed"); } #else return; -#endif /* HAVE_MBEDTLS_PSA_CRYPTO_H && defined(MBEDTLS_PSA_CRYPTO_C) */ +#endif } static inline mbedtls_compat_group_id @@ -96,7 +96,7 @@ { #if MBEDTLS_VERSION_NUMBER > 0x03000000 return mbedtls_ctr_drbg_update(ctx, additional, add_len); -#elif HAVE_MBEDTLS_CTR_DRBG_UPDATE_RET +#elif defined(HAVE_MBEDTLS_CTR_DRBG_UPDATE_RET) return mbedtls_ctr_drbg_update_ret(ctx, additional, add_len); #else mbedtls_ctr_drbg_update(ctx, additional, add_len); diff --git a/src/openvpn/ssl_mbedtls.c b/src/openvpn/ssl_mbedtls.c index ecccc26..a4bb772 100644 --- a/src/openvpn/ssl_mbedtls.c +++ b/src/openvpn/ssl_mbedtls.c @@ -173,8 +173,9 @@ ASSERT(NULL !=3D ctx); return ctx->initialised; } - -#if HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB +#ifdef MBEDTLS_SSL_KEYING_MATERIAL_EXPORT +/* mbedtls_ssl_export_keying_material does not need helper/callback method= s */ +#elif defined(HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB) /* * Key export callback for older versions of mbed TLS, to be used with * mbedtls_ssl_conf_export_keys_ext_cb(). It is called with the master @@ -205,7 +206,7 @@ return 0; } -#elif HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB +#elif defined(HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB) /* * Key export callback for newer versions of mbed TLS, to be used with * mbedtls_ssl_set_export_keys_cb(). When used with TLS 1.2, the callback @@ -251,10 +252,11 @@ memcpy(cache->master_secret, secret, sizeof(cache->master_secret)); cache->tls_prf_type =3D tls_prf_type; } -#elif !defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT) +#else /* ifdef MBEDTLS_SSL_KEYING_MATERIAL_EXPORT */ #error mbedtls_ssl_conf_export_keys_ext_cb, mbedtls_ssl_set_export_keys_cb= or mbedtls_ssl_export_keying_material must be available in mbed TLS #endif /* HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB */ + bool key_state_export_keying_material(struct tls_session *session, const char *label, size_t label_size, @@ -1244,7 +1246,7 @@ mbedtls_ssl_conf_max_tls_version(ks_ssl->ssl_config, version); } -#if HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB && !defined(MBEDTLS_SSL_KEYIN= G_MATERIAL_EXPORT) +#if defined(HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB) && !defined(MBEDTLS_= SSL_KEYING_MATERIAL_EXPORT) /* Initialize keying material exporter, old style. */ mbedtls_ssl_conf_export_keys_ext_cb(ks_ssl->ssl_config, mbedtls_ssl_export_keys_cb, sessio= n); @@ -1259,7 +1261,7 @@ * verification. */ ASSERT(mbed_ok(mbedtls_ssl_set_hostname(ks_ssl->ctx, NULL))); -#if HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB && !defined(MBEDTLS_SSL_KEYING_MAT= ERIAL_EXPORT) +#if defined(HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB) && !defined(MBEDTLS_SSL_K= EYING_MATERIAL_EXPORT) /* Initialize keying material exporter, new style. */ mbedtls_ssl_set_export_keys_cb(ks_ssl->ctx, mbedtls_ssl_export_keys_cb= , session); #endif -- To view, visit http://gerrit.openvpn.net/c/openvpn/+/1081?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: I0f325800ebeb20bd5ef3ff78e5c5fcf0f6f74efd Gerrit-Change-Number: 1081 Gerrit-PatchSet: 5 Gerrit-Owner: plaisthos Gerrit-Reviewer: flichtenheld Gerrit-CC: openvpn-devel Gerrit-Attention: plaisthos Gerrit-Attention: flichtenheld Gerrit-MessageType: newpatchset --CcX2FtxJNQE= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

Attention is currently required from: flichtenheld, plaisthos.

plaisthos uploaded patch set #5 to this change.

<= a href=3D"http://gerrit.openvpn.net/c/openvpn/+/1081?usp=3Demail">View Chan= ge

Cleanup/simplify mbed TLS related define from autoconf

Instea= d of a custom logic using 0/1 to be defined when the functions
are prese= nt or not, use the standard check and adjust the source code
accordingly= .

Also not compile mbed key helper with MBEDTLS_SSL_KEYING_MATERIAL_= EXPORT

The helper methods are only used when we don't have
MB= EDTLS_SSL_KEYING_MATERIAL_EXPORT and mbedtls_ssl_export_keying_material.
Remove AEAD check that tests for presence of mbedtls_cipher_write_tag<= br>and mbedtls_cipher_check_tag. Having an mbed TLS version that does notsupport that is highly unlikely. It might have been a good check in
Po= larSSL's time but is not today anymore.

Change-Id: I0f325800ebeb= 20bd5ef3ff78e5c5fcf0f6f74efd
Signed-off-by: Arne Schwabe <arne@...2068...= 7...>
---
M config.h.cmake.in
M configure.ac
M src/openvpn/m= bedtls_compat.h
M src/openvpn/ssl_mbedtls.c
4 files changed, 18 inser= tions(+), 36 deletions(-)

git pull ssh://gerrit.openvpn.net:29418=
/openvpn refs/changes/81/1081/5
diff --git a/config.h.cmake.in b/co=
nfig.h.cmake.in
index 5df0ac8..48807ee 100644
--- a/config.h.cmake.in
+++ b/config.h.cmake.in@@ -370,10 +370,10 @@
#undef HAVE_VFORK_H
/* Availability of different mbed TLS features a= nd APIs */
-#cmakedefin= e01 HAVE_MBEDTLS_PSA_CRYPTO_H
-#define HAVE_MBEDTLS_SSL_TLS_PRF 1
-#cmakedefine01 HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB

-#cmakedefine01 HAVE_MBEDT= LS_CTR_DRBG_UPDATE_RET
+#cmakedefine HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB
+#cmakedefine HAVE_MBEDTL= S_SSL_CONF_EXPORT_KEYS_EXT_CB
+#cmakedefine HAVE_MBEDTLS_CTR_DRBG_UPDATE_RET

/* Path to ifconfig tool */
#define IFCONF= IG_PATH "@IFCONFIG_PATH@"
diff --git a/configure.= ac b/configure.ac
index 02b45f8..51c20ef 100644
<= span>--- a/configure.ac

+++ b/configure.ac
= @@ -1044,31 +1044,11 @@
[AC_DEFINE([HAVE_MBEDTLS_PSA_CRY= PTO_H], [0], [no])]
)

- AC_CHECK_FUNCS(
- [ \
- mbedtls_cipher_write_tag \
- mbedtls_cipher_check_tag \
- ],
- ,
- [= AC_MSG_ERROR([mbed TLS check for AEAD support failed])]
- )
+ AC_CHECK_FUNCS([mbedtls_ssl_tls_prf mbedtls_ssl_conf_expo= rt_keys_ext_cb])

- AC_CHECK_FUNC(
- [mbedtls_ssl_tls_prf],
- [AC_DEFINE([HAVE_MBEDTLS_SSL_TLS_PRF], [1], [yes])],
= - [AC_DEFINE([HAVE_MBEDTLS_SSL_T= LS_PRF], [0], [no])]
- = )
-
- AC_CHECK_FUNC(
- [mbedtls_ssl_conf_export_keys_ext_cb],=
- [AC_DEFINE([HAVE_MBEDTLS_S= SL_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_conf_export_keys_ext_c= b" !=3D xyes; then
AC_CHECK_FUNC(
- [mbedtls_ssl_set_export_keys_cb],
- [AC_DEFINE([HAVE_MBED= TLS_SSL_SET_EXPORT_KEYS_CB], [1], [yes])],
- [AC_DEFINE([HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB], [= 0], [no])]
+ [mbedt= ls_ssl_set_export_keys_cb]
)
if test = "x$ac_cv_func_mbedtls_ssl_set_export_keys_cb" !=3D xyes; then
AC_CHECK_FUNC([mbedtls_ssl_export_keying_material])=
diff --git a/src/openvpn/mbedtls_compat.h b/src/openvpn/mbedtls_c= ompat.h
index 145a7ae..68c4cc3 100644
--- a= /src/openvpn/mbedtls_compat.h
+++ b/src/openvpn/mbedtls_com= pat.h
@@ -48,7 +48,7 @@
#include <mbedt= ls/version.h>
#include <mbedtls/x509_crt.h>

-#if HAVE_= MBEDTLS_PSA_CRYPTO_H
= +#ifdef HAVE_MBEDTLS_PSA_CRYPTO_H
#include <psa/cry= pto.h>
#endif

@@ -61,= 14 +61,14 @@
static inline void
mbedtls_c= ompat_psa_crypto_init(void)
{
-#if HAVE_MBEDTLS_PSA_CRYPTO_H && defined(M= BEDTLS_PSA_CRYPTO_C)
= +#if defined(HAVE_MBEDTLS_PSA_CRYPTO_H) && defined(MBEDTLS_PSA_CRYP= TO_C)
if (psa_crypto_init() !=3D PSA_SUCCESS) {
msg(M_FATAL, "mbedtls: psa_cry= pto_init() failed");
}
#else
return;
-#endif /* HAVE_MBEDTLS_PSA_CRYPTO_H && defined(MBEDTLS_PSA_CRYP= TO_C) */
+#endif
}

static inline mbedtls_com= pat_group_id
@@ -96,7 +96,7 @@
{ #if MBEDTLS_VERSION_NUMBER > 0x03000000
ret= urn mbedtls_ctr_drbg_update(ctx, additional, add_len);
-#elif HAVE_MBEDTLS_CTR_DRBG_UPDATE_RET
+#elif defined(HAVE_MBED= TLS_CTR_DRBG_UPDATE_RET)
return mbedtls_ctr_drbg_updat= e_ret(ctx, additional, add_len);
#else
= mbedtls_ctr_drbg_update(ctx, additional, add_len);
diff -= -git a/src/openvpn/ssl_mbedtls.c b/src/openvpn/ssl_mbedtls.c
index ecccc26..a4bb772 100644

--- a/src/openvpn/ssl_mbedt= ls.c
+++ b/src/openvpn/ssl_mbedtls.c
@@ -17= 3,8 +173,9 @@
ASSERT(NULL !=3D ctx);
= return ctx->initialised;
}
-
-#if HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB
+#ifdef MBEDTLS_SSL_KEYING_MATERIAL_EXPORT=
+/* mbedtls_ssl_expo= rt_keying_material does not need helper/callback methods */
+#elif defined(HAVE_MBEDTLS_SSL_CONF= _EXPORT_KEYS_EXT_CB)

/*
* Key export cal= lback for older versions of mbed TLS, to be used with
* m= bedtls_ssl_conf_export_keys_ext_cb(). It is called with the master@@ -205,7 +206,7 @@

return 0= ;
}
-#= elif HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB
+#elif defined(HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB)
/*
* Key export callback for newer versions= of mbed TLS, to be used with
* mbedtls_ssl_set_export_ke= ys_cb(). When used with TLS 1.2, the callback
@@ -251,10 +2= 52,11 @@
memcpy(cache->master_secret, secret, sizeo= f(cache->master_secret));
cache->tls_prf_type = =3D tls_prf_type;
}
-#elif !defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT)+#else /* ifdef MBEDTLS_SSL_K= EYING_MATERIAL_EXPORT */
#error mbedtls_ssl_conf_export_ke= ys_ext_cb, mbedtls_ssl_set_export_keys_cb or mbedtls_ssl_export_keying_mate= rial must be available in mbed TLS
#endif /* HAVE_MBEDTLS_= SSL_CONF_EXPORT_KEYS_EXT_CB */

+
bool
key_st= ate_export_keying_material(struct tls_session *session,
= const char *label, size_t label_size,=
@@ -1244,7 +1246,7 @@
mbedtls_ssl_conf_m= ax_tls_version(ks_ssl->ssl_config, version);
}

-#if HAVE= _MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB && !defined(MBEDTLS_SSL_KEYING= _MATERIAL_EXPORT)
+#i= f defined(HAVE_MBEDTLS_SSL_CONF_EXPORT_KEYS_EXT_CB) && !defined(MBE= DTLS_SSL_KEYING_MATERIAL_EXPORT)
/* Initialize keying = material exporter, old style. */
mbedtls_ssl_conf_expo= rt_keys_ext_cb(ks_ssl->ssl_config,
= mbedtls_ssl_export_keys_cb, session);
@= @ -1259,7 +1261,7 @@
* verification. */
ASSERT(mbed_ok(mbedtls_ssl_set_hostname(ks_ssl->ctx, NULL)));

-#if HA= VE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB && !defined(MBEDTLS_SSL_KEYING_MA= TERIAL_EXPORT)
+#if d= efined(HAVE_MBEDTLS_SSL_SET_EXPORT_KEYS_CB) && !defined(MBEDTLS_SSL= _KEYING_MATERIAL_EXPORT)
/* Initialize keying material= exporter, new style. */
mbedtls_ssl_set_export_keys_c= b(ks_ssl->ctx, mbedtls_ssl_export_keys_cb, session);
#e= ndif

To view, visit change 1081. To unsubsc= ribe, or for help writing mail filters, visit settings.

Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: I0f325800ebeb20bd5ef3ff78e5c= 5fcf0f6f74efd
Gerrit-Change-Number: 1081
Gerrit-PatchSet: 5
Gerrit-Owner: plaisthos <arne-openvpn@...1711...= 27...>
Gerrit-Reviewer: flichtenheld <frank@...2716...= 1...>
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: newpatchset
--CcX2FtxJNQE=--