#include <xmss_wots_addressed_publickey.h>

Inheritance diagram for Botan::XMSS_WOTS_Addressed_PublicKey:

Public Member Functions
XMSS_Address &	address ()

const XMSS_Address &	address () const

std::string	algo_name () const override

AlgorithmIdentifier	algorithm_identifier () const override

bool	check_key (RandomNumberGenerator &rng, bool strong) const override

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_Encryption >	create_kem_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const

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

virtual Signature_Format	default_x509_signature_format () const

size_t	estimated_strength () const override

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

OID	get_oid () const override

size_t	key_length () const override

virtual size_t	message_part_size () const

virtual size_t	message_parts () const

XMSS_WOTS_PublicKey &	public_key ()

const XMSS_WOTS_PublicKey &	public_key () const

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

std::vector< uint8_t >	subject_public_key () const

	XMSS_WOTS_Addressed_PublicKey (XMSS_WOTS_PublicKey public_key)

	XMSS_WOTS_Addressed_PublicKey (XMSS_WOTS_PublicKey public_key, XMSS_Address adrs)

Protected Attributes
XMSS_Address	m_adrs

XMSS_WOTS_PublicKey	m_pub_key

Detailed Description

Wrapper class to pair a XMSS_WOTS_PublicKey with an XMSS Address. Since the PK_Ops::Verification interface does not allow an extra address parameter to be passed to the sign(RandomNumberGenerator&), the address needs to be stored together with the key and passed to the XMSS_WOTS_Verification_Operation() on creation.

Definition at line 24 of file xmss_wots_addressed_publickey.h.

Constructor & Destructor Documentation

◆ XMSS_WOTS_Addressed_PublicKey() [1/2]

Botan::XMSS_WOTS_Addressed_PublicKey::XMSS_WOTS_Addressed_PublicKey ( XMSS_WOTS_PublicKey public_key )

inline

Definition at line 27 of file xmss_wots_addressed_publickey.h.

28 : m_pub_key(std::move(public_key)), m_adrs() {}

Botan::XMSS_WOTS_Addressed_PublicKey::m_pub_key

XMSS_WOTS_PublicKey m_pub_key

Definition: xmss_wots_addressed_publickey.h:83

Botan::XMSS_WOTS_Addressed_PublicKey::public_key

const XMSS_WOTS_PublicKey & public_key() const

Definition: xmss_wots_addressed_publickey.h:34

Botan::XMSS_WOTS_Addressed_PublicKey::m_adrs

XMSS_Address m_adrs

Definition: xmss_wots_addressed_publickey.h:84

◆ XMSS_WOTS_Addressed_PublicKey() [2/2]

Botan::XMSS_WOTS_Addressed_PublicKey::XMSS_WOTS_Addressed_PublicKey	(	XMSS_WOTS_PublicKey	public_key,
		XMSS_Address	adrs
	)

inline

Definition at line 30 of file xmss_wots_addressed_publickey.h.

32 : m_pub_key(std::move(public_key)), m_adrs(std::move(adrs)) {}

Member Function Documentation

◆ address() [1/2]

XMSS_Address & Botan::XMSS_WOTS_Addressed_PublicKey::address ( )

inline

Definition at line 38 of file xmss_wots_addressed_publickey.h.

38{ return m_adrs; }

References m_adrs.

◆ address() [2/2]

const XMSS_Address & Botan::XMSS_WOTS_Addressed_PublicKey::address ( ) const

inline

Definition at line 37 of file xmss_wots_addressed_publickey.h.

37{ return m_adrs; }

References m_adrs.

◆ algo_name()

std::string Botan::XMSS_WOTS_Addressed_PublicKey::algo_name ( ) const

inlineoverridevirtual

Get the name of the underlying public key scheme.

Returns: name of the public key scheme

Implements Botan::Public_Key.

Definition at line 40 of file xmss_wots_addressed_publickey.h.

         {
         return m_pub_key.algo_name();
         }

References Botan::XMSS_WOTS_PublicKey::algo_name(), and m_pub_key.

◆ algorithm_identifier()

AlgorithmIdentifier Botan::XMSS_WOTS_Addressed_PublicKey::algorithm_identifier ( ) const

inlineoverridevirtual

Returns: X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 45 of file xmss_wots_addressed_publickey.h.

         {
         return m_pub_key.algorithm_identifier();
         }

References Botan::XMSS_WOTS_PublicKey::algorithm_identifier(), and m_pub_key.

◆ check_key()

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

inlineoverridevirtual

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 50 of file xmss_wots_addressed_publickey.h.

         {
         return m_pub_key.check_key(rng, strong);
         }

References Botan::XMSS_WOTS_PublicKey::check_key(), and m_pub_key.

◆ create_encryption_op()

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

virtualinherited

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

Return an encryption operation for this key/params or throw

Parameters

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::ElGamal_PublicKey, Botan::RSA_PublicKey, and Botan::SM2_PublicKey.

Definition at line 91 of file pk_keys.cpp.

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

References Botan::Public_Key::algo_name().

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

◆ create_kem_encryption_op()

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

virtualinherited

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

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

