Botan 3.5.0
Crypto and TLS for C&
Botan::Kyber_Symmetric_Primitives Class Referenceabstract

#include <kyber_symmetric_primitives.h>

Inheritance diagram for Botan::Kyber_Symmetric_Primitives:
Botan::Kyber_90s_Symmetric_Primitives Botan::Kyber_Modern_Symmetric_Primitives

Public Member Functions

std::pair< KyberSharedSecret, KyberEncryptionRandomnessG (StrongSpan< const KyberMessage > msg, StrongSpan< const KyberHashedPublicKey > pubkey_hash) const
 
std::pair< KyberSeedRho, KyberSeedSigmaG (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::XOFXOF (StrongSpan< const KyberSeedRho > seed, std::tuple< uint8_t, uint8_t > matrix_position) const
 
virtual ~Kyber_Symmetric_Primitives ()=default
 

Protected Member Functions

virtual HashFunctionget_G () const =0
 
virtual HashFunctionget_H () const =0
 
virtual HashFunctionget_KDF () const =0
 
virtual Botan::XOFget_PRF (std::span< const uint8_t > seed, uint8_t nonce) const =0
 
virtual std::unique_ptr< Botan::XOFget_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.

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

◆ 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.

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

◆ get_G()

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

◆ get_H()

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

◆ get_KDF()

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

◆ get_PRF()

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

◆ 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

◆ 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.

40 {
42 }
T process(const uint8_t in[], size_t length)
Definition buf_comp.h:105
virtual HashFunction & get_H() const =0
Strong< std::vector< uint8_t >, struct KyberHashedCiphertext_ > KyberHashedCiphertext
Definition kyber_types.h:58

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.

37{ return get_H().process<KyberMessage>(m); }
Strong< secure_vector< uint8_t >, struct KyberMessage_ > KyberMessage
Random message value to be encrypted by the CPA-secure Kyber encryption scheme.
Definition kyber_types.h:36

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.

44 {
46 }
Strong< std::vector< uint8_t >, struct KyberHashedPublicKey_ > KyberHashedPublicKey
Definition kyber_types.h:51

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.

60 {
61 auto& kdf = get_KDF();
62 kdf.update(shared_secret);
63 kdf.update(hashed_ciphertext);
64 kdf.final(out);
65 }
virtual HashFunction & get_KDF() const =0

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.

69 {
70 auto bare_seed_span = std::visit([&](const auto s) { return s.get(); }, seed);
71 return get_PRF(bare_seed_span, nonce).output<KyberSamplingRandomness>(outlen);
72 }
virtual Botan::XOF & get_PRF(std::span< const uint8_t > seed, uint8_t nonce) const =0
T output(size_t bytes)
Definition xof.h:155
Strong< secure_vector< uint8_t >, struct KyberSamplingRandomness_ > KyberSamplingRandomness
PRF value used for sampling of error polynomials.
Definition kyber_types.h:42

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.

75 {
76 // TODO: once we remove Kyber 90s, we should make `get_XOF()` return a
77 // reference instead of a unique pointer (for consistency), and
78 // call `get_XOF().copy_state()` here. The AES-CTR XOF doesn't
79 // support this.
80 return get_XOF(seed, matrix_position);
81 }
virtual std::unique_ptr< Botan::XOF > get_XOF(std::span< const uint8_t > seed, std::tuple< uint8_t, uint8_t > matrix_position) const =0

References get_XOF().

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


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