blob: df03dd6073effdd22768c4596023be65a28a0d04 [file] [log] [blame]
Paul Bakker367dae42009-06-28 21:50:27 +00001cmake_minimum_required(VERSION 2.6)
Manuel Pégourié-Gonnarddb5d15e2015-06-24 15:01:15 +02002project("mbed TLS" C)
Paul Bakker367dae42009-06-28 21:50:27 +00003
Manuel Pégourié-Gonnard0b4e2ac2015-07-08 22:10:38 +01004option(USE_PKCS11_HELPER_LIBRARY "Build mbed TLS with the pkcs11-helper library." OFF)
5option(ENABLE_ZLIB_SUPPORT "Build mbed TLS with zlib library." OFF)
6
7option(ENABLE_PROGRAMS "Build mbed TLS programs." ON)
Manuel Pégourié-Gonnard58719102015-07-09 09:19:47 +01008
Simon Butcher1ceab6e2016-06-21 10:14:00 +01009option(UNSAFE_BUILD "Allow unsafe builds. These builds ARE NOT SECURE." OFF)
Manuel Pégourié-Gonnard58719102015-07-09 09:19:47 +010010
11# the test suites currently have compile errors with MSVC
12if(MSVC)
13 option(ENABLE_TESTING "Build mbed TLS tests." OFF)
14else()
15 option(ENABLE_TESTING "Build mbed TLS tests." ON)
16endif()
Manuel Pégourié-Gonnard0b4e2ac2015-07-08 22:10:38 +010017
Simon Butcher45103f32016-06-21 14:47:11 +010018# Warning string - created as a list for compatibility with CMake 2.8
19set(WARNING_BORDER "*******************************************************\n")
20set(NULL_ENTROPY_WARN_L1 "**** WARNING! MBEDTLS_TEST_NULL_ENTROPY defined!\n")
21set(NULL_ENTROPY_WARN_L2 "**** THIS BUILD HAS NO DEFINED ENTROPY SOURCES\n")
22set(NULL_ENTROPY_WARN_L3 "**** AND IS *NOT* SUITABLE FOR PRODUCTION USE\n")
23
24set(NULL_ENTROPY_WARNING "${WARNING_BORDER}"
25 "${NULL_ENTROPY_WARN_L1}"
26 "${NULL_ENTROPY_WARN_L2}"
27 "${NULL_ENTROPY_WARN_L3}"
28 "${WARNING_BORDER}")
29
Simon Butcher1ceab6e2016-06-21 10:14:00 +010030find_package(Perl)
31if(PERL_FOUND)
32
33 # If NULL Entropy is configured, display an appropriate warning
Andres AGdc192212016-08-31 17:33:13 +010034 execute_process(COMMAND ${PERL_EXECUTABLE} ${CMAKE_SOURCE_DIR}/scripts/config.pl -f ${CMAKE_SOURCE_DIR}/include/mbedtls/config.h get MBEDTLS_TEST_NULL_ENTROPY
Simon Butcher1ceab6e2016-06-21 10:14:00 +010035 RESULT_VARIABLE result)
36 if(${result} EQUAL 0)
Simon Butcher45103f32016-06-21 14:47:11 +010037 message(WARNING ${NULL_ENTROPY_WARNING})
38
Simon Butcher1ceab6e2016-06-21 10:14:00 +010039 if(NOT UNSAFE_BUILD)
40 message(FATAL_ERROR "\
41\n\
42Warning! You have enabled MBEDTLS_TEST_NULL_ENTROPY. \
43This option is not safe for production use and negates all security \
44It is intended for development use only. \
45\n\
46To confirm you want to build with this option, re-run cmake with the \
47option: \n\
48 cmake -DUNSAFE_BUILD=ON ")
49
50 return()
51 endif()
52 endif()
53endif()
54
Manuel Pégourié-Gonnard0b4e2ac2015-07-08 22:10:38 +010055set(CMAKE_BUILD_TYPE ${CMAKE_BUILD_TYPE}
56 CACHE STRING "Choose the type of build: None Debug Release Coverage ASan ASanDbg MemSan MemSanDbg Check CheckFull"
57 FORCE)
58
Gilles Peskine84052572018-03-21 12:12:47 +010059# Create a symbolic link from ${base_name} in the binary directory
60# to the corresponding path in the source directory.
61function(link_to_source base_name)
62 # Get OS dependent path to use in `execute_process`
63 file(TO_NATIVE_PATH "${CMAKE_CURRENT_BINARY_DIR}/${base_name}" link)
64 file(TO_NATIVE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/${base_name}" target)
65
66 if (NOT EXISTS ${link})
67 if (CMAKE_HOST_UNIX)
68 set(command ln -s ${target} ${link})
69 else()
70 set(command cmd.exe /c mklink /j ${link} ${target})
71 endif()
72
73 execute_process(COMMAND ${command}
74 RESULT_VARIABLE result
75 ERROR_VARIABLE output)
76
77 if (NOT ${result} EQUAL 0)
78 message(FATAL_ERROR "Could not create symbolic link for: ${target} --> ${output}")
79 endif()
80 endif()
81endfunction(link_to_source)
82
Barry K. Nathancf975f52014-04-23 17:40:25 -070083string(REGEX MATCH "Clang" CMAKE_COMPILER_IS_CLANG "${CMAKE_C_COMPILER_ID}")
Paul Bakker92bc8752013-12-30 17:56:23 +010084
Paul Bakker2015eac2011-07-27 16:52:28 +000085if(CMAKE_COMPILER_IS_GNUCC)
Manuel Pégourié-Gonnardbcb04602015-07-19 16:00:04 +020086 # some warnings we want are not available with old GCC versions
87 # note: starting with CMake 2.8 we could use CMAKE_C_COMPILER_VERSION
88 execute_process(COMMAND ${CMAKE_C_COMPILER} -dumpversion
89 OUTPUT_VARIABLE GCC_VERSION)
Manuel Pégourié-Gonnard824ba722015-08-27 23:00:49 +020090 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -W -Wdeclaration-after-statement -Wwrite-strings")
Manuel Pégourié-Gonnardbcb04602015-07-19 16:00:04 +020091 if (GCC_VERSION VERSION_GREATER 4.5 OR GCC_VERSION VERSION_EQUAL 4.5)
92 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wlogical-op")
93 endif()
Manuel Pégourié-Gonnard824ba722015-08-27 23:00:49 +020094 if (GCC_VERSION VERSION_GREATER 4.8 OR GCC_VERSION VERSION_EQUAL 4.8)
95 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wshadow")
96 endif()
Manuel Pégourié-Gonnard216a1832015-06-25 09:20:03 +020097 set(CMAKE_C_FLAGS_RELEASE "-O2")
98 set(CMAKE_C_FLAGS_DEBUG "-O0 -g3")
99 set(CMAKE_C_FLAGS_COVERAGE "-O0 -g3 --coverage")
100 set(CMAKE_C_FLAGS_ASAN "-Werror -fsanitize=address -fno-common -O3")
101 set(CMAKE_C_FLAGS_ASANDBG "-Werror -fsanitize=address -fno-common -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls ")
102 set(CMAKE_C_FLAGS_CHECK "-Werror -Os")
103 set(CMAKE_C_FLAGS_CHECKFULL "${CMAKE_C_FLAGS_CHECK} -Wcast-qual")
Paul Bakker2015eac2011-07-27 16:52:28 +0000104endif(CMAKE_COMPILER_IS_GNUCC)
Paul Bakker76f03112013-11-28 17:20:04 +0100105
Paul Bakker92bc8752013-12-30 17:56:23 +0100106if(CMAKE_COMPILER_IS_CLANG)
Manuel Pégourié-Gonnardea356662015-08-27 12:02:40 +0200107 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -W -Wdeclaration-after-statement -Wwrite-strings -Wpointer-arith -Wimplicit-fallthrough -Wshadow")
Manuel Pégourié-Gonnard216a1832015-06-25 09:20:03 +0200108 set(CMAKE_C_FLAGS_RELEASE "-O2")
109 set(CMAKE_C_FLAGS_DEBUG "-O0 -g3")
110 set(CMAKE_C_FLAGS_COVERAGE "-O0 -g3 --coverage")
111 set(CMAKE_C_FLAGS_ASAN "-Werror -fsanitize=address -fno-common -fsanitize=undefined -fno-sanitize-recover -O3")
112 set(CMAKE_C_FLAGS_ASANDBG "-Werror -fsanitize=address -fno-common -fsanitize=undefined -fno-sanitize-recover -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls ")
113 set(CMAKE_C_FLAGS_MEMSAN "-Werror -fsanitize=memory -O3")
114 set(CMAKE_C_FLAGS_MEMSANDBG "-Werror -fsanitize=memory -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls -fsanitize-memory-track-origins=2")
115 set(CMAKE_C_FLAGS_CHECK "-Werror -Os")
Paul Bakker92bc8752013-12-30 17:56:23 +0100116endif(CMAKE_COMPILER_IS_CLANG)
117
Manuel Pégourié-Gonnard30830532015-07-01 17:06:28 +0200118if(MSVC)
Simon B9b3e3c42016-11-03 01:12:50 +0000119 # Strictest warnings, and treat as errors
120 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /W3")
121 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /WX")
Manuel Pégourié-Gonnard30830532015-07-01 17:06:28 +0200122endif(MSVC)
123
Paul Bakker396c52f2009-07-11 19:54:40 +0000124if(CMAKE_BUILD_TYPE STREQUAL "Coverage")
Manuel Pégourié-Gonnard216a1832015-06-25 09:20:03 +0200125 if(CMAKE_COMPILER_IS_GNUCC OR CMAKE_COMPILER_IS_CLANG)
126 set(CMAKE_SHARED_LINKER_FLAGS "--coverage")
127 endif(CMAKE_COMPILER_IS_GNUCC OR CMAKE_COMPILER_IS_CLANG)
Paul Bakker396c52f2009-07-11 19:54:40 +0000128endif(CMAKE_BUILD_TYPE STREQUAL "Coverage")
Paul Bakker367dae42009-06-28 21:50:27 +0000129
Paul Bakker091e2872011-07-13 11:45:58 +0000130if(LIB_INSTALL_DIR)
131else()
Manuel Pégourié-Gonnard216a1832015-06-25 09:20:03 +0200132 set(LIB_INSTALL_DIR lib)
Paul Bakker091e2872011-07-13 11:45:58 +0000133endif()
134
Paul Bakker367dae42009-06-28 21:50:27 +0000135include_directories(include/)
136
Paul Bakker92eeea42012-07-03 15:10:33 +0000137if(ENABLE_ZLIB_SUPPORT)
Manuel Pégourié-Gonnard216a1832015-06-25 09:20:03 +0200138 find_package(ZLIB)
Paul Bakker92eeea42012-07-03 15:10:33 +0000139
Manuel Pégourié-Gonnard216a1832015-06-25 09:20:03 +0200140 if(ZLIB_FOUND)
141 include_directories(${ZLIB_INCLUDE_DIR})
142 endif(ZLIB_FOUND)
Paul Bakker92eeea42012-07-03 15:10:33 +0000143endif(ENABLE_ZLIB_SUPPORT)
144
Paul Bakker367dae42009-06-28 21:50:27 +0000145add_subdirectory(library)
Paul Bakker547f73d2011-01-05 15:07:54 +0000146add_subdirectory(include)
Paul Bakker2015eac2011-07-27 16:52:28 +0000147
Paul Bakkerdf5024c2014-03-26 13:27:51 +0100148if(ENABLE_PROGRAMS)
Manuel Pégourié-Gonnard216a1832015-06-25 09:20:03 +0200149 add_subdirectory(programs)
Paul Bakkerdf5024c2014-03-26 13:27:51 +0100150endif()
Paul Bakkerccba9bc2011-01-05 15:30:32 +0000151
Manuel Pégourié-Gonnardc9901892016-01-12 13:59:39 +0000152ADD_CUSTOM_TARGET(apidoc
Krzysztof Stachowiaka0188d62018-01-19 16:21:11 +0100153 COMMAND doxygen mbedtls.doxyfile
154 WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/doxygen)
Manuel Pégourié-Gonnard7669f282013-09-07 16:52:42 +0200155
Paul Bakker27f1cae2014-04-30 16:31:54 +0200156if(ENABLE_TESTING)
Manuel Pégourié-Gonnard5fe51d72015-07-01 16:59:56 +0200157 enable_testing()
Manuel Pégourié-Gonnardc8293b22015-06-25 09:22:25 +0200158
Manuel Pégourié-Gonnard5fe51d72015-07-01 16:59:56 +0200159 add_subdirectory(tests)
Manuel Pégourié-Gonnard61137df2014-02-24 11:57:36 +0100160
Manuel Pégourié-Gonnard5fe51d72015-07-01 16:59:56 +0200161 # additional convenience targets for Unix only
162 if(UNIX)
Manuel Pégourié-Gonnard546d86c2014-01-31 16:19:43 +0100163
Manuel Pégourié-Gonnard5fe51d72015-07-01 16:59:56 +0200164 ADD_CUSTOM_TARGET(covtest
165 COMMAND make test
166 COMMAND programs/test/selftest
Simon Butcher3ea7f522016-03-07 23:22:10 +0000167 COMMAND tests/compat.sh
Manuel Pégourié-Gonnard3d404b42015-07-08 21:59:16 +0100168 COMMAND tests/ssl-opt.sh
Manuel Pégourié-Gonnard5fe51d72015-07-01 16:59:56 +0200169 )
Manuel Pégourié-Gonnardd3a91662015-07-01 10:06:27 +0200170
Manuel Pégourié-Gonnard5fe51d72015-07-01 16:59:56 +0200171 ADD_CUSTOM_TARGET(lcov
172 COMMAND rm -rf Coverage
173 COMMAND lcov --capture --initial --directory library/CMakeFiles/mbedtls.dir -o files.info
174 COMMAND lcov --capture --directory library/CMakeFiles/mbedtls.dir -o tests.info
175 COMMAND lcov --add-tracefile files.info --add-tracefile tests.info -o all.info
176 COMMAND lcov --remove all.info -o final.info '*.h'
177 COMMAND gendesc tests/Descriptions.txt -o descriptions
178 COMMAND genhtml --title "mbed TLS" --description-file descriptions --keep-descriptions --legend --no-branch-coverage -o Coverage final.info
179 COMMAND rm -f files.info tests.info all.info final.info descriptions
180 )
181
182 ADD_CUSTOM_TARGET(memcheck
183 COMMAND sed -i.bak s+/usr/bin/valgrind+`which valgrind`+ DartConfiguration.tcl
184 COMMAND ctest -O memcheck.log -D ExperimentalMemCheck
185 COMMAND tail -n1 memcheck.log | grep 'Memory checking results:' > /dev/null
186 COMMAND rm -f memcheck.log
187 COMMAND mv DartConfiguration.tcl.bak DartConfiguration.tcl
188 )
189 endif(UNIX)
Paul Bakker27f1cae2014-04-30 16:31:54 +0200190endif()
Gilles Peskine84052572018-03-21 12:12:47 +0100191
192# Make scripts and data files needed for testing available in an
193# out-of-source build.
194if (NOT ${CMAKE_CURRENT_BINARY_DIR} STREQUAL ${CMAKE_CURRENT_SOURCE_DIR})
195 link_to_source(scripts)
196endif()