#include <xmss_address.h>

Public Types
enum class	Key_Mask : uint8_t { Key_Mode = 0 , Mask_Mode = 1 , Mask_MSB_Mode = 1 , Mask_LSB_Mode = 2 }
enum class	Type : uint8_t { None = 255 , OTS_Hash_Address = 0 , LTree_Address = 1 , Hash_Tree_Address = 2 }

Public Member Functions
std::span< const uint8_t >	bytes () const
uint32_t	get_chain_address () const
uint32_t	get_hash_address () const
Key_Mask	get_key_mask_mode () const
uint8_t	get_layer_addr () const
uint32_t	get_ltree_address () const
uint32_t	get_ots_address () const
uint64_t	get_tree_addr () const
uint32_t	get_tree_height () const
uint32_t	get_tree_index () const
Type	get_type () const
XMSS_Address &	operator= (const XMSS_Address &other)=default
XMSS_Address &	operator= (XMSS_Address &&other)=default
void	set_chain_address (uint32_t value)
void	set_hash_address (uint32_t value)
void	set_key_mask_mode (Key_Mask value)
void	set_layer_addr ()
void	set_ltree_address (uint32_t value)
void	set_ots_address (uint32_t value)
void	set_tree_addr ()
void	set_tree_height (uint32_t value)
void	set_tree_index (uint32_t value)
void	set_type (Type type)
size_t	size () const
	XMSS_Address ()
	XMSS_Address (const XMSS_Address &other)=default
	XMSS_Address (Type type)
	XMSS_Address (XMSS_Address &&other)=default
	~XMSS_Address ()=default

Detailed Description

Generic XMSS Address type holding 256 Bits of data. Properties of all three address formats L-Tree-Address, Hash-Tree-Address, OTS-Hash-Address can be called depending on the type currently assigned to the XMSS address using set_type().

Definition at line 25 of file xmss_address.h.

Member Enumeration Documentation

◆ Key_Mask

enum class Botan::XMSS_Address::Key_Mask : uint8_t

strong

The available modes for an XMSS Address:

Key_Mode: Used to generate the key.
Mask_Mode: Sets the n-byte bitmask (OTS-Hash-Address)
Mask_MSB_Mode: Used to generate the b most significant bytes of the 2n-byte bitmask (LTree Address and Hash Tree Address).
Mask_LSB_Mode: Used to generated the b least significant bytes of the 2n-byte bitmask. (LTree Address and Hash Tree Address).

Enumerator
Key_Mode
Mask_Mode
Mask_MSB_Mode
Mask_LSB_Mode

Definition at line 42 of file xmss_address.h.

42: uint8_t { Key_Mode = 0, Mask_Mode = 1, Mask_MSB_Mode = 1, Mask_LSB_Mode = 2 };

◆ Type

enum class Botan::XMSS_Address::Type : uint8_t

strong

Distinct types an XMSS_Address can represent. The available types are specified in [1] - 2.5 Hash Function Address Scheme.

Enumerator
None
OTS_Hash_Address
LTree_Address
Hash_Tree_Address

Definition at line 31 of file xmss_address.h.

31: uint8_t { None = 255, OTS_Hash_Address = 0, LTree_Address = 1, Hash_Tree_Address = 2 };

Botan::PKCS11::Flag::None

@ None

Definition p11.h:302

Constructor & Destructor Documentation

◆ XMSS_Address() [1/4]

Botan::XMSS_Address::XMSS_Address ( )

inline

Definition at line 289 of file xmss_address.h.

289: m_data{} { set_type(Type::None); }

Botan::XMSS_Address::Type::None

@ None

Definition xmss_address.h:31

Botan::XMSS_Address::set_type

void set_type(Type type)

Definition xmss_address.h:93

References None, and set_type().

Referenced by operator=(), operator=(), XMSS_Address(), and XMSS_Address().

◆ ~XMSS_Address()

Botan::XMSS_Address::~XMSS_Address ( )

default

◆ XMSS_Address() [2/4]

Botan::XMSS_Address::XMSS_Address ( const XMSS_Address & other )

default

References XMSS_Address().

◆ XMSS_Address() [3/4]

Botan::XMSS_Address::XMSS_Address ( XMSS_Address && other )

default

References XMSS_Address().

◆ XMSS_Address() [4/4]

Botan::XMSS_Address::XMSS_Address ( Type type )

inlineexplicit

Definition at line 298 of file xmss_address.h.

298: m_data() { set_type(type); }

References set_type().

Member Function Documentation

◆ bytes()

std::span< const uint8_t > Botan::XMSS_Address::bytes ( ) const

inline

Definition at line 282 of file xmss_address.h.

282{ return std::span{m_data}; }

