Botan  2.10.0
Crypto and TLS for C++11
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:
Botan::XMSS_PublicKey Botan::XMSS_Common_Ops Botan::Private_Key Botan::Public_Key Botan::Public_Key

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::Decryptioncreate_decryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
 
virtual std::unique_ptr< PK_Ops::Encryptioncreate_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
 
virtual std::unique_ptr< PK_Ops::KEM_Decryptioncreate_kem_decryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
 
virtual std::unique_ptr< PK_Ops::KEM_Encryptioncreate_kem_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
 
virtual std::unique_ptr< PK_Ops::Key_Agreementcreate_key_agreement_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
 
std::unique_ptr< PK_Ops::Signaturecreate_signature_op (RandomNumberGenerator &, const std::string &, const std::string &provider) const override
 
std::unique_ptr< PK_Ops::Verificationcreate_verification_op (const std::string &, const std::string &provider) const override
 
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
 
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_Parameterswots_parameters () const
 
const XMSS_WOTS_PrivateKeywots_private_key () const
 
XMSS_WOTS_PrivateKeywots_private_key ()
 
XMSS_Parameters::xmss_algorithm_t xmss_oid () const
 
const XMSS_Parametersxmss_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
 
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, draft-itrf-cfrg-xmss-hash-based-signatures-06 Release: July 2016. https://datatracker.ietf.org/doc/ draft-irtf-cfrg-xmss-hash-based-signatures/?include_text=1

Definition at line 38 of file xmss_privatekey.h.

Constructor & Destructor Documentation

◆ XMSS_PrivateKey() [1/3]

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_idIdentifier for the selected XMSS signature method.
rngA random number generator to use for key generation.

Definition at line 76 of file xmss_privatekey.cpp.

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

79  : XMSS_PublicKey(xmss_algo_id, rng),
80  XMSS_Common_Ops(xmss_algo_id),
81  m_wots_priv_key(XMSS_PublicKey::m_xmss_params.ots_oid(),
82  public_seed(),
83  rng),
84  m_prf(rng.random_vec(XMSS_PublicKey::m_xmss_params.element_size())),
86  {
87  XMSS_Address adrs;
89  XMSS_PublicKey::m_xmss_params.tree_height(),
90  adrs));
91  }
const secure_vector< uint8_t > & public_seed() const override
XMSS_Common_Ops(XMSS_Parameters::xmss_algorithm_t oid)
secure_vector< uint8_t > tree_hash(size_t start_idx, size_t target_node_height, XMSS_Address &adrs)
void set_root(const secure_vector< uint8_t > &root)
size_t element_size() const
XMSS_PublicKey(XMSS_Parameters::xmss_algorithm_t xmss_oid, RandomNumberGenerator &rng)
XMSS_Parameters m_xmss_params
static XMSS_Index_Registry & get_instance()

◆ XMSS_PrivateKey() [2/3]

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_keyAn XMSS private key serialized using raw_private_key().

Definition at line 28 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().

29  : XMSS_PublicKey(unlock(raw_key)),
31  m_wots_priv_key(m_wots_params.oid(), m_public_seed),
33  {
34  /*
35  The code requires sizeof(size_t) >= ceil(tree_height / 8)
36 
37  Maximum supported tree height is 20, ceil(20/8) == 3, so 4 byte
38  size_t is sufficient for all defined parameters, or even a
39  (hypothetical) tree height 32, which would be extremely slow to
40  compute.
41  */
42  static_assert(sizeof(size_t) >= 4, "size_t is big enough to support leaf index");
43 
44  if(raw_key.size() != size())
45  {
46  throw Decoding_Error("Invalid XMSS private key size detected.");
47  }
48 
49  // extract & copy unused leaf index from raw_key.
50  uint64_t unused_leaf = 0;
51  auto begin = (raw_key.begin() + XMSS_PublicKey::size());
52  auto end = raw_key.begin() + XMSS_PublicKey::size() + sizeof(uint64_t);
53 
54  for(auto& i = begin; i != end; i++)
55  {
56  unused_leaf = ((unused_leaf << 8) | *i);
57  }
58 
59  if(unused_leaf >= (1ull << XMSS_PublicKey::m_xmss_params.tree_height()))
60  {
61  throw Decoding_Error("XMSS private key leaf index out of bounds");
62  }
63 
64  begin = end;
66  m_prf.clear();
67  m_prf.reserve(XMSS_PublicKey::m_xmss_params.element_size());
68  std::copy(begin, end, std::back_inserter(m_prf));
69 
70  begin = end;
71  end = begin + m_wots_params.element_size();
72  m_wots_priv_key.set_private_seed(secure_vector<uint8_t>(begin, end));
73  set_unused_leaf_index(static_cast<size_t>(unused_leaf));
74  }
secure_vector< uint8_t > m_public_seed
XMSS_Common_Ops(XMSS_Parameters::xmss_algorithm_t oid)
void set_unused_leaf_index(size_t idx)
virtual size_t size() const
size_t size() const override
std::vector< T > unlock(const secure_vector< T > &in)
Definition: secmem.h:72
size_t element_size() const
XMSS_PublicKey(XMSS_Parameters::xmss_algorithm_t xmss_oid, RandomNumberGenerator &rng)
XMSS_WOTS_Parameters m_wots_params
void set_private_seed(const secure_vector< uint8_t > &private_seed)
XMSS_Parameters m_xmss_params
static XMSS_Index_Registry & get_instance()
ots_algorithm_t oid() const

