CMakeLists.txt

# Copyright (C) 2009 - 2022 National Aeronautics and Space Administration.
# All Foreign Rights are Reserved to the U.S. Government.
# 
# This software is provided "as is" without any warranty of any kind, either expressed, implied, or statutory,
# including, but not limited to, any warranty that the software will conform to specifications, any implied warranties
# of merchantability, fitness for a particular purpose, and freedom from infringement, and any warranty that the
# documentation will conform to the program, or any warranty that the software will be error free.
# 
# In no event shall NASA be liable for any damages, including, but not limited to direct, indirect, special or
# consequential damages, arising out of, resulting from, or in any way connected with the software or its
# documentation, whether or not based upon warranty, contract, tort or otherwise, and whether or not loss was sustained
# from, or arose out of the results of, or use of, the software, documentation or services provided hereunder.
# 
# ITC Team
# NASA IV&V
# jstar-development-team@mail.nasa.gov

cmake_minimum_required(VERSION 3.14.0)
project(crypto C)

#set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsanitize=address")

#
# CUSTOM PATH Definiton
#
set(SA_CUSTOM_PATH_DEFAULT "../../sa/custom")
set(KEY_CUSTOM_PATH_DEFAULT "../../key/custom")
set(MC_CUSTOM_PATH_DEFAULT "../../mc/custom")
set(MC_LOG_PATH_DEFAULT "log.txt")
set(CRYPTO_CUSTOM_PATH_DEFAULT "../../crypto/custom")



#
# Define Build Flags
# The default value is captured in line, change with flag `-DXYZ=1`
# For flags with the same prefix, one or more may be enabled
#
option(CODECOV "Code Coverage" OFF)
option(CRYPTO_LIBGCRYPT "Cryptography Module - Libgcrypt" OFF)
option(CRYPTO_KMC "Cryptography Module - KMC" OFF)
option(CRYPTO_WOLFSSL "Cryptography Module - WolfSSL" OFF)
option(CRYPTO_CUSTOM "Cryptography Module - CUSTOM" OFF)
option(CRYPTO_CUSTOM_PATH "Cryptography Module - CUSTOM PATH" OFF)
option(DEBUG "Debug" OFF)
option(ENABLE_FUZZING "Enable fuzz testing" OFF)
option(KEY_CUSTOM "Key Module - Custom" OFF)
option(KEY_CUSTOM_PATH "Custom Key Path" OFF)
option(KEY_INTERNAL "Key Module - Internal" OFF)
option(KEY_KMC "Key Module - KMC" OFF)
option(MC_CUSTOM "Monitoring and Control - Custom" OFF)
option(MC_CUSTOM_PATH "Custom Monitoring and Control path" OFF)
option(MC_DISABLED "Monitoring and Control - Disabled" OFF)
option(MC_INTERNAL "Monitoring and Control - Internal" OFF)
option(SA_CUSTOM "Security Association - Custom" OFF)
option(SA_CUSTOM_PATH "Custom Security Association Path" OFF)
option(SA_INTERNAL "Security Association - Internal" OFF)
option(SA_MARIADB "Security Association - MariaDB" OFF)
option(SUPPORT "Support" OFF)
option(SYSTEM_INSTALL "SystemInstall" OFF)
option(TEST "Test" OFF)
option(SA_FILE "Save Security Association to File" OFF)
option(KEY_VALIDATION "Validate existance of key duplication" OFF)
option(KMC_MDB_RH "KMC-MDB-RedHat-Integration-Testing" OFF) #Disabled by default, enable with: -DKMC_MDB_RH=ON
option(KMC_MDB_DB "KMC-MDB-Debian-Integration-Testing" OFF) #Disabled by default, enable with: -DKMC_MDB_DB=ON
option(CRYPTO_EPROC "Enables the building and use of Extended Procedures" OFF) #Disabled by default, enable with -DCRYPTO_EPROC=ON
option(STANDALONE_TCP "Enables TCP support for standalone" OFF)

option(MAC_SIZE "The size of the max MAC buffer in bytes")
option(IV_SIZE "The size of the max IV buffer in bytes")
option(NUM_SA "The max number of SAs that will be used")
option(NUM_KEYS "The max number of keys that will be used")

option(CRYPTO_RX_GROUND_PORT "Port to receive commands from ground")
option(CRYPTO_TX_GROUND_PORT "Port to transmit telemetry to ground")
option(CRYPTO_TX_RADIO_PORT "Port to receive telemetry from radio")
option(CRYPTO_RX_RADIO_PORT "Port to transmit commands to radio")

#
# Max Size Defines
#
if(NUM_SA)
    add_compile_definitions(NUM_SA=${NUM_SA})
    message(STATUS "NUM_SA set to: ${NUM_SA}")
endif()
if(MAC_SIZE)
    add_compile_definitions(MAC_SIZE=${MAC_SIZE})
    message(STATUS "MAC_SIZE set to: ${MAC_SIZE}")
endif()
if(IV_SIZE)
    add_compile_definitions(IV_SIZE=${IV_SIZE})
    message(STATUS "IV_SIZE set to: ${IV_SIZE}")
endif()
if(NUM_KEYS)
    add_compile_definitions(NUM_KEYS=${NUM_KEYS})
    message(STATUS "NUM_KEYS set to: ${NUM_KEYS}")
endif()

#
# Custom Module Paths
#
if(KEY_CUSTOM)
    if(NOT DEFINED KEY_CUSTOM_PATH)
        set(KEY_CUSTOM_PATH ${KEY_CUSTOM_PATH_DEFAULT})
        message(STATUS "Default path set for KEY_CUSTOM_PATH")
    endif()
    message(STATUS "KEY_CUSTOM being utilized.  Path set to: ${KEY_CUSTOM_PATH}")
