#include <xmss_wots_privatekey.h>

Inheritance diagram for Botan::XMSS_WOTS_PrivateKey:

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

AlgorithmIdentifier	algorithm_identifier () const override

wots_keysig_t	at (size_t i, XMSS_Hash &hash)

wots_keysig_t	at (const XMSS_Address &adrs, XMSS_Hash &hash)

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

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

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

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

wots_keysig_t	generate_private_key (const secure_vector< uint8_t > &priv_seed)

XMSS_WOTS_PublicKey	generate_public_key (XMSS_Address &adrs)

void	generate_public_key (XMSS_WOTS_PublicKey &pub_key, wots_keysig_t &&in_key_data, XMSS_Address &adrs, XMSS_Hash &hash)

void	generate_public_key (XMSS_WOTS_PublicKey &pub_key, wots_keysig_t &&in_key_data, XMSS_Address &adrs)

virtual OID	get_oid () const

const wots_keysig_t &	key_data () const

wots_keysig_t &	key_data ()

size_t	key_length () const override

virtual size_t	message_part_size () const

virtual size_t	message_parts () const

	operator const wots_keysig_t & () const

	operator wots_keysig_t & ()

bool	operator!= (const XMSS_WOTS_PublicKey &key)

bool	operator== (const XMSS_WOTS_PublicKey &key)

wots_keysig_t	operator[] (size_t i)

wots_keysig_t	operator[] (const XMSS_Address &adrs)

const secure_vector< uint8_t > &	operator[] (size_t i) const

AlgorithmIdentifier	pkcs8_algorithm_identifier () const override

secure_vector< uint8_t >	private_key_bits () const override

secure_vector< uint8_t >	private_key_info () const

const secure_vector< uint8_t > &	private_seed () const

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

const secure_vector< uint8_t > &	public_seed () const

secure_vector< uint8_t > &	public_seed ()

void	set_key_data (const wots_keysig_t &key_data)

void	set_key_data (wots_keysig_t &&key_data)

void	set_private_seed (const secure_vector< uint8_t > &private_seed)

void	set_private_seed (secure_vector< uint8_t > &&private_seed)

void	set_public_seed (const secure_vector< uint8_t > &public_seed)

void	set_public_seed (secure_vector< uint8_t > &&public_seed)

wots_keysig_t	sign (const secure_vector< uint8_t > &msg, XMSS_Address &adrs)

wots_keysig_t	sign (const secure_vector< uint8_t > &msg, XMSS_Address &adrs, XMSS_Hash &hash)

virtual bool	stateful_operation () const

std::vector< uint8_t >	subject_public_key () const

const XMSS_WOTS_Parameters &	wots_parameters () const

	XMSS_WOTS_PrivateKey (XMSS_WOTS_Parameters::ots_algorithm_t oid)

	XMSS_WOTS_PrivateKey (XMSS_WOTS_Parameters::ots_algorithm_t oid, RandomNumberGenerator &rng)

	XMSS_WOTS_PrivateKey (XMSS_WOTS_Parameters::ots_algorithm_t oid, const secure_vector< uint8_t > &public_seed, RandomNumberGenerator &rng)

	XMSS_WOTS_PrivateKey (XMSS_WOTS_Parameters::ots_algorithm_t oid, const secure_vector< uint8_t > &public_seed)

	XMSS_WOTS_PrivateKey (XMSS_WOTS_Parameters::ots_algorithm_t oid, const secure_vector< uint8_t > &public_seed, const secure_vector< uint8_t > &private_seed)

Protected Member Functions
void	chain (secure_vector< uint8_t > &x, size_t start_idx, size_t steps, XMSS_Address &adrs, const secure_vector< uint8_t > &public_seed, XMSS_Hash &hash)

void	chain (secure_vector< uint8_t > &x, size_t start_idx, size_t steps, XMSS_Address &adrs, const secure_vector< uint8_t > &public_seed)

Protected Attributes
XMSS_Hash	m_hash

wots_keysig_t	m_key

secure_vector< uint8_t >	m_public_seed

XMSS_WOTS_Parameters	m_wots_params

Detailed Description

A Winternitz One Time Signature private key for use with Extended Hash-Based Signatures.

Definition at line 26 of file xmss_wots_privatekey.h.

