openssl_compat.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2024, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include <openssl/opensslv.h>
#include <openssl/ssl.h>
#include <openssl/err.h>
#include <openssl/evp.h>
 
// ============================================================================
// Version Detection Macros
// ============================================================================
 
static_assert(OPENSSL_VERSION_NUMBER >= 0x30000000L,
    "OpenSSL 3.x or newer is required. OpenSSL 1.1.x reached EOL on September 11, 2023.");
 
// ============================================================================
// Deprecation Warning Suppression for OpenSSL 3.x
// ============================================================================
 
#if defined(__GNUC__) || defined(__clang__)
    #define NETWORK_OPENSSL_SUPPRESS_DEPRECATED_START \
        _Pragma("GCC diagnostic push") \
        _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
    #define NETWORK_OPENSSL_SUPPRESS_DEPRECATED_END \
        _Pragma("GCC diagnostic pop")
#elif defined(_MSC_VER)
    #define NETWORK_OPENSSL_SUPPRESS_DEPRECATED_START \
        __pragma(warning(push)) \
        __pragma(warning(disable: 4996))
    #define NETWORK_OPENSSL_SUPPRESS_DEPRECATED_END \
        __pragma(warning(pop))
#else
    #define NETWORK_OPENSSL_SUPPRESS_DEPRECATED_START
    #define NETWORK_OPENSSL_SUPPRESS_DEPRECATED_END
#endif
 
// ============================================================================
// API Compatibility Utilities
// ============================================================================
 
namespace kcenon::network::internal
{
 
inline const char* openssl_version_string() noexcept
{
    return OpenSSL_version(OPENSSL_VERSION);
}
 
inline std::string get_openssl_error() noexcept
{
    unsigned long err = ERR_get_error();
    if (err == 0)
    {
        return "No OpenSSL error";
    }
    char buf[256];
    ERR_error_string_n(err, buf, sizeof(buf));
    return std::string(buf);
}
 
inline void clear_openssl_errors() noexcept
{
    ERR_clear_error();
}
 
} // namespace kcenon::network::internal
 
// ============================================================================
// OpenSSL 3.x Provider Notes
// ============================================================================