#include <xmss_privatekey.h>

Inheritance diagram for Botan::XMSS_PrivateKey:

Public Member Functions
std::string	algo_name () const override

AlgorithmIdentifier	algorithm_identifier () const override

bool	check_key (RandomNumberGenerator &, bool) const override

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

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

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

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

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

std::unique_ptr< PK_Ops::Signature >	create_signature_op (RandomNumberGenerator &, const std::string &, const std::string &provider) const override

std::unique_ptr< PK_Ops::Verification >	create_verification_op (const std::string &, const std::string &provider) const override

virtual Signature_Format	default_x509_signature_format () const

size_t	estimated_strength () const override

std::string	fingerprint (const std::string &alg) const

std::string	fingerprint_private (const std::string &alg) const

std::string	fingerprint_public (const std::string &alg="SHA-256") const

virtual OID	get_oid () const

size_t	key_length () const override

virtual size_t	message_part_size () const

virtual size_t	message_parts () const

virtual AlgorithmIdentifier	pkcs8_algorithm_identifier () const

const secure_vector< uint8_t > &	prf () const

secure_vector< uint8_t > &	prf ()

secure_vector< uint8_t >	private_key_bits () const override

secure_vector< uint8_t >	private_key_info () const

std::vector< uint8_t >	public_key_bits () const override

virtual secure_vector< uint8_t > &	public_seed ()

const secure_vector< uint8_t > &	public_seed () const override

secure_vector< uint8_t >	raw_private_key () const

virtual std::vector< uint8_t >	raw_public_key () const

size_t	reserve_unused_leaf_index ()

secure_vector< uint8_t > &	root ()

const secure_vector< uint8_t > &	root () const

void	set_public_seed (const secure_vector< uint8_t > &public_seed) override

void	set_public_seed (secure_vector< uint8_t > &&public_seed) override

void	set_root (const secure_vector< uint8_t > &root)

void	set_root (secure_vector< uint8_t > &&root)

void	set_unused_leaf_index (size_t idx)

void	set_xmss_oid (XMSS_Parameters::xmss_algorithm_t xmss_oid)

size_t	size () const override

bool	stateful_operation () const override

std::vector< uint8_t >	subject_public_key () const

secure_vector< uint8_t >	tree_hash (size_t start_idx, size_t target_node_height, XMSS_Address &adrs)

size_t	unused_leaf_index () const

XMSS_WOTS_Parameters::ots_algorithm_t	wots_oid () const

const XMSS_WOTS_Parameters &	wots_parameters () const

const XMSS_WOTS_PrivateKey &	wots_private_key () const

XMSS_WOTS_PrivateKey &	wots_private_key ()

XMSS_Parameters::xmss_algorithm_t	xmss_oid () const

const XMSS_Parameters &	xmss_parameters () const

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

	XMSS_PrivateKey (const secure_vector< uint8_t > &raw_key)

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

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

void	create_l_tree (secure_vector< uint8_t > &result, wots_keysig_t pk, XMSS_Address &adrs, const secure_vector< uint8_t > &seed)

void	randomize_tree_hash (secure_vector< uint8_t > &result, const secure_vector< uint8_t > &left, const secure_vector< uint8_t > &right, XMSS_Address &adrs, const secure_vector< uint8_t > &seed, XMSS_Hash &hash)

void	randomize_tree_hash (secure_vector< uint8_t > &result, const secure_vector< uint8_t > &left, const secure_vector< uint8_t > &right, XMSS_Address &adrs, const secure_vector< uint8_t > &seed)

Protected Attributes
XMSS_Hash	m_hash

secure_vector< uint8_t >	m_public_seed

std::vector< uint8_t >	m_raw_key

secure_vector< uint8_t >	m_root

XMSS_WOTS_Parameters	m_wots_params

XMSS_Parameters	m_xmss_params

XMSS_Parameters	m_xmss_params

Detailed Description

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

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

Definition at line 37 of file xmss_privatekey.h.

Constructor & Destructor Documentation

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

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

Parameters

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

