Botan  2.15.0
Crypto and TLS for C++11
Public 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::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
 
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_Parameterswots_parameters () const
 
const XMSS_WOTS_PrivateKeywots_private_key () const
 
XMSS_WOTS_PrivateKeywots_private_key ()
 
std::string xmss_hash_function () const
 
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 Attributes

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
 

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

101  : XMSS_PublicKey(xmss_algo_id, rng),
102  m_wots_priv_key(XMSS_PublicKey::m_xmss_params.ots_oid(),
103  public_seed(),
104  rng),
105  m_hash(xmss_hash_function()),
106  m_prf(rng.random_vec(XMSS_PublicKey::m_xmss_params.element_size())),
107  m_index_reg(XMSS_Index_Registry::get_instance())
108  {
109  XMSS_Address adrs;
111  XMSS_PublicKey::m_xmss_params.tree_height(),
112  adrs));
113  }
const secure_vector< uint8_t > & public_seed() const override
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)
std::string xmss_hash_function() const
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 48 of file xmss_privatekey.cpp.

49  : XMSS_PublicKey(unlock(key_bits)),
50  m_wots_priv_key(m_wots_params.oid(), m_public_seed),
51  m_hash(xmss_hash_function()),
53  {
54  /*
55  The code requires sizeof(size_t) >= ceil(tree_height / 8)
56 
57  Maximum supported tree height is 20, ceil(20/8) == 3, so 4 byte
58  size_t is sufficient for all defined parameters, or even a
59  (hypothetical) tree height 32, which would be extremely slow to
60  compute.
61  */
62  static_assert(sizeof(size_t) >= 4, "size_t is big enough to support leaf index");
63 
64  secure_vector<uint8_t> raw_key = extract_raw_key(key_bits);
65 
66  if(raw_key.size() != XMSS_PrivateKey::size())
67  {
68  throw Decoding_Error("Invalid XMSS private key size");
69  }
70 
71  // extract & copy unused leaf index from raw_key
72  uint64_t unused_leaf = 0;
73  auto begin = (raw_key.begin() + XMSS_PublicKey::size());
74  auto end = raw_key.begin() + XMSS_PublicKey::size() + sizeof(uint32_t);
75 
76  for(auto& i = begin; i != end; i++)
77  {
78  unused_leaf = ((unused_leaf << 8) | *i);
79  }
80 
81  if(unused_leaf >= (1ull << XMSS_PublicKey::m_xmss_params.tree_height()))
82  {
83  throw Decoding_Error("XMSS private key leaf index out of bounds");
84  }
85 
86  begin = end;
88  m_prf.clear();
89  m_prf.reserve(XMSS_PublicKey::m_xmss_params.element_size());
90  std::copy(begin, end, std::back_inserter(m_prf));
91 
92  begin = end;
93  end = begin + m_wots_params.element_size();
94  m_wots_priv_key.set_private_seed(secure_vector<uint8_t>(begin, end));
95  set_unused_leaf_index(static_cast<size_t>(unused_leaf));
96  }
secure_vector< uint8_t > m_public_seed
void set_unused_leaf_index(size_t idx)
std::string xmss_hash_function() const
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 75 of file xmss_privatekey.h.

81  : XMSS_PublicKey(xmss_algo_id, root, public_seed),
82  m_wots_priv_key(XMSS_PublicKey::m_xmss_params.ots_oid(),
84  wots_priv_seed),
85  m_hash(XMSS_PublicKey::m_xmss_params.hash_function_name()),
86  m_prf(prf),
88  {
89  set_unused_leaf_index(idx_leaf);
90  }
const secure_vector< uint8_t > & public_seed() const override
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 198 of file xmss_publickey.h.

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

199  {
200  return "XMSS";
201  }

◆ algorithm_identifier()

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

Implements Botan::Public_Key.

Definition at line 203 of file xmss_publickey.h.

References Botan::AlgorithmIdentifier::USE_EMPTY_PARAM.

204  {
205  return AlgorithmIdentifier(get_oid(), AlgorithmIdentifier::USE_EMPTY_PARAM);
206  }
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 208 of file xmss_publickey.h.

209  {
210  return true;
211  }

◆ 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 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  }
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 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  }
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 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  }
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 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  }
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 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  }
virtual std::string algo_name() const =0

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

References Botan::XMSS_PublicKey::algo_name().

335  {
336  if(provider == "base" || provider.empty())
337  return std::unique_ptr<PK_Ops::Signature>(
338  new XMSS_Signature_Operation(*this));
339 
340  throw Provider_Not_Found(algo_name(), provider);
341  }
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 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  }
std::string algo_name() const override

◆ default_x509_signature_format()

virtual Signature_Format Botan::Public_Key::default_x509_signature_format ( ) const
inlinevirtualinherited

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  }
virtual size_t message_parts() const
Definition: pk_keys.h:113

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

218  {
220  }
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 216 of file pk_keys.h.

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

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