Constructor & Destructor Documentation

Botan::XMSS_WOTS_PrivateKey::XMSS_WOTS_PrivateKey ( XMSS_WOTS_Parameters::ots_algorithm_t oid )

inline

Creates a WOTS private key for the chosen XMSS WOTS signature method. Members need to be initialized manually.

Parameters

oid	Identifier for the selected signature method.

Definition at line 36 of file xmss_wots_privatekey.h.

37 : XMSS_WOTS_PublicKey(oid)

38 {}

Botan::XMSS_WOTS_PublicKey::XMSS_WOTS_PublicKey

XMSS_WOTS_PublicKey(XMSS_WOTS_Parameters::ots_algorithm_t oid)

Definition: xmss_wots_publickey.h:84

Botan::XMSS_WOTS_PrivateKey::XMSS_WOTS_PrivateKey	(	XMSS_WOTS_Parameters::ots_algorithm_t	oid,
		RandomNumberGenerator &	rng
	)

inline

Creates a WOTS private key for the chosen XMSS WOTS signature method.

Parameters

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

Definition at line 46 of file xmss_wots_privatekey.h.

References Botan::XMSS_WOTS_PublicKey::set_key_data().

          : XMSS_WOTS_PublicKey(oid, rng),
            m_private_seed(rng.random_vec(m_wots_params.element_size()))
          {
          set_key_data(generate(m_private_seed));
          }

Botan::XMSS_WOTS_PrivateKey::XMSS_WOTS_PrivateKey	(	XMSS_WOTS_Parameters::ots_algorithm_t	oid,
		const secure_vector< uint8_t > &	public_seed,
		RandomNumberGenerator &	rng
	)

inline

Constructs a WOTS private key. Chains will be generated on demand applying a hash function to a unique value generated from a secret seed and a counter. The secret seed of length n, will be automatically generated using AutoSeeded_RNG(). "n" equals the element size of the chosen WOTS security parameter set.

Parameters

oid	Identifier for the selected signature method.
public_seed	A public seed used for the pseudo random generation of public keys derived from this private key.
rng	A random number generator to use for key generation.

Definition at line 66 of file xmss_wots_privatekey.h.

References Botan::XMSS_WOTS_PublicKey::set_key_data().

          : XMSS_WOTS_PublicKey(oid, public_seed),
            m_private_seed(rng.random_vec(m_wots_params.element_size()))
          {
          set_key_data(generate(m_private_seed));
          }

Botan::XMSS_WOTS_PrivateKey::XMSS_WOTS_PrivateKey	(	XMSS_WOTS_Parameters::ots_algorithm_t	oid,
		const secure_vector< uint8_t > &	public_seed
	)

inline

Constructs a WOTS private key. Chains will be generated on demand applying a hash function to a unique value generated from a secret seed and a counter. The secret seed of length n, will be automatically generated using AutoSeeded_RNG(). "n" equals the element size of the chosen WOTS security parameter set.

Parameters

oid	Identifier for the selected signature method.
public_seed	A public seed used for the pseudo random generation of public keys derived from this private key.

Definition at line 86 of file xmss_wots_privatekey.h.

88 : XMSS_WOTS_PublicKey(oid, public_seed)

89 {}

Botan::XMSS_WOTS_PublicKey::public_seed

const secure_vector< uint8_t > & public_seed() const

Definition: xmss_wots_publickey.h:201

Botan::XMSS_WOTS_PublicKey::XMSS_WOTS_PublicKey

XMSS_WOTS_PublicKey(XMSS_WOTS_Parameters::ots_algorithm_t oid)

Definition: xmss_wots_publickey.h:84

Botan::XMSS_WOTS_PrivateKey::XMSS_WOTS_PrivateKey	(	XMSS_WOTS_Parameters::ots_algorithm_t	oid,
		const secure_vector< uint8_t > &	public_seed,
		const secure_vector< uint8_t > &	private_seed
	)

inline

Constructs a WOTS private key. Chains will be generated on demand applying a hash function to a unique value generated from the secret seed and a counter.

Parameters

oid	Identifier for the selected signature method.
public_seed	A public seed used for the pseudo random generation of public keys derived from this private key.
private_seed	A secret uniformly random n-byte value.

Definition at line 101 of file xmss_wots_privatekey.h.

