#include <sp_address.h>

Public Member Functions
Sphincs_Address &	copy_keypair_from (const Sphincs_Address other)
Sphincs_Address &	copy_subtree_from (const Sphincs_Address &other)
Sphincs_Address_Type	get_type () const
Sphincs_Address &	set_chain_address (WotsChainIndex chain)
Sphincs_Address &	set_hash_address (WotsHashIndex hash)
Sphincs_Address &	set_keypair_address (TreeNodeIndex keypair)
Sphincs_Address &	set_layer_address (HypertreeLayerIndex layer)
Sphincs_Address &	set_tree_address (XmssTreeIndexInLayer tree)
Sphincs_Address &	set_tree_height (TreeLayerIndex tree_height)
Sphincs_Address &	set_tree_index (TreeNodeIndex tree_index)
Sphincs_Address &	set_type (Sphincs_Address_Type type)
	Sphincs_Address (Sphincs_Address_Type type)
	Sphincs_Address (std::array< uint32_t, 8 > address)
std::array< uint8_t, 32 >	to_bytes () const
std::array< uint8_t, 22 >	to_bytes_compressed () const

Static Public Member Functions
static Sphincs_Address	as_keypair_from (const Sphincs_Address &other)
static Sphincs_Address	as_subtree_from (const Sphincs_Address &other)

Detailed Description

Representation of a SLH-DSA hash function address as specified in FIPS 205, Section 4.2

Definition at line 34 of file sp_address.h.

Constructor & Destructor Documentation

◆ Sphincs_Address() [1/2]

Botan::Sphincs_Address::Sphincs_Address ( Sphincs_Address_Type type )

inlineexplicit

Definition at line 49 of file sp_address.h.

49: m_address{} { set_type(type); }

Botan::Sphincs_Address::set_type

Sphincs_Address & set_type(Sphincs_Address_Type type)

Definition sp_address.h:73

References set_type().

Referenced by as_keypair_from(), as_subtree_from(), copy_keypair_from(), copy_subtree_from(), set_chain_address(), set_hash_address(), set_keypair_address(), set_layer_address(), set_tree_address(), set_tree_height(), set_tree_index(), and set_type().

◆ Sphincs_Address() [2/2]

Botan::Sphincs_Address::Sphincs_Address ( std::array< uint32_t, 8 > address )

inlineexplicit

Definition at line 51 of file sp_address.h.

                                                              : m_address{} {
         std::copy(address.begin(), address.end(), m_address.begin());
      }

Member Function Documentation

◆ as_keypair_from()

Sphincs_Address Botan::Sphincs_Address::as_keypair_from ( const Sphincs_Address & other )

inlinestatic

Definition at line 130 of file sp_address.h.

                                                                           {
         Sphincs_Address result({0, 0, 0, 0, 0, 0, 0, 0});
         result.copy_keypair_from(other);
         return result;
      }

References Sphincs_Address().

Referenced by Botan::fors_public_key_from_signature(), and Botan::fors_sign_and_pkgen().

◆ as_subtree_from()

Sphincs_Address Botan::Sphincs_Address::as_subtree_from ( const Sphincs_Address & other )

inlinestatic

Definition at line 114 of file sp_address.h.

                                                                           {
         auto result = Sphincs_Address({0, 0, 0, 0, 0, 0, 0, 0});
         result.copy_subtree_from(other);
         return result;
      }

References Sphincs_Address().

Referenced by Botan::xmss_sign_and_pkgen().

◆ copy_keypair_from()

Sphincs_Address & Botan::Sphincs_Address::copy_keypair_from ( const Sphincs_Address other )

inline

Definition at line 120 of file sp_address.h.

                                                                      {
         m_address[layer_offset] = other.m_address[layer_offset];
         m_address[tree_offset + 0] = other.m_address[tree_offset + 0];
         m_address[tree_offset + 1] = other.m_address[tree_offset + 1];
         m_address[tree_offset + 2] = other.m_address[tree_offset + 2];
         m_address[keypair_offset] = other.m_address[keypair_offset];
 
         return *this;
      }

References Sphincs_Address().

Referenced by Botan::ht_verify().

◆ copy_subtree_from()

Sphincs_Address & Botan::Sphincs_Address::copy_subtree_from ( const Sphincs_Address & other )

inline

Definition at line 105 of file sp_address.h.

                                                                       {
         m_address[layer_offset] = other.m_address[layer_offset];
         m_address[tree_offset + 0] = other.m_address[tree_offset + 0];
         m_address[tree_offset + 1] = other.m_address[tree_offset + 1];
         m_address[tree_offset + 2] = other.m_address[tree_offset + 2];
 
         return *this;
      }

References Sphincs_Address().

Referenced by Botan::ht_sign(), and Botan::ht_verify().

◆ get_type()

Sphincs_Address_Type Botan::Sphincs_Address::get_type ( ) const

inline

Definition at line 136 of file sp_address.h.

136{ return Sphincs_Address_Type(m_address[type_offset]); }

Botan::Sphincs_Address_Type

Sphincs_Address_Type

Definition sp_address.h:20

Referenced by Botan::wots_sign_and_pkgen(), and Botan::xmss_sign_and_pkgen().

◆ set_chain_address()

Sphincs_Address & Botan::Sphincs_Address::set_chain_address ( WotsChainIndex chain )

inline

Definition at line 83 of file sp_address.h.

                                                               {
         m_address[chain_offset] = chain.get();
         return *this;
      }

