Skip to content

getting-started.md

Latest commit

 

History

History
60 lines (42 loc) · 1.37 KB

getting-started.md

File metadata and controls

60 lines (42 loc) · 1.37 KB

Getting Started

← Back to README

Install the library

cmake -B build -DCMAKE_PREFIX_PATH=/path/to/Qt -DCMAKE_INSTALL_PREFIX=/path/to/install
cmake --build build
cmake --install build

Optional CMake flags

cmake -B build \
  -DQTAES_ENABLE_AESNI=ON \              # Hardware AES-NI acceleration (all modes)
  -DQTAES_ENABLE_TESTS=ON \             # Build unit tests
  -DQTAES_ENABLE_WERROR=ON \            # Treat warnings as errors
  -DQTAES_ENABLE_SANITIZERS=ON \        # AddressSanitizer + UBSan (GCC/Clang only)
  -DQTAES_ENABLE_FUZZING=ON \           # libFuzzer fuzz target (Clang only)
  -DQTAES_ENABLE_OPENSSL_CROSS_CHECK=ON \ # OpenSSL interop cross-check tests
  -DQTAES_CONSTANT_TIME_SBOX=ON         # Side-channel resistant S-box (no table lookups)

Use in your project

In your CMakeLists.txt:

find_package(QtAES REQUIRED)
target_link_libraries(your_target PRIVATE QtAES::QtAES)

Then include as you would any Qt class header:

#include <QAESEncryption>

Pass the install prefix to CMake so find_package can locate the library:

cmake -B build -DCMAKE_PREFIX_PATH=/path/to/install

Embed as a subdirectory

Alternatively, copy the source tree into your project and use add_subdirectory:

add_subdirectory(Qt-AES)
target_link_libraries(your_target PRIVATE QtAES::QtAES)