◆ XMSS_PrivateKey() [3/3]

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_idIdentifier for the selected XMSS signature method.
idx_leafIndex of the next unused leaf.
wots_priv_seedA seed to generate a Winternitz-One-Time- Signature private key from.
prfa secret n-byte key sourced from a secure source of uniformly random data.
rootRoot node of the binary hash tree.
public_seedThe public seed.

Definition at line 78 of file xmss_privatekey.h.

84  : XMSS_PublicKey(xmss_algo_id, root, public_seed),
85  XMSS_Common_Ops(xmss_algo_id),
86  m_wots_priv_key(XMSS_PublicKey::m_xmss_params.ots_oid(),
88  wots_priv_seed),
89  m_prf(prf),
91  {
92  set_unused_leaf_index(idx_leaf);
93  }
const secure_vector< uint8_t > & public_seed() const override
XMSS_Common_Ops(XMSS_Parameters::xmss_algorithm_t oid)
void set_unused_leaf_index(size_t idx)
const secure_vector< uint8_t > & prf() const
secure_vector< uint8_t > & root()
XMSS_PublicKey(XMSS_Parameters::xmss_algorithm_t xmss_oid, RandomNumberGenerator &rng)
XMSS_Parameters m_xmss_params
static XMSS_Index_Registry & get_instance()

Member Function Documentation

◆ algo_name()

std::string Botan::XMSS_PublicKey::algo_name ( ) const
inlineoverridevirtualinherited

Get the name of the underlying public key scheme.

Returns
name of the public key scheme

Implements Botan::Public_Key.

Definition at line 185 of file xmss_publickey.h.

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

186  {
187  return "XMSS";
188  }

◆ algorithm_identifier()

AlgorithmIdentifier Botan::XMSS_PublicKey::algorithm_identifier ( ) const
inlineoverridevirtualinherited
Returns
X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 190 of file xmss_publickey.h.

References Botan::AlgorithmIdentifier::USE_NULL_PARAM.

191  {
192  return AlgorithmIdentifier(get_oid(), AlgorithmIdentifier::USE_NULL_PARAM);
193  }
virtual OID get_oid() const
Definition: pk_keys.cpp:53

◆ check_key()

bool Botan::XMSS_PublicKey::check_key ( RandomNumberGenerator rng,
bool  strong 
) const
inlineoverridevirtualinherited

Test the key values for consistency.

Parameters
rngrng to use
strongwhether to perform strong and lengthy version of the test
Returns
true if the test is passed

Implements Botan::Public_Key.

Definition at line 195 of file xmss_publickey.h.

196  {
197  return true;
198  }

◆ create_decryption_op()

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

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
rnga 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.
paramsadditional parameters
providerthe provider to use

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

Definition at line 117 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

120  {
121  throw Lookup_Error(algo_name() + " does not support decryption");
122  }
virtual std::string algo_name() const =0

◆ create_encryption_op()

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

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
rnga 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.
paramsadditional parameters
providerthe provider to use

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

Definition at line 94 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

