Repository navigation
Expand file tree
/
Copy pathCMakeLists.txt
More file actions
832 lines (754 loc) · 32.6 KB
/
Copy pathCMakeLists.txt
File metadata and controls
832 lines (754 loc) · 32.6 KB
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
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
cmake_minimum_required(VERSION 3.14)
project(OpenCryptUI LANGUAGES CXX)
# Enable position-independent code globally
set(CMAKE_POSITION_INDEPENDENT_CODE ON)
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fPIC")
# Check for CI environment
if(DEFINED ENV{CI} OR DEFINED ENV{GITHUB_ACTIONS} OR DEFINED ENV{GITLAB_CI} OR DEFINED ENV{TRAVIS})
message(STATUS "Building in CI environment - disabling logs")
add_definitions(-DQT_CI_BUILD)
# Disable Qt debug/warning messages in CI
add_definitions(-DQT_NO_DEBUG_OUTPUT)
add_definitions(-DQT_NO_WARNING_OUTPUT)
endif()
set(CMAKE_INCLUDE_CURRENT_DIR ON)
set(CMAKE_AUTOUIC ON)
set(CMAKE_AUTOMOC ON)
set(CMAKE_AUTORCC ON)
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
# ---------------------------------------------------------------------------
# Compiler / linker hardening flags.
#
# We feature-detect each flag so gcc/clang/MinGW/AppleClang are all happy.
# Flags are collected into ENGINE_HARDENING_CFLAGS / ENGINE_HARDENING_LFLAGS
# and applied to our own targets below (NOT globally — we don't want to
# break Qt/Sodium/OpenSSL transitively). For the final STATUS summary we
# also collect enabled flags into ENGINE_HARDENING_SUMMARY.
#
# Applies to: EncryptionLib, OpenCryptUI, OpenCryptUITest, TestRoundtrip,
# and every TestEngine* / TestBenchmark target created via the
# add_engine_test() helper later in this file.
#
# Target profile:
# - Stack overflow / smash: -fstack-protector-strong, -fstack-clash-protection
# - FORTIFY source (libc): -D_FORTIFY_SOURCE=2 (only active at -O2+)
# - CFI via Intel CET on x86-64: -fcf-protection=full (no-op on non-x86)
# - Format-string auditing: -Wformat -Wformat-security -Werror=format-security
# - Linker: RELRO + BIND_NOW + noexecstack (ELF only), -pie (ELF only)
# ---------------------------------------------------------------------------
include(CheckCXXCompilerFlag)
set(ENGINE_HARDENING_CFLAGS "")
set(ENGINE_HARDENING_LFLAGS "")
set(ENGINE_HARDENING_SUMMARY "")
function(_try_add_cflag flag var_name)
string(MAKE_C_IDENTIFIER "has${flag}" _sym)
# Apple Clang silently accepts many GCC-only flags (e.g.
# -fstack-clash-protection) and emits "argument unused during
# compilation" once per translation unit. Forcing
# -Werror=unused-command-line-argument during the probe makes those
# cases fail the check so we don't add a no-op-with-warning flag.
#
# Only do this on Clang — gcc doesn't recognise that diagnostic
# name, so passing -Werror=unused-command-line-argument to gcc
# causes every probe to fail.
if(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
set(CMAKE_REQUIRED_FLAGS "-Werror=unused-command-line-argument")
endif()
check_cxx_compiler_flag("${flag}" ${_sym})
unset(CMAKE_REQUIRED_FLAGS)
if(${_sym})
list(APPEND ENGINE_HARDENING_CFLAGS "${flag}")
list(APPEND ENGINE_HARDENING_SUMMARY "${flag}")
set(ENGINE_HARDENING_CFLAGS "${ENGINE_HARDENING_CFLAGS}" PARENT_SCOPE)
set(ENGINE_HARDENING_SUMMARY "${ENGINE_HARDENING_SUMMARY}" PARENT_SCOPE)
endif()
endfunction()
# Compile-time flags. FORTIFY_SOURCE only makes sense at -O2+; set it via
# a generator expression so Debug builds don't warn about "requires optimization".
_try_add_cflag("-fstack-protector-strong" stackprot_strong)
_try_add_cflag("-fstack-clash-protection" stackclash)
_try_add_cflag("-fcf-protection=full" cfprot)
_try_add_cflag("-Wformat" wformat)
_try_add_cflag("-Wformat-security" wformat_sec)
_try_add_cflag("-Werror=format-security" werr_format_sec)
# FORTIFY_SOURCE needs optimization; attach it to Release-like configs only.
# Use -D form so it reaches the preprocessor explicitly.
set(ENGINE_HARDENING_FORTIFY
"$<$<CONFIG:Release>:-D_FORTIFY_SOURCE=2>"
"$<$<CONFIG:RelWithDebInfo>:-D_FORTIFY_SOURCE=2>"
"$<$<CONFIG:MinSizeRel>:-D_FORTIFY_SOURCE=2>"
)
list(APPEND ENGINE_HARDENING_SUMMARY "-D_FORTIFY_SOURCE=2 (Release configs)")
# Linker flags: ELF-only. Skip on macOS (ld64 doesn't accept these) and
# skip if the compile-flag probe above failed to find a C++ compiler.
if(NOT APPLE AND NOT MSVC)
set(_linker_candidates
"-Wl,-z,relro"
"-Wl,-z,now"
"-Wl,-z,noexecstack"
)
foreach(_lflag IN LISTS _linker_candidates)
# Probe by trying to compile+link a trivial program. CMake's
# check_linker_flag is 3.18+; support older via try_compile probe.
set(_tmp_src "${CMAKE_BINARY_DIR}/_hardening_probe.cpp")
file(WRITE "${_tmp_src}" "int main(){return 0;}\n")
try_compile(_ok "${CMAKE_BINARY_DIR}/_hardening_try" "${_tmp_src}"
LINK_OPTIONS "${_lflag}"
OUTPUT_VARIABLE _out)
if(_ok)
list(APPEND ENGINE_HARDENING_LFLAGS "${_lflag}")
list(APPEND ENGINE_HARDENING_SUMMARY "${_lflag}")
endif()
endforeach()
endif()
# ---------------------------------------------------------------------------
# Find Qt packages
find_package(Qt5 COMPONENTS Core Gui Widgets Test REQUIRED)
# OpenSSL configuration
if(WIN32)
set(OPENSSL_USE_STATIC_LIBS TRUE)
set(OPENSSL_MSVC_STATIC_RT TRUE)
set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded") # Static runtime
set(CMAKE_FIND_LIBRARY_SUFFIXES ".a") # Force static libraries
endif()
# Find OpenSSL package
find_package(OpenSSL REQUIRED)
# Find Argon2 and Sodium (Scrypt) packages
if (CMAKE_SYSTEM_NAME STREQUAL "Linux")
find_package(PkgConfig REQUIRED)
pkg_search_module(ARGON2 REQUIRED libargon2)
pkg_search_module(SODIUM REQUIRED libsodium)
elseif (CMAKE_SYSTEM_NAME STREQUAL "Darwin")
set(ARGON2_LIB_DIR $ENV{ARGON2_LIB_DIR})
set(ARGON2_INCLUDE_DIR $ENV{ARGON2_INCLUDE_DIR})
set(SODIUM_LIB_DIR $ENV{SODIUM_LIB_DIR})
set(SODIUM_INCLUDE_DIR $ENV{SODIUM_INCLUDE_DIR})
set(OPENSSL_ROOT_DIR $ENV{OPENSSL_ROOT_DIR})
set(OPENSSL_INCLUDE_DIR $ENV{OPENSSL_INCLUDE_DIR})
set(OPENSSL_LIBRARIES $ENV{OPENSSL_LIBRARIES})
link_directories(${ARGON2_LIB_DIR} ${SODIUM_LIB_DIR})
# macOS frameworks. Security for keychain/SE/CryptoKit hooks (used by
# hwkey_macos.cpp); CoreFoundation for the CF* types Security drags in
# (CFDictionary, CFRelease, kCFAllocatorDefault — these are NOT in
# Security itself, contrary to many docs).
find_library(SECURITY_FRAMEWORK Security REQUIRED)
find_library(COREFOUNDATION_FRAMEWORK CoreFoundation REQUIRED)
elseif (CMAKE_SYSTEM_NAME STREQUAL "Windows")
set(ARGON2_LIB_DIR $ENV{ARGON2_LIB_DIR})
set(ARGON2_INCLUDE_DIR $ENV{ARGON2_INCLUDE_DIR})
set(SODIUM_LIB_DIR $ENV{SODIUM_LIB_DIR})
set(SODIUM_INCLUDE_DIR $ENV{SODIUM_INCLUDE_DIR})
link_directories(${ARGON2_LIB_DIR} ${SODIUM_LIB_DIR})
endif()
# Add this line to set the UI file directory
set(CMAKE_AUTOUIC_SEARCH_PATHS ${CMAKE_CURRENT_SOURCE_DIR}/ui)
# Add the resources file
qt5_add_resources(RESOURCES resources/resources.qrc)
# Library sources
set(LIBRARY_SOURCES
src/mainwindow.cpp
src/mainwindow_menu.cpp
src/mainwindow_preferences.cpp
src/mainwindow_fileops.cpp
src/mainwindow_container.cpp
src/mainwindow_easymode.cpp
include/mainwindow.h
src/mainwindow_disk.cpp
src/encryptionengine_init.cpp
src/encryptionengine_fileops.cpp
src/encryptionengine_keyderivation.cpp
src/encryptionengine_keyfile.cpp
src/encryptionengine_crypto.cpp
src/encryptionengine_chunks.cpp
src/encryptionengine_tables.cpp
src/encryptionengine_disk.cpp
src/encryptionengine_diskops.cpp
src/encryptionengine_diskops_header.cpp
src/encryptionengine_tamperevidence.cpp
src/encryptionengine_securewipe.cpp
include/encryptionengine.h
include/encryptionengine_diskops.h
src/encryptionworker.cpp
include/encryptionworker.h
src/customlistwidget.cpp
include/customlistwidget.h
src/logging/secure_logger.cpp
include/logging/secure_logger.h
src/secure_string.cpp
include/secure_string.h
src/deniable_container.cpp
include/deniable_container.h
src/block_volume.cpp
src/block_device_io.cpp
include/block_volume.h
src/vault_mount.cpp
include/vault_mount.h
src/shamir.cpp
include/shamir.h
src/hwkey_stub.cpp
src/hwkey_linux.cpp
src/hwkey_macos.cpp
src/hwkey_windows.cpp
include/hwkey.h
src/pq_hybrid.cpp
src/pq_hybrid_stub.cpp
include/pq_hybrid.h
include/cryptoprovider.h
src/opensslprovider.cpp
src/opensslprovider_standard.cpp
src/opensslprovider_aead.cpp
src/libsodiumprovider.cpp
src/argon2provider.cpp
ui/mainwindow.ui
${RESOURCES}
${CMAKE_CURRENT_BINARY_DIR}/version.h
)
# Create a library target for common code
add_library(EncryptionLib STATIC ${LIBRARY_SOURCES})
set_target_properties(EncryptionLib PROPERTIES POSITION_INDEPENDENT_CODE ON)
target_compile_options(EncryptionLib PRIVATE -fPIC
${ENGINE_HARDENING_CFLAGS}
${ENGINE_HARDENING_FORTIFY}
)
target_link_options(EncryptionLib PRIVATE ${ENGINE_HARDENING_LFLAGS})
target_include_directories(EncryptionLib PRIVATE
${CMAKE_CURRENT_SOURCE_DIR}/include/logging
${CMAKE_CURRENT_SOURCE_DIR}/include
${CMAKE_CURRENT_SOURCE_DIR}/src
${CMAKE_CURRENT_SOURCE_DIR}/ui
${Qt5Core_INCLUDE_DIRS}
${Qt5Gui_INCLUDE_DIRS}
${Qt5Widgets_INCLUDE_DIRS}
${ARGON2_INCLUDE_DIRS}
${SODIUM_INCLUDE_DIRS}
${ARGON2_INCLUDE_DIR}
${SODIUM_INCLUDE_DIR}
${OPENSSL_INCLUDE_DIR}
)
target_link_libraries(EncryptionLib PRIVATE
Qt5::Core
Qt5::Gui
Qt5::Widgets
OpenSSL::SSL
OpenSSL::Crypto
${ARGON2_LIBRARIES}
${SODIUM_LIBRARIES}
argon2
sodium
)
# Add Security + CoreFoundation frameworks on macOS (used by hwkey_macos.cpp).
if (CMAKE_SYSTEM_NAME STREQUAL "Darwin")
target_link_libraries(EncryptionLib PRIVATE ${SECURITY_FRAMEWORK} ${COREFOUNDATION_FRAMEWORK})
endif()
# Add Windows CNG (ncrypt.dll) on Windows. hwkey_windows.cpp calls
# NCryptOpenStorageProvider / NCryptFreeObject for TPM probing — those
# live in ncrypt.lib (MSVC) / -lncrypt (MinGW).
if (CMAKE_SYSTEM_NAME STREQUAL "Windows")
target_link_libraries(EncryptionLib PRIVATE ncrypt)
endif()
# Create the main executable and link against the library.
# WIN32 → no console window on Windows.
# MACOSX_BUNDLE → produce a proper OpenCryptUI.app on macOS so macdeployqt
# can embed Qt frameworks + plugins and the result runs on other Macs.
add_executable(OpenCryptUI WIN32 MACOSX_BUNDLE src/main.cpp)
set_target_properties(OpenCryptUI PROPERTIES
POSITION_INDEPENDENT_CODE ON
MACOSX_BUNDLE_GUI_IDENTIFIER "com.opencryptui.OpenCryptUI"
MACOSX_BUNDLE_BUNDLE_VERSION "1.0"
MACOSX_BUNDLE_SHORT_VERSION_STRING "1.0"
)
target_compile_options(OpenCryptUI PRIVATE -fPIC
${ENGINE_HARDENING_CFLAGS}
${ENGINE_HARDENING_FORTIFY}
)
target_link_options(OpenCryptUI PRIVATE ${ENGINE_HARDENING_LFLAGS})
# Disable logging for main application
target_compile_definitions(OpenCryptUI PRIVATE
-DNO_LOGGING
)
target_include_directories(OpenCryptUI PRIVATE
${CMAKE_CURRENT_SOURCE_DIR}/include
${CMAKE_CURRENT_SOURCE_DIR}/src
${CMAKE_CURRENT_SOURCE_DIR}/ui
${Qt5Core_INCLUDE_DIRS}
${Qt5Gui_INCLUDE_DIRS}
${Qt5Widgets_INCLUDE_DIRS}
${OPENSSL_INCLUDE_DIR}
)
target_link_libraries(OpenCryptUI PRIVATE EncryptionLib)
# Ensure GenerateVersionHeader is built before the main executable
add_dependencies(OpenCryptUI GenerateVersionHeader)
# ---- Mountable containers: FUSE driver (Linux/macOS via FUSE, Windows WinFsp) ----
# Off by default. The same source (libfuse3 high-level API) builds against:
# Linux : libfuse3 (apt install libfuse3-dev)
# macOS : macFUSE/fuse-t exposing the fuse3 pkg-config module
# Windows: WinFsp (winfsp.dev), which ships a libfuse3-compatible API
option(OCUI_ENABLE_FUSE "Build opencryptui-mount (needs libfuse3 / macFUSE / WinFsp)" OFF)
if(OCUI_ENABLE_FUSE)
add_executable(opencryptui-mount src/fuse_mount.cpp)
set_target_properties(opencryptui-mount PROPERTIES POSITION_INDEPENDENT_CODE ON)
target_include_directories(opencryptui-mount PRIVATE
${CMAKE_CURRENT_SOURCE_DIR}/include
${CMAKE_CURRENT_SOURCE_DIR}/include/logging)
target_link_libraries(opencryptui-mount PRIVATE
EncryptionLib Qt5::Core OpenSSL::SSL OpenSSL::Crypto argon2 sodium)
if(WIN32)
# WinFsp provides the libfuse3 API on Windows. Use the standard install
# dir or pass -DWINFSP_DIR=... ; link the arch-matched import lib.
if(NOT WINFSP_DIR)
set(WINFSP_DIR "$ENV{ProgramFiles\(x86\)}/WinFsp")
endif()
if(CMAKE_SIZEOF_VOID_P EQUAL 8)
set(_winfsp_lib "${WINFSP_DIR}/lib/winfsp-x64.lib")
else()
set(_winfsp_lib "${WINFSP_DIR}/lib/winfsp-x86.lib")
endif()
if(NOT EXISTS "${WINFSP_DIR}/inc/fuse3/fuse.h")
message(FATAL_ERROR "WinFsp FUSE headers not found under ${WINFSP_DIR}. "
"Install WinFsp with the developer headers, or set -DWINFSP_DIR=<path>.")
endif()
target_include_directories(opencryptui-mount PRIVATE
"${WINFSP_DIR}/inc" "${WINFSP_DIR}/inc/fuse3")
target_link_libraries(opencryptui-mount PRIVATE "${_winfsp_lib}")
message(STATUS "FUSE mount driver: ENABLED (WinFsp at ${WINFSP_DIR})")
else()
# Linux + macOS expose the fuse3 API via pkg-config.
find_package(PkgConfig REQUIRED)
pkg_check_modules(FUSE3 REQUIRED IMPORTED_TARGET fuse3)
target_link_libraries(opencryptui-mount PRIVATE PkgConfig::FUSE3)
# GCC/Clog hardening flags are GNU-style; fine on Linux. Skip on macOS
# where some (e.g. -fcf-protection) are not valid on Apple Silicon.
if(UNIX AND NOT APPLE)
target_compile_options(opencryptui-mount PRIVATE ${ENGINE_HARDENING_CFLAGS} ${ENGINE_HARDENING_FORTIFY})
target_link_options(opencryptui-mount PRIVATE ${ENGINE_HARDENING_LFLAGS})
endif()
message(STATUS "FUSE mount driver: ENABLED (fuse3 ${FUSE3_VERSION})")
endif()
# Real end-to-end mount test (POSIX shell): create → mount → write → read →
# verify no plaintext on disk → unmount → remount → wrong-password.
# Skips (return code 77) when /dev/fuse is unavailable. Windows has no shell
# equivalent here; it is covered by manual testing + the VaultMount test.
if(NOT WIN32)
add_test(NAME FuseMountE2E
COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/tests/fuse_mount_e2e.sh $<TARGET_FILE:opencryptui-mount>)
set_tests_properties(FuseMountE2E PROPERTIES SKIP_RETURN_CODE 77 TIMEOUT 180)
endif()
endif()
find_package(Python3 REQUIRED COMPONENTS Interpreter)
set(PYTHON_EXECUTABLE ${PYTHON_EXECUTABLE})
# Add custom command to generate version.h using Python script
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/version.h
COMMAND ${Python3_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/scripts/generate_version_header.py
DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/scripts/generate_version_header.py
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
)
# Add custom target to ensure version.h is generated
add_custom_target(GenerateVersionHeader ALL DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/version.h)
# Include version.h
include_directories(${CMAKE_CURRENT_BINARY_DIR})
# Add test source
set(TEST_SOURCES
tests/main.cpp
tests/test_encryption_app.cpp
tests/test_ui_encrypt_decrypt.cpp
tests/test_ui_smoke.cpp
tests/test_ui_tamper.cpp
tests/test_ui_container.cpp
tests/test_ui_easymode.cpp
tests/test_ui_common.h
)
# Create test executable
add_executable(OpenCryptUITest ${TEST_SOURCES})
set_target_properties(OpenCryptUITest PROPERTIES POSITION_INDEPENDENT_CODE ON)
target_compile_options(OpenCryptUITest PRIVATE -fPIC
${ENGINE_HARDENING_CFLAGS}
${ENGINE_HARDENING_FORTIFY}
)
target_link_options(OpenCryptUITest PRIVATE ${ENGINE_HARDENING_LFLAGS})
# Always enable logging for tests
target_compile_definitions(OpenCryptUITest PRIVATE
-DTEST_MODE
-DENABLE_LOGGING
)
target_include_directories(OpenCryptUITest PRIVATE
${CMAKE_CURRENT_SOURCE_DIR}/include
${CMAKE_CURRENT_SOURCE_DIR}/src
${CMAKE_CURRENT_SOURCE_DIR}/ui
${Qt5Core_INCLUDE_DIRS}
${Qt5Gui_INCLUDE_DIRS}
${Qt5Widgets_INCLUDE_DIRS}
${OPENSSL_INCLUDE_DIR}
# Needed on macOS (Homebrew) and Windows (MSYS2) where sodium/argon2
# headers aren't on the default search path. Linux picks them up from
# /usr/include but listing them here is harmless.
${SODIUM_INCLUDE_DIRS}
${SODIUM_INCLUDE_DIR}
${ARGON2_INCLUDE_DIRS}
${ARGON2_INCLUDE_DIR}
)
target_link_libraries(OpenCryptUITest PRIVATE
EncryptionLib
Qt5::Core
Qt5::Gui
Qt5::Widgets
Qt5::Test
OpenSSL::SSL
OpenSSL::Crypto
${ARGON2_LIBRARIES}
${SODIUM_LIBRARIES}
argon2
sodium
)
# Roundtrip regression test — standalone binary, no UI.
# Guards against the sign/verify aliasing + trailer-format bugs fixed previously:
# a quick encrypt→decrypt must succeed and the recovered plaintext must match.
add_executable(TestRoundtrip tests/test_roundtrip.cpp)
set_target_properties(TestRoundtrip PROPERTIES POSITION_INDEPENDENT_CODE ON)
target_compile_definitions(TestRoundtrip PRIVATE -DTEST_MODE -DENABLE_LOGGING)
target_include_directories(TestRoundtrip PRIVATE
${CMAKE_CURRENT_SOURCE_DIR}/include
${CMAKE_CURRENT_SOURCE_DIR}/include/logging
${CMAKE_CURRENT_SOURCE_DIR}/src
${Qt5Core_INCLUDE_DIRS}
${OPENSSL_INCLUDE_DIR}
${SODIUM_INCLUDE_DIRS}
${SODIUM_INCLUDE_DIR}
${ARGON2_INCLUDE_DIRS}
${ARGON2_INCLUDE_DIR}
)
target_link_libraries(TestRoundtrip PRIVATE
EncryptionLib
Qt5::Core
Qt5::Gui
Qt5::Widgets
OpenSSL::SSL
OpenSSL::Crypto
argon2
sodium
)
target_compile_options(TestRoundtrip PRIVATE
${ENGINE_HARDENING_CFLAGS}
${ENGINE_HARDENING_FORTIFY}
)
target_link_options(TestRoundtrip PRIVATE ${ENGINE_HARDENING_LFLAGS})
# Helper macro: compile an engine-level test (no UI). One .cpp, one
# executable, one CTest entry. Matches the TestRoundtrip pattern so
# every engine test gets the same includes and links.
function(add_engine_test name source)
add_executable(${name} ${source})
set_target_properties(${name} PROPERTIES POSITION_INDEPENDENT_CODE ON)
target_compile_definitions(${name} PRIVATE -DTEST_MODE -DENABLE_LOGGING)
target_include_directories(${name} PRIVATE
${CMAKE_CURRENT_SOURCE_DIR}/include
${CMAKE_CURRENT_SOURCE_DIR}/include/logging
${CMAKE_CURRENT_SOURCE_DIR}/src
${Qt5Core_INCLUDE_DIRS}
${OPENSSL_INCLUDE_DIR}
${SODIUM_INCLUDE_DIRS}
${SODIUM_INCLUDE_DIR}
${ARGON2_INCLUDE_DIRS}
${ARGON2_INCLUDE_DIR}
)
target_link_libraries(${name} PRIVATE
EncryptionLib
Qt5::Core Qt5::Gui Qt5::Widgets
OpenSSL::SSL OpenSSL::Crypto
argon2 sodium
)
target_compile_options(${name} PRIVATE
${ENGINE_HARDENING_CFLAGS}
${ENGINE_HARDENING_FORTIFY}
)
target_link_options(${name} PRIVATE ${ENGINE_HARDENING_LFLAGS})
endfunction()
add_engine_test(TestEngineTamper tests/test_engine_tamper.cpp)
add_engine_test(TestEngineDowngrade tests/test_engine_downgrade.cpp)
add_engine_test(TestEngineKeyfile tests/test_engine_keyfile.cpp)
add_engine_test(TestEngineCipherMatrix tests/test_engine_cipher_matrix.cpp)
add_engine_test(TestEngineKdf tests/test_engine_kdf.cpp)
add_engine_test(TestBenchmark tests/test_benchmark.cpp)
add_engine_test(TestEnginePerChunk tests/test_engine_per_chunk.cpp)
add_engine_test(TestSecureString tests/test_secure_string.cpp)
add_engine_test(TestSecureLoggerRedact tests/test_secure_logger_redaction.cpp)
add_engine_test(TestPqHybrid tests/test_pq_hybrid.cpp)
add_engine_test(TestHwKeyStub tests/test_hwkey_stub.cpp)
add_engine_test(TestEngineV4Deniability tests/test_engine_v4_deniability.cpp)
add_engine_test(TestEngineV3Fallback tests/test_engine_v3_fallback.cpp)
add_engine_test(TestEngineCascade tests/test_engine_cascade.cpp)
add_engine_test(TestDeniableContainer tests/test_deniable_container.cpp)
add_engine_test(TestBlockVolume tests/test_block_volume.cpp)
add_engine_test(TestShamir tests/test_shamir.cpp)
# VaultMounter integration test - only meaningful when the FUSE driver exists.
# Self-SKIPs at runtime when FUSE is unavailable in the environment.
if(OCUI_ENABLE_FUSE)
add_engine_test(TestVaultMount tests/test_vault_mount.cpp)
add_dependencies(TestVaultMount opencryptui-mount)
add_test(NAME VaultMount COMMAND TestVaultMount)
set_tests_properties(VaultMount PROPERTIES SKIP_RETURN_CODE 77 TIMEOUT 180)
endif()
# End-to-end black-box test: exercises the shipped OpenCryptUI binary via
# QProcess (startup smoke) plus engine round-trip and tamper-rejection cases
# that mirror what the binary does at runtime.
add_engine_test(TestEndToEndBlackbox tests/test_endtoend_blackbox.cpp)
# Inject the absolute path to the OpenCryptUI binary so the test can locate
# it without relying on PATH or working-directory assumptions.
target_compile_definitions(TestEndToEndBlackbox PRIVATE
OPENCRYPTUI_BINARY_PATH="${CMAKE_BINARY_DIR}/OpenCryptUI"
)
# QProcess is part of Qt5::Core (already linked by add_engine_test), but
# ensure the dependency on the binary being built is expressed so that a
# parallel build does not run the test before the binary is ready.
add_dependencies(TestEndToEndBlackbox OpenCryptUI)
# Add tests to CTest
enable_testing()
add_test(NAME OpenCryptUITest COMMAND OpenCryptUITest)
add_test(NAME TestRoundtripGCM COMMAND TestRoundtrip AES-256-GCM)
add_test(NAME TestRoundtripCBC COMMAND TestRoundtrip AES-256-CBC)
add_test(NAME EngineTamper COMMAND TestEngineTamper)
add_test(NAME EngineDowngrade COMMAND TestEngineDowngrade)
add_test(NAME EngineKeyfile COMMAND TestEngineKeyfile)
add_test(NAME EngineCipherMatrix COMMAND TestEngineCipherMatrix)
add_test(NAME EngineKdf COMMAND TestEngineKdf)
add_test(NAME TestBenchmark COMMAND TestBenchmark)
add_test(NAME EnginePerChunk COMMAND TestEnginePerChunk)
add_test(NAME SecureString COMMAND TestSecureString)
add_test(NAME SecureLoggerRedact COMMAND TestSecureLoggerRedact)
add_test(NAME PqHybrid COMMAND TestPqHybrid)
add_test(NAME HwKeyStub COMMAND TestHwKeyStub)
add_test(NAME EngineV4Deniability COMMAND TestEngineV4Deniability)
add_test(NAME EngineV3Fallback COMMAND TestEngineV3Fallback)
add_test(NAME EngineCascade COMMAND TestEngineCascade)
add_test(NAME DeniableContainer COMMAND TestDeniableContainer)
add_test(NAME BlockVolume COMMAND TestBlockVolume)
add_test(NAME Shamir COMMAND TestShamir)
add_test(NAME EndToEndBlackbox COMMAND TestEndToEndBlackbox)
set_tests_properties(EndToEndBlackbox PROPERTIES
ENVIRONMENT "QT_QPA_PLATFORM=offscreen"
TIMEOUT 30
)
# Copy test runner scripts
configure_file(
${CMAKE_CURRENT_SOURCE_DIR}/scripts/run_tests.sh
${CMAKE_CURRENT_BINARY_DIR}/run_tests.sh
COPYONLY
)
# Make the scripts executable
file(CHMOD ${CMAKE_CURRENT_BINARY_DIR}/run_tests.sh
PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE)
# Copy macOS-specific test script
if(APPLE)
configure_file(
${CMAKE_CURRENT_SOURCE_DIR}/scripts/run_tests_mac.sh
${CMAKE_CURRENT_BINARY_DIR}/run_tests_mac.sh
COPYONLY
)
# Make the macOS script executable
file(CHMOD ${CMAKE_CURRENT_BINARY_DIR}/run_tests_mac.sh
PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE)
endif()
# Copy Windows-specific test script
if(WIN32)
configure_file(
${CMAKE_CURRENT_SOURCE_DIR}/scripts/run_tests.bat
${CMAKE_CURRENT_BINARY_DIR}/run_tests.bat
COPYONLY
)
endif()
# Print paths for debugging
message(STATUS "Qt5_DIR: ${Qt5_DIR}")
message(STATUS "OPENSSL_ROOT_DIR: ${OPENSSL_ROOT_DIR}")
message(STATUS "OPENSSL_INCLUDE_DIR: ${OPENSSL_INCLUDE_DIR}")
message(STATUS "OPENSSL_LIBRARIES: ${OPENSSL_LIBRARIES}")
message(STATUS "ARGON2_INCLUDE_DIRS: ${ARGON2_INCLUDE_DIRS}")
message(STATUS "SODIUM_INCLUDE_DIRS: ${SODIUM_INCLUDE_DIRS}")
message(STATUS "ARGON2_LIB_DIR: ${ARGON2_LIB_DIR}")
message(STATUS "SODIUM_LIB_DIR: ${SODIUM_LIB_DIR}")
message(STATUS "CMAKE_PREFIX_PATH: ${CMAKE_PREFIX_PATH}")
message(STATUS "=== Hardening summary ===")
if(ENGINE_HARDENING_SUMMARY)
foreach(_s IN LISTS ENGINE_HARDENING_SUMMARY)
message(STATUS " ${_s}")
endforeach()
else()
message(STATUS " (no hardening flags enabled — compiler too old or on an unsupported platform)")
endif()
# ---------------------------------------------------------------------------
# Reproducible-build provenance.
#
# Goal: a security researcher can build OpenCryptUI from source, hash the
# binary, and compare against a published reference. Two unrelated builds
# of the same commit should produce byte-identical output.
#
# What we do here:
# - Pick up SOURCE_DATE_EPOCH from the commit timestamp if not already in
# the environment. GCC, ld, and other tooling honour this to suppress
# embedded build timestamps.
# - Add -Wl,--build-id=sha1 (ELF only) so the build-id is a deterministic
# hash of the input rather than a random uuid.
# - Emit BUILD_PROVENANCE.txt next to the binary with everything a
# reviewer needs to verify the build: commit, epoch, dep versions,
# compiler version, hardening flag set actually applied.
# ---------------------------------------------------------------------------
if(NOT DEFINED ENV{SOURCE_DATE_EPOCH})
execute_process(
COMMAND git -C ${CMAKE_SOURCE_DIR} log -1 --format=%ct
OUTPUT_VARIABLE _git_epoch
OUTPUT_STRIP_TRAILING_WHITESPACE
ERROR_QUIET
RESULT_VARIABLE _git_rc)
if(_git_rc EQUAL 0 AND _git_epoch)
set(ENV{SOURCE_DATE_EPOCH} "${_git_epoch}")
message(STATUS "SOURCE_DATE_EPOCH: ${_git_epoch} (from git HEAD)")
endif()
endif()
if(NOT APPLE AND NOT MSVC)
foreach(_t EncryptionLib OpenCryptUI OpenCryptUITest TestRoundtrip)
if(TARGET ${_t})
target_link_options(${_t} PRIVATE -Wl,--build-id=sha1)
endif()
endforeach()
endif()
# Capture commit + dep versions for BUILD_PROVENANCE.txt
execute_process(COMMAND git -C ${CMAKE_SOURCE_DIR} rev-parse HEAD
OUTPUT_VARIABLE OCUI_GIT_SHA OUTPUT_STRIP_TRAILING_WHITESPACE
ERROR_QUIET RESULT_VARIABLE _sha_rc)
if(NOT _sha_rc EQUAL 0)
set(OCUI_GIT_SHA "unknown")
endif()
# Best-effort dep version detection.
set(OCUI_OPENSSL_VERSION "${OPENSSL_VERSION}")
set(OCUI_SODIUM_VERSION "${SODIUM_VERSION}")
set(OCUI_ARGON2_VERSION "${ARGON2_VERSION}")
set(OCUI_QT5_VERSION "${Qt5_VERSION}")
set(OCUI_COMPILER_ID "${CMAKE_CXX_COMPILER_ID} ${CMAKE_CXX_COMPILER_VERSION}")
string(REPLACE ";" "\n " OCUI_HARDENING_LIST "${ENGINE_HARDENING_SUMMARY}")
file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/BUILD_PROVENANCE.txt
"OpenCryptUI build provenance
=============================
Generated at configure time. Pair with the binary's SHA-256 to verify a build.
Commit : ${OCUI_GIT_SHA}
SOURCE_DATE_EPOCH : $ENV{SOURCE_DATE_EPOCH}
Compiler : ${OCUI_COMPILER_ID}
CMake : ${CMAKE_VERSION}
Build type : ${CMAKE_BUILD_TYPE}
Target system : ${CMAKE_SYSTEM_NAME} ${CMAKE_SYSTEM_PROCESSOR}
Dependencies
------------
OpenSSL : ${OCUI_OPENSSL_VERSION}
libsodium : ${OCUI_SODIUM_VERSION}
Argon2 : ${OCUI_ARGON2_VERSION}
Qt5 : ${OCUI_QT5_VERSION}
Hardening flags applied
-----------------------
${OCUI_HARDENING_LIST}
")
message(STATUS "Wrote ${CMAKE_CURRENT_BINARY_DIR}/BUILD_PROVENANCE.txt")
# ---------------------------------------------------------------------------
# libFuzzer harnesses — opt-in, Clang-only, never part of the default build.
#
# Enable with:
# cmake -DOCUI_ENABLE_FUZZ=ON -DCMAKE_C_COMPILER=clang \
# -DCMAKE_CXX_COMPILER=clang++ <source-dir>
#
# Three executables are produced:
# FuzzOCUIHeader — stresses the v2/v3 header parser via decryptFile
# FuzzChunkDecoder — stresses v3 chunk framing and decryptChunk
# FuzzSignatureVerifier — stresses the Ed25519 + CRC32 trailer verifier
#
# None are registered with add_test() — fuzzers run indefinitely by default
# and are driven via the 'fuzz' convenience target (see below).
# ---------------------------------------------------------------------------
option(OCUI_ENABLE_FUZZ "Build libFuzzer harnesses (requires Clang)" OFF)
if(OCUI_ENABLE_FUZZ)
if(NOT (CMAKE_CXX_COMPILER_ID STREQUAL "Clang" OR
CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang"))
message(FATAL_ERROR
"OCUI_ENABLE_FUZZ=ON requires Clang (CMAKE_CXX_COMPILER_ID is "
"'${CMAKE_CXX_COMPILER_ID}'). Re-run with "
"-DCMAKE_CXX_COMPILER=clang++")
endif()
message(STATUS "Building libFuzzer harnesses (Clang ${CMAKE_CXX_COMPILER_VERSION})")
# Compile + link flags applied to every fuzzer target.
# -fsanitize=fuzzer provides the LLVMFuzzerTestOneInput entry-point driver.
# -fsanitize=address,undefined catches memory errors and UB at runtime.
# -O1 -g -fno-omit-frame-pointer give usable stack traces without making
# the build too slow.
# NOTE: Do NOT add -D_FORTIFY_SOURCE here; it conflicts with -O1.
set(FUZZ_COMPILE_FLAGS
-fsanitize=fuzzer,address,undefined
-O1
-g
-fno-omit-frame-pointer
)
set(FUZZ_LINK_FLAGS
-fsanitize=fuzzer,address,undefined
)
# Helper function: create one fuzzer executable.
function(add_fuzzer name source)
add_executable(${name} ${source})
set_target_properties(${name} PROPERTIES POSITION_INDEPENDENT_CODE ON)
target_compile_options(${name} PRIVATE ${FUZZ_COMPILE_FLAGS})
target_link_options(${name} PRIVATE ${FUZZ_LINK_FLAGS})
# Suppress the project-wide hardening flags that conflict with fuzzer
# instrumentation (e.g. -fstack-clash-protection and -Werror=format-security
# can interact poorly with the fuzzer runtime).
target_compile_definitions(${name} PRIVATE -DTEST_MODE -DENABLE_LOGGING)
target_include_directories(${name} PRIVATE
${CMAKE_CURRENT_SOURCE_DIR}/include
${CMAKE_CURRENT_SOURCE_DIR}/include/logging
${CMAKE_CURRENT_SOURCE_DIR}/src
${Qt5Core_INCLUDE_DIRS}
${OPENSSL_INCLUDE_DIR}
${SODIUM_INCLUDE_DIRS}
${SODIUM_INCLUDE_DIR}
${ARGON2_INCLUDE_DIRS}
${ARGON2_INCLUDE_DIR}
)
target_link_libraries(${name} PRIVATE
EncryptionLib
Qt5::Core Qt5::Gui Qt5::Widgets
OpenSSL::SSL OpenSSL::Crypto
argon2 sodium
)
endfunction()
add_fuzzer(FuzzOCUIHeader
${CMAKE_CURRENT_SOURCE_DIR}/tests/fuzz/fuzz_ocui_header.cpp)
add_fuzzer(FuzzChunkDecoder
${CMAKE_CURRENT_SOURCE_DIR}/tests/fuzz/fuzz_chunk_decoder.cpp)
add_fuzzer(FuzzSignatureVerifier
${CMAKE_CURRENT_SOURCE_DIR}/tests/fuzz/fuzz_signature_verifier.cpp)
# Seed corpus directories — passed to each fuzzer so it starts from known
# good (and known bad) inputs rather than from scratch.
set(CORPUS_HEADER "${CMAKE_CURRENT_SOURCE_DIR}/tests/fuzz/corpus/ocui_header")
set(CORPUS_CHUNK "${CMAKE_CURRENT_SOURCE_DIR}/tests/fuzz/corpus/chunk_decoder")
set(CORPUS_SIG "${CMAKE_CURRENT_SOURCE_DIR}/tests/fuzz/corpus/signature_verifier")
# 'fuzz' convenience target: run each fuzzer for 60 seconds then stop.
# Usage: cmake --build <build-dir> --target fuzz
# Each fuzzer's crash artifacts land in the build directory next to its
# binary; any crash-* file produced causes the fuzzer to exit with non-zero
# status, which propagates through the custom target.
add_custom_target(fuzz
COMMAND FuzzOCUIHeader
-max_total_time=60
-print_final_stats=1
-artifact_prefix=${CMAKE_CURRENT_BINARY_DIR}/crash-header-
${CORPUS_HEADER}
COMMAND FuzzChunkDecoder
-max_total_time=60
-print_final_stats=1
-artifact_prefix=${CMAKE_CURRENT_BINARY_DIR}/crash-chunk-
${CORPUS_CHUNK}
COMMAND FuzzSignatureVerifier
-max_total_time=60
-print_final_stats=1
-artifact_prefix=${CMAKE_CURRENT_BINARY_DIR}/crash-sigver-
${CORPUS_SIG}
DEPENDS FuzzOCUIHeader FuzzChunkDecoder FuzzSignatureVerifier
COMMENT "Running each fuzzer for 60 s (OCUI_ENABLE_FUZZ=ON)"
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
)
message(STATUS " Fuzz targets: FuzzOCUIHeader FuzzChunkDecoder FuzzSignatureVerifier")
message(STATUS " Run smoke check: cmake --build <build-dir> --target fuzz")
endif() # OCUI_ENABLE_FUZZ