From: "plaisthos (Code Review)" Date: Thu, 7 Dec 2023 18:26:29 +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="OeADsDAlruY="; 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: flichtenheld Cc: openvpn-devel --OeADsDAlruY= Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Attention is currently required from: flichtenheld. Hello flichtenheld,=20 I'd like you to reexamine a change. Please visit http://gerrit.openvpn.net/c/openvpn/+/460?usp=3Demail to look at the new patch set (#5). The following approvals got outdated and were removed: Code-Review-1 by flichtenheld 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 --- 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, 83 insertions(+), 0 deletions(-) git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/60/460/5 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..8c17f2a 100644 --- a/src/openvpn/crypto.c +++ b/src/openvpn/crypto.c @@ -1789,3 +1789,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 { 0xe0, 0x5f, 0x1f, 1, 0, 0, 0, 0}; + + 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 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..82122f5 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 key material export" + "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 1521872..fc0a5d5 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 not supp= orted " + "by TLS library. Your system does not support this calculation= " + "anymore or your security policy (e.g. FIPS 140-2) forbids it.= " + "Connections will only work with peers running OpenVPN 2.6.0 o= r " + "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"); + } + + } +} + +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); @@ -8643,6 +8674,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: 5 Gerrit-Owner: plaisthos Gerrit-Reviewer: flichtenheld Gerrit-CC: openvpn-devel Gerrit-Attention: flichtenheld Gerrit-MessageType: newpatchset --OeADsDAlruY= Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable

Attention is currently required from: flichtenheld.

plaisthos uploaded patch set #5 to this change.

<= a href=3D"http://gerrit.openvpn.net/c/openvpn/+/460?usp=3Demail">View Chang= e

The following approvals got outdated and were removed: Code-Review-1 by flichtenheld

Check PRF availability on initialisation and =
add --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 = add the option --force-tls-key-material-export
that automatically reject= s clients that do not support TLS Keying Material
Export and automatical= ly enable it when TLS 1.0 PRF support is not available.

Change-Id: I= 04f8c7c413e7cb62c726262feee6ca89c7e86c70
Signed-off-by: Arne Schwabe <= ;arne@...1227...>
---
M doc/man-sections/protocol-options.rst
M= src/openvpn/crypto.c
M src/openvpn/crypto.h
M src/openvpn/multi.cM src/openvpn/options.c
M src/openvpn/options.h
6 files changed, 83 = insertions(+), 0 deletions(-)

git pull ssh://gerrit.openvpn.net:2=
9418/openvpn refs/changes/60/460/5
diff --git a/doc/man-sections/pr=
otocol-options.rst b/doc/man-sections/protocol-options.rst
= index 948c0c8..8b061d2 100644
--- a/doc/man-sections/protoc= ol-options.rst
+++ b/doc/man-sections/protocol-options.rst<= /span>
@@ -242,3 +242,11 @@
a key renegotiation= begins (default :code:`3600` seconds). This feature
all= ows 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-e= xport
+ This option = is only available in --mode server and forces to use
+ Keying Material Exporters (RFC 5705) fo= r clients. This can be used to
+ simulate an environment where the cryptographic library does n= ot support
+ the old= er method to generate data channel keys anymore. This option is
<= span style=3D"color: hsl(120, 100%, 40%);">+ 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.= .8c17f2a 100644
--- a/src/openvpn/crypto.c
= +++ b/src/openvpn/crypto.c
@@ -1789,3 +1789,22 @@ gc_free(&gc);
return ret;
}

+
+bool
+check_tls_prf_working(void)
+{
+ /* Modern TLS libraries might no longer support the T= LS 1.0 PRF with
+ = * MD5+SHA1. This allows us to establish connections only
+ * with other 2.6.0+ OpenVPN peer= s.
+ * Do a simpl= e 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 { 0xe0, 0x5f, 0x1f, 1, 0,= 0, 0, 0};
++ int ret =3D ssl_tls1_PRF= ((uint8_t *)seed, (int) strlen(seed),
+ (uint8_t *)secret, (int) strle= n(secret),
+ = out, sizeof(out));
+
+ = return (ret && memcmp(out, expected_out, sizeof(out)) !=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 avai= lable.
+ *
= + * @return true if supported,= false otherwise.
+ *= /
+bool check_tls_prf= _working(void);
+
#endif /* CRYPTO_H */
diff --git a/src/openvp= n/multi.c b/src/openvpn/multi.c
index 8b490ed..82122f5 1006= 44
--- a/src/openvpn/multi.c
+++ b/src/open= vpn/multi.c
@@ -1830,6 +1830,16 @@
{
o->imported_protocol_flags |=3D CO_USE_TLS_KEY_M= ATERIAL_EXPORT;
}
+ else if (o->force_key_material_export)
= + {
+ msg(M_INFO, "PUSH: client does = not support TLS key material export"
+ "but --force-tls-key-material-export= is enabled.");
= + auth_set_client_reason(tls_multi, "Client incompatible with t= his"
+ = "server. Keying Material Exporters (RFC 5705)&quo= t;
+ = "support missing. Upgrade to a client that "=
+ = "supports this feature (OpenVPN 2.6.0+).");
+ return false;
+ }

if (pro= to & 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.cindex 1521872..fc0a5d5 100644
--- a/src/openvpn/opt= ions.c
+++ b/src/openvpn/options.c
@@ -1561= ,6 +1561,7 @@
SHOW_STR(auth_user_pass_verify_script);<= /span>
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_S= TR_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 r= equires --mode server");
+ }
}

/*

@@ -3634,6 +3640,30 @@
}<= br>
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 not supported "
+ "by TLS library. Your system does not support this c= alculation "
+ = "anymore or your security policy (e.g. FIPS 140-2) forbids i= t. "
+ = "Connections will only work with peers running OpenVPN 2.6.0 or &quo= t;
+ "= ;higher)");
+#if= ndef HAVE_EXPORT_KEYING_MATERIAL
+ msg(M_FATAL, "Keying Material Exporters (RFC 5705= ) not available either. "
+ "No way to generate data channel keys left.&quo= t;);
+#endif+ if (o->mode =3D= =3D MODE_SERVER)
+ = {
+ m= sg(M_WARN, "Automatically enabling option "
+ "--force-tls-key-mat= erial-export");
= + }
++ }
+}
+
+sta= tic void
options_postprocess_mutate(struct options *o, str= uct env_set *es)
{
int i;
<= span>@@ -3647,6 +3677,7 @@


options_p= ostprocess_setdefault_ncpciphers(o);
options_set_backw= ards_compatible_options(o);
+ options_process_mutate_prf(o);

options_postprocess_cipher(o);

o->ncp_cipher= s =3D mutate_ncp_cipher_list(o->ncp_ciphers, &o->gc);
<= span>@@ -8643,6 +8674,11 @@

}
= }
}
+ else if (streq(p[0], "force-tls-key-material-export&= quot;))
+ {=
+ 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 ign= ored (SSL library PRNG is used)");
diff --git a/src/op= envpn/options.h b/src/openvpn/options.h
index c4514e1..cbff= f18 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 ex= port for data channel key generation */
+ bool force_key_material_export;

bool vlan_tagging;
enum vlan_accep= table_frames vlan_accept;

To view, visi= t 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: 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: flichtenheld <frank@...2375...= 41...>
Gerrit-MessageType: newpatchset
--OeADsDAlruY=--