97  {
98  throw Lookup_Error(algo_name() + " does not support encryption");
99  }
virtual std::string algo_name() const =0

◆ create_kem_decryption_op()

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
virtualinherited

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
rnga 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.
paramsadditional parameters
providerthe provider to use

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

Definition at line 125 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

128  {
129  throw Lookup_Error(algo_name() + " does not support KEM decryption");
130  }
virtual std::string algo_name() const =0

◆ create_kem_encryption_op()

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
virtualinherited

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
rnga 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.
paramsadditional parameters
providerthe provider to use

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

Definition at line 102 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

105  {
106  throw Lookup_Error(algo_name() + " does not support KEM encryption");
107  }
virtual std::string algo_name() const =0

◆ create_key_agreement_op()

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
virtualinherited

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
rnga 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.
paramsadditional parameters
providerthe provider to use

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

Definition at line 141 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

144  {
145  throw Lookup_Error(algo_name() + " does not support key agreement");
146  }
virtual std::string algo_name() const =0

◆ create_l_tree() [1/2]

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 
)
protectedinherited

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]resultPublic key compressed to a single n-byte value pk[0].
[in]pkWinternitz One Time Signatures+ public key.
[in]adrsAddress encoding the address of the L-Tree
[in]seedThe seed generated during the public key generation.
[in]hashInstance 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(), Botan::XMSS_Common_Ops::randomize_tree_hash(), tree_hash(), and Botan::XMSS_Verification_Operation::XMSS_Verification_Operation().

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  }
XMSS_Parameters m_xmss_params
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)
MechanismType hash

◆ create_l_tree() [2/2]

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 
)
inlineprotectedinherited

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]resultPublic key compressed to a single n-byte value pk[0].
[in]pkWinternitz One Time Signatures+ public key.
[in]adrsAddress encoding the address of the L-Tree
[in]seedThe seed generated during the public key generation.

Definition at line 110 of file xmss_common_ops.h.

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

114  {
115  create_l_tree(result, pk, adrs, seed, m_hash);
116  }
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)

◆ create_signature_op()

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

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
rnga 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.
paramsadditional parameters
providerthe provider to use

Reimplemented from Botan::Private_Key.

Definition at line 314 of file xmss_privatekey.cpp.

References Botan::XMSS_PublicKey::algo_name().

317  {
318  if(provider == "base" || provider.empty())
319  return std::unique_ptr<PK_Ops::Signature>(
320  new XMSS_Signature_Operation(*this));
321 
322  throw Provider_Not_Found(algo_name(), provider);
323  }
std::string algo_name() const override

◆ create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::XMSS_PublicKey::create_verification_op ( const std::string &  params,
const std::string &  provider 
) const
overridevirtualinherited

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
paramsadditional parameters
providerthe provider to use

Reimplemented from Botan::Public_Key.

Definition at line 64 of file xmss_publickey.cpp.

References Botan::XMSS_PublicKey::algo_name().

66  {
67  if(provider == "base" || provider.empty())
68  {
69  return std::unique_ptr<PK_Ops::Verification>(
70  new XMSS_Verification_Operation(*this));
71  }
72  throw Provider_Not_Found(algo_name(), provider);
73  }
std::string algo_name() const override

◆ estimated_strength()

size_t Botan::XMSS_PublicKey::estimated_strength ( ) const
inlineoverridevirtualinherited

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 204 of file xmss_publickey.h.

205  {
207  }
size_t estimated_strength() const
XMSS_Parameters m_xmss_params

◆ fingerprint()

std::string Botan::Private_Key::fingerprint ( const std::string &  alg) const
inlineinherited

Definition at line 204 of file pk_keys.h.

205  {
206  return fingerprint_private(alg); // match behavior in previous versions
207  }
std::string fingerprint_private(const std::string &alg) const
Definition: pk_keys.cpp:88

◆ fingerprint_private()

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 88 of file pk_keys.cpp.

References Botan::create_hex_fingerprint().

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().

89  {
91  }
virtual secure_vector< uint8_t > private_key_bits() const =0
AlgorithmIdentifier hash_algo
Definition: x509_obj.cpp:23
std::string create_hex_fingerprint(const uint8_t bits[], size_t bits_len, const std::string &hash_name)
Definition: pk_keys.cpp:17