Referenced by Botan::XMSS_Common_Ops::randomize_tree_hash(), and Botan::XMSS_WOTS_PrivateKey::XMSS_WOTS_PrivateKey().

◆ get_chain_address()

uint32_t Botan::XMSS_Address::get_chain_address ( ) const

inline

Retrieve the chain address. A call to this method is only valid, if the address type is set to Type::OTS_Hash_Address.

Returns: chain address.

Definition at line 180 of file xmss_address.h.

                                         {
         BOTAN_ASSERT(get_type() == Type::OTS_Hash_Address,
                      "get_chain_address() requires XMSS_Address::Type::"
                      "OTS_Hash_Address.");
         return get_lo32(2);
      }

References BOTAN_ASSERT, get_type(), and OTS_Hash_Address.

◆ get_hash_address()

uint32_t Botan::XMSS_Address::get_hash_address ( ) const

inline

Retrieves the address of the hash function call within the chain. A call to this method is only valid, if the address type is set to Type::OTS_Hash_Address.

Returns: address of the hash function call within chain.

Definition at line 233 of file xmss_address.h.

                                        {
         BOTAN_ASSERT(get_type() == Type::OTS_Hash_Address,
                      "get_hash_address() requires XMSS_Address::Type::"
                      "OTS_Hash_Address.");
         return get_hi32(3);
      }

References BOTAN_ASSERT, get_type(), and OTS_Hash_Address.

◆ get_key_mask_mode()

Key_Mask Botan::XMSS_Address::get_key_mask_mode ( ) const

inline

Retrieves the mode the address is currently set to. (See XMSS_Address::Key_Mask for details.)

Returns: currently active mode

Definition at line 104 of file xmss_address.h.

104{ return Key_Mask(m_data[31]); }

Botan::XMSS_Address::Key_Mask

Key_Mask

Definition xmss_address.h:42

◆ get_layer_addr()

uint8_t Botan::XMSS_Address::get_layer_addr ( ) const

inline

Layer Address for XMSS is constantly zero and can not be changed this property is only of relevance to XMSS_MT.

Returns: Layer address, which is constant 0 for XMSS.

Definition at line 50 of file xmss_address.h.

50{ return 0; }

◆ get_ltree_address()

uint32_t Botan::XMSS_Address::get_ltree_address ( ) const

inline

Retrieves the index of the leaf computed with this LTree. A call to this method is only valid, if the address type is set to Type::LTree_Address.

Returns: index of the leaf.

Definition at line 153 of file xmss_address.h.

                                         {
         BOTAN_ASSERT(get_type() == Type::LTree_Address,
                      "set_ltree_address() requires XMSS_Address::Type::"
                      "LTree_Address.");
         return get_hi32(2);
      }

References BOTAN_ASSERT, get_type(), and LTree_Address.

◆ get_ots_address()

uint32_t Botan::XMSS_Address::get_ots_address ( ) const

inline

Retrieve the index of the OTS key pair within the tree. A call to this method is only valid, if the address type is set to Type::OTS_Hash_Address.

Returns: index of OTS key pair.

Definition at line 125 of file xmss_address.h.

                                       {
         BOTAN_ASSERT(get_type() == Type::OTS_Hash_Address,
                      "get_ots_address() requires XMSS_Address::Type::"
                      "OTS_Hash_Address.");
         return get_hi32(2);
      }

References BOTAN_ASSERT, get_type(), and OTS_Hash_Address.

◆ get_tree_addr()

uint64_t Botan::XMSS_Address::get_tree_addr ( ) const

inline

Tree Address for XMSS is constantly zero and can not be changed this property is only of relevance to XMSS_MT.

Returns: Tree address, which is constant 0 for XMSS.

Definition at line 65 of file xmss_address.h.

65{ return 0; }

◆ get_tree_height()

uint32_t Botan::XMSS_Address::get_tree_height ( ) const

inline

Retrieves the height of the tree node to be computed within the tree. A call to this method is only valid, if the address type is set to Type::LTree_Address or Type::Hash_Tree_Address.

Returns: height of the tree node.

Definition at line 205 of file xmss_address.h.

                                       {
         BOTAN_ASSERT(get_type() == Type::LTree_Address || get_type() == Type::Hash_Tree_Address,
                      "get_tree_height() requires XMSS_Address::Type::"
                      "LTree_Address or XMSS_Address::Type::Hash_Tree_Address.");
         return get_lo32(2);
      }

References BOTAN_ASSERT, get_type(), Hash_Tree_Address, and LTree_Address.

Referenced by Botan::XMSS_Common_Ops::create_l_tree().

◆ get_tree_index()

uint32_t Botan::XMSS_Address::get_tree_index ( ) const

inline

Retrieves the index of the tree node at current tree height in the tree. A call to this method is only valid, if the address type is set to Type::LTree_Address or Type::Hash_Tree_Address.

