1 cmake_minimum_required(VERSION 2.6)
3 project("mbed TLS" C CXX)
8 set(MBEDTLS_DIR ${CMAKE_CURRENT_SOURCE_DIR})
10 option(USE_PKCS11_HELPER_LIBRARY "Build mbed TLS with the pkcs11-helper library." OFF)
11 option(ENABLE_ZLIB_SUPPORT "Build mbed TLS with zlib library." OFF)
13 option(ENABLE_PROGRAMS "Build mbed TLS programs." ON)
15 option(UNSAFE_BUILD "Allow unsafe builds. These builds ARE NOT SECURE." OFF)
17 # export the submodule flag so that crypto knows it's being built as a submodule
18 set( USE_CRYPTO_SUBMODULE ON )
20 string(REGEX MATCH "Clang" CMAKE_COMPILER_IS_CLANG "${CMAKE_C_COMPILER_ID}")
21 string(REGEX MATCH "GNU" CMAKE_COMPILER_IS_GNU "${CMAKE_C_COMPILER_ID}")
22 string(REGEX MATCH "IAR" CMAKE_COMPILER_IS_IAR "${CMAKE_C_COMPILER_ID}")
23 string(REGEX MATCH "MSVC" CMAKE_COMPILER_IS_MSVC "${CMAKE_C_COMPILER_ID}")
25 # the test suites currently have compile errors with MSVC
26 if(CMAKE_COMPILER_IS_MSVC)
27 option(ENABLE_TESTING "Build mbed TLS tests." OFF)
29 option(ENABLE_TESTING "Build mbed TLS tests." ON)
32 # Warning string - created as a list for compatibility with CMake 2.8
33 set(WARNING_BORDER "*******************************************************\n")
34 set(NULL_ENTROPY_WARN_L1 "**** WARNING! MBEDTLS_TEST_NULL_ENTROPY defined!\n")
35 set(NULL_ENTROPY_WARN_L2 "**** THIS BUILD HAS NO DEFINED ENTROPY SOURCES\n")
36 set(NULL_ENTROPY_WARN_L3 "**** AND IS *NOT* SUITABLE FOR PRODUCTION USE\n")
38 set(NULL_ENTROPY_WARNING "${WARNING_BORDER}"
39 "${NULL_ENTROPY_WARN_L1}"
40 "${NULL_ENTROPY_WARN_L2}"
41 "${NULL_ENTROPY_WARN_L3}"
44 set(CTR_DRBG_128_BIT_KEY_WARN_L1 "**** WARNING! MBEDTLS_CTR_DRBG_USE_128_BIT_KEY defined!\n")
45 set(CTR_DRBG_128_BIT_KEY_WARN_L2 "**** Using 128-bit keys for CTR_DRBG limits the security of generated\n")
46 set(CTR_DRBG_128_BIT_KEY_WARN_L3 "**** keys and operations that use random values generated to 128-bit security\n")
48 set(CTR_DRBG_128_BIT_KEY_WARNING "${WARNING_BORDER}"
49 "${CTR_DRBG_128_BIT_KEY_WARN_L1}"
50 "${CTR_DRBG_128_BIT_KEY_WARN_L2}"
51 "${CTR_DRBG_128_BIT_KEY_WARN_L3}"
54 find_package(PythonInterp)
58 # If 128-bit keys are configured for CTR_DRBG, display an appropriate warning
59 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
60 RESULT_VARIABLE result)
62 message(WARNING ${CTR_DRBG_128_BIT_KEY_WARNING})
65 # If NULL Entropy is configured, display an appropriate warning
66 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
67 RESULT_VARIABLE result)
69 message(WARNING ${NULL_ENTROPY_WARNING})
72 message(FATAL_ERROR "\
74 Warning! You have enabled MBEDTLS_TEST_NULL_ENTROPY. \
75 This option is not safe for production use and negates all security \
76 It is intended for development use only. \
78 To confirm you want to build with this option, re-run cmake with the \
80 cmake -DUNSAFE_BUILD=ON ")
87 set(CMAKE_BUILD_TYPE ${CMAKE_BUILD_TYPE}
88 CACHE STRING "Choose the type of build: None Debug Release Coverage ASan ASanDbg MemSan MemSanDbg Check CheckFull"
91 # Create a symbolic link from ${base_name} in the binary directory
92 # to the corresponding path in the source directory.
93 function(link_to_source base_name)
94 # Get OS dependent path to use in `execute_process`
96 #mklink is an internal command of cmd.exe it can only work with \
97 string(REPLACE "/" "\\" link "${CMAKE_CURRENT_BINARY_DIR}/${base_name}")
98 string(REPLACE "/" "\\" target "${CMAKE_CURRENT_SOURCE_DIR}/${base_name}")
100 set(link "${CMAKE_CURRENT_BINARY_DIR}/${base_name}")
101 set(target "${CMAKE_CURRENT_SOURCE_DIR}/${base_name}")
104 if (NOT EXISTS ${link})
106 set(command ln -s ${target} ${link})
108 if (IS_DIRECTORY ${target})
109 set(command cmd.exe /c mklink /j ${link} ${target})
111 set(command cmd.exe /c mklink /h ${link} ${target})
115 execute_process(COMMAND ${command}
116 RESULT_VARIABLE result
117 ERROR_VARIABLE output)
119 if (NOT ${result} EQUAL 0)
120 message(FATAL_ERROR "Could not create symbolic link for: ${target} --> ${output}")
123 endfunction(link_to_source)
125 string(REGEX MATCH "Clang" CMAKE_COMPILER_IS_CLANG "${CMAKE_C_COMPILER_ID}")
127 if(CMAKE_COMPILER_IS_GNU)
128 # some warnings we want are not available with old GCC versions
129 # note: starting with CMake 2.8 we could use CMAKE_C_COMPILER_VERSION
130 execute_process(COMMAND ${CMAKE_C_COMPILER} -dumpversion
131 OUTPUT_VARIABLE GCC_VERSION)
132 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -W -Wdeclaration-after-statement -Wwrite-strings")
133 if (GCC_VERSION VERSION_GREATER 4.5 OR GCC_VERSION VERSION_EQUAL 4.5)
134 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wlogical-op")
136 if (GCC_VERSION VERSION_GREATER 4.8 OR GCC_VERSION VERSION_EQUAL 4.8)
137 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wshadow")
139 set(CMAKE_C_FLAGS_RELEASE "-O2")
140 set(CMAKE_C_FLAGS_DEBUG "-O0 -g3")
141 set(CMAKE_C_FLAGS_COVERAGE "-O0 -g3 --coverage")
142 set(CMAKE_C_FLAGS_ASAN "-Werror -fsanitize=address -fno-common -O3")
143 set(CMAKE_C_FLAGS_ASANDBG "-Werror -fsanitize=address -fno-common -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls ")
144 set(CMAKE_C_FLAGS_CHECK "-Werror -Os")
145 set(CMAKE_C_FLAGS_CHECKFULL "${CMAKE_C_FLAGS_CHECK} -Wcast-qual")
146 endif(CMAKE_COMPILER_IS_GNU)
148 if(CMAKE_COMPILER_IS_CLANG)
149 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -W -Wdeclaration-after-statement -Wwrite-strings -Wpointer-arith -Wimplicit-fallthrough -Wshadow")
150 set(CMAKE_C_FLAGS_RELEASE "-O2")
151 set(CMAKE_C_FLAGS_DEBUG "-O0 -g3")
152 set(CMAKE_C_FLAGS_COVERAGE "-O0 -g3 --coverage")
153 set(CMAKE_C_FLAGS_ASAN "-Werror -fsanitize=address -fno-common -fsanitize=undefined -fno-sanitize-recover=all -O3")
154 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 ")
155 set(CMAKE_C_FLAGS_MEMSAN "-Werror -fsanitize=memory -O3")
156 set(CMAKE_C_FLAGS_MEMSANDBG "-Werror -fsanitize=memory -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls -fsanitize-memory-track-origins=2")
157 set(CMAKE_C_FLAGS_CHECK "-Werror -Os")
158 endif(CMAKE_COMPILER_IS_CLANG)
160 if(CMAKE_COMPILER_IS_IAR)
161 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} --warn_about_c_style_casts --warnings_are_errors -Ohz")
162 endif(CMAKE_COMPILER_IS_IAR)
164 if(CMAKE_COMPILER_IS_MSVC)
165 # Strictest warnings, and treat as errors
166 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /W3")
167 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /WX")
168 endif(CMAKE_COMPILER_IS_MSVC)
170 if(CMAKE_BUILD_TYPE STREQUAL "Coverage")
171 if(CMAKE_COMPILER_IS_GNU OR CMAKE_COMPILER_IS_CLANG)
172 set(CMAKE_SHARED_LINKER_FLAGS "--coverage")
173 endif(CMAKE_COMPILER_IS_GNU OR CMAKE_COMPILER_IS_CLANG)
174 endif(CMAKE_BUILD_TYPE STREQUAL "Coverage")
178 set(LIB_INSTALL_DIR lib)
181 if(ENABLE_ZLIB_SUPPORT)
185 include_directories(${ZLIB_INCLUDE_DIR})
187 endif(ENABLE_ZLIB_SUPPORT)
189 add_subdirectory(library)
190 add_subdirectory(include)
191 add_subdirectory(crypto/library)
192 add_subdirectory(crypto/include)
195 add_subdirectory(programs)
198 ADD_CUSTOM_TARGET(apidoc
199 COMMAND doxygen mbedtls.doxyfile
200 WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/doxygen)
205 add_subdirectory(tests)
206 add_subdirectory(crypto/tests)
208 # additional convenience targets for Unix only
211 ADD_CUSTOM_TARGET(covtest
213 COMMAND programs/test/selftest
214 COMMAND tests/compat.sh
215 COMMAND tests/ssl-opt.sh
218 ADD_CUSTOM_TARGET(lcov
219 COMMAND rm -rf Coverage
220 COMMAND lcov --capture --initial --directory library/CMakeFiles/mbedtls.dir -o files.info
221 COMMAND lcov --capture --directory library/CMakeFiles/mbedtls.dir -o tests.info
222 COMMAND lcov --add-tracefile files.info --add-tracefile tests.info -o all.info
223 COMMAND lcov --remove all.info -o final.info '*.h'
224 COMMAND gendesc tests/Descriptions.txt -o descriptions
225 COMMAND genhtml --title "mbed TLS" --description-file descriptions --keep-descriptions --legend --no-branch-coverage -o Coverage final.info
226 COMMAND rm -f files.info tests.info all.info final.info descriptions
229 ADD_CUSTOM_TARGET(memcheck
230 COMMAND sed -i.bak s+/usr/bin/valgrind+`which valgrind`+ DartConfiguration.tcl
231 COMMAND ctest -O memcheck.log -D ExperimentalMemCheck
232 COMMAND tail -n1 memcheck.log | grep 'Memory checking results:' > /dev/null
233 COMMAND rm -f memcheck.log
234 COMMAND mv DartConfiguration.tcl.bak DartConfiguration.tcl
238 # Make scripts needed for testing available in an out-of-source build.
239 if (NOT ${CMAKE_CURRENT_BINARY_DIR} STREQUAL ${CMAKE_CURRENT_SOURCE_DIR})
240 link_to_source(scripts)
241 # Copy (don't link) DartConfiguration.tcl, needed for memcheck, to
242 # keep things simple with the sed commands in the memcheck target.
243 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/DartConfiguration.tcl
244 ${CMAKE_CURRENT_BINARY_DIR}/DartConfiguration.tcl COPYONLY)