Botan 2.13.0 Crypto and TLS for C++11

- Main Page
- Namespaces
- Classes
- Files

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Botan::XMSS_PrivateKey Class Referencefinal

`#include <xmss_privatekey.h>`

Inheritance diagram for Botan::XMSS_PrivateKey:

## Public Member Functions
std::string | algo_name () const override
AlgorithmIdentifier | algorithm_identifier () const override
bool | check_key (RandomNumberGenerator &, bool) const override
virtual std::unique_ptr< PK_Ops::Decryption > | create_decryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
virtual std::unique_ptr< PK_Ops::Encryption > | create_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
virtual std::unique_ptr< PK_Ops::KEM_Decryption > | create_kem_decryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
virtual std::unique_ptr< PK_Ops::KEM_Encryption > | create_kem_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
virtual std::unique_ptr< PK_Ops::Key_Agreement > | create_key_agreement_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
std::unique_ptr< PK_Ops::Signature > | create_signature_op (RandomNumberGenerator &, const std::string &, const std::string &provider) const override
std::unique_ptr< PK_Ops::Verification > | create_verification_op (const std::string &, const std::string &provider) const override
virtual Signature_Format | default_x509_signature_format () const
size_t | estimated_strength () const override
std::string | fingerprint (const std::string &alg) const
std::string | fingerprint_private (const std::string &alg) const
std::string | fingerprint_public (const std::string &alg="SHA-256") const
virtual OID | get_oid () const
size_t | key_length () const override
virtual size_t | message_part_size () const
virtual size_t | message_parts () const
virtual AlgorithmIdentifier | pkcs8_algorithm_identifier () const
const secure_vector< uint8_t > & | prf () const
secure_vector< uint8_t > & | prf ()
secure_vector< uint8_t > | private_key_bits () const override
secure_vector< uint8_t > | private_key_info () const
std::vector< uint8_t > | public_key_bits () const override
virtual secure_vector< uint8_t > & | public_seed ()
const secure_vector< uint8_t > & | public_seed () const override
secure_vector< uint8_t > | raw_private_key () const
virtual std::vector< uint8_t > | raw_public_key () const
size_t | reserve_unused_leaf_index ()
secure_vector< uint8_t > & | root ()
const secure_vector< uint8_t > & | root () const
void | set_public_seed (const secure_vector< uint8_t > &public_seed) override
void | set_public_seed (secure_vector< uint8_t > &&public_seed) override
void | set_root (const secure_vector< uint8_t > &root)
void | set_root (secure_vector< uint8_t > &&root)
void | set_unused_leaf_index (size_t idx)
void | set_xmss_oid (XMSS_Parameters::xmss_algorithm_t xmss_oid)
size_t | size () const override
bool | stateful_operation () const override
std::vector< uint8_t > | subject_public_key () const
secure_vector< uint8_t > | tree_hash (size_t start_idx, size_t target_node_height, XMSS_Address &adrs)
size_t | unused_leaf_index () const
XMSS_WOTS_Parameters::ots_algorithm_t | wots_oid () const
const XMSS_WOTS_Parameters & | wots_parameters () const
const XMSS_WOTS_PrivateKey & | wots_private_key () const
XMSS_WOTS_PrivateKey & | wots_private_key ()
XMSS_Parameters::xmss_algorithm_t | xmss_oid () const
const XMSS_Parameters & | xmss_parameters () const
| XMSS_PrivateKey (XMSS_Parameters::xmss_algorithm_t xmss_algo_id, RandomNumberGenerator &rng)
| XMSS_PrivateKey (const secure_vector< uint8_t > &raw_key)
| XMSS_PrivateKey (XMSS_Parameters::xmss_algorithm_t xmss_algo_id, size_t idx_leaf, const secure_vector< uint8_t > &wots_priv_seed, const secure_vector< uint8_t > &prf, const secure_vector< uint8_t > &root, const secure_vector< uint8_t > &public_seed)

## Protected Member Functions
void | create_l_tree (secure_vector< uint8_t > &result, wots_keysig_t pk, XMSS_Address &adrs, const secure_vector< uint8_t > &seed, XMSS_Hash &hash)
void | create_l_tree (secure_vector< uint8_t > &result, wots_keysig_t pk, XMSS_Address &adrs, const secure_vector< uint8_t > &seed)
void | randomize_tree_hash (secure_vector< uint8_t > &result, const secure_vector< uint8_t > &left, const secure_vector< uint8_t > &right, XMSS_Address &adrs, const secure_vector< uint8_t > &seed, XMSS_Hash &hash)
void | randomize_tree_hash (secure_vector< uint8_t > &result, const secure_vector< uint8_t > &left, const secure_vector< uint8_t > &right, XMSS_Address &adrs, const secure_vector< uint8_t > &seed)

## Protected Attributes
XMSS_Hash | m_hash
secure_vector< uint8_t > | m_public_seed
std::vector< uint8_t > | m_raw_key
secure_vector< uint8_t > | m_root
XMSS_WOTS_Parameters | m_wots_params
XMSS_Parameters | m_xmss_params
XMSS_Parameters | m_xmss_params

## Detailed Description

An XMSS: Extended Hash-Based Signature private key. The XMSS private key does not support the X509 and PKCS7 standard. Instead the raw format described in [1] is used.

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

Definition at line 37 of file xmss_privatekey.h.

## Constructor & Destructor Documentation

Botan::XMSS_PrivateKey::XMSS_PrivateKey | ( | XMSS_Parameters::xmss_algorithm_t | xmss_algo_id,
|  | RandomNumberGenerator & | rng
| ) |  |

Creates a new XMSS private key for the chosen XMSS signature method. New seeds for public/private key and pseudo random function input are generated using the provided RNG. The appropriate WOTS signature method will be automatically set based on the chosen XMSS signature method.

Parameters

  xmss_algo_id | Identifier for the selected XMSS signature method.
  rng | A random number generator to use for key generation.

Definition at line 97 of file xmss_privatekey.cpp.

References Botan::XMSS_PublicKey::m_xmss_params, Botan::XMSS_PublicKey::set_root(), and tree_hash().

100 : XMSS_PublicKey(xmss_algo_id, rng),
101 XMSS_Common_Ops(xmss_algo_id),
102 m_wots_priv_key(XMSS_PublicKey::m_xmss_params.ots_oid(),
103 public_seed(),
104 rng),
105 m_prf(rng.random_vec(XMSS_PublicKey::m_xmss_params.element_size())),
106 m_index_reg(XMSS_Index_Registry::get_instance())
107 {
108 XMSS_Address adrs;
109 set_root(tree_hash(0,
110 XMSS_PublicKey::m_xmss_params.tree_height(),
111 adrs));
112 }
Botan::XMSS_PrivateKey::public_seed
const secure_vector< uint8_t > & public_seed() const override
Definition: xmss_privatekey.h:193
Botan::XMSS_Common_Ops::XMSS_Common_Ops
XMSS_Common_Ops(XMSS_Parameters::xmss_algorithm_t oid)
Definition: xmss_common_ops.h:29
Botan::XMSS_PrivateKey::tree_hash
secure_vector< uint8_t > tree_hash(size_t start_idx, size_t target_node_height, XMSS_Address &adrs)
Definition: xmss_privatekey.cpp:115
Botan::XMSS_Parameters::element_size
size_t element_size() const
Definition: xmss_parameters.h:67
Botan::XMSS_PublicKey::set_root
void set_root(const secure_vector< uint8_t > &root)
Definition: xmss_publickey.h:152
Botan::XMSS_PublicKey::XMSS_PublicKey
XMSS_PublicKey(XMSS_Parameters::xmss_algorithm_t xmss_oid, RandomNumberGenerator &rng)
Definition: xmss_publickey.h:51
Botan::XMSS_PublicKey::m_xmss_params
XMSS_Parameters m_xmss_params
Definition: xmss_publickey.h:251
Botan::XMSS_Index_Registry::get_instance
static XMSS_Index_Registry & get_instance()
Definition: xmss_index_registry.h:34

Botan::XMSS_PrivateKey::XMSS_PrivateKey | ( | const secure_vector< uint8_t > & | raw_key | ) |

Creates an XMSS_PrivateKey from a byte sequence produced by raw_private_key().

Parameters

  raw_key | An XMSS private key serialized using raw_private_key().

Definition at line 47 of file xmss_privatekey.cpp.

