forked from aws/s2n-tls
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCMakeLists.txt
787 lines (672 loc) · 31.3 KB
/
CMakeLists.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
cmake_minimum_required (VERSION 3.9)
project (s2n C)
if(POLICY CMP0077)
cmake_policy(SET CMP0077 NEW) #option does nothing when a normal variable of the same name exists.
endif()
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
set(INSTALL_LIB_DIR lib CACHE PATH "Installation directory for libraries")
set(INSTALL_INCLUDE_DIR include CACHE PATH "Installation directory for header files")
set(INSTALL_CMAKE_DIR lib/cmake CACHE PATH "Installation directory for cmake files")
set(CMAKE_FIND_PACKAGE_PREFER_CONFIG TRUE)
# These Version numbers are for major updates only- we won't track minor/patch updates here.
set(VERSION_MAJOR 1)
set(VERSION_MINOR 0)
set(VERSION_PATCH 0)
option(SEARCH_LIBCRYPTO "Set this if you want to let S2N search libcrypto for you,
otherwise a crypto target needs to be defined." ON)
option(UNSAFE_TREAT_WARNINGS_AS_ERRORS "Compiler warnings are treated as errors. Warnings may
indicate danger points where you should verify with the S2N-TLS developers that the security of
the library is not compromised. Turn this OFF to ignore warnings." ON)
option(S2N_WERROR_ALL "This option will cause all artifacts linked to libs2n to use the
-Werror setting." OFF)
option(S2N_INTERN_LIBCRYPTO "This ensures that s2n-tls is compiled and deployed with a specific
version of libcrypto by interning the code and hiding symbols. This also enables s2n-tls to be
loaded in an application with an otherwise conflicting libcrypto version." OFF)
option(S2N_LTO, "Enables link time optimizations when building s2n-tls." OFF)
option(S2N_STACKTRACE "Enables stacktrace functionality in s2n-tls. Note that this functionality is
only available on platforms that support execinfo." ON)
option(COVERAGE "Enable profiling collection for code coverage calculation" OFF)
option(BUILD_TESTING "Build tests for s2n-tls. By default only unit tests are built." ON)
option(S2N_INTEG_TESTS "Enable the integrationv2 tests" OFF)
option(S2N_FAST_INTEG_TESTS "Enable the integrationv2 with more parallelism, only has effect if S2N_INTEG_TESTS=ON" ON)
option(S2N_INSTALL_S2NC_S2ND "Install the binaries s2nc and s2nd" OFF)
option(S2N_USE_CRYPTO_SHARED_LIBS "For S2N to use shared libs in Findcrypto" OFF)
option(TSAN "Enable ThreadSanitizer to test thread safety" OFF)
option(ASAN "Enable AddressSanitizer to test memory safety" OFF)
option(SECCOMP "Link with seccomp and run seccomp tests" OFF)
file(GLOB API_HEADERS "api/*.h")
file(GLOB API_UNSTABLE_HEADERS "api/unstable/*.h")
file(GLOB CRYPTO_HEADERS "crypto/*.h")
file(GLOB CRYPTO_SRC "crypto/*.c")
file(GLOB ERROR_HEADERS "error/*.h")
file(GLOB ERROR_SRC "error/*.c")
file(GLOB STUFFER_HEADERS "stuffer/*.h")
file(GLOB STUFFER_SRC "stuffer/*.c")
file(GLOB_RECURSE TLS_HEADERS "tls/*.h")
file(GLOB_RECURSE TLS_SRC "tls/*.c")
file(GLOB UTILS_HEADERS "utils/*.h")
file(GLOB UTILS_SRC "utils/*.c")
message(STATUS "Detected CMAKE_SYSTEM_PROCESSOR as ${CMAKE_SYSTEM_PROCESSOR}")
if(CMAKE_SIZEOF_VOID_P EQUAL 4)
message(STATUS "Detected 32-Bit system")
else()
message(STATUS "Detected 64-Bit system")
endif()
##be nice to visual studio users
if(MSVC)
source_group("Header Files\\s2n\\api" FILES ${API_HEADERS} ${API_UNSTABLE_HEADERS})
source_group("Header Files\\s2n\\crypto" FILES ${CRYPTO_HEADERS})
source_group("Header Files\\s2n\\error" FILES ${ERROR_HEADERS})
source_group("Header Files\\s2n\\stuffer" FILES ${STUFFER_HEADERS})
source_group("Header Files\\s2n\\tls" FILES ${TLS_HEADERS})
source_group("Header Files\\s2n\\utils" FILES ${UTILS_HEADERS})
source_group("Source Files\\crypto" FILES ${CRYPTO_SRC})
source_group("Source Files\\error" FILES ${ERROR_SRC})
source_group("Source Files\\stuffer" FILES ${STUFFER_SRC})
source_group("Source Files\\tls" FILES ${TLS_SRC})
source_group("Source Files\\utils" FILES ${UTILS_SRC})
else()
set(THREADS_PREFER_PTHREAD_FLAG ON)
find_package(Threads REQUIRED)
endif()
if(APPLE)
set(OS_LIBS c Threads::
8000
Threads)
elseif(CMAKE_SYSTEM_NAME STREQUAL "FreeBSD")
set(OS_LIBS thr execinfo)
elseif(CMAKE_SYSTEM_NAME STREQUAL "NetBSD")
set(OS_LIBS Threads::Threads)
elseif(CMAKE_SYSTEM_NAME STREQUAL "OpenBSD")
set(OS_LIBS Threads::Threads kvm)
elseif(CMAKE_SYSTEM_NAME STREQUAL "Android")
set(OS_LIBS Threads::Threads dl)
else()
set(OS_LIBS Threads::Threads dl rt)
endif()
# Compiling the unit tests rely on S2N_TEST_IN_FIPS_MODE to be set correctly
if(S2N_FIPS)
add_definitions(-DS2N_TEST_IN_FIPS_MODE)
endif()
file(GLOB S2N_HEADERS
${API_HEADERS}
${API_UNSTABLE_HEADERS}
${CRYPTO_HEADERS}
${ERROR_HEADERS}
${STUFFER_HEADERS}
${TLS_HEADERS}
${UTILS_HEADERS}
)
file(GLOB S2N_SRC
${CRYPTO_SRC}
${ERROR_SRC}
${STUFFER_SRC}
${TLS_SRC}
${UTILS_SRC}
)
add_library(${PROJECT_NAME} ${S2N_HEADERS} ${S2N_SRC})
set_target_properties(${PROJECT_NAME} PROPERTIES LINKER_LANGUAGE C)
# Version numbers are for major updates only- we won't track minor/patch updates here.
set_target_properties(${PROJECT_NAME} PROPERTIES VERSION ${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH})
set_target_properties(${PROJECT_NAME} PROPERTIES SOVERSION ${VERSION_MAJOR})
set(CMAKE_C_FLAGS_DEBUGOPT "")
target_compile_options(${PROJECT_NAME} PRIVATE
-pedantic
-std=gnu99
-Wall
-Wcast-align
-Wchar-subscripts
-Wcomment
-Wformat-security
-Wimplicit
-Wshadow
-Wsign-compare
-Wuninitialized
-Wunused
-Wwrite-strings
# Assembler Options
-Wa,--noexecstack
# Suppressed Warnings
-Wno-deprecated-declarations
# GCC 4 fails to parse our macros with a "missing-braces" error
-Wno-missing-braces
-Wno-strict-prototypes
-Wno-unknown-pragmas
)
if (S2N_WERROR_ALL)
target_compile_options(${PROJECT_NAME} PUBLIC -Werror)
elseif (UNSAFE_TREAT_WARNINGS_AS_ERRORS)
target_compile_options(${PROJECT_NAME} PRIVATE -Werror )
endif ()
if(BUILD_TESTING AND BUILD_SHARED_LIBS OR S2N_FUZZ_TEST)
target_compile_options(${PROJECT_NAME} PRIVATE -fvisibility=default)
else()
target_compile_options(${PROJECT_NAME} PRIVATE -fvisibility=hidden -DS2N_EXPORTS)
endif()
if(S2N_LTO)
target_compile_options(${PROJECT_NAME} PRIVATE -flto)
# if we're building a static lib, make it easier for consuming applications to also perform LTO
if(NOT BUILD_SHARED_LIBS)
target_compile_options(${PROJECT_NAME} PRIVATE -ffunction-sections -fdata-sections)
endif()
endif()
if(NOT APPLE)
set(CMAKE_SHARED_LINKER_FLAGS -Wl,-z,noexecstack,-z,relro,-z,now)
endif()
# Whether to fail the build when compiling s2n's portable C code with non-portable assembly optimizations. Doing this
# can lead to runtime crashes if build artifacts are built on modern hardware, but deployed to older hardware without
# newer CPU instructions. s2n, by default, should be backwards compatible with older CPU types so this flag should be
# enabled in s2n's CI builds and tests, but other consumers of s2n may have stronger control of what CPU types they
# deploy to, and can enable more CPU optimizations.
if(S2N_BLOCK_NONPORTABLE_OPTIMIZATIONS)
target_compile_options(${PROJECT_NAME} PUBLIC -DS2N_BLOCK_NONPORTABLE_OPTIMIZATIONS=1)
endif()
target_compile_options(${PROJECT_NAME} PUBLIC -fPIC)
set(S2N_PRELUDE "${CMAKE_CURRENT_LIST_DIR}/utils/s2n_prelude.h")
target_compile_options(${PROJECT_NAME} PRIVATE -include "${S2N_PRELUDE}")
# Match on Release, RelWithDebInfo and MinSizeRel
# See: https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html#variable:CMAKE_BUILD_TYPE
if(CMAKE_BUILD_TYPE MATCHES Rel)
add_definitions(-DS2N_BUILD_RELEASE)
endif()
if(NO_STACK_PROTECTOR)
target_compile_options(${PROJECT_NAME} PRIVATE -Wstack-protector -fstack-protector-all)
endif()
if(S2N_FUZZ_TEST)
target_compile_definitions(${PROJECT_NAME} PUBLIC S2N_FUZZ_TESTING=1)
target_compile_options(${PROJECT_NAME} PUBLIC -fsanitize=fuzzer-no-link,leak,address,undefined)
target_link_libraries(${PROJECT_NAME} PUBLIC -fsanitize=fuzzer-no-link,leak,address,undefined)
endif()
if(TSAN)
target_compile_options(${PROJECT_NAME} PUBLIC -fsanitize=thread -DS2N_THREAD_SANITIZER=1)
target_link_options(${PROJECT_NAME} PUBLIC -fsanitize=thread)
endif()
if(ASAN)
target_compile_options(${PROJECT_NAME} PUBLIC -fsanitize=address -DS2N_ADDRESS_SANITIZER=1)
target_link_options(${PROJECT_NAME} PUBLIC -fsanitize=address)
endif()
if (UBSAN)
target_compile_options(${PROJECT_NAME} PUBLIC -fsanitize=undefined -fno-sanitize-recover=all)
target_link_options(${PROJECT_NAME} PUBLIC -fsanitize=undefined -fno-sanitize-recover=all)
endif()
if(TSAN OR ASAN OR UBSAN)
# no-omit-frame-pointer and no-optimize-sibling-calls provide better stack traces
target_compile_options(${PROJECT_NAME} PUBLIC -fno-omit-frame-pointer -fno-optimize-sibling-calls)
endif()
list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules")
if (NOT $ENV{S2N_LIBCRYPTO} MATCHES "awslc")
# add cast-qual back in for non AWS-LC
target_compile_options(${PROJECT_NAME} PRIVATE -Wcast-qual)
endif()
if (COVERAGE)
# https://cmake.org/cmake/help/latest/variable/CMAKE_LANG_COMPILER_ID.html
# Coverage is done using LLVM source based coverage. This is only supported
# on LLVM compilers. GCC would fail with "unrecognized compile options"
# on -fprofile-instr-generate -fcoverage-mapping flags.
if (NOT ${CMAKE_C_COMPILER_ID} MATCHES Clang)
message(FATAL_ERROR "This project requires clang for coverage support")
endif()
target_compile_options(${PROJECT_NAME} PUBLIC -fprofile-instr-generate -fcoverage-mapping)
target_link_options(${PROJECT_NAME} PUBLIC -fprofile-instr-generate -fcoverage-mapping)
endif()
# For interning, we need to find the static libcrypto library. Cmake configs
# can branch on the variable BUILD_SHARED_LIBS to e.g. avoid having to define
# multiple targets. An example is AWS-LC:
# https://github.com/awslabs/aws-lc/blob/main/crypto/cmake/crypto-config.cmake#L5
if (S2N_INTERN_LIBCRYPTO)
set(BUILD_SHARED_LIBS_BACKUP ${BUILD_SHARED_LIBS})
set(BUILD_SHARED_LIBS OFF)
endif()
# Work around target differences
if (TARGET crypto)
message(STATUS "S2N found target: crypto")
set(LINK_LIB "crypto")
else()
find_package(crypto REQUIRED)
message(STATUS "Using libcrypto from the cmake path")
set(LINK_LIB "AWS::crypto")
endif()
if (S2N_INTERN_LIBCRYPTO)
# Restore the old BUILD_SHARED_LIBS value
set(BUILD_SHARED_LIBS ${BUILD_SHARED_LIBS_BACKUP})
message(STATUS "Enabling libcrypto interning")
endif()
if (NOT DEFINED CMAKE_AR)
message(STATUS "CMAKE_AR undefined, setting to `ar` by default")
SET(CMAKE_AR ar)
else()
message(STATUS "CMAKE_AR found: ${CMAKE_AR}")
endif()
if (NOT DEFINED CMAKE_RANLIB)
message(STATUS "CMAKE_RANLIB undefined, setting to `ranlib` by default")
SET(CMAKE_RANLIB ranlib)
else()
message(STATUS "CMAKE_RANLIB found: ${CMAKE_RANLIB}")
endif()
if (NOT DEFINED CMAKE_OBJCOPY)
message(STATUS "CMAKE_OBJCOPY undefined, setting to `objcopy` by default")
SET(CMAKE_OBJCOPY objcopy)
else()
message(STATUS "CMAKE_OBJCOPY found: ${CMAKE_OBJCOPY}")
endif()
# Sets the result of the feature probe to `IS_AVAILABLE`
function(feature_probe_result PROBE_NAME IS_AVAILABLE)
# normalize the boolean value
if(IS_AVAILABLE)
set(NORMALIZED TRUE)
else()
set(NORMALIZED FALSE)
endif()
# indicate the status of the probe
message(STATUS "feature ${PROBE_NAME}: ${NORMALIZED}")
# set the probe result in the parent scope for other probes
set(${PROBE_NAME} ${NORMALIZED} PARENT_SCOPE)
# define the probe if available
if(NORMALIZED)
add_definitions(-D${PROBE_NAME})
endif()
endfunction()
# Tries to compile a feature probe and initializes the corresponding flags
function(feature_probe PROBE_NAME)
# Load the global probe flags
file(READ "${CMAKE_CURRENT_LIST_DIR}/tests/features/GLOBAL.flags" GLOBAL_FILE)
string(REPLACE "\n" "" GLOBAL_FLAGS "${GLOBAL_FILE}")
# Load the probe's flags
file(READ "${CMAKE_CURRENT_LIST_DIR}/tests/features/${PROBE_NAME}.flags" PROBE_FILE)
string(REPLACE "\n" "" PROBE_FLAGS "${PROBE_FILE}")
# Try to compile the probe with the given flags
try_compile(
IS_AVAILABLE
${CMAKE_BINARY_DIR}
SOURCES "${CMAKE_CURRENT_LIST_DIR}/tests/features/${PROBE_NAME}.c"
LINK_LIBRARIES ${LINK_LIB} ${OS_LIBS}
CMAKE_FLAGS ${ADDITIONAL_FLAGS}
COMPILE_DEFINITIONS -I "${CMAKE_CURRENT_LIST_DIR}" -include "${CMAKE_CURRENT_LIST_DIR}/utils/s2n_prelude.h" -c ${GLOBAL_FLAGS} ${PROBE_FLAGS}
${ARGN}
OUTPUT_VARIABLE TRY_COMPILE_OUTPUT
)
# Uncomment the line below to get the output of the try_compile command
#message(STATUS "Output of try_compile: ${TRY_COMPILE_OUTPUT}")
# Set the result of the probe
feature_probe_result(${PROBE_NAME} ${IS_AVAILABLE})
# Make sure the variable is set in the parent scope
set(${PROBE_NAME} ${IS_AVAILABLE} PARENT_SCOPE)
# Set the flags that we used for the probe
set(${PROBE_NAME}_FLAGS ${PROBE_FLAGS} PARENT_SCOPE)
endfunction()
# Iterate over all of the features and try to compile them
FILE(GLOB FEATURE_SRCS "${CMAKE_CURRENT_LIST_DIR}/tests/features/*.c")
list(SORT FEATURE_SRCS)
foreach(file ${FEATURE_SRCS})
get_filename_component(feature_name ${file} NAME_WE)
feature_probe(${feature_name})
endforeach()
# FreeBSD might need to link to execinfo explicitly
if(NOT S2N_EXECINFO_AVAILABLE AND CMAKE_SYSTEM_NAME STREQUAL "FreeBSD")
feature_probe(S2N_EXECINFO_AVAILABLE LINK_LIBRARIES execinfo)
endif()
# Stack traces are only available if execinfo is
if (NOT S2N_EXECINFO_AVAILABLE)
set(S2N_STACKTRACE FALSE)
endif()
feature_probe_result(S2N_STACKTRACE ${S2N_STACKTRACE})
if (S2N_INTERN_LIBCRYPTO)
# Check if the AWS::crypto target has beeen added and handle it
if (TARGET AWS::crypto)
# Get the target library type (shared or static)
get_target_property(target_type AWS::crypto TYPE)
message(STATUS "AWS::crypto target type: ${target_type}")
# If we didn't find the a target with static library type, fallback to
# existing crypto_STATIC_LIBRARY and crypto_INCLUDE_DIR
if (target_type STREQUAL STATIC_LIBRARY)
# We need an path to the include directory and libcrypto.a archive.
# The finder module defines these appropriately, but if we go through
# the target config we need to query this information from the target
# first.
get_target_property(crypto_STATIC_LIBRARY AWS::crypto LOCATION)
get_target_property(crypto_INCLUDE_DIR AWS::crypto INTERFACE_INCLUDE_DIRECTORIES)
endif()
endif()
if (NOT crypto_STATIC_LIBRARY)
message(FATAL_ERROR "libcrypto interning requires a static build of libcrypto.a to be available")
endif()
message(STATUS "crypto_STATIC_LIBRARY: ${crypto_STATIC_LIBRARY}")
message(STATUS "crypto_INCLUDE_DIR: ${crypto_INCLUDE_DIR}")
# Don't call link_target_libraries here, just make sure the libcrypto include dir is in the path
include_directories("${crypto_INCLUDE_DIR}")
add_custom_command(
OUTPUT libcrypto.symbols
COMMAND
# copy the static version of libcrypto
cp ${crypto_STATIC_LIBRARY} s2n_libcrypto.a &&
# dump all of the symbols and prefix them with `s2n$`
bash -c "${CMAKE_NM} s2n_libcrypto.a | awk '/ [A-Z] /{print $3\" s2n$\"$3}' | sort | uniq > libcrypto.symbols" &&
# redefine the libcrypto libary symbols
${CMAKE_OBJCOPY} --redefine-syms libcrypto.symbols s2n_libcrypto.a &&
rm -rf s2n_libcrypto &&
mkdir s2n_libcrypto &&
cd s2n_libcrypto &&
# extract libcrypto objects from the archive
${CMAKE_AR} x ../s2n_libcrypto.a &&
# rename all of the object files so we don't have any object name collisions
bash -c "find . -name '*.o' -type f -print0 | xargs -0 -n1 -- basename | xargs -I{} mv {} s2n_crypto__{}"
VERBATIM
)
add_custom_target(s2n_libcrypto ALL
DEPENDS libcrypto.symbols
)
add_dependencies(${PROJECT_NAME} s2n_libcrypto)
add_definitions(-DS2N_INTERN_LIBCRYPTO)
if ((BUILD_SHARED_LIBS AND BUILD_TESTING) OR NOT BUILD_SHARED_LIBS)
# if libcrypto needs to be interned, rewrite libcrypto references so use of internal functions will link correctly
add_custom_command(
TARGET ${PROJECT_NAME} PRE_LINK
COMMAND
find "${CMAKE_CURRENT_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/${PROJECT_NAME}.dir" -name '*.c.o' -exec objcopy --redefine-syms libcrypto.symbols {} \\\;
)
endif()
# copy the static libcrypto into the final artifact
if (BUILD_SHARED_LIBS)
if (BUILD_TESTING)
# if we're building tests, we export the prefixed symbols so tests can link to them
set_target_properties(${PROJECT_NAME} PROPERTIES LINK_FLAGS
"-Wl,--whole-archive s2n_libcrypto.a -Wl,--no-whole-archive")
else()
# if we're not building tests, then just copy the original archive, unmodified
set_target_properties(${PROJECT_NAME} PROPERTIES LINK_FLAGS
"-Wl,--whole-archive ${crypto_STATIC_LIBRARY} -Wl,--no-whole-archive -Wl,--exclude-libs=ALL")
endif()
else()
# add all of the prefixed symbols to the archive
add_custom_command(
TARGET ${PROJECT_NAME} POST_BUILD
DEPENDS libcrypto.symbols
COMMAND
bash -c "${CMAKE_AR} -r lib/libs2n.a s2n_libcrypto/*.o"
VERBATIM
)
endif()
else()
# LINK_LIB is set above after checking targets. It handles the find_package craziness.
target_link_libraries(${PROJECT_NAME} PUBLIC ${LINK_LIB})
endif()
target_link_libraries(${PROJECT_NAME} PUBLIC ${OS_LIBS} m)
target_include_directories(${PROJECT_NAME} PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}>)
target_include_directories(${PROJECT_NAME} PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/api> $<INSTALL_INTERFACE:include>)
if (BUILD_TESTING)
enable_testing()
############################################################################
################### build testlib (utility library) ########################
############################################################################
file(GLOB TESTLIB_SRC "tests/testlib/*.c")
file(GLOB EXAMPLES_SRC "docs/examples/*.c")
add_library(testss2n STATIC ${TESTLIB_SRC} ${EXAMPLES_SRC})
target_include_directories(testss2n PUBLIC tests)
target_compile_options(testss2n PRIVATE -std=gnu99)
# make sure all linked tests include the prelude
target_compile_options(testss2n PUBLIC -include "${S2N_PRELUDE}")
target_link_libraries(testss2n PUBLIC ${PROJECT_NAME})
if (SECCOMP)
message(STATUS "Linking tests with seccomp")
target_link_libraries(testss2n PRIVATE seccomp)
target_compile_definitions(testss2n PRIVATE SECCOMP)
endif()
if (S2N_INTERN_LIBCRYPTO)
# if libcrypto was interned, rewrite libcrypto symbols so use of internal
# functions will link correctly
add_custom_command(
TARGET testss2n POST_BUILD
COMMAND
objcopy --redefine-syms libcrypto.symbols lib/libtestss2n.a
)
endif()
############################################################################
########################## configure unit tests ############################
############################################################################
# CTest configuration variables need to be set before include(CTest) is called
set(VALGRIND_DEFAULT " \
--leak-check=full \
--leak-resolution=high \
--trace-children=yes \
-q --error-exitcode=123 \
--error-limit=no \
--num-callers=40 \
--undef-value-errors=no \
--track-fds=yes \
--log-fd=2 \
--suppressions=valgrind.suppressions")
# "pedantic valgrind" will error on memory that is "Still Reachable".
# We only run this on OpenSSL 1.1.1 because there are hundreds of false positives in other libcryptos.
# Tracking issue: https://github.com/aws/s2n-tls/issues/4777
if ($ENV{S2N_LIBCRYPTO} MATCHES "openssl-1.1.1")
set(MEMORYCHECK_COMMAND_OPTIONS "${VALGRIND_DEFAULT} --run-libc-freeres=yes --errors-for-leak-kinds=all --show-leak-kinds=all")
else()
set(MEMORYCHECK_COMMAND_OPTIONS "${VALGRIND_DEFAULT} --run-libc-freeres=no")
endif()
set(MEMORYCHECK_TYPE "Valgrind")
set(UNIT_TEST_ENVS S2N_DONT_MLOCK=1)
if (TSAN OR ASAN)
set(UNIT_TEST_ENVS ${UNIT_TEST_ENVS} S2N_ADDRESS_SANITIZER=1)
endif()
if(TSAN)
set(TSAN_SUPPRESSIONS_FILE ${CMAKE_SOURCE_DIR}/tests/.tsan_suppressions)
if(NOT EXISTS ${TSAN_SUPPRESSIONS_FILE})
message(FATAL_ERROR "TSAN suppression file ${TSAN_SUPPRESSIONS_FILE} missing")
endif()
set(TSAN_OPTIONS suppressions=${TSAN_SUPPRESSIONS_FILE})
if(DEFINED ENV{TSAN_OPTIONS})
set(TSAN_OPTIONS "${TSAN_OPTIONS} $ENV{TSAN_OPTIONS}")
endif()
set(UNIT_TEST_ENVS ${UNIT_TEST_ENVS} TSAN_OPTIONS=${TSAN_OPTIONS})
endif()
if(ASAN)
# "detect_odr_violation" detects violations of the "one definition rule",
# ensuring that symbols are only defined once.
# But some of our unit tests intentionally include *.c files for testing,
# resulting in duplicate global values.
set(ASAN_OPTIONS detect_odr_violation=0)
if(DEFINED ENV{ASAN_OPTIONS})
set(ASAN_OPTIONS "${ASAN_OPTIONS} $ENV{ASAN_OPTIONS}")
endif()
set(UNIT_TEST_ENVS ${UNIT_TEST_ENVS} ASAN_OPTIONS=${ASAN_OPTIONS})
endif()
message(STATUS "Running tests with environment: ${UNIT_TEST_ENVS}")
include(CTest)
############################################################################
############################ build unit tests ##############################
############################################################################
file(GLOB UNITTESTS_SRC "tests/unit/*.c")
foreach(test_case ${UNITTESTS_SRC})
# NAME_WE: name without extension
get_filename_component(test_case_name ${test_case} NAME_WE)
add_executable(${test_case_name} ${test_case})
target_link_libraries(${test_case_name} PRIVATE testss2n)
if (S2N_INTERN_LIBCRYPTO)
# if libcrypto was interned, rewrite libcrypto symbols so use of internal functions will link correctly
add_custom_command(
TARGET ${test_case_name} PRE_LINK
COMMAND
find . -name '${test_case_name}.c.o' -exec objcopy --redefine-syms libcrypto.symbols {} \\\;
)
endif()
target_compile_options(${test_case_name} PRIVATE
-Wall -Wimplicit -Wunused -Wcomment -Wchar-subscripts -Wuninitialized
-Wshadow -Wcast-align -Wwrite-strings -Wformat-security
-Wno-deprecated-declarations -Wno-unknown-pragmas -Wno-deprecated -std=gnu99
)
if (S2N_LTO)
target_compile_options(${test_case_name} PRIVATE -flto)
endif()
add_test(
NAME ${test_case_name}
COMMAND $<TARGET_FILE:${test_case_name}>
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/tests/unit
)
set_property(TEST ${test_case_name} PROPERTY LABELS "unit")
set_property(TEST ${test_case_name} PROPERTY ENVIRONMENT ${UNIT_TEST_ENVS})
endforeach(test_case)
############################################################################
######################### build utility binaries ###########################
############################################################################
add_executable(s2nc "bin/s2nc.c" "bin/echo.c" "bin/https.c" "bin/common.c")
target_link_libraries(s2nc ${PROJECT_NAME})
target_compile_options(s2nc PRIVATE -std=gnu99)
add_executable(s2nd "bin/s2nd.c" "bin/echo.c" "bin/https.c" "bin/common.c")
target_link_libraries(s2nd ${PROJECT_NAME})
target_compile_options(s2nd PRIVATE -std=gnu99)
add_executable(policy "bin/policy.c")
target_link_libraries(policy ${PROJECT_NAME})
target_compile_options(policy PRIVATE -std=gnu99)
if(S2N_LTO)
target_compile_options(s2nc PRIVATE -flto)
target_compile_options(s2nd PRIVATE -flto)
endif()
if (S2N_INTEG_TESTS)
find_package (Python3 COMPONENTS Interpreter Development)
file(GLOB integv2_test_files "${PROJECT_SOURCE_DIR}/tests/integrationv2/test_*.py")
set(N 1)
if (S2N_FAST_INTEG_TESTS)
set(N auto)
endif()
foreach(test_file_path ${integv2_test_files})
get_filename_component(test_filename ${test_file_path} NAME_WE)
string(REGEX REPLACE "^test_" "integrationv2_" test_target ${test_filename})
if (S2N_INTEG_NIX)
# For Nix and environments where LD_LIBRARY_PATH is already correct.
# We're also dropping tox and calling pytest directly, because
# Nix is already handling all of the python setup.
if (CMAKE_SYSTEM_PROCESSOR STREQUAL "aarch64" AND ${test_target} STREQUAL "integrationv2_sslyze" )
# sslyze/nassl is not available on aarch64.
message(WARNING "Skipping ${test_target} due to missing tools on ${CMAKE_SYSTEM_PROCESSOR}")
continue()
endif()
message(STATUS "Adding integ test ${test_target}")
add_test(NAME ${test_target}
COMMAND
pytest
-x -n=${N} --reruns=2 --durations=10 --cache-clear -rpfsq
-o log_cli=true --log-cli-level=DEBUG --provider-version=$ENV{S2N_LIBCRYPTO}
--fips-mode=0 ${test_file_path}
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/tests/integrationv2
)
else()
# For use with libcryptos built into test-deps, and not in LD_LIBRARY_PATH.
# This is a duplication of tests/integrationv2/Makefile and
# can go away once all the Nix porting is finished.
add_test(NAME ${test_target}
COMMAND
${CMAKE_COMMAND} -E env
DYLD_LIBRARY_PATH=${PROJECT_SOURCE_DIR}/libcrypto-root/lib:$ENV{DYLD_LIBRARY_PATH}
LD_LIBRARY_PATH=${PROJECT_SOURCE_DIR}/libcrypto-root/lib:${PROJECT_SOURCE_DIR}/test-deps/openssl-1.1.1/lib:${PROJECT_SOURCE_DIR}/test-deps/gnutls37/nettle/lib:$ENV{LD_LIBRARY_PATH}
PATH=${PROJECT_SOURCE_DIR}/bin:${PROJECT_SOURCE_DIR}/test-deps/openssl-1.1.1/bin:${PROJECT_SOURCE_DIR}/test-deps/gnutls37/bin:$ENV{PATH}
PYTHONNOUSERSITE=1
S2N_INTEG_TEST=1
TOX_TEST_NAME=${test_file_path}
${Python3_EXECUTABLE} -m tox
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/tests/integrationv2)
endif()
set_property(TEST ${test_target} PROPERTY LABELS "integrationv2")
set_property(TEST ${test_target} PROPERTY TIMEOUT 7200)
endforeach()
endif()
if(S2N_FUZZ_TEST)
message(STATUS "Fuzz build enabled")
set(SCRIPT_PATH "${CMAKE_CURRENT_SOURCE_DIR}/tests/fuzz/runFuzzTest.sh")
set(BUILD_DIR_PATH "${CMAKE_CURRENT_SOURCE_DIR}/build")
file(GLOB FUZZ_TEST_SRCS "${CMAKE_CURRENT_SOURCE_DIR}/tests/fuzz/*.c")
file(GLOB TESTLIB_SRC "tests/testlib/*.c")
file(GLOB TESTLIB_HEADERS "tests/testlib/*.h" "tests/s2n_test.h")
# This must be a shared object so that symbols can be overridden by the
# fuzz test specific LD_PRELOAD libraries.
add_library(fuzztest SHARED ${TESTLIB_SRC})
target_include_directories(fuzztest PUBLIC tests)
target_link_libraries(fuzztest PUBLIC ${PROJECT_NAME})
# Set default values for fuzzing if not defined
if(NOT DEFINED FUZZ_TIMEOUT_SEC)
set(FUZZ_TIMEOUT_SEC 60)
endif()
if(DEFINED ENV{CORPUS_UPLOAD_LOC})
set(CORPUS_UPLOAD_LOC $ENV{CORPUS_UPLOAD_LOC})
else()
set(CORPUS_UPLOAD_LOC "none")
endif()
if(DEFINED ENV{ARTIFACT_UPLOAD_LOC})
set(ARTIFACT_UPLOAD_LOC $ENV{ARTIFACT_UPLOAD_LOC})
else()
set(ARTIFACT_UPLOAD_LOC "none")
endif()
# Build LD_PRELOAD shared libraries
file(GLOB LIBRARY_SRCS "${CMAKE_CURRENT_SOURCE_DIR}/tests/fuzz/LD_PRELOAD/*.c")
foreach(SRC ${LIBRARY_SRCS})
get_filename_component(LIB_NAME ${SRC} NAME_WE)
add_library(${LIB_NAME} SHARED ${SRC})
target_include_directories(${LIB_NAME} PRIVATE
${CMAKE_CURRENT_SOURCE_DIR}
${CMAKE_CURRENT_SOURCE_DIR}/api
)
endforeach()
set(CMAKE_C_COMPILER clang)
foreach(src ${FUZZ_TEST_SRCS})
get_filename_component(TEST_NAME ${src} NAME_WE)
add_executable(${TEST_NAME} ${src})
target_compile_options(${TEST_NAME} PRIVATE
-g -Wno-unknown-pragmas -Wno-unused-result
)
target_link_options(${TEST_NAME} PRIVATE
-fsanitize=fuzzer -lstdc++
)
target_link_libraries(${TEST_NAME} PRIVATE
fuzztest
)
add_test(NAME ${TEST_NAME}
COMMAND ${CMAKE_COMMAND} -E env
bash ${SCRIPT_PATH}
${TEST_NAME}
${FUZZ_TIMEOUT_SEC}
${BUILD_DIR_PATH}
${CORPUS_UPLOAD_LOC}
${ARTIFACT_UPLOAD_LOC}
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/tests/fuzz
)
set_property(TEST ${TEST_NAME} PROPERTY LABELS "fuzz")
endforeach()
endif()
endif()
#install the s2n files
install(FILES ${API_HEADERS} DESTINATION "include/" COMPONENT Development)
install(FILES ${API_UNSTABLE_HEADERS} DESTINATION "include/s2n/unstable" COMPONENT Development)
if (UNIX AND NOT APPLE)
include(GNUInstallDirs)
elseif(NOT DEFINED CMAKE_INSTALL_LIBDIR)
set(CMAKE_INSTALL_LIBDIR "lib")
endif()
if (S2N_INSTALL_S2NC_S2ND)
install(
TARGETS s2nc s2nd RUNTIME DESTINATION bin
)
endif()
install(
TARGETS ${PROJECT_NAME}
EXPORT ${PROJECT_NAME}-targets
ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} COMPONENT Development
LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} COMPONENT Runtime
RUNTIME DESTINATION bin COMPONENT Runtime
)
configure_file("cmake/${PROJECT_NAME}-config.cmake"
"${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config.cmake"
@ONLY)
if (BUILD_SHARED_LIBS)
set (TARGET_DIR "shared")
else()
set (TARGET_DIR "static")
endif()
install(EXPORT "${PROJECT_NAME}-targets"
DESTINATION "${CMAKE_INSTALL_LIBDIR}/${PROJECT_NAME}/cmake/${TARGET_DIR}"
NAMESPACE AWS::
COMPONENT Development)
install(FILES "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config.cmake"
DESTINATION "${CMAKE_INSTALL_LIBDIR}/${PROJECT_NAME}/cmake/"
COMPONENT Development)
install(FILES "cmake/modules/Findcrypto.cmake"
DESTINATION "${CMAKE_INSTALL_LIBDIR}/${PROJECT_NAME}/cmake/modules/"
COMPONENT Development)