openssl_wrappers.h

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the Apache 2.0 License.
#pragma once

#include "ccf/crypto/pem.h"

#define FMT_HEADER_ONLY

#include "ccf/ds/x509_time_fmt.h"

#include <algorithm>
#include <chrono>
#include <fmt/format.h>
#include <memory>
#include <openssl/asn1.h>
#include <openssl/bn.h>
#include <openssl/ec.h>
#include <openssl/err.h>
#include <openssl/evp.h>
#include <openssl/pem.h>
#include <openssl/rsa.h>
#include <openssl/ssl.h>
#include <openssl/x509.h>
#include <openssl/x509v3.h>
#include <optional>

namespace ccf::crypto::OpenSSL
{
  /*
   * Generic OpenSSL error handling
   */

  /// Returns the error string from an error code
  inline std::string error_string(unsigned long ec)
  {
    // ERR_error_string doesn't really expect the code could actually be zero
    // and uses the `static char buf[256]` which is NOT cleaned nor checked
    // if it has changed. So we use ERR_error_string_n directly.
    if (ec != 0u)
    {
      constexpr size_t max_error_size = 256;
      std::string err(max_error_size, '\0');
      ERR_error_string_n(ec, err.data(), err.size());
      // Remove any trailing NULs before returning
      err.resize(std::strlen(err.c_str()));
      return err;
    }
    return "unknown error";
  }

  /// Throws if rc is not 1
  inline void CHECK1(int rc)
  {
    if (rc != 1)
    {
      unsigned long ec = ERR_get_error();
      throw std::runtime_error(fmt::format(
        "OpenSSL error (rc={}, ec={}): {}", rc, ec, error_string(ec)));
    }
  }

  /// Throws if ptr is null
  inline void CHECKNULL(void* ptr)
  {
    if (ptr == nullptr)
    {
      throw std::runtime_error("OpenSSL error: missing object");
    }
  }

  // Throws if values are not equal
  inline void CHECKEQUAL(int expect, int actual)
  {
    if (expect != actual)
    {
      unsigned long ec = ERR_get_error();
      throw std::runtime_error(fmt::format(
        "OpenSSL error (rc={}, ec={}): {}", actual, ec, error_string(ec)));
    }
  }

  // Throws if value is not positive
  inline void CHECKPOSITIVE(int val)
  {
    if (val <= 0)
    {
      unsigned long ec = ERR_get_error();
      throw std::runtime_error(fmt::format(
        "OpenSSL error (rc={}, ec={}): {}", val, ec, error_string(ec)));
    }
  }

  /*
   * Unique pointer wrappers for SSL objects, with SSL' specific constructors
   * and destructors. Some objects need special functionality, others are just
   * wrappers around the same template interface Unique_SSL_OBJECT.
   */

  /// Generic template interface for different types of objects below
  /// If there are no c-tors in the derived class that matches this one,
  /// pass `nullptr` to the CTOR/DTOR parameters and make sure to implement
  /// and delete the appropriate c-tors in the derived class.
  template <class T, T* (*CTOR)(), void (*DTOR)(T*)>
  class Unique_SSL_OBJECT
  {
  protected:
    /// Pointer owning storage
    std::unique_ptr<T, void (*)(T*)> p;

  public:
    /// C-tor with new pointer via T's c-tor
    Unique_SSL_OBJECT() : p(CTOR(), DTOR)
    {
      CHECKNULL(p.get());
    }
    /// C-tor with pointer created in base class
    Unique_SSL_OBJECT(T* ptr, void (*dtor)(T*), bool check_null = true) :
      p(ptr, dtor)
    {
      if (check_null)
      {
        CHECKNULL(p.get());
      }
    }
    /// Type cast to underlying pointer
    operator T*()
    {
      return p.get();
    }
    /// Type cast to underlying pointer
    operator T*() const
    {
      return p.get();
    }
    /// Reset pointer, free old if any
    void reset(T* other)
    {
      p.reset(other);
    }
    /// Release pointer, so it's freed elsewhere (CAUTION!)
    T* release()
    {
      return p.release();
    }
  };

