gnss-sdr/cmake/Modules/GnsssdrCrypto.cmake

# GNSS-SDR is a Global Navigation Satellite System software-defined receiver.
# This file is part of GNSS-SDR.
#
# SPDX-FileCopyrightText: 2024 C. Fernandez-Prades cfernandez(at)cttc.es
# SPDX-License-Identifier: BSD-3-Clause

if(NOT COMMAND feature_summary)
    include(FeatureSummary)
endif()

if(NOT GNSSSDR_LIB_PATHS)
    include(GnsssdrLibPaths)
endif()

################################################################################
# OpenSSL https://www.openssl.org/
################################################################################
if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
    set(OPENSSL_ROOT_DIR /usr/local/opt/openssl) # Trick for Homebrew
endif()
unset(OPENSSL_FOUND CACHE)
unset(GnuTLS_FOUND CACHE)
unset(GMP_FOUND CACHE)
if(NOT ENABLE_GNUTLS)
    find_package(OpenSSL)
endif()
set_package_properties(OpenSSL
    PROPERTIES
        URL "https://www.openssl.org"
        PURPOSE "Used for the OSNMA and SUPL protocol implementations."
        TYPE REQUIRED
)
if(OPENSSL_FOUND)
    set_package_properties(OpenSSL
        PROPERTIES
            DESCRIPTION "Cryptography and SSL/TLS Toolkit (found: v${OPENSSL_VERSION})"
    )
else()
    set_package_properties(OpenSSL
        PROPERTIES
            DESCRIPTION "OpenSSL has not been found, but GnuTLS with openssl compatibility can replace it"
    )
    ################################################################################
    # GnuTLS - https://www.gnutls.org/
    ################################################################################
    find_package(GnuTLS)
    set_package_properties(GnuTLS PROPERTIES
        URL "https://www.gnutls.org/"
        PURPOSE "Used for the OSNMA and SUPL protocol implementations."
        TYPE REQUIRED
    )
    if(GnuTLS_FOUND AND GNUTLS_VERSION_STRING)
        set_package_properties(GnuTLS PROPERTIES
            DESCRIPTION "Transport Layer Security Library (found: v${GNUTLS_VERSION_STRING})"
        )
    else()
        set_package_properties(GnuTLS PROPERTIES
            DESCRIPTION "Transport Layer Security Library"
        )
    endif()
    find_library(GNUTLS_OPENSSL_LIBRARY
        NAMES gnutls-openssl libgnutls-openssl.so.27
        PATHS ${GNSSSDR_LIB_PATHS}
    )

    find_path(GNUTLS_INCLUDE_DIR NAMES gnutls/gnutls.h
        PATHS
            /usr/include
            /usr/local/include
            /opt/local/include   # default location in Macports
            /opt/homebrew/opt/gnutls/include/
            ${GNUTLS_ROOT_DIR}/include/
    )

    if(NOT GNUTLS_OPENSSL_LIBRARY)
        message(" The GnuTLS library with openssl compatibility enabled has not been found.")
        message(" You can try to install the required libraries by typing:")
        if(${CMAKE_SYSTEM_NAME} MATCHES "Linux|kFreeBSD|GNU")
            if(${LINUX_DISTRIBUTION} MATCHES "Fedora" OR ${LINUX_DISTRIBUTION} MATCHES "Red Hat")
                message(" sudo yum install openssl-devel")
            else()
                message(" sudo apt-get install libgnutls28-dev")
            endif()
        endif()
        if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
            message(" 'sudo port install openssl3', if you are using Macports, or")
            message(" 'brew install openssl', if you are using Homebrew.")
        endif()
        message(FATAL_ERROR "OpenSSL or the GnuTLS libraries with openssl compatibility are required to build gnss-sdr")
    endif()

    # Test GnuTLS capabilities
    file(READ "${GNUTLS_INCLUDE_DIR}/gnutls/gnutls.h" gnutls_gnutls_file_contents)
    if("${gnutls_gnutls_file_contents}" MATCHES "GNUTLS_SIGN_ECDSA_SHA256")
        set(GNUTLS_SIGN_ECDSA_SHA256 TRUE)
    endif()
    if("${gnutls_gnutls_file_contents}" MATCHES "GNUTLS_SIGN_ECDSA_SHA512")
        set(GNUTLS_SIGN_ECDSA_SHA512 TRUE)
    endif()
    if("${gnutls_gnutls_file_contents}" MATCHES "GNUTLS_DIG_SHA3_256")
        set(GNUTLS_DIG_SHA3_256 TRUE)
    endif()
    if("${gnutls_gnutls_file_contents}" MATCHES "#define GNUTLS_VERSION_MAJOR 2")
        set(GNUTLS_HMAC_INIT_WITH_DIGEST TRUE)
    endif()
    if("${gnutls_gnutls_file_contents}" MATCHES "GNUTLS_MAC_AES_CMAC_128")
        set(GNUTLS_MAC_AES_CMAC_128 TRUE)
    endif()
    file(READ "${GNUTLS_INCLUDE_DIR}/gnutls/abstract.h" gnutls_abstract_file_contents)
    if("${gnutls_abstract_file_contents}" MATCHES "gnutls_pubkey_export2")
        set(GNUTLS_PUBKEY_EXPORT2 TRUE)
    endif()

    find_package(GMP)
    set_package_properties(GMP PROPERTIES
        PURPOSE "Required to decompress cryptographic keys."
        TYPE REQUIRED
    )
    if(NOT GMP_FOUND)
        message(FATAL_ERROR "GMP is required by gnss-sdr if linking against GnuTLS")
    endif()