◆ fingerprint_public()

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 80 of file pk_keys.cpp.

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

81  {
83  }
AlgorithmIdentifier hash_algo
Definition: x509_obj.cpp:23
std::string create_hex_fingerprint(const uint8_t bits[], size_t bits_len, const std::string &hash_name)
Definition: pk_keys.cpp:17
std::vector< uint8_t > subject_public_key() const
Definition: pk_keys.cpp:38

◆ get_oid()

OID Botan::Public_Key::get_oid ( ) const
virtualinherited

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(), and Botan::OIDS::lookup().

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  try {
56  return OIDS::lookup(algo_name());
57  }
58  catch(Lookup_Error&)
59  {
60  throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
61  }
62  }
virtual std::string algo_name() const =0
std::string lookup(const OID &oid)
Definition: oids.cpp:113

◆ key_length()

size_t Botan::XMSS_PublicKey::key_length ( ) const
inlineoverridevirtualinherited

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 209 of file xmss_publickey.h.

210  {
212  }
size_t estimated_strength() const
XMSS_Parameters m_xmss_params

◆ message_part_size()

virtual size_t Botan::Public_Key::message_part_size ( ) const
inlinevirtualinherited

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 119 of file pk_keys.h.

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

119 { return 0; }

◆ message_parts()

virtual size_t Botan::Public_Key::message_parts ( ) const
inlinevirtualinherited

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 108 of file pk_keys.h.

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

108 { return 1; }

◆ pkcs8_algorithm_identifier()

virtual AlgorithmIdentifier Botan::Private_Key::pkcs8_algorithm_identifier ( ) const
inlinevirtualinherited
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 193 of file pk_keys.h.

194  { return algorithm_identifier(); }
virtual AlgorithmIdentifier algorithm_identifier() const =0

◆ prf() [1/2]

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

Definition at line 169 of file xmss_privatekey.h.

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

170  {
171  return m_prf;
172  }

◆ prf() [2/2]

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

Definition at line 174 of file xmss_privatekey.h.

175  {
176  return m_prf;
177  }

◆ private_key_bits()

secure_vector<uint8_t> Botan::XMSS_PrivateKey::private_key_bits ( ) const
inlineoverridevirtual
Returns
BER encoded private key bits

Implements Botan::Private_Key.

Definition at line 202 of file xmss_privatekey.h.

203  {
204  return raw_private_key();
205  }
secure_vector< uint8_t > raw_private_key() const

◆ private_key_info()

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 64 of file pk_keys.cpp.

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::OCTET_STRING, 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().

65  {
66  const size_t PKCS8_VERSION = 0;
67 
68  return DER_Encoder()
69  .start_cons(SEQUENCE)
70  .encode(PKCS8_VERSION)
72  .encode(private_key_bits(), OCTET_STRING)
73  .end_cons()
74  .get_contents();
75  }
virtual secure_vector< uint8_t > private_key_bits() const =0
virtual AlgorithmIdentifier pkcs8_algorithm_identifier() const
Definition: pk_keys.h:193

◆ public_key_bits()

std::vector<uint8_t> Botan::XMSS_PublicKey::public_key_bits ( ) const
inlineoverridevirtualinherited

Returns a raw byte sequence as defined in [1]. This method acts as an alias for raw_public_key().

Returns
raw public key bits.

Implements Botan::Public_Key.

Definition at line 220 of file xmss_publickey.h.

221  {
222  return raw_public_key();
223  }
virtual std::vector< uint8_t > raw_public_key() const

◆ public_seed() [1/2]

virtual secure_vector<uint8_t>& Botan::XMSS_PublicKey::public_seed ( )
inlinevirtualinherited

Definition at line 165 of file xmss_publickey.h.

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

166  {
167  return m_public_seed;
168  }
secure_vector< uint8_t > m_public_seed

◆ public_seed() [2/2]

const secure_vector<uint8_t>& Botan::XMSS_PrivateKey::public_seed ( ) const
inlineoverridevirtual

Reimplemented from Botan::XMSS_PublicKey.

Definition at line 192 of file xmss_privatekey.h.

Referenced by tree_hash().

193  {
194  return m_public_seed;
195  }
secure_vector< uint8_t > m_public_seed