References Botan::XMSS_Parameters::element_size(), Botan::XMSS_WOTS_Parameters::element_size(), Botan::XMSS_PublicKey::m_wots_params, Botan::XMSS_PublicKey::m_xmss_params, Botan::XMSS_WOTS_PrivateKey::set_private_seed(), set_unused_leaf_index(), size(), and Botan::XMSS_PublicKey::size().

48 : XMSS_PublicKey(unlock(key_bits)),
49 XMSS_Common_Ops(XMSS_PublicKey::m_xmss_params.oid()),
50 m_wots_priv_key(m_wots_params.oid(), m_public_seed),
51 m_index_reg(XMSS_Index_Registry::get_instance())
52 {
53 /*
54 The code requires sizeof(size_t) >= ceil(tree_height / 8)
55
56 Maximum supported tree height is 20, ceil(20/8) == 3, so 4 byte
57 size_t is sufficient for all defined parameters, or even a
58 (hypothetical) tree height 32, which would be extremely slow to
59 compute.
60 */
61 static_assert(sizeof(size_t) >= 4, "size_t is big enough to support leaf index");
62
63 secure_vector<uint8_t> raw_key = extract_raw_key(key_bits);
64
65 if(raw_key.size() != XMSS_PrivateKey::size())
66 {
67 throw Decoding_Error("Invalid XMSS private key size");
68 }
69
70 // extract & copy unused leaf index from raw_key
71 uint64_t unused_leaf = 0;
72 auto begin = (raw_key.begin() + XMSS_PublicKey::size());
73 auto end = raw_key.begin() + XMSS_PublicKey::size() + sizeof(uint32_t);
74
75 for(auto& i = begin; i != end; i++)
76 {
77 unused_leaf = ((unused_leaf << 8) | *i);
78 }
79
80 if(unused_leaf >= (1ull << XMSS_PublicKey::m_xmss_params.tree_height()))
81 {
82 throw Decoding_Error("XMSS private key leaf index out of bounds");
83 }
84
85 begin = end;
86 end = begin + XMSS_PublicKey::m_xmss_params.element_size();
87 m_prf.clear();
88 m_prf.reserve(XMSS_PublicKey::m_xmss_params.element_size());
89 std::copy(begin, end, std::back_inserter(m_prf));
90
91 begin = end;
92 end = begin + m_wots_params.element_size();
93 m_wots_priv_key.set_private_seed(secure_vector<uint8_t>(begin, end));
94 set_unused_leaf_index(static_cast<size_t>(unused_leaf));
95 }
Botan::XMSS_PublicKey::m_public_seed
secure_vector< uint8_t > m_public_seed
Definition: xmss_publickey.h:254
Botan::XMSS_Common_Ops::XMSS_Common_Ops
XMSS_Common_Ops(XMSS_Parameters::xmss_algorithm_t oid)
Definition: xmss_common_ops.h:29
Botan::XMSS_Parameters::element_size
size_t element_size() const
Definition: xmss_parameters.h:67
Botan::XMSS_PrivateKey::set_unused_leaf_index
void set_unused_leaf_index(size_t idx)
Definition: xmss_privatekey.h:115
Botan::XMSS_WOTS_Parameters::element_size
size_t element_size() const
Definition: xmss_wots_parameters.h:79
Botan::XMSS_PrivateKey::size
size_t size() const override
Definition: xmss_privatekey.h:208
Botan::XMSS_PublicKey::size
virtual size_t size() const
Definition: xmss_publickey.h:235
Botan::unlock
std::vector< T > unlock(const secure_vector< T > &in)
Definition: secmem.h:72
Botan::XMSS_PublicKey::XMSS_PublicKey
XMSS_PublicKey(XMSS_Parameters::xmss_algorithm_t xmss_oid, RandomNumberGenerator &rng)
Definition: xmss_publickey.h:51
Botan::XMSS_PublicKey::m_wots_params
XMSS_WOTS_Parameters m_wots_params
Definition: xmss_publickey.h:252
Botan::XMSS_WOTS_PrivateKey::set_private_seed
void set_private_seed(const secure_vector< uint8_t > &private_seed)
Definition: xmss_wots_privatekey.h:279
Botan::XMSS_PublicKey::m_xmss_params
XMSS_Parameters m_xmss_params
Definition: xmss_publickey.h:251
Botan::XMSS_Index_Registry::get_instance
static XMSS_Index_Registry & get_instance()
Definition: xmss_index_registry.h:34
Botan::XMSS_WOTS_Parameters::oid
ots_algorithm_t oid() const
Definition: xmss_wots_parameters.h:97

Botan::XMSS_PrivateKey::XMSS_PrivateKey | ( | XMSS_Parameters::xmss_algorithm_t | xmss_algo_id,
|  | size_t | idx_leaf,
|  | const secure_vector< uint8_t > & | wots_priv_seed,
|  | const secure_vector< uint8_t > & | prf,
|  | const secure_vector< uint8_t > & | root,
|  | const secure_vector< uint8_t > & | public_seed
| ) |  |
| inline

Creates a new XMSS private key for the chosen XMSS signature method using precomputed seeds for public/private keys and pseudo random function input. The appropriate WOTS signature method will be automatically set, based on the chosen XMSS signature method.

Parameters

  xmss_algo_id | Identifier for the selected XMSS signature method.
  idx_leaf | Index of the next unused leaf.
  wots_priv_seed | A seed to generate a Winternitz-One-Time- Signature private key from.
  prf | a secret n-byte key sourced from a secure source of uniformly random data.
  root | Root node of the binary hash tree.
  public_seed | The public seed.

Definition at line 77 of file xmss_privatekey.h.

83 : XMSS_PublicKey(xmss_algo_id, root, public_seed),
84 XMSS_Common_Ops(xmss_algo_id),
85 m_wots_priv_key(XMSS_PublicKey::m_xmss_params.ots_oid(),
86 public_seed,
87 wots_priv_seed),
88 m_prf(prf),
89 m_index_reg(XMSS_Index_Registry::get_instance())
90 {
91 set_unused_leaf_index(idx_leaf);
92 }
Botan::XMSS_PrivateKey::public_seed
const secure_vector< uint8_t > & public_seed() const override
Definition: xmss_privatekey.h:193
Botan::XMSS_Common_Ops::XMSS_Common_Ops
XMSS_Common_Ops(XMSS_Parameters::xmss_algorithm_t oid)
Definition: xmss_common_ops.h:29
Botan::XMSS_PrivateKey::set_unused_leaf_index
void set_unused_leaf_index(size_t idx)
Definition: xmss_privatekey.h:115
Botan::XMSS_PublicKey::root
secure_vector< uint8_t > & root()
Definition: xmss_publickey.h:147
Botan::XMSS_PrivateKey::prf
const secure_vector< uint8_t > & prf() const
Definition: xmss_privatekey.h:170
Botan::XMSS_PublicKey::XMSS_PublicKey
XMSS_PublicKey(XMSS_Parameters::xmss_algorithm_t xmss_oid, RandomNumberGenerator &rng)
Definition: xmss_publickey.h:51
Botan::XMSS_PublicKey::m_xmss_params
XMSS_Parameters m_xmss_params
Definition: xmss_publickey.h:251
Botan::XMSS_Index_Registry::get_instance
static XMSS_Index_Registry & get_instance()
Definition: xmss_index_registry.h:34

## Member Function Documentation

std::string Botan::XMSS_PublicKey::algo_name | ( |  | ) | const
| inline override virtual inherited

Get the name of the underlying public key scheme.

Returns
  name of the public key scheme

Implements Botan::Public_Key.

Definition at line 187 of file xmss_publickey.h.

Referenced by create_signature_op(), and Botan::XMSS_PublicKey::create_verification_op().

188 {
189 return "XMSS";
190 }

AlgorithmIdentifier Botan::XMSS_PublicKey::algorithm_identifier | ( |  | ) | const
| inline override virtual inherited

Returns
  X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 192 of file xmss_publickey.h.

References Botan::AlgorithmIdentifier::USE_EMPTY_PARAM.

193 {
194 return AlgorithmIdentifier(get_oid(), AlgorithmIdentifier::USE_EMPTY_PARAM);
195 }
Botan::Public_Key::get_oid
virtual OID get_oid() const
Definition: pk_keys.cpp:53
Botan::AlgorithmIdentifier::USE_EMPTY_PARAM
Definition: alg_id.h:24

bool Botan::XMSS_PublicKey::check_key | ( | RandomNumberGenerator & | rng,
|  | bool | strong
| ) |  | const
| inline override virtual inherited

Test the key values for consistency.

Parameters

  rng | rng to use
  strong | whether to perform strong and lengthy version of the test

