blob: 5ab75b10a7cf75e7d74766a98eda6e6e39bad0bd [file] [log] [blame]
Ronald Cronb1790af2020-05-20 15:34:47 +02001#
2# CMake build system design considerations:
3#
4# - Include directories:
5# + Do not define include directories globally using the include_directories
6# command but rather at the target level using the
7# target_include_directories command. That way, it is easier to guarantee
8# that targets are built using the proper list of include directories.
Shaun Case8b0ecbc2021-12-20 21:14:10 -08009# + Use the PUBLIC and PRIVATE keywords to specify the scope of include
Ronald Cronb1790af2020-05-20 15:34:47 +020010# directories. That way, a target linking to a library (using the
bootstrap-prime6dbbf442022-05-17 19:30:44 -040011# target_link_libraries command) inherits from the library PUBLIC include
Ronald Cronb1790af2020-05-20 15:34:47 +020012# directories and not from the PRIVATE ones.
Raef Coles995c66f2020-10-13 16:30:41 +010013# - MBEDTLS_TARGET_PREFIX: CMake targets are designed to be alterable by calling
14# CMake in order to avoid target name clashes, via the use of
15# MBEDTLS_TARGET_PREFIX. The value of this variable is prefixed to the
16# mbedtls, mbedx509, mbedcrypto and apidoc targets.
Ronald Cronb1790af2020-05-20 15:34:47 +020017#
18
Dave Rodgmanbe4af042021-06-04 17:04:20 +010019# We specify a minimum requirement of 3.10.2, but for now use 3.5.1 here
20# until our infrastructure catches up.
21cmake_minimum_required(VERSION 3.5.1)
Paul Elliottb250ac92020-09-18 18:15:07 +010022
Chris Kayd259e342021-03-25 16:03:25 +000023include(CMakePackageConfigHelpers)
24
Ronald Cron977766c2024-07-11 08:47:53 +020025# Include convenience functions for printing properties and variables, like
26# cmake_print_properties(), cmake_print_variables().
27include(CMakePrintHelpers)
28
Paul Elliottb250ac92020-09-18 18:15:07 +010029# https://cmake.org/cmake/help/latest/policy/CMP0011.html
30# Setting this policy is required in CMake >= 3.18.0, otherwise a warning is generated. The OLD
31# policy setting is deprecated, and will be removed in future versions.
32cmake_policy(SET CMP0011 NEW)
33# https://cmake.org/cmake/help/latest/policy/CMP0012.html
34# Setting the CMP0012 policy to NEW is required for FindPython3 to work with CMake 3.18.2
35# (there is a bug in this particular version), otherwise, setting the CMP0012 policy is required
36# for CMake versions >= 3.18.3 otherwise a deprecated warning is generated. The OLD policy setting
37# is deprecated and will be removed in future versions.
38cmake_policy(SET CMP0012 NEW)
39
Andrzej Kurek0211c322018-03-15 05:16:24 -040040if(TEST_CPP)
Bill Robertsaab7f7f2024-02-20 08:16:57 -060041 project("Mbed TLS"
42 LANGUAGES C CXX
Gilles Peskinea712d8d2024-10-14 11:04:31 +020043 VERSION 3.6.2
Bill Robertsaab7f7f2024-02-20 08:16:57 -060044 )
Andrzej Kurek0211c322018-03-15 05:16:24 -040045else()
Bill Robertsaab7f7f2024-02-20 08:16:57 -060046 project("Mbed TLS"
47 LANGUAGES C
Gilles Peskinea712d8d2024-10-14 11:04:31 +020048 VERSION 3.6.2
Bill Robertsaab7f7f2024-02-20 08:16:57 -060049 )
Andrzej Kurek0211c322018-03-15 05:16:24 -040050endif()
Paul Bakker367dae42009-06-28 21:50:27 +000051
Biswapriyo Nath0f2e87b2022-04-22 20:56:21 +053052include(GNUInstallDirs)
53
Gilles Peskinee820c0a2023-08-03 17:45:20 +020054# Determine if Mbed TLS is being built as a subproject using add_subdirectory()
Antonio de Angelis2869c672021-12-07 20:45:55 +000055if(NOT DEFINED MBEDTLS_AS_SUBPROJECT)
56 set(MBEDTLS_AS_SUBPROJECT ON)
57 if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
58 set(MBEDTLS_AS_SUBPROJECT OFF)
59 endif()
60endif()
61
Ashley Duncand85a7e92019-04-29 20:35:06 +120062# Set the project root directory.
63set(MBEDTLS_DIR ${CMAKE_CURRENT_SOURCE_DIR})
64
Gilles Peskinee820c0a2023-08-03 17:45:20 +020065option(ENABLE_PROGRAMS "Build Mbed TLS programs." ON)
Manuel Pégourié-Gonnard58719102015-07-09 09:19:47 +010066
Simon Butcher1ceab6e2016-06-21 10:14:00 +010067option(UNSAFE_BUILD "Allow unsafe builds. These builds ARE NOT SECURE." OFF)
Carlos Gomes Martinhoa5f0bd32020-04-03 09:42:37 +020068option(MBEDTLS_FATAL_WARNINGS "Compiler warnings treated as errors" ON)
Anton Komlevca947a42022-04-14 15:22:11 +010069if(CMAKE_HOST_WIN32)
Gilles Peskineecc99612023-09-09 22:54:26 +020070 # N.B. The comment on the next line is significant! If you change it,
71 # edit the sed command in prepare_release.sh that modifies
72 # CMakeLists.txt.
Gilles Peskineeeed74e2023-09-09 21:00:30 +020073 option(GEN_FILES "Generate the auto-generated files as needed" OFF) # off in development
David Horstmann77496512021-10-21 19:45:52 +010074else()
David Horstmannfbc34ee2024-08-30 11:03:41 +010075 option(GEN_FILES "Generate the auto-generated files as needed" ON)
David Horstmann77496512021-10-21 19:45:52 +010076endif()
Manuel Pégourié-Gonnard58719102015-07-09 09:19:47 +010077
Antonio de Angelis2869c672021-12-07 20:45:55 +000078option(DISABLE_PACKAGE_CONFIG_AND_INSTALL "Disable package configuration, target export and installation" ${MBEDTLS_AS_SUBPROJECT})
79
Daan Timmer6c792ca2023-10-18 16:15:58 +020080if (CMAKE_C_SIMULATE_ID)
81 set(COMPILER_ID ${CMAKE_C_SIMULATE_ID})
82else()
83 set(COMPILER_ID ${CMAKE_C_COMPILER_ID})
84endif(CMAKE_C_SIMULATE_ID)
85
86string(REGEX MATCH "Clang" CMAKE_COMPILER_IS_CLANG "${COMPILER_ID}")
87string(REGEX MATCH "GNU" CMAKE_COMPILER_IS_GNU "${COMPILER_ID}")
88string(REGEX MATCH "IAR" CMAKE_COMPILER_IS_IAR "${COMPILER_ID}")
89string(REGEX MATCH "MSVC" CMAKE_COMPILER_IS_MSVC "${COMPILER_ID}")
Azim Khan45b79cf2018-05-23 16:55:16 +010090
Manuel Pégourié-Gonnard58719102015-07-09 09:19:47 +010091# the test suites currently have compile errors with MSVC
Azim Khan45b79cf2018-05-23 16:55:16 +010092if(CMAKE_COMPILER_IS_MSVC)
Gilles Peskinee820c0a2023-08-03 17:45:20 +020093 option(ENABLE_TESTING "Build Mbed TLS tests." OFF)
Manuel Pégourié-Gonnard58719102015-07-09 09:19:47 +010094else()
Gilles Peskinee820c0a2023-08-03 17:45:20 +020095 option(ENABLE_TESTING "Build Mbed TLS tests." ON)
Manuel Pégourié-Gonnard58719102015-07-09 09:19:47 +010096endif()
Manuel Pégourié-Gonnard0b4e2ac2015-07-08 22:10:38 +010097
Simon Butcher45103f32016-06-21 14:47:11 +010098# Warning string - created as a list for compatibility with CMake 2.8
Nir Sonnenscheinb7ebbca2018-08-29 10:20:12 +030099set(CTR_DRBG_128_BIT_KEY_WARN_L1 "**** WARNING! MBEDTLS_CTR_DRBG_USE_128_BIT_KEY defined!\n")
100set(CTR_DRBG_128_BIT_KEY_WARN_L2 "**** Using 128-bit keys for CTR_DRBG limits the security of generated\n")
101set(CTR_DRBG_128_BIT_KEY_WARN_L3 "**** keys and operations that use random values generated to 128-bit security\n")
102
103set(CTR_DRBG_128_BIT_KEY_WARNING "${WARNING_BORDER}"
104 "${CTR_DRBG_128_BIT_KEY_WARN_L1}"
105 "${CTR_DRBG_128_BIT_KEY_WARN_L2}"
106 "${CTR_DRBG_128_BIT_KEY_WARN_L3}"
107 "${WARNING_BORDER}")
108
Gilles Peskine97409292019-09-04 22:10:34 +0200109# Python 3 is only needed here to check for configuration warnings.
okhowang(王沛文)3c1b0902020-03-25 19:55:32 +0800110if(NOT CMAKE_VERSION VERSION_LESS 3.15.0)
111 set(Python3_FIND_STRATEGY LOCATION)
112 find_package(Python3 COMPONENTS Interpreter)
113 if(Python3_Interpreter_FOUND)
114 set(MBEDTLS_PYTHON_EXECUTABLE ${Python3_EXECUTABLE})
115 endif()
116else()
117 find_package(PythonInterp 3)
118 if(PYTHONINTERP_FOUND)
119 set(MBEDTLS_PYTHON_EXECUTABLE ${PYTHON_EXECUTABLE})
120 endif()
121endif()
122if(MBEDTLS_PYTHON_EXECUTABLE)
Simon Butcher1ceab6e2016-06-21 10:14:00 +0100123
Nir Sonnenscheinb7ebbca2018-08-29 10:20:12 +0300124 # If 128-bit keys are configured for CTR_DRBG, display an appropriate warning
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +0200125 execute_process(COMMAND ${MBEDTLS_PYTHON_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/scripts/config.py -f ${CMAKE_CURRENT_SOURCE_DIR}/include/mbedtls/mbedtls_config.h get MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
Nir Sonnenscheinb7ebbca2018-08-29 10:20:12 +0300126 RESULT_VARIABLE result)
127 if(${result} EQUAL 0)
128 message(WARNING ${CTR_DRBG_128_BIT_KEY_WARNING})
129 endif()
130
Simon Butcher1ceab6e2016-06-21 10:14:00 +0100131endif()
132
Paul Elliott7fd162e2024-01-24 18:05:53 +0000133# We now potentially need to link all executables against PThreads, if available
134set(CMAKE_THREAD_PREFER_PTHREAD TRUE)
135set(THREADS_PREFER_PTHREAD_FLAG TRUE)
136find_package(Threads)
137
Peter Toftfdf33792020-10-14 17:19:02 +0200138# If this is the root project add longer list of available CMAKE_BUILD_TYPE values
139if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
140 set(CMAKE_BUILD_TYPE ${CMAKE_BUILD_TYPE}
Paul Elliottbbdfc8a2023-11-23 14:07:43 +0000141 CACHE STRING "Choose the type of build: None Debug Release Coverage ASan ASanDbg MemSan MemSanDbg Check CheckFull TSan TSanDbg"
Peter Toftfdf33792020-10-14 17:19:02 +0200142 FORCE)
143endif()
Manuel Pégourié-Gonnard0b4e2ac2015-07-08 22:10:38 +0100144
David Horstmann0f1dd572023-02-15 14:44:25 +0000145# Make MBEDTLS_CONFIG_FILE and MBEDTLS_USER_CONFIG_FILE into PATHs
146set(MBEDTLS_CONFIG_FILE "" CACHE FILEPATH "Mbed TLS config file (overrides default).")
147set(MBEDTLS_USER_CONFIG_FILE "" CACHE FILEPATH "Mbed TLS user config file (appended to default).")
David Horstmannae33ab82023-01-12 13:59:34 +0000148
Gilles Peskine84052572018-03-21 12:12:47 +0100149# Create a symbolic link from ${base_name} in the binary directory
150# to the corresponding path in the source directory.
Dominik Gschwindc6d16362022-08-10 16:27:14 +0200151# Note: Copies the file(s) on Windows.
Gilles Peskine84052572018-03-21 12:12:47 +0100152function(link_to_source base_name)
Dominik Gschwindc6d16362022-08-10 16:27:14 +0200153 set(link "${CMAKE_CURRENT_BINARY_DIR}/${base_name}")
154 set(target "${CMAKE_CURRENT_SOURCE_DIR}/${base_name}")
Gilles Peskine84052572018-03-21 12:12:47 +0100155
Dave Rodgmana14f5d92022-07-20 11:09:17 +0100156 # Linking to non-existent file is not desirable. At best you will have a
Paul Elliott582f72b2022-07-12 14:55:01 +0100157 # dangling link, but when building in tree, this can create a symbolic link
158 # to itself.
159 if (EXISTS ${target} AND NOT EXISTS ${link})
Gilles Peskine84052572018-03-21 12:12:47 +0100160 if (CMAKE_HOST_UNIX)
Dominik Gschwindc6d16362022-08-10 16:27:14 +0200161 execute_process(COMMAND ln -s ${target} ${link}
162 RESULT_VARIABLE result
163 ERROR_VARIABLE output)
164
165 if (NOT ${result} EQUAL 0)
166 message(FATAL_ERROR "Could not create symbolic link for: ${target} --> ${output}")
167 endif()
Gilles Peskine84052572018-03-21 12:12:47 +0100168 else()
Darryl Greend75ee642018-06-07 11:55:50 +0100169 if (IS_DIRECTORY ${target})
Dominik Gschwindc6d16362022-08-10 16:27:14 +0200170 file(GLOB_RECURSE files FOLLOW_SYMLINKS LIST_DIRECTORIES false RELATIVE ${target} "${target}/*")
171 foreach(file IN LISTS files)
172 configure_file("${target}/${file}" "${link}/${file}" COPYONLY)
173 endforeach(file)
Darryl Greend75ee642018-06-07 11:55:50 +0100174 else()
Dominik Gschwindc6d16362022-08-10 16:27:14 +0200175 configure_file(${target} ${link} COPYONLY)
Darryl Greend75ee642018-06-07 11:55:50 +0100176 endif()
Gilles Peskine84052572018-03-21 12:12:47 +0100177 endif()
Gilles Peskine84052572018-03-21 12:12:47 +0100178 endif()
179endfunction(link_to_source)
180
David Horstmannb3a54242021-10-19 18:37:04 +0100181# Get the filename without the final extension (i.e. convert "a.b.c" to "a.b")
182function(get_name_without_last_ext dest_var full_name)
183 # Split into a list on '.' (but a cmake list is just a ';'-separated string)
184 string(REPLACE "." ";" ext_parts "${full_name}")
185 # Remove the last item if there are more than one
186 list(LENGTH ext_parts ext_parts_len)
187 if (${ext_parts_len} GREATER "1")
188 math(EXPR ext_parts_last_item "${ext_parts_len} - 1")
189 list(REMOVE_AT ext_parts ${ext_parts_last_item})
190 endif()
191 # Convert back to a string by replacing separators with '.'
192 string(REPLACE ";" "." no_ext_name "${ext_parts}")
193 # Copy into the desired variable
194 set(${dest_var} ${no_ext_name} PARENT_SCOPE)
195endfunction(get_name_without_last_ext)
196
makise-homuraac2fd652020-08-18 21:59:46 +0300197include(CheckCCompilerFlag)
198
Dave Rodgmanf5f1cfc2022-05-10 17:26:47 +0100199set(CMAKE_C_EXTENSIONS OFF)
okhowang(王沛文)df865c32020-09-03 16:21:30 +0800200set(CMAKE_C_STANDARD 99)
201
Azim Khan45b79cf2018-05-23 16:55:16 +0100202if(CMAKE_COMPILER_IS_GNU)
Manuel Pégourié-Gonnardbcb04602015-07-19 16:00:04 +0200203 # some warnings we want are not available with old GCC versions
204 # note: starting with CMake 2.8 we could use CMAKE_C_COMPILER_VERSION
205 execute_process(COMMAND ${CMAKE_C_COMPILER} -dumpversion
206 OUTPUT_VARIABLE GCC_VERSION)
Michael Schuster4d0d0ec2024-06-05 01:45:54 +0200207 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -Wwrite-strings -Wmissing-prototypes")
Paul Elliottea32d552020-12-09 14:34:47 +0000208 if (GCC_VERSION VERSION_GREATER 3.0 OR GCC_VERSION VERSION_EQUAL 3.0)
209 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wformat=2 -Wno-format-nonliteral")
210 endif()
Gilles Peskinebe517162019-07-02 20:22:11 +0200211 if (GCC_VERSION VERSION_GREATER 4.3 OR GCC_VERSION VERSION_EQUAL 4.3)
212 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wvla")
213 endif()
Manuel Pégourié-Gonnardbcb04602015-07-19 16:00:04 +0200214 if (GCC_VERSION VERSION_GREATER 4.5 OR GCC_VERSION VERSION_EQUAL 4.5)
215 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wlogical-op")
216 endif()
Manuel Pégourié-Gonnard824ba722015-08-27 23:00:49 +0200217 if (GCC_VERSION VERSION_GREATER 4.8 OR GCC_VERSION VERSION_EQUAL 4.8)
okhowang(王沛文)0cd8e0f2020-07-03 11:41:38 +0800218 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wshadow")
219 endif()
220 if (GCC_VERSION VERSION_GREATER 5.0)
makise-homuraac2fd652020-08-18 21:59:46 +0300221 CHECK_C_COMPILER_FLAG("-Wformat-signedness" C_COMPILER_SUPPORTS_WFORMAT_SIGNEDNESS)
222 if(C_COMPILER_SUPPORTS_WFORMAT_SIGNEDNESS)
223 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wformat-signedness")
224 endif()
225 endif()
Paul Elliottea32d552020-12-09 14:34:47 +0000226 if (GCC_VERSION VERSION_GREATER 7.0 OR GCC_VERSION VERSION_EQUAL 7.0)
Paul Elliott2065a8d2021-03-17 13:12:22 +0000227 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wformat-overflow=2 -Wformat-truncation")
Paul Elliottea32d552020-12-09 14:34:47 +0000228 endif()
Manuel Pégourié-Gonnard216a1832015-06-25 09:20:03 +0200229 set(CMAKE_C_FLAGS_RELEASE "-O2")
230 set(CMAKE_C_FLAGS_DEBUG "-O0 -g3")
231 set(CMAKE_C_FLAGS_COVERAGE "-O0 -g3 --coverage")
Gilles Peskine765da152024-10-15 12:03:26 +0200232 # Old GCC versions hit a performance problem with test_suite_pkwrite
233 # "Private keey write check EC" tests when building with Asan+UBSan
234 # and -O3: those tests take more than 100x time than normal, with
235 # test_suite_pkwrite taking >3h on the CI. Observed with GCC 5.4 on
236 # Ubuntu 16.04 x86_64 and GCC 6.5 on Ubuntu 18.04 x86_64.
237 # GCC 7.5 and above on Ubuntu 18.04 appear fine.
Valerio Settibdca1fe2024-10-16 13:28:44 +0200238 # To avoid the performance problem, we use -O2 when GCC version is lower than 7.0.
239 # It doesn't slow down much even with modern compiler versions.
240 if (GCC_VERSION VERSION_LESS 7.0)
241 message(STATUS "USING O2")
242 set(CMAKE_C_FLAGS_ASAN "-fsanitize=address -fno-common -fsanitize=undefined -fno-sanitize-recover=all -O2")
243 else()
244 message(STATUS "USING O3")
245 set(CMAKE_C_FLAGS_ASAN "-fsanitize=address -fno-common -fsanitize=undefined -fno-sanitize-recover=all -O3")
246 endif()
Carlos Gomes Martinhoa5f0bd32020-04-03 09:42:37 +0200247 set(CMAKE_C_FLAGS_ASANDBG "-fsanitize=address -fno-common -fsanitize=undefined -fno-sanitize-recover=all -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls")
Paul Elliottbbdfc8a2023-11-23 14:07:43 +0000248 set(CMAKE_C_FLAGS_TSAN "-fsanitize=thread -O3")
249 set(CMAKE_C_FLAGS_TSANDBG "-fsanitize=thread -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls")
Carlos Gomes Martinhoa5f0bd32020-04-03 09:42:37 +0200250 set(CMAKE_C_FLAGS_CHECK "-Os")
Manuel Pégourié-Gonnard216a1832015-06-25 09:20:03 +0200251 set(CMAKE_C_FLAGS_CHECKFULL "${CMAKE_C_FLAGS_CHECK} -Wcast-qual")
Azim Khan45b79cf2018-05-23 16:55:16 +0100252endif(CMAKE_COMPILER_IS_GNU)
Paul Bakker76f03112013-11-28 17:20:04 +0100253
Paul Bakker92bc8752013-12-30 17:56:23 +0100254if(CMAKE_COMPILER_IS_CLANG)
Michael Schuster4d0d0ec2024-06-05 01:45:54 +0200255 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -Wwrite-strings -Wmissing-prototypes -Wpointer-arith -Wimplicit-fallthrough -Wshadow -Wvla -Wformat=2 -Wno-format-nonliteral")
Manuel Pégourié-Gonnard216a1832015-06-25 09:20:03 +0200256 set(CMAKE_C_FLAGS_RELEASE "-O2")
257 set(CMAKE_C_FLAGS_DEBUG "-O0 -g3")
258 set(CMAKE_C_FLAGS_COVERAGE "-O0 -g3 --coverage")
Carlos Gomes Martinhoa5f0bd32020-04-03 09:42:37 +0200259 set(CMAKE_C_FLAGS_ASAN "-fsanitize=address -fno-common -fsanitize=undefined -fno-sanitize-recover=all -O3")
260 set(CMAKE_C_FLAGS_ASANDBG "-fsanitize=address -fno-common -fsanitize=undefined -fno-sanitize-recover=all -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls")
261 set(CMAKE_C_FLAGS_MEMSAN "-fsanitize=memory -O3")
262 set(CMAKE_C_FLAGS_MEMSANDBG "-fsanitize=memory -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls -fsanitize-memory-track-origins=2")
Paul Elliottbbdfc8a2023-11-23 14:07:43 +0000263 set(CMAKE_C_FLAGS_TSAN "-fsanitize=thread -O3")
264 set(CMAKE_C_FLAGS_TSANDBG "-fsanitize=thread -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls")
Carlos Gomes Martinhoa5f0bd32020-04-03 09:42:37 +0200265 set(CMAKE_C_FLAGS_CHECK "-Os")
Paul Bakker92bc8752013-12-30 17:56:23 +0100266endif(CMAKE_COMPILER_IS_CLANG)
267
Azim Khan45b79cf2018-05-23 16:55:16 +0100268if(CMAKE_COMPILER_IS_IAR)
TTornblome4f6d792020-04-16 13:53:38 +0200269 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} --warn_about_c_style_casts")
270 set(CMAKE_C_FLAGS_RELEASE "-Ohz")
271 set(CMAKE_C_FLAGS_DEBUG "--debug -On")
Azim Khan45b79cf2018-05-23 16:55:16 +0100272endif(CMAKE_COMPILER_IS_IAR)
273
274if(CMAKE_COMPILER_IS_MSVC)
Andrea Pappacoda92029092021-12-27 22:41:21 +0100275 # Strictest warnings, UTF-8 source and execution charset
276 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /W3 /utf-8")
Azim Khan45b79cf2018-05-23 16:55:16 +0100277endif(CMAKE_COMPILER_IS_MSVC)
Manuel Pégourié-Gonnard30830532015-07-01 17:06:28 +0200278
Carlos Gomes Martinhoa5f0bd32020-04-03 09:42:37 +0200279if(MBEDTLS_FATAL_WARNINGS)
280 if(CMAKE_COMPILER_IS_MSVC)
281 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /WX")
282 endif(CMAKE_COMPILER_IS_MSVC)
283
284 if(CMAKE_COMPILER_IS_CLANG OR CMAKE_COMPILER_IS_GNU)
285 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Werror")
Carlos Gomes Martinhoe150c772020-04-21 22:15:01 +0200286 if(UNSAFE_BUILD)
287 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wno-error=cpp")
288 set(CMAKE_C_FLAGS_ASAN "${CMAKE_C_FLAGS_ASAN} -Wno-error=cpp")
289 set(CMAKE_C_FLAGS_ASANDBG "${CMAKE_C_FLAGS_ASANDBG} -Wno-error=cpp")
290 endif(UNSAFE_BUILD)
Carlos Gomes Martinhoa5f0bd32020-04-03 09:42:37 +0200291 endif(CMAKE_COMPILER_IS_CLANG OR CMAKE_COMPILER_IS_GNU)
savent5d8adab2022-06-17 18:06:30 +0800292
293 if (CMAKE_COMPILER_IS_IAR)
Robin Kastberge5eb33d2023-05-26 15:57:37 +0200294 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} --warnings_are_errors")
savent5d8adab2022-06-17 18:06:30 +0800295 endif(CMAKE_COMPILER_IS_IAR)
Carlos Gomes Martinhoa5f0bd32020-04-03 09:42:37 +0200296endif(MBEDTLS_FATAL_WARNINGS)
297
Gilles Peskinef5db72b2024-06-06 22:12:06 +0200298if(CMAKE_BUILD_TYPE STREQUAL "Check" AND TEST_CPP)
299 set(CMAKE_CXX_STANDARD 11)
300 set(CMAKE_CXX_STANDARD_REQUIRED ON)
301 set(CMAKE_CXX_EXTENSIONS OFF)
302 if(CMAKE_COMPILER_IS_CLANG OR CMAKE_COMPILER_IS_GNU)
303 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -pedantic")
304 endif()
305endif()
306
Paul Bakker396c52f2009-07-11 19:54:40 +0000307if(CMAKE_BUILD_TYPE STREQUAL "Coverage")
Azim Khan45b79cf2018-05-23 16:55:16 +0100308 if(CMAKE_COMPILER_IS_GNU OR CMAKE_COMPILER_IS_CLANG)
Manuel Pégourié-Gonnard216a1832015-06-25 09:20:03 +0200309 set(CMAKE_SHARED_LINKER_FLAGS "--coverage")
Azim Khan45b79cf2018-05-23 16:55:16 +0100310 endif(CMAKE_COMPILER_IS_GNU OR CMAKE_COMPILER_IS_CLANG)
Paul Bakker396c52f2009-07-11 19:54:40 +0000311endif(CMAKE_BUILD_TYPE STREQUAL "Coverage")
Paul Bakker367dae42009-06-28 21:50:27 +0000312
Paul Bakker091e2872011-07-13 11:45:58 +0000313if(LIB_INSTALL_DIR)
Biswapriyo Nath0f2e87b2022-04-22 20:56:21 +0530314 set(CMAKE_INSTALL_LIBDIR "${LIB_INSTALL_DIR}")
Paul Bakker091e2872011-07-13 11:45:58 +0000315endif()
316
Gilles Peskinef9bbe0d2024-03-04 16:25:14 +0100317if (NOT EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/framework/CMakeLists.txt")
Harry Ramseyf0dedba2024-12-10 15:32:04 +0000318 if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/.git")
Harry Ramseye3fdd0a2024-11-04 15:14:53 +0000319 message(FATAL_ERROR "${CMAKE_CURRENT_SOURCE_DIR}CMakeLists.txt not found (and does appear to be a git checkout). Run `git submodule update --init` from the source tree to fetch the submodule contents.")
Harry Ramseyd532a662024-11-04 10:50:30 +0000320 else ()
Harry Ramseye3fdd0a2024-11-04 15:14:53 +0000321 message(FATAL_ERROR "${CMAKE_CURRENT_SOURCE_DIR}/CMakeLists.txt not found (and does not appear to be a git checkout). Please ensure you have downloaded the right archive from the release page on GitHub.")
Harry Ramseyd532a662024-11-04 10:50:30 +0000322 endif()
Gilles Peskinef9bbe0d2024-03-04 16:25:14 +0100323endif()
Gilles Peskine469f7812024-02-29 18:19:56 +0100324add_subdirectory(framework)
325
Christoph M. Wintersteiger7b747fc2019-04-08 17:00:34 +0100326add_subdirectory(include)
327
Christoph M. Wintersteiger62dddd02018-12-14 13:07:50 +0000328add_subdirectory(3rdparty)
Christoph M. Wintersteiger6ea2dea12019-01-21 17:26:19 +0000329
Paul Bakker367dae42009-06-28 21:50:27 +0000330add_subdirectory(library)
Paul Bakker2015eac2011-07-27 16:52:28 +0000331
Bill Robertsa4d17b32024-01-09 13:10:05 -0600332add_subdirectory(pkgconfig)
333
Ronald Crondd6bdb52020-06-26 16:37:02 +0200334#
David Horstmanndcf42a02024-11-08 14:40:12 +0000335# The C files in framework/tests/src directory contain test code shared among test suites
Ronald Crondd6bdb52020-06-26 16:37:02 +0200336# and programs. This shared test code is compiled and linked to test suites and
337# programs objects as a set of compiled objects. The compiled objects are NOT
338# built into a library that the test suite and program objects would link
339# against as they link against the mbedcrypto, mbedx509 and mbedtls libraries.
340# The reason is that such library is expected to have mutual dependencies with
341# the aforementioned libraries and that there is as of today no portable way of
342# handling such dependencies (only toolchain specific solutions).
343#
344# Thus the below definition of the `mbedtls_test` CMake library of objects
345# target. This library of objects is used by tests and programs CMake files
346# to define the test executables.
347#
Ronald Cronddaf99c2020-06-19 11:27:26 +0200348if(ENABLE_TESTING OR ENABLE_PROGRAMS)
Yanray Wangb458b8c2022-10-28 11:49:33 +0800349 file(GLOB MBEDTLS_TEST_FILES
David Horstmann0e8cc112024-11-04 14:13:37 +0000350 ${CMAKE_CURRENT_SOURCE_DIR}/tests/src/*.c
David Horstmanndcf42a02024-11-08 14:40:12 +0000351 ${CMAKE_CURRENT_SOURCE_DIR}/framework/tests/src/*.c
352 ${CMAKE_CURRENT_SOURCE_DIR}/framework/tests/src/drivers/*.c)
Valerio Setti911363e2024-04-15 09:11:28 +0200353 add_library(mbedtls_test OBJECT ${MBEDTLS_TEST_FILES})
354 if(GEN_FILES)
David Horstmann58b660c2024-05-10 14:23:16 +0100355 add_custom_command(
356 OUTPUT
David Horstmanndcf42a02024-11-08 14:40:12 +0000357 ${CMAKE_CURRENT_SOURCE_DIR}/framework/tests/src/test_keys.h
David Horstmann58b660c2024-05-10 14:23:16 +0100358 WORKING_DIRECTORY
359 ${CMAKE_CURRENT_SOURCE_DIR}/tests
360 COMMAND
361 "${MBEDTLS_PYTHON_EXECUTABLE}"
David Horstmannea091522024-05-29 17:57:08 +0100362 "${CMAKE_CURRENT_SOURCE_DIR}/framework/scripts/generate_test_keys.py"
David Horstmann58b660c2024-05-10 14:23:16 +0100363 "--output"
David Horstmanndcf42a02024-11-08 14:40:12 +0000364 "${CMAKE_CURRENT_SOURCE_DIR}/framework/tests/src/test_keys.h"
David Horstmann58b660c2024-05-10 14:23:16 +0100365 DEPENDS
David Horstmannea091522024-05-29 17:57:08 +0100366 ${CMAKE_CURRENT_SOURCE_DIR}/framework/scripts/generate_test_keys.py
David Horstmann58b660c2024-05-10 14:23:16 +0100367 )
David Horstmanndcf42a02024-11-08 14:40:12 +0000368 add_custom_target(test_keys_header DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/framework/tests/src/test_keys.h)
David Horstmann58b660c2024-05-10 14:23:16 +0100369 add_custom_command(
370 OUTPUT
371 ${CMAKE_CURRENT_SOURCE_DIR}/tests/src/test_certs.h
372 WORKING_DIRECTORY
373 ${CMAKE_CURRENT_SOURCE_DIR}/tests
374 COMMAND
375 "${MBEDTLS_PYTHON_EXECUTABLE}"
David Horstmannea091522024-05-29 17:57:08 +0100376 "${CMAKE_CURRENT_SOURCE_DIR}/framework/scripts/generate_test_cert_macros.py"
David Horstmann58b660c2024-05-10 14:23:16 +0100377 "--output"
378 "${CMAKE_CURRENT_SOURCE_DIR}/tests/src/test_certs.h"
379 DEPENDS
David Horstmannea091522024-05-29 17:57:08 +0100380 ${CMAKE_CURRENT_SOURCE_DIR}/framework/scripts/generate_test_cert_macros.py
David Horstmann58b660c2024-05-10 14:23:16 +0100381 )
382 add_custom_target(test_certs_header DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/tests/src/test_certs.h)
Valerio Setti911363e2024-04-15 09:11:28 +0200383 add_dependencies(mbedtls_test test_keys_header test_certs_header)
384 endif()
Ronald Cronddaf99c2020-06-19 11:27:26 +0200385 target_include_directories(mbedtls_test
David Horstmanndcf42a02024-11-08 14:40:12 +0000386 PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/framework/tests/include
David Horstmann0e8cc112024-11-04 14:13:37 +0000387 PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/tests/include
Ronald Cronddaf99c2020-06-19 11:27:26 +0200388 PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/include
389 PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/library)
David Horstmannc2ab3982024-01-17 12:25:19 +0000390 # Request C11, needed for memory poisoning tests
391 set_target_properties(mbedtls_test PROPERTIES C_STANDARD 11)
Yanray Wangb458b8c2022-10-28 11:49:33 +0800392
393 file(GLOB MBEDTLS_TEST_HELPER_FILES
394 ${CMAKE_CURRENT_SOURCE_DIR}/tests/src/test_helpers/*.c)
395 add_library(mbedtls_test_helpers OBJECT ${MBEDTLS_TEST_HELPER_FILES})
396 target_include_directories(mbedtls_test_helpers
David Horstmanndcf42a02024-11-08 14:40:12 +0000397 PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/framework/tests/include
David Horstmann16b1c7b2024-10-31 15:48:28 +0000398 PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/tests/include
Yanray Wangb458b8c2022-10-28 11:49:33 +0800399 PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/include
400 PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/library
401 PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/3rdparty/everest/include)
David Horstmannae33ab82023-01-12 13:59:34 +0000402
403 # Pass-through MBEDTLS_CONFIG_FILE and MBEDTLS_USER_CONFIG_FILE
David Horstmann0f1dd572023-02-15 14:44:25 +0000404 if(MBEDTLS_CONFIG_FILE)
David Horstmannae33ab82023-01-12 13:59:34 +0000405 target_compile_definitions(mbedtls_test
406 PUBLIC MBEDTLS_CONFIG_FILE="${MBEDTLS_CONFIG_FILE}")
407 target_compile_definitions(mbedtls_test_helpers
408 PUBLIC MBEDTLS_CONFIG_FILE="${MBEDTLS_CONFIG_FILE}")
409 endif()
David Horstmann0f1dd572023-02-15 14:44:25 +0000410 if(MBEDTLS_USER_CONFIG_FILE)
David Horstmannae33ab82023-01-12 13:59:34 +0000411 target_compile_definitions(mbedtls_test
412 PUBLIC MBEDTLS_USER_CONFIG_FILE="${MBEDTLS_USER_CONFIG_FILE}")
413 target_compile_definitions(mbedtls_test_helpers
414 PUBLIC MBEDTLS_USER_CONFIG_FILE="${MBEDTLS_USER_CONFIG_FILE}")
415 endif()
Ronald Cronddaf99c2020-06-19 11:27:26 +0200416endif()
417
Paul Bakkerdf5024c2014-03-26 13:27:51 +0100418if(ENABLE_PROGRAMS)
Gilles Peskine278b4172024-09-24 19:09:57 +0200419 set(ssl_opt_target "${MBEDTLS_TARGET_PREFIX}ssl-opt")
420 add_custom_target(${ssl_opt_target})
421
Manuel Pégourié-Gonnard216a1832015-06-25 09:20:03 +0200422 add_subdirectory(programs)
Paul Bakkerdf5024c2014-03-26 13:27:51 +0100423endif()
Paul Bakkerccba9bc2011-01-05 15:30:32 +0000424
Raef Coles995c66f2020-10-13 16:30:41 +0100425ADD_CUSTOM_TARGET(${MBEDTLS_TARGET_PREFIX}apidoc
Krzysztof Stachowiaka0188d62018-01-19 16:21:11 +0100426 COMMAND doxygen mbedtls.doxyfile
427 WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/doxygen)
Manuel Pégourié-Gonnard7669f282013-09-07 16:52:42 +0200428
Paul Bakker27f1cae2014-04-30 16:31:54 +0200429if(ENABLE_TESTING)
Manuel Pégourié-Gonnard5fe51d72015-07-01 16:59:56 +0200430 enable_testing()
Manuel Pégourié-Gonnardc8293b22015-06-25 09:22:25 +0200431
Manuel Pégourié-Gonnard5fe51d72015-07-01 16:59:56 +0200432 add_subdirectory(tests)
Manuel Pégourié-Gonnard61137df2014-02-24 11:57:36 +0100433
Manuel Pégourié-Gonnard5fe51d72015-07-01 16:59:56 +0200434 # additional convenience targets for Unix only
435 if(UNIX)
Manuel Pégourié-Gonnard546d86c2014-01-31 16:19:43 +0100436
Gilles Peskine0ab6c8a2022-12-08 22:18:31 +0100437 # For coverage testing:
438 # 1. Build with:
439 # cmake -D CMAKE_BUILD_TYPE=Coverage /path/to/source && make
440 # 2. Run the relevant tests for the part of the code you're interested in.
441 # For the reference coverage measurement, see
442 # tests/scripts/basic-build-test.sh
443 # 3. Run scripts/lcov.sh to generate an HTML report.
Manuel Pégourié-Gonnard5fe51d72015-07-01 16:59:56 +0200444 ADD_CUSTOM_TARGET(lcov
Gilles Peskinecb330762022-11-30 17:52:01 +0100445 COMMAND scripts/lcov.sh
Manuel Pégourié-Gonnard5fe51d72015-07-01 16:59:56 +0200446 )
447
448 ADD_CUSTOM_TARGET(memcheck
449 COMMAND sed -i.bak s+/usr/bin/valgrind+`which valgrind`+ DartConfiguration.tcl
450 COMMAND ctest -O memcheck.log -D ExperimentalMemCheck
451 COMMAND tail -n1 memcheck.log | grep 'Memory checking results:' > /dev/null
452 COMMAND rm -f memcheck.log
453 COMMAND mv DartConfiguration.tcl.bak DartConfiguration.tcl
454 )
455 endif(UNIX)
Gilles Peskine84052572018-03-21 12:12:47 +0100456
Renz Christian Bagaporod8a40b52019-04-28 13:51:37 +0800457 # Make scripts needed for testing available in an out-of-source build.
458 if (NOT ${CMAKE_CURRENT_BINARY_DIR} STREQUAL ${CMAKE_CURRENT_SOURCE_DIR})
459 link_to_source(scripts)
460 # Copy (don't link) DartConfiguration.tcl, needed for memcheck, to
461 # keep things simple with the sed commands in the memcheck target.
462 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/DartConfiguration.tcl
463 ${CMAKE_CURRENT_BINARY_DIR}/DartConfiguration.tcl COPYONLY)
464 endif()
Gilles Peskine84052572018-03-21 12:12:47 +0100465endif()
Chris Kayd259e342021-03-25 16:03:25 +0000466
Antonio de Angelis2869c672021-12-07 20:45:55 +0000467if(NOT DISABLE_PACKAGE_CONFIG_AND_INSTALL)
468 configure_package_config_file(
469 "cmake/MbedTLSConfig.cmake.in"
470 "cmake/MbedTLSConfig.cmake"
471 INSTALL_DESTINATION "cmake")
Chris Kayd259e342021-03-25 16:03:25 +0000472
Antonio de Angelis2869c672021-12-07 20:45:55 +0000473 write_basic_package_version_file(
474 "cmake/MbedTLSConfigVersion.cmake"
475 COMPATIBILITY SameMajorVersion
Gilles Peskinea712d8d2024-10-14 11:04:31 +0200476 VERSION 3.6.2)
Chris Kayd259e342021-03-25 16:03:25 +0000477
Antonio de Angelis2869c672021-12-07 20:45:55 +0000478 install(
479 FILES "${CMAKE_CURRENT_BINARY_DIR}/cmake/MbedTLSConfig.cmake"
480 "${CMAKE_CURRENT_BINARY_DIR}/cmake/MbedTLSConfigVersion.cmake"
Issam E. Maghni760f3a02022-11-19 18:34:01 +0000481 DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/MbedTLS")
Chris Kayd259e342021-03-25 16:03:25 +0000482
Antonio de Angelis2869c672021-12-07 20:45:55 +0000483 export(
484 EXPORT MbedTLSTargets
485 NAMESPACE MbedTLS::
486 FILE "cmake/MbedTLSTargets.cmake")
Chris Kayd259e342021-03-25 16:03:25 +0000487
Antonio de Angelis2869c672021-12-07 20:45:55 +0000488 install(
489 EXPORT MbedTLSTargets
490 NAMESPACE MbedTLS::
Issam E. Maghni760f3a02022-11-19 18:34:01 +0000491 DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/MbedTLS"
Antonio de Angelis2869c672021-12-07 20:45:55 +0000492 FILE "MbedTLSTargets.cmake")
Chris Kayd259e342021-03-25 16:03:25 +0000493
Antonio de Angelis2869c672021-12-07 20:45:55 +0000494 if(CMAKE_VERSION VERSION_GREATER 3.15 OR CMAKE_VERSION VERSION_EQUAL 3.15)
495 # Do not export the package by default
496 cmake_policy(SET CMP0090 NEW)
Chris Kayd259e342021-03-25 16:03:25 +0000497
Antonio de Angelis2869c672021-12-07 20:45:55 +0000498 # Make this package visible to the system
499 export(PACKAGE MbedTLS)
500 endif()
Chris Kayd259e342021-03-25 16:03:25 +0000501endif()