Definition at line 97 of file xmss_privatekey.cpp.

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

    : XMSS_PublicKey(xmss_algo_id, rng),
      XMSS_Common_Ops(xmss_algo_id),
      m_wots_priv_key(XMSS_PublicKey::m_xmss_params.ots_oid(),
                      public_seed(),
                      rng),
      m_prf(rng.random_vec(XMSS_PublicKey::m_xmss_params.element_size())),
      m_index_reg(XMSS_Index_Registry::get_instance())
    {
    XMSS_Address adrs;
    set_root(tree_hash(0,
                       XMSS_PublicKey::m_xmss_params.tree_height(),
                       adrs));
    }

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

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

Parameters

raw_key An XMSS private key serialized using raw_private_key().

Definition at line 47 of file xmss_privatekey.cpp.

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

    : XMSS_PublicKey(unlock(key_bits)),
      XMSS_Common_Ops(XMSS_PublicKey::m_xmss_params.oid()),
      m_wots_priv_key(m_wots_params.oid(), m_public_seed),
      m_index_reg(XMSS_Index_Registry::get_instance())
    {
    /*
    The code requires sizeof(size_t) >= ceil(tree_height / 8)
 
    Maximum supported tree height is 20, ceil(20/8) == 3, so 4 byte
    size_t is sufficient for all defined parameters, or even a
    (hypothetical) tree height 32, which would be extremely slow to
    compute.
    */
    static_assert(sizeof(size_t) >= 4, "size_t is big enough to support leaf index");
 
    secure_vector<uint8_t> raw_key = extract_raw_key(key_bits);
 
    if(raw_key.size() != XMSS_PrivateKey::size())
       {
       throw Decoding_Error("Invalid XMSS private key size");
       }
 
    // extract & copy unused leaf index from raw_key
    uint64_t unused_leaf = 0;
    auto begin = (raw_key.begin() + XMSS_PublicKey::size());
    auto end = raw_key.begin() + XMSS_PublicKey::size() + sizeof(uint32_t);
 
    for(auto& i = begin; i != end; i++)
       {
       unused_leaf = ((unused_leaf << 8) | *i);
       }
 
    if(unused_leaf >= (1ull << XMSS_PublicKey::m_xmss_params.tree_height()))
       {
       throw Decoding_Error("XMSS private key leaf index out of bounds");
       }
 
    begin = end;
    end = begin + XMSS_PublicKey::m_xmss_params.element_size();
    m_prf.clear();
    m_prf.reserve(XMSS_PublicKey::m_xmss_params.element_size());
    std::copy(begin, end, std::back_inserter(m_prf));
 
    begin = end;
    end = begin + m_wots_params.element_size();
    m_wots_priv_key.set_private_seed(secure_vector<uint8_t>(begin, end));
    set_unused_leaf_index(static_cast<size_t>(unused_leaf));
    }

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

inline

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

Parameters

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

Definition at line 77 of file xmss_privatekey.h.

          : XMSS_PublicKey(xmss_algo_id, root, public_seed),
            XMSS_Common_Ops(xmss_algo_id),
            m_wots_priv_key(XMSS_PublicKey::m_xmss_params.ots_oid(),
                            public_seed,
                            wots_priv_seed),
            m_prf(prf),
            m_index_reg(XMSS_Index_Registry::get_instance())
          {
          set_unused_leaf_index(idx_leaf);
          }

Member Function Documentation

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

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

          {
          return "XMSS";
          }

AlgorithmIdentifier Botan::XMSS_PublicKey::algorithm_identifier ( ) const

inlineoverridevirtualinherited

Returns: X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 192 of file xmss_publickey.h.

References Botan::AlgorithmIdentifier::USE_EMPTY_PARAM.

          {
          return AlgorithmIdentifier(get_oid(), AlgorithmIdentifier::USE_EMPTY_PARAM);
          }

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

inlineoverridevirtualinherited

Test the key values for consistency.

Parameters

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

Returns: true if the test is passed

Implements Botan::Public_Key.

Definition at line 197 of file xmss_publickey.h.

          {
          return true;
          }

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

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

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

Definition at line 114 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

    {
    throw Lookup_Error(algo_name() + " does not support decryption");
    }

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

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

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

Definition at line 91 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

    {
    throw Lookup_Error(algo_name() + " does not support encryption");
    }

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

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

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

Definition at line 122 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

    {
    throw Lookup_Error(algo_name() + " does not support KEM decryption");
    }

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

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

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

Definition at line 99 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

    {
    throw Lookup_Error(algo_name() + " does not support KEM encryption");
    }

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

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

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