◆ randomize_tree_hash() [1/2]

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 
)
protectedinherited

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]resultThe resulting randomized hash.
[in]leftLeft half of the hash function input.
[in]rightRight half of the hash function input.
[in]adrsAdress of the hash function call.
[in]seedThe seed for G.
[in]hashInstance 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(), tree_hash(), Botan::XMSS_Common_Ops::XMSS_Common_Ops(), and Botan::XMSS_Verification_Operation::XMSS_Verification_Operation().

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  }
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:55
XMSS_Parameters m_xmss_params
size_t element_size() const
MechanismType hash

◆ randomize_tree_hash() [2/2]

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 
)
inlineprotectedinherited

Algorithm 7: "RAND_HASH"

Generates a randomized hash.

Parameters
[out]resultThe resulting randomized hash.
[in]leftLeft half of the hash function input.
[in]rightRight half of the hash function input.
[in]adrsAdress of the hash function call.
[in]seedThe seed for G.

Definition at line 67 of file xmss_common_ops.h.

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

73  {
74  randomize_tree_hash(result, left, right, adrs, seed, m_hash);
75  }
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)

◆ raw_private_key()

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 292 of file xmss_privatekey.cpp.

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

293  {
294  std::vector<uint8_t> pk { raw_public_key() };
295  secure_vector<uint8_t> result(pk.begin(), pk.end());
296  result.reserve(size());
297 
298  for(int i = 7; i >= 0; i--)
299  {
300  result.push_back(
301  static_cast<uint8_t>(
302  static_cast<uint64_t>(unused_leaf_index()) >> 8 * i));
303  }
304 
305  std::copy(m_prf.begin(), m_prf.end(), std::back_inserter(result));
306  std::copy(m_wots_priv_key.private_seed().begin(),
307  m_wots_priv_key.private_seed().end(),
308  std::back_inserter(result));
309 
310  return result;
311  }
virtual std::vector< uint8_t > raw_public_key() const
size_t unused_leaf_index() const
size_t size() const override
const secure_vector< uint8_t > & private_seed() const

◆ raw_public_key()

std::vector< uint8_t > Botan::XMSS_PublicKey::raw_public_key ( ) const
virtualinherited

Generates a non standardized 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 75 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().

76  {
77  std::vector<uint8_t> result
78  {
79  static_cast<uint8_t>(m_xmss_params.oid() >> 24),
80  static_cast<uint8_t>(m_xmss_params.oid() >> 16),
81  static_cast<uint8_t>(m_xmss_params.oid() >> 8),
82  static_cast<uint8_t>(m_xmss_params.oid())
83  };
84 
85  std::copy(m_root.begin(), m_root.end(), std::back_inserter(result));
86  std::copy(m_public_seed.begin(),
87  m_public_seed.end(),
88  std::back_inserter(result));
89 
90  return result;
91  }
secure_vector< uint8_t > m_public_seed
secure_vector< uint8_t > m_root
XMSS_Parameters m_xmss_params
xmss_algorithm_t oid() const

◆ reserve_unused_leaf_index()

size_t Botan::XMSS_PrivateKey::reserve_unused_leaf_index ( )
inline

Definition at line 136 of file xmss_privatekey.h.

References Botan::XMSS_PublicKey::m_xmss_params.

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

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

◆ root() [1/2]

secure_vector<uint8_t>& Botan::XMSS_PublicKey::root ( )
inlineinherited

Definition at line 145 of file xmss_publickey.h.

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

146  {
147  return m_root;
148  }
secure_vector< uint8_t > m_root

◆ root() [2/2]

const secure_vector<uint8_t>& Botan::XMSS_PublicKey::root ( ) const
inlineinherited

Definition at line 160 of file xmss_publickey.h.

161  {
162  return m_root;
163  }
secure_vector< uint8_t > m_root

◆ set_public_seed() [1/2]

void Botan::XMSS_PrivateKey::set_public_seed ( const secure_vector< uint8_t > &  public_seed)
inlineoverridevirtual

Reimplemented from Botan::XMSS_PublicKey.

Definition at line 179 of file xmss_privatekey.h.

181  {
183  m_wots_priv_key.set_public_seed(public_seed);
184  }
const secure_vector< uint8_t > & public_seed() const override
secure_vector< uint8_t > m_public_seed
void set_public_seed(const secure_vector< uint8_t > &public_seed)

