private_key.hpp

Go to the documentation of this file.

#pragma once
 
/// @file userver/crypto/private_key.hpp
/// @brief @copybrief crypto::PrivateKey
 
#include <memory>
#include <optional>
#include <string>
#include <string_view>
 
#include <userver/crypto/basic_types.hpp>
 
USERVER_NAMESPACE_BEGIN
 
namespace crypto {
 
/// @ingroup userver_universal userver_containers
///
/// Loaded into memory private key
class PrivateKey {
public:
    using NativeType = EVP_PKEY;
 
    PrivateKey() = default;
 
    NativeType* GetNative() const noexcept { return pkey_.get(); }
    explicit operator bool() const noexcept { return !!pkey_; }
 
    /// Returns a PEM-encoded representation of stored private key encrypted by
    /// the provided password.
    ///
    /// @throw crypto::SerializationError if the password is empty or
    /// serialization fails.
    std::optional<std::string> GetPemString(std::string_view password) const;
 
    /// Returns a PEM-encoded representation of stored private key in an
    /// unencrypted form.
    ///
    /// @throw crypto::SerializationError if serialization fails.
    std::optional<std::string> GetPemStringUnencrypted() const;
 
    /// Accepts a string that contains a private key and a password, checks the
    /// key and password, loads it into OpenSSL structures and returns as a
    /// PrivateKey variable.
    ///
    /// @throw crypto::KeyParseError if failed to load the key.
    static PrivateKey LoadFromString(std::string_view key, std::string_view password);
 
    /// Accepts a string that contains a private key (not protected with
    /// password), checks the key and password, loads it into OpenSSL structures
    /// and returns as a PrivateKey variable.
    ///
    /// @throw crypto::KeyParseError if failed to load the key.
    static PrivateKey LoadFromString(std::string_view key);
 
private:
    explicit PrivateKey(std::shared_ptr<NativeType> pkey) : pkey_(std::move(pkey)) {}
 
    std::shared_ptr<NativeType> pkey_{};
};
 
}  // namespace crypto
 
USERVER_NAMESPACE_END