#include <x25519.h>

Inheritance diagram for Botan::X25519_PrivateKey:

Public Member Functions
virtual Signature_Format	_default_x509_signature_format () const
virtual std::optional< size_t >	_signature_element_size_for_DER_encoding () const
secure_vector< uint8_t >	agree (const uint8_t w[], size_t w_len) 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::Decryption >	create_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
virtual std::unique_ptr< PK_Ops::Encryption >	create_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
virtual std::unique_ptr< PK_Ops::KEM_Decryption >	create_kem_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
virtual std::unique_ptr< PK_Ops::KEM_Encryption >	create_kem_encryption_op (std::string_view params, std::string_view provider) const
std::unique_ptr< PK_Ops::Key_Agreement >	create_key_agreement_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override
virtual std::unique_ptr< PK_Ops::Signature >	create_signature_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
virtual std::unique_ptr< PK_Ops::Verification >	create_verification_op (std::string_view params, std::string_view provider) const
virtual std::unique_ptr< PK_Ops::Verification >	create_x509_verification_op (const AlgorithmIdentifier &signature_algorithm, std::string_view provider) const
Signature_Format	default_x509_signature_format () const
size_t	estimated_strength () const override
std::string	fingerprint_private (std::string_view alg) const
std::string	fingerprint_public (std::string_view alg="SHA-256") const
std::unique_ptr< Private_Key >	generate_another (RandomNumberGenerator &rng) const final
virtual const BigInt &	get_int_field (std::string_view field) const
OID	get_oid () const
const secure_vector< uint8_t > &	get_x () const
size_t	key_length () const override
size_t	message_part_size () const
size_t	message_parts () const
virtual OID	object_identifier () const
virtual AlgorithmIdentifier	pkcs8_algorithm_identifier () const
secure_vector< uint8_t >	private_key_bits () const override
secure_vector< uint8_t >	private_key_info () const
std::unique_ptr< Public_Key >	public_key () const override
std::vector< uint8_t >	public_key_bits () const override
std::vector< uint8_t >	public_value () const override
secure_vector< uint8_t >	raw_private_key_bits () const override
std::vector< uint8_t >	raw_public_key_bits () const override
virtual std::optional< uint64_t >	remaining_operations () const
	Retrieves the number of remaining operations if this is a stateful private key.
virtual bool	stateful_operation () const
std::vector< uint8_t >	subject_public_key () const
bool	supports_operation (PublicKeyOperation op) const override
	X25519_PrivateKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits)
	X25519_PrivateKey (RandomNumberGenerator &rng)
	X25519_PrivateKey (std::span< const uint8_t > secret_key)

Protected Attributes
std::shared_ptr< const X25519_PublicKey_Data >	m_public

Detailed Description

Definition at line 64 of file x25519.h.

Constructor & Destructor Documentation

◆ X25519_PrivateKey() [1/3]

Botan::X25519_PrivateKey::X25519_PrivateKey	(	const AlgorithmIdentifier &	alg_id,
		std::span< const uint8_t >	key_bits )

Construct a private key from the specified parameters.

Parameters

alg_id	the X.509 algorithm identifier
key_bits	PKCS #8 structure

Definition at line 125 of file x25519.cpp.

                                                                                                       {
   // RFC 8410 Section 3: "the parameters MUST be absent".
   if(!alg_id.parameters_are_empty()) {
      throw Decoding_Error("Unexpected parameters for X25519 private key");
   }
 
   secure_vector<uint8_t> secret_key;
   BER_Decoder(key_bits, BER_Decoder::Limits::DER()).decode(secret_key, ASN1_Type::OctetString).discard_remaining();
 
   size_check(secret_key.size(), "private key");
   load_x25519_keypair(std::move(secret_key), m_public, m_private);
}

References Botan::BER_Decoder::decode(), Botan::BER_Decoder::Limits::DER(), Botan::BER_Decoder::discard_remaining(), Botan::X25519_PublicKey::m_public, Botan::OctetString, and Botan::AlgorithmIdentifier::parameters_are_empty().