References Botan::XMSS_WOTS_PublicKey::set_key_data().

          : XMSS_WOTS_PublicKey(oid, public_seed),
            m_private_seed(private_seed)
          {
          set_key_data(generate(private_seed));
          }

Member Function Documentation

std::string Botan::XMSS_WOTS_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 234 of file xmss_wots_publickey.h.

References Botan::XMSS_WOTS_PublicKey::m_wots_params, and Botan::XMSS_WOTS_Parameters::name().

Referenced by Botan::XMSS_WOTS_Addressed_PublicKey::algo_name().

          {
          return m_wots_params.name();
          }

AlgorithmIdentifier Botan::XMSS_WOTS_PublicKey::algorithm_identifier ( ) const

inlineoverridevirtualinherited

Returns: X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 239 of file xmss_wots_publickey.h.

Referenced by Botan::XMSS_WOTS_Addressed_PublicKey::algorithm_identifier().

          {
          throw Not_Implemented("No AlgorithmIdentifier available for XMSS-WOTS.");
          }

wots_keysig_t Botan::XMSS_WOTS_PrivateKey::at	(	size_t	i,
		XMSS_Hash &	hash
	)

inline

Retrieves the i-th WOTS private key using pseudo random key (re-)generation.

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

Parameters

i	Index of the key to retrieve.
hash	Instance of XMSS_Hash, that may only be used by the thead executing at.

Returns: WOTS secret key.

Definition at line 124 of file xmss_wots_privatekey.h.

References Botan::XMSS_Tools::concat(), Botan::XMSS_WOTS_Parameters::element_size(), Botan::XMSS_Hash::h(), and Botan::XMSS_WOTS_PublicKey::m_wots_params.

Referenced by operator[](), and sign().

          {
          secure_vector<uint8_t> idx_bytes;
          XMSS_Tools::concat(idx_bytes, i, m_wots_params.element_size());
          hash.h(idx_bytes, m_private_seed, idx_bytes);
          return generate(idx_bytes, hash);
          }

wots_keysig_t Botan::XMSS_WOTS_PrivateKey::at	(	const XMSS_Address &	adrs,
		XMSS_Hash &	hash
	)

inline

Retrieves the i-th WOTS private key using pseudo random key (re-)generation.

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

Parameters

adrs	The address of the key to retrieve.
hash	Instance of XMSS_Hash, that may only be used by the thead executing at.

Returns: WOTS secret key.

Definition at line 159 of file xmss_wots_privatekey.h.

References Botan::XMSS_Address::bytes(), and Botan::XMSS_Hash::prf().

          {
          secure_vector<uint8_t> result;
          hash.prf(result, m_private_seed, adrs.bytes());
          return generate(result, hash);
          }

void Botan::XMSS_WOTS_PublicKey::chain	(	secure_vector< uint8_t > &	x,
		size_t	start_idx,
		size_t	steps,
		XMSS_Address &	adrs,
		const secure_vector< uint8_t > &	public_seed,
		XMSS_Hash &	hash
	)

protectedinherited

Algorithm 2: Chaining Function.

Takes an n-byte input string and transforms it into a the function result iterating the cryptographic hash function "F" steps times on the input x using the outputs of the PRNG "G".

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

Parameters

[out]	x	An n-byte input string, that will be transformed into the chaining function result.
	start_idx	The start index.
	steps	A number of steps.
	adrs	An OTS Hash Address.
	public_seed	A public seed.
	hash	Instance of XMSS_Hash, that may only by the thead executing chain.

Definition at line 16 of file xmss_wots_publickey.cpp.

References Botan::XMSS_Address::bytes(), Botan::XMSS_Hash::f(), Botan::XMSS_Address::Key_Mode, Botan::XMSS_WOTS_PublicKey::m_wots_params, Botan::XMSS_Address::Mask_Mode, Botan::XMSS_Hash::output_length(), Botan::XMSS_Hash::prf(), Botan::XMSS_Address::set_hash_address(), Botan::XMSS_Address::set_key_mask_mode(), Botan::XMSS_WOTS_Parameters::wots_parameter(), and Botan::xor_buf().

