-cmake_minimum_required(VERSION 3.0 FATAL_ERROR)
+cmake_minimum_required(VERSION 3.18 FATAL_ERROR)
project(gost-engine LANGUAGES C)
include(GNUInstallDirs)
+include(CheckLibraryExists)
+include(CheckFunctionExists)
+include(CheckCSourceRuns)
-find_package(OpenSSL 1.1 REQUIRED)
+enable_testing()
+
+find_package(OpenSSL 3.0 REQUIRED)
+
+if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
+ message(STATUS "Setting build type to 'RelWithDebInfo' as none was specified.")
+ set(CMAKE_BUILD_TYPE "RelWithDebInfo" CACHE STRING "Choose the type of build." FORCE)
+endif()
+
+if (NOT DEFINED OPENSSL_ROOT_DIR)
+ get_filename_component(OPENSSL_ROOT_DIR ${OPENSSL_INCLUDE_DIR} DIRECTORY)
+ message(STATUS "Setting OpenSSL root: ${OPENSSL_ROOT_DIR}")
+endif()
+find_program(OPENSSL_PROGRAM openssl
+ PATHS ${OPENSSL_ROOT_DIR} PATH_SUFFIXES apps bin NO_DEFAULT_PATH)
+message(STATUS "Found OpenSSL application: ${OPENSSL_PROGRAM}")
include_directories(${OPENSSL_INCLUDE_DIR})
+set(OPENSSL_MODULES_DIR ${CMAKE_INSTALL_LIBDIR}/ossl-modules)
if (CMAKE_C_COMPILER_ID MATCHES "Clang")
- add_compile_options(-Qunused-arguments)
+ set(CMAKE_C_FLAGS_RELEASE -O2)
+ set(CMAKE_C_FLAGS_DEBUG "-O0 -ggdb")
+ set(CMAKE_C_FLAGS_RELWITHDEBINFO "-O2 -ggdb")
+ add_compile_options(-Werror -Wall -Wno-unused-parameter -Wno-unused-function -Wno-missing-braces -Qunused-arguments -Wno-deprecated-declarations)
elseif(CMAKE_C_COMPILER_ID MATCHES "GNU")
- add_compile_options(-O2 -Werror -Wall -Wno-unused-parameter -Wno-unused-function -Wno-missing-braces -ggdb)
+ set(CMAKE_C_FLAGS_RELEASE -O2)
+ set(CMAKE_C_FLAGS_DEBUG "-O0 -ggdb")
+ set(CMAKE_C_FLAGS_RELWITHDEBINFO "-O2 -ggdb")
+ add_compile_options(-Werror -Wall -Wno-unused-parameter -Wno-unused-function -Wno-missing-braces -Wno-error=unknown-pragmas -Wno-error=pragmas -Wno-deprecated-declarations)
elseif(CMAKE_C_COMPILER_ID MATCHES "MSVC")
- add_definitions(-D_CRT_SECURE_NO_WARNINGS)
- add_definitions(-D_CRT_DEPRECATED_NO_WARNINGS)
- add_definitions(-D_CRT_NONSTDC_NO_WARNINGS)
- add_compile_options(/MP /WX /W4 /wd4100 /wd4267 /wd4206 /wd4706 /wd4244 /wd4115)
+ add_definitions(-D_CRT_SECURE_NO_WARNINGS)
+ add_definitions(-D_CRT_DEPRECATED_NO_WARNINGS)
+ add_definitions(-D_CRT_NONSTDC_NO_WARNINGS)
+ add_compile_options(/MP /WX /W4 /wd4100 /wd4267 /wd4206 /wd4706 /wd4244 /wd4115 /wd4996)
+endif()
+
+if (ASAN)
+ message(STATUS "address sanitizer enabled")
+ set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=address -g3 -fno-omit-frame-pointer")
+ set(SKIP_PERL_TESTS 1)
endif()
set(CMAKE_C_STANDARD 90)
+CHECK_FUNCTION_EXISTS(clock_gettime HAVE_CLOCK_GETTIME_C)
+CHECK_LIBRARY_EXISTS(rt clock_gettime "" HAVE_CLOCK_GETTIME_RT)
+if(HAVE_CLOCK_GETTIME_RT AND NOT HAVE_CLOCK_GETTIME_C)
+ set(CLOCK_GETTIME_LIB rt)
+endif()
include (TestBigEndian)
TEST_BIG_ENDIAN(IS_BIG_ENDIAN)
add_definitions(-DL_ENDIAN)
endif()
-set(BIN_DIRECTORY bin)
+check_c_source_runs("
+ #ifdef _MSC_VER
+ # include <intrin.h>
+ #else
+ # include <x86intrin.h>
+ #endif
+ int main(void) {
+ unsigned long long x = -1, y = 1, r;
+ unsigned char cf;
+ cf = _addcarry_u64(1, x, y, &r);
+ return !(cf == 1 && r == 1);
+ }
+ " ADDCARRY_U64)
+if (ADDCARRY_U64)
+ add_definitions(-DHAVE_ADDCARRY_U64)
+endif()
+
+check_c_source_runs("
+ int main(void) {
+ char buf[16] = { 0, 1, 2 };
+ int *p = (int *)(buf + 1);
+ int *q = (int *)(buf + 2);
+ return (*p == *q);
+ }
+ " RELAXED_ALIGNMENT)
+if (NOT RELAXED_ALIGNMENT)
+ add_definitions(-DSTRICT_ALIGNMENT)
+endif()
+
+if(MSVC)
+ set(BIN_DIRECTORY bin/$<CONFIG>/)
+else()
+ set(BIN_DIRECTORY bin)
+endif()
-set(OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/${BIN_DIRECTORY})
+set(OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${BIN_DIRECTORY})
#set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${OUTPUT_DIRECTORY})
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${OUTPUT_DIRECTORY})
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${OUTPUT_DIRECTORY})
+# Remove when https://gitlab.kitware.com/cmake/cmake/issues/18525 is addressed
+set(OPENSSL_ENGINES_DIR "" CACHE PATH "OpenSSL Engines Directory")
+if ("${OPENSSL_ENGINES_DIR}" STREQUAL "")
+ include(FindPkgConfig)
+ pkg_get_variable(OPENSSL_ENGINES_DIR libcrypto enginesdir)
+ if ("${OPENSSL_ENGINES_DIR}" STREQUAL "")
+ message( FATAL_ERROR "Unable to discover the OpenSSL engines directory. Provide the path using -DOPENSSL_ENGINES_DIR" )
+ endif()
+endif()
+
set(GOST_89_SOURCE_FILES
gost89.c
gost89.h
gost_grasshopper_precompiled.c
gost_grasshopper_cipher.h
gost_grasshopper_cipher.c
- gost_grasshopper_mac.h
- gost_grasshopper_mac.c
)
-set(GOST_CORE_SOURCE_FILES
+set(GOST_ERR_SOURCE_FILES
e_gost_err.c
e_gost_err.h
+ )
+
+set(GOST_CORE_SOURCE_FILES
+ gost_ameth.c
+ gost_pmeth.c
+ gost_ctl.c
gost_asn1.c
gost_crypt.c
- gost_ctl.c
- gost_eng.c
gost_keywrap.c
gost_keywrap.h
+ gost_md.c
+ gost_md2012.c
+ gost_omac.c
+ gost_omac_acpkm.c
+ gost_gost2015.c
gost_lcl.h
gost_params.c
+ gost_keyexpimp.c
)
set(GOST_EC_SOURCE_FILES
gost_ec_keyx.c
gost_ec_sign.c
+ ecp_id_GostR3410_2001_CryptoPro_A_ParamSet.c
+ ecp_id_GostR3410_2001_CryptoPro_B_ParamSet.c
+ ecp_id_GostR3410_2001_CryptoPro_C_ParamSet.c
+ ecp_id_GostR3410_2001_TestParamSet.c
+ ecp_id_tc26_gost_3410_2012_256_paramSetA.c
+ ecp_id_tc26_gost_3410_2012_512_paramSetA.c
+ ecp_id_tc26_gost_3410_2012_512_paramSetB.c
+ ecp_id_tc26_gost_3410_2012_512_paramSetC.c
)
set (GOST_OMAC_SOURCE_FILES
gost_omac.c
+ gost_omac_acpkm.c
)
set(GOST_LIB_SOURCE_FILES
+ ${GOST_CORE_SOURCE_FILES}
${GOST_89_SOURCE_FILES}
${GOST_HASH_SOURCE_FILES}
${GOST_HASH_2012_SOURCE_FILES}
)
set(GOST_ENGINE_SOURCE_FILES
- ${GOST_CORE_SOURCE_FILES}
- gost_ameth.c
- gost_md.c
- gost_md2012.c
- gost_pmeth.c
- gost_omac.c
+ gost_eng.c
)
+set(GOST_PROV_SOURCE_FILES
+ gost_prov.c
+ gost_prov_cipher.c
+ gost_prov_digest.c
+ gost_prov_mac.c
+ )
+
+set(TEST_ENVIRONMENT_COMMON
+ CMAKE_CURRENT_SOURCE_DIR=${CMAKE_CURRENT_SOURCE_DIR}
+ PERL5LIB=${CMAKE_CURRENT_SOURCE_DIR}/test
+ OPENSSL_PROGRAM=${OPENSSL_PROGRAM}
+ OPENSSL_CRYPTO_LIBRARY=${OPENSSL_CRYPTO_LIBRARY}
+ )
+
+set(TEST_ENVIRONMENT_ENGINE
+ ${TEST_ENVIRONMENT_COMMON}
+ OPENSSL_ENGINES=${CMAKE_RUNTIME_OUTPUT_DIRECTORY}
+ OPENSSL_CONF=${CMAKE_CURRENT_SOURCE_DIR}/test/engine.cnf
+ )
+
+set(TEST_ENVIRONMENT_PROVIDER
+ ${TEST_ENVIRONMENT_COMMON}
+ OPENSSL_MODULES=${CMAKE_RUNTIME_OUTPUT_DIRECTORY}
+ OPENSSL_CONF=${CMAKE_CURRENT_SOURCE_DIR}/test/provider.cnf
+ )
+
+add_executable(test_digest test_digest.c)
+target_link_libraries(test_digest OpenSSL::Crypto)
+add_test(NAME digest-with-engine COMMAND test_digest)
+set_tests_properties(digest-with-engine
+ PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_ENGINE}")
+add_test(NAME digest-with-provider COMMAND test_digest)
+set_tests_properties(digest-with-provider
+ PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_PROVIDER}")
+
+add_executable(test_ciphers test_ciphers.c)
+target_link_libraries(test_ciphers OpenSSL::Crypto)
+add_test(NAME ciphers-with-engine COMMAND test_ciphers)
+set_tests_properties(ciphers-with-engine
+ PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_ENGINE}")
+add_test(NAME ciphers-with-provider COMMAND test_ciphers)
+set_tests_properties(ciphers-with-provider
+ PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_PROVIDER}")
+
+# test_curves is an internals testing program, it doesn't need a test env
+add_executable(test_curves test_curves.c)
+target_link_libraries(test_curves gost_core gost_err)
+add_test(NAME curves COMMAND test_curves)
+
+add_executable(test_params test_params.c)
+target_link_libraries(test_params OpenSSL::Crypto)
+add_test(NAME parameters-with-engine COMMAND test_params)
+set_tests_properties(parameters-with-engine
+ PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_ENGINE}")
+
+add_executable(test_derive test_derive.c)
+target_link_libraries(test_derive OpenSSL::Crypto)
+add_test(NAME derive-with-engine COMMAND test_derive)
+set_tests_properties(derive-with-engine
+ PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_ENGINE}")
+
+add_executable(test_sign test_sign.c)
+target_link_libraries(test_sign OpenSSL::Crypto)
+add_test(NAME sign/verify-with-engine COMMAND test_sign)
+set_tests_properties(sign/verify-with-engine
+ PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_ENGINE}")
+
+if(NOT MSVC)
+ add_executable(test_tls test_tls.c)
+ target_link_libraries(test_tls OpenSSL::SSL)
+ add_test(NAME TLS-with-engine COMMAND test_tls)
+ set_tests_properties(TLS-with-engine
+ PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_ENGINE}")
+endif()
+
+add_executable(test_context test_context.c)
+target_link_libraries(test_context OpenSSL::Crypto)
+add_test(NAME context-with-engine COMMAND test_context)
+set_tests_properties(context-with-engine
+ PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_ENGINE}")
+add_test(NAME context-with-provider COMMAND test_context)
+set_tests_properties(context-with-provider
+ PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_PROVIDER}")
+
+# test_keyexpimp is an internals testing program, it doesn't need a test env
+add_executable(test_keyexpimp test_keyexpimp.c)
+#target_compile_definitions(test_keyexpimp PUBLIC -DOPENSSL_LOAD_CONF)
+target_link_libraries(test_keyexpimp gost_core gost_err)
+add_test(NAME keyexpimp COMMAND test_keyexpimp)
+
+# test_gost89 is an internals testing program, it doesn't need a test env
+add_executable(test_gost89 test_gost89.c)
+target_link_libraries(test_gost89 gost_core gost_err)
+add_test(NAME gost89 COMMAND test_gost89)
+
+if(NOT SKIP_PERL_TESTS)
+ execute_process(COMMAND perl -MTest2::V0 -e ""
+ ERROR_QUIET RESULT_VARIABLE MISSING_TEST2_V0)
+ find_program(HAVE_PROVE NAMES prove)
+ if(NOT MISSING_TEST2_V0 AND HAVE_PROVE)
+ add_test(NAME engine
+ COMMAND prove --merge -PWrapOpenSSL ${CMAKE_CURRENT_SOURCE_DIR}/test :: engine)
+ set_tests_properties(engine PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_ENGINE}")
+ add_test(NAME provider
+ COMMAND prove --merge -PWrapOpenSSL ${CMAKE_CURRENT_SOURCE_DIR}/test :: provider)
+ set_tests_properties(provider PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_PROVIDER}")
+ else()
+ message(STATUS "No Test2::V0 perl module (engine and provider tests skipped)")
+ endif()
+endif()
+
+if(NOT MSVC)
+ add_executable(sign benchmark/sign.c)
+ target_link_libraries(sign gost_core gost_err ${CLOCK_GETTIME_LIB})
+endif()
+
+# All that may need to load just built engine will have path to it defined.
+set(BINARY_TESTS_TARGETS
+ test_digest
+ test_ciphers
+ test_curves
+ test_params
+ test_derive
+ test_sign
+ test_context
+ test_keyexpimp
+ test_gost89
+ )
+if(NOT MSVC)
+ list(APPEND BINARY_TESTS_TARGETS test_tls)
+endif()
+set_property(TARGET ${BINARY_TESTS_TARGETS} APPEND PROPERTY COMPILE_DEFINITIONS ENGINE_DIR="${OUTPUT_DIRECTORY}")
+
add_library(gost_core STATIC ${GOST_LIB_SOURCE_FILES})
set_target_properties(gost_core PROPERTIES POSITION_INDEPENDENT_CODE ON)
+target_link_libraries(gost_core PRIVATE OpenSSL::Crypto)
+add_library(gost_err STATIC ${GOST_ERR_SOURCE_FILES})
+set_target_properties(gost_err PROPERTIES POSITION_INDEPENDENT_CODE ON)
+target_link_libraries(gost_err PRIVATE OpenSSL::Crypto)
+# The GOST engine in module form
add_library(gost_engine MODULE ${GOST_ENGINE_SOURCE_FILES})
-set_target_properties(gost_engine PROPERTIES PREFIX "" OUTPUT_NAME "gost")
-target_link_libraries(gost_engine gost_core ${OPENSSL_CRYPTO_LIBRARY})
+# Set the suffix explicitly to adapt to OpenSSL's idea of what a
+# module suffix should be
+set_target_properties(gost_engine PROPERTIES
+ PREFIX "" OUTPUT_NAME "gost" SUFFIX ${CMAKE_SHARED_LIBRARY_SUFFIX})
+target_link_libraries(gost_engine PRIVATE gost_core gost_err)
+
+if (NOT MSVC)
+# The GOST engine in library form
+add_library(lib_gost_engine SHARED ${GOST_ENGINE_SOURCE_FILES})
+set_target_properties(lib_gost_engine PROPERTIES
+ COMPILE_DEFINITIONS "BUILDING_ENGINE_AS_LIBRARY"
+ PUBLIC_HEADER gost-engine.h
+ OUTPUT_NAME "gost")
+target_link_libraries(lib_gost_engine PRIVATE gost_core gost_err)
+endif()
+
+# The GOST provider uses this
+add_subdirectory(libprov)
+
+# The GOST provider in module form
+add_library(gost_prov MODULE
+ ${GOST_PROV_SOURCE_FILES} ${GOST_ENGINE_SOURCE_FILES}
+ )
+set_target_properties(gost_prov PROPERTIES
+ PREFIX "" OUTPUT_NAME "gostprov" SUFFIX ${CMAKE_SHARED_LIBRARY_SUFFIX}
+ COMPILE_DEFINITIONS "BUILDING_GOST_PROVIDER;OPENSSL_NO_DYNAMIC_ENGINE"
+ )
+target_link_libraries(gost_prov PRIVATE gost_core libprov)
+
+if (NOT MSVC)
+# The GOST provider in library form
+add_library(lib_gost_prov SHARED
+ ${GOST_PROV_SOURCE_FILES} ${GOST_ENGINE_SOURCE_FILES}
+ )
+set_target_properties(lib_gost_prov PROPERTIES
+ OUTPUT_NAME "gostprov"
+ COMPILE_DEFINITIONS "BUILDING_GOST_PROVIDER;BUILDING_PROVIDER_AS_LIBRARY;OPENSSL_NO_DYNAMIC_ENGINE"
+ )
+target_link_libraries(lib_gost_prov PRIVATE gost_core libprov)
+endif()
set(GOST_SUM_SOURCE_FILES
gostsum.c
)
add_executable(gostsum ${GOST_SUM_SOURCE_FILES})
-target_link_libraries(gostsum gost_core)
+target_link_libraries(gostsum gost_core gost_err)
set(GOST_12_SUM_SOURCE_FILES
gost12sum.c
)
add_executable(gost12sum ${GOST_12_SUM_SOURCE_FILES})
-target_link_libraries(gost12sum gost_core)
+target_link_libraries(gost12sum gost_core gost_err)
set_source_files_properties(tags PROPERTIES GENERATED true)
add_custom_target(tags
COMMAND ctags -R . ${OPENSSL_ROOT_DIR}
WORKING_DIRECTORY ${CMAKE_SOURCE_DIR})
-# install
-set(OPENSSL_ENGINES_INSTALL_DIR ${CMAKE_INSTALL_LIBDIR}/engines-${OPENSSL_VERSION_MAJOR}_${OPENSSL_VERSION_MINOR})
-set(OPENSSL_MAN_INSTALL_DIR ${CMAKE_INSTALL_MANDIR}/man1)
+add_custom_target(tcl_tests
+ COMMAND OPENSSL_LIBCRYPTO=${OPENSSL_CRYPTO_LIBRARY}
+ OPENSSL_APP=${OPENSSL_PROGRAM}
+ TESTSRC=${CMAKE_SOURCE_DIR}/tcl_tests
+ TESTDIR=${CMAKE_BINARY_DIR}/tcl_tests
+ ENGINE_DIR=${CMAKE_RUNTIME_OUTPUT_DIRECTORY}
+ sh ./runtest.sh
+ WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/tcl_tests)
+
+add_executable(test_tlstree test_tlstree.c)
+target_link_libraries(test_tlstree PUBLIC OpenSSL::Crypto)
+
+# install programs and manuals
+install(TARGETS gostsum gost12sum RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
+install(FILES gostsum.1 gost12sum.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1)
+
+# install engine and provider in module form
+install(TARGETS gost_engine EXPORT GostEngineConfig
+ LIBRARY DESTINATION ${OPENSSL_ENGINES_DIR}
+ RUNTIME DESTINATION ${OPENSSL_ENGINES_DIR})
+install(TARGETS gost_prov EXPORT GostProviderConfig
+ LIBRARY DESTINATION ${OPENSSL_MODULES_DIR}
+ RUNTIME DESTINATION ${OPENSSL_MODULES_DIR})
+if (NOT MSVC)
+# install engine and provider in library form
+install(TARGETS lib_gost_engine EXPORT GostEngineConfig
+ LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR})
+install(TARGETS lib_gost_prov EXPORT GostProviderConfig
+ LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR})
+endif()
-install(TARGETS gost_engine gostsum gost12sum EXPORT GostEngineConfig
- LIBRARY DESTINATION ${OPENSSL_ENGINES_INSTALL_DIR}
- RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
-install(FILES gostsum.1 gost12sum.1 DESTINATION ${OPENSSL_MAN_INSTALL_DIR})
if (MSVC)
- install(FILES $<TARGET_PDB_FILE:gost_engine> DESTINATION ${OPENSSL_ENGINES_INSTALL_DIR} OPTIONAL)
- install(FILES $<TARGET_PDB_FILE:gostsum> $<TARGET_PDB_FILE:gost12sum> DESTINATION ${CMAKE_INSTALL_BINDIR} OPTIONAL)
+ install(FILES $<TARGET_PDB_FILE:gostsum> $<TARGET_PDB_FILE:gost12sum>
+ EXPORT GostEngineConfig DESTINATION ${CMAKE_INSTALL_BINDIR} OPTIONAL)
+ install(FILES $<TARGET_PDB_FILE:gost_engine>
+ EXPORT GostEngineConfig DESTINATION ${OPENSSL_ENGINES_DIR} OPTIONAL)
+ install(FILES $<TARGET_PDB_FILE:gost_prov>
+ EXPORT GostProviderConfig DESTINATION ${OPENSSL_MODULES_DIR} OPTIONAL)
endif()
+install(EXPORT GostEngineConfig DESTINATION GostEngine/share/cmake/GostEngine)
+install(EXPORT GostProviderConfig DESTINATION GostEngine/share/cmake/GostProvider)