Definition at line 138 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

    {
    throw Lookup_Error(algo_name() + " does not support key agreement");
    }

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

Definition at line 46 of file xmss_common_ops.cpp.

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

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

    {
    size_t l = m_xmss_params.len();
    adrs.set_tree_height(0);
 
    while(l > 1)
       {
       for(size_t i = 0; i < l >> 1; i++)
          {
          adrs.set_tree_index(static_cast<uint32_t>(i));
          randomize_tree_hash(pk[i], pk[2 * i], pk[2 * i + 1], adrs, seed, hash);
          }
       if(l & 0x01)
          {
          pk[l >> 1] = pk[l - 1];
          }
       l = (l >> 1) + (l & 0x01);
       adrs.set_tree_height(adrs.get_tree_height() + 1);
       }
    result = pk[0];
    }

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

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

Definition at line 112 of file xmss_common_ops.h.

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

          {
          create_l_tree(result, pk, adrs, seed, m_hash);
          }

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

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

Reimplemented from Botan::Private_Key.

Definition at line 337 of file xmss_privatekey.cpp.

References Botan::XMSS_PublicKey::algo_name().

    {
    if(provider == "base" || provider.empty())
       return std::unique_ptr<PK_Ops::Signature>(
          new XMSS_Signature_Operation(*this));
 
    throw Provider_Not_Found(algo_name(), provider);
    }

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

params	additional parameters
provider	the provider to use

Reimplemented from Botan::Public_Key.

Definition at line 85 of file xmss_publickey.cpp.

References Botan::XMSS_PublicKey::algo_name().

    {
    if(provider == "base" || provider.empty())
       {
       return std::unique_ptr<PK_Ops::Verification>(
                 new XMSS_Verification_Operation(*this));
       }
    throw Provider_Not_Found(algo_name(), provider);
    }

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

          {
          return (this->message_parts() >= 2) ? DER_SEQUENCE : IEEE_1363;
          }

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

          {
          return m_xmss_params.estimated_strength();
          }

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

inlineinherited

Definition at line 216 of file pk_keys.h.

          {
          return fingerprint_private(alg); // match behavior in previous versions
          }

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

inherited

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

Definition at line 85 of file pk_keys.cpp.

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

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

    {
    return create_hex_fingerprint(private_key_bits(), hash_algo);
    }

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

inherited

Returns: Hash of the subject public key

Definition at line 77 of file pk_keys.cpp.

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

    {
    return create_hex_fingerprint(subject_public_key(), hash_algo);
    }

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

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

    {
    const OID o = OIDS::str2oid_or_empty(algo_name());
    if(o.empty())
       throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
    return o;
    }

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

          {
          return m_xmss_params.estimated_strength();
          }

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; }

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; }

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(); }

Botan::Public_Key::algorithm_identifier

virtual AlgorithmIdentifier algorithm_identifier() const =0

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

inline

Definition at line 170 of file xmss_privatekey.h.

          {
          return m_prf;
          }

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

inline

Definition at line 175 of file xmss_privatekey.h.

          {
          return m_prf;
          }

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

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

          {
          return DER_Encoder().encode(raw_private_key(), OCTET_STRING).get_contents();
          }

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

    {
    const size_t PKCS8_VERSION = 0;
 
    return DER_Encoder()
          .start_cons(SEQUENCE)
             .encode(PKCS8_VERSION)
             .encode(pkcs8_algorithm_identifier())
             .encode(private_key_bits(), OCTET_STRING)
          .end_cons()
       .get_contents();
    }

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

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

          {
          std::vector<uint8_t> output;
          DER_Encoder(output).encode(raw_public_key(), OCTET_STRING);
          return output;
          }

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

inlinevirtualinherited

Definition at line 167 of file xmss_publickey.h.

          {
          return m_public_seed;
          }

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

inlineoverridevirtual

Reimplemented from Botan::XMSS_PublicKey.

Definition at line 193 of file xmss_privatekey.h.

Referenced by tree_hash().

          {
          return m_public_seed;
          }

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

