CMakeLists.txt

   1 cmake_minimum_required(VERSION 3.18 FATAL_ERROR)
   2 project(gost-engine LANGUAGES C)
   3
   4 include(GNUInstallDirs)
   5 include(CheckLibraryExists)
   6 include(CheckFunctionExists)
   7 include(CheckCSourceRuns)
   8
   9 enable_testing()
  10
  11 find_package(OpenSSL 3.0 REQUIRED)
  12
  13 if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
  14   message(STATUS "Setting build type to 'RelWithDebInfo' as none was specified.")
  15   set(CMAKE_BUILD_TYPE "RelWithDebInfo" CACHE STRING "Choose the type of build." FORCE)
  16 endif()
  17
  18 if (NOT DEFINED OPENSSL_ROOT_DIR)
  19   get_filename_component(OPENSSL_ROOT_DIR ${OPENSSL_INCLUDE_DIR} DIRECTORY)
  20   message(STATUS "Setting OpenSSL root: ${OPENSSL_ROOT_DIR}")
  21 endif()
  22 find_program(OPENSSL_PROGRAM openssl
  23   PATHS ${OPENSSL_ROOT_DIR} PATH_SUFFIXES apps bin NO_DEFAULT_PATH)
  24 message(STATUS "Found OpenSSL application: ${OPENSSL_PROGRAM}")
  25 include_directories(${OPENSSL_INCLUDE_DIR})
  26 set(OPENSSL_MODULES_DIR ${CMAKE_INSTALL_LIBDIR}/ossl-modules)
  27
  28 if (CMAKE_C_COMPILER_ID MATCHES "Clang")
  29   set(CMAKE_C_FLAGS_RELEASE -O2)
  30   set(CMAKE_C_FLAGS_DEBUG "-O0 -ggdb")
  31   set(CMAKE_C_FLAGS_RELWITHDEBINFO "-O2 -ggdb")
  32   add_compile_options(-Werror -Wall -Wno-unused-parameter -Wno-unused-function -Wno-missing-braces -Qunused-arguments -Wno-deprecated-declarations)
  33 elseif(CMAKE_C_COMPILER_ID MATCHES "GNU")
  34   set(CMAKE_C_FLAGS_RELEASE -O2)
  35   set(CMAKE_C_FLAGS_DEBUG "-O0 -ggdb")
  36   set(CMAKE_C_FLAGS_RELWITHDEBINFO "-O2 -ggdb")
  37   add_compile_options(-Werror -Wall -Wno-unused-parameter -Wno-unused-function -Wno-missing-braces -Wno-error=unknown-pragmas -Wno-error=pragmas -Wno-deprecated-declarations)
  38 elseif(CMAKE_C_COMPILER_ID MATCHES "MSVC")
  39   add_definitions(-D_CRT_SECURE_NO_WARNINGS)
  40   add_definitions(-D_CRT_DEPRECATED_NO_WARNINGS)
  41   add_definitions(-D_CRT_NONSTDC_NO_WARNINGS)
  42   add_compile_options(/MP /WX /W4 /wd4100 /wd4267 /wd4206 /wd4706 /wd4244 /wd4115 /wd4996)
  43 endif()
  44
  45 if (ASAN)
  46   message(STATUS "address sanitizer enabled")
  47   set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=address -g3 -fno-omit-frame-pointer")
  48   set(SKIP_PERL_TESTS 1)
  49 endif()
  50
  51 set(CMAKE_C_STANDARD 90)
  52 CHECK_FUNCTION_EXISTS(clock_gettime HAVE_CLOCK_GETTIME_C)
  53 CHECK_LIBRARY_EXISTS(rt clock_gettime "" HAVE_CLOCK_GETTIME_RT)
  54 if(HAVE_CLOCK_GETTIME_RT AND NOT HAVE_CLOCK_GETTIME_C)
  55   set(CLOCK_GETTIME_LIB rt)
  56 endif()
  57
  58 include (TestBigEndian)
  59 TEST_BIG_ENDIAN(IS_BIG_ENDIAN)
  60 if(IS_BIG_ENDIAN)
  61  message(STATUS "BIG_ENDIAN")
  62 else()
  63  message(STATUS "LITTLE_ENDIAN")
  64  add_definitions(-DL_ENDIAN)
  65 endif()
  66
  67 check_c_source_runs("
  68   #ifdef _MSC_VER
  69   # include <intrin.h>
  70   #else
  71   # include <x86intrin.h>
  72   #endif
  73   int main(void) {
  74     unsigned long long x = -1, y = 1, r;
  75     unsigned char cf;
  76     cf = _addcarry_u64(1, x, y, &r);
  77     return !(cf == 1 && r == 1);
  78   }
  79   " ADDCARRY_U64)
  80 if (ADDCARRY_U64)
  81   add_definitions(-DHAVE_ADDCARRY_U64)
  82 endif()
  83
  84 check_c_source_runs("
  85   int main(void) {
  86     char buf[16] = { 0, 1, 2 };
  87     int *p = (int *)(buf + 1);
  88     int *q = (int *)(buf + 2);
  89     return (*p == *q);
  90   }
  91   " RELAXED_ALIGNMENT)
  92 if (NOT RELAXED_ALIGNMENT)
  93   add_definitions(-DSTRICT_ALIGNMENT)
  94 endif()
  95
  96 if(MSVC)
  97   set(BIN_DIRECTORY bin/$<CONFIG>/)
  98 else()
  99   set(BIN_DIRECTORY bin)
 100 endif()
 101
 102 set(OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${BIN_DIRECTORY})
 103
 104 #set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${OUTPUT_DIRECTORY})
 105 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${OUTPUT_DIRECTORY})
 106 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${OUTPUT_DIRECTORY})
 107
 108 # Remove when https://gitlab.kitware.com/cmake/cmake/issues/18525 is addressed
 109 set(OPENSSL_ENGINES_DIR "" CACHE PATH "OpenSSL Engines Directory")
 110 if ("${OPENSSL_ENGINES_DIR}" STREQUAL "")
 111         include(FindPkgConfig)
 112         pkg_get_variable(OPENSSL_ENGINES_DIR libcrypto enginesdir)
 113         if ("${OPENSSL_ENGINES_DIR}" STREQUAL "")
 114                 message( FATAL_ERROR "Unable to discover the OpenSSL engines directory. Provide the path using -DOPENSSL_ENGINES_DIR" )
 115         endif()
 116 endif()
 117
 118 set(GOST_89_SOURCE_FILES
 119         gost89.c
 120         gost89.h
 121         )
 122
 123 set(GOST_HASH_SOURCE_FILES
 124         gosthash.c
 125         gosthash.h
 126         )
 127
 128 set(GOST_HASH_2012_SOURCE_FILES
 129         gosthash2012.c
 130         gosthash2012.h
 131         gosthash2012_const.h
 132         gosthash2012_precalc.h
 133         gosthash2012_ref.h
 134         gosthash2012_sse2.h
 135         )
 136
 137 set(GOST_GRASSHOPPER_SOURCE_FILES
 138         gost_grasshopper.h
 139         gost_grasshopper_core.h
 140         gost_grasshopper_core.c
 141         gost_grasshopper_defines.h
 142         gost_grasshopper_defines.c
 143         gost_grasshopper_math.h
 144         gost_grasshopper_galois_precompiled.c
 145         gost_grasshopper_precompiled.c
 146         gost_grasshopper_cipher.h
 147         gost_grasshopper_cipher.c
 148         )
 149
 150 set(GOST_ERR_SOURCE_FILES
 151         e_gost_err.c
 152         e_gost_err.h
 153         )
 154
 155 set(GOST_CORE_SOURCE_FILES
 156         gost_ameth.c
 157         gost_pmeth.c
 158         gost_ctl.c
 159         gost_asn1.c
 160         gost_crypt.c
 161         gost_keywrap.c
 162         gost_keywrap.h
 163         gost_md.c
 164         gost_md2012.c
 165         gost_omac.c
 166         gost_omac_acpkm.c
 167         gost_gost2015.c
 168         gost_lcl.h
 169         gost_params.c
 170         gost_keyexpimp.c
 171         )
 172
 173 set(GOST_EC_SOURCE_FILES
 174         gost_ec_keyx.c
 175         gost_ec_sign.c
 176         ecp_id_GostR3410_2001_CryptoPro_A_ParamSet.c
 177         ecp_id_GostR3410_2001_CryptoPro_B_ParamSet.c
 178         ecp_id_GostR3410_2001_CryptoPro_C_ParamSet.c
 179         ecp_id_GostR3410_2001_TestParamSet.c
 180         ecp_id_tc26_gost_3410_2012_256_paramSetA.c
 181         ecp_id_tc26_gost_3410_2012_512_paramSetA.c
 182         ecp_id_tc26_gost_3410_2012_512_paramSetB.c
 183         ecp_id_tc26_gost_3410_2012_512_paramSetC.c
 184         )
 185
 186 set (GOST_OMAC_SOURCE_FILES
 187         gost_omac.c
 188         gost_omac_acpkm.c
 189         )
 190
 191 set(GOST_LIB_SOURCE_FILES
 192         ${GOST_CORE_SOURCE_FILES}
 193         ${GOST_89_SOURCE_FILES}
 194         ${GOST_HASH_SOURCE_FILES}
 195         ${GOST_HASH_2012_SOURCE_FILES}
 196         ${GOST_GRASSHOPPER_SOURCE_FILES}
 197         ${GOST_EC_SOURCE_FILES}
 198         ${GOST_OMAC_SOURCE_FILES}
 199         )
 200
 201 set(GOST_ENGINE_SOURCE_FILES
 202         gost_eng.c
 203         )
 204
 205 set(GOST_PROV_SOURCE_FILES
 206         gost_prov.c
 207         gost_prov_cipher.c
 208         gost_prov_digest.c
 209         gost_prov_mac.c
 210         )
 211
 212 set(TEST_ENVIRONMENT_COMMON
 213         CMAKE_CURRENT_SOURCE_DIR=${CMAKE_CURRENT_SOURCE_DIR}
 214         PERL5LIB=${CMAKE_CURRENT_SOURCE_DIR}/test
 215         OPENSSL_PROGRAM=${OPENSSL_PROGRAM}
 216         OPENSSL_CRYPTO_LIBRARY=${OPENSSL_CRYPTO_LIBRARY}
 217         )
 218
 219 set(TEST_ENVIRONMENT_ENGINE
 220         ${TEST_ENVIRONMENT_COMMON}
 221         OPENSSL_ENGINES=${CMAKE_RUNTIME_OUTPUT_DIRECTORY}
 222         OPENSSL_CONF=${CMAKE_CURRENT_SOURCE_DIR}/test/engine.cnf
 223         )
 224
 225 set(TEST_ENVIRONMENT_PROVIDER
 226         ${TEST_ENVIRONMENT_COMMON}
 227         OPENSSL_MODULES=${CMAKE_RUNTIME_OUTPUT_DIRECTORY}
 228         OPENSSL_CONF=${CMAKE_CURRENT_SOURCE_DIR}/test/provider.cnf
 229         )
 230
 231 add_executable(test_digest test_digest.c)
 232 target_link_libraries(test_digest OpenSSL::Crypto)
 233 add_test(NAME digest-with-engine COMMAND test_digest)
 234 set_tests_properties(digest-with-engine
 235   PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_ENGINE}")
 236 add_test(NAME digest-with-provider COMMAND test_digest)
 237 set_tests_properties(digest-with-provider
 238   PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_PROVIDER}")
 239
 240 add_executable(test_ciphers test_ciphers.c)
 241 target_link_libraries(test_ciphers OpenSSL::Crypto)
 242 add_test(NAME ciphers-with-engine COMMAND test_ciphers)
 243 set_tests_properties(ciphers-with-engine
 244   PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_ENGINE}")
 245 add_test(NAME ciphers-with-provider COMMAND test_ciphers)
 246 set_tests_properties(ciphers-with-provider
 247   PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_PROVIDER}")
 248
 249 # test_curves is an internals testing program, it doesn't need a test env
 250 add_executable(test_curves test_curves.c)
 251 target_link_libraries(test_curves gost_core gost_err)
 252 add_test(NAME curves COMMAND test_curves)
 253
 254 add_executable(test_params test_params.c)
 255 target_link_libraries(test_params OpenSSL::Crypto)
 256 add_test(NAME parameters-with-engine COMMAND test_params)
 257 set_tests_properties(parameters-with-engine
 258   PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_ENGINE}")
 259
 260 add_executable(test_derive test_derive.c)
 261 target_link_libraries(test_derive OpenSSL::Crypto)
 262 add_test(NAME derive-with-engine COMMAND test_derive)
 263 set_tests_properties(derive-with-engine
 264   PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_ENGINE}")
 265
 266 add_executable(test_sign test_sign.c)
 267 target_link_libraries(test_sign OpenSSL::Crypto)
 268 add_test(NAME sign/verify-with-engine COMMAND test_sign)
 269 set_tests_properties(sign/verify-with-engine
 270   PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_ENGINE}")
 271
 272 add_executable(test_tls test_tls.c)
 273 target_link_libraries(test_tls OpenSSL::SSL)
 274 add_test(NAME TLS-with-engine COMMAND test_tls)
 275 set_tests_properties(TLS-with-engine
 276   PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_ENGINE}")
 277
 278 add_executable(test_context test_context.c)
 279 target_link_libraries(test_context OpenSSL::Crypto)
 280 add_test(NAME context-with-engine COMMAND test_context)
 281 set_tests_properties(context-with-engine
 282   PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_ENGINE}")
 283 add_test(NAME context-with-provider COMMAND test_context)
 284 set_tests_properties(context-with-provider
 285   PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_PROVIDER}")
 286
 287 # test_keyexpimp is an internals testing program, it doesn't need a test env
 288 add_executable(test_keyexpimp test_keyexpimp.c)
 289 #target_compile_definitions(test_keyexpimp PUBLIC -DOPENSSL_LOAD_CONF)
 290 target_link_libraries(test_keyexpimp gost_core gost_err)
 291 add_test(NAME keyexpimp COMMAND test_keyexpimp)
 292
 293 # test_gost89 is an internals testing program, it doesn't need a test env
 294 add_executable(test_gost89 test_gost89.c)
 295 target_link_libraries(test_gost89 gost_core gost_err)
 296 add_test(NAME gost89 COMMAND test_gost89)
 297
 298 add_executable(test_mgm test_mgm.c)
 299 target_link_libraries(test_mgm OpenSSL::Crypto)
 300 add_test(NAME mgm-with-engine COMMAND test_mgm)
 301 set_tests_properties(mgm-with-engine
 302   PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_ENGINE}")
 303 add_test(NAME mgm-with-provider COMMAND test_mgm)
 304 set_tests_properties(mgm-with-provider
 305   PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_PROVIDER}")
 306
 307 if(NOT SKIP_PERL_TESTS)
 308     execute_process(COMMAND perl -MTest2::V0 -e ""
 309        ERROR_QUIET RESULT_VARIABLE MISSING_TEST2_V0)
 310     find_program(HAVE_PROVE NAMES prove)
 311     if(NOT MISSING_TEST2_V0 AND HAVE_PROVE)
 312         add_test(NAME engine
 313             COMMAND prove --merge -PWrapOpenSSL ${CMAKE_CURRENT_SOURCE_DIR}/test :: engine)
 314         set_tests_properties(engine PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_ENGINE}")
 315         add_test(NAME provider
 316             COMMAND prove --merge -PWrapOpenSSL ${CMAKE_CURRENT_SOURCE_DIR}/test :: provider)
 317         set_tests_properties(provider PROPERTIES ENVIRONMENT "${TEST_ENVIRONMENT_PROVIDER}")
 318     else()
 319         message(STATUS "No Test2::V0 perl module (engine and provider tests skipped)")
 320     endif()
 321 endif()
 322
 323 if(NOT MSVC)
 324   add_executable(sign benchmark/sign.c)
 325   target_link_libraries(sign gost_core gost_err ${CLOCK_GETTIME_LIB})
 326 endif()
 327
 328 # All that may need to load just built engine will have path to it defined.
 329 set(BINARY_TESTS_TARGETS
 330         test_digest
 331         test_ciphers
 332         test_curves
 333         test_params
 334         test_derive
 335         test_sign
 336         test_context
 337         test_keyexpimp
 338         test_gost89
 339         test_tls
 340         test_mgm
 341         )
 342 set_property(TARGET ${BINARY_TESTS_TARGETS} APPEND PROPERTY COMPILE_DEFINITIONS ENGINE_DIR="${OUTPUT_DIRECTORY}")
 343
 344 add_library(gost_core STATIC ${GOST_LIB_SOURCE_FILES})
 345 set_target_properties(gost_core PROPERTIES POSITION_INDEPENDENT_CODE ON)
 346 target_link_libraries(gost_core PRIVATE OpenSSL::Crypto)
 347 add_library(gost_err STATIC ${GOST_ERR_SOURCE_FILES})
 348 set_target_properties(gost_err PROPERTIES POSITION_INDEPENDENT_CODE ON)
 349 target_link_libraries(gost_err PRIVATE OpenSSL::Crypto)
 350
 351 # The GOST engine in module form
 352 add_library(gost_engine MODULE ${GOST_ENGINE_SOURCE_FILES})
 353 # Set the suffix explicitly to adapt to OpenSSL's idea of what a
 354 # module suffix should be
 355 set_target_properties(gost_engine PROPERTIES
 356   PREFIX "" OUTPUT_NAME "gost" SUFFIX ${CMAKE_SHARED_LIBRARY_SUFFIX})
 357 target_link_libraries(gost_engine PRIVATE gost_core gost_err)
 358
 359 if (NOT MSVC)
 360 # The GOST engine in library form
 361 add_library(lib_gost_engine SHARED ${GOST_ENGINE_SOURCE_FILES})
 362 set_target_properties(lib_gost_engine PROPERTIES
 363   COMPILE_DEFINITIONS "BUILDING_ENGINE_AS_LIBRARY"
 364   PUBLIC_HEADER gost-engine.h
 365   OUTPUT_NAME "gost")
 366 target_link_libraries(lib_gost_engine PRIVATE gost_core gost_err)
 367 endif()
 368
 369 # The GOST provider uses this
 370 add_subdirectory(libprov)
 371
 372 # The GOST provider in module form
 373 add_library(gost_prov MODULE
 374   ${GOST_PROV_SOURCE_FILES} ${GOST_ENGINE_SOURCE_FILES}
 375   )
 376 set_target_properties(gost_prov PROPERTIES
 377   PREFIX "" OUTPUT_NAME "gostprov" SUFFIX ${CMAKE_SHARED_LIBRARY_SUFFIX}
 378   COMPILE_DEFINITIONS "BUILDING_GOST_PROVIDER;OPENSSL_NO_DYNAMIC_ENGINE"
 379   )
 380 target_link_libraries(gost_prov PRIVATE gost_core libprov)
 381
 382 if (NOT MSVC)
 383 # The GOST provider in library form
 384 add_library(lib_gost_prov SHARED
 385   ${GOST_PROV_SOURCE_FILES} ${GOST_ENGINE_SOURCE_FILES}
 386   )
 387 set_target_properties(lib_gost_prov PROPERTIES
 388   OUTPUT_NAME "gostprov"
 389   COMPILE_DEFINITIONS "BUILDING_GOST_PROVIDER;BUILDING_PROVIDER_AS_LIBRARY;OPENSSL_NO_DYNAMIC_ENGINE"
 390   )
 391 target_link_libraries(lib_gost_prov PRIVATE gost_core libprov)
 392 endif()
 393
 394 set(GOST_SUM_SOURCE_FILES
 395         gostsum.c
 396         )
 397
 398 add_executable(gostsum ${GOST_SUM_SOURCE_FILES})
 399 target_link_libraries(gostsum gost_core gost_err)
 400
 401 set(GOST_12_SUM_SOURCE_FILES
 402         gost12sum.c
 403         )
 404
 405 add_executable(gost12sum ${GOST_12_SUM_SOURCE_FILES})
 406 target_link_libraries(gost12sum gost_core gost_err)
 407
 408 set_source_files_properties(tags PROPERTIES GENERATED true)
 409 add_custom_target(tags
 410     COMMAND ctags -R . ${OPENSSL_ROOT_DIR}
 411     WORKING_DIRECTORY ${CMAKE_SOURCE_DIR})
 412
 413 add_custom_target(tcl_tests
 414     COMMAND OPENSSL_LIBCRYPTO=${OPENSSL_CRYPTO_LIBRARY}
 415             OPENSSL_APP=${OPENSSL_PROGRAM}
 416             TESTSRC=${CMAKE_SOURCE_DIR}/tcl_tests
 417             TESTDIR=${CMAKE_BINARY_DIR}/tcl_tests
 418             ENGINE_DIR=${CMAKE_RUNTIME_OUTPUT_DIRECTORY}
 419             sh ./runtest.sh
 420     WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/tcl_tests)
 421
 422 add_executable(test_tlstree test_tlstree.c)
 423 target_link_libraries(test_tlstree PUBLIC OpenSSL::Crypto)
 424
 425 # install programs and manuals
 426 install(TARGETS gostsum gost12sum RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR})
 427 install(FILES gostsum.1 gost12sum.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1)
 428
 429 # install engine and provider in module form
 430 install(TARGETS gost_engine EXPORT GostEngineConfig
 431         LIBRARY  DESTINATION ${OPENSSL_ENGINES_DIR}
 432         RUNTIME  DESTINATION ${OPENSSL_ENGINES_DIR})
 433 install(TARGETS gost_prov EXPORT GostProviderConfig
 434         LIBRARY  DESTINATION ${OPENSSL_MODULES_DIR}
 435         RUNTIME  DESTINATION ${OPENSSL_MODULES_DIR})
 436 if (NOT MSVC)
 437 # install engine and provider in library form
 438 install(TARGETS lib_gost_engine EXPORT GostEngineConfig
 439         LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR})
 440 install(TARGETS lib_gost_prov EXPORT GostProviderConfig
 441         LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR})
 442 endif()
 443
 444 if (MSVC)
 445   install(FILES $<TARGET_PDB_FILE:gostsum> $<TARGET_PDB_FILE:gost12sum>
 446     EXPORT GostEngineConfig DESTINATION ${CMAKE_INSTALL_BINDIR} OPTIONAL)
 447   install(FILES $<TARGET_PDB_FILE:gost_engine>
 448     EXPORT GostEngineConfig DESTINATION ${OPENSSL_ENGINES_DIR} OPTIONAL)
 449   install(FILES $<TARGET_PDB_FILE:gost_prov>
 450     EXPORT GostProviderConfig DESTINATION ${OPENSSL_MODULES_DIR} OPTIONAL)
 451 endif()
 452 install(EXPORT GostEngineConfig DESTINATION share/cmake/GostEngine)
 453 install(EXPORT GostProviderConfig DESTINATION share/cmake/GostProvider)