Botan::Dilithium_Common_Symmetric_Primitives Class Reference

#include <dilithium_modern.h>

Inheritance diagram for Botan::Dilithium_Common_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
std::unique_ptr< Botan::XOF >	XOF (XofType type, std::span< const uint8_t > seed, uint16_t nonce) const override

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

Detailed Description

Definition at line 24 of file dilithium_modern.h.

Member Enumeration Documentation

XofType

enum class Botan::Dilithium_Symmetric_Primitives::XofType

stronginherited

Enumerator
k128
k256

Definition at line 30 of file dilithium_symmetric_primitives.h.

{ k128, k256 };

Member Function Documentation

create()

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

staticinherited

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

inlineinherited

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

inlineinherited

Definition at line 48 of file dilithium_symmetric_primitives.h.

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

References Botan::Dilithium_Symmetric_Primitives::k256, and Botan::Dilithium_Symmetric_Primitives::XOF().

H()

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

inlineinherited

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()

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

inlineoverridevirtual

Implements Botan::Dilithium_Symmetric_Primitives.

Definition at line 26 of file dilithium_modern.h.

                                                                                                            {
         const auto xof_type = [&] {
            switch(type) {
               case XofType::k128:
                  return "SHAKE-128";
               case XofType::k256:
                  return "SHAKE-256";
            }
 
            BOTAN_ASSERT_UNREACHABLE();
         }();
 
         std::array<uint8_t, sizeof(nonce)> nonce_buffer;
         store_le(nonce, nonce_buffer.data());
 
         auto xof = Botan::XOF::create_or_throw(xof_type);
         xof->update(seed);
         xof->update(nonce_buffer);
         return xof;
      }

References BOTAN_ASSERT_UNREACHABLE, Botan::XOF::create_or_throw(), Botan::Dilithium_Symmetric_Primitives::k128, Botan::Dilithium_Symmetric_Primitives::k256, and Botan::store_le().

---

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

• src/lib/pubkey/dilithium/dilithium/dilithium_modern.h