◆ set_public_seed() [2/2]

void Botan::XMSS_PrivateKey::set_public_seed ( secure_vector< uint8_t > &&  public_seed)
inlineoverridevirtual

Reimplemented from Botan::XMSS_PublicKey.

Definition at line 186 of file xmss_privatekey.h.

187  {
188  m_public_seed = std::move(public_seed);
189  m_wots_priv_key.set_public_seed(m_public_seed);
190  }
const secure_vector< uint8_t > & public_seed() const override
secure_vector< uint8_t > m_public_seed
void set_public_seed(const secure_vector< uint8_t > &public_seed)

◆ set_root() [1/2]

void Botan::XMSS_PublicKey::set_root ( const secure_vector< uint8_t > &  root)
inlineinherited

Definition at line 150 of file xmss_publickey.h.

Referenced by XMSS_PrivateKey().

151  {
152  m_root = root;
153  }
secure_vector< uint8_t > m_root
secure_vector< uint8_t > & root()

◆ set_root() [2/2]

void Botan::XMSS_PublicKey::set_root ( secure_vector< uint8_t > &&  root)
inlineinherited

Definition at line 155 of file xmss_publickey.h.

156  {
157  m_root = std::move(root);
158  }
secure_vector< uint8_t > m_root
secure_vector< uint8_t > & root()

◆ set_unused_leaf_index()

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
idxIndex of the last unused leaf.

Definition at line 114 of file xmss_privatekey.h.

References Botan::XMSS_PublicKey::m_xmss_params.

Referenced by XMSS_PrivateKey().

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

◆ set_xmss_oid()

void Botan::XMSS_PublicKey::set_xmss_oid ( XMSS_Parameters::xmss_algorithm_t  xmss_oid)
inlineinherited

Sets the chosen XMSS signature method

Definition at line 106 of file xmss_publickey.h.

107  {
108  m_xmss_params = XMSS_Parameters(xmss_oid);
109  m_wots_params = XMSS_WOTS_Parameters(m_xmss_params.ots_oid());
110  }
XMSS_WOTS_Parameters::ots_algorithm_t ots_oid() const
XMSS_Parameters::xmss_algorithm_t xmss_oid() const
XMSS_WOTS_Parameters m_wots_params
XMSS_Parameters m_xmss_params

◆ size()

size_t Botan::XMSS_PrivateKey::size ( ) const
inlineoverridevirtual

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 207 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().

208  {
209  return XMSS_PublicKey::size() +
210  sizeof(uint64_t) +
211  2 * XMSS_PublicKey::m_xmss_params.element_size();
212  }
virtual size_t size() const
XMSS_Parameters m_xmss_params

◆ subject_public_key()

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  }
virtual std::vector< uint8_t > public_key_bits() const =0
virtual AlgorithmIdentifier algorithm_identifier() const =0

◆ tree_hash()

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_idxThe start index.
target_node_heightHeight of the target node.
adrsAddress 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 94 of file xmss_privatekey.cpp.

References BOTAN_ASSERT, BOTAN_ASSERT_NOMSG, Botan::XMSS_Common_Ops::create_l_tree(), Botan::XMSS_Parameters::element_size(), Botan::XMSS_WOTS_PrivateKey::generate_public_key(), Botan::XMSS_Index_Registry::get(), Botan::XMSS_Address::get_tree_height(), Botan::XMSS_Address::get_tree_index(), Botan::Thread_Pool::global_instance(), hash, Botan::XMSS_Address::Hash_Tree_Address, Botan::XMSS_Address::LTree_Address, Botan::XMSS_Common_Ops::m_hash, Botan::XMSS_PublicKey::m_xmss_params, Botan::XMSS_WOTS_Parameters::oid(), Botan::XMSS_Address::OTS_Hash_Address, Botan::XMSS_WOTS_PrivateKey::private_seed(), public_seed(), Botan::XMSS_Common_Ops::randomize_tree_hash(), Botan::Thread_Pool::run(), Botan::XMSS_Address::set_ltree_address(), Botan::XMSS_Address::set_ots_address(), Botan::XMSS_Address::set_tree_height(), Botan::XMSS_Address::set_tree_index(), Botan::XMSS_Address::set_type(), Botan::Thread_Pool::worker_count(), Botan::XMSS_WOTS_PublicKey::wots_parameters(), and wots_private_key().