References Botan::detail::Strong_Base< T >::get(), and Sphincs_Address().

Referenced by Botan::wots_public_key_from_signature(), and Botan::wots_sign_and_pkgen().

◆ set_hash_address()

Sphincs_Address & Botan::Sphincs_Address::set_hash_address ( WotsHashIndex hash )

inline

Definition at line 93 of file sp_address.h.

                                                            {
         m_address[hash_offset] = hash.get();
         return *this;
      }

References Botan::detail::Strong_Base< T >::get(), and Sphincs_Address().

Referenced by Botan::wots_sign_and_pkgen().

◆ set_keypair_address()

Sphincs_Address & Botan::Sphincs_Address::set_keypair_address ( TreeNodeIndex keypair )

inline

Definition at line 78 of file sp_address.h.

                                                                  {
         m_address[keypair_offset] = keypair.get();
         return *this;
      }

References Botan::detail::Strong_Base< T >::get(), and Sphincs_Address().

Referenced by Botan::ht_sign(), Botan::ht_verify(), and Botan::wots_sign_and_pkgen().

◆ set_layer_address()

Sphincs_Address & Botan::Sphincs_Address::set_layer_address ( HypertreeLayerIndex layer )

inline

Definition at line 57 of file sp_address.h.

                                                                    {
         m_address[layer_offset] = layer.get();
         return *this;
      }

References Botan::detail::Strong_Base< T >::get(), and Sphincs_Address().

Referenced by Botan::ht_sign(), Botan::ht_verify(), and Botan::xmss_gen_root().

◆ set_tree_address()

Sphincs_Address & Botan::Sphincs_Address::set_tree_address ( XmssTreeIndexInLayer tree )

inline

Definition at line 62 of file sp_address.h.

                                                                   {
         m_address[tree_offset + 0] = 0;  // not required by all current instances
         m_address[tree_offset + 1] = static_cast<uint32_t>(tree.get() >> 32);
         m_address[tree_offset + 2] = static_cast<uint32_t>(tree.get());
         return *this;
      }

References Botan::detail::Strong_Base< T >::get(), and Sphincs_Address().

Referenced by Botan::ht_sign(), and Botan::ht_verify().

◆ set_tree_height()

Sphincs_Address & Botan::Sphincs_Address::set_tree_height ( TreeLayerIndex tree_height )

inline

Definition at line 88 of file sp_address.h.

                                                                   {
         m_address[tree_height_offset] = tree_height.get();
         return *this;
      }

References Botan::detail::Strong_Base< T >::get(), and Sphincs_Address().

Referenced by Botan::compute_root(), and Botan::treehash().

◆ set_tree_index()

Sphincs_Address & Botan::Sphincs_Address::set_tree_index ( TreeNodeIndex tree_index )

inline

Definition at line 98 of file sp_address.h.

                                                                {
         m_address[tree_index_offset] = tree_index.get();
         return *this;
      }

References Botan::detail::Strong_Base< T >::get(), and Sphincs_Address().

Referenced by Botan::compute_root(), and Botan::treehash().

◆ set_type()

Sphincs_Address & Botan::Sphincs_Address::set_type ( Sphincs_Address_Type type )

inline

Definition at line 73 of file sp_address.h.

                                                           {
         m_address[type_offset] = static_cast<uint32_t>(type);
         return *this;
      }

References Sphincs_Address().

Referenced by Botan::fors_public_key_from_signature(), Botan::fors_sign_and_pkgen(), Sphincs_Address(), Botan::wots_sign_and_pkgen(), and Botan::xmss_sign_and_pkgen().

◆ to_bytes()

std::array< uint8_t, 32 > Botan::Sphincs_Address::to_bytes ( ) const

inline

Definition at line 138 of file sp_address.h.

                                             {
         std::array<uint8_t, sizeof(m_address)> result{};
         for(unsigned int i = 0; i < m_address.size(); ++i) {
            store_be(m_address[i], result.data() + (i * 4));
         }
         return result;
      }

References Botan::store_be().

◆ to_bytes_compressed()

std::array< uint8_t, 22 > Botan::Sphincs_Address::to_bytes_compressed ( ) const

inline

Definition at line 146 of file sp_address.h.

                                                        {
         std::array<uint8_t, 22> result{};
 
         result[0] = static_cast<uint8_t>(m_address[layer_offset]);
         store_be(m_address[tree_offset + 1], &result[1]);
         store_be(m_address[tree_offset + 2], &result[5]);
         result[9] = static_cast<uint8_t>(m_address[type_offset]);
         store_be(m_address[keypair_offset], &result[10]);
         store_be(m_address[chain_offset], &result[14]);
         store_be(m_address[hash_offset], &result[18]);
 
         return result;
      }

References Botan::store_be().

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

src/lib/pubkey/sphincsplus/sphincsplus_common/sp_address.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Sphincs_Address() [1/2]

◆ Sphincs_Address() [2/2]

Member Function Documentation

◆ as_keypair_from()

◆ as_subtree_from()

◆ copy_keypair_from()

◆ copy_subtree_from()

◆ get_type()

◆ set_chain_address()

◆ set_hash_address()

◆ set_keypair_address()

◆ set_layer_address()

◆ set_tree_address()

◆ set_tree_height()

◆ set_tree_index()

◆ set_type()

◆ to_bytes()

◆ to_bytes_compressed()