endif()

if(MC_CUSTOM)
    if(NOT DEFINED MC_CUSTOM_PATH)
        set(MC_CUSTOM_PATH ${MC_CUSTOM_PATH_DEFAULT})
        message(STATUS "Default path set for MC_CUSTOM_PATH")
    endif()
    message(STATUS "MC_CUSTOM being utilized.  Path set to: ${MC_CUSTOM_PATH}")
endif()

if(SA_CUSTOM)
    if(NOT DEFINED SA_CUSTOM_PATH)
        set(SA_CUSTOM_PATH ${SA_CUSTOM_PATH_DEFAULT})
        message(STATUS "Default path set for SA_CUSTOM_PATH")
    endif()
    message(STATUS "SA_CUSTOM being utilized.  Path set to: ${SA_CUSTOM_PATH}")
endif()

if(CRYPTO_CUSTOM)
    if(NOT DEFINED CRYPTO_CUSTOM_PATH)
        set(CRYPTO_CUSTOM_PATH ${CRYPTO_CUSTOM_PATH_DEFAULT})
        message(STATUS "Default path set for CRYPTO_CUSTOM_PATH")
    endif()
    message(STATUS "CRYPTO_CUSTOM being utilized.  Path set to: ${CRYPTO_CUSTOM_PATH}")
endif()


#
# Build Flag Logic
#
if(CODECOV)
    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fprofile-arcs -ftest-coverage")
endif()

if(SA_FILE)
    add_definitions(-DSA_FILE)
endif()

if(KEY_VALIDATION)
    add_definitions(-DKEY_VALIDATION)
endif()

if(DEBUG)
    add_definitions(-DDEBUG -DOCF_DEBUG -DFECF_DEBUG -DSA_DEBUG -DPDU_DEBUG -DCCSDS_DEBUG -DTC_DEBUG -DMAC_DEBUG -DTM_DEBUG -DAOS_DEBUG)
    add_compile_options(-ggdb)
endif()

if(DEFINED MC_LOG_CUSTOM_PATH)
    message(STATUS "MC_LOG_CUSTOM_PATH set to: ${MC_LOG_CUSTOM_PATH}")
    add_compile_definitions(MC_LOG_PATH="${MC_LOG_CUSTOM_PATH}")
else()
    add_compile_definitions(MC_LOG_PATH="${MC_LOG_PATH_DEFAULT}")
endif()

IF(KMC_MDB_RH)
    ADD_DEFINITIONS(-DKMC_MDB_RH)
ENDIF(KMC_MDB_RH)

IF(KMC_MDB_DB)
    ADD_DEFINITIONS(-DKMC_MDB_DB)
ENDIF(KMC_MDB_DB)

IF(CRYPTO_EPROC)
    ADD_DEFINITIONS(-DCRYPTO_EPROC)
    message(WARNING "Cryptolib Extended Procedures NOT complete.  NOT Fully tested.  Use at own risk!")
ENDIF(CRYPTO_EPROC)

if(SYSTEM_INSTALL)
    # The library will be installed to /usr/local unless overridden with
    # -DCMAKE_INSTALL_PREFIX=/some/path
    # See https://cmake.org/cmake/help/latest/variable/CMAKE_INSTALL_PREFIX.html
elseif(CRYPTO_SUBMODULE_INSTALL)
    set(CMAKE_INSTALL_PREFIX ${CRYPTO_SUBMODULE_INSTALL})
elseif(NOT DEFINED CFE_SYSTEM_PSPNAME)
    # Not cFE / cFS
    set(CMAKE_INSTALL_RPATH "$ORIGIN/../lib")
    set(CMAKE_INSTALL_PREFIX ${PROJECT_SOURCE_DIR}/install)
endif()

# if(TEST_ENC)
#     # Can't run an additional set of tests without `TEST` enabled
#     set(TEST ON)
# endif()

if(TEST)
    include(CTest)
    enable_testing()
endif()

#
# Project Specifics
#
if(ENABLE_FUZZING) 
    # More permissive flags for fuzzing (afl compiler fails with -Werror for self-assign warnings)
    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -Wno-self-assign -g -O0")
else()
    # Stricter flags for normal builds (treat warnings as errors)
    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall -Wextra -Werror -g -O0")
endif()

include_directories(include)
add_subdirectory(src)

if(SUPPORT)
    add_subdirectory(support)
    if(CRYPTO_RX_GROUND_PORT)
        message(STATUS "TC_APPLY_PORT set to ${CRYPTO_RX_GROUND_PORT}")
        add_compile_definitions(TC_APPLY_PORT="${CRYPTO_RX_GROUND_PORT}")
    endif()
    if(CRYPTO_TX_GROUND_PORT)
        message(STATUS "TM_PROCESS_FWD_PORT set to ${CRYPTO_TX_GROUND_PORT}")
        add_compile_definitions(TM_PROCESS_FWD_PORT="${CRYPTO_TX_GROUND_PORT}")
    endif()
    if(CRYPTO_TX_RADIO_PORT)
        message(STATUS "TM_PROCESS_PORT set to ${CRYPTO_TX_RADIO_PORT}")
        add_compile_definitions(TM_PROCESS_PORT="${CRYPTO_TX_RADIO_PORT}")
    endif()
    if(CRYPTO_RX_RADIO_PORT)
        message(STATUS "TC_APPLY_FWD_PORT set to ${CRYPTO_RX_RADIO_PORT}")
        add_compile_definitions(TC_APPLY_FWD_PORT="${CRYPTO_RX_RADIO_PORT}")
    endif()
endif()

if(TEST)
    add_subdirectory(test)
endif()

if(ENABLE_FUZZING)
    add_subdirectory(./support/fuzz)
endif()