Referenced by Botan::XMSS_Signature_Operation::signature_length(), and XMSS_PrivateKey().

97  {
98  BOTAN_ASSERT((start_idx % (1 << target_node_height)) == 0,
99  "Start index must be divisible by 2^{target node height}.");
100 
101 #if defined(BOTAN_HAS_THREAD_UTILS)
102  // dertermine number of parallel tasks to split the tree_hashing into.
103 
104  Thread_Pool& thread_pool = Thread_Pool::global_instance();
105 
106  const size_t split_level = std::min(target_node_height, thread_pool.worker_count());
107 
108  // skip parallelization overhead for leaf nodes.
109  if(split_level == 0)
110  {
111  secure_vector<uint8_t> result;
112  tree_hash_subtree(result, start_idx, target_node_height, adrs);
113  return result;
114  }
115 
116  const size_t subtrees = static_cast<size_t>(1) << split_level;
117  const size_t last_idx = (static_cast<size_t>(1) << (target_node_height)) + start_idx;
118  const size_t offs = (last_idx - start_idx) / subtrees;
119  uint8_t level = split_level; // current level in the tree
120 
121  BOTAN_ASSERT((last_idx - start_idx) % subtrees == 0,
122  "Number of worker threads in tree_hash need to divide range "
123  "of calculated nodes.");
124 
125  std::vector<secure_vector<uint8_t>> nodes(
126  subtrees,
127  secure_vector<uint8_t>(XMSS_PublicKey::m_xmss_params.element_size()));
128  std::vector<XMSS_Address> node_addresses(subtrees, adrs);
129  std::vector<XMSS_Hash> xmss_hash(subtrees, m_hash);
130  std::vector<std::future<void>> work;
131 
132  // Calculate multiple subtrees in parallel.
133  for(size_t i = 0; i < subtrees; i++)
134  {
135  using tree_hash_subtree_fn_t =
136  void (XMSS_PrivateKey::*)(secure_vector<uint8_t>&,
137  size_t,
138  size_t,
139  XMSS_Address&,
140  XMSS_Hash&);
141 
142  auto work_fn = static_cast<tree_hash_subtree_fn_t>(&XMSS_PrivateKey::tree_hash_subtree);
143 
144  work.push_back(thread_pool.run(
145  work_fn,
146  this,
147  std::ref(nodes[i]),
148  start_idx + i * offs,
149  target_node_height - split_level,
150  std::ref(node_addresses[i]),
151  std::ref(xmss_hash[i])));
152  }
153 
154  for(auto& w : work)
155  {
156  w.get();
157  }
158  work.clear();
159 
160  // Parallelize the top tree levels horizontally
161  while(level-- > 1)
162  {
163  std::vector<secure_vector<uint8_t>> ro_nodes(
164  nodes.begin(), nodes.begin() + (1 << (level+1)));
165 
166  for(size_t i = 0; i < (1U << level); i++)
167  {
168  BOTAN_ASSERT_NOMSG(xmss_hash.size() > i);
169 
170  node_addresses[i].set_tree_height(target_node_height - (level + 1));
171  node_addresses[i].set_tree_index(
172  (node_addresses[2 * i + 1].get_tree_index() - 1) >> 1);
173  using rnd_tree_hash_fn_t =
174  void (XMSS_PrivateKey::*)(secure_vector<uint8_t>&,
175  const secure_vector<uint8_t>&,
176  const secure_vector<uint8_t>&,
177  XMSS_Address& adrs,
178  const secure_vector<uint8_t>&,
179  XMSS_Hash&);
180 
181  auto work_fn = static_cast<rnd_tree_hash_fn_t>(&XMSS_PrivateKey::randomize_tree_hash);
182 
183  work.push_back(thread_pool.run(
184  work_fn,
185  this,
186  std::ref(nodes[i]),
187  std::ref(ro_nodes[2 * i]),
188  std::ref(ro_nodes[2 * i + 1]),
189  std::ref(node_addresses[i]),
190  std::ref(this->public_seed()),
191  std::ref(xmss_hash[i])));
192  }
193 
194  for(auto &w : work)
195  {
196  w.get();
197  }
198  work.clear();
199  }
200 
201  // Avoid creation an extra thread to calculate root node.
202  node_addresses[0].set_tree_height(target_node_height - 1);
203  node_addresses[0].set_tree_index(
204  (node_addresses[1].get_tree_index() - 1) >> 1);
205  randomize_tree_hash(nodes[0],
206  nodes[0],
207  nodes[1],
208  node_addresses[0],
209  this->public_seed());
210  return nodes[0];
211 #else
212  secure_vector<uint8_t> result;
213  tree_hash_subtree(result, start_idx, target_node_height, adrs);
214  return result;
215 #endif
216  }
const secure_vector< uint8_t > & public_seed() const override
#define BOTAN_ASSERT_NOMSG(expr)
Definition: assert.h:68
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:55
XMSS_PrivateKey(XMSS_Parameters::xmss_algorithm_t xmss_algo_id, RandomNumberGenerator &rng)
static Thread_Pool & global_instance()
Definition: thread_pool.cpp:15
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)
XMSS_Parameters m_xmss_params

