Add WinTLS support for SSL/TLS on Windows

Introduces conditional support for WinTLS as an alternative to OpenSSL for SSL/TLS on Windows platforms. Updates CMake configuration, build scripts, and source files to handle both OpenSSL and WinTLS, including new CMake find module, macro definitions, and conditional compilation. Refactors include paths, protocol handler directories, and updates documentation to reflect the new SSL/TLS options.
Macro WITH_ETP_SSL is now automatically defined by the library if needed.

Author: philippeVerney

.github/workflows/github-actions.yml

@@ -202,7 +202,7 @@ jobs:
             cmake -DCMAKE_TOOLCHAIN_FILE=%VCPKG_INSTALLATION_ROOT%\scripts\buildsystems\vcpkg.cmake -G"Visual Studio 17 2022" -A x64 -T host=x64 -Wno-dev -Wno-deprecated -DCMAKE_INSTALL_PREFIX=${{ runner.temp }}/fesapi-install ${{ runner.temp }}\fesapi-2.14.0.0 &&
             cmake --build . --config Release -j2 &&
             cmake --build . --config Release --target INSTALL &&
-            %VCPKG_INSTALLATION_ROOT%\vcpkg install openssl boost-beast avro-cpp &&
+            %VCPKG_INSTALLATION_ROOT%\vcpkg install bext-wintls boost-beast avro-cpp &&
             cd ${{ runner.temp }} &&
             mkdir fetpapi-build &&
             cd fetpapi-build &&

.gitignore

@@ -2,7 +2,7 @@
 /cs/fetpapiCs.csproj
 /swig/setup.py
 /swig/swigEtp1_2Include.i
-/src/nsDefinitions.h
+/src/macroDefinitions.h
 
 ## Ignore csharp swig generated files
 /swig/swigGeneratedCsWrapper.cpp

CMakeLists.txt

@@ -15,7 +15,7 @@ set (FETPAPI_BINARY_DIR ${CMAKE_CURRENT_BINARY_DIR})
 
 # version mechanism
 set (Fetpapi_VERSION_MAJOR 0)
-set (Fetpapi_VERSION_MINOR 4)
+set (Fetpapi_VERSION_MINOR 5)
 set (Fetpapi_VERSION_PATCH 0)
 set (Fetpapi_VERSION_TWEAK 0)
 
@@ -120,6 +120,7 @@ endif()
 
 # avro DEPENDENCY
 find_package(AVRO REQUIRED)
+target_link_libraries (${PROJECT_NAME} PUBLIC AVRO::AVRO ${CMAKE_THREAD_LIBS_INIT})
 
 if (WITH_FESAPI)
 	find_package(FESAPI REQUIRED)
@@ -129,9 +130,9 @@ if (WITH_FESAPI)
 			message(SEND_ERROR "The FESAPI library (FESAPI_JAR variable) does not look to be a valid file. Please modify it.")
 		endif ()
 	endif (WITH_JAVA_WRAPPING)
+	target_link_libraries(${PROJECT_NAME} PUBLIC FESAPI::FESAPI)
 endif (WITH_FESAPI)
 
-target_link_libraries (${PROJECT_NAME} PRIVATE AVRO::AVRO ${CMAKE_THREAD_LIBS_INIT})
 if (WIN32)
 	target_link_libraries (${PROJECT_NAME} PRIVATE bcrypt.lib)
 
@@ -149,24 +150,26 @@ else (WIN32)
 endif (WIN32)
 
 if (WITH_ETP_SSL)
-	target_compile_definitions(${PROJECT_NAME} PRIVATE WITH_ETP_SSL)
-	if (NOT TARGET OpenSSL::SSL OR NOT TARGET OpenSSL::Crypto)
-		find_package(OpenSSL REQUIRED)
+	if (WIN32)
+		set (USE_WINTLS_INSTEAD_OF_OPENSSL ON CACHE BOOL "Build FETPAPI with ETP SSL support.")
 	endif()
