• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1cmake_minimum_required(VERSION 2.6)
2if(TEST_CPP)
3    project("mbed TLS" C CXX)
4else()
5    project("mbed TLS" C)
6endif()
7
8option(USE_PKCS11_HELPER_LIBRARY "Build mbed TLS with the pkcs11-helper library." OFF)
9option(ENABLE_ZLIB_SUPPORT "Build mbed TLS with zlib library." OFF)
10
11option(ENABLE_PROGRAMS "Build mbed TLS programs." ON)
12
13option(UNSAFE_BUILD "Allow unsafe builds. These builds ARE NOT SECURE." OFF)
14
15string(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
20# the test suites currently have compile errors with MSVC
21if(CMAKE_COMPILER_IS_MSVC)
22    option(ENABLE_TESTING "Build mbed TLS tests." OFF)
23else()
24    option(ENABLE_TESTING "Build mbed TLS tests." ON)
25endif()
26
27# 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
39set(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
49find_package(PythonInterp)
50find_package(Perl)
51if(PERL_FOUND)
52
53    # 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
60    # If NULL Entropy is configured, display an appropriate warning
61    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
62                        RESULT_VARIABLE result)
63    if(${result} EQUAL 0)
64        message(WARNING ${NULL_ENTROPY_WARNING})
65
66        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
82set(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
86# 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`
90    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()
98
99    if (NOT EXISTS ${link})
100        if (CMAKE_HOST_UNIX)
101            set(command ln -s ${target} ${link})
102        else()
103            if (IS_DIRECTORY ${target})
104                set(command cmd.exe /c mklink /j ${link} ${target})
105            else()
106                set(command cmd.exe /c mklink /h ${link} ${target})
107            endif()
108        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
120string(REGEX MATCH "Clang" CMAKE_COMPILER_IS_CLANG "${CMAKE_C_COMPILER_ID}")
121
122if(CMAKE_COMPILER_IS_GNU)
123    # 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)
127    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -W -Wdeclaration-after-statement -Wwrite-strings")
128    if (GCC_VERSION VERSION_GREATER 4.5 OR GCC_VERSION VERSION_EQUAL 4.5)
129        set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wlogical-op")
130    endif()
131    if (GCC_VERSION VERSION_GREATER 4.8 OR GCC_VERSION VERSION_EQUAL 4.8)
132        set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wshadow")
133    endif()
134    set(CMAKE_C_FLAGS_RELEASE     "-O2")
135    set(CMAKE_C_FLAGS_DEBUG       "-O0 -g3")
136    set(CMAKE_C_FLAGS_COVERAGE    "-O0 -g3 --coverage")
137    set(CMAKE_C_FLAGS_ASAN        "-Werror -fsanitize=address -fno-common -O3")
138    set(CMAKE_C_FLAGS_ASANDBG     "-Werror -fsanitize=address -fno-common -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls ")
139    set(CMAKE_C_FLAGS_CHECK       "-Werror -Os")
140    set(CMAKE_C_FLAGS_CHECKFULL   "${CMAKE_C_FLAGS_CHECK} -Wcast-qual")
141endif(CMAKE_COMPILER_IS_GNU)
142
143if(CMAKE_COMPILER_IS_CLANG)
144    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -W -Wdeclaration-after-statement -Wwrite-strings -Wpointer-arith -Wimplicit-fallthrough -Wshadow")
145    set(CMAKE_C_FLAGS_RELEASE     "-O2")
146    set(CMAKE_C_FLAGS_DEBUG       "-O0 -g3")
147    set(CMAKE_C_FLAGS_COVERAGE    "-O0 -g3 --coverage")
148    set(CMAKE_C_FLAGS_ASAN        "-Werror -fsanitize=address -fno-common -fsanitize=undefined -fno-sanitize-recover=all -O3")
149    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 ")
150    set(CMAKE_C_FLAGS_MEMSAN      "-Werror -fsanitize=memory -O3")
151    set(CMAKE_C_FLAGS_MEMSANDBG   "-Werror -fsanitize=memory -O1 -g3 -fno-omit-frame-pointer -fno-optimize-sibling-calls -fsanitize-memory-track-origins=2")
152    set(CMAKE_C_FLAGS_CHECK       "-Werror -Os")
153endif(CMAKE_COMPILER_IS_CLANG)
154
155if(CMAKE_COMPILER_IS_IAR)
156    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} --warn_about_c_style_casts --warnings_are_errors -Ohz")
157endif(CMAKE_COMPILER_IS_IAR)
158
159if(CMAKE_COMPILER_IS_MSVC)
160    # Strictest warnings, and treat as errors
161    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /W3")
162    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /WX")
163endif(CMAKE_COMPILER_IS_MSVC)
164
165if(CMAKE_BUILD_TYPE STREQUAL "Coverage")
166    if(CMAKE_COMPILER_IS_GNU OR CMAKE_COMPILER_IS_CLANG)
167        set(CMAKE_SHARED_LINKER_FLAGS "--coverage")
168    endif(CMAKE_COMPILER_IS_GNU OR CMAKE_COMPILER_IS_CLANG)
169endif(CMAKE_BUILD_TYPE STREQUAL "Coverage")
170
171if(LIB_INSTALL_DIR)
172else()
173    set(LIB_INSTALL_DIR lib)
174endif()
175
176include_directories(include/)
177
178if(ENABLE_ZLIB_SUPPORT)
179    find_package(ZLIB)
180
181    if(ZLIB_FOUND)
182        include_directories(${ZLIB_INCLUDE_DIR})
183    endif(ZLIB_FOUND)
184endif(ENABLE_ZLIB_SUPPORT)
185
186add_subdirectory(library)
187add_subdirectory(include)
188
189if(ENABLE_PROGRAMS)
190    add_subdirectory(programs)
191endif()
192
193ADD_CUSTOM_TARGET(apidoc
194    COMMAND doxygen mbedtls.doxyfile
195    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/doxygen)
196
197if(ENABLE_TESTING)
198    enable_testing()
199
200    add_subdirectory(tests)
201
202    # additional convenience targets for Unix only
203    if(UNIX)
204
205        ADD_CUSTOM_TARGET(covtest
206            COMMAND make test
207            COMMAND programs/test/selftest
208            COMMAND tests/compat.sh
209            COMMAND tests/ssl-opt.sh
210        )
211
212        ADD_CUSTOM_TARGET(lcov
213            COMMAND rm -rf Coverage
214            COMMAND lcov --capture --initial --directory library/CMakeFiles/mbedtls.dir -o files.info
215            COMMAND lcov --capture --directory library/CMakeFiles/mbedtls.dir -o tests.info
216            COMMAND lcov --add-tracefile files.info --add-tracefile tests.info -o all.info
217            COMMAND lcov --remove all.info -o final.info '*.h'
218            COMMAND gendesc tests/Descriptions.txt -o descriptions
219            COMMAND genhtml --title "mbed TLS" --description-file descriptions --keep-descriptions --legend --no-branch-coverage -o Coverage final.info
220            COMMAND rm -f files.info tests.info all.info final.info descriptions
221        )
222
223        ADD_CUSTOM_TARGET(memcheck
224            COMMAND sed -i.bak s+/usr/bin/valgrind+`which valgrind`+ DartConfiguration.tcl
225            COMMAND ctest -O memcheck.log -D ExperimentalMemCheck
226            COMMAND tail -n1 memcheck.log | grep 'Memory checking results:' > /dev/null
227            COMMAND rm -f memcheck.log
228            COMMAND mv DartConfiguration.tcl.bak DartConfiguration.tcl
229        )
230    endif(UNIX)
231
232    # Make scripts needed for testing available in an out-of-source build.
233    if (NOT ${CMAKE_CURRENT_BINARY_DIR} STREQUAL ${CMAKE_CURRENT_SOURCE_DIR})
234        link_to_source(scripts)
235        # Copy (don't link) DartConfiguration.tcl, needed for memcheck, to
236        # keep things simple with the sed commands in the memcheck target.
237        configure_file(${CMAKE_CURRENT_SOURCE_DIR}/DartConfiguration.tcl
238                    ${CMAKE_CURRENT_BINARY_DIR}/DartConfiguration.tcl COPYONLY)
239    endif()
240endif()
241