Parameters

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::Kyber_PublicKey, Botan::McEliece_PublicKey, and Botan::RSA_PublicKey.

Definition at line 99 of file pk_keys.cpp.

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

References Botan::Public_Key::algo_name().

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

◆ create_verification_op()

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

inlineoverridevirtual

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 56 of file xmss_wots_addressed_publickey.h.

         {
         return m_pub_key.create_verification_op(params, provider);
         }

References Botan::Public_Key::create_verification_op(), and m_pub_key.

◆ default_x509_signature_format()

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

inlinevirtualinherited

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 125 of file pk_keys.h.

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

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

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

◆ estimated_strength()

size_t Botan::XMSS_WOTS_Addressed_PublicKey::estimated_strength ( ) const

inlineoverridevirtual

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 67 of file xmss_wots_addressed_publickey.h.

         {
         return m_pub_key.estimated_strength();
         }

References Botan::XMSS_WOTS_PublicKey::estimated_strength(), and m_pub_key.

◆ fingerprint_public()

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

inherited

Returns: Hash of the subject public key

Definition at line 77 of file pk_keys.cpp.

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

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

◆ get_oid()

OID Botan::XMSS_WOTS_Addressed_PublicKey::get_oid ( ) const

inlineoverridevirtual

Get the OID of the underlying public key scheme.

Returns: OID of the public key scheme

Reimplemented from Botan::Public_Key.

Definition at line 62 of file xmss_wots_addressed_publickey.h.

         {
         return m_pub_key.get_oid();
         }

References Botan::Public_Key::get_oid(), and m_pub_key.

◆ key_length()

size_t Botan::XMSS_WOTS_Addressed_PublicKey::key_length ( ) const

inlineoverridevirtual

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 72 of file xmss_wots_addressed_publickey.h.

         {
         return m_pub_key.estimated_strength();
         }

References Botan::XMSS_WOTS_PublicKey::estimated_strength(), and m_pub_key.

◆ message_part_size()

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

inlinevirtualinherited

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

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

Returns: size of the message parts in bits

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

Definition at line 123 of file pk_keys.h.

123{ return 0; }

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

◆ message_parts()

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

inlinevirtualinherited

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

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

Returns: number of message parts

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

Definition at line 112 of file pk_keys.h.

112{ return 1; }

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

◆ public_key() [1/2]

XMSS_WOTS_PublicKey & Botan::XMSS_WOTS_Addressed_PublicKey::public_key ( )

inline

Definition at line 35 of file xmss_wots_addressed_publickey.h.

35{ return m_pub_key; }

References m_pub_key.

◆ public_key() [2/2]

const XMSS_WOTS_PublicKey & Botan::XMSS_WOTS_Addressed_PublicKey::public_key ( ) const

inline

Definition at line 34 of file xmss_wots_addressed_publickey.h.

34{ return m_pub_key; }

References m_pub_key.

◆ public_key_bits()

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

inlineoverridevirtual

Returns: BER encoded public key bits

Implements Botan::Public_Key.

Definition at line 77 of file xmss_wots_addressed_publickey.h.

         {
         return m_pub_key.public_key_bits();
         }

References m_pub_key, and Botan::XMSS_WOTS_PublicKey::public_key_bits().

◆ subject_public_key()

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

inherited

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

Definition at line 38 of file pk_keys.cpp.

   {
   std::vector<uint8_t> output;
 
   DER_Encoder(output).start_sequence()
         .encode(algorithm_identifier())
         .encode(public_key_bits(), ASN1_Type::BitString)
      .end_cons();
 
   return output;
   }

References Botan::Public_Key::algorithm_identifier(), Botan::BitString, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::Public_Key::public_key_bits(), and Botan::DER_Encoder::start_sequence().

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

Member Data Documentation

◆ m_adrs

XMSS_Address Botan::XMSS_WOTS_Addressed_PublicKey::m_adrs

protected

Definition at line 84 of file xmss_wots_addressed_publickey.h.

Referenced by address().

◆ m_pub_key

XMSS_WOTS_PublicKey Botan::XMSS_WOTS_Addressed_PublicKey::m_pub_key

protected

Definition at line 83 of file xmss_wots_addressed_publickey.h.

Referenced by algo_name(), algorithm_identifier(), check_key(), create_verification_op(), estimated_strength(), get_oid(), key_length(), public_key(), and public_key_bits().

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

src/lib/pubkey/xmss/xmss_wots_addressed_publickey.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ XMSS_WOTS_Addressed_PublicKey() [1/2]

◆ XMSS_WOTS_Addressed_PublicKey() [2/2]

Member Function Documentation

◆ address() [1/2]

◆ address() [2/2]

◆ algo_name()

◆ algorithm_identifier()

◆ check_key()

◆ create_encryption_op()

◆ create_kem_encryption_op()

◆ create_verification_op()

◆ default_x509_signature_format()

◆ estimated_strength()

◆ fingerprint_public()

◆ get_oid()

◆ key_length()

◆ message_part_size()

◆ message_parts()

◆ public_key() [1/2]

◆ public_key() [2/2]

◆ public_key_bits()

◆ subject_public_key()

Member Data Documentation

◆ m_adrs

◆ m_pub_key