Botan::Kyber_Symmetric_Primitives Class Reference

#include <kyber_symmetric_primitives.h>

Inheritance diagram for Botan::Kyber_Symmetric_Primitives:

Public Member Functions
std::pair< KyberSharedSecret, KyberEncryptionRandomness >	G (StrongSpan< const KyberMessage > msg, StrongSpan< const KyberHashedPublicKey > pubkey_hash) const
std::pair< KyberSeedRho, KyberSeedSigma >	G (StrongSpan< const KyberSeedRandomness > seed) const
KyberHashedCiphertext	H (StrongSpan< const KyberCompressedCiphertext > r) const
KyberMessage	H (StrongSpan< const KyberMessage > m) const
KyberHashedPublicKey	H (StrongSpan< const KyberSerializedPublicKey > pk) const
void	KDF (StrongSpan< KyberSharedSecret > out, StrongSpan< const KyberSharedSecret > shared_secret, StrongSpan< const KyberHashedCiphertext > hashed_ciphertext) const
KyberSamplingRandomness	PRF (KyberSigmaOrEncryptionRandomness seed, const uint8_t nonce, const size_t outlen) const
std::unique_ptr< Botan::XOF >	XOF (StrongSpan< const KyberSeedRho > seed, std::tuple< uint8_t, uint8_t > matrix_position) const
virtual	~Kyber_Symmetric_Primitives ()=default

Protected Member Functions
virtual HashFunction &	get_G () const =0
virtual HashFunction &	get_H () const =0
virtual HashFunction &	get_KDF () const =0
virtual Botan::XOF &	get_PRF (std::span< const uint8_t > seed, uint8_t nonce) const =0
virtual std::unique_ptr< Botan::XOF >	get_XOF (std::span< const uint8_t > seed, std::tuple< uint8_t, uint8_t > matrix_position) const =0

Detailed Description

Adapter class that uses polymorphy to distinguish Kyber "modern" from Kyber "90s" modes.

Definition at line 32 of file kyber_symmetric_primitives.h.

Constructor & Destructor Documentation

~Kyber_Symmetric_Primitives()

virtual Botan::Kyber_Symmetric_Primitives::~Kyber_Symmetric_Primitives ( )

virtualdefault

Member Function Documentation

G() [1/2]

std::pair< KyberSharedSecret, KyberEncryptionRandomness > Botan::Kyber_Symmetric_Primitives::G ( StrongSpan< const KyberMessage > msg, StrongSpan< const KyberHashedPublicKey > pubkey_hash ) const

inline

Definition at line 52 of file kyber_symmetric_primitives.h.

                                                                                                       {
         return G_split<KyberSharedSecret, KyberEncryptionRandomness>(msg, pubkey_hash);
      }

G() [2/2]

std::pair< KyberSeedRho, KyberSeedSigma > Botan::Kyber_Symmetric_Primitives::G ( StrongSpan< const KyberSeedRandomness > seed ) const

inline

Definition at line 48 of file kyber_symmetric_primitives.h.

                                                                                                {
         return G_split<KyberSeedRho, KyberSeedSigma>(seed);
      }

get_G()

virtual HashFunction & Botan::Kyber_Symmetric_Primitives::get_G ( ) const

protectedpure virtual

Implemented in Botan::Kyber_90s_Symmetric_Primitives, and Botan::Kyber_Modern_Symmetric_Primitives.

get_H()

virtual HashFunction & Botan::Kyber_Symmetric_Primitives::get_H ( ) const

protectedpure virtual

Implemented in Botan::Kyber_90s_Symmetric_Primitives, and Botan::Kyber_Modern_Symmetric_Primitives.

Referenced by H(), H(), and H().

get_KDF()

virtual HashFunction & Botan::Kyber_Symmetric_Primitives::get_KDF ( ) const

protectedpure virtual

Implemented in Botan::Kyber_90s_Symmetric_Primitives, and Botan::Kyber_Modern_Symmetric_Primitives.

