Botan::Kyber_KEM_Decryptor_Base Class Reference

#include <kyber_encaps_base.h>

Inheritance diagram for Botan::Kyber_KEM_Decryptor_Base:

Public Member Functions
size_t	encapsulated_key_length () const override
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
void	raw_kem_decrypt (std::span< uint8_t > out_shared_key, std::span< const uint8_t > encapsulated_key) final
size_t	raw_kem_shared_key_length () const override
size_t	shared_key_length (size_t desired_shared_key_len) const final

Protected Member Functions
virtual void	decapsulate (StrongSpan< KyberSharedSecret > out_shared_key, StrongSpan< const KyberCompressedCiphertext > encapsulated_key)=0
	Kyber_KEM_Decryptor_Base (std::string_view kdf)
virtual const KyberConstants &	mode () const =0

Detailed Description

Definition at line 43 of file kyber_encaps_base.h.

Constructor & Destructor Documentation

Kyber_KEM_Decryptor_Base()

Botan::Kyber_KEM_Decryptor_Base::Kyber_KEM_Decryptor_Base ( std::string_view kdf )

inlineprotected

Definition at line 55 of file kyber_encaps_base.h.

: PK_Ops::KEM_Decryption_with_KDF(kdf) {}

Member Function Documentation

decapsulate()

virtual void Botan::Kyber_KEM_Decryptor_Base::decapsulate ( StrongSpan< KyberSharedSecret > out_shared_key, StrongSpan< const KyberCompressedCiphertext > encapsulated_key )

protectedpure virtual

Implemented in Botan::Kyber_KEM_Decryptor.

Referenced by raw_kem_decrypt().

encapsulated_key_length()

size_t Botan::Kyber_KEM_Decryptor_Base::encapsulated_key_length ( ) const

inlineoverridevirtual

Implements Botan::PK_Ops::KEM_Decryption.

Definition at line 47 of file kyber_encaps_base.h.

{ return mode().encapsulated_key_length(); }

References Botan::KyberConstants::encapsulated_key_length(), and mode().

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 )

finalvirtualinherited

Implements Botan::PK_Ops::KEM_Decryption.

Definition at line 204 of file pk_ops.cpp.

                                                                               {
   BOTAN_ARG_CHECK(salt.empty() || m_kdf, "PK_KEM_Decryptor::decrypt requires a KDF to use a salt");
 
   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_decrypt(raw_shared, encapsulated_key);
      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_decrypt(out_shared_key, encapsulated_key);
   }
}

References BOTAN_ARG_CHECK, and BOTAN_ASSERT_EQUAL.

mode()

virtual const KyberConstants & Botan::Kyber_KEM_Decryptor_Base::mode ( ) const

protectedpure virtual

Implemented in Botan::Kyber_KEM_Decryptor.

Referenced by encapsulated_key_length(), and raw_kem_shared_key_length().

raw_kem_decrypt()

void Botan::Kyber_KEM_Decryptor_Base::raw_kem_decrypt ( std::span< uint8_t > out_shared_key, std::span< const uint8_t > encapsulated_key )

inlinefinalvirtual

Implements Botan::PK_Ops::KEM_Decryption_with_KDF.

Definition at line 49 of file kyber_encaps_base.h.

                                                                                                           {
         decapsulate(StrongSpan<KyberSharedSecret>(out_shared_key),
                     StrongSpan<const KyberCompressedCiphertext>(encapsulated_key));
      }

References decapsulate().

raw_kem_shared_key_length()

size_t Botan::Kyber_KEM_Decryptor_Base::raw_kem_shared_key_length ( ) const

inlineoverridevirtual

Implements Botan::PK_Ops::KEM_Decryption_with_KDF.

Definition at line 45 of file kyber_encaps_base.h.

{ return mode().shared_key_length(); }

References mode(), and Botan::KyberConstants::shared_key_length().

shared_key_length()

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

finalvirtualinherited

Implements Botan::PK_Ops::KEM_Decryption.

Definition at line 196 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 file:

• src/lib/pubkey/kyber/kyber_common/kyber_encaps_base.h