Botan 3.7.1
Crypto and TLS for C&
|
#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 | |
secure_vector< uint8_t > & | bytes () |
const secure_vector< 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 |
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 (secure_vector< uint8_t > data) | |
XMSS_Address (Type type) | |
Protected Attributes | |
secure_vector< uint8_t > | m_data |
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 23 of file xmss_address.h.
|
strong |
The available modes for an XMSS Address:
Enumerator | |
---|---|
Key_Mode | |
Mask_Mode | |
Mask_MSB_Mode | |
Mask_LSB_Mode |
Definition at line 40 of file xmss_address.h.
|
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 29 of file xmss_address.h.
|
inline |
|
inline |
Definition at line 291 of file xmss_address.h.
References set_type().
|
inline |
Definition at line 293 of file xmss_address.h.
References BOTAN_ASSERT, and m_data.
|
inline |
|
inline |
Definition at line 280 of file xmss_address.h.
References m_data.
Referenced by Botan::XMSS_Common_Ops::randomize_tree_hash(), and Botan::XMSS_WOTS_PrivateKey::XMSS_WOTS_PrivateKey().
|
inline |
Retrieve 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 178 of file xmss_address.h.
References BOTAN_ASSERT, get_type(), and OTS_Hash_Address.
|
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.
Definition at line 231 of file xmss_address.h.
References BOTAN_ASSERT, get_type(), and OTS_Hash_Address.
|
inline |
Retrieves the mode the address is currently set to. (See XMSS_Address::Key_Mask for details.)
Definition at line 102 of file xmss_address.h.
References m_data.
|
inline |
Layer Address for XMSS is constantly zero and can not be changed this property is only of relevance to XMSS_MT.
Definition at line 48 of file xmss_address.h.
|
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.
Definition at line 151 of file xmss_address.h.
References BOTAN_ASSERT, get_type(), and LTree_Address.
|
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.
Definition at line 123 of file xmss_address.h.
References BOTAN_ASSERT, get_type(), and OTS_Hash_Address.
|
inline |
Tree Address for XMSS is constantly zero and can not be changed this property is only of relevance to XMSS_MT.
Definition at line 63 of file xmss_address.h.
|
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.
Definition at line 203 of file xmss_address.h.
References BOTAN_ASSERT, get_type(), Hash_Tree_Address, and LTree_Address.
Referenced by Botan::XMSS_Common_Ops::create_l_tree().
|
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.
Definition at line 259 of file xmss_address.h.
References BOTAN_ASSERT, get_type(), Hash_Tree_Address, and LTree_Address.
|
inline |
retrieves the logical type currently assigned to the XMSS Address instance.
Definition at line 79 of file xmss_address.h.
References m_data.
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().
|
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 189 of file xmss_address.h.
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().
|
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.
value | address of the hash function call within chain. |
Definition at line 245 of file xmss_address.h.
References BOTAN_ASSERT, get_type(), and OTS_Hash_Address.
|
inline |
Changes the mode the address currently used address mode. (XMSS_Address::Key_Mask for details.)
value | Target mode. |
Definition at line 110 of file xmss_address.h.
References BOTAN_ASSERT, get_type(), m_data, Mask_LSB_Mode, and OTS_Hash_Address.
Referenced by Botan::XMSS_Common_Ops::randomize_tree_hash().
|
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 55 of file xmss_address.h.
References BOTAN_ASSERT.
|
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.
value | index of the leaf. |
Definition at line 165 of file xmss_address.h.
References BOTAN_ASSERT, get_type(), and LTree_Address.
|
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.
value | index of OTS key pair. |
Definition at line 137 of file xmss_address.h.
References BOTAN_ASSERT, get_type(), and OTS_Hash_Address.
|
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 70 of file xmss_address.h.
References BOTAN_ASSERT.
|
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.
value | height of the tree node. |
Definition at line 217 of file xmss_address.h.
References BOTAN_ASSERT, get_type(), Hash_Tree_Address, and LTree_Address.
Referenced by Botan::XMSS_Common_Ops::create_l_tree().
|
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.
value | index of the tree node at current height. |
Definition at line 273 of file xmss_address.h.
References BOTAN_ASSERT, get_type(), Hash_Tree_Address, and LTree_Address.
Referenced by Botan::XMSS_Common_Ops::create_l_tree().
|
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.
type | Type that shall be assigned to the address (OTS_Hash_Address, LTree_Address or Hash_Tree_Address) |
Definition at line 91 of file xmss_address.h.
References m_data.
Referenced by XMSS_Address(), and XMSS_Address().
|
inline |
Definition at line 287 of file xmss_address.h.
References m_data.
|
protected |
Definition at line 298 of file xmss_address.h.
Referenced by bytes(), bytes(), get_key_mask_mode(), get_type(), set_key_mask_mode(), set_type(), size(), and XMSS_Address().