Referenced by Botan::XMSS_WOTS_PublicKey::chain(), generate_public_key(), and sign().

    {
    secure_vector<uint8_t> prf_output(hash.output_length());
 
    for(size_t i = start_idx;
          i < (start_idx + steps) && i < m_wots_params.wots_parameter();
          i++)
       {
       adrs.set_hash_address(static_cast<uint32_t>(i));
 
       //Calculate tmp XOR bitmask
       adrs.set_key_mask_mode(XMSS_Address::Key_Mask::Mask_Mode);
       hash.prf(prf_output, seed, adrs.bytes());
       xor_buf(result, prf_output, result.size());
 
       // Calculate key
       adrs.set_key_mask_mode(XMSS_Address::Key_Mask::Key_Mode);
 
       //Calculate f(key, tmp XOR bitmask)
       hash.prf(prf_output, seed, adrs.bytes());
       hash.f(result, prf_output, result);
       }
    }

void Botan::XMSS_WOTS_PublicKey::chain	(	secure_vector< uint8_t > &	x,
		size_t	start_idx,
		size_t	steps,
		XMSS_Address &	adrs,
		const secure_vector< uint8_t > &	public_seed
	)

inlineprotectedinherited

Algorithm 2: Chaining Function.

Takes an n-byte input string and transforms it into a the function result iterating the cryptographic hash function "F" steps times on the input x using the outputs of the PRNG "G".

Parameters

[out]	x	An n-byte input string, that will be transformed into the chaining function result.
	start_idx	The start index.
	steps	A number of steps.
	adrs	An OTS Hash Address.
	public_seed	A public seed.

Definition at line 316 of file xmss_wots_publickey.h.

References Botan::XMSS_WOTS_PublicKey::chain(), and Botan::XMSS_WOTS_PublicKey::m_hash.

          {
          chain(x, start_idx, steps, adrs, public_seed, m_hash);
          }

bool Botan::XMSS_WOTS_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 244 of file xmss_wots_publickey.h.

Referenced by Botan::XMSS_WOTS_Addressed_PublicKey::check_key().

          {
          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");
    }

std::unique_ptr< PK_Ops::Signature > Botan::Private_Key::create_signature_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 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 in Botan::XMSS_PrivateKey, Botan::TPM_PrivateKey, Botan::RSA_PrivateKey, Botan::ECDSA_PrivateKey, Botan::GOST_3410_PrivateKey, Botan::SM2_PrivateKey, Botan::ECGDSA_PrivateKey, Botan::ECKCDSA_PrivateKey, Botan::Ed25519_PrivateKey, and Botan::DSA_PrivateKey.

Definition at line 130 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_Signer::PK_Signer().

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

std::unique_ptr< PK_Ops::Verification > Botan::Public_Key::create_verification_op	(	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 verification operation for this key/params or throw

Parameters

params	additional parameters
provider	the provider to use

Reimplemented in Botan::XMSS_PublicKey, Botan::RSA_PublicKey, Botan::ECDSA_PublicKey, Botan::XMSS_WOTS_Addressed_PublicKey, Botan::GOST_3410_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::SM2_PublicKey, Botan::Ed25519_PublicKey, and Botan::DSA_PublicKey.

Definition at line 107 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::XMSS_WOTS_Addressed_PublicKey::create_verification_op(), and Botan::PK_Verifier::PK_Verifier().

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

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_WOTS_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 249 of file xmss_wots_publickey.h.

References Botan::XMSS_WOTS_Parameters::estimated_strength(), and Botan::XMSS_WOTS_PublicKey::m_wots_params.

Referenced by Botan::XMSS_WOTS_Addressed_PublicKey::estimated_strength(), and Botan::XMSS_WOTS_Addressed_PublicKey::key_length().

          {
          return m_wots_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);
    }

wots_keysig_t Botan::XMSS_WOTS_PrivateKey::generate_private_key ( const secure_vector< uint8_t > & priv_seed )

XMSS_WOTS_PublicKey Botan::XMSS_WOTS_PrivateKey::generate_public_key ( XMSS_Address & adrs )

Algorithm 4: "WOTS_genPK" Generates a Winternitz One Time Signature+ (WOTS+) Public Key from a given private key.

Parameters

adrs	Hash function address encoding the address of the WOTS+ key pair within a greater structure.

Returns: A XMSS_WOTS_PublicKey.

