dh.hpp

Go to the documentation of this file.

//    OpenVPN -- An application to securely tunnel IP networks
//               over a single port, with support for SSL/TLS-based
//               session authentication and key exchange,
//               packet encryption, packet authentication, and
//               packet compression.
//
//    Copyright (C) 2012- OpenVPN Inc.
//
//    SPDX-License-Identifier: MPL-2.0 OR AGPL-3.0-only WITH openvpn3-openssl-exception
//
 
// Wrap an OpenSSL DH object
 
#pragma once
 
#include <string>
 
#include <openssl/opensslv.h>
 
#include <openvpn/common/size.hpp>
#include <openvpn/common/numeric_cast.hpp>
#include <openvpn/common/exception.hpp>
#include <openvpn/openssl/util/error.hpp>
 
#if OPENSSL_VERSION_NUMBER < 0x30000000L
#include <openvpn/openssl/pki/dh-compat.hpp>
#else
 
 
namespace openvpn::OpenSSLPKI {
 
 
 
class DH
{
  public:
    DH()
        : dh_(nullptr)
    {
    }
 
    explicit DH(const std::string &dh_txt)
        : dh_(nullptr)
    {
        parse_pem(dh_txt);
    }
 
    DH(const DH &other)
    {
        dup(other.dh_);
    }
 
    DH(DH &&other) noexcept
        : dh_(other.dh_)
    {
        other.dh_ = nullptr;
    }
 
    void operator=(const DH &other)
    {
        if (this != &other)
        {
            erase();
            dup(other.dh_);
        }
    }
 
    DH &operator=(DH &&other) noexcept
    {
        if (this != &other)
        {
            erase();
            dh_ = other.dh_;
            other.dh_ = nullptr;
        }
        return *this;
    }
 
    bool defined() const
    {
        return dh_ != nullptr;
    }
    ::EVP_PKEY *obj() const
    {
        return dh_;
    }
 
    ::EVP_PKEY *obj_release()
    {
        auto dh = dh_;
        dh_ = nullptr;
        return dh;
    }
 
    void parse_pem(const std::string &dh_txt)
    {
        BIO *bio = ::BIO_new_mem_buf(const_cast<char *>(dh_txt.c_str()), numeric_cast<int>(dh_txt.length()));
        if (!bio)
            throw OpenSSLException();
 
        ::EVP_PKEY *dh = ::PEM_read_bio_Parameters_ex(bio, nullptr, nullptr, nullptr);
        ::BIO_free(bio);
        if (!dh)
            throw OpenSSLException("DH::parse_pem");
 
        erase();
        dh_ = dh;
    }
 
    std::string render_pem() const
    {
        if (dh_)
        {
            BIO *bio = ::BIO_new(BIO_s_mem());
            const int ret = ::PEM_write_bio_Parameters(bio, dh_);
            if (ret == 0)
            {
                ::BIO_free(bio);
                throw OpenSSLException("DH::render_pem");
            }
 
            {
                char *temp;
                const size_t buf_len = ::BIO_get_mem_data(bio, &temp);
                std::string ret = std::string(temp, buf_len);
                ::BIO_free(bio);
                return ret;
            }
        }
        else
            return "";
    }
 
    ~DH()
    {
        erase();
    }
 
  private:
    void erase()
    {
        if (dh_)
            ::EVP_PKEY_free(dh_);
    }
 
    void dup(const ::EVP_PKEY *dh)
    {
        if (dh)
            dh_ = EVP_PKEY_dup(const_cast<EVP_PKEY *>(dh));
        else
            dh_ = nullptr;
    }
 
    ::EVP_PKEY *dh_;
};
} // namespace openvpn::OpenSSLPKI
#endif