Botan::XMSS_Signature_Operation Class Reference

#include <xmss_signature_operation.h>

Inheritance diagram for Botan::XMSS_Signature_Operation:

Public Member Functions
AlgorithmIdentifier	algorithm_identifier () const override
std::string	hash_function () const override
secure_vector< uint8_t >	sign (RandomNumberGenerator &) override
size_t	signature_length () const override
void	update (const uint8_t msg[], size_t msg_len) override
	XMSS_Signature_Operation (const XMSS_PrivateKey &private_key)

Detailed Description

Signature generation operation for Extended Hash-Based Signatures (XMSS) as defined in:

[1] XMSS: Extended Hash-Based Signatures, Request for Comments: 8391 Release: May 2018. https://datatracker.ietf.org/doc/rfc8391/

Definition at line 28 of file xmss_signature_operation.h.

Constructor & Destructor Documentation

XMSS_Signature_Operation()

Botan::XMSS_Signature_Operation::XMSS_Signature_Operation

(

const XMSS_PrivateKey &

private_key

)

Definition at line 22 of file xmss_signature_operation.cpp.

                                                                                     :
      m_priv_key(private_key),
      m_hash(private_key.xmss_parameters()),
      m_randomness(0),
      m_leaf_idx(0),
      m_is_initialized(false) {}

Member Function Documentation

algorithm_identifier()

AlgorithmIdentifier Botan::XMSS_Signature_Operation::algorithm_identifier ( ) const

overridevirtual

Return an algorithm identifier associated with this signature scheme.

Default implementation throws an exception

Reimplemented from Botan::PK_Ops::Signature.

Definition at line 101 of file xmss_signature_operation.cpp.

                                                                         {
   return AlgorithmIdentifier(OID::from_string("XMSS"), AlgorithmIdentifier::USE_EMPTY_PARAM);
}

References Botan::OID::from_string(), and Botan::AlgorithmIdentifier::USE_EMPTY_PARAM.

hash_function()

std::string Botan::XMSS_Signature_Operation::hash_function ( ) const

inlineoverridevirtual

Return the hash function being used by this signer

Implements Botan::PK_Ops::Signature.

Definition at line 46 of file xmss_signature_operation.h.

{ return m_hash.hash_function(); }

References Botan::XMSS_Hash::hash_function().

sign()

secure_vector< uint8_t > Botan::XMSS_Signature_Operation::sign ( RandomNumberGenerator & )

overridevirtual

Creates an XMSS signature for the message provided through call to update().

Returns

serialized XMSS signature.

Implements Botan::PK_Ops::Signature.

Definition at line 74 of file xmss_signature_operation.cpp.

                                                                              {
   initialize();
   secure_vector<uint8_t> signature(sign(m_hash.h_msg_final(), m_priv_key).bytes());
   m_is_initialized = false;
   return signature;
}

References Botan::XMSS_Hash::h_msg_final(), and sign().

Referenced by sign().

signature_length()

size_t Botan::XMSS_Signature_Operation::signature_length ( ) const

overridevirtual

Return an upper bound on the length of the output signature

Implements Botan::PK_Ops::Signature.

Definition at line 50 of file xmss_signature_operation.cpp.

                                                        {
   const auto& params = m_priv_key.xmss_parameters();
   return sizeof(uint64_t) +  // size of leaf index
          params.element_size() + params.len() * params.element_size() + params.tree_height() * params.element_size();
}

References Botan::XMSS_Parameters::element_size(), and Botan::XMSS_PublicKey::xmss_parameters().

update()

void Botan::XMSS_Signature_Operation::update ( const uint8_t msg[], size_t msg_len )

overridevirtual

Add more data to the message currently being signed

Parameters

msg	the message
msg_len	the length of msg in bytes

Implements Botan::PK_Ops::Signature.

Definition at line 69 of file xmss_signature_operation.cpp.

                                                                         {
   initialize();
   m_hash.h_msg_update({msg, msg_len});
}

References Botan::XMSS_Hash::h_msg_update().

---

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

• src/lib/pubkey/xmss/xmss_signature_operation.h
• src/lib/pubkey/xmss/xmss_signature_operation.cpp