◆ unused_leaf_index()

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 102 of file xmss_privatekey.h.

Referenced by raw_private_key().

103  {
104  return *recover_global_leaf_index();
105  }

◆ wots_oid()

XMSS_WOTS_Parameters::ots_algorithm_t Botan::XMSS_PublicKey::wots_oid ( ) const
inlineinherited

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

Returns
XMSS WOTS signature method identifier.

Definition at line 129 of file xmss_publickey.h.

130  {
131  return m_wots_params.oid();
132  }
XMSS_WOTS_Parameters m_wots_params
ots_algorithm_t oid() const

◆ wots_parameters()

const XMSS_WOTS_Parameters& Botan::XMSS_PublicKey::wots_parameters ( ) const
inlineinherited

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

Returns
XMSS WOTS signature method parameters.

Definition at line 140 of file xmss_publickey.h.

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

141  {
142  return m_wots_params;
143  }
XMSS_WOTS_Parameters m_wots_params

◆ wots_private_key() [1/2]

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 153 of file xmss_privatekey.h.

Referenced by tree_hash(), and Botan::XMSS_Signature_Operation::XMSS_Signature_Operation().

154  {
155  return m_wots_priv_key;
156  }

◆ wots_private_key() [2/2]

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 164 of file xmss_privatekey.h.

165  {
166  return m_wots_priv_key;
167  }

◆ xmss_oid()

XMSS_Parameters::xmss_algorithm_t Botan::XMSS_PublicKey::xmss_oid ( ) const
inlineinherited

Retrieves the chosen XMSS signature method.

Returns
XMSS signature method identifier.

Definition at line 98 of file xmss_publickey.h.

99  {
100  return m_xmss_params.oid();
101  }
XMSS_Parameters m_xmss_params
xmss_algorithm_t oid() const

◆ xmss_parameters()

const XMSS_Parameters& Botan::XMSS_PublicKey::xmss_parameters ( ) const
inlineinherited

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

Returns
XMSS parameters.

Definition at line 118 of file xmss_publickey.h.

Referenced by Botan::XMSS_Verification_Operation::is_valid_signature(), and Botan::XMSS_Signature_Operation::sign().

119  {
120  return m_xmss_params;
121  }
XMSS_Parameters m_xmss_params

Member Data Documentation

◆ m_hash

XMSS_Hash Botan::XMSS_Common_Ops::m_hash
protectedinherited

◆ m_public_seed

secure_vector<uint8_t> Botan::XMSS_PublicKey::m_public_seed
protectedinherited

◆ m_root

secure_vector<uint8_t> Botan::XMSS_PublicKey::m_root
protectedinherited

◆ m_wots_params

XMSS_WOTS_Parameters Botan::XMSS_PublicKey::m_wots_params
protectedinherited

Definition at line 247 of file xmss_publickey.h.

Referenced by XMSS_PrivateKey().

◆ m_xmss_params [1/2]

XMSS_Parameters Botan::XMSS_Common_Ops::m_xmss_params
protectedinherited

◆ m_xmss_params [2/2]

XMSS_Parameters Botan::XMSS_PublicKey::m_xmss_params
protectedinherited

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