endif()

################################################################################

function(link_to_crypto_dependencies target)
    if(OPENSSL_FOUND)
        if(TARGET OpenSSL::SSL)
            target_link_libraries(${target}
                PUBLIC
                    OpenSSL::SSL
            )
            if(TARGET OpenSSL::Crypto)
                target_link_libraries(${target}
                    PUBLIC
                        OpenSSL::Crypto
                )
            endif()
        else()
            target_link_libraries(${target}
                PUBLIC
                    ${OPENSSL_LIBRARIES}
                    "${OPENSSL_CRYPTO_LIBRARIES}"
            )
            target_include_directories(${target}
                PUBLIC
                    ${OPENSSL_INCLUDE_DIR}
            )
        endif()
        if(OPENSSL_VERSION)
            if(OPENSSL_VERSION VERSION_GREATER "3.0.0")
                target_compile_definitions(${target} PUBLIC -DUSE_OPENSSL_3=1)
            else()
                if(NOT OPENSSL_VERSION VERSION_LESS "1.1.1")
                    target_compile_definitions(${target} PUBLIC -DUSE_OPENSSL_111=1)
                endif()
            endif()
        endif()
    else()  # GnuTLS
        target_link_libraries(${target}
            PUBLIC
                ${GNUTLS_LIBRARIES}
                ${GNUTLS_OPENSSL_LIBRARY}
            PRIVATE
                Gmp::gmp
        )
        target_include_directories(${target}
            PUBLIC
                ${GNUTLS_INCLUDE_DIR}
        )
        target_compile_definitions(${target} PUBLIC -DUSE_GNUTLS_FALLBACK=1)
        if(GNUTLS_SIGN_ECDSA_SHA256)
            target_compile_definitions(${target} PRIVATE -DHAVE_GNUTLS_SIGN_ECDSA_SHA256=1)
        endif()
        if(GNUTLS_SIGN_ECDSA_SHA512)
            target_compile_definitions(${target} PRIVATE -DHAVE_GNUTLS_SIGN_ECDSA_SHA512=1)
        endif()
        if(GNUTLS_DIG_SHA3_256)
            target_compile_definitions(${target} PRIVATE -DHAVE_GNUTLS_DIG_SHA3_256=1)
        endif()
        if(GNUTLS_PUBKEY_EXPORT2)
            target_compile_definitions(${target} PRIVATE -DHAVE_GNUTLS_PUBKEY_EXPORT2=1)
        endif()
        if(GNUTLS_HMAC_INIT_WITH_DIGEST)
            target_compile_definitions(${target} PRIVATE -DHAVE_GNUTLS_HMAC_INIT_WITH_DIGEST=1)
        endif()
        if(GNUTLS_MAC_AES_CMAC_128)
            target_compile_definitions(${target} PRIVATE -DHAVE_GNUTLS_MAC_AES_CMAC_128=1)
        endif()
    endif()
endfunction()