Definition at line 32 of file xmss_wots_privatekey.cpp.

References Botan::XMSS_WOTS_PublicKey::m_wots_params, Botan::XMSS_WOTS_Parameters::oid(), and Botan::XMSS_WOTS_PublicKey::public_seed().

Referenced by generate_public_key().

    {
    XMSS_WOTS_PublicKey pub_key(m_wots_params.oid(),
                                public_seed());
    generate_public_key(pub_key, wots_keysig_t((*this)[adrs]), adrs);
    return pub_key;
    }

void Botan::XMSS_WOTS_PrivateKey::generate_public_key	(	XMSS_WOTS_PublicKey &	pub_key,
		wots_keysig_t &&	in_key_data,
		XMSS_Address &	adrs,
		XMSS_Hash &	hash
	)

Algorithm 4: "WOTS_genPK" Initializes a Winternitz One Time Signature+ (WOTS+) Public Key's key_data() member, with data derived from in_key_data using the WOTS chaining function.

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

Parameters

[out]	pub_key	Public key to initialize key_data() member on.
	in_key_data	Input key material from private key used for public key generation.
	adrs	Hash function address encoding the address of the WOTS+ key pair within a greater structure.
	hash	Instance of XMSS_Hash, that may only by the thead executing generate_public_key.

Definition at line 41 of file xmss_wots_privatekey.cpp.

References BOTAN_ASSERT, Botan::XMSS_WOTS_PublicKey::chain(), hash, Botan::XMSS_WOTS_Parameters::len(), Botan::XMSS_WOTS_PublicKey::m_wots_params, Botan::XMSS_WOTS_PublicKey::public_seed(), Botan::XMSS_Address::set_chain_address(), Botan::XMSS_WOTS_PublicKey::set_key_data(), Botan::XMSS_WOTS_Parameters::wots_parameter(), and Botan::XMSS_WOTS_PublicKey::wots_parameters().

    {
    BOTAN_ASSERT(wots_parameters() == pub_key.wots_parameters() &&
                 public_seed() == pub_key.public_seed(),
                 "Conflicting public key data.");
 
    pub_key.set_key_data(std::move(in_key_data));
    for(size_t i = 0; i < m_wots_params.len(); i++)
       {
       adrs.set_chain_address(static_cast<uint32_t>(i));
       chain(pub_key[i], 0, m_wots_params.wots_parameter() - 1, adrs,
             public_seed(), hash);
       }
    }

void Botan::XMSS_WOTS_PrivateKey::generate_public_key	(	XMSS_WOTS_PublicKey &	pub_key,
		wots_keysig_t &&	in_key_data,
		XMSS_Address &	adrs
	)

inline

Algorithm 4: "WOTS_genPK" Initializes a Winternitz One Time Signature+ (WOTS+) Public Key's key_data() member, with data derived from in_key_data using the WOTS chaining function.

Parameters

[out]	pub_key	Public key to initialize key_data() member on.
	in_key_data	Input key material from private key used for public key generation.
	adrs	Hash function address encoding the address of the WOTS+ key pair within a greater structure.

Definition at line 219 of file xmss_wots_privatekey.h.

References generate_public_key(), and Botan::XMSS_WOTS_PublicKey::m_hash.

          {
          generate_public_key(pub_key, std::forward<wots_keysig_t>(in_key_data), adrs, m_hash);
          }

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

const wots_keysig_t& Botan::XMSS_WOTS_PublicKey::key_data ( ) const

inlineinherited

Definition at line 215 of file xmss_wots_publickey.h.

References Botan::XMSS_WOTS_PublicKey::m_key.

Referenced by Botan::XMSS_WOTS_PublicKey::set_key_data().

215 { return m_key; }

Botan::XMSS_WOTS_PublicKey::m_key

wots_keysig_t m_key

Definition: xmss_wots_publickey.h:327

wots_keysig_t& Botan::XMSS_WOTS_PublicKey::key_data ( )

inlineinherited

Definition at line 217 of file xmss_wots_publickey.h.

References Botan::XMSS_WOTS_PublicKey::m_key.

217 { return m_key; }

Botan::XMSS_WOTS_PublicKey::m_key

wots_keysig_t m_key

Definition: xmss_wots_publickey.h:327

size_t Botan::XMSS_WOTS_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 254 of file xmss_wots_publickey.h.

