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

#include <ed25519.h>

Inheritance diagram for Botan::Ed25519_PublicKey:
Botan::Public_Key Botan::Ed25519_PrivateKey

Public Member Functions

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
 
 Ed25519_PublicKey (const AlgorithmIdentifier &alg_id, const std::vector< uint8_t > &key_bits)
 
 Ed25519_PublicKey (const std::vector< uint8_t > &pub)
 
 Ed25519_PublicKey (const secure_vector< uint8_t > &pub)
 
size_t estimated_strength () const override
 
std::string fingerprint_public (const std::string &alg="SHA-256") const
 
virtual OID get_oid () const
 
const std::vector< uint8_t > & get_public_key () const
 
size_t key_length () const override
 
virtual size_t message_part_size () const
 
virtual size_t message_parts () const
 
std::vector< uint8_t > public_key_bits () const override
 
std::vector< uint8_t > subject_public_key () const
 

Protected Member Functions

 Ed25519_PublicKey ()=default
 

Protected Attributes

std::vector< uint8_t > m_public
 

Detailed Description

Definition at line 18 of file ed25519.h.

Constructor & Destructor Documentation

◆ Ed25519_PublicKey() [1/4]

Botan::Ed25519_PublicKey::Ed25519_PublicKey ( const AlgorithmIdentifier alg_id,
const std::vector< uint8_t > &  key_bits 
)

Create a Ed25519 Public Key.

Parameters
alg_idthe X.509 algorithm identifier
key_bitsDER encoded public key bits

Definition at line 34 of file ed25519_key.cpp.

References m_public.

36  {
37  m_public = key_bits;
38 
39  if(m_public.size() != 32)
40  throw Decoding_Error("Invalid size for Ed25519 public key");
41  }
std::vector< uint8_t > m_public
Definition: ed25519.h:62

◆ Ed25519_PublicKey() [2/4]

Botan::Ed25519_PublicKey::Ed25519_PublicKey ( const std::vector< uint8_t > &  pub)
inlineexplicit

Create a Ed25519 Public Key.

Parameters
pub32-byte raw public key

Definition at line 45 of file ed25519.h.

45 : m_public(pub) {}
std::vector< uint8_t > m_public
Definition: ed25519.h:62

◆ Ed25519_PublicKey() [3/4]

Botan::Ed25519_PublicKey::Ed25519_PublicKey ( const secure_vector< uint8_t > &  pub)
inlineexplicit

Create a Ed25519 Public Key.

Parameters
pub32-byte raw public key

Definition at line 51 of file ed25519.h.

51  :
52  m_public(pub.begin(), pub.end()) {}
std::vector< uint8_t > m_public
Definition: ed25519.h:62

◆ Ed25519_PublicKey() [4/4]

Botan::Ed25519_PublicKey::Ed25519_PublicKey ( )
protecteddefault

Member Function Documentation

◆ algo_name()

std::string Botan::Ed25519_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 21 of file ed25519.h.

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

21 { return "Ed25519"; }

◆ algorithm_identifier()

AlgorithmIdentifier Botan::Ed25519_PublicKey::algorithm_identifier ( ) const
overridevirtual
Returns
X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 20 of file ed25519_key.cpp.

References Botan::Public_Key::get_oid().

21  {
22  // AlgorithmIdentifier::USE_NULL_PARAM puts 0x05 0x00 in parameters
23  // We want nothing
24  std::vector<uint8_t> empty;
25  return AlgorithmIdentifier(get_oid(), empty);
26  }
virtual OID get_oid() const
Definition: pk_keys.cpp:51

◆ check_key()

bool Botan::Ed25519_PublicKey::check_key ( RandomNumberGenerator rng,
bool  strong 
) const
overridevirtual

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.

Reimplemented in Botan::Ed25519_PrivateKey.

Definition at line 28 of file ed25519_key.cpp.

29  {
30  return true; // no tests possible?
31  // TODO could check cofactor
32  }

◆ 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::Ed25519_PublicKey::create_verification_op ( 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 verification operation for this key/params or throw

Parameters
paramsadditional parameters
providerthe provider to use

Reimplemented from Botan::Public_Key.

Definition at line 219 of file ed25519_key.cpp.

References algo_name().

221  {
222  if(provider == "base" || provider.empty())
223  {
224  if(params == "" || params == "Identity" || params == "Pure")
225  return std::unique_ptr<PK_Ops::Verification>(new Ed25519_Pure_Verify_Operation(*this));
226  else
227  return std::unique_ptr<PK_Ops::Verification>(new Ed25519_Hashed_Verify_Operation(*this, params));
228  }
229  throw Provider_Not_Found(algo_name(), provider);
230  }
std::string algo_name() const override
Definition: ed25519.h:21

◆ estimated_strength()

size_t Botan::Ed25519_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 23 of file ed25519.h.

23 { return 128; }

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

References Botan::Public_Key::algo_name(), and Botan::OIDS::lookup().

Referenced by Botan::DL_Scheme_PublicKey::algorithm_identifier(), Botan::Curve25519_PublicKey::algorithm_identifier(), 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(), Botan::EC_PublicKey::EC_PublicKey(), and Botan::XMSS_WOTS_Addressed_PublicKey::get_oid().

52  {
53  try {
54  return OIDS::lookup(algo_name());
55  }
56  catch(Lookup_Error&)
57  {
58  throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
59  }
60  }
virtual std::string algo_name() const =0
std::string lookup(const OID &oid)
Definition: oids.cpp:18

◆ get_public_key()

const std::vector<uint8_t>& Botan::Ed25519_PublicKey::get_public_key ( ) const
inline

Definition at line 58 of file ed25519.h.

58 { return m_public; }
std::vector< uint8_t > m_public
Definition: ed25519.h:62

◆ key_length()

size_t Botan::Ed25519_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 25 of file ed25519.h.

25 { return 255; }

◆ 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_bits()

std::vector< uint8_t > Botan::Ed25519_PublicKey::public_key_bits ( ) const
overridevirtual
Returns
BER encoded public key bits

Implements Botan::Public_Key.

Definition at line 43 of file ed25519_key.cpp.

References m_public.

44  {
45  return m_public;
46  }
std::vector< uint8_t > m_public
Definition: ed25519.h:62

◆ 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_public

std::vector<uint8_t> Botan::Ed25519_PublicKey::m_public
protected

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