Returns
  true if the test is passed

Implements Botan::Public_Key.

Definition at line 197 of file xmss_publickey.h.

198 {
199 return true;
200 }

std::unique_ptr< PK_Ops::Decryption > Botan::Private_Key::create_decryption_op | ( | RandomNumberGenerator & | rng,
|  | const std::string & | params,
|  | const std::string & | provider
| ) |  | const
| virtual inherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return an decryption operation for this key/params or throw

Parameters

  rng | a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
  params | additional parameters
  provider | the provider to use

Reimplemented in Botan::RSA_PrivateKey, Botan::SM2_PrivateKey, and Botan::ElGamal_PrivateKey.

Definition at line 114 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_Decryptor_EME::PK_Decryptor_EME().

117 {
118 throw Lookup_Error(algo_name() + " does not support decryption");
119 }
Botan::Public_Key::algo_name
virtual std::string algo_name() const =0

std::unique_ptr< PK_Ops::Encryption > Botan::Public_Key::create_encryption_op | ( | RandomNumberGenerator & | rng,
|  | const std::string & | params,
|  | const std::string & | provider
| ) |  | const
| virtual inherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return an encryption operation for this key/params or throw

Parameters

  rng | a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
  params | additional parameters
  provider | the provider to use

Reimplemented in Botan::RSA_PublicKey, Botan::SM2_PublicKey, and Botan::ElGamal_PublicKey.

Definition at line 91 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_Encryptor_EME::PK_Encryptor_EME().

94 {
95 throw Lookup_Error(algo_name() + " does not support encryption");
96 }
Botan::Public_Key::algo_name
virtual std::string algo_name() const =0

std::unique_ptr< PK_Ops::KEM_Decryption > Botan::Private_Key::create_kem_decryption_op | ( | RandomNumberGenerator & | rng,
|  | const std::string & | params,
|  | const std::string & | provider
| ) |  | const
| virtual inherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return a KEM decryption operation for this key/params or throw

Parameters

  rng | a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
  params | additional parameters
  provider | the provider to use

Reimplemented in Botan::RSA_PrivateKey, and Botan::McEliece_PrivateKey.

Definition at line 122 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_KEM_Decryptor::PK_KEM_Decryptor().

125 {
126 throw Lookup_Error(algo_name() + " does not support KEM decryption");
127 }
Botan::Public_Key::algo_name
virtual std::string algo_name() const =0

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::Public_Key::create_kem_encryption_op | ( | RandomNumberGenerator & | rng,
|  | const std::string & | params,
|  | const std::string & | provider
| ) |  | const
| virtual inherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return a KEM encryption operation for this key/params or throw

Parameters

  rng | a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
  params | additional parameters
  provider | the provider to use

Reimplemented in Botan::RSA_PublicKey, and Botan::McEliece_PublicKey.

Definition at line 99 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_KEM_Encryptor::PK_KEM_Encryptor().

102 {
103 throw Lookup_Error(algo_name() + " does not support KEM encryption");
104 }
Botan::Public_Key::algo_name
virtual std::string algo_name() const =0

std::unique_ptr< PK_Ops::Key_Agreement > Botan::Private_Key::create_key_agreement_op | ( | RandomNumberGenerator & | rng,
|  | const std::string & | params,
|  | const std::string & | provider
| ) |  | const
| virtual inherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return a key agreement operation for this key/params or throw

Parameters

  rng | a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
  params | additional parameters
  provider | the provider to use

Reimplemented in Botan::ECDH_PrivateKey, Botan::Curve25519_PrivateKey, and Botan::DH_PrivateKey.

Definition at line 138 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_Key_Agreement::PK_Key_Agreement().

141 {
142 throw Lookup_Error(algo_name() + " does not support key agreement");
143 }
Botan::Public_Key::algo_name
virtual std::string algo_name() const =0

void Botan::XMSS_Common_Ops::create_l_tree | ( | secure_vector< uint8_t > & | result,
|  | wots_keysig_t | pk,
|  | XMSS_Address & | adrs,
|  | const secure_vector< uint8_t > & | seed,
|  | XMSS_Hash & | hash
| ) |  |
| protected inherited

Algorithm 8: "ltree" Create an L-tree used to compute the leaves of the binary hash tree. Takes a WOTS+ public key and compresses it to a single n-byte value.

This overload is used in multithreaded scenarios, where it is required to provide seperate instances of XMSS_Hash to each thread.

Parameters

  [out] | result | Public key compressed to a single n-byte value pk[0].
  [in] | pk | Winternitz One Time Signatures+ public key.
  [in] | adrs | Address encoding the address of the L-Tree
  [in] | seed | The seed generated during the public key generation.
  [in] | hash | Instance of XMSS_Hash, that may only be used by the thead executing create_l_tree.

Definition at line 46 of file xmss_common_ops.cpp.

References Botan::XMSS_Address::get_tree_height(), Botan::XMSS_Parameters::len(), Botan::XMSS_Common_Ops::m_xmss_params, Botan::XMSS_Common_Ops::randomize_tree_hash(), Botan::XMSS_Address::set_tree_height(), and Botan::XMSS_Address::set_tree_index().

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

51 {
52 size_t l = m_xmss_params.len();
53 adrs.set_tree_height(0);
54
55 while(l > 1)
56 {
57 for(size_t i = 0; i < l >> 1; i++)
58 {
59 adrs.set_tree_index(static_cast<uint32_t>(i));
60 randomize_tree_hash(pk[i], pk[2 * i], pk[2 * i + 1], adrs, seed, hash);
61 }
62 if(l & 0x01)
63 {
64 pk[l >> 1] = pk[l - 1];
65 }
66 l = (l >> 1) + (l & 0x01);
67 adrs.set_tree_height(adrs.get_tree_height() + 1);
68 }
69 result = pk[0];
70 }
Botan::XMSS_Common_Ops::m_xmss_params
XMSS_Parameters m_xmss_params
Definition: xmss_common_ops.h:121
Botan::XMSS_Parameters::len
size_t len() const
Definition: xmss_parameters.h:82
Botan::XMSS_Common_Ops::randomize_tree_hash
void randomize_tree_hash(secure_vector< uint8_t > &result, const secure_vector< uint8_t > &left, const secure_vector< uint8_t > &right, XMSS_Address &adrs, const secure_vector< uint8_t > &seed, XMSS_Hash &hash)
Definition: xmss_common_ops.cpp:14
hash
MechanismType hash
Definition: p11_mechanism.cpp:64

void Botan::XMSS_Common_Ops::create_l_tree | ( | secure_vector< uint8_t > & | result,
|  | wots_keysig_t | pk,
|  | XMSS_Address & | adrs,
|  | const secure_vector< uint8_t > & | seed
| ) |  |
| inline protected inherited

Algorithm 8: "ltree" Create an L-tree used to compute the leaves of the binary hash tree. Takes a WOTS+ public key and compresses it to a single n-byte value.

Parameters

  [out] | result | Public key compressed to a single n-byte value pk[0].
  [in] | pk | Winternitz One Time Signatures+ public key.
  [in] | adrs | Address encoding the address of the L-Tree
  [in] | seed | The seed generated during the public key generation.

Definition at line 112 of file xmss_common_ops.h.

References Botan::XMSS_Common_Ops::create_l_tree(), and Botan::XMSS_Common_Ops::m_hash.

116 {
117 create_l_tree(result, pk, adrs, seed, m_hash);
118 }
Botan::XMSS_Common_Ops::create_l_tree
void create_l_tree(secure_vector< uint8_t > &result, wots_keysig_t pk, XMSS_Address &adrs, const secure_vector< uint8_t > &seed, XMSS_Hash &hash)
Definition: xmss_common_ops.cpp:46
Botan::XMSS_Common_Ops::m_hash
XMSS_Hash m_hash
Definition: xmss_common_ops.h:122

std::unique_ptr< PK_Ops::Signature > Botan::XMSS_PrivateKey::create_signature_op | ( | RandomNumberGenerator & | rng,
|  | const std::string & | params,
|  | const std::string & | provider
| ) |  | const
| override virtual

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return a signature operation for this key/params or throw

Parameters

  rng | a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
  params | additional parameters
  provider | the provider to use

Reimplemented from Botan::Private_Key.

Definition at line 337 of file xmss_privatekey.cpp.

References Botan::XMSS_PublicKey::algo_name().

340 {
341 if(provider == "base" || provider.empty())
342 return std::unique_ptr<PK_Ops::Signature>(
343 new XMSS_Signature_Operation(*this));
344
345 throw Provider_Not_Found(algo_name(), provider);
346 }
Botan::XMSS_PublicKey::algo_name
std::string algo_name() const override
Definition: xmss_publickey.h:187