References Botan::XMSS_WOTS_Parameters::estimated_strength(), and Botan::XMSS_WOTS_PublicKey::m_wots_params.

          {
          return m_wots_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; }

Botan::XMSS_WOTS_PublicKey::operator const wots_keysig_t & ( ) const

inlineinherited

Convert the key into the raw key data. The key becomes a length len vector of n-byte elements.

Definition at line 193 of file xmss_wots_publickey.h.

References Botan::XMSS_WOTS_PublicKey::m_key.

193 { return m_key; }

Botan::XMSS_WOTS_PublicKey::m_key

wots_keysig_t m_key

Definition: xmss_wots_publickey.h:327

Botan::XMSS_WOTS_PublicKey::operator wots_keysig_t & ( )

inlineinherited

Convert the key into the raw key data. The key becomes a length len vector of n-byte elements.

Definition at line 199 of file xmss_wots_publickey.h.

References Botan::XMSS_WOTS_PublicKey::m_key.

199 { return m_key; }

Botan::XMSS_WOTS_PublicKey::m_key

wots_keysig_t m_key

Definition: xmss_wots_publickey.h:327

bool Botan::XMSS_WOTS_PublicKey::operator!= ( const XMSS_WOTS_PublicKey & key )

inlineinherited

Definition at line 269 of file xmss_wots_publickey.h.

          {
          return !(*this == key);
          }

bool Botan::XMSS_WOTS_PublicKey::operator== ( const XMSS_WOTS_PublicKey & key )

inlineinherited

Definition at line 264 of file xmss_wots_publickey.h.

References Botan::XMSS_WOTS_PublicKey::m_key.

          {
          return m_key == key.m_key;
          }

wots_keysig_t Botan::XMSS_WOTS_PrivateKey::operator[] ( size_t i )

inline

Retrieves the i-th WOTS private key using pseudo random key (re-)generation.

Parameters

i	Index of the key to retrieve.

Returns: WOTS secret key.

Definition at line 140 of file xmss_wots_privatekey.h.

References at(), and Botan::XMSS_WOTS_PublicKey::m_hash.

          {
          return this->at(i, m_hash);
          }

wots_keysig_t Botan::XMSS_WOTS_PrivateKey::operator[] ( const XMSS_Address & adrs )

inline

Definition at line 166 of file xmss_wots_privatekey.h.

References at(), and Botan::XMSS_WOTS_PublicKey::m_hash.

          {
          return this->at(adrs, m_hash);
          }

const secure_vector<uint8_t>& Botan::XMSS_WOTS_PublicKey::operator[] ( size_t i ) const

inlineinherited

Retrieves the i-th element out of the length len chain of n-byte elements contained in the public key.

Parameters

i	index of the element.

Returns: n-byte element addressed by i.

Definition at line 186 of file xmss_wots_publickey.h.

References Botan::XMSS_WOTS_PublicKey::m_key.

186 { return m_key[i]; }

Botan::XMSS_WOTS_PublicKey::m_key

wots_keysig_t m_key

Definition: xmss_wots_publickey.h:327

AlgorithmIdentifier Botan::XMSS_WOTS_PrivateKey::pkcs8_algorithm_identifier ( ) const

inlineoverridevirtual

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

Reimplemented from Botan::Private_Key.

Definition at line 296 of file xmss_wots_privatekey.h.

Referenced by Botan::XMSS_WOTS_Addressed_PrivateKey::pkcs8_algorithm_identifier().

          {
          throw Not_Implemented("No AlgorithmIdentifier available for XMSS-WOTS.");
          }

secure_vector<uint8_t> Botan::XMSS_WOTS_PrivateKey::private_key_bits ( ) const

inlineoverridevirtual

Returns: BER encoded private key bits

Implements Botan::Private_Key.

Definition at line 301 of file xmss_wots_privatekey.h.

Referenced by Botan::XMSS_WOTS_Addressed_PrivateKey::private_key_bits().

          {
          throw Not_Implemented("No PKCS8 key format defined for XMSS-WOTS.");
          }

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

const secure_vector<uint8_t>& Botan::XMSS_WOTS_PrivateKey::private_seed ( ) const

inline

Retrieves the secret seed used to generate WOTS+ chains. The seed should be a uniformly random n-byte value.

