Botan::PK_Ops::KEM_Encryption_with_KDF Class Reference

#include <pk_ops_impl.h>

Inheritance diagram for Botan::PK_Ops::KEM_Encryption_with_KDF:

Public Member Functions
virtual size_t	encapsulated_key_length () const =0
void	kem_encrypt (std::span< uint8_t > out_encapsulated_key, std::span< uint8_t > out_shared_key, RandomNumberGenerator &rng, size_t desired_shared_key_len, std::span< const uint8_t > salt) final
size_t	shared_key_length (size_t desired_shared_key_len) const final
	~KEM_Encryption_with_KDF () override

Protected Member Functions
	KEM_Encryption_with_KDF (std::string_view kdf)
virtual void	raw_kem_encrypt (std::span< uint8_t > out_encapsulated_key, std::span< uint8_t > out_raw_shared_key, RandomNumberGenerator &rng)=0
virtual size_t	raw_kem_shared_key_length () const =0

Detailed Description

Definition at line 122 of file pk_ops_impl.h.

Constructor & Destructor Documentation

~KEM_Encryption_with_KDF()

Botan::PK_Ops::KEM_Encryption_with_KDF::~KEM_Encryption_with_KDF ( )

overridedefault

KEM_Encryption_with_KDF()

Botan::PK_Ops::KEM_Encryption_with_KDF::KEM_Encryption_with_KDF ( std::string_view kdf )

explicitprotected

Definition at line 227 of file pk_ops.cpp.

                                                                         {
   if(kdf != "Raw") {
      m_kdf = KDF::create_or_throw(kdf);
   }
}

References Botan::KDF::create_or_throw().

Member Function Documentation

encapsulated_key_length()

virtual size_t Botan::PK_Ops::KEM_Encryption::encapsulated_key_length ( ) const

pure virtualinherited

Implemented in Botan::Classic_McEliece_Encryptor, and Botan::Kyber_KEM_Encryptor_Base.

kem_encrypt()

void Botan::PK_Ops::KEM_Encryption_with_KDF::kem_encrypt ( std::span< uint8_t > out_encapsulated_key, std::span< uint8_t > out_shared_key, RandomNumberGenerator & rng, size_t desired_shared_key_len, std::span< const uint8_t > salt )

finalvirtual

Implements Botan::PK_Ops::KEM_Encryption.

Definition at line 206 of file pk_ops.cpp.

                                                                               {
   BOTAN_ARG_CHECK(salt.empty() || m_kdf, "PK_KEM_Encryptor::encrypt requires a KDF to use a salt");
   BOTAN_ASSERT_NOMSG(out_encapsulated_key.size() == encapsulated_key_length());
 
   if(m_kdf) {
      BOTAN_ASSERT_EQUAL(
         out_shared_key.size(), desired_shared_key_len, "KDF output length and shared key length match");
 
      secure_vector<uint8_t> raw_shared(raw_kem_shared_key_length());
      this->raw_kem_encrypt(out_encapsulated_key, raw_shared, rng);
      m_kdf->derive_key(out_shared_key, raw_shared, salt, {});
   } else {
      BOTAN_ASSERT_EQUAL(out_shared_key.size(), raw_kem_shared_key_length(), "Shared key has raw KEM output length");
      this->raw_kem_encrypt(out_encapsulated_key, out_shared_key, rng);
   }
}

References BOTAN_ARG_CHECK, BOTAN_ASSERT_EQUAL, and BOTAN_ASSERT_NOMSG.

raw_kem_encrypt()

virtual void Botan::PK_Ops::KEM_Encryption_with_KDF::raw_kem_encrypt ( std::span< uint8_t > out_encapsulated_key, std::span< uint8_t > out_raw_shared_key, RandomNumberGenerator & rng )

protectedpure virtual

Implemented in Botan::Classic_McEliece_Encryptor, and Botan::Kyber_KEM_Encryptor_Base.

raw_kem_shared_key_length()

virtual size_t Botan::PK_Ops::KEM_Encryption_with_KDF::raw_kem_shared_key_length ( ) const

protectedpure virtual

Implemented in Botan::Classic_McEliece_Encryptor, and Botan::Kyber_KEM_Encryptor_Base.

shared_key_length()

size_t Botan::PK_Ops::KEM_Encryption_with_KDF::shared_key_length ( size_t desired_shared_key_len ) const

finalvirtual

Implements Botan::PK_Ops::KEM_Encryption.

Definition at line 198 of file pk_ops.cpp.

                                                                                           {
   if(m_kdf) {
      return desired_shared_key_len;
   } else {
      return this->raw_kem_shared_key_length();
   }
}

---

The documentation for this class was generated from the following files:

• src/lib/pubkey/pk_ops_impl.h
• src/lib/pubkey/pk_ops.cpp