  struct Unique_BIO : public Unique_SSL_OBJECT<BIO, nullptr, nullptr>
  {
    Unique_BIO() :
      Unique_SSL_OBJECT(BIO_new(BIO_s_mem()), [](auto x) { BIO_free(x); })
    {}
    Unique_BIO(const void* buf, int len) :
      Unique_SSL_OBJECT(BIO_new_mem_buf(buf, len), [](auto x) { BIO_free(x); })
    {}
    Unique_BIO(std::span<const uint8_t> s) :
      Unique_SSL_OBJECT(
        BIO_new_mem_buf(s.data(), s.size()), [](auto x) { BIO_free(x); })
    {}
    Unique_BIO(const Pem& pem) :
      Unique_SSL_OBJECT(
        BIO_new_mem_buf(pem.data(), -1), [](auto x) { BIO_free(x); })
    {}
    Unique_BIO(SSL_CTX* ctx) :
      Unique_SSL_OBJECT(
        BIO_new_ssl_connect(ctx), [](auto x) { BIO_free_all(x); })
    {}
  };

  struct Unique_SSL_CTX : public Unique_SSL_OBJECT<SSL_CTX, nullptr, nullptr>
  {
    Unique_SSL_CTX(const SSL_METHOD* m) :
      Unique_SSL_OBJECT(SSL_CTX_new(m), SSL_CTX_free)
    {}
  };

  struct Unique_SSL : public Unique_SSL_OBJECT<SSL, nullptr, nullptr>
  {
    Unique_SSL(SSL_CTX* ctx) : Unique_SSL_OBJECT(SSL_new(ctx), SSL_free) {}
  };

  struct Unique_PKEY
    : public Unique_SSL_OBJECT<EVP_PKEY, EVP_PKEY_new, EVP_PKEY_free>
  {
    using Unique_SSL_OBJECT::Unique_SSL_OBJECT;
    Unique_PKEY(BIO* mem) :
      Unique_SSL_OBJECT(
        PEM_read_bio_PUBKEY(mem, nullptr, nullptr, nullptr), EVP_PKEY_free)
    {}

    Unique_PKEY(EVP_PKEY* pkey) :
      Unique_SSL_OBJECT(EVP_PKEY_dup(pkey), EVP_PKEY_free)
    {}
  };

  struct Unique_EVP_PKEY_CTX
    : public Unique_SSL_OBJECT<EVP_PKEY_CTX, nullptr, nullptr>
  {
    Unique_EVP_PKEY_CTX(EVP_PKEY* key) :
      Unique_SSL_OBJECT(EVP_PKEY_CTX_new(key, nullptr), EVP_PKEY_CTX_free)
    {}
    Unique_EVP_PKEY_CTX(int key_type = EVP_PKEY_EC) :
      Unique_SSL_OBJECT(
        EVP_PKEY_CTX_new_id(key_type, nullptr), EVP_PKEY_CTX_free)
    {}

    Unique_EVP_PKEY_CTX(const std::string& name) :
      Unique_SSL_OBJECT(
        EVP_PKEY_CTX_new_from_name(nullptr, name.c_str(), nullptr),
        EVP_PKEY_CTX_free)
    {}
  };

  struct Unique_EVP_MD_CTX
    : public Unique_SSL_OBJECT<EVP_MD_CTX, nullptr, nullptr>
  {
    Unique_EVP_MD_CTX() : Unique_SSL_OBJECT(EVP_MD_CTX_new(), EVP_MD_CTX_free)
    {}
  };

  struct Unique_X509_REQ
    : public Unique_SSL_OBJECT<X509_REQ, X509_REQ_new, X509_REQ_free>
  {
    using Unique_SSL_OBJECT::Unique_SSL_OBJECT;
    Unique_X509_REQ(BIO* mem) :
      Unique_SSL_OBJECT(
        PEM_read_bio_X509_REQ(mem, nullptr, nullptr, nullptr), X509_REQ_free)
    {}
  };

  struct Unique_X509_CRL
    : public Unique_SSL_OBJECT<X509_CRL, X509_CRL_new, X509_CRL_free>
  {
    using Unique_SSL_OBJECT::Unique_SSL_OBJECT;
    Unique_X509_CRL(BIO* mem) :
      Unique_SSL_OBJECT(
        PEM_read_bio_X509_CRL(mem, nullptr, nullptr, nullptr), X509_CRL_free)
    {}
  };

  static const char pem_prefix[] = "-----BEGIN CERTIFICATE-----";
  // -1 for the null terminator
  static constexpr size_t pem_prefix_len = sizeof(pem_prefix) - 1;