Referenced by KDF().

get_PRF()

virtual Botan::XOF & Botan::Kyber_Symmetric_Primitives::get_PRF ( std::span< const uint8_t > seed, uint8_t nonce ) const

protectedpure virtual

Implemented in Botan::Kyber_90s_Symmetric_Primitives, and Botan::Kyber_Modern_Symmetric_Primitives.

Referenced by PRF().

get_XOF()

virtual std::unique_ptr< Botan::XOF > Botan::Kyber_Symmetric_Primitives::get_XOF ( std::span< const uint8_t > seed, std::tuple< uint8_t, uint8_t > matrix_position ) const

protectedpure virtual

Implemented in Botan::Kyber_90s_Symmetric_Primitives, and Botan::Kyber_Modern_Symmetric_Primitives.

Referenced by XOF().

H() [1/3]

KyberHashedCiphertext Botan::Kyber_Symmetric_Primitives::H ( StrongSpan< const KyberCompressedCiphertext > r ) const

inline

Definition at line 40 of file kyber_symmetric_primitives.h.

                                                                                   {
         return get_H().process<KyberHashedCiphertext>(r);
      }

References get_H(), and Botan::Buffered_Computation::process().

H() [2/3]

KyberMessage Botan::Kyber_Symmetric_Primitives::H ( StrongSpan< const KyberMessage > m ) const

inline

Definition at line 37 of file kyber_symmetric_primitives.h.

{ return get_H().process<KyberMessage>(m); }

References get_H(), and Botan::Buffered_Computation::process().

H() [3/3]

KyberHashedPublicKey Botan::Kyber_Symmetric_Primitives::H ( StrongSpan< const KyberSerializedPublicKey > pk ) const

inline

Definition at line 44 of file kyber_symmetric_primitives.h.

                                                                                  {
         return get_H().process<KyberHashedPublicKey>(pk);
      }

References get_H(), and Botan::Buffered_Computation::process().

KDF()

void Botan::Kyber_Symmetric_Primitives::KDF ( StrongSpan< KyberSharedSecret > out, StrongSpan< const KyberSharedSecret > shared_secret, StrongSpan< const KyberHashedCiphertext > hashed_ciphertext ) const

inline

Definition at line 58 of file kyber_symmetric_primitives.h.

                                                                                {
         auto& kdf = get_KDF();
         kdf.update(shared_secret);
         kdf.update(hashed_ciphertext);
         kdf.final(out);
      }

References get_KDF().

PRF()

KyberSamplingRandomness Botan::Kyber_Symmetric_Primitives::PRF ( KyberSigmaOrEncryptionRandomness seed, const uint8_t nonce, const size_t outlen ) const

inline

Definition at line 67 of file kyber_symmetric_primitives.h.

                                                             {
         auto bare_seed_span = std::visit([&](const auto s) { return s.get(); }, seed);
         return get_PRF(bare_seed_span, nonce).output<KyberSamplingRandomness>(outlen);
      }

References get_PRF(), and Botan::XOF::output().

Referenced by Botan::Polynomial::getnoise_eta1(), and Botan::Polynomial::getnoise_eta2().

XOF()

std::unique_ptr< Botan::XOF > Botan::Kyber_Symmetric_Primitives::XOF ( StrongSpan< const KyberSeedRho > seed, std::tuple< uint8_t, uint8_t > matrix_position ) const

inline

Definition at line 74 of file kyber_symmetric_primitives.h.

                                                                                        {
         // TODO: once we remove Kyber 90s, we should make `get_XOF()` return a
         //       reference instead of a unique pointer (for consistency), and
         //       call `get_XOF().copy_state()` here. The AES-CTR XOF doesn't
         //       support this.
         return get_XOF(seed, matrix_position);
      }

References get_XOF().

Referenced by Botan::PolynomialMatrix::generate().

---

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

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