Botan 3.14.1
Crypto and TLS for C&
Botan::PK_Ops::KEM_Decryption_with_KDF Class Referenceabstract

#include <pk_ops_impl.h>

Inheritance diagram for Botan::PK_Ops::KEM_Decryption_with_KDF:
Botan::PK_Ops::KEM_Decryption Botan::Classic_McEliece_Decryptor Botan::Kyber_KEM_Decryptor_Base Botan::Kyber_KEM_Decryptor Botan::ML_KEM_Decryptor

Public Member Functions

virtual size_t encapsulated_key_length () const =0
void kem_decrypt (std::span< uint8_t > out_shared_key, std::span< const uint8_t > encapsulated_key, 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_Decryption_with_KDF () override

Protected Member Functions

 KEM_Decryption_with_KDF (const PK_KEM_Options_Reader &options, KemSharedKeyQuality raw_key)
virtual void raw_kem_decrypt (std::span< uint8_t > out_raw_shared_key, std::span< const uint8_t > encapsulated_key)=0
virtual size_t raw_kem_shared_key_length () const =0

Detailed Description

Definition at line 175 of file pk_ops_impl.h.

Constructor & Destructor Documentation

◆ ~KEM_Decryption_with_KDF()

Botan::PK_Ops::KEM_Decryption_with_KDF::~KEM_Decryption_with_KDF ( )
overridedefault

◆ KEM_Decryption_with_KDF()

Botan::PK_Ops::KEM_Decryption_with_KDF::KEM_Decryption_with_KDF ( const PK_KEM_Options_Reader & options,
KemSharedKeyQuality raw_key )
protected
Parameters
optionsthe KEM options; if these do not specify a KDF then whether the raw output can be used directly is decided by raw_key

Definition at line 292 of file pk_ops.cpp.

293 :
294 m_kdf(kem_kdf_from_options(options, raw_key)) {}

Referenced by Botan::Classic_McEliece_Decryptor::Classic_McEliece_Decryptor(), Botan::Kyber_KEM_Decryptor_Base::Kyber_KEM_Decryptor_Base(), and raw_kem_shared_key_length().

Member Function Documentation

◆ encapsulated_key_length()

virtual size_t Botan::PK_Ops::KEM_Decryption::encapsulated_key_length ( ) const
pure virtualinherited

◆ kem_decrypt()

void Botan::PK_Ops::KEM_Decryption_with_KDF::kem_decrypt ( std::span< uint8_t > out_shared_key,
std::span< const uint8_t > encapsulated_key,
size_t desired_shared_key_len,
std::span< const uint8_t > salt )
finalvirtual

Implements Botan::PK_Ops::KEM_Decryption.

Definition at line 273 of file pk_ops.cpp.

276 {
277 BOTAN_ARG_CHECK(salt.empty() || m_kdf, "PK_KEM_Decryptor::decrypt requires a KDF to use a salt");
278
279 if(m_kdf) {
281 out_shared_key.size(), desired_shared_key_len, "KDF output length and shared key length match");
282
284 this->raw_kem_decrypt(raw_shared, encapsulated_key);
285 m_kdf->derive_key(out_shared_key, raw_shared, salt, {});
286 } else {
287 BOTAN_ASSERT_EQUAL(out_shared_key.size(), raw_kem_shared_key_length(), "Shared key has raw KEM output length");
288 this->raw_kem_decrypt(out_shared_key, encapsulated_key);
289 }
290}
#define BOTAN_ASSERT_EQUAL(expr1, expr2, assertion_made)
Definition assert.h:95
#define BOTAN_ARG_CHECK(expr, msg)
Definition assert.h:33
virtual void raw_kem_decrypt(std::span< uint8_t > out_raw_shared_key, std::span< const uint8_t > encapsulated_key)=0
virtual size_t raw_kem_shared_key_length() const =0
std::vector< T, secure_allocator< T > > secure_vector
Definition secmem.h:128

References BOTAN_ARG_CHECK, BOTAN_ASSERT_EQUAL, raw_kem_decrypt(), and raw_kem_shared_key_length().

◆ raw_kem_decrypt()

virtual void Botan::PK_Ops::KEM_Decryption_with_KDF::raw_kem_decrypt ( std::span< uint8_t > out_raw_shared_key,
std::span< const uint8_t > encapsulated_key )
protectedpure virtual

◆ raw_kem_shared_key_length()

virtual size_t Botan::PK_Ops::KEM_Decryption_with_KDF::raw_kem_shared_key_length ( ) const
protectedpure virtual

◆ shared_key_length()

size_t Botan::PK_Ops::KEM_Decryption_with_KDF::shared_key_length ( size_t desired_shared_key_len) const
finalvirtual

Implements Botan::PK_Ops::KEM_Decryption.

Definition at line 265 of file pk_ops.cpp.

265 {
266 if(m_kdf) {
267 return desired_shared_key_len;
268 } else {
269 return this->raw_kem_shared_key_length();
270 }
271}

References raw_kem_shared_key_length().


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