◆ X25519_PrivateKey() [2/3]

Botan::X25519_PrivateKey::X25519_PrivateKey ( RandomNumberGenerator & rng )

explicit

Generate a private key.

Parameters

Random Number Generators the RNG to use

Definition at line 121 of file x25519.cpp.

                                                               {
   load_x25519_keypair(rng.random_vec(32), m_public, m_private);
}

References Botan::X25519_PublicKey::m_public, and Botan::RandomNumberGenerator::random_vec().

◆ X25519_PrivateKey() [3/3]

Botan::X25519_PrivateKey::X25519_PrivateKey ( std::span< const uint8_t > secret_key )

explicit

Construct a private key from the specified parameters.

Parameters

secret_key the private key

Definition at line 113 of file x25519.cpp.

                                                                      {
   if(secret_key.size() != 32) {
      throw Decoding_Error("Invalid size for X25519 private key");
   }
 
   load_x25519_keypair(secure_vector<uint8_t>(secret_key.begin(), secret_key.end()), m_public, m_private);
}

References Botan::X25519_PublicKey::m_public.

Member Function Documentation

◆ _default_x509_signature_format()

Signature_Format Botan::Asymmetric_Key::_default_x509_signature_format ( ) const

virtualinherited

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 30 of file pk_keys.cpp.

                                                                      {
   if(_signature_element_size_for_DER_encoding()) {
      return Signature_Format::DerSequence;
   } else {
      return Signature_Format::Standard;
   }
}

References _signature_element_size_for_DER_encoding(), Botan::DerSequence, and Botan::Standard.

Referenced by Botan::X509_Object::choose_sig_format(), Botan::Public_Key::default_x509_signature_format(), and Botan::PK_Verifier::PK_Verifier().

◆ _signature_element_size_for_DER_encoding()

virtual std::optional< size_t > Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding ( ) const

inlinevirtualinherited

Certain signatures schemes such as ECDSA have more than one element, and certain unfortunate protocols decided the thing to do was not concatenate them as normally done, but instead DER encode each of the elements as independent values.

If this returns a value x then the signature is checked to be exactly 2*x bytes and split in half for DER encoding.

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 144 of file pk_keys.h.

144{ return {}; }

Referenced by _default_x509_signature_format(), Botan::Public_Key::message_part_size(), Botan::Public_Key::message_parts(), Botan::PK_Verifier::PK_Verifier(), and Botan::PK_Verifier::PK_Verifier().

◆ agree()

secure_vector< uint8_t > Botan::X25519_PrivateKey::agree	(	const uint8_t	w[],
		size_t	w_len ) const

Definition at line 152 of file x25519.cpp.

                                                                                     {
   size_check(w_len, "public value");
   return curve25519(m_private->key(), w);
}

◆ algo_name()

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

inlineoverridevirtualinherited

Get the name of the underlying public key scheme.

Returns: name of the public key scheme

Implements Botan::Asymmetric_Key.

Definition at line 21 of file x25519.h.

21{ return "X25519"; }

Referenced by Botan::X25519_PrivateKey::create_key_agreement_op().

◆ algorithm_identifier()

AlgorithmIdentifier Botan::X25519_PublicKey::algorithm_identifier ( ) const

overridevirtualinherited

Return the X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 80 of file x25519.cpp.

                                                                 {
   return AlgorithmIdentifier(object_identifier(), AlgorithmIdentifier::USE_EMPTY_PARAM);
}

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

◆ check_key()

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

overridevirtual

Test the key values for consistency.

Note this function is always "best effort"; for many algorithms it is not computationally possible to ensure the key is correctly formed in all respects. There is always the possibility a malformed key will be accepted; this is especially the case for public keys.

Parameters

Random Number Generators	rng to use for randomized testing (may be ignored)
strong	whether to perform strong and lengthy version of the test, however for many algorithms this has no effect

Returns: true if the tests passed

Implements Botan::Asymmetric_Key.

Definition at line 146 of file x25519.cpp.

                                                                        {
   std::vector<uint8_t> public_point(32);
   curve25519_basepoint(public_point.data(), m_private->key().data());
   return public_point == m_public->key();
}

