blob: 5a092192625a41cf7d7b1d2d4d9873138d8d9818 [file] [log] [blame]
Paul Bakker367dae42009-06-28 21:50:27 +00001cmake_minimum_required(VERSION 2.6)
Andrzej Kurek0211c322018-03-15 05:16:24 -04002if(TEST_CPP)
Andrzej Kurek037ec4b2018-06-26 06:57:55 -04003 project("mbed TLS" C CXX)
Andrzej Kurek0211c322018-03-15 05:16:24 -04004else()
Andrzej Kurek037ec4b2018-06-26 06:57:55 -04005 project("mbed TLS" C)
Andrzej Kurek0211c322018-03-15 05:16:24 -04006endif()
Paul Bakker367dae42009-06-28 21:50:27 +00007
Ashley Duncand85a7e92019-04-29 20:35:06 +12008# Set the project root directory.
9set(MBEDTLS_DIR ${CMAKE_CURRENT_SOURCE_DIR})
10
Manuel Pégourié-Gonnard0b4e2ac2015-07-08 22:10:38 +010011option(ENABLE_PROGRAMS "Build mbed TLS programs." ON)
Manuel Pégourié-Gonnard58719102015-07-09 09:19:47 +010012
Simon Butcher1ceab6e2016-06-21 10:14:00 +010013option(UNSAFE_BUILD "Allow unsafe builds. These builds ARE NOT SECURE." OFF)
Manuel Pégourié-Gonnard58719102015-07-09 09:19:47 +010014
Azim Khan45b79cf2018-05-23 16:55:16 +010015string(REGEX MATCH "Clang" CMAKE_COMPILER_IS_CLANG "${CMAKE_C_COMPILER_ID}")
16string(REGEX MATCH "GNU" CMAKE_COMPILER_IS_GNU "${CMAKE_C_COMPILER_ID}")
17string(REGEX MATCH "IAR" CMAKE_COMPILER_IS_IAR "${CMAKE_C_COMPILER_ID}")
18string(REGEX MATCH "MSVC" CMAKE_COMPILER_IS_MSVC "${CMAKE_C_COMPILER_ID}")
19
Manuel Pégourié-Gonnard58719102015-07-09 09:19:47 +010020# the test suites currently have compile errors with MSVC
Azim Khan45b79cf2018-05-23 16:55:16 +010021if(CMAKE_COMPILER_IS_MSVC)
Manuel Pégourié-Gonnard58719102015-07-09 09:19:47 +010022 option(ENABLE_TESTING "Build mbed TLS tests." OFF)
23else()
24 option(ENABLE_TESTING "Build mbed TLS tests." ON)
25endif()
Manuel Pégourié-Gonnard0b4e2ac2015-07-08 22:10:38 +010026
Simon Butcher45103f32016-06-21 14:47:11 +010027# Warning string - created as a list for compatibility with CMake 2.8
28set(WARNING_BORDER "*******************************************************\n")
29set(NULL_ENTROPY_WARN_L1 "**** WARNING! MBEDTLS_TEST_NULL_ENTROPY defined!\n")
30set(NULL_ENTROPY_WARN_L2 "**** THIS BUILD HAS NO DEFINED ENTROPY SOURCES\n")
31set(NULL_ENTROPY_WARN_L3 "**** AND IS *NOT* SUITABLE FOR PRODUCTION USE\n")
32
33set(NULL_ENTROPY_WARNING "${WARNING_BORDER}"
34 "${NULL_ENTROPY_WARN_L1}"
35 "${NULL_ENTROPY_WARN_L2}"
36 "${NULL_ENTROPY_WARN_L3}"
37 "${WARNING_BORDER}")
38
Nir Sonnenscheinb7ebbca2018-08-29 10:20:12 +030039set(CTR_DRBG_128_BIT_KEY_WARN_L1 "**** WARNING! MBEDTLS_CTR_DRBG_USE_128_BIT_KEY defined!\n")
40set(CTR_DRBG_128_BIT_KEY_WARN_L2 "**** Using 128-bit keys for CTR_DRBG limits the security of generated\n")
41set(CTR_DRBG_128_BIT_KEY_WARN_L3 "**** keys and operations that use random values generated to 128-bit security\n")
42
43set(CTR_DRBG_128_BIT_KEY_WARNING "${WARNING_BORDER}"
44 "${CTR_DRBG_128_BIT_KEY_WARN_L1}"
45 "${CTR_DRBG_128_BIT_KEY_WARN_L2}"
46 "${CTR_DRBG_128_BIT_KEY_WARN_L3}"
47 "${WARNING_BORDER}")
48
Nir Sonnenscheine46c3292018-08-29 23:39:58 +030049find_package(PythonInterp)
Simon Butcher1ceab6e2016-06-21 10:14:00 +010050find_package(Perl)
51if(PERL_FOUND)
52
Nir Sonnenscheinb7ebbca2018-08-29 10:20:12 +030053 # If 128-bit keys are configured for CTR_DRBG, display an appropriate warning
54 execute_process(COMMAND ${PERL_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/scripts/config.pl -f ${CMAKE_CURRENT_SOURCE_DIR}/include/mbedtls/config.h get MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
55 RESULT_VARIABLE result)
56 if(${result} EQUAL 0)
57 message(WARNING ${CTR_DRBG_128_BIT_KEY_WARNING})
58 endif()
59
Simon Butcher1ceab6e2016-06-21 10:14:00 +010060 # If NULL Entropy is configured, display an appropriate warning
VOLAT Matthieu 22923533751f2017-09-01 09:55:40 +020061 execute_process(COMMAND ${PERL_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/scripts/config.pl -f ${CMAKE_CURRENT_SOURCE_DIR}/include/mbedtls/config.h get MBEDTLS_TEST_NULL_ENTROPY
Simon Butcher1ceab6e2016-06-21 10:14:00 +010062 RESULT_VARIABLE result)
63 if(${result} EQUAL 0)
Simon Butcher45103f32016-06-21 14:47:11 +010064 message(WARNING ${NULL_ENTROPY_WARNING})
65
Simon Butcher1ceab6e2016-06-21 10:14:00 +010066 if(NOT UNSAFE_BUILD)
67 message(FATAL_ERROR "\
68\n\
69Warning! You have enabled MBEDTLS_TEST_NULL_ENTROPY. \
70This option is not safe for production use and negates all security \
71It is intended for development use only. \
72\n\
73To confirm you want to build with this option, re-run cmake with the \
74option: \n\
75 cmake -DUNSAFE_BUILD=ON ")
76
77 return()
78 endif()
79 endif()
80endif()
81
Manuel Pégourié-Gonnard0b4e2ac2015-07-08 22:10:38 +010082set(CMAKE_BUILD_TYPE ${CMAKE_BUILD_TYPE}
83 CACHE STRING "Choose the type of build: None Debug Release Coverage ASan ASanDbg MemSan MemSanDbg Check CheckFull"
84 FORCE)
85
Gilles Peskine84052572018-03-21 12:12:47 +010086# Create a symbolic link from ${base_name} in the binary directory
87# to the corresponding path in the source directory.
88function(link_to_source base_name)
89 # Get OS dependent path to use in `execute_process`
Qixiang Xu7346b312019-02-21 14:55:13 +080090 if (CMAKE_HOST_WIN32)
91 #mklink is an internal command of cmd.exe it can only work with \
92 string(REPLACE "/" "\\" link "${CMAKE_CURRENT_BINARY_DIR}/${base_name}")
93 string(REPLACE "/" "\\" target "${CMAKE_CURRENT_SOURCE_DIR}/${base_name}")
94 else()
95 set(link "${CMAKE_CURRENT_BINARY_DIR}/${base_name}")
96 set(target "${CMAKE_CURRENT_SOURCE_DIR}/${base_name}")
97 endif()
Gilles Peskine84052572018-03-21 12:12:47 +010098
99 if (NOT EXISTS ${link})
100 if (CMAKE_HOST_UNIX)
101 set(command ln -s ${target} ${link})
102 else()
Darryl Greend75ee642018-06-07 11:55:50 +0100103 if (IS_DIRECTORY ${target})
104 set(command cmd.exe /c mklink /j ${link} ${target})
105 else()
Darryl Green2a1edac2018-06-08 10:07:32 +0100106 set(command cmd.exe /c mklink /h ${link} ${target})
Darryl Greend75ee642018-06-07 11:55:50 +0100107 endif()
Gilles Peskine84052572018-03-21 12:12:47 +0100108 endif()
109
110 execute_process(COMMAND ${command}
111 RESULT_VARIABLE result
112 ERROR_VARIABLE output)
113
114 if (NOT ${result} EQUAL 0)
115 message(FATAL_ERROR "Could not create symbolic link for: ${target} --> ${output}")
116 endif()
117 endif()
118endfunction(link_to_source)
119
Barry K. Nathancf975f52014-04-23 17:40:25 -0700120string(REGEX MATCH "Clang" CMAKE_COMPILER_IS_CLANG "${CMAKE_C_COMPILER_ID}")
Paul Bakker92bc8752013-12-30 17:56:23 +0100121
Azim Khan45b79cf2018-05-23 16:55:16 +0100122if(CMAKE_COMPILER_IS_GNU)
Manuel Pégourié-Gonnardbcb04602015-07-19 16:00:04 +0200123 # some warnings we want are not available with old GCC versions
124 # note: starting with CMake 2.8 we could use CMAKE_C_COMPILER_VERSION
125 execute_process(COMMAND ${CMAKE_C_COMPILER} -dumpversion
126 OUTPUT_VARIABLE GCC_VERSION)
Gilles Peskine85aba472019-07-02 20:03:01 +0200127 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -Wwrite-strings")
Gilles Peskinebe517162019-07-02 20:22:11 +0200128 if (GCC_VERSION VERSION_GREATER 4.3 OR GCC_VERSION VERSION_EQUAL 4.3)
129 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wvla")
130 endif()
Manuel Pégourié-Gonnardbcb04602015-07-19 16:00:04 +0200131 if (GCC_VERSION VERSION_GREATER 4.5 OR GCC_VERSION VERSION_EQUAL 4.5)
132 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wlogical-op")
133 endif()
Manuel Pégourié-Gonnard824ba722015-08-27 23:00:49 +0200134 if (GCC_VERSION VERSION_GREATER 4.8 OR GCC_VERSION VERSION_EQUAL 4.8)
135 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wshadow")
136 endif()
Manuel Pégourié-Gonnard216a1832015-06-25 09:20:03 +0200137 set(CMAKE_C_FLAGS_RELEASE "-O2")
138 set(CMAKE_C_FLAGS_DEBUG "-O0 -g3")
139 set(CMAKE_C_FLAGS_COVERAGE "-O0 -g3 --coverage")
140 set(CMAKE_C_FLAGS_ASAN "-Werror -fsanitize=address -fno-common -O3")
141 set(CMAKE_C_FLAGS_ASANDBG "-Werror -fsanitize=address -fno-common -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls ")
142 set(CMAKE_C_FLAGS_CHECK "-Werror -Os")
143 set(CMAKE_C_FLAGS_CHECKFULL "${CMAKE_C_FLAGS_CHECK} -Wcast-qual")
Azim Khan45b79cf2018-05-23 16:55:16 +0100144endif(CMAKE_COMPILER_IS_GNU)
Paul Bakker76f03112013-11-28 17:20:04 +0100145
Paul Bakker92bc8752013-12-30 17:56:23 +0100146if(CMAKE_COMPILER_IS_CLANG)
Gilles Peskinebe517162019-07-02 20:22:11 +0200147 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -Wwrite-strings -Wpointer-arith -Wimplicit-fallthrough -Wshadow -Wvla")
Manuel Pégourié-Gonnard216a1832015-06-25 09:20:03 +0200148 set(CMAKE_C_FLAGS_RELEASE "-O2")
149 set(CMAKE_C_FLAGS_DEBUG "-O0 -g3")
150 set(CMAKE_C_FLAGS_COVERAGE "-O0 -g3 --coverage")
Ron Eldore95092d2018-05-24 10:15:13 +0300151 set(CMAKE_C_FLAGS_ASAN "-Werror -fsanitize=address -fno-common -fsanitize=undefined -fno-sanitize-recover=all -O3")
152 set(CMAKE_C_FLAGS_ASANDBG "-Werror -fsanitize=address -fno-common -fsanitize=undefined -fno-sanitize-recover=all -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls ")
Manuel Pégourié-Gonnard216a1832015-06-25 09:20:03 +0200153 set(CMAKE_C_FLAGS_MEMSAN "-Werror -fsanitize=memory -O3")
154 set(CMAKE_C_FLAGS_MEMSANDBG "-Werror -fsanitize=memory -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls -fsanitize-memory-track-origins=2")
155 set(CMAKE_C_FLAGS_CHECK "-Werror -Os")
Paul Bakker92bc8752013-12-30 17:56:23 +0100156endif(CMAKE_COMPILER_IS_CLANG)
157
Azim Khan45b79cf2018-05-23 16:55:16 +0100158if(CMAKE_COMPILER_IS_IAR)
159 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} --warn_about_c_style_casts --warnings_are_errors -Ohz")
160endif(CMAKE_COMPILER_IS_IAR)
161
162if(CMAKE_COMPILER_IS_MSVC)
Simon B9b3e3c42016-11-03 01:12:50 +0000163 # Strictest warnings, and treat as errors
164 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /W3")
165 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /WX")
Azim Khan45b79cf2018-05-23 16:55:16 +0100166endif(CMAKE_COMPILER_IS_MSVC)
Manuel Pégourié-Gonnard30830532015-07-01 17:06:28 +0200167
Paul Bakker396c52f2009-07-11 19:54:40 +0000168if(CMAKE_BUILD_TYPE STREQUAL "Coverage")
Azim Khan45b79cf2018-05-23 16:55:16 +0100169 if(CMAKE_COMPILER_IS_GNU OR CMAKE_COMPILER_IS_CLANG)
Manuel Pégourié-Gonnard216a1832015-06-25 09:20:03 +0200170 set(CMAKE_SHARED_LINKER_FLAGS "--coverage")
Azim Khan45b79cf2018-05-23 16:55:16 +0100171 endif(CMAKE_COMPILER_IS_GNU OR CMAKE_COMPILER_IS_CLANG)
Paul Bakker396c52f2009-07-11 19:54:40 +0000172endif(CMAKE_BUILD_TYPE STREQUAL "Coverage")
Paul Bakker367dae42009-06-28 21:50:27 +0000173
Paul Bakker091e2872011-07-13 11:45:58 +0000174if(LIB_INSTALL_DIR)
175else()
Manuel Pégourié-Gonnard216a1832015-06-25 09:20:03 +0200176 set(LIB_INSTALL_DIR lib)
Paul Bakker091e2872011-07-13 11:45:58 +0000177endif()
178
Christoph M. Wintersteiger6ea2dea12019-01-21 17:26:19 +0000179include_directories(include/)
Darryl Greend9eee3b2018-11-02 10:45:36 +0000180include_directories(library/)
Paul Bakker367dae42009-06-28 21:50:27 +0000181
Christoph M. Wintersteiger62dddd02018-12-14 13:07:50 +0000182add_subdirectory(3rdparty)
Christoph M. Wintersteiger6ea2dea12019-01-21 17:26:19 +0000183include_directories(${thirdparty_inc})
184list(APPEND libs ${thirdparty_lib})
185add_definitions(${thirdparty_def})
186
Paul Bakker367dae42009-06-28 21:50:27 +0000187add_subdirectory(library)
Paul Bakker547f73d2011-01-05 15:07:54 +0000188add_subdirectory(include)
Paul Bakker2015eac2011-07-27 16:52:28 +0000189
Paul Bakkerdf5024c2014-03-26 13:27:51 +0100190if(ENABLE_PROGRAMS)
Manuel Pégourié-Gonnard216a1832015-06-25 09:20:03 +0200191 add_subdirectory(programs)
Paul Bakkerdf5024c2014-03-26 13:27:51 +0100192endif()
Paul Bakkerccba9bc2011-01-05 15:30:32 +0000193
Manuel Pégourié-Gonnardc9901892016-01-12 13:59:39 +0000194ADD_CUSTOM_TARGET(apidoc
Krzysztof Stachowiaka0188d62018-01-19 16:21:11 +0100195 COMMAND doxygen mbedtls.doxyfile
196 WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/doxygen)
Manuel Pégourié-Gonnard7669f282013-09-07 16:52:42 +0200197
Paul Bakker27f1cae2014-04-30 16:31:54 +0200198if(ENABLE_TESTING)
Manuel Pégourié-Gonnard5fe51d72015-07-01 16:59:56 +0200199 enable_testing()
Manuel Pégourié-Gonnardc8293b22015-06-25 09:22:25 +0200200
Manuel Pégourié-Gonnard5fe51d72015-07-01 16:59:56 +0200201 add_subdirectory(tests)
Manuel Pégourié-Gonnard61137df2014-02-24 11:57:36 +0100202
Manuel Pégourié-Gonnard5fe51d72015-07-01 16:59:56 +0200203 # additional convenience targets for Unix only
204 if(UNIX)
Manuel Pégourié-Gonnard546d86c2014-01-31 16:19:43 +0100205
Manuel Pégourié-Gonnard5fe51d72015-07-01 16:59:56 +0200206 ADD_CUSTOM_TARGET(covtest
207 COMMAND make test
208 COMMAND programs/test/selftest
Manuel Pégourié-Gonnard5fe51d72015-07-01 16:59:56 +0200209 )
Manuel Pégourié-Gonnardd3a91662015-07-01 10:06:27 +0200210
Manuel Pégourié-Gonnard5fe51d72015-07-01 16:59:56 +0200211 ADD_CUSTOM_TARGET(lcov
212 COMMAND rm -rf Coverage
213 COMMAND lcov --capture --initial --directory library/CMakeFiles/mbedtls.dir -o files.info
214 COMMAND lcov --capture --directory library/CMakeFiles/mbedtls.dir -o tests.info
215 COMMAND lcov --add-tracefile files.info --add-tracefile tests.info -o all.info
216 COMMAND lcov --remove all.info -o final.info '*.h'
217 COMMAND gendesc tests/Descriptions.txt -o descriptions
218 COMMAND genhtml --title "mbed TLS" --description-file descriptions --keep-descriptions --legend --no-branch-coverage -o Coverage final.info
219 COMMAND rm -f files.info tests.info all.info final.info descriptions
220 )
221
222 ADD_CUSTOM_TARGET(memcheck
223 COMMAND sed -i.bak s+/usr/bin/valgrind+`which valgrind`+ DartConfiguration.tcl
224 COMMAND ctest -O memcheck.log -D ExperimentalMemCheck
225 COMMAND tail -n1 memcheck.log | grep 'Memory checking results:' > /dev/null
226 COMMAND rm -f memcheck.log
227 COMMAND mv DartConfiguration.tcl.bak DartConfiguration.tcl
228 )
229 endif(UNIX)
Gilles Peskine84052572018-03-21 12:12:47 +0100230
Renz Christian Bagaporod8a40b52019-04-28 13:51:37 +0800231 # Make scripts needed for testing available in an out-of-source build.
232 if (NOT ${CMAKE_CURRENT_BINARY_DIR} STREQUAL ${CMAKE_CURRENT_SOURCE_DIR})
233 link_to_source(scripts)
234 # Copy (don't link) DartConfiguration.tcl, needed for memcheck, to
235 # keep things simple with the sed commands in the memcheck target.
236 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/DartConfiguration.tcl
237 ${CMAKE_CURRENT_BINARY_DIR}/DartConfiguration.tcl COPYONLY)
238 endif()
Gilles Peskine84052572018-03-21 12:12:47 +0100239endif()