std::unique_ptr< PK_Ops::Verification > Botan::XMSS_PublicKey::create_verification_op | ( | const std::string & | params,
|  | const std::string & | provider
| ) |  | const
| override virtual inherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return a verification operation for this key/params or throw

Parameters

  params | additional parameters
  provider | the provider to use

Reimplemented from Botan::Public_Key.

Definition at line 85 of file xmss_publickey.cpp.

References Botan::XMSS_PublicKey::algo_name().

87 {
88 if(provider == "base" || provider.empty())
89 {
90 return std::unique_ptr<PK_Ops::Verification>(
91 new XMSS_Verification_Operation(*this));
92 }
93 throw Provider_Not_Found(algo_name(), provider);
94 }
Botan::XMSS_PublicKey::algo_name
std::string algo_name() const override
Definition: xmss_publickey.h:187

virtual Signature_Format Botan::Public_Key::default_x509_signature_format | ( |  | ) | const
| inline virtual inherited

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 126 of file pk_keys.h.

References Botan::DER_SEQUENCE, and Botan::IEEE_1363.

Referenced by Botan::X509_Object::choose_sig_format(), and Botan::X509_Object::verify_signature().

127 {
128 return (this->message_parts() >= 2) ? DER_SEQUENCE : IEEE_1363;
129 }
Botan::Public_Key::message_parts
virtual size_t message_parts() const
Definition: pk_keys.h:113
Botan::IEEE_1363
Definition: pk_keys.h:24
Botan::DER_SEQUENCE
Definition: pk_keys.h:24

size_t Botan::XMSS_PublicKey::estimated_strength | ( |  | ) | const
| inline override virtual inherited

Return the estimated strength of the underlying key against the best currently known attack. Note that this ignores anything but pure attacks against the key itself and do not take into account padding schemes, usage mistakes, etc which might reduce the strength. However it does suffice to provide an upper bound.

Returns
  estimated strength in bits

Implements Botan::Public_Key.

Definition at line 206 of file xmss_publickey.h.

207 {
208 return m_xmss_params.estimated_strength();
209 }
Botan::XMSS_Parameters::estimated_strength
size_t estimated_strength() const
Definition: xmss_parameters.h:95
Botan::XMSS_PublicKey::m_xmss_params
XMSS_Parameters m_xmss_params
Definition: xmss_publickey.h:251

std::string Botan::Private_Key::fingerprint | ( | const std::string & | alg | ) | const
| inline inherited

Definition at line 216 of file pk_keys.h.

217 {
218 return fingerprint_private(alg); // match behavior in previous versions
219 }
Botan::Private_Key::fingerprint_private
std::string fingerprint_private(const std::string &alg) const
Definition: pk_keys.cpp:85

std::string Botan::Private_Key::fingerprint_private | ( | const std::string & | alg | ) | const
| inherited

Returns
  Hash of the PKCS #8 encoding for this key object

Definition at line 85 of file pk_keys.cpp.

References Botan::create_hex_fingerprint(), and Botan::Private_Key::private_key_bits().

Referenced by Botan::Certificate_Store_In_SQL::find_certs_for_key(), Botan::Certificate_Store_In_SQL::insert_key(), and Botan::Certificate_Store_In_SQL::remove_key().

86 {
87 return create_hex_fingerprint(private_key_bits(), hash_algo);
88 }
Botan::Private_Key::private_key_bits
virtual secure_vector< uint8_t > private_key_bits() const =0
hash_algo
AlgorithmIdentifier hash_algo
Definition: x509_obj.cpp:22
Botan::create_hex_fingerprint
std::string create_hex_fingerprint(const uint8_t bits[], size_t bits_len, const std::string &hash_name)
Definition: pk_keys.cpp:17

std::string Botan::Public_Key::fingerprint_public | ( | const std::string & | alg = `"SHA-256"` | ) | const
| inherited

Returns
  Hash of the subject public key

Definition at line 77 of file pk_keys.cpp.

References Botan::create_hex_fingerprint(), and Botan::Public_Key::subject_public_key().

78 {
79 return create_hex_fingerprint(subject_public_key(), hash_algo);
80 }
hash_algo
AlgorithmIdentifier hash_algo
Definition: x509_obj.cpp:22
Botan::create_hex_fingerprint
std::string create_hex_fingerprint(const uint8_t bits[], size_t bits_len, const std::string &hash_name)
Definition: pk_keys.cpp:17
Botan::Public_Key::subject_public_key
std::vector< uint8_t > subject_public_key() const
Definition: pk_keys.cpp:38

OID Botan::Public_Key::get_oid | ( |  | ) | const
| virtual inherited

Get the OID of the underlying public key scheme.

Returns
  OID of the public key scheme

Reimplemented in Botan::XMSS_WOTS_Addressed_PublicKey.

Definition at line 53 of file pk_keys.cpp.

References Botan::Public_Key::algo_name(), Botan::OID::empty(), and Botan::OIDS::str2oid_or_empty().

Referenced by Botan::DL_Scheme_PublicKey::algorithm_identifier(), Botan::Curve25519_PublicKey::algorithm_identifier(), Botan::Ed25519_PublicKey::algorithm_identifier(), Botan::McEliece_PublicKey::algorithm_identifier(), Botan::RSA_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), Botan::TPM_PrivateKey::algorithm_identifier(), and Botan::XMSS_WOTS_Addressed_PublicKey::get_oid().

54 {
55 const OID o = OIDS::str2oid_or_empty(algo_name());
56 if(o.empty())
57 throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
58 return o;
59 }
Botan::Public_Key::algo_name
virtual std::string algo_name() const =0
Botan::OIDS::str2oid_or_empty
BOTAN_UNSTABLE_API OID str2oid_or_empty(const std::string &name)
Definition: oids.cpp:116

size_t Botan::XMSS_PublicKey::key_length | ( |  | ) | const
| inline override virtual inherited

Return an integer value best approximating the length of the primary security parameter. For example for RSA this will be the size of the modulus, for ECDSA the size of the ECC group, and for McEliece the size of the code will be returned.

Implements Botan::Public_Key.

Definition at line 211 of file xmss_publickey.h.

212 {
213 return m_xmss_params.estimated_strength();
214 }
Botan::XMSS_Parameters::estimated_strength
size_t estimated_strength() const
Definition: xmss_parameters.h:95
Botan::XMSS_PublicKey::m_xmss_params
XMSS_Parameters m_xmss_params
Definition: xmss_publickey.h:251

virtual size_t Botan::Public_Key::message_part_size | ( |  | ) | const
| inline virtual inherited

Returns how large each of the message parts refered to by message_parts() is

This function is public but applications should have few reasons to ever call this.

Returns
  size of the message parts in bits

Reimplemented in Botan::ECDSA_PublicKey, Botan::GOST_3410_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::SM2_PublicKey, and Botan::DSA_PublicKey.

Definition at line 124 of file pk_keys.h.

Referenced by Botan::PK_Signer::PK_Signer(), and Botan::PK_Verifier::PK_Verifier().

124 { return 0; }

virtual size_t Botan::Public_Key::message_parts | ( |  | ) | const
| inline virtual inherited

Returns more than 1 if the output of this algorithm (ciphertext, signature) should be treated as more than one value. This is used for algorithms like DSA and ECDSA, where the (r,s) output pair can be encoded as either a plain binary list or a TLV tagged DER encoding depending on the protocol.

This function is public but applications should have few reasons to ever call this.

Returns
  number of message parts

Reimplemented in Botan::ECDSA_PublicKey, Botan::GOST_3410_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::SM2_PublicKey, and Botan::DSA_PublicKey.

Definition at line 113 of file pk_keys.h.

Referenced by Botan::PK_Signer::PK_Signer(), and Botan::PK_Verifier::PK_Verifier().

113 { return 1; }

virtual AlgorithmIdentifier Botan::Private_Key::pkcs8_algorithm_identifier | ( |  | ) | const
| inline virtual inherited

Returns
  PKCS #8 AlgorithmIdentifier for this key Might be different from the X.509 identifier, but normally is not

Reimplemented in Botan::XMSS_WOTS_PrivateKey, Botan::GOST_3410_PrivateKey, and Botan::XMSS_WOTS_Addressed_PrivateKey.

Definition at line 205 of file pk_keys.h.

Referenced by Botan::Private_Key::private_key_info().

