Botan 3.4.0
Crypto and TLS for C&
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::Asymmetric_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, std::string_view params, std::string_view provider) const
 
virtual std::unique_ptr< PK_Ops::KEM_Encryptioncreate_kem_encryption_op (std::string_view params, std::string_view provider) const
 
std::unique_ptr< PK_Ops::Verificationcreate_verification_op (std::string_view params, std::string_view provider) const override
 
std::unique_ptr< PK_Ops::Verificationcreate_x509_verification_op (const AlgorithmIdentifier &signature_algorithm, std::string_view provider) const override
 
virtual Signature_Format default_x509_signature_format () const
 
 Ed25519_PublicKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits)
 
template<typename Alloc >
 Ed25519_PublicKey (const std::vector< uint8_t, Alloc > &pub)
 
 Ed25519_PublicKey (const uint8_t pub_key[], size_t len)
 
size_t estimated_strength () const override
 
std::string fingerprint_public (std::string_view alg="SHA-256") const
 
std::unique_ptr< Private_Keygenerate_another (RandomNumberGenerator &rng) const final
 
virtual const BigIntget_int_field (std::string_view field) const
 
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
 
virtual OID object_identifier () const
 
std::vector< uint8_t > public_key_bits () const override
 
std::vector< uint8_t > subject_public_key () const
 
bool supports_operation (PublicKeyOperation op) const override
 

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,
std::span< const 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 74 of file ed25519_key.cpp.

74 {
75 m_public.assign(key_bits.begin(), key_bits.end());
76
77 if(m_public.size() != 32) {
78 throw Decoding_Error("Invalid size for Ed25519 public key");
79 }
80}
std::vector< uint8_t > m_public
Definition ed25519.h:58

References m_public.

◆ Ed25519_PublicKey() [2/4]

template<typename Alloc >
Botan::Ed25519_PublicKey::Ed25519_PublicKey ( const std::vector< uint8_t, Alloc > & pub)
inline

Definition at line 46 of file ed25519.h.

46: Ed25519_PublicKey(pub.data(), pub.size()) {}

◆ Ed25519_PublicKey() [3/4]

Botan::Ed25519_PublicKey::Ed25519_PublicKey ( const uint8_t pub_key[],
size_t len )

Definition at line 67 of file ed25519_key.cpp.

67 {
68 if(pub_len != 32) {
69 throw Decoding_Error("Invalid length for Ed25519 key");
70 }
71 m_public.assign(pub_key, pub_key + pub_len);
72}

References m_public.

◆ 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::Asymmetric_Key.

Definition at line 20 of file ed25519.h.