Definition at line 14 of file xmss_common_ops.cpp.

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

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

    {
    adrs.set_key_mask_mode(XMSS_Address::Key_Mask::Key_Mode);
    secure_vector<uint8_t> key { hash.prf(seed, adrs.bytes()) };
 
    adrs.set_key_mask_mode(XMSS_Address::Key_Mask::Mask_MSB_Mode);
    secure_vector<uint8_t> bitmask_l { hash.prf(seed, adrs.bytes()) };
 
    adrs.set_key_mask_mode(XMSS_Address::Key_Mask::Mask_LSB_Mode);
    secure_vector<uint8_t> bitmask_r { hash.prf(seed, adrs.bytes()) };
 
    BOTAN_ASSERT(bitmask_l.size() == left.size() &&
                 bitmask_r.size() == right.size(),
                 "Bitmask size doesn't match node size.");
 
    secure_vector<uint8_t> concat_xor(m_xmss_params.element_size() * 2);
    for(size_t i = 0; i < left.size(); i++)
       {
       concat_xor[i] = left[i] ^ bitmask_l[i];
       concat_xor[i + left.size()] = right[i] ^ bitmask_r[i];
       }
 
    hash.h(result, key, concat_xor);
    }

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]	result	The resulting randomized hash.
[in]	left	Left half of the hash function input.
[in]	right	Right half of the hash function input.
[in]	adrs	Adress of the hash function call.
[in]	seed	The seed for G.

Definition at line 69 of file xmss_common_ops.h.

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

          {
          randomize_tree_hash(result, left, right, adrs, seed, m_hash);
          }

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

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

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

Definition at line 315 of file xmss_privatekey.cpp.

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

    {
    std::vector<uint8_t> pk { raw_public_key() };
    secure_vector<uint8_t> result(pk.begin(), pk.end());
    result.reserve(size());
 
    for(int i = 3; i >= 0; i--)
       {
       result.push_back(
          static_cast<uint8_t>(
             static_cast<uint64_t>(unused_leaf_index()) >> 8 * i));
       }
 
    std::copy(m_prf.begin(), m_prf.end(), std::back_inserter(result));
    std::copy(m_wots_priv_key.private_seed().begin(),
              m_wots_priv_key.private_seed().end(),
              std::back_inserter(result));
 
    return result;
    }

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

    {
    std::vector<uint8_t> result
       {
       static_cast<uint8_t>(m_xmss_params.oid() >> 24),
       static_cast<uint8_t>(m_xmss_params.oid() >> 16),
       static_cast<uint8_t>(m_xmss_params.oid() >>  8),
       static_cast<uint8_t>(m_xmss_params.oid())
       };
 
    std::copy(m_root.begin(), m_root.end(), std::back_inserter(result));
    std::copy(m_public_seed.begin(),
              m_public_seed.end(),
              std::back_inserter(result));
 
    return result;
    }

size_t Botan::XMSS_PrivateKey::reserve_unused_leaf_index ( )

inline

Definition at line 137 of file xmss_privatekey.h.

References Botan::XMSS_PublicKey::m_xmss_params.

          {
          size_t idx = (static_cast<std::atomic<size_t>&>(
                           *recover_global_leaf_index())).fetch_add(1);
          if(idx >= (1ull << XMSS_PublicKey::m_xmss_params.tree_height()))
             {
             throw Decoding_Error("XMSS private key, one time signatures exhaused");
             }
          return idx;
          }

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

inlineinherited

Definition at line 147 of file xmss_publickey.h.

          {
          return m_root;
          }

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

inlineinherited

Definition at line 162 of file xmss_publickey.h.

          {
          return m_root;
          }

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

inlineoverridevirtual

Reimplemented from Botan::XMSS_PublicKey.

Definition at line 180 of file xmss_privatekey.h.

          {
          m_public_seed = public_seed;
          m_wots_priv_key.set_public_seed(public_seed);
          }

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

inlineoverridevirtual

Reimplemented from Botan::XMSS_PublicKey.

Definition at line 187 of file xmss_privatekey.h.

          {
          m_public_seed = std::move(public_seed);
          m_wots_priv_key.set_public_seed(m_public_seed);
          }

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

inlineinherited

Definition at line 152 of file xmss_publickey.h.

Referenced by XMSS_PrivateKey().

          {
          m_root = root;
          }

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

inlineinherited

Definition at line 157 of file xmss_publickey.h.

          {
          m_root = std::move(root);
          }

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

inline

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

Parameters

idx	Index of the last unused leaf.

Definition at line 115 of file xmss_privatekey.h.