206 { return algorithm_identifier(); }
Botan::Public_Key::algorithm_identifier
virtual AlgorithmIdentifier algorithm_identifier() const =0

const secure_vector<uint8_t>& Botan::XMSS_PrivateKey::prf | ( |  | ) | const
| inline

Definition at line 170 of file xmss_privatekey.h.

171 {
172 return m_prf;
173 }

secure_vector<uint8_t>& Botan::XMSS_PrivateKey::prf | ( |  | ) |
| inline

Definition at line 175 of file xmss_privatekey.h.

176 {
177 return m_prf;
178 }

secure_vector<uint8_t> Botan::XMSS_PrivateKey::private_key_bits | ( |  | ) | const
| inline override virtual

Returns
  BER encoded private key bits

Implements Botan::Private_Key.

Definition at line 203 of file xmss_privatekey.h.

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::get_contents(), and Botan::OCTET_STRING.

204 {
205 return DER_Encoder().encode(raw_private_key(), OCTET_STRING).get_contents();
206 }
Botan::XMSS_PrivateKey::raw_private_key
secure_vector< uint8_t > raw_private_key() const
Definition: xmss_privatekey.cpp:315
Botan::OCTET_STRING
Definition: asn1_obj.h:36

secure_vector< uint8_t > Botan::Private_Key::private_key_info | ( |  | ) | const
| inherited

Returns
  PKCS #8 private key encoding for this key object

Definition at line 61 of file pk_keys.cpp.

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::OCTET_STRING, Botan::Private_Key::pkcs8_algorithm_identifier(), Botan::Private_Key::private_key_bits(), Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

Referenced by Botan::PKCS8::BER_encode(), Botan::PKCS8::BER_encode_encrypted_pbkdf_iter(), and Botan::PKCS8::BER_encode_encrypted_pbkdf_msec().

62 {
63 const size_t PKCS8_VERSION = 0;
64
65 return DER_Encoder()
66 .start_cons(SEQUENCE)
67 .encode(PKCS8_VERSION)
68 .encode(pkcs8_algorithm_identifier())
69 .encode(private_key_bits(), OCTET_STRING)
70 .end_cons()
71 .get_contents();
72 }
Botan::Private_Key::private_key_bits
virtual secure_vector< uint8_t > private_key_bits() const =0
Botan::SEQUENCE
Definition: asn1_obj.h:40
Botan::Private_Key::pkcs8_algorithm_identifier
virtual AlgorithmIdentifier pkcs8_algorithm_identifier() const
Definition: pk_keys.h:205
Botan::OCTET_STRING
Definition: asn1_obj.h:36

std::vector<uint8_t> Botan::XMSS_PublicKey::public_key_bits | ( |  | ) | const
| inline override virtual inherited

Returns the encoded public key as defined in RFC draft-vangeest-x509-hash-sigs-03.

Returns
  encoded public key bits

Implements Botan::Public_Key.

Definition at line 222 of file xmss_publickey.h.

References Botan::DER_Encoder::encode(), and Botan::OCTET_STRING.

223 {
224 std::vector<uint8_t> output;
225 DER_Encoder(output).encode(raw_public_key(), OCTET_STRING);
226 return output;
227 }
Botan::XMSS_PublicKey::raw_public_key
virtual std::vector< uint8_t > raw_public_key() const
Definition: xmss_publickey.cpp:96
Botan::OCTET_STRING
Definition: asn1_obj.h:36

virtual secure_vector<uint8_t>& Botan::XMSS_PublicKey::public_seed | ( |  | ) |
| inline virtual inherited

Definition at line 167 of file xmss_publickey.h.

168 {
169 return m_public_seed;
170 }
Botan::XMSS_PublicKey::m_public_seed
secure_vector< uint8_t > m_public_seed
Definition: xmss_publickey.h:254

const secure_vector<uint8_t>& Botan::XMSS_PrivateKey::public_seed | ( |  | ) | const
| inline override virtual

Reimplemented from Botan::XMSS_PublicKey.

Definition at line 193 of file xmss_privatekey.h.

Referenced by tree_hash().

194 {
195 return m_public_seed;
196 }
Botan::XMSS_PublicKey::m_public_seed
secure_vector< uint8_t > m_public_seed
Definition: xmss_publickey.h:254

void Botan::XMSS_Common_Ops::randomize_tree_hash | ( | secure_vector< uint8_t > & | result,
|  | const secure_vector< uint8_t > & | left,
|  | const secure_vector< uint8_t > & | right,
|  | XMSS_Address & | adrs,
|  | const secure_vector< uint8_t > & | seed,
|  | XMSS_Hash & | hash
| ) |  |
| protected inherited

Algorithm 7: "RAND_HASH"

Generates a randomized hash.

This overload is used in multithreaded scenarios, where it is required to provide seperate instances of XMSS_Hash to each thread.

Parameters

  [out] | result | The resulting randomized hash.
  [in] | left | Left half of the hash function input.
  [in] | right | Right half of the hash function input.
  [in] | adrs | Adress of the hash function call.
  [in] | seed | The seed for G.
  [in] | hash | Instance of XMSS_Hash, that may only by the thead executing generate_public_key.

Definition at line 14 of file xmss_common_ops.cpp.

References BOTAN_ASSERT, Botan::XMSS_Address::bytes(), Botan::XMSS_Parameters::element_size(), Botan::XMSS_Hash::h(), Botan::XMSS_Address::Key_Mode, Botan::XMSS_Common_Ops::m_xmss_params, Botan::XMSS_Address::Mask_LSB_Mode, Botan::XMSS_Address::Mask_MSB_Mode, Botan::XMSS_Hash::prf(), and Botan::XMSS_Address::set_key_mask_mode().

Referenced by Botan::XMSS_Common_Ops::create_l_tree(), Botan::XMSS_Common_Ops::randomize_tree_hash(), and tree_hash().

20 {
21 adrs.set_key_mask_mode(XMSS_Address::Key_Mask::Key_Mode);
22 secure_vector<uint8_t> key { hash.prf(seed, adrs.bytes()) };
23
24 adrs.set_key_mask_mode(XMSS_Address::Key_Mask::Mask_MSB_Mode);
25 secure_vector<uint8_t> bitmask_l { hash.prf(seed, adrs.bytes()) };
26
27 adrs.set_key_mask_mode(XMSS_Address::Key_Mask::Mask_LSB_Mode);
28 secure_vector<uint8_t> bitmask_r { hash.prf(seed, adrs.bytes()) };
29
30 BOTAN_ASSERT(bitmask_l.size() == left.size() &&
31 bitmask_r.size() == right.size(),
32 "Bitmask size doesn't match node size.");
33
34 secure_vector<uint8_t> concat_xor(m_xmss_params.element_size() * 2);
35 for(size_t i = 0; i < left.size(); i++)
36 {
37 concat_xor[i] = left[i] ^ bitmask_l[i];
38 concat_xor[i + left.size()] = right[i] ^ bitmask_r[i];
39 }
40
41 hash.h(result, key, concat_xor);
42 }
Botan::XMSS_Address::Key_Mask::Mask_MSB_Mode
Botan::XMSS_Parameters::element_size
size_t element_size() const
Definition: xmss_parameters.h:67
BOTAN_ASSERT
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:55
Botan::XMSS_Common_Ops::m_xmss_params
XMSS_Parameters m_xmss_params
Definition: xmss_common_ops.h:121
Botan::XMSS_Address::Key_Mask::Mask_LSB_Mode
hash
MechanismType hash
Definition: p11_mechanism.cpp:64
Botan::XMSS_Address::Key_Mask::Key_Mode

void Botan::XMSS_Common_Ops::randomize_tree_hash | ( | secure_vector< uint8_t > & | result,
|  | const secure_vector< uint8_t > & | left,
|  | const secure_vector< uint8_t > & | right,
|  | XMSS_Address & | adrs,
|  | const secure_vector< uint8_t > & | seed
| ) |  |
| inline protected inherited

Algorithm 7: "RAND_HASH"

Generates a randomized hash.

Parameters

  [out] | result | The resulting randomized hash.
  [in] | left | Left half of the hash function input.
  [in] | right | Right half of the hash function input.
  [in] | adrs | Adress of the hash function call.
  [in] | seed | The seed for G.

Definition at line 69 of file xmss_common_ops.h.

References Botan::XMSS_Common_Ops::m_hash, and Botan::XMSS_Common_Ops::randomize_tree_hash().

75 {
76 randomize_tree_hash(result, left, right, adrs, seed, m_hash);
77 }
Botan::XMSS_Common_Ops::m_hash
XMSS_Hash m_hash
Definition: xmss_common_ops.h:122
Botan::XMSS_Common_Ops::randomize_tree_hash
void randomize_tree_hash(secure_vector< uint8_t > &result, const secure_vector< uint8_t > &left, const secure_vector< uint8_t > &right, XMSS_Address &adrs, const secure_vector< uint8_t > &seed, XMSS_Hash &hash)
Definition: xmss_common_ops.cpp:14

secure_vector< uint8_t > Botan::XMSS_PrivateKey::raw_private_key | ( |  | ) | const

Generates a non standartized byte sequence representing the XMSS private key.

Returns
  byte sequence consisting of the following elements in order: 4-byte OID, n-byte root node, n-byte public seed, 8-byte unused leaf index, n-byte prf seed, n-byte private seed.

Definition at line 315 of file xmss_privatekey.cpp.

References Botan::XMSS_WOTS_PrivateKey::private_seed(), Botan::XMSS_PublicKey::raw_public_key(), size(), and unused_leaf_index().

316 {
317 std::vector<uint8_t> pk { raw_public_key() };
318 secure_vector<uint8_t> result(pk.begin(), pk.end());
319 result.reserve(size());
320
321 for(int i = 3; i >= 0; i--)
322 {
323 result.push_back(
324 static_cast<uint8_t>(
325 static_cast<uint64_t>(unused_leaf_index()) >> 8 * i));
326 }
327
328 std::copy(m_prf.begin(), m_prf.end(), std::back_inserter(result));
329 std::copy(m_wots_priv_key.private_seed().begin(),
330 m_wots_priv_key.private_seed().end(),
331 std::back_inserter(result));
332
333 return result;
334 }
Botan::XMSS_WOTS_PrivateKey::private_seed
const secure_vector< uint8_t > & private_seed() const
Definition: xmss_wots_privatekey.h:268
Botan::XMSS_PrivateKey::size
size_t size() const override
Definition: xmss_privatekey.h:208
Botan::XMSS_PublicKey::raw_public_key
virtual std::vector< uint8_t > raw_public_key() const
Definition: xmss_publickey.cpp:96
Botan::XMSS_PrivateKey::unused_leaf_index
size_t unused_leaf_index() const
Definition: xmss_privatekey.h:103

std::vector< uint8_t > Botan::XMSS_PublicKey::raw_public_key | ( |  | ) | const
| virtual inherited

Generates a byte sequence representing the XMSS public key, as defined in 1

Returns
  4-byte OID, followed by n-byte root node, followed by public seed.

Definition at line 96 of file xmss_publickey.cpp.

References Botan::XMSS_PublicKey::m_public_seed, Botan::XMSS_PublicKey::m_root, Botan::XMSS_PublicKey::m_xmss_params, and Botan::XMSS_Parameters::oid().

Referenced by raw_private_key().

97 {
98 std::vector<uint8_t> result
99 {
100 static_cast<uint8_t>(m_xmss_params.oid() >> 24),
101 static_cast<uint8_t>(m_xmss_params.oid() >> 16),
102 static_cast<uint8_t>(m_xmss_params.oid() >> 8),
103 static_cast<uint8_t>(m_xmss_params.oid())
104 };
105
106 std::copy(m_root.begin(), m_root.end(), std::back_inserter(result));
107 std::copy(m_public_seed.begin(),
108 m_public_seed.end(),
109 std::back_inserter(result));
110
111 return result;
112 }
Botan::XMSS_PublicKey::m_public_seed
secure_vector< uint8_t > m_public_seed
Definition: xmss_publickey.h:254
Botan::XMSS_PublicKey::m_root
secure_vector< uint8_t > m_root
Definition: xmss_publickey.h:253
Botan::XMSS_Parameters::oid
xmss_algorithm_t oid() const
Definition: xmss_parameters.h:84
Botan::XMSS_PublicKey::m_xmss_params
XMSS_Parameters m_xmss_params
Definition: xmss_publickey.h:251

size_t Botan::XMSS_PrivateKey::reserve_unused_leaf_index | ( |  | ) |
| inline

Definition at line 137 of file xmss_privatekey.h.

References Botan::XMSS_PublicKey::m_xmss_params.

138 {
139 size_t idx = (static_cast<std::atomic<size_t>&>(
140 *recover_global_leaf_index())).fetch_add(1);
141 if(idx >= (1ull << XMSS_PublicKey::m_xmss_params.tree_height()))
142 {
143 throw Decoding_Error("XMSS private key, one time signatures exhaused");
144 }
145 return idx;
146 }
Botan::XMSS_PublicKey::m_xmss_params
XMSS_Parameters m_xmss_params
Definition: xmss_publickey.h:251

secure_vector<uint8_t>& Botan::XMSS_PublicKey::root | ( |  | ) |
| inline inherited

Definition at line 147 of file xmss_publickey.h.

148 {
149 return m_root;
150 }
Botan::XMSS_PublicKey::m_root
secure_vector< uint8_t > m_root
Definition: xmss_publickey.h:253

const secure_vector<uint8_t>& Botan::XMSS_PublicKey::root | ( |  | ) | const
| inline inherited

Definition at line 162 of file xmss_publickey.h.

163 {
164 return m_root;
165 }
Botan::XMSS_PublicKey::m_root
secure_vector< uint8_t > m_root
Definition: xmss_publickey.h:253

void Botan::XMSS_PrivateKey::set_public_seed | ( | const secure_vector< uint8_t > & | public_seed | ) |
| inline override virtual

Reimplemented from Botan::XMSS_PublicKey.

Definition at line 180 of file xmss_privatekey.h.

182 {
183 m_public_seed = public_seed;
184 m_wots_priv_key.set_public_seed(public_seed);
185 }
Botan::XMSS_PrivateKey::public_seed
const secure_vector< uint8_t > & public_seed() const override
Definition: xmss_privatekey.h:193
Botan::XMSS_PublicKey::m_public_seed
secure_vector< uint8_t > m_public_seed
Definition: xmss_publickey.h:254
Botan::XMSS_WOTS_PublicKey::set_public_seed
void set_public_seed(const secure_vector< uint8_t > &public_seed)
Definition: xmss_wots_publickey.h:205

void Botan::XMSS_PrivateKey::set_public_seed | ( | secure_vector< uint8_t > && | public_seed | ) |
| inline override virtual

Reimplemented from Botan::XMSS_PublicKey.

Definition at line 187 of file xmss_privatekey.h.

188 {
189 m_public_seed = std::move(public_seed);
190 m_wots_priv_key.set_public_seed(m_public_seed);
191 }
Botan::XMSS_PrivateKey::public_seed
const secure_vector< uint8_t > & public_seed() const override
Definition: xmss_privatekey.h:193
Botan::XMSS_PublicKey::m_public_seed
secure_vector< uint8_t > m_public_seed
Definition: xmss_publickey.h:254
Botan::XMSS_WOTS_PublicKey::set_public_seed
void set_public_seed(const secure_vector< uint8_t > &public_seed)
Definition: xmss_wots_publickey.h:205

void Botan::XMSS_PublicKey::set_root | ( | const secure_vector< uint8_t > & | root | ) |
| inline inherited

Definition at line 152 of file xmss_publickey.h.

Referenced by XMSS_PrivateKey().

153 {
154 m_root = root;
155 }
Botan::XMSS_PublicKey::m_root
secure_vector< uint8_t > m_root
Definition: xmss_publickey.h:253
Botan::XMSS_PublicKey::root
secure_vector< uint8_t > & root()
Definition: xmss_publickey.h:147

void Botan::XMSS_PublicKey::set_root | ( | secure_vector< uint8_t > && | root | ) |
| inline inherited

Definition at line 157 of file xmss_publickey.h.

158 {
159 m_root = std::move(root);
160 }
Botan::XMSS_PublicKey::m_root
secure_vector< uint8_t > m_root
Definition: xmss_publickey.h:253
Botan::XMSS_PublicKey::root
secure_vector< uint8_t > & root()
Definition: xmss_publickey.h:147

void Botan::XMSS_PrivateKey::set_unused_leaf_index | ( | size_t | idx | ) |
| inline

Sets the last unused leaf index of the private key. The leaf index will be updated automatically during every signing operation, and should not be set manually.

Parameters

  idx | Index of the last unused leaf.

Definition at line 115 of file xmss_privatekey.h.

References Botan::XMSS_PublicKey::m_xmss_params.

Referenced by XMSS_PrivateKey().