20{ 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 23 of file ed25519_key.cpp.

23 {
24 return AlgorithmIdentifier(object_identifier(), AlgorithmIdentifier::USE_EMPTY_PARAM);
25}
virtual OID object_identifier() const
Definition pk_keys.cpp:22

References Botan::Asymmetric_Key::object_identifier(), and Botan::AlgorithmIdentifier::USE_EMPTY_PARAM.

◆ check_key()

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

Implements Botan::Public_Key.

Definition at line 27 of file ed25519_key.cpp.

27 {
28 if(m_public.size() != 32) {
29 return false;
30 }
31
32 /*
33 This function was derived from public domain code in Tor's blinding.c
34 */
35
36 const uint8_t identity_element[32] = {1};
37 if(CT::is_equal(m_public.data(), identity_element, 32).as_bool()) {
38 return false;
39 }
40
41 // The order of the Ed25519 group encoded
42 const uint8_t modm_m[32] = {0xed, 0xd3, 0xf5, 0x5c, 0x1a, 0x63, 0x12, 0x58, 0xd6, 0x9c, 0xf7,
43 0xa2, 0xde, 0xf9, 0xde, 0x14, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
44 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x10};
45
46 const unsigned char zero[32] = {0};
47
48 unsigned char pkcopy[32];
49
50 copy_mem(pkcopy, m_public.data(), 32);
51 pkcopy[31] ^= (1 << 7); // flip sign
52 ge_p3 point;
53 if(ge_frombytes_negate_vartime(&point, pkcopy) != 0) {
54 return false;
55 }
56
57 uint8_t result[32];
58 ge_double_scalarmult_vartime(result, modm_m, &point, zero);
59
60 if(!CT::is_equal(result, identity_element, 32).as_bool()) {
61 return false;
62 }
63
64 return true;
65}
constexpr CT::Mask< T > is_equal(const T x[], const T y[], size_t len)
Definition ct_utils.h:345
int ge_frombytes_negate_vartime(ge_p3 *v, const uint8_t *)
Definition ge.cpp:425
constexpr void copy_mem(T *out, const T *in, size_t n)
Definition mem_ops.h:146
void ge_double_scalarmult_vartime(uint8_t out[32], const uint8_t a[], const ge_p3 *A, const uint8_t b[])

References Botan::copy_mem(), Botan::ge_double_scalarmult_vartime(), Botan::ge_frombytes_negate_vartime(), Botan::CT::is_equal(), and m_public.

◆ create_encryption_op()

std::unique_ptr< PK_Ops::Encryption > Botan::Public_Key::create_encryption_op ( RandomNumberGenerator & rng,
std::string_view params,
std::string_view 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::ElGamal_PublicKey, Botan::RSA_PublicKey, and Botan::SM2_PublicKey.

Definition at line 90 of file pk_keys.cpp.

92 {
93 throw Lookup_Error(fmt("{} does not support encryption", algo_name()));
94}
virtual std::string algo_name() const =0
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

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 ( std::string_view params,
std::string_view 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
paramsadditional parameters
providerthe provider to use

Reimplemented in Botan::TLS::Hybrid_KEM_PublicKey, Botan::TLS::KEX_to_KEM_Adapter_PublicKey, Botan::FrodoKEM_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, and Botan::RSA_PublicKey.

Definition at line 96 of file pk_keys.cpp.

97 {
98 throw Lookup_Error(fmt("{} does not support KEM encryption", algo_name()));
99}

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

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

◆ create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Ed25519_PublicKey::create_verification_op ( std::string_view params,
std::string_view provider ) const
overridevirtual

This is an internal library function exposed on key types. In 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 272 of file ed25519_key.cpp.

273 {
274 if(provider == "base" || provider.empty()) {
275 if(params.empty() || params == "Identity" || params == "Pure") {
276 return std::make_unique<Ed25519_Pure_Verify_Operation>(*this);
277 } else if(params == "Ed25519ph") {
278 return std::make_unique<Ed25519_Hashed_Verify_Operation>(*this, "SHA-512", true);
279 } else {
280 return std::make_unique<Ed25519_Hashed_Verify_Operation>(*this, params, false);
281 }
282 }
283 throw Provider_Not_Found(algo_name(), provider);
284}
std::string algo_name() const override
Definition ed25519.h:20

◆ create_x509_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Ed25519_PublicKey::create_x509_verification_op ( const AlgorithmIdentifier & signature_algorithm,
std::string_view provider ) const
overridevirtual

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

Return a verification operation for this combination of key and signature algorithm or throw.

Parameters
signature_algorithmis the X.509 algorithm identifier encoding the padding scheme and hash hash function used in the signature if applicable.
providerthe provider to use

Reimplemented from Botan::Public_Key.

Definition at line 286 of file ed25519_key.cpp.

287 {
288 if(provider == "base" || provider.empty()) {
289 if(alg_id != this->algorithm_identifier()) {
290 throw Decoding_Error("Unexpected AlgorithmIdentifier for Ed25519 X509 signature");
291 }
292
293 return std::make_unique<Ed25519_Pure_Verify_Operation>(*this);
294 }
295 throw Provider_Not_Found(algo_name(), provider);
296}
AlgorithmIdentifier algorithm_identifier() const override

◆ default_x509_signature_format()

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

◆ 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::Asymmetric_Key.

Definition at line 22 of file ed25519.h.

22{ return 128; }

◆ fingerprint_public()

std::string Botan::Public_Key::fingerprint_public ( std::string_view alg = "SHA-256") const
inherited
Returns
Hash of the subject public key

Definition at line 79 of file pk_keys.cpp.

79 {
80 return create_hex_fingerprint(subject_public_key(), hash_algo);
81}
std::vector< uint8_t > subject_public_key() const
Definition pk_keys.cpp:48
std::string create_hex_fingerprint(const uint8_t bits[], size_t bits_len, std::string_view hash_name)
Definition pk_keys.cpp:30

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

◆ generate_another()

std::unique_ptr< Private_Key > Botan::Ed25519_PublicKey::generate_another ( RandomNumberGenerator & rng) const
finalvirtual

Generate another (cryptographically independent) key pair using the same algorithm parameters as this key. This is most useful for algorithms that support PublicKeyOperation::KeyAgreement to generate a fitting ephemeral key pair. For other key types it might throw Not_Implemented.

Implements Botan::Asymmetric_Key.

Definition at line 86 of file ed25519_key.cpp.

86 {
87 return std::make_unique<Ed25519_PrivateKey>(rng);
88}

◆ get_int_field()

const BigInt & Botan::Asymmetric_Key::get_int_field ( std::string_view field) const
virtualinherited

Access an algorithm specific field

If the field is not known for this algorithm, an Invalid_Argument is thrown. The interpretation of the result requires knowledge of which algorithm is involved. For instance for RSA "p" represents one of the secret primes, while for DSA "p" is the public prime.

Some algorithms may not implement this method at all.

This is primarily used to implement the FFI botan_pubkey_get_field and botan_privkey_get_field functions.

Reimplemented in Botan::EC_PrivateKey, Botan::DH_PublicKey, Botan::DH_PrivateKey, Botan::DSA_PublicKey, Botan::DSA_PrivateKey, Botan::EC_PublicKey, Botan::ElGamal_PublicKey, Botan::ElGamal_PrivateKey, Botan::RSA_PublicKey, and Botan::RSA_PrivateKey.

Definition at line 18 of file pk_keys.cpp.

18 {
19 throw Unknown_PK_Field_Name(algo_name(), field);
20}

References Botan::Asymmetric_Key::algo_name().

Referenced by Botan::EC_PublicKey::get_int_field(), and Botan::RSA_PublicKey::get_int_field().

◆ get_oid()

OID Botan::Public_Key::get_oid ( ) const
inlineinherited

Deprecated version of object_identifier

Definition at line 132 of file pk_keys.h.

132{ return this->object_identifier(); }

◆ get_public_key()

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

Definition at line 36 of file ed25519.h.

36{ return m_public; }

Referenced by Botan::Ed25519_PrivateKey::public_key().

◆ 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 24 of file ed25519.h.

24{ 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::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::GOST_3410_PublicKey, and Botan::SM2_PublicKey.

Definition at line 188 of file pk_keys.h.

188{ return 0; }

Referenced by Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), 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 177 of file pk_keys.h.

177{ return 1; }

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

◆ object_identifier()

OID Botan::Asymmetric_Key::object_identifier ( ) const
virtualinherited

◆ 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 82 of file ed25519_key.cpp.

82 {
83 return m_public;
84}

References m_public.

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

48 {
49 std::vector<uint8_t> output;
50
51 DER_Encoder(output)
52 .start_sequence()
53 .encode(algorithm_identifier())
55 .end_cons();
56
57 return output;
58}
virtual AlgorithmIdentifier algorithm_identifier() const =0
virtual std::vector< uint8_t > public_key_bits() const =0

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

◆ supports_operation()

bool Botan::Ed25519_PublicKey::supports_operation ( PublicKeyOperation op) const
inlineoverridevirtual

Return true if this key could be used for the specified type of operation.

Implements Botan::Asymmetric_Key.

Definition at line 34 of file ed25519.h.

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: