Ronald Cron | f85882d | 2024-10-11 19:56:38 +0200 | [diff] [blame] | 1 | include(CMakePackageConfigHelpers) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 2 | include(GNUInstallDirs) |
| 3 | |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 4 | # Determine if TF-PSA-Crypto is being built as a subproject using add_subdirectory() |
| 5 | if(NOT DEFINED TF_PSA_CRYPTO_AS_SUBPROJECT) |
| 6 | set(TF_PSA_CRYPTO_AS_SUBPROJECT ON) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 7 | if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR) |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 8 | set(TF_PSA_CRYPTO_AS_SUBPROJECT OFF) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 9 | endif() |
| 10 | endif() |
| 11 | |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 12 | # Set the project, Mbed TLS and framework root directory. |
| 13 | set(TF_PSA_CRYPTO_DIR ${CMAKE_CURRENT_SOURCE_DIR}) |
| 14 | set(MBEDTLS_DIR ${CMAKE_CURRENT_SOURCE_DIR}/..) |
| 15 | set(MBEDTLS_FRAMEWORK_DIR ${CMAKE_CURRENT_SOURCE_DIR}/../framework) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 16 | |
Ronald Cron | b58c225 | 2024-10-04 17:19:50 +0200 | [diff] [blame] | 17 | # Put the version numbers into relevant files |
| 18 | set(version_number_files |
| 19 | doxygen/input/doc_mainpage.h |
| 20 | doxygen/tfpsacrypto.doxyfile) |
| 21 | foreach(file ${version_number_files}) |
| 22 | configure_file(${file}.in |
| 23 | ${TF_PSA_CRYPTO_DIR}/${file}) |
| 24 | endforeach(file) |
| 25 | |
| 26 | ADD_CUSTOM_TARGET(${TF_PSA_CRYPTO_TARGET_PREFIX}apidoc |
| 27 | COMMAND doxygen tfpsacrypto.doxyfile |
| 28 | WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/doxygen) |
| 29 | |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 30 | option(ENABLE_PROGRAMS "Build TF-PSA-Crypto programs." ON) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 31 | |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 32 | option(TF_PSA_CRYPTO_FATAL_WARNINGS "Compiler warnings treated as errors" ON) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 33 | if(CMAKE_HOST_WIN32) |
| 34 | # N.B. The comment on the next line is significant! If you change it, |
| 35 | # edit the sed command in prepare_release.sh that modifies |
| 36 | # CMakeLists.txt. |
| 37 | option(GEN_FILES "Generate the auto-generated files as needed" OFF) # off in development |
| 38 | else() |
| 39 | option(GEN_FILES "Generate the auto-generated files as needed" ON) |
| 40 | endif() |
| 41 | |
Ronald Cron | 4c3fa0a | 2024-07-30 10:50:39 +0200 | [diff] [blame] | 42 | # Support for package config and install to be added later. |
Ronald Cron | f85882d | 2024-10-11 19:56:38 +0200 | [diff] [blame] | 43 | option(DISABLE_PACKAGE_CONFIG_AND_INSTALL "Disable package configuration, target export and installation" ${TF_PSA_CRYPTO_AS_SUBPROJECT}) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 44 | |
| 45 | if (CMAKE_C_SIMULATE_ID) |
| 46 | set(COMPILER_ID ${CMAKE_C_SIMULATE_ID}) |
| 47 | else() |
| 48 | set(COMPILER_ID ${CMAKE_C_COMPILER_ID}) |
| 49 | endif(CMAKE_C_SIMULATE_ID) |
| 50 | |
| 51 | string(REGEX MATCH "Clang" CMAKE_COMPILER_IS_CLANG "${COMPILER_ID}") |
| 52 | string(REGEX MATCH "GNU" CMAKE_COMPILER_IS_GNU "${COMPILER_ID}") |
| 53 | string(REGEX MATCH "IAR" CMAKE_COMPILER_IS_IAR "${COMPILER_ID}") |
| 54 | string(REGEX MATCH "MSVC" CMAKE_COMPILER_IS_MSVC "${COMPILER_ID}") |
| 55 | |
| 56 | # the test suites currently have compile errors with MSVC |
| 57 | if(CMAKE_COMPILER_IS_MSVC) |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 58 | option(ENABLE_TESTING "Build TF-PSA-Crypto tests." OFF) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 59 | else() |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 60 | option(ENABLE_TESTING "Build TF-PSA-Crypto tests." ON) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 61 | endif() |
| 62 | |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 63 | option(USE_STATIC_TF_PSA_CRYPTO_LIBRARY "Build TF-PSA-Crypto static library." ON) |
| 64 | option(USE_SHARED_TF_PSA_CRYPTO_LIBRARY "Build TF-PSA-Crypto shared library." OFF) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 65 | option(LINK_WITH_PTHREAD "Explicitly link Mbed TLS library to pthread." OFF) |
| 66 | option(LINK_WITH_TRUSTED_STORAGE "Explicitly link Mbed TLS library to trusted_storage." OFF) |
| 67 | |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 68 | set(mbedcrypto_target "${TF_PSA_CRYPTO_TARGET_PREFIX}mbedcrypto") |
| 69 | if (USE_STATIC_TF_PSA_CRYPTO_LIBRARY) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 70 | set(mbedcrypto_static_target ${mbedcrypto_target}) |
| 71 | endif() |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 72 | if(USE_STATIC_TF_PSA_CRYPTO_LIBRARY AND USE_SHARED_TF_PSA_CRYPTO_LIBRARY) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 73 | string(APPEND mbedcrypto_static_target "_static") |
| 74 | endif() |
| 75 | |
| 76 | # Warning string - created as a list for compatibility with CMake 2.8 |
| 77 | set(CTR_DRBG_128_BIT_KEY_WARN_L1 "**** WARNING! MBEDTLS_CTR_DRBG_USE_128_BIT_KEY defined!\n") |
| 78 | set(CTR_DRBG_128_BIT_KEY_WARN_L2 "**** Using 128-bit keys for CTR_DRBG limits the security of generated\n") |
| 79 | set(CTR_DRBG_128_BIT_KEY_WARN_L3 "**** keys and operations that use random values generated to 128-bit security\n") |
| 80 | |
| 81 | set(CTR_DRBG_128_BIT_KEY_WARNING "${WARNING_BORDER}" |
| 82 | "${CTR_DRBG_128_BIT_KEY_WARN_L1}" |
| 83 | "${CTR_DRBG_128_BIT_KEY_WARN_L2}" |
| 84 | "${CTR_DRBG_128_BIT_KEY_WARN_L3}" |
| 85 | "${WARNING_BORDER}") |
| 86 | |
| 87 | # Python 3 is only needed here to check for configuration warnings. |
| 88 | if(NOT CMAKE_VERSION VERSION_LESS 3.15.0) |
| 89 | set(Python3_FIND_STRATEGY LOCATION) |
| 90 | find_package(Python3 COMPONENTS Interpreter) |
| 91 | if(Python3_Interpreter_FOUND) |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 92 | set(TF_PSA_CRYPTO_PYTHON_EXECUTABLE ${Python3_EXECUTABLE}) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 93 | endif() |
| 94 | else() |
| 95 | find_package(PythonInterp 3) |
| 96 | if(PYTHONINTERP_FOUND) |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 97 | set(TF_PSA_CRYPTO_PYTHON_EXECUTABLE ${PYTHON_EXECUTABLE}) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 98 | endif() |
| 99 | endif() |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 100 | if(TF_PSA_CRYPTO_PYTHON_EXECUTABLE) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 101 | |
| 102 | # If 128-bit keys are configured for CTR_DRBG, display an appropriate warning |
Ronald Cron | e9e7b76 | 2024-07-20 15:28:39 +0200 | [diff] [blame] | 103 | execute_process(COMMAND ${TF_PSA_CRYPTO_PYTHON_EXECUTABLE} ${MBEDTLS_DIR}/scripts/config.py -f ${MBEDTLS_DIR}/include/mbedtls/mbedtls_config.h get MBEDTLS_CTR_DRBG_USE_128_BIT_KEY |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 104 | RESULT_VARIABLE result) |
| 105 | if(${result} EQUAL 0) |
| 106 | message(WARNING ${CTR_DRBG_128_BIT_KEY_WARNING}) |
| 107 | endif() |
| 108 | |
| 109 | endif() |
| 110 | |
| 111 | # We now potentially need to link all executables against PThreads, if available |
| 112 | set(CMAKE_THREAD_PREFER_PTHREAD TRUE) |
| 113 | set(THREADS_PREFER_PTHREAD_FLAG TRUE) |
| 114 | find_package(Threads) |
| 115 | |
| 116 | # If this is the root project add longer list of available CMAKE_BUILD_TYPE values |
Ronald Cron | f584e97 | 2024-10-07 11:38:17 +0200 | [diff] [blame] | 117 | if(NOT TF_PSA_CRYPTO_AS_SUBPROJECT) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 118 | set(CMAKE_BUILD_TYPE ${CMAKE_BUILD_TYPE} |
| 119 | CACHE STRING "Choose the type of build: None Debug Release Coverage ASan ASanDbg MemSan MemSanDbg Check CheckFull TSan TSanDbg" |
| 120 | FORCE) |
| 121 | endif() |
| 122 | |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 123 | # Make TF_PSA_CRYPTO_CONFIG_FILE and TF_PSA_CRYPTO_USER_CONFIG_FILE into PATHs |
| 124 | set(TF_PSA_CRYPTO_CONFIG_FILE "" CACHE FILEPATH "TF-PSA-Crypto config file (overrides default).") |
| 125 | set(TF_PSA_CRYPTO_USER_CONFIG_FILE "" CACHE FILEPATH "TF-PSA-Crypto user config file (appended to default).") |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 126 | |
| 127 | # Create a symbolic link from ${base_name} in the binary directory |
| 128 | # to the corresponding path in the source directory. |
| 129 | # Note: Copies the file(s) on Windows. |
| 130 | function(link_to_source base_name) |
| 131 | set(link "${CMAKE_CURRENT_BINARY_DIR}/${base_name}") |
| 132 | set(target "${CMAKE_CURRENT_SOURCE_DIR}/${base_name}") |
| 133 | |
| 134 | # Linking to non-existent file is not desirable. At best you will have a |
| 135 | # dangling link, but when building in tree, this can create a symbolic link |
| 136 | # to itself. |
| 137 | if (EXISTS ${target} AND NOT EXISTS ${link}) |
| 138 | if (CMAKE_HOST_UNIX) |
| 139 | execute_process(COMMAND ln -s ${target} ${link} |
| 140 | RESULT_VARIABLE result |
| 141 | ERROR_VARIABLE output) |
| 142 | |
| 143 | if (NOT ${result} EQUAL 0) |
| 144 | message(FATAL_ERROR "Could not create symbolic link for: ${target} --> ${output}") |
| 145 | endif() |
| 146 | else() |
| 147 | if (IS_DIRECTORY ${target}) |
| 148 | file(GLOB_RECURSE files FOLLOW_SYMLINKS LIST_DIRECTORIES false RELATIVE ${target} "${target}/*") |
| 149 | foreach(file IN LISTS files) |
| 150 | configure_file("${target}/${file}" "${link}/${file}" COPYONLY) |
| 151 | endforeach(file) |
| 152 | else() |
| 153 | configure_file(${target} ${link} COPYONLY) |
| 154 | endif() |
| 155 | endif() |
| 156 | endif() |
| 157 | endfunction(link_to_source) |
| 158 | |
| 159 | # Get the filename without the final extension (i.e. convert "a.b.c" to "a.b") |
| 160 | function(get_name_without_last_ext dest_var full_name) |
| 161 | # Split into a list on '.' (but a cmake list is just a ';'-separated string) |
| 162 | string(REPLACE "." ";" ext_parts "${full_name}") |
| 163 | # Remove the last item if there are more than one |
| 164 | list(LENGTH ext_parts ext_parts_len) |
| 165 | if (${ext_parts_len} GREATER "1") |
| 166 | math(EXPR ext_parts_last_item "${ext_parts_len} - 1") |
| 167 | list(REMOVE_AT ext_parts ${ext_parts_last_item}) |
| 168 | endif() |
| 169 | # Convert back to a string by replacing separators with '.' |
| 170 | string(REPLACE ";" "." no_ext_name "${ext_parts}") |
| 171 | # Copy into the desired variable |
| 172 | set(${dest_var} ${no_ext_name} PARENT_SCOPE) |
| 173 | endfunction(get_name_without_last_ext) |
| 174 | |
| 175 | include(CheckCCompilerFlag) |
| 176 | |
| 177 | set(CMAKE_C_EXTENSIONS OFF) |
| 178 | set(CMAKE_C_STANDARD 99) |
| 179 | |
Ronald Cron | b247898 | 2024-10-07 16:17:07 +0200 | [diff] [blame] | 180 | function(set_base_compile_options target) |
| 181 | if(CMAKE_COMPILER_IS_GNU) |
| 182 | set_gnu_base_compile_options(${target}) |
Ronald Cron | d9e1109 | 2024-10-09 10:01:46 +0200 | [diff] [blame] | 183 | elseif(CMAKE_COMPILER_IS_CLANG) |
| 184 | set_clang_base_compile_options(${target}) |
Ronald Cron | 6f9d508 | 2024-10-09 14:54:43 +0200 | [diff] [blame] | 185 | elseif(CMAKE_COMPILER_IS_IAR) |
| 186 | set_iar_base_compile_options(${target}) |
| 187 | elseif(CMAKE_COMPILER_IS_MSVC) |
| 188 | set_msvc_base_compile_options(${target}) |
Ronald Cron | b247898 | 2024-10-07 16:17:07 +0200 | [diff] [blame] | 189 | endif() |
| 190 | endfunction(set_base_compile_options) |
| 191 | |
| 192 | function(set_gnu_base_compile_options target) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 193 | # some warnings we want are not available with old GCC versions |
| 194 | # note: starting with CMake 2.8 we could use CMAKE_C_COMPILER_VERSION |
| 195 | execute_process(COMMAND ${CMAKE_C_COMPILER} -dumpversion |
| 196 | OUTPUT_VARIABLE GCC_VERSION) |
Ronald Cron | b247898 | 2024-10-07 16:17:07 +0200 | [diff] [blame] | 197 | target_compile_options(${target} PRIVATE -Wall -Wextra -Wwrite-strings -Wmissing-prototypes) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 198 | if (GCC_VERSION VERSION_GREATER 3.0 OR GCC_VERSION VERSION_EQUAL 3.0) |
Ronald Cron | b247898 | 2024-10-07 16:17:07 +0200 | [diff] [blame] | 199 | target_compile_options(${target} PRIVATE -Wformat=2 -Wno-format-nonliteral) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 200 | endif() |
| 201 | if (GCC_VERSION VERSION_GREATER 4.3 OR GCC_VERSION VERSION_EQUAL 4.3) |
Ronald Cron | b247898 | 2024-10-07 16:17:07 +0200 | [diff] [blame] | 202 | target_compile_options(${target} PRIVATE -Wvla) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 203 | endif() |
| 204 | if (GCC_VERSION VERSION_GREATER 4.5 OR GCC_VERSION VERSION_EQUAL 4.5) |
Ronald Cron | b247898 | 2024-10-07 16:17:07 +0200 | [diff] [blame] | 205 | target_compile_options(${target} PRIVATE -Wlogical-op) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 206 | endif() |
| 207 | if (GCC_VERSION VERSION_GREATER 4.8 OR GCC_VERSION VERSION_EQUAL 4.8) |
Ronald Cron | b247898 | 2024-10-07 16:17:07 +0200 | [diff] [blame] | 208 | target_compile_options(${target} PRIVATE -Wshadow) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 209 | endif() |
| 210 | if (GCC_VERSION VERSION_GREATER 5.0) |
| 211 | CHECK_C_COMPILER_FLAG("-Wformat-signedness" C_COMPILER_SUPPORTS_WFORMAT_SIGNEDNESS) |
| 212 | if(C_COMPILER_SUPPORTS_WFORMAT_SIGNEDNESS) |
Ronald Cron | b247898 | 2024-10-07 16:17:07 +0200 | [diff] [blame] | 213 | target_compile_options(${target} PRIVATE -Wformat-signedness) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 214 | endif() |
| 215 | endif() |
| 216 | if (GCC_VERSION VERSION_GREATER 7.0 OR GCC_VERSION VERSION_EQUAL 7.0) |
Ronald Cron | b247898 | 2024-10-07 16:17:07 +0200 | [diff] [blame] | 217 | target_compile_options(${target} PRIVATE -Wformat-overflow=2 -Wformat-truncation) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 218 | endif() |
Ronald Cron | b247898 | 2024-10-07 16:17:07 +0200 | [diff] [blame] | 219 | target_compile_options(${target} PRIVATE $<$<CONFIG:Release>:-O2>) |
| 220 | target_compile_options(${target} PRIVATE $<$<CONFIG:Debug>:-O0 -g3>) |
| 221 | target_compile_options(${target} PRIVATE $<$<CONFIG:Coverage>:-O0 -g3 --coverage>) |
Ronald Cron | 4ae24f4 | 2024-10-08 17:53:13 +0200 | [diff] [blame] | 222 | set_target_properties(${target} PROPERTIES LINK_FLAGS_COVERAGE "--coverage") |
Ronald Cron | b247898 | 2024-10-07 16:17:07 +0200 | [diff] [blame] | 223 | # Old GCC versions hit a performance problem with test_suite_pkwrite |
| 224 | # "Private keey write check EC" tests when building with Asan+UBSan |
| 225 | # and -O3: those tests take more than 100x time than normal, with |
| 226 | # test_suite_pkwrite taking >3h on the CI. Observed with GCC 5.4 on |
| 227 | # Ubuntu 16.04 x86_64 and GCC 6.5 on Ubuntu 18.04 x86_64. |
| 228 | # GCC 7.5 and above on Ubuntu 18.04 appear fine. |
| 229 | # To avoid the performance problem, we use -O2 when GCC version is lower than 7.0. |
| 230 | # It doesn't slow down much even with modern compiler versions. |
| 231 | target_compile_options(${target} PRIVATE $<$<CONFIG:ASan>:-fsanitize=address -fno-common -fsanitize=undefined -fno-sanitize-recover=all>) |
| 232 | if (GCC_VERSION VERSION_LESS 7.0) |
| 233 | target_compile_options(${target} PRIVATE $<$<CONFIG:ASan>:-O2>) |
| 234 | else() |
| 235 | target_compile_options(${target} PRIVATE $<$<CONFIG:ASan>:-O3>) |
| 236 | endif() |
Ronald Cron | 4ae24f4 | 2024-10-08 17:53:13 +0200 | [diff] [blame] | 237 | set_target_properties(${target} PROPERTIES LINK_FLAGS_ASAN "-fsanitize=address -fsanitize=undefined") |
Ronald Cron | b247898 | 2024-10-07 16:17:07 +0200 | [diff] [blame] | 238 | target_compile_options(${target} PRIVATE $<$<CONFIG:ASanDbg>:-fsanitize=address -fno-common -fsanitize=undefined -fno-sanitize-recover=all -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls>) |
Ronald Cron | 4ae24f4 | 2024-10-08 17:53:13 +0200 | [diff] [blame] | 239 | set_target_properties(${target} PROPERTIES LINK_FLAGS_ASANDBG "-fsanitize=address -fsanitize=undefined") |
Ronald Cron | b247898 | 2024-10-07 16:17:07 +0200 | [diff] [blame] | 240 | target_compile_options(${target} PRIVATE $<$<CONFIG:TSan>:-fsanitize=thread -O3>) |
Ronald Cron | 4ae24f4 | 2024-10-08 17:53:13 +0200 | [diff] [blame] | 241 | set_target_properties(${target} PROPERTIES LINK_FLAGS_TSAN "-fsanitize=thread") |
Ronald Cron | b247898 | 2024-10-07 16:17:07 +0200 | [diff] [blame] | 242 | target_compile_options(${target} PRIVATE $<$<CONFIG:TSanDbg>:-fsanitize=thread -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls>) |
Ronald Cron | 4ae24f4 | 2024-10-08 17:53:13 +0200 | [diff] [blame] | 243 | set_target_properties(${target} PROPERTIES LINK_FLAGS_TSANDBG "-fsanitize=thread") |
Ronald Cron | b247898 | 2024-10-07 16:17:07 +0200 | [diff] [blame] | 244 | target_compile_options(${target} PRIVATE $<$<CONFIG:Check>:-Os>) |
| 245 | target_compile_options(${target} PRIVATE $<$<CONFIG:CheckFull>:-Os -Wcast-qual>) |
Ronald Cron | d77fad2 | 2024-10-08 09:24:31 +0200 | [diff] [blame] | 246 | |
| 247 | if(TF_PSA_CRYPTO_FATAL_WARNINGS) |
Ronald Cron | b247898 | 2024-10-07 16:17:07 +0200 | [diff] [blame] | 248 | target_compile_options(${target} PRIVATE -Werror) |
Ronald Cron | d77fad2 | 2024-10-08 09:24:31 +0200 | [diff] [blame] | 249 | endif(TF_PSA_CRYPTO_FATAL_WARNINGS) |
Ronald Cron | b247898 | 2024-10-07 16:17:07 +0200 | [diff] [blame] | 250 | endfunction(set_gnu_base_compile_options) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 251 | |
Ronald Cron | d9e1109 | 2024-10-09 10:01:46 +0200 | [diff] [blame] | 252 | function(set_clang_base_compile_options target) |
| 253 | target_compile_options(${target} PRIVATE -Wall -Wextra -Wwrite-strings -Wmissing-prototypes -Wpointer-arith -Wimplicit-fallthrough -Wshadow -Wvla -Wformat=2 -Wno-format-nonliteral) |
| 254 | target_compile_options(${target} PRIVATE $<$<CONFIG:Release>:-O2>) |
| 255 | target_compile_options(${target} PRIVATE $<$<CONFIG:Debug>:-O0 -g3>) |
| 256 | target_compile_options(${target} PRIVATE $<$<CONFIG:Coverage>:-O0 -g3 --coverage>) |
| 257 | set_target_properties(${target} PROPERTIES LINK_FLAGS_COVERAGE "--coverage") |
| 258 | target_compile_options(${target} PRIVATE $<$<CONFIG:ASan>:-fsanitize=address -fno-common -fsanitize=undefined -fno-sanitize-recover=all -O3>) |
| 259 | set_target_properties(${target} PROPERTIES LINK_FLAGS_ASAN "-fsanitize=address -fsanitize=undefined") |
| 260 | target_compile_options(${target} PRIVATE $<$<CONFIG:ASanDbg>:-fsanitize=address -fno-common -fsanitize=undefined -fno-sanitize-recover=all -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls>) |
| 261 | set_target_properties(${target} PROPERTIES LINK_FLAGS_ASANDBG "-fsanitize=address -fsanitize=undefined") |
| 262 | target_compile_options(${target} PRIVATE $<$<CONFIG:MemSan>:-fsanitize=memory>) |
| 263 | set_target_properties(${target} PROPERTIES LINK_FLAGS_MEMSAN "-fsanitize=memory") |
| 264 | target_compile_options(${target} PRIVATE $<$<CONFIG:MemSanDbg>:-fsanitize=memory -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls -fsanitize-memory-track-origins=2>) |
| 265 | set_target_properties(${target} PROPERTIES LINK_FLAGS_MEMSANDBG "-fsanitize=memory") |
| 266 | target_compile_options(${target} PRIVATE $<$<CONFIG:TSan>:-fsanitize=thread -O3>) |
| 267 | set_target_properties(${target} PROPERTIES LINK_FLAGS_TSAN "-fsanitize=thread") |
| 268 | target_compile_options(${target} PRIVATE $<$<CONFIG:TSanDbg>:-fsanitize=thread -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls>) |
| 269 | set_target_properties(${target} PROPERTIES LINK_FLAGS_TSANDBG "-fsanitize=thread") |
| 270 | target_compile_options(${target} PRIVATE $<$<CONFIG:Check>:-Os>) |
Ronald Cron | d77fad2 | 2024-10-08 09:24:31 +0200 | [diff] [blame] | 271 | |
Ronald Cron | d9e1109 | 2024-10-09 10:01:46 +0200 | [diff] [blame] | 272 | if(MBEDTLS_FATAL_WARNINGS) |
| 273 | target_compile_options(${target} PRIVATE -Werror) |
| 274 | endif(MBEDTLS_FATAL_WARNINGS) |
| 275 | endfunction(set_clang_base_compile_options) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 276 | |
Ronald Cron | 6f9d508 | 2024-10-09 14:54:43 +0200 | [diff] [blame] | 277 | function(set_iar_base_compile_options target) |
| 278 | target_compile_options(${target} PRIVATE --warn_about_c_style_casts) |
| 279 | target_compile_options(${target} PRIVATE $<$<CONFIG:Release>:-Ohz>) |
| 280 | target_compile_options(${target} PRIVATE $<$<CONFIG:Debug>:--debug -On>) |
Ronald Cron | d77fad2 | 2024-10-08 09:24:31 +0200 | [diff] [blame] | 281 | |
Ronald Cron | 6f9d508 | 2024-10-09 14:54:43 +0200 | [diff] [blame] | 282 | if(MBEDTLS_FATAL_WARNINGS) |
| 283 | target_compile_options(${target} PRIVATE --warnings_are_errors) |
| 284 | endif(MBEDTLS_FATAL_WARNINGS) |
| 285 | endfunction(set_iar_base_compile_options) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 286 | |
Ronald Cron | 6f9d508 | 2024-10-09 14:54:43 +0200 | [diff] [blame] | 287 | function(set_msvc_base_compile_options target) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 288 | # Strictest warnings, UTF-8 source and execution charset |
Ronald Cron | 6f9d508 | 2024-10-09 14:54:43 +0200 | [diff] [blame] | 289 | target_compile_options(${target} PRIVATE /W3 /utf-8) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 290 | |
Ronald Cron | 6f9d508 | 2024-10-09 14:54:43 +0200 | [diff] [blame] | 291 | if(MBEDTLS_FATAL_WARNINGS) |
| 292 | target_compile_options(${target} PRIVATE /WX) |
| 293 | endif(MBEDTLS_FATAL_WARNINGS) |
| 294 | endfunction(set_msvc_base_compile_options) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 295 | |
| 296 | if(CMAKE_BUILD_TYPE STREQUAL "Check" AND TEST_CPP) |
| 297 | set(CMAKE_CXX_STANDARD 11) |
| 298 | set(CMAKE_CXX_STANDARD_REQUIRED ON) |
| 299 | set(CMAKE_CXX_EXTENSIONS OFF) |
| 300 | if(CMAKE_COMPILER_IS_CLANG OR CMAKE_COMPILER_IS_GNU) |
| 301 | set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -pedantic") |
| 302 | endif() |
| 303 | endif() |
| 304 | |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 305 | if (NOT EXISTS "${MBEDTLS_FRAMEWORK_DIR}/CMakeLists.txt") |
| 306 | message(FATAL_ERROR "${MBEDTLS_FRAMEWORK_DIR}/CMakeLists.txt not found. Run `git submodule update --init` from the source tree to fetch the submodule contents.") |
| 307 | endif() |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 308 | |
| 309 | add_subdirectory(include) |
Ronald Cron | 31829a8 | 2024-07-29 19:06:40 +0200 | [diff] [blame] | 310 | add_subdirectory(core) |
| 311 | add_subdirectory(drivers) |
Ronald Cron | f85882d | 2024-10-11 19:56:38 +0200 | [diff] [blame] | 312 | add_subdirectory(pkgconfig) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 313 | |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 314 | # |
| 315 | # The C files in tests/src directory contain test code shared among test suites |
| 316 | # and programs. This shared test code is compiled and linked to test suites and |
| 317 | # programs objects as a set of compiled objects. The compiled objects are NOT |
| 318 | # built into a library that the test suite and program objects would link |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 319 | # against as they link against the tfpsacrypto library. The reason is that such |
Ronald Cron | 97d05e5 | 2024-07-20 15:02:50 +0200 | [diff] [blame] | 320 | # library is expected to have mutual dependencies with the aforementioned |
| 321 | # library and that there is as of today no portable way of handling such |
| 322 | # dependencies (only toolchain specific solutions). |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 323 | # |
| 324 | # Thus the below definition of the `mbedtls_test` CMake library of objects |
| 325 | # target. This library of objects is used by tests and programs CMake files |
| 326 | # to define the test executables. |
| 327 | # |
| 328 | if(ENABLE_TESTING OR ENABLE_PROGRAMS) |
| 329 | file(GLOB MBEDTLS_TEST_FILES |
Ronald Cron | e9e7b76 | 2024-07-20 15:28:39 +0200 | [diff] [blame] | 330 | ${MBEDTLS_DIR}/tests/src/*.c |
| 331 | ${MBEDTLS_DIR}/tests/src/drivers/*.c) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 332 | add_library(mbedtls_test OBJECT ${MBEDTLS_TEST_FILES}) |
Ronald Cron | b247898 | 2024-10-07 16:17:07 +0200 | [diff] [blame] | 333 | set_base_compile_options(mbedtls_test) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 334 | if(GEN_FILES) |
| 335 | add_custom_command( |
| 336 | OUTPUT |
Ronald Cron | e9e7b76 | 2024-07-20 15:28:39 +0200 | [diff] [blame] | 337 | ${MBEDTLS_DIR}/tests/src/test_keys.h |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 338 | WORKING_DIRECTORY |
Ronald Cron | e9e7b76 | 2024-07-20 15:28:39 +0200 | [diff] [blame] | 339 | ${MBEDTLS_DIR}/tests |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 340 | COMMAND |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 341 | "${TF_PSA_CRYPTO_PYTHON_EXECUTABLE}" |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 342 | "${MBEDTLS_FRAMEWORK_DIR}/scripts/generate_test_keys.py" |
| 343 | "--output" |
Ronald Cron | e9e7b76 | 2024-07-20 15:28:39 +0200 | [diff] [blame] | 344 | "${MBEDTLS_DIR}/tests/src/test_keys.h" |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 345 | DEPENDS |
| 346 | ${MBEDTLS_FRAMEWORK_DIR}/scripts/generate_test_keys.py |
| 347 | ) |
Ronald Cron | e9e7b76 | 2024-07-20 15:28:39 +0200 | [diff] [blame] | 348 | add_custom_target(test_keys_header DEPENDS ${MBEDTLS_DIR}/tests/src/test_keys.h) |
Ronald Cron | 97d05e5 | 2024-07-20 15:02:50 +0200 | [diff] [blame] | 349 | |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 350 | add_custom_command( |
| 351 | OUTPUT |
Ronald Cron | e9e7b76 | 2024-07-20 15:28:39 +0200 | [diff] [blame] | 352 | ${MBEDTLS_DIR}/tests/src/test_certs.h |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 353 | WORKING_DIRECTORY |
Ronald Cron | e9e7b76 | 2024-07-20 15:28:39 +0200 | [diff] [blame] | 354 | ${MBEDTLS_DIR}/tests |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 355 | COMMAND |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 356 | "${TF_PSA_CRYPTO_PYTHON_EXECUTABLE}" |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 357 | "${MBEDTLS_FRAMEWORK_DIR}/scripts/generate_test_cert_macros.py" |
| 358 | "--output" |
Ronald Cron | e9e7b76 | 2024-07-20 15:28:39 +0200 | [diff] [blame] | 359 | "${MBEDTLS_DIR}/tests/src/test_certs.h" |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 360 | DEPENDS |
| 361 | ${MBEDTLS_FRAMEWORK_DIR}/scripts/generate_test_cert_macros.py |
| 362 | ) |
Ronald Cron | e9e7b76 | 2024-07-20 15:28:39 +0200 | [diff] [blame] | 363 | add_custom_target(test_certs_header DEPENDS ${MBEDTLS_DIR}/tests/src/test_certs.h) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 364 | add_dependencies(mbedtls_test test_keys_header test_certs_header) |
| 365 | endif() |
| 366 | target_include_directories(mbedtls_test |
Ronald Cron | e9e7b76 | 2024-07-20 15:28:39 +0200 | [diff] [blame] | 367 | PRIVATE ${MBEDTLS_DIR}/tests/include |
| 368 | PRIVATE ${MBEDTLS_DIR}/include |
| 369 | PRIVATE include |
| 370 | PRIVATE drivers/builtin/include |
| 371 | PRIVATE core |
| 372 | PRIVATE drivers/builtin/src) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 373 | # Request C11, needed for memory poisoning tests |
| 374 | set_target_properties(mbedtls_test PROPERTIES C_STANDARD 11) |
| 375 | |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 376 | # Pass-through TF_PSA_CRYPTO_CONFIG_FILE and TF_PSA_CRYPTO_USER_CONFIG_FILE |
| 377 | if(TF_PSA_CRYPTO_CONFIG_FILE) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 378 | target_compile_definitions(mbedtls_test |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 379 | PUBLIC TF_PSA_CRYPTO_CONFIG_FILE="${TF_PSA_CRYPTO_CONFIG_FILE}") |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 380 | endif() |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 381 | if(TF_PSA_CRYPTO_USER_CONFIG_FILE) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 382 | target_compile_definitions(mbedtls_test |
Ronald Cron | 9c84726 | 2024-07-20 14:56:49 +0200 | [diff] [blame] | 383 | PUBLIC TF_PSA_CRYPTO_USER_CONFIG_FILE="${TF_PSA_CRYPTO_USER_CONFIG_FILE}") |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 384 | endif() |
| 385 | endif() |
| 386 | |
| 387 | if(ENABLE_PROGRAMS) |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 388 | add_subdirectory(programs) |
| 389 | endif() |
| 390 | |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 391 | if(ENABLE_TESTING) |
| 392 | enable_testing() |
| 393 | |
| 394 | add_subdirectory(tests) |
| 395 | |
| 396 | # additional convenience targets for Unix only |
| 397 | if(UNIX) |
Ronald Cron | d916cc9 | 2024-10-17 18:33:59 +0200 | [diff] [blame] | 398 | # For coverage testing: |
| 399 | # 1. Build with: |
| 400 | # cmake -D CMAKE_BUILD_TYPE=Coverage /path/to/source && make |
| 401 | # 2. Run the relevant tests for the part of the code you're interested in. |
| 402 | # For the reference coverage measurement, see |
| 403 | # tests/scripts/basic-build-test.sh |
| 404 | # 3. Run scripts/lcov.sh to generate an HTML report. |
| 405 | ADD_CUSTOM_TARGET(lcov |
| 406 | COMMAND ${MBEDTLS_DIR}/scripts/lcov.sh |
| 407 | ) |
| 408 | |
Ronald Cron | 701faac | 2024-07-20 14:43:53 +0200 | [diff] [blame] | 409 | ADD_CUSTOM_TARGET(memcheck |
| 410 | COMMAND sed -i.bak s+/usr/bin/valgrind+`which valgrind`+ DartConfiguration.tcl |
| 411 | COMMAND ctest -O memcheck.log -D ExperimentalMemCheck |
| 412 | COMMAND tail -n1 memcheck.log | grep 'Memory checking results:' > /dev/null |
| 413 | COMMAND rm -f memcheck.log |
| 414 | COMMAND mv DartConfiguration.tcl.bak DartConfiguration.tcl |
| 415 | ) |
| 416 | endif(UNIX) |
| 417 | |
| 418 | # Make scripts needed for testing available in an out-of-source build. |
| 419 | if (NOT ${CMAKE_CURRENT_BINARY_DIR} STREQUAL ${CMAKE_CURRENT_SOURCE_DIR}) |
| 420 | link_to_source(scripts) |
| 421 | # Copy (don't link) DartConfiguration.tcl, needed for memcheck, to |
| 422 | # keep things simple with the sed commands in the memcheck target. |
| 423 | configure_file(${CMAKE_CURRENT_SOURCE_DIR}/DartConfiguration.tcl |
| 424 | ${CMAKE_CURRENT_BINARY_DIR}/DartConfiguration.tcl COPYONLY) |
| 425 | endif() |
| 426 | endif() |
Ronald Cron | f85882d | 2024-10-11 19:56:38 +0200 | [diff] [blame] | 427 | |
| 428 | if(NOT DISABLE_PACKAGE_CONFIG_AND_INSTALL) |
| 429 | configure_package_config_file( |
| 430 | "cmake/TF-PSA-CryptoConfig.cmake.in" |
| 431 | "cmake/TF-PSA-CryptoConfig.cmake" |
| 432 | INSTALL_DESTINATION "cmake") |
| 433 | |
| 434 | write_basic_package_version_file( |
| 435 | "cmake/TF-PSA-CryptoConfigVersion.cmake" |
| 436 | COMPATIBILITY SameMajorVersion |
| 437 | VERSION 0.1.0) |
| 438 | |
| 439 | install( |
| 440 | FILES "${CMAKE_CURRENT_BINARY_DIR}/cmake/TF-PSA-CryptoConfig.cmake" |
| 441 | "${CMAKE_CURRENT_BINARY_DIR}/cmake/TF-PSA-CryptoConfigVersion.cmake" |
| 442 | DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/TF-PSA-Crypto") |
| 443 | |
| 444 | export( |
| 445 | EXPORT MbedTLSTargets |
| 446 | NAMESPACE TF-PSA-Crypto:: |
| 447 | FILE "cmake/TF-PSA-CryptoTargets.cmake") |
| 448 | |
| 449 | install( |
| 450 | EXPORT MbedTLSTargets |
| 451 | NAMESPACE TF-PSA-Crypto:: |
| 452 | DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/TF-PSA-Crypto" |
| 453 | FILE "TF-PSA-CryptoTargets.cmake") |
| 454 | |
| 455 | if(CMAKE_VERSION VERSION_GREATER 3.15 OR CMAKE_VERSION VERSION_EQUAL 3.15) |
| 456 | # Do not export the package by default |
| 457 | cmake_policy(SET CMP0090 NEW) |
| 458 | |
| 459 | # Make this package visible to the system |
| 460 | export(PACKAGE TF-PSA-Crypto) |
| 461 | endif() |
| 462 | endif() |