Botan::Kyber_KEM_Encryptor_Base Class Reference

#include <kyber_encaps_base.h>

Inheritance diagram for Botan::Kyber_KEM_Encryptor_Base:

Public Member Functions
size_t	encapsulated_key_length () const override
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
void	raw_kem_encrypt (std::span< uint8_t > out_encapsulated_key, std::span< uint8_t > out_shared_key, RandomNumberGenerator &rng) 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	encapsulate (StrongSpan< KyberCompressedCiphertext > out_encapsulated_key, StrongSpan< KyberSharedSecret > out_shared_key, RandomNumberGenerator &rng)=0
	Kyber_KEM_Encryptor_Base (std::string_view kdf, const Kyber_PublicKeyInternal &pk)
const KyberConstants &	mode () const
const KyberPolyMat &	precomputed_matrix_At () const

Detailed Description

Definition at line 36 of file kyber_encaps_base.h.

Constructor & Destructor Documentation

Kyber_KEM_Encryptor_Base()

Botan::Kyber_KEM_Encryptor_Base::Kyber_KEM_Encryptor_Base ( std::string_view kdf, const Kyber_PublicKeyInternal & pk )

inlineprotected

Definition at line 52 of file kyber_encaps_base.h.

                                                                                      :
            PK_Ops::KEM_Encryption_with_KDF(kdf), Kyber_KEM_Operation_Base(pk) {}

References Botan::PK_Ops::KEM_Encryption_with_KDF::KEM_Encryption_with_KDF(), and Botan::Kyber_KEM_Operation_Base::Kyber_KEM_Operation_Base().

Referenced by Botan::Kyber_KEM_Encryptor::Kyber_KEM_Encryptor(), and Botan::ML_KEM_Encryptor::ML_KEM_Encryptor().

Member Function Documentation

encapsulate()

virtual void Botan::Kyber_KEM_Encryptor_Base::encapsulate ( StrongSpan< KyberCompressedCiphertext > out_encapsulated_key, StrongSpan< KyberSharedSecret > out_shared_key, RandomNumberGenerator & rng )

protectedpure virtual

Implemented in Botan::Kyber_KEM_Encryptor, and Botan::ML_KEM_Encryptor.

Referenced by raw_kem_encrypt().

encapsulated_key_length()

size_t Botan::Kyber_KEM_Encryptor_Base::encapsulated_key_length ( ) const

inlineoverridevirtual

Implements Botan::PK_Ops::KEM_Encryption.

Definition at line 41 of file kyber_encaps_base.h.

{ return mode().ciphertext_bytes(); }

References Botan::KyberConstants::ciphertext_bytes(), and Botan::Kyber_KEM_Operation_Base::mode().

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 )

finalvirtualinherited

Implements Botan::PK_Ops::KEM_Encryption.

Definition at line 210 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, BOTAN_ASSERT_NOMSG, Botan::PK_Ops::KEM_Encryption::encapsulated_key_length(), raw_kem_encrypt(), and raw_kem_shared_key_length().

mode()

const KyberConstants & Botan::Kyber_KEM_Operation_Base::mode ( ) const

inlineprotectedinherited

Definition at line 23 of file kyber_encaps_base.h.

{ return m_mode; }

Referenced by Botan::Kyber_KEM_Decryptor::decapsulate(), Botan::ML_KEM_Decryptor::decapsulate(), Botan::Kyber_KEM_Encryptor::encapsulate(), Botan::ML_KEM_Encryptor::encapsulate(), Botan::Kyber_KEM_Decryptor_Base::encapsulated_key_length(), Botan::Kyber_KEM_Encryptor_Base::encapsulated_key_length(), Kyber_KEM_Operation_Base(), Botan::Kyber_KEM_Decryptor_Base::raw_kem_shared_key_length(), and Botan::Kyber_KEM_Encryptor_Base::raw_kem_shared_key_length().

precomputed_matrix_At()

const KyberPolyMat & Botan::Kyber_KEM_Operation_Base::precomputed_matrix_At ( ) const

inlineprotectedinherited

Definition at line 25 of file kyber_encaps_base.h.

{ return m_At; }

Referenced by Botan::Kyber_KEM_Decryptor::decapsulate(), Botan::ML_KEM_Decryptor::decapsulate(), Botan::Kyber_KEM_Encryptor::encapsulate(), and Botan::ML_KEM_Encryptor::encapsulate().

raw_kem_encrypt()

void Botan::Kyber_KEM_Encryptor_Base::raw_kem_encrypt ( std::span< uint8_t > out_encapsulated_key, std::span< uint8_t > out_shared_key, RandomNumberGenerator & rng )

inlinefinalvirtual

Implements Botan::PK_Ops::KEM_Encryption_with_KDF.

Definition at line 43 of file kyber_encaps_base.h.

                                                             {
         encapsulate(StrongSpan<KyberCompressedCiphertext>(out_encapsulated_key),
                     StrongSpan<KyberSharedSecret>(out_shared_key),
                     rng);
      }

References encapsulate().

raw_kem_shared_key_length()

size_t Botan::Kyber_KEM_Encryptor_Base::raw_kem_shared_key_length ( ) const

inlineoverridevirtual

Implements Botan::PK_Ops::KEM_Encryption_with_KDF.

Definition at line 39 of file kyber_encaps_base.h.

{ return mode().shared_key_bytes(); }

References Botan::Kyber_KEM_Operation_Base::mode(), and Botan::KyberConstants::shared_key_bytes().

shared_key_length()

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

finalvirtualinherited

Implements Botan::PK_Ops::KEM_Encryption.

Definition at line 202 of file pk_ops.cpp.

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

References 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