Botan::DilithiumMessageHash Class Reference

#include <dilithium_symmetric_primitives.h>

Inheritance diagram for Botan::DilithiumMessageHash:

Public Member Functions
	DilithiumMessageHash (DilithiumHashedPublicKey tr)
DilithiumMessageRepresentative	final ()
virtual bool	is_valid_user_context (std::span< const uint8_t > user_context) const
std::string	name () const
virtual void	start (std::span< const uint8_t > user_context)
void	update (std::span< const uint8_t > data)
virtual	~DilithiumMessageHash ()

Detailed Description

Wrapper type for the H() function calculating the message representative for the Dilithium signature scheme. This wrapper may be used multiple times.

Namely: mu = H(tr || M)

Definition at line 28 of file dilithium_symmetric_primitives.h.

Constructor & Destructor Documentation

DilithiumMessageHash()

Botan::DilithiumMessageHash::DilithiumMessageHash ( DilithiumHashedPublicKey tr )

explicit

Definition at line 30 of file dilithium_symmetric_primitives.cpp.

                                                                      :
      m_tr(std::move(tr)), m_shake(XOF::create_or_throw("SHAKE-256")) {}

~DilithiumMessageHash()

Botan::DilithiumMessageHash::~DilithiumMessageHash ( )

virtualdefault

Member Function Documentation

final()

DilithiumMessageRepresentative Botan::DilithiumMessageHash::final ( )

inline

Definition at line 53 of file dilithium_symmetric_primitives.h.

                                             {
         ensure_started();
         const scoped_cleanup clean([this]() { clear(); });
         return m_shake->output<DilithiumMessageRepresentative>(DilithiumConstants::MESSAGE_HASH_BYTES);
      }

References Botan::DilithiumConstants::MESSAGE_HASH_BYTES.

is_valid_user_context()

virtual bool Botan::DilithiumMessageHash::is_valid_user_context ( std::span< const uint8_t > user_context ) const

inlinevirtual

Reimplemented in Botan::ML_DSA_MessageHash.

Definition at line 36 of file dilithium_symmetric_primitives.h.

                                                                                    {
         // Only ML-DSA supports user contexts, for all other modes it must be empty.
         return user_context.empty();
      }

Referenced by start().

name()

std::string Botan::DilithiumMessageHash::name

(

)

const

Definition at line 35 of file dilithium_symmetric_primitives.cpp.

                                           {
   return Botan::fmt("{}({})", m_shake->name(), DilithiumConstants::MESSAGE_HASH_BYTES * 8);
}

References Botan::fmt(), and Botan::DilithiumConstants::MESSAGE_HASH_BYTES.

start()

virtual void Botan::DilithiumMessageHash::start ( std::span< const uint8_t > user_context )

inlinevirtual

Reimplemented in Botan::ML_DSA_MessageHash.

Definition at line 41 of file dilithium_symmetric_primitives.h.

                                                              {
         BOTAN_STATE_CHECK(!m_was_started);
         BOTAN_ARG_CHECK(is_valid_user_context(user_context), "Invalid user context");
         m_was_started = true;
         update(m_tr);  // see calculation of mu in FIPS 204, Algorithm 7, line 6
      }

References BOTAN_ARG_CHECK, BOTAN_STATE_CHECK, is_valid_user_context(), and update().

Referenced by Botan::ML_DSA_MessageHash::start().

update()

void Botan::DilithiumMessageHash::update ( std::span< const uint8_t > data )

inline

Definition at line 48 of file dilithium_symmetric_primitives.h.

                                               {
         ensure_started();
         m_shake->update(data);
      }

Referenced by start(), and Botan::ML_DSA_MessageHash::start().

---

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