References Botan::curve25519_basepoint(), and Botan::X25519_PublicKey::m_public.

◆ create_decryption_op()

std::unique_ptr< PK_Ops::Decryption > Botan::Private_Key::create_decryption_op	(	RandomNumberGenerator &	rng,
		std::string_view	params,
		std::string_view	provider ) const

virtualinherited

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

Return an decryption operation for this key/params or throw

Parameters

Random Number Generators	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_PrivateKey, Botan::RSA_PrivateKey, Botan::SM2_PrivateKey, and Botan::TPM2::RSA_PrivateKey.

Definition at line 126 of file pk_keys.cpp.

                                                                                              {
   throw Lookup_Error(fmt("{} does not support decryption", algo_name()));
}

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

Referenced by Botan::PK_Decryptor_EME::PK_Decryptor_EME().

◆ 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

Random Number Generators	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, Botan::SM2_PublicKey, and Botan::TPM2::RSA_PublicKey.

Definition at line 105 of file pk_keys.cpp.

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

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

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

◆ create_kem_decryption_op()

std::unique_ptr< PK_Ops::KEM_Decryption > Botan::Private_Key::create_kem_decryption_op	(	RandomNumberGenerator &	rng,
		std::string_view	params,
		std::string_view	provider ) const

virtualinherited

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

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

Parameters

Random Number Generators	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::Classic_McEliece_PrivateKey, Botan::FrodoKEM_PrivateKey, Botan::KEX_to_KEM_Adapter_PrivateKey, Botan::Kyber_PrivateKey, Botan::McEliece_PrivateKey, Botan::RSA_PrivateKey, and Botan::TLS::Hybrid_KEM_PrivateKey.

Definition at line 132 of file pk_keys.cpp.

                                                                                                      {
   throw Lookup_Error(fmt("{} does not support KEM decryption", algo_name()));
}

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

Referenced by Botan::PK_KEM_Decryptor::PK_KEM_Decryptor().

◆ 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

params	additional parameters
provider	the provider to use

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

Definition at line 111 of file pk_keys.cpp.

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

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

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

◆ create_key_agreement_op()

