/usr/include/botan-2/botan/xmss_address.h is in libbotan-2-dev 2.4.0-5ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 | /*
* XMSS Address
* (C) 2016 Matthias Gierlings
*
* Botan is released under the Simplified BSD License (see license.txt)
**/
#ifndef BOTAN_XMSS_ADDRESS_H_
#define BOTAN_XMSS_ADDRESS_H_
#include <botan/xmss_tools.h>
namespace Botan {
/**
* 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().
**/
class XMSS_Address final
{
public:
/**
* Distinct types an XMSS_Address can represent. The available types
* are specified in [1] - 2.5 Hash Function Address Scheme.
**/
enum class Type : uint8_t
{
None = 255,
OTS_Hash_Address = 0,
LTree_Address = 1,
Hash_Tree_Address = 2
};
/**
* 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).
**/
enum class Key_Mask : uint8_t
{
Key_Mode = 0,
Mask_Mode = 1,
Mask_MSB_Mode = 1,
Mask_LSB_Mode = 2
};
/**
* Layer Address for XMSS is constantly zero and can not be changed this
* property is only of relevance to XMSS_MT.
*
* @return Layer address, which is constant 0 for XMSS.
**/
uint8_t get_layer_addr() const { return 0; }
/**
* 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.
**/
void set_layer_addr()
{
BOTAN_ASSERT(false, "Only available in XMSS_MT.");
}
/**
* Tree Address for XMSS is constantly zero and can not be changed this
* property is only of relevance to XMSS_MT.
*
* @return Tree address, which is constant 0 for XMSS.
**/
uint64_t get_tree_addr() const { return 0; }
/**
* 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.
**/
void set_tree_addr()
{
BOTAN_ASSERT(false, "Only available in XMSS_MT.");
}
/**
* retrieves the logical type currently assigned to the XMSS Address
* instance.
*
* @return Type of the address (OTS_Hash_Address, LTree_Address or
* Hash_Tree_Address)
**/
Type get_type() const
{
return static_cast<Type>(m_data[15]);
}
/**
* 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.
*
* @param type Type that shall be assigned to the address
* (OTS_Hash_Address, LTree_Address or Hash_Tree_Address)
**/
void set_type(Type type)
{
m_data[15] = static_cast<uint8_t>(type);
std::fill(m_data.begin() + 16, m_data.end(), static_cast<uint8_t>(0));
}
/**
* Retrieves the mode the address os currently set to. (See
* XMSS_Address::Key_Mask for details.)
*
* @return currently active mode
**/
Key_Mask get_key_mask_mode() const
{
return Key_Mask(m_data[31]);
}
/**
* Changes the mode the address currently used address mode.
* (XMSS_Address::Key_Mask for details.)
*
* @param value Target mode.
**/
void set_key_mask_mode(Key_Mask value)
{
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);
}
/**
* 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.
*
* @return index of OTS key pair.
**/
uint32_t get_ots_address() const
{
BOTAN_ASSERT(get_type() == Type::OTS_Hash_Address,
"get_ots_address() requires XMSS_Address::Type::"
"OTS_Hash_Address.");
return get_hi32(2);
}
/**
* 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.
*
* @param value index of OTS key pair.
**/
void set_ots_address(uint32_t value)
{
BOTAN_ASSERT(get_type() == Type::OTS_Hash_Address,
"set_ots_address() requires XMSS_Address::Type::"
"OTS_Hash_Address.");
set_hi32(2, value);
}
/**
* 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.
*
* @return index of the leaf.
**/
uint32_t get_ltree_address() const
{
BOTAN_ASSERT(get_type() == Type::LTree_Address,
"set_ltree_address() requires XMSS_Address::Type::"
"LTree_Address.");
return get_hi32(2);
}
/**
* 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.
*
* @param value index of the leaf.
**/
void set_ltree_address(uint32_t value)
{
BOTAN_ASSERT(get_type() == Type::LTree_Address,
"set_ltree_address() requires XMSS_Address::Type::"
"LTree_Address.");
set_hi32(2, value);
}
/**
* Retrieve the chain address. A call to this method is only valid, if
* the address type is set to Type::OTS_Hash_Address.
*
* @return chain address.
**/
uint32_t get_chain_address() const
{
BOTAN_ASSERT(get_type() == Type::OTS_Hash_Address,
"get_chain_address() requires XMSS_Address::Type::"
"OTS_Hash_Address.");
return get_lo32(2);
}
/**
* Set the chain address. A call to this method is only valid, if
* the address type is set to Type::OTS_Hash_Address.
**/
void set_chain_address(uint32_t value)
{
BOTAN_ASSERT(get_type() == Type::OTS_Hash_Address,
"set_chain_address() requires XMSS_Address::Type::"
"OTS_Hash_Address.");
set_lo32(2, value);
}
/**
* 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.
*
* @return height of the tree node.
**/
uint32_t get_tree_height() const
{
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);
}
/**
* 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.
*
* @param value height of the tree node.
**/
void set_tree_height(uint32_t value)
{
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);
}
/**
* 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.
*
* @return address of the hash function call within chain.
**/
uint32_t get_hash_address() const
{
BOTAN_ASSERT(get_type() == Type::OTS_Hash_Address,
"get_hash_address() requires XMSS_Address::Type::"
"OTS_Hash_Address.");
return get_hi32(3);
}
/**
* 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.
*
* @param value address of the hash function call within chain.
**/
void set_hash_address(uint32_t value)
{
BOTAN_ASSERT(get_type() == Type::OTS_Hash_Address,
"set_hash_address() requires XMSS_Address::Type::"
"OTS_Hash_Address.");
set_hi32(3, value);
}
/**
* 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.
*
* @return index of the tree node at current height.
**/
uint32_t get_tree_index() const
{
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);
}
/**
* 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.
*
* @param value index of the tree node at current height.
**/
void set_tree_index(uint32_t value)
{
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);
}
const secure_vector<uint8_t>& bytes() const
{
return m_data;
}
secure_vector<uint8_t>& bytes()
{
return m_data;
}
/**
* @return the size of an XMSS_Address
**/
size_t size() const
{
return m_data.size();
}
XMSS_Address()
: m_data(m_address_size)
{
set_type(Type::None);
}
XMSS_Address(Type type)
: m_data(m_address_size)
{
set_type(type);
}
XMSS_Address(const secure_vector<uint8_t>& data) : m_data(data)
{
BOTAN_ASSERT(m_data.size() == m_address_size,
"XMSS_Address must be of 256 bits size.");
}
XMSS_Address(secure_vector<uint8_t>&& data) : m_data(std::move(data))
{
BOTAN_ASSERT(m_data.size() == m_address_size,
"XMSS_Address must be of 256 bits size.");
}
protected:
secure_vector<uint8_t> m_data;
private:
static const size_t m_address_size = 32;
inline uint32_t get_hi32(size_t offset) const
{
return ((0x000000FF & m_data[8 * offset + 3]) |
(0x000000FF & m_data[8 * offset + 2]) << 8 |
(0x000000FF & m_data[8 * offset + 1]) << 16 |
(0x000000FF & m_data[8 * offset ]) << 24);
}
inline void set_hi32(size_t offset, uint32_t value)
{
m_data[offset * 8 ] = ((value >> 24) & 0xFF);
m_data[offset * 8 + 1] = ((value >> 16) & 0xFF);
m_data[offset * 8 + 2] = ((value >> 8) & 0xFF);
m_data[offset * 8 + 3] = ((value ) & 0xFF);
}
inline uint32_t get_lo32(size_t offset) const
{
return ((0x000000FF & m_data[8 * offset + 7]) |
(0x000000FF & m_data[8 * offset + 6]) << 8 |
(0x000000FF & m_data[8 * offset + 5]) << 16 |
(0x000000FF & m_data[8 * offset + 4]) << 24);
}
inline void set_lo32(size_t offset, uint32_t value)
{
m_data[offset * 8 + 4] = ((value >> 24) & 0xFF);
m_data[offset * 8 + 5] = ((value >> 16) & 0xFF);
m_data[offset * 8 + 6] = ((value >> 8) & 0xFF);
m_data[offset * 8 + 7] = ((value ) & 0xFF);
}
};
}
#endif
|