Botan::ML_DSA_MessageHash Class Reference

#include <ml_dsa_impl.h>

Inheritance diagram for Botan::ML_DSA_MessageHash:

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

Detailed Description

Definition at line 28 of file ml_dsa_impl.h.

Member Function Documentation

DilithiumMessageHash()

Botan::DilithiumMessageHash::DilithiumMessageHash ( DilithiumHashedPublicKey tr )

inlineexplicit

Definition at line 33 of file dilithium_symmetric_primitives.h.

: m_tr(std::move(tr)) {}

final()

DilithiumMessageRepresentative Botan::DilithiumMessageHash::final ( )

inlineinherited

Definition at line 58 of file dilithium_symmetric_primitives.h.

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

References Botan::DilithiumConstants::MESSAGE_HASH_BYTES.

is_valid_user_context()

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

inlinefinalvirtual

Reimplemented from Botan::DilithiumMessageHash.

Definition at line 32 of file ml_dsa_impl.h.

                                                                                  {
         return user_context.size() <= 255;
      }

name()

std::string Botan::DilithiumMessageHash::name ( ) const

inlineinherited

Definition at line 37 of file dilithium_symmetric_primitives.h.

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

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

start()

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

inlinefinalvirtual

Reimplemented from Botan::DilithiumMessageHash.

Definition at line 36 of file ml_dsa_impl.h.

                                                            {
         // ML-DSA introduced an application-specific context string that is
         // empty by default and can be set by the application.
         //
         // In HashML-DSA, there's an additional domain information, namely
         // the serialized OID of the hash function used to hash the message.
         //
         // See FIPS 204, Algorithm 2, line 10 and Algorithm 7, line 6, and
         // FIPS 204, Section 5.4
 
         DilithiumMessageHash::start(user_context);
         constexpr uint8_t domain_separator = 0x00;  // HashML-DSA would use 0x01
         const uint8_t context_length = checked_cast_to<uint8_t>(user_context.size());
         update(std::array{domain_separator, context_length});
         update(user_context);
      }

References Botan::checked_cast_to(), Botan::DilithiumMessageHash::start(), and Botan::DilithiumMessageHash::update().

update()

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

inlineinherited

Definition at line 53 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 file:

• src/lib/pubkey/dilithium/ml_dsa/ml_dsa_impl.h