Returns: secret seed.

Definition at line 268 of file xmss_wots_privatekey.h.

Referenced by Botan::XMSS_PrivateKey::raw_private_key(), and set_private_seed().

          {
          return m_private_seed;
          }

std::vector<uint8_t> Botan::XMSS_WOTS_PublicKey::public_key_bits ( ) const

inlineoverridevirtualinherited

Returns: BER encoded public key bits

Implements Botan::Public_Key.

Definition at line 259 of file xmss_wots_publickey.h.

Referenced by Botan::XMSS_WOTS_Addressed_PublicKey::public_key_bits().

          {
          throw Not_Implemented("No key format defined for XMSS-WOTS");
          }

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

inlineinherited

Definition at line 201 of file xmss_wots_publickey.h.

References Botan::XMSS_WOTS_PublicKey::m_public_seed.

Referenced by generate_public_key(), and Botan::XMSS_WOTS_PublicKey::set_public_seed().

201 { return m_public_seed; }

Botan::XMSS_WOTS_PublicKey::m_public_seed

secure_vector< uint8_t > m_public_seed

Definition: xmss_wots_publickey.h:328

secure_vector<uint8_t>& Botan::XMSS_WOTS_PublicKey::public_seed ( )

inlineinherited

Definition at line 203 of file xmss_wots_publickey.h.

References Botan::XMSS_WOTS_PublicKey::m_public_seed.

203 { return m_public_seed; }

Botan::XMSS_WOTS_PublicKey::m_public_seed

secure_vector< uint8_t > m_public_seed

Definition: xmss_wots_publickey.h:328

void Botan::XMSS_WOTS_PublicKey::set_key_data ( const wots_keysig_t & key_data )

inlineinherited

Definition at line 219 of file xmss_wots_publickey.h.

References Botan::XMSS_WOTS_PublicKey::key_data(), and Botan::XMSS_WOTS_PublicKey::m_key.

Referenced by generate_public_key(), and XMSS_WOTS_PrivateKey().

          {
          m_key = key_data;
          }

void Botan::XMSS_WOTS_PublicKey::set_key_data ( wots_keysig_t && key_data )

inlineinherited

Definition at line 224 of file xmss_wots_publickey.h.

References Botan::XMSS_WOTS_PublicKey::key_data(), and Botan::XMSS_WOTS_PublicKey::m_key.

          {
          m_key = std::move(key_data);
          }

void Botan::XMSS_WOTS_PrivateKey::set_private_seed ( const secure_vector< uint8_t > & private_seed )

inline

Sets the secret seed used to generate WOTS+ chains. The seed should be a uniformly random n-byte value.

Parameters

private_seed Uniformly random n-byte value.

Definition at line 279 of file xmss_wots_privatekey.h.

References private_seed().

Referenced by Botan::XMSS_PrivateKey::XMSS_PrivateKey().

          {
          m_private_seed = private_seed;
          }

void Botan::XMSS_WOTS_PrivateKey::set_private_seed ( secure_vector< uint8_t > && private_seed )

inline

Sets the secret seed used to generate WOTS+ chains. The seed should be a uniformly random n-byte value.

Parameters

private_seed Uniformly random n-byte value.

Definition at line 290 of file xmss_wots_privatekey.h.

References private_seed().

          {
          m_private_seed = std::move(private_seed);
          }

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

inlineinherited

Definition at line 205 of file xmss_wots_publickey.h.

References Botan::XMSS_WOTS_PublicKey::m_public_seed, and Botan::XMSS_WOTS_PublicKey::public_seed().

          {
          m_public_seed = public_seed;
          }

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

inlineinherited

Definition at line 210 of file xmss_wots_publickey.h.

References Botan::XMSS_WOTS_PublicKey::m_public_seed, and Botan::XMSS_WOTS_PublicKey::public_seed().

          {
          m_public_seed = std::move(public_seed);
          }

wots_keysig_t Botan::XMSS_WOTS_PrivateKey::sign	(	const secure_vector< uint8_t > &	msg,
		XMSS_Address &	adrs
	)

inline

Algorithm 5: "WOTS_sign" Generates a signature from a private key and a message.

Parameters

msg	A message to sign.
adrs	An OTS hash address identifying the WOTS+ key pair used for signing.