  // Check BIO starts with PEM prefix before attempting to read it as PEM
  // because PEM_read_bio_X509 is permissive and will skip over non-PEM data,
  // which may for example result in a DER containing nested PEM being read
  // as the nested certificate.
  inline X509* read_pem(BIO* mem)
  {
    std::vector<char> buf(pem_prefix_len);
    auto read = BIO_read(mem, buf.data(), pem_prefix_len);
    BIO_reset(mem);
    if (
      read != pem_prefix_len || std::memcmp(buf.data(), pem_prefix, read) != 0)
    {
      return nullptr;
    }
    return PEM_read_bio_X509(mem, nullptr, nullptr, nullptr);
  };

  struct Unique_X509 : public Unique_SSL_OBJECT<X509, X509_new, X509_free>
  {
    using Unique_SSL_OBJECT::Unique_SSL_OBJECT;
    // p == nullptr is OK (e.g. wrong format)
    Unique_X509(BIO* mem, bool pem, bool check_null = false) :
      Unique_SSL_OBJECT(
        pem ? read_pem(mem) : d2i_X509_bio(mem, nullptr), X509_free, check_null)
    {}
    Unique_X509(X509* cert, bool check_null) :
      Unique_SSL_OBJECT(cert, X509_free, check_null)
    {}
  };

  struct X509ValidityPeriod
  {
    ccf::nonstd::SystemClock::time_point not_before;
    ccf::nonstd::SystemClock::time_point not_after;
  };

  /**
   * Extract the inclusive validity period common to every certificate in a
   * DER-encoded chain.
   *
   * @return The common validity period, or std::nullopt if the chain is empty
   * or its certificate validity periods do not overlap.
   */
  inline std::optional<X509ValidityPeriod>
  get_x509_chain_common_validity_period(
    const std::vector<std::vector<uint8_t>>& certificate_chain)
  {
    std::optional<X509ValidityPeriod> common_validity_period;

    for (const auto& certificate : certificate_chain)
    {
      Unique_BIO certificate_bio(certificate);
      Unique_X509 x509(certificate_bio, false, true);

      std::tm not_before{};
      std::tm not_after{};
      CHECK1(ASN1_TIME_to_tm(X509_get0_notBefore(x509), &not_before));
      CHECK1(ASN1_TIME_to_tm(X509_get0_notAfter(x509), &not_after));

      const X509ValidityPeriod certificate_validity_period{
        ccf::nonstd::SystemClock::from_time_t(timegm(&not_before)),
        ccf::nonstd::SystemClock::from_time_t(timegm(&not_after))};

      if (!common_validity_period.has_value())
      {
        common_validity_period = certificate_validity_period;
      }
      else
      {
        common_validity_period->not_before = std::max(
          common_validity_period->not_before,
          certificate_validity_period.not_before);
        common_validity_period->not_after = std::min(
          common_validity_period->not_after,
          certificate_validity_period.not_after);
      }
    }

    if (
      common_validity_period.has_value() &&
      common_validity_period->not_before > common_validity_period->not_after)
    {
      return std::nullopt;
    }

    return common_validity_period;
  }

  struct Unique_X509_STORE
    : public Unique_SSL_OBJECT<X509_STORE, X509_STORE_new, X509_STORE_free>
  {
    using Unique_SSL_OBJECT::Unique_SSL_OBJECT;
  };

  struct Unique_X509_STORE_CTX : public Unique_SSL_OBJECT<
                                   X509_STORE_CTX,
                                   X509_STORE_CTX_new,
                                   X509_STORE_CTX_free>
  {
    using Unique_SSL_OBJECT::Unique_SSL_OBJECT;
  };

  struct Unique_EVP_CIPHER_CTX : public Unique_SSL_OBJECT<
                                   EVP_CIPHER_CTX,
                                   EVP_CIPHER_CTX_new,
                                   EVP_CIPHER_CTX_free>
  {
    using Unique_SSL_OBJECT::Unique_SSL_OBJECT;
  };

  struct Unique_STACK_OF_X509
    : public Unique_SSL_OBJECT<STACK_OF(X509), nullptr, nullptr>
  {
    Unique_STACK_OF_X509() :
      Unique_SSL_OBJECT(
        sk_X509_new_null(), [](auto x) { sk_X509_pop_free(x, X509_free); })
    {}
  };

  struct Unique_STACK_OF_X509_EXTENSIONS
    : public Unique_SSL_OBJECT<STACK_OF(X509_EXTENSION), nullptr, nullptr>
  {
    Unique_STACK_OF_X509_EXTENSIONS() :
      Unique_SSL_OBJECT(sk_X509_EXTENSION_new_null(), [](auto x) {
        sk_X509_EXTENSION_pop_free(x, X509_EXTENSION_free);
      })
    {}
    Unique_STACK_OF_X509_EXTENSIONS(STACK_OF(X509_EXTENSION) * exts) :
      Unique_SSL_OBJECT(
        exts,
        [](auto x) { sk_X509_EXTENSION_pop_free(x, X509_EXTENSION_free); },
        /*check_null=*/false)
    {}
  };

  struct Unique_ECDSA_SIG
    : public Unique_SSL_OBJECT<ECDSA_SIG, ECDSA_SIG_new, ECDSA_SIG_free>
  {
    using Unique_SSL_OBJECT::Unique_SSL_OBJECT;
    Unique_ECDSA_SIG(ECDSA_SIG* ecdsa_sig) :
      Unique_SSL_OBJECT(ecdsa_sig, ECDSA_SIG_free)
    {}
  };

  struct Unique_BIGNUM : public Unique_SSL_OBJECT<BIGNUM, BN_new, BN_free>
  {
    using Unique_SSL_OBJECT::Unique_SSL_OBJECT;

    Unique_BIGNUM(const BIGNUM* n) : Unique_BIGNUM(BN_dup(n), BN_free) {}
  };

  struct Unique_X509_TIME
    : public Unique_SSL_OBJECT<ASN1_TIME, ASN1_TIME_new, ASN1_TIME_free>
  {
    using Unique_SSL_OBJECT::Unique_SSL_OBJECT;
    Unique_X509_TIME(const std::string& s) :
      Unique_SSL_OBJECT(ASN1_TIME_new(), ASN1_TIME_free, /*check_null=*/false)
    {
      auto t = ccf::ds::to_x509_time_string(s);
      CHECK1(ASN1_TIME_set_string(*this, t.c_str()));
      CHECK1(ASN1_TIME_normalize(*this));
    }
    Unique_X509_TIME(ASN1_TIME* t) :
      Unique_SSL_OBJECT(t, ASN1_TIME_free, /*check_null=*/false)
    {}
    Unique_X509_TIME(const ccf::nonstd::SystemClock::time_point& t) :
      Unique_X509_TIME(ccf::ds::to_x509_time_string(t))
    {}
  };

  struct Unique_BN_CTX
    : public Unique_SSL_OBJECT<BN_CTX, BN_CTX_new, BN_CTX_free>
  {
    using Unique_SSL_OBJECT::Unique_SSL_OBJECT;
  };

  struct Unique_EC_GROUP : public Unique_SSL_OBJECT<EC_GROUP, nullptr, nullptr>
  {
    Unique_EC_GROUP(int nid) :
      Unique_SSL_OBJECT(
        EC_GROUP_new_by_curve_name(nid), EC_GROUP_free, /*check_null=*/true)
    {}
  };

  struct Unique_EC_POINT : public Unique_SSL_OBJECT<EC_POINT, nullptr, nullptr>
  {
    Unique_EC_POINT(const EC_GROUP* group) :
      Unique_SSL_OBJECT(EC_POINT_new(group), EC_POINT_free, /*check_null=*/true)
    {}
    Unique_EC_POINT(EC_POINT* point) :
      Unique_SSL_OBJECT(point, EC_POINT_free, /*check_null=*/true)
    {}
  };

  struct Unique_EVP_ENCODE_CTX : public Unique_SSL_OBJECT<
                                   EVP_ENCODE_CTX,
                                   EVP_ENCODE_CTX_new,
                                   EVP_ENCODE_CTX_free>
  {
    using Unique_SSL_OBJECT::Unique_SSL_OBJECT;
  };

  struct Unique_EVP_PKEY
    : public Unique_SSL_OBJECT<EVP_PKEY, EVP_PKEY_new, EVP_PKEY_free>
  {
    Unique_EVP_PKEY() = default;
    Unique_EVP_PKEY(EVP_PKEY* key) : Unique_SSL_OBJECT(key, EVP_PKEY_free) {}
  };

  struct Unique_X509_REQ_DER
    : public Unique_SSL_OBJECT<X509_REQ, X509_REQ_new, X509_REQ_free>
  {
    Unique_X509_REQ_DER(BIO* mem) :
      Unique_SSL_OBJECT::Unique_SSL_OBJECT(
        d2i_X509_REQ_bio(mem, nullptr), X509_REQ_free)
    {}
  };
}