References Botan::create_hex_fingerprint(), hash_algo, 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  {
88  }
virtual secure_vector< uint8_t > private_key_bits() const =0
AlgorithmIdentifier hash_algo
Definition: x509_obj.cpp:22
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 77 of file pk_keys.cpp.

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

78  {
80  }
AlgorithmIdentifier hash_algo
Definition: x509_obj.cpp:22
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

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

223  {
225  }
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 124 of file pk_keys.h.

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

124 { 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 113 of file pk_keys.h.

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

113 { 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 205 of file pk_keys.h.

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

206  { 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 168 of file xmss_privatekey.h.

169  {
170  return m_prf;
171  }

◆ prf() [2/2]

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

Definition at line 173 of file xmss_privatekey.h.

174  {
175  return m_prf;
176  }

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

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

202  {
203  return DER_Encoder().encode(raw_private_key(), OCTET_STRING).get_contents();
204  }
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 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)
69  .encode(private_key_bits(), OCTET_STRING)
70  .end_cons()
71  .get_contents();
72  }
virtual secure_vector< uint8_t > private_key_bits() const =0
virtual AlgorithmIdentifier pkcs8_algorithm_identifier() const
Definition: pk_keys.h:205

◆ public_key_bits()

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

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

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

234  {
235  std::vector<uint8_t> output;
236  DER_Encoder(output).encode(raw_public_key(), OCTET_STRING);
237  return output;
238  }
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 178 of file xmss_publickey.h.

179  {
180  return m_public_seed;
181  }
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 191 of file xmss_privatekey.h.

Referenced by tree_hash().

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

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

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

311  {
312  std::vector<uint8_t> pk { raw_public_key() };
313  secure_vector<uint8_t> result(pk.begin(), pk.end());
314  result.reserve(size());
315 
316  for(int i = 3; i >= 0; i--)
317  {
318  result.push_back(
319  static_cast<uint8_t>(
320  static_cast<uint64_t>(unused_leaf_index()) >> 8 * i));
321  }
322 
323  std::copy(m_prf.begin(), m_prf.end(), std::back_inserter(result));
324  std::copy(m_wots_priv_key.private_seed().begin(),
325  m_wots_priv_key.private_seed().end(),
326  std::back_inserter(result));
327 
328  return result;
329  }
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 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  }
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 135 of file xmss_privatekey.h.

References Botan::XMSS_PublicKey::m_xmss_params.

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

◆ root() [1/2]

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

Definition at line 158 of file xmss_publickey.h.

159  {
160  return m_root;
161  }
secure_vector< uint8_t > m_root

◆ root() [2/2]

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

Definition at line 173 of file xmss_publickey.h.

174  {
175  return m_root;
176  }
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 178 of file xmss_privatekey.h.

180  {
182  m_wots_priv_key.set_public_seed(public_seed);
183  }
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 185 of file xmss_privatekey.h.

186  {
187  m_public_seed = std::move(public_seed);
188  m_wots_priv_key.set_public_seed(m_public_seed);
189  }
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 163 of file xmss_publickey.h.

164  {
165  m_root = root;
166  }
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 168 of file xmss_publickey.h.

169  {
170  m_root = std::move(root);
171  }
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 113 of file xmss_privatekey.h.

References Botan::XMSS_PublicKey::m_xmss_params.

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

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

Referenced by raw_private_key().

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

◆ stateful_operation()

bool Botan::XMSS_PrivateKey::stateful_operation ( ) const
inlineoverridevirtual

Reimplemented from Botan::Private_Key.

Definition at line 92 of file xmss_privatekey.h.

92 { return true; }

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

References BOTAN_ASSERT, BOTAN_ASSERT_NOMSG, Botan::Thread_Pool::global_instance(), 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().

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

Referenced by raw_private_key().

102  {
103  return *recover_global_leaf_index();
104  }

◆ wots_oid()

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

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

Returns
XMSS WOTS signature method identifier.

Definition at line 142 of file xmss_publickey.h.

143  {
144  return m_wots_params.oid();
145  }
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 153 of file xmss_publickey.h.

154  {
155  return m_wots_params;
156  }
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 152 of file xmss_privatekey.h.

153  {
154  return m_wots_priv_key;
155  }

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

164  {
165  return m_wots_priv_key;
166  }

◆ xmss_hash_function()

std::string Botan::XMSS_PublicKey::xmss_hash_function ( ) const
inlineinherited

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

Returns
XMSS parameters.

Definition at line 131 of file xmss_publickey.h.

132  {
134  }
const std::string & hash_function_name() const
XMSS_Parameters m_xmss_params

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

101  {
102  return m_xmss_params.oid();
103  }
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 120 of file xmss_publickey.h.

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

121  {
122  return m_xmss_params;
123  }
XMSS_Parameters m_xmss_params

Member Data Documentation

◆ m_public_seed

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

◆ m_raw_key

std::vector<uint8_t> Botan::XMSS_PublicKey::m_raw_key
protectedinherited

Definition at line 261 of file xmss_publickey.h.

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

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

◆ m_xmss_params

XMSS_Parameters Botan::XMSS_PublicKey::m_xmss_params
protectedinherited

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