From: "cron2 (Code Review)" Date: Thu, 4 Jan 2024 15:45:07 +0000 In-Reply-To: References: Reply-To: gert@...1296..., 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="Bh5jT7qPaqk="; charset=UTF-8 Subject: [Openvpn-devel] [M] Change in openvpn[master]: Check PRF availability on initialisation and add --force-tls-key-mate... List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: plaisthos Cc: flichtenheld , openvpn-devel --Bh5jT7qPaqk= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable cron2 has submitted this change. ( http://gerrit.openvpn.net/c/openvpn/+/46= 0?usp=3Demail ) Change subject: Check PRF availability on initialisation and add --force-tl= s-key-material-export ...................................................................... Check PRF availability on initialisation and add --force-tls-key-material-e= xport We now warn a user if the TLS 1.0 PRF is not supported by the cryptographic library of the system. Also add the option --force-tls-key-material-export that automatically rejects clients that do not support TLS Keying Material Export and automatically enable it when TLS 1.0 PRF support is not availabl= e. Change-Id: I04f8c7c413e7cb62c726262feee6ca89c7e86c70 Signed-off-by: Arne Schwabe Acked-by: Gert Doering Message-Id: <20240104140214.32196-1-gert@...1296...> URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg27= 924.html Signed-off-by: Gert Doering --- M doc/man-sections/protocol-options.rst M src/openvpn/crypto.c M src/openvpn/crypto.h M src/openvpn/multi.c M src/openvpn/options.c M src/openvpn/options.h 6 files changed, 84 insertions(+), 0 deletions(-) diff --git a/doc/man-sections/protocol-options.rst b/doc/man-sections/proto= col-options.rst index 948c0c8..8b061d2 100644 --- a/doc/man-sections/protocol-options.rst +++ b/doc/man-sections/protocol-options.rst @@ -242,3 +242,11 @@ a key renegotiation begins (default :code:`3600` seconds). This feature allows for a graceful transition from old to new key, and removes the key renegotiation sequence from the critical path of tunnel data forwarding. + +--force-tls-key-material-export + This option is only available in --mode server and forces to use + Keying Material Exporters (RFC 5705) for clients. This can be used to + simulate an environment where the cryptographic library does not support + the older method to generate data channel keys anymore. This option is + intended to be a test option and might be removed in a future OpenVPN + version without notice. diff --git a/src/openvpn/crypto.c b/src/openvpn/crypto.c index e4452d7..2fca131 100644 --- a/src/openvpn/crypto.c +++ b/src/openvpn/crypto.c @@ -27,6 +27,7 @@ #endif #include "syshead.h" +#include #include "crypto.h" #include "error.h" @@ -1789,3 +1790,22 @@ gc_free(&gc); return ret; } + +bool +check_tls_prf_working(void) +{ + /* Modern TLS libraries might no longer support the TLS 1.0 PRF with + * MD5+SHA1. This allows us to establish connections only + * with other 2.6.0+ OpenVPN peers. + * Do a simple dummy test here to see if it works. */ + const char *seed =3D "tls1-prf-test"; + const char *secret =3D "tls1-prf-test-secret"; + uint8_t out[8]; + uint8_t expected_out[] =3D { 'q', 'D', '\xfe', '%', '@', 's', 'u', '\x= 95' }; + + int ret =3D ssl_tls1_PRF((uint8_t *)seed, (int) strlen(seed), + (uint8_t *)secret, (int) strlen(secret), + out, sizeof(out)); + + return (ret && memcmp(out, expected_out, sizeof(out)) =3D=3D 0); +} diff --git a/src/openvpn/crypto.h b/src/openvpn/crypto.h index 9255d38..4201524 100644 --- a/src/openvpn/crypto.h +++ b/src/openvpn/crypto.h @@ -593,4 +593,12 @@ return kt; } +/** + * Checks if the current TLS library supports the TLS 1.0 PRF with MD5+SHA1 + * that OpenVPN uses when TLS Keying Material Export is not available. + * + * @return true if supported, false otherwise. + */ +bool check_tls_prf_working(void); + #endif /* CRYPTO_H */ diff --git a/src/openvpn/multi.c b/src/openvpn/multi.c index 8b490ed..f4f0b8a 100644 --- a/src/openvpn/multi.c +++ b/src/openvpn/multi.c @@ -1830,6 +1830,16 @@ { o->imported_protocol_flags |=3D CO_USE_TLS_KEY_MATERIAL_EXPORT; } + else if (o->force_key_material_export) + { + msg(M_INFO, "PUSH: client does not support TLS Keying Material " + "Exporters but --force-tls-key-material-export is enabled."); + auth_set_client_reason(tls_multi, "Client incompatible with this " + "server. Keying Material Exporters (RFC 570= 5) " + "support missing. Upgrade to a client that " + "supports this feature (OpenVPN 2.6.0+)."); + return false; + } if (proto & IV_PROTO_DYN_TLS_CRYPT) { o->imported_protocol_flags |=3D CO_USE_DYNAMIC_TLS_CRYPT; diff --git a/src/openvpn/options.c b/src/openvpn/options.c index e498114..1b28a19 100644 --- a/src/openvpn/options.c +++ b/src/openvpn/options.c @@ -1561,6 +1561,7 @@ SHOW_STR(auth_user_pass_verify_script); SHOW_BOOL(auth_user_pass_verify_script_via_file); SHOW_BOOL(auth_token_generate); + SHOW_BOOL(force_key_material_export); SHOW_INT(auth_token_lifetime); SHOW_STR_INLINE(auth_token_secret_file); #if PORT_SHARE @@ -2802,6 +2803,11 @@ { msg(M_USAGE, "--vlan-tagging requires --mode server"); } + + if (options->force_key_material_export) + { + msg(M_USAGE, "--force-tls-key-material-export requires --mode = server"); + } } /* @@ -3634,6 +3640,30 @@ } static void +options_process_mutate_prf(struct options *o) +{ + if (!check_tls_prf_working()) + { + msg(D_TLS_ERRORS, "Warning: TLS 1.0 PRF with MD5+SHA1 PRF is not " + "supported by the TLS library. Your system does not support th= is " + "calculation anymore or your security policy (e.g. FIPS 140-2)= " + "forbids it. Connections will only work with peers running " + "OpenVPN 2.6.0 or higher)"); +#ifndef HAVE_EXPORT_KEYING_MATERIAL + msg(M_FATAL, "Keying Material Exporters (RFC 5705) not available e= ither. " + "No way to generate data channel keys left."); +#endif + if (o->mode =3D=3D MODE_SERVER) + { + msg(M_WARN, "Automatically enabling option " + "--force-tls-key-material-export"); + o->force_key_material_export =3D true; + } + + } +} + +static void options_postprocess_mutate(struct options *o, struct env_set *es) { int i; @@ -3647,6 +3677,7 @@ options_postprocess_setdefault_ncpciphers(o); options_set_backwards_compatible_options(o); + options_process_mutate_prf(o); options_postprocess_cipher(o); o->ncp_ciphers =3D mutate_ncp_cipher_list(o->ncp_ciphers, &o->gc); @@ -8642,6 +8673,11 @@ } } } + else if (streq(p[0], "force-tls-key-material-export")) + { + VERIFY_PERMISSION(OPT_P_GENERAL); + options->force_key_material_export =3D true; + } else if (streq(p[0], "prng") && p[1] && !p[3]) { msg(M_WARN, "NOTICE: --prng option ignored (SSL library PRNG is us= ed)"); diff --git a/src/openvpn/options.h b/src/openvpn/options.h index c4514e1..cbfff18 100644 --- a/src/openvpn/options.h +++ b/src/openvpn/options.h @@ -687,6 +687,8 @@ const char *keying_material_exporter_label; int keying_material_exporter_length; #endif + /* force using TLS key material export for data channel key generation= */ + bool force_key_material_export; bool vlan_tagging; enum vlan_acceptable_frames vlan_accept; -- To view, visit http://gerrit.openvpn.net/c/openvpn/+/460?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: I04f8c7c413e7cb62c726262feee6ca89c7e86c70 Gerrit-Change-Number: 460 Gerrit-PatchSet: 10 Gerrit-Owner: plaisthos Gerrit-Reviewer: cron2 Gerrit-Reviewer: flichtenheld Gerrit-CC: openvpn-devel Gerrit-MessageType: merged --Bh5jT7qPaqk= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

cron2 submitted this change.

View Change

Check PRF availability on initialisation and a=
dd --force-tls-key-material-export

We now warn a user if the TLS 1.0= PRF is not supported by the cryptographic
library of the system. Also a= dd the option --force-tls-key-material-export
that automatically rejects= clients that do not support TLS Keying Material
Export and automaticall= y enable it when TLS 1.0 PRF support is not available.

Change-Id: I0= 4f8c7c413e7cb62c726262feee6ca89c7e86c70
Signed-off-by: Arne Schwabe <= arne@...1227...>
Acked-by: Gert Doering <gert@...1296...>
Me= ssage-Id: <20240104140214.32196-1-gert@...1296...>
URL: https://ww= w.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg27924.html
Sig= ned-off-by: Gert Doering <gert@...1296...>
---
M doc/man-sectio= ns/protocol-options.rst
M src/openvpn/crypto.c
M src/openvpn/crypto.h=
M src/openvpn/multi.c
M src/openvpn/options.c
M src/openvpn/optio= ns.h
6 files changed, 84 insertions(+), 0 deletions(-)

diff --git a/doc/man-sections/protocol-options.rst b/doc/man-sections/pr=
otocol-options.rst
index 948c0c8..8b061d2 100644
= --- a/doc/man-sections/protocol-options.rst
+++ b/doc= /man-sections/protocol-options.rst
@@ -242,3 +242,11 @@

a key renegotiation begins (default :code:`3600` seconds). = This feature
allows for a graceful transition from old t= o new key, and removes the key
renegotiation sequence fr= om the critical path of tunnel data forwarding.
+
+--force-tls-key-material-export
+ This option is only available in --mode server and f= orces to use
+ Keyin= g Material Exporters (RFC 5705) for clients. This can be used to
= + simulate an environment wher= e the cryptographic library does not support
+ the older method to generate data channel keys a= nymore. This option is
+ version without no= tice.
diff --git a/src/openvpn/crypto.c b/src/openvpn/crypt= o.c
index e4452d7..2fca131 100644
--- a/src= /openvpn/crypto.c
+++ b/src/openvpn/crypto.c
@@ -27,6 +27,7 @@
#endif

#include "syshead.h"
+#include <string.h>

= #include "crypto.h"
#include "error.h"= ;
@@ -1789,3 +1790,22 @@
gc_free(&= gc);
return ret;
}
+
+bool
+{
+ /* = Modern TLS libraries might no longer support the TLS 1.0 PRF with+ * MD5+SHA1. This allows = us to establish connections only
+ * with other 2.6.0+ OpenVPN peers.
+ * Do a simple dummy test here to see= if it works. */
+ = const char *seed =3D "tls1-prf-test";
+ const char *secret =3D "tls1-prf-test= -secret";
+ u= int8_t out[8];
+ u= int8_t expected_out[] =3D { 'q', 'D', '\xfe', '= %', '@', 's', 'u', '\x95' };
= +
+ int ret =3D ssl_tls1_PRF((uint8_t *)seed, (in= t) strlen(seed),
+ = (uint8_t *)secret, (int) strlen(secret),
= + out= , sizeof(out));
+

+ return (ret &&a= mp; memcmp(out, expected_out, sizeof(out)) =3D=3D 0);
+}
diff --git a/src/openvp= n/crypto.h b/src/openvpn/crypto.h
index 9255d38..4201524 10= 0644
--- a/src/openvpn/crypto.h
+++ b/src/o= penvpn/crypto.h
@@ -593,4 +593,12 @@
r= eturn kt;
}