Returns: index of the tree node at current height.

Definition at line 261 of file xmss_address.h.

                                      {
         BOTAN_ASSERT(get_type() == Type::LTree_Address || get_type() == Type::Hash_Tree_Address,
                      "get_tree_index() requires XMSS_Address::Type::"
                      "LTree_Address or XMSS_Address::Type::Hash_Tree_Address.");
         return get_hi32(3);
      }

References BOTAN_ASSERT, get_type(), Hash_Tree_Address, and LTree_Address.

◆ get_type()

Type Botan::XMSS_Address::get_type ( ) const

inline

retrieves the logical type currently assigned to the XMSS Address instance.

Returns: Type of the address (OTS_Hash_Address, LTree_Address or Hash_Tree_Address)

Definition at line 81 of file xmss_address.h.

81{ return static_cast<Type>(m_data[15]); }

Botan::XMSS_Address::Type

Type

Definition xmss_address.h:31

Referenced by get_chain_address(), get_hash_address(), get_ltree_address(), get_ots_address(), get_tree_height(), get_tree_index(), set_chain_address(), set_hash_address(), set_key_mask_mode(), set_ltree_address(), set_ots_address(), set_tree_height(), and set_tree_index().

◆ operator=() [1/2]

XMSS_Address & Botan::XMSS_Address::operator= ( const XMSS_Address & other )

default

References XMSS_Address().

◆ operator=() [2/2]

XMSS_Address & Botan::XMSS_Address::operator= ( XMSS_Address && other )

default

References XMSS_Address().

◆ set_chain_address()

void Botan::XMSS_Address::set_chain_address ( uint32_t value )

inline

Set the chain address. A call to this method is only valid, if the address type is set to Type::OTS_Hash_Address.

Definition at line 191 of file xmss_address.h.

                                             {
         BOTAN_ASSERT(get_type() == Type::OTS_Hash_Address,
                      "set_chain_address() requires XMSS_Address::Type::"
                      "OTS_Hash_Address.");
         set_lo32(2, value);
      }

References BOTAN_ASSERT, get_type(), and OTS_Hash_Address.

Referenced by Botan::XMSS_WOTS_PrivateKey::sign(), Botan::XMSS_WOTS_PublicKey::XMSS_WOTS_PublicKey(), and Botan::XMSS_WOTS_PublicKey::XMSS_WOTS_PublicKey().

◆ set_hash_address()

void Botan::XMSS_Address::set_hash_address ( uint32_t value )

inline

Sets the address of the hash function call within the chain. A call to this method is only valid, if the address type is set to Type::OTS_Hash_Address.

Parameters

value address of the hash function call within chain.

Definition at line 247 of file xmss_address.h.

                                            {
         BOTAN_ASSERT(get_type() == Type::OTS_Hash_Address,
                      "set_hash_address() requires XMSS_Address::Type::"
                      "OTS_Hash_Address.");
         set_hi32(3, value);
      }

References BOTAN_ASSERT, get_type(), and OTS_Hash_Address.

◆ set_key_mask_mode()

void Botan::XMSS_Address::set_key_mask_mode ( Key_Mask value )

inline

Changes the mode the address currently used address mode. (XMSS_Address::Key_Mask for details.)

Parameters

value Target mode.

Definition at line 112 of file xmss_address.h.

                                             {
         BOTAN_ASSERT(value != Key_Mask::Mask_LSB_Mode || get_type() != Type::OTS_Hash_Address,
                      "Invalid Key_Mask for current XMSS_Address::Type.");
         m_data[31] = static_cast<uint8_t>(value);
      }

References BOTAN_ASSERT, get_type(), Mask_LSB_Mode, and OTS_Hash_Address.

Referenced by Botan::XMSS_Common_Ops::randomize_tree_hash().

◆ set_layer_addr()

void Botan::XMSS_Address::set_layer_addr ( )

inline

Layer Address for XMSS is constantly zero and can not be changed this property is only of relevance to XMSS_MT. Calling this method for XMSS will result in an error.

Definition at line 57 of file xmss_address.h.

57{ BOTAN_ASSERT(false, "Only available in XMSS_MT."); }

References BOTAN_ASSERT.

◆ set_ltree_address()

void Botan::XMSS_Address::set_ltree_address ( uint32_t value )

inline

Sets the index of the leaf computed with this LTree. A call to this method is only valid, if the address type is set to Type::LTree_Address.

Parameters

value index of the leaf.

Definition at line 167 of file xmss_address.h.

                                             {
         BOTAN_ASSERT(get_type() == Type::LTree_Address,
                      "set_ltree_address() requires XMSS_Address::Type::"
                      "LTree_Address.");
         set_hi32(2, value);
      }