-	target_link_libraries(${PROJECT_NAME} PRIVATE OpenSSL::SSL OpenSSL::Crypto)
-	# OpenSSL::applink is recommended under MSVC : https://cmake.org/cmake/help/latest/module/FindOpenSSL.html
-	if (CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
-		target_link_libraries(${PROJECT_NAME} PRIVATE OpenSSL::applink)
-	endif ()
-endif ()
 
-if (WITH_FESAPI)
-	target_link_libraries(${PROJECT_NAME} PRIVATE FESAPI::FESAPI)
-endif (WITH_FESAPI)
+	if (NOT USE_WINTLS_INSTEAD_OF_OPENSSL)
+		target_compile_definitions(${PROJECT_NAME} PRIVATE WITH_ETP_SSL)
+		if (NOT TARGET OpenSSL::SSL OR NOT TARGET OpenSSL::Crypto)
+			find_package(OpenSSL REQUIRED)
+		endif()
+		target_link_libraries(${PROJECT_NAME} PRIVATE OpenSSL::SSL OpenSSL::Crypto)
+		# OpenSSL::applink is recommended under MSVC : https://cmake.org/cmake/help/latest/module/FindOpenSSL.html
+		if (CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
+			target_link_libraries(${PROJECT_NAME} PRIVATE OpenSSL::applink)
+		endif ()
+	endif()
+endif ()
 
 # Namespaces definitions
 set (FETPAPI_ETP_NS etp CACHE STRING "Namespace for etp objects")
-configure_file(${CMAKE_CURRENT_SOURCE_DIR}/cmake/nsDefinitions.h ${CMAKE_CURRENT_SOURCE_DIR}/src/nsDefinitions.h) # Overwrite if different
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/cmake/macroDefinitions.h.in ${CMAKE_CURRENT_SOURCE_DIR}/src/macroDefinitions.h @ONLY) # Overwrite if different
 
 # ============================================================================
 # SWIG wrapping
@@ -195,26 +198,25 @@ endif (WITH_PYTHON_WRAPPING)
 
 include(${CMAKE_CURRENT_SOURCE_DIR}/src/CMakeLists.txt)
 set (ALL_SOURCES_AND_HEADERS
-	${ALL_SOURCES_AND_HEADERS}
-	${FETPAPI_SOURCES}
 	${FETPAPI_HEADERS}
+	${FETPAPI_ETP_SOURCES}
+	${FETPAPI_ETP_HEADERS}
 	${FETPAPI_PROTOCOL_SOURCES}
 	${FETPAPI_PROTOCOL_HEADERS}
 	${FETPAPI_FESAPI_SOURCES}
 	${FETPAPI_FESAPI_HEADERS}
 	${FETPAPI_SSL_SOURCES}
 	${FETPAPI_SSL_HEADERS}
 )
-
-if (WITH_FESAPI)
-	target_include_directories(${PROJECT_NAME} PRIVATE ${FESAPI_INCLUDE_DIR})
-endif (WITH_FESAPI)
-
 target_sources(${PROJECT_NAME} PRIVATE ${ALL_SOURCES_AND_HEADERS})
 
-target_include_directories(${PROJECT_NAME} SYSTEM PRIVATE ${AVRO_INCLUDE_DIR})
 if (WITH_ETP_SSL)
-	target_include_directories(${PROJECT_NAME} SYSTEM PRIVATE ${OPENSSL_INCLUDE_DIR})
+	if (NOT USE_WINTLS_INSTEAD_OF_OPENSSL)
+		target_include_directories(${PROJECT_NAME} SYSTEM PRIVATE ${OPENSSL_INCLUDE_DIR})
+	else()
+		find_package(WINTLS REQUIRED)
+		target_link_libraries(${PROJECT_NAME} PUBLIC WINTLS::WINTLS)
+	endif()
 endif ()
 
 target_include_directories(${PROJECT_NAME} INTERFACE
@@ -224,8 +226,8 @@ target_include_directories(${PROJECT_NAME} INTERFACE
 # organizing sources and headers in the Visual Studio Project
 if (WIN32)
 	set (ETP_PREFIX "etp")
-	source_group ("${ETP_PREFIX}" FILES ${FETPAPI_SOURCES} ${FETPAPI_HEADERS})
-	source_group ("${ETP_PREFIX}\\ProtocolHandlers" FILES ${FETPAPI_PROTOCOL_SOURCES} ${FETPAPI_PROTOCOL_HEADERS})
+	source_group ("${ETP_PREFIX}" FILES ${FETPAPI_ETP_SOURCES} ${FETPAPI_ETP_HEADERS})
+	source_group ("${ETP_PREFIX}\\protocolHandlers" FILES ${FETPAPI_PROTOCOL_SOURCES} ${FETPAPI_PROTOCOL_HEADERS})
 
 	if (WITH_ETP_SSL)
 		source_group ("${ETP_PREFIX}\\ssl" FILES ${FETPAPI_SSL_SOURCES} ${FETPAPI_SSL_HEADERS})
@@ -287,7 +289,7 @@ install(EXPORT Fetpapi-export
 )
 
 INSTALL (
-	FILES ${CMAKE_CURRENT_SOURCE_DIR}/src/nsDefinitions.h
+	FILES ${CMAKE_CURRENT_SOURCE_DIR}/src/macroDefinitions.h
 	DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/fetpapi
 	COMPONENT fetpapi_headers
 )
@@ -300,7 +302,7 @@ INSTALL (
 
 INSTALL (
 	FILES ${FETPAPI_PROTOCOL_HEADERS}
-	DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/fetpapi/etp/ProtocolHandlers
+	DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/fetpapi/etp/protocolHandlers
 	COMPONENT fetpapi_headers
 )
 

README.md

@@ -12,7 +12,8 @@
 Download (build and install if necessary) third party libraries:
 - BOOST : All versions from version 1.66 should be ok but you may experience some [min/max build issues](https://github.com/boostorg/beast/issues/1980) using version 1.72 or 1.73.
 - AVRO : https://avro.apache.org/releases.html#Download (starting from version 1.9.0 [except 1.11.1](https://issues.apache.org/jira/browse/AVRO-3601), build it with the above boost library.)
-- (OPTIONALLY) OpenSSL : version 3.4 is known to work.
+- (OPTIONALLY) OpenSSL : version 3.4 is known to work. OpenSSL is mandatory on Unix environement if you want SSL/TLS support. On Windows environment, you can depends on [Wintls](https://github.com/laudrup/boost-wintls/tree/master) instead
+- (OPTIONALLY) [Wintls](https://github.com/laudrup/boost-wintls/tree/master) : Starting from version 0.9.9. Only on Windows and only if you don't want to use OpenSSL to support SSL/TLS. FYI, WinTLs uses native Windows API [(SSPI/Schannel)](https://docs.microsoft.com/en-us/windows-server/security/tls/tls-ssl-schannel-ssp-overview) functionality instead of OpenSSL for providing TLS encrypted stream functionality.
 - (OPTIONALLY) [FESAPI](https://github.com/F2I-Consulting/fesapi/releases) : All versions from version 2.7.0.0 should be ok but a minimal version of 2.11.0.0 is recommended to automatically recognize FESAPI CMake Variables using CMake find Module and build silently the EtpClient example.
 
 # Configure the build
@@ -32,9 +33,14 @@ FETPAPI uses cmake as its build tool. A 3.12 version or later of cmake is requir
 	- You will then have to also provide the path to the SWIG (version 3 as a mininum version) executable http://swig.org/download.html in the SWIG_EXECUTABLE variable (and click again on "Configure" button)
 	- you will find the wrappers in fetpapi/cs/src (fetpapi/cs also contains a VS2015 project for the wrappers) or fetpapi/python/src
 - OPTIONALLY, for SSL support, please enable the WITH_ETP_SSL variable and set the following variables :
-	- OPENSSL_INCLUDE_DIR : the OpenSSL include directory
-	- LIB_EAY_RELEASE : the OpenSSL crypto library you want to link with.
-	- SSL_EAY_RELEASE : the OpenSSL ssl library you want to link with. 
+	- If you use OpenSSL which is mandatory on Unix and optional on Windows to support SSL/TLS
+		- OPENSSL_INCLUDE_DIR : the OpenSSL include directory
+		- LIB_EAY_RELEASE : the OpenSSL crypto library you want to link with.
+		- SSL_EAY_RELEASE : the OpenSSL ssl library you want to link with.
+		- USE_WINTLS_INSTEAD_OF_OPENSSL : must be set to OFF on windows
+	- If you use Wintls on Windows to support SSL/TLS
+		- USE_WINTLS_INSTEAD_OF_OPENSSL : must be set to ON on windows
+		- WINTLS_ROOT : Path to the folder containing the include folder of Wintls
 - OPTIONALLY, for FESAPI (v2.7.0.0 as a minimal version) support (see [here](https://github.com/F2I-Consulting/fesapi) for documentation on how to build fesapi), please enable the WITH_FESAPI variable and usually set the following variable :
 	- FESAPI_ROOT : The path to the folder containing include and lib folders of FESAPI (using [our own cmake find module](./cmake/modules/FindFESAPI.cmake))
 

cmake/nsDefinitions.h cmake/macroDefinitions.h.incmake/nsDefinitions.h renamed to cmake/macroDefinitions.h.in

@@ -18,5 +18,9 @@ under the License.
 -----------------------------------------------------------------------*/
 #pragma once
 
-/** @namespace	${FETPAPI_ETP_NS} @brief The ${FETPAPI_ETP_NS} namespace. */
-#define ETP_NS ${FETPAPI_ETP_NS}
+/** @namespace	@FETPAPI_ETP_NS@ @brief The @FETPAPI_ETP_NS@ namespace. */
+#define ETP_NS @FETPAPI_ETP_NS@
+
+/** Build FETPAPI with ETP SSL support **/
+#cmakedefine01 WITH_ETP_SSL
+#cmakedefine01 USE_WINTLS_INSTEAD_OF_OPENSSL

cmake/modules/FindAVRO.cmake

@@ -31,8 +31,6 @@ Hints
 A user may set ``AVRO_ROOT`` to a avro installation root to tell this
 module where to look.
 #]=======================================================================]
-include(SelectLibraryConfigurations)
-
 set(_AVRO_SEARCHES)
 
 # Search AVRO_ROOT first if it is set.
@@ -69,6 +67,7 @@ if(NOT AVRO_LIBRARY)
     find_library(AVRO_LIBRARY_DEBUG NAMES ${AVRO_NAMES_DEBUG} NAMES_PER_DIR ${${search}} PATH_SUFFIXES lib)
   endforeach()
 
+  include(SelectLibraryConfigurations)
   select_library_configurations(AVRO)
 endif()
 
@@ -77,7 +76,7 @@ unset(AVRO_NAMES_DEBUG)
 
 mark_as_advanced(AVRO_INCLUDE_DIR)
 
-FIND_PACKAGE_HANDLE_STANDARD_ARGS(AVRO REQUIRED_VARS AVRO_LIBRARY AVRO_INCLUDE_DIR)
+find_package_handle_standard_args(AVRO REQUIRED_VARS AVRO_LIBRARY AVRO_INCLUDE_DIR)
 
 if(AVRO_FOUND)
     set(AVRO_INCLUDE_DIRS ${AVRO_INCLUDE_DIR})

cmake/modules/FindFESAPI.cmake

@@ -31,8 +31,6 @@ Hints
 A user may set ``FESAPI_ROOT`` to a fesapi installation root to tell this
 module where to look.
 #]=======================================================================]
-include(SelectLibraryConfigurations)
-
 set(_FESAPI_SEARCHES)
 
 # Search FESAPI_ROOT first if it is set.
@@ -70,6 +68,7 @@ if(NOT FESAPI_LIBRARY)
     find_library(FESAPI_LIBRARY_DEBUG NAMES ${FESAPI_NAMES_DEBUG} NAMES_PER_DIR ${${search}} PATH_SUFFIXES lib)
   endforeach()
 
+  include(SelectLibraryConfigurations)
   select_library_configurations(FESAPI)
 endif()
 
@@ -78,7 +77,7 @@ unset(FESAPI_NAMES_DEBUG)
 
 mark_as_advanced(FESAPI_INCLUDE_DIR)
 
-FIND_PACKAGE_HANDLE_STANDARD_ARGS(FESAPI REQUIRED_VARS FESAPI_LIBRARY FESAPI_INCLUDE_DIR)
+find_package_handle_standard_args(FESAPI REQUIRED_VARS FESAPI_LIBRARY FESAPI_INCLUDE_DIR)
 
 if(FESAPI_FOUND)
     set(FESAPI_INCLUDE_DIRS ${FESAPI_INCLUDE_DIR})

cmake/modules/FindWINTLS.cmake

@@ -0,0 +1,75 @@
+# Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
+# file Copyright.txt or https://cmake.org/licensing for details.
+
+#[=======================================================================[.rst:
+WINTLS
+--------
+
+Find the native WinTLS includes.
+Heavily inspired by the official FindZLIB cmake module v3.27.
+
+IMPORTED Targets
+^^^^^^^^^^^^^^^^
+
+This module defines :prop_tgt:`IMPORTED` target ``WINTLS::WINTLS``, if
+WINTLS has been found.
+
+Result Variables
+^^^^^^^^^^^^^^^^
+
+This module defines the following variables:
+
+::
+
+  WINTLS_INCLUDE_DIRS   - where to find wintls.hpp
+  WINTLS_FOUND          - True if WINTLS found.
+
+Hints
+^^^^^
+
+A user may set ``WINTLS_ROOT`` to a WINTLS installation root to tell this
+module where to look.
+#]=======================================================================]
+
+if(WINTLS_FIND_COMPONENTS AND NOT WINTLS_FIND_QUIETLY)
+  message(AUTHOR_WARNING
+    "WINTLS does not provide any COMPONENTS.  Calling\n"
+    "  find_package(WINTLS COMPONENTS ...)\n"
+    "will always fail."
+    )
+endif()
+
+set(_WINTLS_SEARCHES)
+
+# Search WINTLS_ROOT first if it is set.
+if(WINTLS_ROOT)
+  set(_WINTLS_SEARCH_ROOT PATHS ${WINTLS_ROOT} NO_DEFAULT_PATH)
+  list(APPEND _WINTLS_SEARCHES _WINTLS_SEARCH_ROOT)
+endif()
+
+# Normal search.
+set(_WINTLS_x86 "(x86)")
+set(_WINTLS_SEARCH_NORMAL
+    PATHS "$ENV{ProgramFiles}/WINTLS"
+          "$ENV{ProgramFiles${_WINTLS_x86}}/WINTLS")
+unset(_WINTLS_x86)
+list(APPEND _WINTLS_SEARCHES _WINTLS_SEARCH_NORMAL)
+
+# Try each search configuration.
+foreach(search ${_WINTLS_SEARCHES})
+  find_path(WINTLS_INCLUDE_DIR NAMES wintls.hpp ${${search}} PATH_SUFFIXES include)
+endforeach()
+
+mark_as_advanced(WINTLS_INCLUDE_DIR)
+
+find_package_handle_standard_args(WINTLS REQUIRED_VARS WINTLS_INCLUDE_DIR)
+
+if(WINTLS_FOUND)
+    set(WINTLS_INCLUDE_DIRS ${WINTLS_INCLUDE_DIR})
+
+    if(NOT TARGET WINTLS::WINTLS)
+      add_library(WINTLS::WINTLS INTERFACE IMPORTED)
+      set_target_properties(WINTLS::WINTLS PROPERTIES
+        INTERFACE_INCLUDE_DIRECTORIES "${WINTLS_INCLUDE_DIRS}")
+    endif()
+endif()

cmake/swigEtp1_2Include.i.in

@@ -40,7 +40,7 @@ under the License.
 %include "stdint.i"
 %include "std_string.i"
 
-%include "../src/nsDefinitions.h"
+%include "../src/macroDefinitions.h"
 
 //************************/
 // JAVA

cs/CMakeLists.txt

@@ -17,9 +17,6 @@ list (APPEND EXECUTE_COMMAND -csharp)
 if (WITH_FESAPI)
         list (APPEND EXECUTE_COMMAND -DWITH_FESAPI)
 endif (WITH_FESAPI)
-if (WITH_ETP_SSL)
-        list (APPEND EXECUTE_COMMAND -DWITH_ETP_SSL)
-endif (WITH_ETP_SSL)
 list (APPEND EXECUTE_COMMAND -dllimport)
 list (APPEND EXECUTE_COMMAND ${PROJECT_NAME}${CMAKE_RELEASE_POSTFIX}-${Fetpapi_VERSION_MAJOR}.${Fetpapi_VERSION_MINOR}.dll)
 list (APPEND EXECUTE_COMMAND -namespace)