References Botan::XMSS_PublicKey::m_xmss_params.

Referenced by XMSS_PrivateKey().

          {
          if(idx >= (1ull << XMSS_PublicKey::m_xmss_params.tree_height()))
             {
             throw Decoding_Error("XMSS private key leaf index out of bounds");
             }
          else
             {
             std::atomic<size_t>& index =
                static_cast<std::atomic<size_t>&>(*recover_global_leaf_index());
             size_t current = 0;
 
             do
                {
                current = index.load();
                if(current > idx)
                   { return; }
                }
             while(!index.compare_exchange_strong(current, idx));
             }
          }

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.

          {
          m_xmss_params = XMSS_Parameters(xmss_oid);
          m_wots_params = XMSS_WOTS_Parameters(m_xmss_params.ots_oid());
          }

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

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

Referenced by raw_private_key(), and XMSS_PrivateKey().

          {
          return XMSS_PublicKey::size() +
                 sizeof(uint32_t) +
                 2 * XMSS_PublicKey::m_xmss_params.element_size();
          }

bool Botan::XMSS_PrivateKey::stateful_operation ( ) const

inlineoverridevirtual

Reimplemented from Botan::Private_Key.

Definition at line 94 of file xmss_privatekey.h.

94 { return true; }

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

inherited

Returns: X.509 subject key encoding for this key object

Definition at line 38 of file pk_keys.cpp.

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

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

    {
    std::vector<uint8_t> output;
 
    DER_Encoder(output).start_cons(SEQUENCE)
          .encode(algorithm_identifier())
          .encode(public_key_bits(), BIT_STRING)
       .end_cons();
 
    return output;
    }

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

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

Parameters

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

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

Definition at line 115 of file xmss_privatekey.cpp.

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

Referenced by XMSS_PrivateKey().

    {
    BOTAN_ASSERT_NOMSG(target_node_height <= 30);
    BOTAN_ASSERT((start_idx % (static_cast<size_t>(1) << target_node_height)) == 0,
                 "Start index must be divisible by 2^{target node height}.");
 
 #if defined(BOTAN_HAS_THREAD_UTILS)
    // dertermine number of parallel tasks to split the tree_hashing into.
 
    Thread_Pool& thread_pool = Thread_Pool::global_instance();
 
    const size_t split_level = std::min(target_node_height, thread_pool.worker_count());
 
    // skip parallelization overhead for leaf nodes.
    if(split_level == 0)
       {
       secure_vector<uint8_t> result;
       tree_hash_subtree(result, start_idx, target_node_height, adrs);
       return result;
       }
 
    const size_t subtrees = static_cast<size_t>(1) << split_level;
    const size_t last_idx = (static_cast<size_t>(1) << (target_node_height)) + start_idx;
    const size_t offs = (last_idx - start_idx) / subtrees;
    // this cast cannot overflow because target_node_height is limited
    uint8_t level = static_cast<uint8_t>(split_level); // current level in the tree
 
    BOTAN_ASSERT((last_idx - start_idx) % subtrees == 0,
                 "Number of worker threads in tree_hash need to divide range "
                 "of calculated nodes.");
 
    std::vector<secure_vector<uint8_t>> nodes(
        subtrees,
        secure_vector<uint8_t>(XMSS_PublicKey::m_xmss_params.element_size()));
    std::vector<XMSS_Address> node_addresses(subtrees, adrs);
    std::vector<XMSS_Hash> xmss_hash(subtrees, m_hash);
    std::vector<std::future<void>> work;
 
    // Calculate multiple subtrees in parallel.
    for(size_t i = 0; i < subtrees; i++)
       {
       using tree_hash_subtree_fn_t =
          void (XMSS_PrivateKey::*)(secure_vector<uint8_t>&,
                                    size_t,
                                    size_t,
                                    XMSS_Address&,
                                    XMSS_Hash&);
 
       auto work_fn = static_cast<tree_hash_subtree_fn_t>(&XMSS_PrivateKey::tree_hash_subtree);
 
       work.push_back(thread_pool.run(
                         work_fn,
                         this,
                         std::ref(nodes[i]),
                         start_idx + i * offs,
                         target_node_height - split_level,
                         std::ref(node_addresses[i]),
                         std::ref(xmss_hash[i])));
       }
 
    for(auto& w : work)
       {
       w.get();
       }
    work.clear();
 
    // Parallelize the top tree levels horizontally
    while(level-- > 1)
       {
       std::vector<secure_vector<uint8_t>> ro_nodes(
          nodes.begin(), nodes.begin() + (static_cast<size_t>(1) << (level+1)));
 
       for(size_t i = 0; i < (static_cast<size_t>(1) << level); i++)
          {
          BOTAN_ASSERT_NOMSG(xmss_hash.size() > i);
 
          node_addresses[i].set_tree_height(static_cast<uint32_t>(target_node_height - (level + 1)));
          node_addresses[i].set_tree_index(
             (node_addresses[2 * i + 1].get_tree_index() - 1) >> 1);
          using rnd_tree_hash_fn_t =
             void (XMSS_PrivateKey::*)(secure_vector<uint8_t>&,
                                       const secure_vector<uint8_t>&,
                                       const secure_vector<uint8_t>&,
                                       XMSS_Address& adrs,
                                       const secure_vector<uint8_t>&,
                                       XMSS_Hash&);
 
          auto work_fn = static_cast<rnd_tree_hash_fn_t>(&XMSS_PrivateKey::randomize_tree_hash);
 
          work.push_back(thread_pool.run(
                work_fn,
                this,
                std::ref(nodes[i]),
                std::ref(ro_nodes[2 * i]),
                std::ref(ro_nodes[2 * i + 1]),
                std::ref(node_addresses[i]),
                std::ref(this->public_seed()),
                std::ref(xmss_hash[i])));
          }
 
       for(auto &w : work)
          {
          w.get();
          }
       work.clear();
       }
 
    // Avoid creation an extra thread to calculate root node.
    node_addresses[0].set_tree_height(static_cast<uint32_t>(target_node_height - 1));
    node_addresses[0].set_tree_index(
       (node_addresses[1].get_tree_index() - 1) >> 1);
    randomize_tree_hash(nodes[0],
                        nodes[0],
                        nodes[1],
                        node_addresses[0],
                        this->public_seed());
    return nodes[0];
 #else
    secure_vector<uint8_t> result;
    tree_hash_subtree(result, start_idx, target_node_height, adrs);
    return result;
 #endif
    }