116 {
117 if(idx >= (1ull << XMSS_PublicKey::m_xmss_params.tree_height()))
118 {
119 throw Decoding_Error("XMSS private key leaf index out of bounds");
120 }
121 else
122 {
123 std::atomic<size_t>& index =
124 static_cast<std::atomic<size_t>&>(*recover_global_leaf_index());
125 size_t current = 0;
126
127 do
128 {
129 current = index.load();
130 if(current > idx)
131 { return; }
132 }
133 while(!index.compare_exchange_strong(current, idx));
134 }
135 }
Botan::XMSS_PublicKey::m_xmss_params
XMSS_Parameters m_xmss_params
Definition: xmss_publickey.h:251

void Botan::XMSS_PublicKey::set_xmss_oid | ( | XMSS_Parameters::xmss_algorithm_t | xmss_oid | ) |
| inline inherited

Sets the chosen XMSS signature method

Definition at line 108 of file xmss_publickey.h.

109 {
110 m_xmss_params = XMSS_Parameters(xmss_oid);
111 m_wots_params = XMSS_WOTS_Parameters(m_xmss_params.ots_oid());
112 }
Botan::XMSS_Parameters::ots_oid
XMSS_WOTS_Parameters::ots_algorithm_t ots_oid() const
Definition: xmss_parameters.h:86
Botan::XMSS_PublicKey::xmss_oid
XMSS_Parameters::xmss_algorithm_t xmss_oid() const
Definition: xmss_publickey.h:100
Botan::XMSS_PublicKey::m_wots_params
XMSS_WOTS_Parameters m_wots_params
Definition: xmss_publickey.h:252
Botan::XMSS_PublicKey::m_xmss_params
XMSS_Parameters m_xmss_params
Definition: xmss_publickey.h:251

size_t Botan::XMSS_PrivateKey::size | ( |  | ) | const
| inline override virtual

Size in bytes of the serialized XMSS public key produced by raw_public_key().

Returns
  size in bytes of serialized Public Key.

Reimplemented from Botan::XMSS_PublicKey.

Definition at line 208 of file xmss_privatekey.h.

References Botan::XMSS_PublicKey::m_xmss_params, and Botan::XMSS_PublicKey::size().

Referenced by raw_private_key(), and XMSS_PrivateKey().

209 {
210 return XMSS_PublicKey::size() +
211 sizeof(uint32_t) +
212 2 * XMSS_PublicKey::m_xmss_params.element_size();
213 }
Botan::XMSS_PublicKey::size
virtual size_t size() const
Definition: xmss_publickey.h:235
Botan::XMSS_PublicKey::m_xmss_params
XMSS_Parameters m_xmss_params
Definition: xmss_publickey.h:251

bool Botan::XMSS_PrivateKey::stateful_operation | ( |  | ) | const
| inline override virtual

Reimplemented from Botan::Private_Key.

Definition at line 94 of file xmss_privatekey.h.

94 { return true; }

std::vector< uint8_t > Botan::Public_Key::subject_public_key | ( |  | ) | const
| inherited

Returns
  X.509 subject key encoding for this key object

Definition at line 38 of file pk_keys.cpp.

References Botan::Public_Key::algorithm_identifier(), Botan::BIT_STRING, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::Public_Key::public_key_bits(), Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

Referenced by Botan::X509::BER_encode(), Botan::PKCS10_Request::create(), Botan::Public_Key::fingerprint_public(), and Botan::X509::PEM_encode().

39 {
40 std::vector<uint8_t> output;
41
42 DER_Encoder(output).start_cons(SEQUENCE)
43 .encode(algorithm_identifier())
44 .encode(public_key_bits(), BIT_STRING)
45 .end_cons();
46
47 return output;
48 }
Botan::Public_Key::public_key_bits
virtual std::vector< uint8_t > public_key_bits() const =0
Botan::Public_Key::algorithm_identifier
virtual AlgorithmIdentifier algorithm_identifier() const =0
Botan::SEQUENCE
Definition: asn1_obj.h:40
Botan::BIT_STRING
Definition: asn1_obj.h:35

secure_vector< uint8_t > Botan::XMSS_PrivateKey::tree_hash | ( | size_t | start_idx,
|  | size_t | target_node_height,
|  | XMSS_Address & | adrs
| ) |  |

Algorithm 9: "treeHash" Computes the internal n-byte nodes of a Merkle tree.

Parameters

  start_idx | The start index.
  target_node_height | Height of the target node.
  adrs | Address of the tree containing the target node.

Returns
  The root node of a tree of height target_node height with the leftmost leaf being the hash of the WOTS+ pk with index start_idx.

Definition at line 115 of file xmss_privatekey.cpp.

References BOTAN_ASSERT, BOTAN_ASSERT_NOMSG, Botan::Thread_Pool::global_instance(), Botan::XMSS_Common_Ops::m_hash, Botan::XMSS_PublicKey::m_xmss_params, public_seed(), Botan::XMSS_Common_Ops::randomize_tree_hash(), Botan::Thread_Pool::run(), and Botan::Thread_Pool::worker_count().

Referenced by XMSS_PrivateKey().

118 {
119 BOTAN_ASSERT_NOMSG(target_node_height <= 30);
120 BOTAN_ASSERT((start_idx % (static_cast<size_t>(1) << target_node_height)) == 0,
121 "Start index must be divisible by 2^{target node height}.");
122
123 #if defined(BOTAN_HAS_THREAD_UTILS)
124 // dertermine number of parallel tasks to split the tree_hashing into.
125
126 Thread_Pool& thread_pool = Thread_Pool::global_instance();
127
128 const size_t split_level = std::min(target_node_height, thread_pool.worker_count());
129
130 // skip parallelization overhead for leaf nodes.
131 if(split_level == 0)
132 {
133 secure_vector<uint8_t> result;
134 tree_hash_subtree(result, start_idx, target_node_height, adrs);
135 return result;
136 }
137
138 const size_t subtrees = static_cast<size_t>(1) << split_level;
139 const size_t last_idx = (static_cast<size_t>(1) << (target_node_height)) + start_idx;
140 const size_t offs = (last_idx - start_idx) / subtrees;
141 // this cast cannot overflow because target_node_height is limited
142 uint8_t level = static_cast<uint8_t>(split_level); // current level in the tree
143
144 BOTAN_ASSERT((last_idx - start_idx) % subtrees == 0,
145 "Number of worker threads in tree_hash need to divide range "
146 "of calculated nodes.");
147
148 std::vector<secure_vector<uint8_t>> nodes(
149 subtrees,
150 secure_vector<uint8_t>(XMSS_PublicKey::m_xmss_params.element_size()));
151 std::vector<XMSS_Address> node_addresses(subtrees, adrs);
152 std::vector<XMSS_Hash> xmss_hash(subtrees, m_hash);
153 std::vector<std::future<void>> work;
154
155 // Calculate multiple subtrees in parallel.
156 for(size_t i = 0; i < subtrees; i++)
157 {
158 using tree_hash_subtree_fn_t =
159 void (XMSS_PrivateKey::*)(secure_vector<uint8_t>&,
160 size_t,
161 size_t,
162 XMSS_Address&,
163 XMSS_Hash&);
164
165 auto work_fn = static_cast<tree_hash_subtree_fn_t>(&XMSS_PrivateKey::tree_hash_subtree);
166
167 work.push_back(thread_pool.run(
168 work_fn,
169 this,
170 std::ref(nodes[i]),
171 start_idx + i * offs,
172 target_node_height - split_level,
173 std::ref(node_addresses[i]),
174 std::ref(xmss_hash[i])));
175 }
176
177 for(auto& w : work)
178 {
179 w.get();
180 }
181 work.clear();
182
183 // Parallelize the top tree levels horizontally
184 while(level-- > 1)
185 {
186 std::vector<secure_vector<uint8_t>> ro_nodes(
187 nodes.begin(), nodes.begin() + (static_cast<size_t>(1) << (level+1)));
188
189 for(size_t i = 0; i < (static_cast<size_t>(1) << level); i++)
190 {
191 BOTAN_ASSERT_NOMSG(xmss_hash.size() > i);
192
193 node_addresses[i].set_tree_height(static_cast<uint32_t>(target_node_height - (level + 1)));
194 node_addresses[i].set_tree_index(
195 (node_addresses[2 * i + 1].get_tree_index() - 1) >> 1);
196 using rnd_tree_hash_fn_t =
197 void (XMSS_PrivateKey::*)(secure_vector<uint8_t>&,
198 const secure_vector<uint8_t>&,
199 const secure_vector<uint8_t>&,
200 XMSS_Address& adrs,
201 const secure_vector<uint8_t>&,
202 XMSS_Hash&);
203
204 auto work_fn = static_cast<rnd_tree_hash_fn_t>(&XMSS_PrivateKey::randomize_tree_hash);
205
206 work.push_back(thread_pool.run(
207 work_fn,
208 this,
209 std::ref(nodes[i]),
210 std::ref(ro_nodes[2 * i]),
211 std::ref(ro_nodes[2 * i + 1]),
212 std::ref(node_addresses[i]),
213 std::ref(this->public_seed()),
214 std::ref(xmss_hash[i])));
215 }
216
217 for(auto &w : work)
218 {
219 w.get();
220 }
221 work.clear();
222 }
223
224 // Avoid creation an extra thread to calculate root node.
225 node_addresses[0].set_tree_height(static_cast<uint32_t>(target_node_height - 1));
226 node_addresses[0].set_tree_index(
227 (node_addresses[1].get_tree_index() - 1) >> 1);
228 randomize_tree_hash(nodes[0],
229 nodes[0],
230 nodes[1],
231 node_addresses[0],
232 this->public_seed());
233 return nodes[0];
234 #else
235 secure_vector<uint8_t> result;
236 tree_hash_subtree(result, start_idx, target_node_height, adrs);
237 return result;
238 #endif
239 }
Botan::XMSS_PrivateKey::public_seed
const secure_vector< uint8_t > & public_seed() const override
Definition: xmss_privatekey.h:193
BOTAN_ASSERT_NOMSG
#define BOTAN_ASSERT_NOMSG(expr)
Definition: assert.h:68
BOTAN_ASSERT
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:55
Botan::XMSS_PrivateKey::XMSS_PrivateKey
XMSS_PrivateKey(XMSS_Parameters::xmss_algorithm_t xmss_algo_id, RandomNumberGenerator &rng)
Definition: xmss_privatekey.cpp:97
Botan::XMSS_Common_Ops::m_hash
XMSS_Hash m_hash
Definition: xmss_common_ops.h:122
Botan::Thread_Pool::global_instance
static Thread_Pool & global_instance()
Definition: thread_pool.cpp:15
Botan::XMSS_Common_Ops::randomize_tree_hash
void randomize_tree_hash(secure_vector< uint8_t > &result, const secure_vector< uint8_t > &left, const secure_vector< uint8_t > &right, XMSS_Address &adrs, const secure_vector< uint8_t > &seed, XMSS_Hash &hash)
Definition: xmss_common_ops.cpp:14
Botan::XMSS_PublicKey::m_xmss_params
XMSS_Parameters m_xmss_params
Definition: xmss_publickey.h:251

size_t Botan::XMSS_PrivateKey::unused_leaf_index | ( |  | ) | const
| inline

Retrieves the last unused leaf index of the private key. Reusing a leaf by utilizing leaf indices lower than the last unused leaf index will compromise security.

Returns
  Index of the last unused leaf.

Definition at line 103 of file xmss_privatekey.h.

Referenced by raw_private_key().

104 {
105 return *recover_global_leaf_index();
106 }

XMSS_WOTS_Parameters::ots_algorithm_t Botan::XMSS_PublicKey::wots_oid | ( |  | ) | const
| inline inherited

Retrieves the Winternitz One Time Signature (WOTS) method, corresponding to the chosen XMSS signature method.

Returns
  XMSS WOTS signature method identifier.

Definition at line 131 of file xmss_publickey.h.

132 {
133 return m_wots_params.oid();
134 }
Botan::XMSS_PublicKey::m_wots_params
XMSS_WOTS_Parameters m_wots_params
Definition: xmss_publickey.h:252
Botan::XMSS_WOTS_Parameters::oid
ots_algorithm_t oid() const
Definition: xmss_wots_parameters.h:97

const XMSS_WOTS_Parameters& Botan::XMSS_PublicKey::wots_parameters | ( |  | ) | const
| inline inherited

Retrieves the Winternitz One Time Signature (WOTS) parameters corresponding to the chosen XMSS signature method.

Returns
  XMSS WOTS signature method parameters.

Definition at line 142 of file xmss_publickey.h.

143 {
144 return m_wots_params;
145 }
Botan::XMSS_PublicKey::m_wots_params
XMSS_WOTS_Parameters m_wots_params
Definition: xmss_publickey.h:252

const XMSS_WOTS_PrivateKey& Botan::XMSS_PrivateKey::wots_private_key | ( |  | ) | const
| inline

Winternitz One Time Signature Scheme key utilized for signing operations.

Returns
  WOTS+ private key.

Definition at line 154 of file xmss_privatekey.h.

155 {
156 return m_wots_priv_key;
157 }

XMSS_WOTS_PrivateKey& Botan::XMSS_PrivateKey::wots_private_key | ( |  | ) |
| inline

Winternitz One Time Signature Scheme key utilized for signing operations.

Returns
  WOTS+ private key.

Definition at line 165 of file xmss_privatekey.h.

166 {
167 return m_wots_priv_key;
168 }

XMSS_Parameters::xmss_algorithm_t Botan::XMSS_PublicKey::xmss_oid | ( |  | ) | const
| inline inherited

Retrieves the chosen XMSS signature method.

Returns
  XMSS signature method identifier.

Definition at line 100 of file xmss_publickey.h.

101 {
102 return m_xmss_params.oid();
103 }
Botan::XMSS_Parameters::oid
xmss_algorithm_t oid() const
Definition: xmss_parameters.h:84
Botan::XMSS_PublicKey::m_xmss_params
XMSS_Parameters m_xmss_params
Definition: xmss_publickey.h:251

const XMSS_Parameters& Botan::XMSS_PublicKey::xmss_parameters | ( |  | ) | const
| inline inherited

Retrieves the XMSS parameters determined by the chosen XMSS Signature method.

Returns
  XMSS parameters.

Definition at line 120 of file xmss_publickey.h.

Referenced by Botan::XMSS_Verification_Operation::is_valid_signature().

121 {
122 return m_xmss_params;
123 }
Botan::XMSS_PublicKey::m_xmss_params
XMSS_Parameters m_xmss_params
Definition: xmss_publickey.h:251

## Member Data Documentation

XMSS_Hash Botan::XMSS_Common_Ops::m_hash
| protected inherited

Definition at line 122 of file xmss_common_ops.h.

Referenced by Botan::XMSS_Common_Ops::create_l_tree(), Botan::XMSS_Common_Ops::randomize_tree_hash(), Botan::XMSS_Signature_Operation::sign(), tree_hash(), and Botan::XMSS_Signature_Operation::update().

secure_vector<uint8_t> Botan::XMSS_PublicKey::m_public_seed
| protected inherited

Definition at line 254 of file xmss_publickey.h.

Referenced by Botan::XMSS_PublicKey::raw_public_key(), and Botan::XMSS_PublicKey::XMSS_PublicKey().

std::vector<uint8_t> Botan::XMSS_PublicKey::m_raw_key
| protected inherited

Definition at line 250 of file xmss_publickey.h.

Referenced by Botan::XMSS_PublicKey::XMSS_PublicKey().

secure_vector<uint8_t> Botan::XMSS_PublicKey::m_root
| protected inherited

Definition at line 253 of file xmss_publickey.h.

Referenced by Botan::XMSS_PublicKey::raw_public_key(), and Botan::XMSS_PublicKey::XMSS_PublicKey().

XMSS_WOTS_Parameters Botan::XMSS_PublicKey::m_wots_params
| protected inherited

Definition at line 252 of file xmss_publickey.h.

Referenced by XMSS_PrivateKey().

XMSS_Parameters Botan::XMSS_Common_Ops::m_xmss_params
| protected inherited

Definition at line 121 of file xmss_common_ops.h.

Referenced by Botan::XMSS_Common_Ops::create_l_tree(), Botan::XMSS_Common_Ops::randomize_tree_hash(), and Botan::XMSS_Signature_Operation::signature_length().

XMSS_Parameters Botan::XMSS_PublicKey::m_xmss_params
| protected inherited

Definition at line 251 of file xmss_publickey.h.

Referenced by Botan::XMSS_PublicKey::raw_public_key(), reserve_unused_leaf_index(), set_unused_leaf_index(), size(), tree_hash(), XMSS_PrivateKey(), and Botan::XMSS_PublicKey::XMSS_PublicKey().

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

- src/lib/pubkey/xmss/xmss_privatekey.h
- src/lib/pubkey/xmss/xmss_privatekey.cpp