References BOTAN_ASSERT, get_type(), and LTree_Address.

◆ set_ots_address()

void Botan::XMSS_Address::set_ots_address ( uint32_t value )

inline

Sets the index of the OTS key pair within the tree. A call to this method is only valid, if the address type is set to Type::OTS_Hash_Address.

Parameters

value index of OTS key pair.

Definition at line 139 of file xmss_address.h.

                                           {
         BOTAN_ASSERT(get_type() == Type::OTS_Hash_Address,
                      "set_ots_address() requires XMSS_Address::Type::"
                      "OTS_Hash_Address.");
         set_hi32(2, value);
      }

References BOTAN_ASSERT, get_type(), and OTS_Hash_Address.

Referenced by Botan::XMSS_Signature_Operation::sign().

◆ set_tree_addr()

void Botan::XMSS_Address::set_tree_addr ( )

inline

Tree Address for XMSS is constantly zero and can not be changed this property is only of relevance to XMSS_MT. Calling this method for XMSS will result in an error.

Definition at line 72 of file xmss_address.h.

72{ BOTAN_ASSERT(false, "Only available in XMSS_MT."); }

References BOTAN_ASSERT.

◆ set_tree_height()

void Botan::XMSS_Address::set_tree_height ( uint32_t value )

inline

Sets the height of the tree node to be computed within the tree. A call to this method is only valid, if the address type is set to Type::LTree_Address or Type::Hash_Tree_Address.

Parameters

value height of the tree node.

Definition at line 219 of file xmss_address.h.

                                           {
         BOTAN_ASSERT(get_type() == Type::LTree_Address || get_type() == Type::Hash_Tree_Address,
                      "set_tree_height() requires XMSS_Address::Type::"
                      "LTree_Address or XMSS_Address::Type::Hash_Tree_Address.");
         set_lo32(2, value);
      }

References BOTAN_ASSERT, get_type(), Hash_Tree_Address, and LTree_Address.

Referenced by Botan::XMSS_Common_Ops::create_l_tree().

◆ set_tree_index()

void Botan::XMSS_Address::set_tree_index ( uint32_t value )

inline

Sets the index of the tree node at current tree height in the tree. A call to this method is only valid, if the address type is set to Type::LTree_Address or Type::Hash_Tree_Address.

Parameters

value index of the tree node at current height.

Definition at line 275 of file xmss_address.h.

                                          {
         BOTAN_ASSERT(get_type() == Type::LTree_Address || get_type() == Type::Hash_Tree_Address,
                      "set_tree_index() requires XMSS_Address::Type::"
                      "LTree_Address or XMSS_Address::Type::Hash_Tree_Address.");
         set_hi32(3, value);
      }

References BOTAN_ASSERT, get_type(), Hash_Tree_Address, and LTree_Address.

Referenced by Botan::XMSS_Common_Ops::create_l_tree().

◆ set_type()

void Botan::XMSS_Address::set_type ( Type type )

inline

Changes the logical type currently assigned to the XMSS Address instance. Please note that changing the type will automatically reset the 128 LSBs of the Address to zero. This affects the key_mask_mode property as well as all properties identified by XMSS_Address::Property.

Parameters

type	Type that shall be assigned to the address (OTS_Hash_Address, LTree_Address or Hash_Tree_Address)

Definition at line 93 of file xmss_address.h.

                               {
         m_data[15] = static_cast<uint8_t>(type);
         std::fill(m_data.begin() + 16, m_data.end(), static_cast<uint8_t>(0));
      }

Referenced by Botan::XMSS_Signature_Operation::sign(), XMSS_Address(), and XMSS_Address().

◆ size()

size_t Botan::XMSS_Address::size ( ) const

inline

Returns: the size of an XMSS_Address

Definition at line 287 of file xmss_address.h.

287{ return m_data.size(); }

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

src/lib/pubkey/xmss/xmss_address.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Key_Mask

◆ Type

Constructor & Destructor Documentation

◆ XMSS_Address() [1/4]

◆ ~XMSS_Address()

◆ XMSS_Address() [2/4]

◆ XMSS_Address() [3/4]

◆ XMSS_Address() [4/4]

Member Function Documentation

◆ bytes()

◆ get_chain_address()

◆ get_hash_address()

◆ get_key_mask_mode()

◆ get_layer_addr()

◆ get_ltree_address()

◆ get_ots_address()

◆ get_tree_addr()

◆ get_tree_height()

◆ get_tree_index()

◆ get_type()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ set_chain_address()

◆ set_hash_address()

◆ set_key_mask_mode()

◆ set_layer_addr()

◆ set_ltree_address()

◆ set_ots_address()

◆ set_tree_addr()

◆ set_tree_height()

◆ set_tree_index()

◆ set_type()

◆ size()