std::unique_ptr< PK_Ops::Key_Agreement > Botan::X25519_PrivateKey::create_key_agreement_op	(	RandomNumberGenerator &	rng,
		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 key agreement operation for this key/params or throw

Parameters

Random Number Generators	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 from Botan::Private_Key.

Definition at line 195 of file x25519.cpp.

                                                                                                                 {
   if(provider == "base" || provider.empty()) {
      return std::make_unique<X25519_KA_Operation>(m_private, params);
   }
   throw Provider_Not_Found(algo_name(), provider);
}

References Botan::X25519_PublicKey::algo_name().

◆ create_signature_op()

std::unique_ptr< PK_Ops::Signature > Botan::Private_Key::create_signature_op	(	RandomNumberGenerator &	rng,
		std::string_view	params,
		std::string_view	provider ) const

virtualinherited

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

Return a signature operation for this key/params or throw

Parameters

Random Number Generators	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::Dilithium_PrivateKey, Botan::DSA_PrivateKey, Botan::ECDSA_PrivateKey, Botan::ECGDSA_PrivateKey, Botan::ECKCDSA_PrivateKey, Botan::Ed25519_PrivateKey, Botan::Ed448_PrivateKey, Botan::GOST_3410_PrivateKey, Botan::HSS_LMS_PrivateKey, Botan::RSA_PrivateKey, Botan::SM2_PrivateKey, Botan::SphincsPlus_PrivateKey, Botan::TPM2::EC_PrivateKey, Botan::TPM2::RSA_PrivateKey, Botan::TPM_PrivateKey, and Botan::XMSS_PrivateKey.

Definition at line 138 of file pk_keys.cpp.

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

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

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

◆ create_verification_op()

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

virtualinherited

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

params	additional parameters
provider	the provider to use

Reimplemented in Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::Ed448_PublicKey, Botan::GOST_3410_PublicKey, Botan::HSS_LMS_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, Botan::SphincsPlus_PublicKey, Botan::TPM2::EC_PublicKey, Botan::TPM2::RSA_PublicKey, and Botan::XMSS_PublicKey.

Definition at line 116 of file pk_keys.cpp.

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

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

Referenced by Botan::PK_Verifier::PK_Verifier().

◆ create_x509_verification_op()

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

virtualinherited

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_algorithm	is the X.509 algorithm identifier encoding the padding scheme and hash hash function used in the signature if applicable.
provider	the provider to use

Reimplemented in Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::Ed448_PublicKey, Botan::GOST_3410_PublicKey, Botan::HSS_LMS_PublicKey, Botan::RSA_PublicKey, Botan::SphincsPlus_PublicKey, and Botan::XMSS_PublicKey.

Definition at line 121 of file pk_keys.cpp.

                                                                                                      {
   throw Lookup_Error(fmt("{} does not support X.509 verification", algo_name()));
}

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

Referenced by Botan::PK_Verifier::PK_Verifier().

◆ default_x509_signature_format()

Signature_Format Botan::Public_Key::default_x509_signature_format ( ) const

inlineinherited

Definition at line 241 of file pk_keys.h.

                                                                                                           {
         return _default_x509_signature_format();
      }

References Botan::Asymmetric_Key::_default_x509_signature_format(), and default_x509_signature_format().

Referenced by default_x509_signature_format().

◆ estimated_strength()

size_t Botan::X25519_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::Asymmetric_Key.

Definition at line 23 of file x25519.h.

23{ return 128; }

◆ fingerprint_private()

std::string Botan::Private_Key::fingerprint_private ( std::string_view alg ) const

inherited

Returns: Hash of the PKCS #8 encoding for this key object

Definition at line 101 of file pk_keys.cpp.

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

References Botan::create_hex_fingerprint(), and 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().

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

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

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

Referenced by public_key_bits().

◆ generate_another()

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

finalvirtualinherited

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 109 of file x25519.cpp.

                                                                                              {
   return std::make_unique<X25519_PrivateKey>(rng);
}

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

TODO(Botan4) Change this to return by value

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

Definition at line 18 of file pk_keys.cpp.

                                                                      {
   throw Unknown_PK_Field_Name(algo_name(), field);
}

References algo_name().

Referenced by estimated_strength(), 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 168 of file pk_keys.h.

168{ return this->object_identifier(); }

References get_oid(), and Botan::Asymmetric_Key::object_identifier().

Referenced by get_oid().

◆ get_x()

const secure_vector< uint8_t > & Botan::X25519_PrivateKey::get_x ( ) const

Definition at line 39 of file x25519.cpp.

                                                             {
   return m_private->key();
}

◆ key_length()

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

25{ return 255; }

◆ message_part_size()

size_t Botan::Public_Key::message_part_size ( ) const

inlineinherited

Returns how large each of the message parts referred 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

Definition at line 232 of file pk_keys.h.

                                                                                     {
         return _signature_element_size_for_DER_encoding().value_or(0);
      }

References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_part_size().

Referenced by message_part_size().

◆ message_parts()

size_t Botan::Public_Key::message_parts ( ) const

inlineinherited

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

Definition at line 219 of file pk_keys.h.

                                                                                 {
         return _signature_element_size_for_DER_encoding() ? 2 : 1;
      }

References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_parts().

Referenced by message_parts().

◆ object_identifier()

OID Botan::Asymmetric_Key::object_identifier ( ) const

virtualinherited

Get the OID of the underlying public key scheme.

Returns: OID of the public key scheme

Reimplemented in Botan::Classic_McEliece_PublicKey, Botan::Dilithium_PublicKey, Botan::FrodoKEM_PublicKey, Botan::HSS_LMS_PublicKey, Botan::Kyber_PublicKey, and Botan::SphincsPlus_PublicKey.

Definition at line 22 of file pk_keys.cpp.

                                            {
   try {
      return OID::from_string(algo_name());
   } catch(Lookup_Error&) {
      throw Lookup_Error(fmt("Public key algorithm {} has no defined OIDs", algo_name()));
   }
}

References algo_name(), Botan::fmt(), and Botan::OID::from_string().

◆ pkcs8_algorithm_identifier()

virtual AlgorithmIdentifier Botan::Private_Key::pkcs8_algorithm_identifier ( ) const

inlinevirtualinherited

Return the PKCS #8 AlgorithmIdentifier for this key

Note: normally this is the same as the public key identifier, but a few oddball algorithms use a different value

Reimplemented in Botan::GOST_3410_PrivateKey, and Botan::HSS_LMS_PrivateKey.

Definition at line 343 of file pk_keys.h.

343{ return algorithm_identifier(); }

Botan::Public_Key::algorithm_identifier

virtual AlgorithmIdentifier algorithm_identifier() const =0

References Botan::Public_Key::algorithm_identifier().

Referenced by private_key_info().

◆ private_key_bits()

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

overridevirtual

Return the PKCS8 private key encoding

Note: this encoding omits the outer PKCS8 algorithm identifiers and will not be portably decodable on its own. Prefer private_key_info.

Implements Botan::Private_Key.

Definition at line 142 of file x25519.cpp.

                                                                 {
   return DER_Encoder().encode(m_private->key(), ASN1_Type::OctetString).get_contents();
}

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::get_contents(), and Botan::OctetString.

◆ private_key_info()

secure_vector< uint8_t > Botan::Private_Key::private_key_info ( ) const

inherited

Return PKCS #8 private key encoding for this key object

Definition at line 75 of file pk_keys.cpp.

                                                           {
   const size_t PKCS8_VERSION = 0;
 
   return DER_Encoder()
      .start_sequence()
      .encode(PKCS8_VERSION)
      .encode(pkcs8_algorithm_identifier())
      .encode(private_key_bits(), ASN1_Type::OctetString)
      .end_cons()
      .get_contents();
}

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::OctetString, pkcs8_algorithm_identifier(), private_key_bits(), and Botan::DER_Encoder::start_sequence().

Referenced by Botan::PKCS8::BER_encode(), Botan::PKCS8::BER_encode_encrypted_pbkdf_iter(), Botan::PKCS8::BER_encode_encrypted_pbkdf_msec(), Botan::PKCS8::PEM_encode(), and public_key().

◆ public_key()

std::unique_ptr< Public_Key > Botan::X25519_PrivateKey::public_key ( ) const

overridevirtual

Allocate a new object for the public key associated with this private key.

Returns: public key

Implements Botan::Private_Key.

Definition at line 138 of file x25519.cpp.

                                                              {
   return std::make_unique<X25519_PublicKey>(public_value());
}

References public_value().

◆ public_key_bits()

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

overridevirtualinherited

Return the subject public key encoding of this public key

Note: this excludes the parameters field and may not be reliably decodable

Implements Botan::Public_Key.

Definition at line 105 of file x25519.cpp.

                                                           {
   return raw_public_key_bits();
}

References raw_public_key_bits().

◆ public_value()

std::vector< uint8_t > Botan::X25519_PrivateKey::public_value ( ) const

inlineoverridevirtual

Return the public value used to effect key exchange

Implements Botan::PK_Key_Agreement_Key.

Definition at line 87 of file x25519.h.

87{ return raw_public_key_bits(); }

References Botan::X25519_PublicKey::raw_public_key_bits().

Referenced by public_key().

◆ raw_private_key_bits()

secure_vector< uint8_t > Botan::X25519_PrivateKey::raw_private_key_bits ( ) const

overridevirtual

Return the binary private key bits, with no additional encoding

Note: some algorithms (for example RSA) do not have an obvious encoding for this value due to having many different values, and thus not implement this function. The default implementation throws Not_Implemented

Reimplemented from Botan::Private_Key.

Definition at line 43 of file x25519.cpp.

                                                                     {
   return m_private->key();
}

◆ raw_public_key_bits()

std::vector< uint8_t > Botan::X25519_PublicKey::raw_public_key_bits ( ) const

overridevirtualinherited

Return the raw public key bits (algorithm specific) with no extra encoding

For key agreements this is an alias for PK_Key_Agreement_Key::public_value.

Note: some algorithms (for example RSA) do not have an obvious encoding for this value due to having many different values, and thus throw Not_Implemented when invoking this method.

Implements Botan::Public_Key.

Definition at line 101 of file x25519.cpp.

                                                               {
   return m_public->key();
}

References m_public.

Referenced by public_key_bits(), Botan::X25519_PrivateKey::public_value(), and public_value().

◆ remaining_operations()

virtual std::optional< uint64_t > Botan::Private_Key::remaining_operations ( ) const

inlinevirtualinherited

Retrieves the number of remaining operations if this is a stateful private key.

Returns: the number of remaining operations or std::nullopt if not applicable.

Reimplemented in Botan::HSS_LMS_PrivateKey, and Botan::XMSS_PrivateKey.

Definition at line 356 of file pk_keys.h.

356{ return std::nullopt; }

◆ stateful_operation()

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

inlinevirtualinherited

Indicates if this key is stateful, ie that performing a private key operation requires updating the key storage.

Reimplemented in Botan::HSS_LMS_PrivateKey, and Botan::XMSS_PrivateKey.

Definition at line 349 of file pk_keys.h.

349{ return false; }

◆ subject_public_key()

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

inherited

Return the SubjectPublicKeyInfo encoding of this public key

This is the subjectPublicKey field plus the algorithm-specific parameters

Definition at line 63 of file pk_keys.cpp.

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

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

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

◆ supports_operation()

bool Botan::X25519_PublicKey::supports_operation ( PublicKeyOperation op ) const

inlineoverridevirtualinherited

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

Implements Botan::Asymmetric_Key.

Definition at line 39 of file x25519.h.

39{ return (op == PublicKeyOperation::KeyAgreement); }

Botan::PublicKeyOperation::KeyAgreement

@ KeyAgreement

Definition pk_keys.h:50

References Botan::KeyAgreement.

Member Data Documentation

◆ m_public

std::shared_ptr<const X25519_PublicKey_Data> Botan::X25519_PublicKey::m_public

protectedinherited

Definition at line 58 of file x25519.h.

Referenced by Botan::X25519_PrivateKey::check_key(), raw_public_key_bits(), Botan::X25519_PrivateKey::X25519_PrivateKey(), Botan::X25519_PrivateKey::X25519_PrivateKey(), Botan::X25519_PrivateKey::X25519_PrivateKey(), and X25519_PublicKey().

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

src/lib/pubkey/x25519/x25519.h
src/lib/pubkey/x25519/x25519.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ X25519_PrivateKey() [1/3]

◆ X25519_PrivateKey() [2/3]

◆ X25519_PrivateKey() [3/3]

Member Function Documentation

◆ _default_x509_signature_format()

◆ _signature_element_size_for_DER_encoding()

◆ agree()

◆ algo_name()

◆ algorithm_identifier()

◆ check_key()

◆ create_decryption_op()

◆ create_encryption_op()

◆ create_kem_decryption_op()

◆ create_kem_encryption_op()

◆ create_key_agreement_op()

◆ create_signature_op()

◆ create_verification_op()

◆ create_x509_verification_op()

◆ default_x509_signature_format()

◆ estimated_strength()

◆ fingerprint_private()

◆ fingerprint_public()

◆ generate_another()

◆ get_int_field()

◆ get_oid()

◆ get_x()

◆ key_length()

◆ message_part_size()

◆ message_parts()

◆ object_identifier()

◆ pkcs8_algorithm_identifier()

◆ private_key_bits()

◆ private_key_info()

◆ public_key()

◆ public_key_bits()

◆ public_value()

◆ raw_private_key_bits()

◆ raw_public_key_bits()

◆ remaining_operations()

◆ stateful_operation()

◆ subject_public_key()

◆ supports_operation()

Member Data Documentation

◆ m_public