Returns: signature for msg.

Definition at line 236 of file xmss_wots_privatekey.h.

References Botan::XMSS_WOTS_PublicKey::m_hash.

          {
          return sign(msg, adrs, m_hash);
          }

wots_keysig_t Botan::XMSS_WOTS_PrivateKey::sign	(	const secure_vector< uint8_t > &	msg,
		XMSS_Address &	adrs,
		XMSS_Hash &	hash
	)

Algorithm 5: "WOTS_sign" Generates a signature from a private key and a message.

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

Parameters

msg	A message to sign.
adrs	An OTS hash address identifying the WOTS+ key pair used for signing.
hash	Instance of XMSS_Hash, that may only be used by the thead executing sign.

Returns: signature for msg.

Definition at line 60 of file xmss_wots_privatekey.cpp.

References Botan::XMSS_WOTS_Parameters::append_checksum(), at(), Botan::XMSS_WOTS_Parameters::base_w(), Botan::XMSS_WOTS_PublicKey::chain(), Botan::XMSS_WOTS_Parameters::len(), Botan::XMSS_WOTS_Parameters::len_1(), Botan::XMSS_WOTS_PublicKey::m_public_seed, Botan::XMSS_WOTS_PublicKey::m_wots_params, and Botan::XMSS_Address::set_chain_address().

    {
    secure_vector<uint8_t> msg_digest
       {
       m_wots_params.base_w(msg, m_wots_params.len_1())
       };
 
    m_wots_params.append_checksum(msg_digest);
    wots_keysig_t sig(this->at(adrs, hash));
 
    for(size_t i = 0; i < m_wots_params.len(); i++)
       {
       adrs.set_chain_address(static_cast<uint32_t>(i));
       chain(sig[i], 0 , msg_digest[i], adrs, m_public_seed, hash);
       }
 
    return sig;
    }

virtual bool Botan::Private_Key::stateful_operation ( ) const

inlinevirtualinherited

Reimplemented in Botan::XMSS_PrivateKey.

Definition at line 189 of file pk_keys.h.

189 { return false; }

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

const XMSS_WOTS_Parameters& Botan::XMSS_WOTS_PublicKey::wots_parameters ( ) const

inlineinherited

Definition at line 229 of file xmss_wots_publickey.h.

References Botan::XMSS_WOTS_PublicKey::m_wots_params.

Referenced by generate_public_key().

          {
          return m_wots_params;
          }

Member Data Documentation

XMSS_Hash Botan::XMSS_WOTS_PublicKey::m_hash

protectedinherited

Definition at line 326 of file xmss_wots_publickey.h.

Referenced by Botan::XMSS_WOTS_PublicKey::chain(), generate_public_key(), operator[](), and sign().

wots_keysig_t Botan::XMSS_WOTS_PublicKey::m_key

protectedinherited

Definition at line 327 of file xmss_wots_publickey.h.

Referenced by Botan::XMSS_WOTS_PublicKey::key_data(), Botan::XMSS_WOTS_PublicKey::operator const wots_keysig_t &(), Botan::XMSS_WOTS_PublicKey::operator wots_keysig_t &(), Botan::XMSS_WOTS_PublicKey::operator==(), Botan::XMSS_WOTS_PublicKey::operator[](), and Botan::XMSS_WOTS_PublicKey::set_key_data().

secure_vector<uint8_t> Botan::XMSS_WOTS_PublicKey::m_public_seed

protectedinherited

Definition at line 328 of file xmss_wots_publickey.h.

Referenced by Botan::XMSS_WOTS_PublicKey::public_seed(), Botan::XMSS_WOTS_PublicKey::set_public_seed(), and sign().

XMSS_WOTS_Parameters Botan::XMSS_WOTS_PublicKey::m_wots_params

protectedinherited

Definition at line 325 of file xmss_wots_publickey.h.

Referenced by Botan::XMSS_WOTS_PublicKey::algo_name(), at(), Botan::XMSS_WOTS_PublicKey::chain(), Botan::XMSS_WOTS_PublicKey::estimated_strength(), generate_public_key(), Botan::XMSS_WOTS_PublicKey::key_length(), sign(), and Botan::XMSS_WOTS_PublicKey::wots_parameters().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation