Botan::Dilithium_Symmetric_Primitives Class Reference

#include <dilithium_symmetric_primitives.h>

Inheritance diagram for Botan::Dilithium_Symmetric_Primitives:

Public Types
enum class	XofType { k128 , k256 }

Public Member Functions
secure_vector< uint8_t >	CRH (std::span< const uint8_t > in, size_t out_len) const
secure_vector< uint8_t >	ExpandMask (std::span< const uint8_t > seed, uint16_t nonce, size_t out_len) const
secure_vector< uint8_t >	H (std::span< const uint8_t > seed, size_t out_len) const
virtual std::unique_ptr< Botan::XOF >	XOF (XofType type, std::span< const uint8_t > seed, uint16_t nonce) const =0
virtual	~Dilithium_Symmetric_Primitives ()=default

Static Public Member Functions
static std::unique_ptr< Dilithium_Symmetric_Primitives >	create (DilithiumMode mode)

Detailed Description

Adapter class that uses polymorphy to distinguish Dilithium "common" from Dilithium "AES" modes.

Definition at line 28 of file dilithium_symmetric_primitives.h.

Member Enumeration Documentation

XofType

enum class Botan::Dilithium_Symmetric_Primitives::XofType

strong

Enumerator
k128
k256

Definition at line 30 of file dilithium_symmetric_primitives.h.

{ k128, k256 };

Constructor & Destructor Documentation

~Dilithium_Symmetric_Primitives()

virtual Botan::Dilithium_Symmetric_Primitives::~Dilithium_Symmetric_Primitives ( )

virtualdefault

Member Function Documentation

create()

std::unique_ptr< Dilithium_Symmetric_Primitives > Botan::Dilithium_Symmetric_Primitives::create ( DilithiumMode mode )

static

Definition at line 22 of file dilithium_symmetric_primitives.cpp.

                                                                                                       {
#if BOTAN_HAS_DILITHIUM
   if(mode.is_modern()) {
      return std::make_unique<Dilithium_Common_Symmetric_Primitives>();
   }
#endif
 
#if BOTAN_HAS_DILITHIUM_AES
   if(mode.is_aes()) {
      return std::make_unique<Dilithium_AES_Symmetric_Primitives>();
   }
#endif
 
   throw Not_Implemented("requested Dilithium mode is not enabled in this build");
}

References Botan::DilithiumMode::is_aes(), and Botan::DilithiumMode::is_modern().

CRH()

secure_vector< uint8_t > Botan::Dilithium_Symmetric_Primitives::CRH ( std::span< const uint8_t > in, size_t out_len ) const

inline

Definition at line 43 of file dilithium_symmetric_primitives.h.

                                                                                  {
         return SHAKE_256(out_len * 8).process(in.data(), in.size());
      }

References Botan::Buffered_Computation::process().

ExpandMask()

secure_vector< uint8_t > Botan::Dilithium_Symmetric_Primitives::ExpandMask ( std::span< const uint8_t > seed, uint16_t nonce, size_t out_len ) const

inline

Definition at line 48 of file dilithium_symmetric_primitives.h.

                                                                                                           {
         return XOF(XofType::k256, seed, nonce)->output(out_len);
      }

References k256, and XOF().

H()

secure_vector< uint8_t > Botan::Dilithium_Symmetric_Primitives::H ( std::span< const uint8_t > seed, size_t out_len ) const

inline

Definition at line 38 of file dilithium_symmetric_primitives.h.

                                                                                  {
         return SHAKE_256(out_len * 8).process(seed.data(), seed.size());
      }

References Botan::Buffered_Computation::process().

XOF()

virtual std::unique_ptr< Botan::XOF > Botan::Dilithium_Symmetric_Primitives::XOF ( XofType type, std::span< const uint8_t > seed, uint16_t nonce ) const

pure virtual

Implemented in Botan::Dilithium_Common_Symmetric_Primitives, and Botan::Dilithium_AES_Symmetric_Primitives.

Referenced by ExpandMask().

---

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

• src/lib/pubkey/dilithium/dilithium_common/dilithium_symmetric_primitives.h
• src/lib/pubkey/dilithium/dilithium_common/dilithium_symmetric_primitives.cpp