11#include <botan/internal/kex_to_kem_adapter.h>
13#include <botan/assert.h>
14#include <botan/internal/fmt.h>
15#include <botan/internal/pk_ops_impl.h>
17#if defined(BOTAN_HAS_DIFFIE_HELLMAN)
19 #include <botan/dl_group.h>
22#if defined(BOTAN_HAS_ECDH)
23 #include <botan/ec_group.h>
24 #include <botan/ecdh.h>
27#if defined(BOTAN_HAS_X25519)
28 #include <botan/pk_options_readers.h>
29 #include <botan/x25519.h>
32#if defined(BOTAN_HAS_X448)
33 #include <botan/x448.h>
50size_t kex_shared_key_length(
const Public_Key& kex_public_key) {
53#if defined(BOTAN_HAS_ECDH)
54 if(
const auto* ecdh =
dynamic_cast<const ECDH_PublicKey*
>(&kex_public_key)) {
55 return ecdh->domain().get_p_bytes();
59#if defined(BOTAN_HAS_DIFFIE_HELLMAN)
60 if(
const auto* dh =
dynamic_cast<const DH_PublicKey*
>(&kex_public_key)) {
61 return dh->group().p_bytes();
65#if defined(BOTAN_HAS_X25519)
66 if(
const auto* curve =
dynamic_cast<const X25519_PublicKey*
>(&kex_public_key)) {
72#if defined(BOTAN_HAS_X448)
73 if(
const auto* curve =
dynamic_cast<const X448_PublicKey*
>(&kex_public_key)) {
80 fmt(
"Cannot get shared kex key length from unknown key agreement public key of type '{}' in the hybrid KEM key",
81 kex_public_key.algo_name()));
88std::unique_ptr<PK_Key_Agreement_Key> generate_key_agreement_private_key(
const Public_Key& kex_public_key,
92 auto new_kex_key = [&] {
93 auto new_private_key = kex_public_key.generate_another(rng);
95 if(kex_key !=
nullptr) [[likely]] {
99 (void)new_private_key.release();
101 return std::unique_ptr<PK_Key_Agreement_Key>(kex_key);
104 BOTAN_ASSERT(new_kex_key,
"Keys wrapped in this adapter are always key-agreement keys");
108std::unique_ptr<Public_Key> maybe_get_public_key(
const std::unique_ptr<Private_Key>& private_key) {
110 return private_key->public_key();
116 KEX_to_KEM_Adapter_Encryption_Operation(std::shared_ptr<const Public_Key> key,
117 const PK_KEM_Options_Reader& options,
118 std::string_view provider) :
120 m_provider(provider),
121 m_public_key(std::move(key)) {}
123 size_t raw_kem_shared_key_length()
const override {
return kex_shared_key_length(*m_public_key); }
125 size_t encapsulated_key_length()
const override {
131 return m_public_key->raw_public_key_bits().size();
134 void raw_kem_encrypt(std::span<uint8_t> out_encapsulated_key,
135 std::span<uint8_t> raw_shared_key,
136 Botan::RandomNumberGenerator& rng)
override {
137 const auto sk = generate_key_agreement_private_key(*m_public_key, rng);
138 const auto shared_key =
139 PK_Key_Agreement(*sk, rng, PK_Key_Agreement_Options().with_raw_shared_key().with_provider(m_provider))
140 .derive_key(0 , m_public_key->raw_public_key_bits())
143 const auto public_value = sk->public_value();
149 out_encapsulated_key.size(),
150 "KEX-to-KEM Adapter: encapsulated key out-param has correct length");
152 shared_key.size(), raw_shared_key.size(),
"KEX-to-KEM Adapter: shared key out-param has correct length");
153 std::copy(public_value.begin(), public_value.end(), out_encapsulated_key.begin());
154 std::copy(shared_key.begin(), shared_key.end(), raw_shared_key.begin());
158 std::string m_provider;
159 std::shared_ptr<const Public_Key> m_public_key;
164 KEX_to_KEM_Decryption_Operation(
const PK_Key_Agreement_Key& key,
165 RandomNumberGenerator& rng,
166 const PK_KEM_Options_Reader& options,
167 const std::string_view provider) :
169 m_operation(key, rng, PK_Key_Agreement_Options().with_raw_shared_key().with_provider(provider)),
170 m_encapsulated_key_length(key.public_value().size()) {}
172 void raw_kem_decrypt(std::span<uint8_t> out_shared_key, std::span<const uint8_t> encap_key)
override {
175 shared_secret.size(), out_shared_key.size(),
"KEX-to-KEM Adapter: shared key out-param has correct length");
176 std::copy(shared_secret.begin(), shared_secret.end(), out_shared_key.begin());
179 size_t encapsulated_key_length()
const override {
return m_encapsulated_key_length; }
181 size_t raw_kem_shared_key_length()
const override {
return m_operation.agreed_value_size(); }
184 PK_Key_Agreement m_operation;
185 size_t m_encapsulated_key_length;
191 m_public_key(std::move(public_key)) {
197 return fmt(
"KEX-to-KEM({})", m_public_key->algo_name());
201 return m_public_key->estimated_strength();
205 return m_public_key->key_length();
209 return m_public_key->check_key(rng, strong);
213 return m_public_key->algorithm_identifier();
217 return m_public_key->raw_public_key_bits();
221 return m_public_key->public_key_bits();
225 return std::make_unique<KEX_to_KEM_Adapter_PrivateKey>(generate_key_agreement_private_key(*m_public_key, rng));
234std::unique_ptr<PK_Key_Agreement_Key> capture_as_ka_key(std::unique_ptr<Private_Key> private_key) {
235 auto* raw_ptr = private_key.release();
237 return std::unique_ptr<PK_Key_Agreement_Key>(sk);
241 "Private key must implement PK_Key_Agreement_Key",
"KEX_to_KEM_Adapter_PrivateKey", __FILE__);
249 m_private_key(capture_as_ka_key(std::move(private_key))) {}
252 return m_private_key->private_key_bits();
256 return m_private_key->raw_private_key_bits();
260 return std::make_unique<KEX_to_KEM_Adapter_PublicKey>(m_private_key->public_key());
264 return m_private_key->check_key(rng, strong);
270 return std::make_unique<KEX_to_KEM_Adapter_Encryption_Operation>(
271 m_public_key, options, options.
provider().value_or(
""));
276 return std::make_unique<KEX_to_KEM_Decryption_Operation>(
277 *m_private_key, rng, options, options.
provider().value_or(
""));
#define BOTAN_ASSERT_NOMSG(expr)
#define BOTAN_ASSERT_EQUAL(expr1, expr2, assertion_made)
#define BOTAN_ARG_CHECK(expr, msg)
#define BOTAN_ASSERT(expr, assertion_made)
secure_vector< uint8_t > private_key_bits() const override
std::unique_ptr< Public_Key > public_key() const override
secure_vector< uint8_t > raw_private_key_bits() const override
KEX_to_KEM_Adapter_PrivateKey(std::unique_ptr< Private_Key > private_key)
std::unique_ptr< PK_Ops::KEM_Decryption > _create_kem_decryption_op(RandomNumberGenerator &rng, const PK_KEM_Options_Reader &options) const override
bool check_key(RandomNumberGenerator &rng, bool strong) const override
size_t estimated_strength() const override
KEX_to_KEM_Adapter_PublicKey(std::unique_ptr< Public_Key > public_key)
std::string algo_name() const override
std::unique_ptr< PK_Ops::KEM_Encryption > _create_kem_encryption_op(const PK_KEM_Options_Reader &options) const override
bool check_key(RandomNumberGenerator &rng, bool strong) const override
std::vector< uint8_t > raw_public_key_bits() const override
size_t key_length() const override
std::unique_ptr< Private_Key > generate_another(RandomNumberGenerator &rng) const final
AlgorithmIdentifier algorithm_identifier() const override
bool supports_operation(PublicKeyOperation op) const override
std::vector< uint8_t > public_key_bits() const override
const std::optional< std::string > & provider() const
A public key for the X448 key agreement scheme according to RFC 7748.
void throw_invalid_argument(const char *message, const char *func, const char *file)
std::string fmt(std::string_view format, const T &... args)
std::vector< T, secure_allocator< T > > secure_vector