Support for wolfSSL with OpenVPN v2.4.8
PATCH 1/1 Support for wolfSSL with OpenVPN v2.4.8
From: David Garske <[email protected]...>
wolfSSL:
Support added in: https://github.com/wolfSSL/wolfssl/pull/2503
```sh git clone https://github.com/wolfSSL/wolfssl.git cd wolfssl ./autogen.sh ./configure --enable-opensslall --enable-des3 --enable-crl --enable-certgen --enable-certext --enable-aesctr --enable-sessioncerts CFLAGS="-DWOLFSSL_DES_ECB -DHAVE_EX_DATA" make sudo make install ```
OpenVPN:
```sh autoreconf -i -v -f ./configure --with-crypto-library=wolfssl make make check sudo make install ``` --- configure.ac | 77 +++++++++++++++++++++- include/openvpn-plugin.h.in | 3 + sample/sample-config-files/loopback-client | 1 + sample/sample-config-files/loopback-server | 1 + src/openvpn/crypto.c | 2 +- src/openvpn/crypto_openssl.c | 3 + src/openvpn/crypto_openssl.h | 3 + src/openvpn/cryptoapi.c | 4 ++ src/openvpn/openssl_compat.h | 5 ++ src/openvpn/ssl_openssl.c | 3 + src/openvpn/ssl_openssl.h | 3 + src/openvpn/ssl_verify_openssl.c | 3 + src/openvpn/ssl_verify_openssl.h | 3 + 13 files changed, 108 insertions(+), 3 deletions(-)
configure.ac +75 -2
@@ -283,10 +283,10 @@ AC_ARG_WITH( AC_ARG_WITH( [crypto-library], - [AS_HELP_STRING([--with-crypto-library=library], [build with the given crypto library, TYPE=openssl|mbedtls @<:@default=openssl@:>@])], + [AS_HELP_STRING([--with-crypto-library=library], [build with the given crypto library, TYPE=openssl|mbedtls|wolfssl @<:@default=openssl@:>@])], [ case "${withval}" in - openssl|mbedtls) ;; + openssl|mbedtls|wolfssl) ;; *) AC_MSG_ERROR([bad value ${withval} for --with-crypto-library]) ;; esac ],
@@ -1028,6 +1028,79 @@ elif test "${enable_crypto}" = "yes" -a "${with_crypto_library}" = "mbedtls"; th AC_DEFINE([ENABLE_CRYPTO_MBEDTLS], [1], [Use mbed TLS library]) CRYPTO_CFLAGS="${MBEDTLS_CFLAGS}" CRYPTO_LIBS="${MBEDTLS_LIBS}" + +elif test "${enable_crypto}" = "yes" -a "${with_crypto_library}" = "wolfssl"; then + AC_ARG_VAR([WOLFSSL_CFLAGS], [C compiler flags for wolfssl]) + AC_ARG_VAR([WOLFSSL_LIBS], [linker flags for wolfssl]) + AC_ARG_VAR([WOLFSSL_DIR], [Path to the wolfssl directory @<:@default=/usr/local/include/wolfssl@:>@]) + if test -n "${WOLFSSL_DIR}"; then + wolfssldir="${WOLFSSL_DIR}" + else + wolfssldir="/usr/local/include/wolfssl" + fi + + saved_CFLAGS="${CFLAGS}" + saved_LIBS="${LIBS}" + + if test -z "${WOLFSSL_CFLAGS}" -a -z "${WOLFSSL_LIBS}"; then + # if the user did not explicitly specify flags, try to autodetect + LIBS="${LIBS} -lwolfssl -lm -pthread" + AC_CHECK_LIB( + [wolfssl], + [wolfSSL_Init], + [], + [AC_MSG_ERROR([Could not link wolfSSL library.])] + ) + AC_CHECK_HEADER([wolfssl/options.h],,[AC_MSG_ERROR([wolfSSL header wolfssl/options.h not found!])]) + fi + + AC_DEFINE([HAVE_HMAC_CTX_NEW], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_HMAC_CTX_FREE], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_HMAC_CTX_RESET], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_EVP_MD_CTX_NEW], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_EVP_MD_CTX_FREE], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_EVP_MD_CTX_RESET], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_OPENSSL_VERSION], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_SSL_CTX_GET_DEFAULT_PASSWD_CB], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_SSL_CTX_GET_DEFAULT_PASSWD_CB_USERDATA], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_SSL_CTX_SET_SECURITY_LEVEL], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_X509_GET0_PUBKEY], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_X509_STORE_GET0_OBJECTS], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_X509_OBJECT_FREE], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_X509_OBJECT_GET_TYPE], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_EVP_PKEY_ID], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_EVP_PKEY_GET0_RSA], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_EVP_PKEY_GET0_DSA], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_EVP_PKEY_GET0_EC_KEY], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_RSA_SET_FLAGS], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_RSA_BITS], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_RSA_GET0_KEY], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_RSA_SET0_KEY], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_DSA_GET0_PQG], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_DSA_BITS], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_RSA_METH_NEW], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_RSA_METH_FREE], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_RSA_METH_SET_PUB_ENC], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_RSA_METH_SET_PUB_DEC], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_RSA_METH_SET_PRIV_ENC], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_RSA_METH_SET_PRIV_DEC], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_RSA_METH_SET_INIT], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_RSA_METH_SET_SIGN], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_RSA_METH_SET_FINISH], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_RSA_METH_SET0_APP_DATA], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_RSA_METH_GET0_APP_DATA], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + AC_DEFINE([HAVE_EC_GROUP_ORDER_BITS], [1], [Emulate AC_CHECK_FUNCS since these are defined as macros]) + + have_crypto_aead_modes="no" + have_crypto="yes" + + WOLFSSL_CFLAGS="${WOLFSSL_CFLAGS} -I${wolfssldir}" + CFLAGS="${WOLFSSL_CFLAGS} ${CFLAGS}" + LIBS="${WOLFSSL_LIBS} ${LIBS}" + AC_DEFINE([ENABLE_CRYPTO_WOLFSSL], [1], [Use wolfSSL crypto library]) + AC_DEFINE([ENABLE_CRYPTO_OPENSSL], [1], [Use wolfSSL openssl compatibility layer]) + CRYPTO_CFLAGS="${WOLFSSL_CFLAGS}" + CRYPTO_LIBS="${WOLFSSL_LIBS}" elif test "${enable_crypto}" = "yes"; then AC_MSG_ERROR([Invalid crypto library: ${with_crypto_library}]) fi
include/openvpn-plugin.h.in +3 -0
@@ -34,6 +34,9 @@ typedef mbedtls_x509_crt openvpn_x509_cert_t; #endif #else /* ifdef ENABLE_CRYPTO_MBEDTLS */ +#ifdef ENABLE_CRYPTO_WOLFSSL +#include <wolfssl/options.h> +#endif #include <openssl/x509.h> #ifndef __OPENVPN_X509_CERT_T_DECLARED #define __OPENVPN_X509_CERT_T_DECLARED
sample/sample-config-files/loopback-client +1 -0
@@ -24,3 +24,4 @@ cert sample-keys/client.crt tls-auth sample-keys/ta.key 1 ping 1 inactive 120 10000000 +cipher AES-256-CBC
sample/sample-config-files/loopback-server +1 -0
@@ -24,3 +24,4 @@ cert sample-keys/server.crt tls-auth sample-keys/ta.key 0 ping 1 inactive 120 10000000 +cipher AES-256-CBC
src/openvpn/crypto.c +1 -1
@@ -439,7 +439,7 @@ openvpn_decrypt_aead(struct buffer *buf, struct buffer work, tag_ptr =BPTR (buf);ASSERT (buf_advance (buf, tag_size));dmsg (D_PACKET_CONTENT ,"DECRYPT MAC: %s" ,format_hex (tag_ptr, tag_size,0 , &gc)); -#if defined(ENABLE_CRYPTO_OPENSSL ) &&OPENSSL_VERSION_NUMBER <0x10001040L +#if defined(ENABLE_CRYPTO_OPENSSL ) &&OPENSSL_VERSION_NUMBER <0x10001040L && !defined(ENABLE_CRYPTO_WOLFSSL )/* OpenSSL <= 1.0.1c bug requires set tag before processing ciphertext */ if (!EVP_CIPHER_CTX_ctrl (ctx->cipher,EVP_CTRL_GCM_SET_TAG , tag_size, tag_ptr)) {
src/openvpn/crypto_openssl.c +3 -0
@@ -43,6 +43,9 @@#include "crypto_backend.h" #include "openssl_compat.h" +#ifdef ENABLE_CRYPTO_WOLFSSL +#include <wolfssl/options.h> +#endif #include <openssl/des.h> #include <openssl/err.h> #include <openssl/evp.h>
src/openvpn/crypto_openssl.h +3 -0
@@ -29,6 +29,9 @@#ifndef CRYPTO_OPENSSL_H_ #define CRYPTO_OPENSSL_H_ +#ifdef ENABLE_CRYPTO_WOLFSSL +#include <wolfssl/options.h> +#endif #include <openssl/evp.h> #include <openssl/hmac.h> #include <openssl/md5.h>
src/openvpn/cryptoapi.c +4 -0
@@ -38,6 +38,10 @@#ifdef ENABLE_CRYPTOAPI +#ifdef ENABLE_CRYPTO_WOLFSSL +#error wolfSSL does not support CryptoAPI +#endif +#include <openssl/ssl.h> #include <openssl/evp.h> #include <openssl/err.h>
src/openvpn/openssl_compat.h +5 -0
@@ -42,6 +42,11 @@#include "buffer.h" +#ifdef ENABLE_CRYPTO_WOLFSSL +#include <wolfssl/options.h> +#include <openssl/rsa.h> +#include <openssl/err.h> +#endif #include <openssl/ssl.h> #include <openssl/x509.h>
src/openvpn/ssl_openssl.c +3 -0
@@ -52,6 +52,9 @@#include "ssl_verify_openssl.h" +#ifdef ENABLE_CRYPTO_WOLFSSL +#include <wolfssl/options.h> +#endif #include <openssl/err.h> #include <openssl/pkcs12.h> #include <openssl/x509.h>
src/openvpn/ssl_openssl.h +3 -0
@@ -29,6 +29,9 @@#ifndef SSL_OPENSSL_H_ #define SSL_OPENSSL_H_ +#ifdef ENABLE_CRYPTO_WOLFSSL +#include <wolfssl/options.h> +#endif #include <openssl/ssl.h> /**
src/openvpn/ssl_verify_openssl.c +3 -0
@@ -44,6 +44,9 @@#include "ssl_verify_backend.h" #include "openssl_compat.h" +#ifdef ENABLE_CRYPTO_WOLFSSL +#include <wolfssl/options.h> +#endif #include <openssl/x509v3.h> #include <openssl/err.h>
src/openvpn/ssl_verify_openssl.h +3 -0
@@ -30,6 +30,9 @@#ifndef SSL_VERIFY_OPENSSL_H_ #define SSL_VERIFY_OPENSSL_H_ +#ifdef ENABLE_CRYPTO_WOLFSSL +#include <wolfssl/options.h> +#endif #include <openssl/x509.h> #ifndef __OPENVPN_X509_CERT_T_DECLARED
Signature · 1 line
2.17.1
David Sommerseth
NAKQuoted 17 lines · Juliusz Sosinowicz
From: David Garske <[email protected]...>
wolfSSL:
Support added in: https://github.com/wolfSSL/wolfssl/pull/2503
```sh git clone https://github.com/wolfSSL/wolfssl.git cd wolfssl ./autogen.sh ./configure --enable-opensslall --enable-des3 --enable-crl --enable-certgen --enable-certext --enable-aesctr --enable-sessioncerts CFLAGS="-DWOLFSSL_DES_ECB -DHAVE_EX_DATA" make sudo make install ```OpenVPN:
Quoted 7 lines
```sh autoreconf -i -v -f ./configure --with-crypto-library=wolfssl make make check sudo make install ```
NAK.
This patch adds a new feature to the 2.4 branch. We don't really want to do that, especially if the change is intrusive (13 files changed, 108 insertions << that is intrusive). WolfSSL support will at best see the light in the coming 2.5 release (At the hackathon we aim for late 2020Q1 or 2020Q2)
In previous rounds we have asked a lot of questions; there has been no real responses to those. This has not even been touched in the relation to this patch.
One good thing I do see, is that it seems to try to use an OpenSSL support layer in WolfSSL - which is good. But then I wonder why we see additions like this all over.
+#ifdef ENABLE_CRYPTO_WOLFSSL
+#include <wolfssl/options.h>
+#endif
In addition, the change in configure.ac with all the AC_DEFINE lines, tagged with "Emulate XXXXX since these are defined as macros" is also making a lot of mess.
And then comes the most critical point to all of this: Who will maintain WolfSSL support in OpenVPN once this has been applied? What kind of commitment will we see from the WolfSSL organization?
The OpenVPN developers community will have an IRC meeting next Thursday (Nov 21 @ 20:00 CET, #openvpn-meeting on FreeNode [1]). I strongly recommend you to attend this meeting to follow up your request.
[1] You need to have your nick registered to join
<https://freenode.net/kb/answer/registration>
Signature · 4 lines
kind regards, David Sommerseth OpenVPN Inc
Hi David,
I apologize for the delayed response. I will rebase our OpenVPN work off of the master branch this week in anticipation for a possible inclusion in version 2.5.
Regarding your question "What kind of commitment will we see from the WolfSSL organization?":
We have a large customer driving the use of wolfSSL with OpenVPN. We've done the initial porting and testing. We will update the port when needed and continue to support this effort. We will also be making public marketing posts and annoucements for OpenVPN support on our blog (https://www.wolfssl.com/blog/) and subscribed mailing lists.
We understand your concern about the intrusiveness of this patch. The majority of insertions occur in the configure and try to follow the structure of how other cryptographic backends are compiled against. The "Emulate XXXXX since these are defined as macros" additions are unfortunately necessary as these functions are defined as macros in our library. AC_CHECK_FUNCS will not check if the function exists behind a macro. Defining these macros in the configure script allows for minimal interference in the rest of OpenVPN code. The rest of the changes in the patch are library inclusions as some things are defined in slightly different locations than OpenSSL. The file <wolfssl/options.h> holds the configure options for the wolfSSL library. It is necessary to include so that the header files know what should be included and defined.
I hope this email clears things up as to why some changes were necessary.
Sincerely
Juliusz
Quoted 60 lines · David Sommerseth
Quoted 17 lines · Juliusz Sosinowicz
From: David Garske <[email protected]...>
wolfSSL:
Support added in: https://github.com/wolfSSL/wolfssl/pull/2503
```sh git clone https://github.com/wolfSSL/wolfssl.git cd wolfssl ./autogen.sh ./configure --enable-opensslall --enable-des3 --enable-crl --enable-certgen --enable-certext --enable-aesctr --enable-sessioncerts CFLAGS="-DWOLFSSL_DES_ECB -DHAVE_EX_DATA" make sudo make install ```OpenVPN:
Quoted 7 lines
```sh autoreconf -i -v -f ./configure --with-crypto-library=wolfssl make make check sudo make install ```NAK.
This patch adds a new feature to the 2.4 branch. We don't really want to do that, especially if the change is intrusive (13 files changed, 108 insertions << that is intrusive). WolfSSL support will at best see the light in the coming 2.5 release (At the hackathon we aim for late 2020Q1 or 2020Q2)
In previous rounds we have asked a lot of questions; there has been no real responses to those. This has not even been touched in the relation to this patch.
One good thing I do see, is that it seems to try to use an OpenSSL support layer in WolfSSL - which is good. But then I wonder why we see additions like this all over.
include/openvpn-plugin.h.in +3
-0+#ifdef ENABLE_CRYPTO_WOLFSSL +#include <wolfssl/options.h> +#endifIn addition, the change in configure.ac with all the
AC_DEFINElines, tagged with "Emulate XXXXX since these are defined as macros" is also making a lot of mess.And then comes the most critical point to all of this: Who will maintain WolfSSL support in OpenVPN once this has been applied? What kind of commitment will we see from the WolfSSL organization?
The OpenVPN developers community will have an IRC meeting next Thursday (Nov 21 @ 20:00 CET, #openvpn-meeting on FreeNode [1]). I strongly recommend you to attend this meeting to follow up your request.
[1] You need to have your nick registered to join
<https://freenode.net/kb/answer/registration>