Botan  2.4.0
Crypto and TLS for C++11
Public Member Functions | Protected Attributes | List of all members
Botan::XMSS_WOTS_Addressed_PublicKey Class Reference

#include <xmss_wots_addressed_publickey.h>

Inheritance diagram for Botan::XMSS_WOTS_Addressed_PublicKey:
Botan::Public_Key Botan::XMSS_WOTS_Addressed_PrivateKey

Public Member Functions

const XMSS_Addressaddress () const
 
XMSS_Addressaddress ()
 
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::Encryptioncreate_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
 
virtual std::unique_ptr< PK_Ops::KEM_Encryptioncreate_kem_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
 
std::unique_ptr< PK_Ops::Verificationcreate_verification_op (const std::string &params, const std::string &provider) const override
 
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
 
const XMSS_WOTS_PublicKeypublic_key () const
 
XMSS_WOTS_PublicKeypublic_key ()
 
std::vector< uint8_t > public_key_bits () const override
 
std::vector< uint8_t > subject_public_key () const
 
 XMSS_WOTS_Addressed_PublicKey (const XMSS_WOTS_PublicKey &public_key)
 
 XMSS_WOTS_Addressed_PublicKey (const XMSS_WOTS_PublicKey &public_key, const XMSS_Address &adrs)
 
 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/4]

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

◆ XMSS_WOTS_Addressed_PublicKey() [2/4]

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

◆ XMSS_WOTS_Addressed_PublicKey() [3/4]

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

◆ XMSS_WOTS_Addressed_PublicKey() [4/4]

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

Definition at line 37 of file xmss_wots_addressed_publickey.h.

Member Function Documentation

◆ address() [1/2]

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

Definition at line 44 of file xmss_wots_addressed_publickey.h.

References m_adrs.

◆ address() [2/2]

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

Definition at line 45 of file xmss_wots_addressed_publickey.h.

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

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

48  {
49  return m_pub_key.algo_name();
50  }
std::string algo_name() const override

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

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

53  {
55  }
AlgorithmIdentifier algorithm_identifier() const override

◆ check_key()

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

Test the key values for consistency.

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

Implements Botan::Public_Key.

Definition at line 57 of file xmss_wots_addressed_publickey.h.

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

58  {
59  return m_pub_key.check_key(rng, strong);
60  }
bool check_key(RandomNumberGenerator &, bool) const override

◆ create_encryption_op()

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

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

Return an encryption operation for this key/params or throw

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

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

Definition at line 92 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

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

◆ create_kem_encryption_op()

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

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

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

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

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

Definition at line 100 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

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

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

Reimplemented from Botan::Public_Key.

Definition at line 63 of file xmss_wots_addressed_publickey.h.

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

65  {
66  return m_pub_key.create_verification_op(params, provider);
67  }
virtual std::unique_ptr< PK_Ops::Verification > create_verification_op(const std::string &params, const std::string &provider) const
Definition: pk_keys.cpp:108

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

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

75  {
77  }
size_t estimated_strength() const override

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

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

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

◆ get_oid()

OID Botan::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 69 of file xmss_wots_addressed_publickey.h.

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

70  {
71  return m_pub_key.get_oid();
72  }
virtual OID get_oid() const
Definition: pk_keys.cpp:51

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

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

80  {
82  }
size_t estimated_strength() const override

◆ 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::GOST_3410_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::SM2_Signature_PublicKey, and Botan::DSA_PublicKey.

Definition at line 118 of file pk_keys.h.

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

118 { return 0; }

◆ message_parts()

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

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

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

Returns
number of message parts

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

Definition at line 107 of file pk_keys.h.

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

107 { return 1; }

◆ public_key() [1/2]

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

Definition at line 41 of file xmss_wots_addressed_publickey.h.

References m_pub_key.

◆ public_key() [2/2]

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

Definition at line 42 of file xmss_wots_addressed_publickey.h.

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

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

85  {
86  return m_pub_key.public_key_bits();
87  }
std::vector< uint8_t > public_key_bits() const override

◆ subject_public_key()

std::vector< uint8_t > Botan::Public_Key::subject_public_key ( ) const
inherited
Returns
X.509 subject key encoding for this key object

Definition at line 38 of file pk_keys.cpp.

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

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

39  {
40  return DER_Encoder()
41  .start_cons(SEQUENCE)
42  .encode(algorithm_identifier())
43  .encode(public_key_bits(), BIT_STRING)
44  .end_cons()
45  .get_contents_unlocked();
46  }
virtual std::vector< uint8_t > public_key_bits() const =0
virtual AlgorithmIdentifier algorithm_identifier() const =0

Member Data Documentation

◆ m_adrs

XMSS_Address Botan::XMSS_WOTS_Addressed_PublicKey::m_adrs
protected

Definition at line 91 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

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