+/**
+ * Checks if the current TLS library supports the TLS 1.0 PRF wi= th MD5+SHA1
+ * that = OpenVPN uses when TLS Keying Material Export is not available.
+ *
+ * @return true if supported, false otherwise.
+ */
+bool check_tls_prf_working(void);
+
#endi= f /* CRYPTO_H */
diff --git a/src/openvpn/multi.c b/src/ope= nvpn/multi.c
index 8b490ed..f4f0b8a 100644
= --- a/src/openvpn/multi.c
+++ b/src/openvpn/multi.c<= br>@@ -1830,6 +1830,16 @@
{
= o->imported_protocol_flags |=3D CO_USE_TLS_KEY_MATERIAL_EXPORT;
}
+= else if (o->force_key_material_export)
+ {
+ msg(M_INFO, "PUSH: client does not support TLS Key= ing Material "
+= "Exporters but --force-tls-key-material-export is enabled.= ");
+ aut= h_set_client_reason(tls_multi, "Client incompatible with this "
+ = "server. Keying Material Exporters (RFC 5705) "<= br>+ = "support missing. Upgrade to a client that "
+ "= ;supports this feature (OpenVPN 2.6.0+).");
+ return false;
+ }
if (proto & I= V_PROTO_DYN_TLS_CRYPT)
{
o-&g= t;imported_protocol_flags |=3D CO_USE_DYNAMIC_TLS_CRYPT;
di= ff --git a/src/openvpn/options.c b/src/openvpn/options.c
in= dex e498114..1b28a19 100644
--- a/src/openvpn/options.c
+++ b/src/openvpn/options.c
@@ -1561,6 +1561,7= @@
SHOW_STR(auth_user_pass_verify_script);
= SHOW_BOOL(auth_user_pass_verify_script_via_file);
SHOW_BOOL(auth_token_generate);

+ SHOW_BOOL(force_key_material_export);
SHOW_INT(auth_token_lifetime);

SHOW_STR_INLINE(= auth_token_secret_file);
#if PORT_SHARE
@@= -2802,6 +2803,11 @@
{
= msg(M_USAGE, "--vlan-tagging requires --mode server"); }
+<= /span>
+ if (options-= >force_key_material_export)
+ {
= + msg(M_USAGE, "--force-tls-key-material-export requires --= mode server");
+= }
}

/*<= /span>
@@ -3634,6 +3640,30 @@
}
=
static void
+options_process_mutate_prf(struct options *o)
+{
+ if (!check_tls_prf_working())
+ {
+ msg(D_TLS_ERRORS, "Warning: TLS 1.0 PRF wi= th MD5+SHA1 PRF is not "
+ "supported by the TLS library. Your system does = not support this "
+ "calculation anymore or your security policy (e.g. FIP= S 140-2) "
+ = "forbids it. Connections will only work with peers running &qu= ot;
+ &quo= t;OpenVPN 2.6.0 or higher)");
+#ifndef HAVE_EXPORT_KEYING_MATERIAL
+ msg(M_FATAL, "Keying Material E= xporters (RFC 5705) not available either. "
+ "No way to generate data chan= nel keys left.");
+ if= (o->mode =3D=3D MODE_SERVER)
+ {
+ "--f= orce-tls-key-material-export");
+ o->force_key_material_export =3D true;

+ }
+
+ }
+}
++static void
= options_postprocess_mutate(struct options *o, struct env_set *es) {
int i;
@@ -3647,6 +3677,7 @@=

options_postprocess_setdefault_ncpc= iphers(o);
options_set_backwards_compatible_options(o)= ;
+ options_proces= s_mutate_prf(o);

options_postprocess= _cipher(o);
o->ncp_ciphers =3D mutate_ncp_cipher_li= st(o->ncp_ciphers, &o->gc);
@@ -8642,6 +8673,11 @= @
}
}
}
+ else if = (streq(p[0], "force-tls-key-material-export"))
+ {
+ VERIFY_PERMISSION(OPT_P_GENERAL);
= + options->force_key_= material_export =3D true;
+ }
else if (streq(p[0], "prng") &am= p;& p[1] && !p[3])
{
= msg(M_WARN, "NOTICE: --prng option ignored (SSL library PRNG is us= ed)");
diff --git a/src/openvpn/options.h b/src/openvp= n/options.h
index c4514e1..cbfff18 100644
-= -- a/src/openvpn/options.h
+++ b/src/openvpn/options.h

@@ -687,6 +687,8 @@
const char *keying_mat= erial_exporter_label;
int keying_material_exporter_len= gth;
#endif
+ /* force using TLS key material export for data channel key ge= neration */
+ bool= force_key_material_export;

bool vla= n_tagging;
enum vlan_acceptable_frames vlan_accept;

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

Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: I04f8c7c413e7cb62c726262feee= 6ca89c7e86c70
Gerrit-Change-Number: 460
Gerrit-PatchSet: 10
Gerrit-Owner: plaisthos <arne-openvpn@...1711...= 27...>
Gerrit-Reviewer: cron2 <gert@...1296...>=
Gerrit-Reviewer: flichtenheld <frank@...2716...= 1...>
Gerrit-CC: openvpn-devel <openvpn-devel@...1484...= ts.sourceforge.net>
Gerrit-MessageType: merged
--Bh5jT7qPaqk=--