size_t Botan::XMSS_PrivateKey::unused_leaf_index ( ) const

inline

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

Returns: Index of the last unused leaf.

Definition at line 103 of file xmss_privatekey.h.

Referenced by raw_private_key().

          {
          return *recover_global_leaf_index();
          }

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

          {
          return m_wots_params.oid();
          }

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

          {
          return m_wots_params;
          }

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

inline

Winternitz One Time Signature Scheme key utilized for signing operations.

Returns: WOTS+ private key.

Definition at line 154 of file xmss_privatekey.h.

          {
          return m_wots_priv_key;
          }

XMSS_WOTS_PrivateKey& Botan::XMSS_PrivateKey::wots_private_key ( )

inline

Winternitz One Time Signature Scheme key utilized for signing operations.

Returns: WOTS+ private key.

Definition at line 165 of file xmss_privatekey.h.

          {
          return m_wots_priv_key;
          }

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.

          {
          return m_xmss_params.oid();
          }

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

          {
          return m_xmss_params;
          }

Member Data Documentation

XMSS_Hash Botan::XMSS_Common_Ops::m_hash

protectedinherited

Definition at line 122 of file xmss_common_ops.h.

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

secure_vector<uint8_t> Botan::XMSS_PublicKey::m_public_seed

protectedinherited

Definition at line 254 of file xmss_publickey.h.

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

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

protectedinherited

Definition at line 250 of file xmss_publickey.h.

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

secure_vector<uint8_t> Botan::XMSS_PublicKey::m_root

protectedinherited

Definition at line 253 of file xmss_publickey.h.

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

XMSS_WOTS_Parameters Botan::XMSS_PublicKey::m_wots_params

protectedinherited

Definition at line 252 of file xmss_publickey.h.

Referenced by XMSS_PrivateKey().

XMSS_Parameters Botan::XMSS_Common_Ops::m_xmss_params

protectedinherited

Definition at line 121 of file xmss_common_ops.h.

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

XMSS_Parameters Botan::XMSS_PublicKey::m_xmss_params

protectedinherited

Definition at line 251 of file xmss_publickey.h.

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

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation