#include <ecdh.h>

Inheritance diagram for Botan::ECDH_PrivateKey:

Public Member Functions
std::string	algo_name () const override

AlgorithmIdentifier	algorithm_identifier () const override

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

std::vector< byte >	DER_domain () const

const EC_Group &	domain () const

EC_Group_Encoding	domain_format () const

	ECDH_PrivateKey (const AlgorithmIdentifier &alg_id, const secure_vector< byte > &key_bits)

	ECDH_PrivateKey (RandomNumberGenerator &rng, const EC_Group &domain, const BigInt &x=0)

size_t	estimated_strength () const override

virtual OID	get_oid () const

size_t	max_input_bits () const override

virtual size_t	message_part_size () const

virtual size_t	message_parts () const

virtual AlgorithmIdentifier	pkcs8_algorithm_identifier () const

secure_vector< byte >	pkcs8_private_key () const override

const BigInt &	private_value () const

const PointGFp &	public_point () const

std::vector< byte >	public_value () const override

void	set_parameter_encoding (EC_Group_Encoding enc)

std::vector< byte >	x509_subject_public_key () const override

Protected Member Functions
void	gen_check (RandomNumberGenerator &rng) const

virtual void	load_check (RandomNumberGenerator &rng) const

void	load_check (RandomNumberGenerator &rng) const override

Protected Attributes
EC_Group_Encoding	m_domain_encoding

EC_Group	m_domain_params

BigInt	m_private_key

PointGFp	m_public_key

Detailed Description

This class represents ECDH Private Keys.

Definition at line 65 of file ecdh.h.

Constructor & Destructor Documentation

§ ECDH_PrivateKey() [1/2]

Botan::ECDH_PrivateKey::ECDH_PrivateKey	(	const AlgorithmIdentifier &	alg_id,
		const secure_vector< byte > &	key_bits
	)

inline

Definition at line 71 of file ecdh.h.

72 :

73 EC_PrivateKey(alg_id, key_bits) {}

Botan::EC_PrivateKey::EC_PrivateKey

EC_PrivateKey()

Definition: ecc_key.h:132

§ ECDH_PrivateKey() [2/2]

Botan::ECDH_PrivateKey::ECDH_PrivateKey	(	RandomNumberGenerator &	rng,
		const EC_Group &	domain,
		const BigInt &	x = `0`
	)

inline

Generate a new private key

Parameters

rng	a random number generator
domain	parameters to used for this key
x	the private key; if zero, a new random key is generated

Definition at line 81 of file ecdh.h.

83 :

84 EC_PrivateKey(rng, domain, x) {}

Botan::EC_PublicKey::domain

const EC_Group & domain() const

Definition: ecc_key.h:59

Botan::EC_PrivateKey::EC_PrivateKey

EC_PrivateKey()

Definition: ecc_key.h:132

Member Function Documentation

§ algo_name()

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

inlineoverridevirtualinherited

Get this keys algorithm name.

Returns: this keys algorithm name

Implements Botan::Public_Key.

Definition at line 41 of file ecdh.h.

41 { return "ECDH"; }

§ algorithm_identifier()

AlgorithmIdentifier Botan::EC_PublicKey::algorithm_identifier ( ) const

overridevirtualinherited

Returns: X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 48 of file ecc_key.cpp.

References Botan::EC_PublicKey::DER_domain(), and Botan::Public_Key::get_oid().

Referenced by Botan::GOST_3410_PrivateKey::pkcs8_algorithm_identifier().

    {
    return AlgorithmIdentifier(get_oid(), DER_domain());
    }

§ check_key()

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

overridevirtualinherited

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.

Reimplemented in Botan::ECDSA_PrivateKey, Botan::ECGDSA_PrivateKey, and Botan::ECKCDSA_PrivateKey.

Definition at line 42 of file ecc_key.cpp.

References Botan::PointGFp::on_the_curve(), and Botan::EC_PublicKey::public_point().

    {
    return public_point().on_the_curve();
    }

§ DER_domain()

std::vector<byte> Botan::EC_PublicKey::DER_domain ( ) const

inlineinherited

Return the DER encoding of this keys domain in whatever format is preset for this particular key

Definition at line 71 of file ecc_key.h.

Referenced by Botan::EC_PublicKey::algorithm_identifier().

72 { return domain().DER_encode(domain_format()); }

Botan::EC_PublicKey::domain

const EC_Group & domain() const

Definition: ecc_key.h:59

Botan::EC_Group::DER_encode

std::vector< byte > DER_encode(EC_Group_Encoding form) const

Definition: ec_group.cpp:91

Botan::EC_PublicKey::domain_format

EC_Group_Encoding domain_format() const

Definition: ecc_key.h:78

§ domain()

const EC_Group& Botan::EC_PublicKey::domain ( ) const

inlineinherited

Get the domain parameters of this key.

Exceptions

Invalid_State is thrown if the domain parameters of this point are not set

Returns: the domain parameters of this key

Definition at line 59 of file ecc_key.h.

Referenced by Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PublicKey::EC_PublicKey(), Botan::EC_PublicKey::estimated_strength(), and Botan::GOST_3410_PublicKey::GOST_3410_PublicKey().

59 { return m_domain_params; }

Botan::EC_PublicKey::m_domain_params

EC_Group m_domain_params

Definition: ecc_key.h:87

§ domain_format()

EC_Group_Encoding Botan::EC_PublicKey::domain_format ( ) const

inlineinherited

Get the domain parameter encoding to be used when encoding this key.

Returns: the encoding to use

Definition at line 78 of file ecc_key.h.

79 { return m_domain_encoding; }

Botan::EC_PublicKey::m_domain_encoding

EC_Group_Encoding m_domain_encoding

Definition: ecc_key.h:89

§ estimated_strength()

size_t Botan::EC_PublicKey::estimated_strength ( ) const

overridevirtualinherited

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 21 of file ecc_key.cpp.

References Botan::EC_PublicKey::domain(), and Botan::ecp_work_factor().

    {
    return ecp_work_factor(domain().get_curve().get_p().bits());
    }

§ gen_check()

void Botan::Private_Key::gen_check ( RandomNumberGenerator & rng ) const

protectedinherited

Self-test after generating a key

Parameters

rng	a random number generator

Definition at line 49 of file pk_keys.cpp.

References Botan::Public_Key::check_key().

Referenced by Botan::RSA_PrivateKey::RSA_PrivateKey().

    {
    if(!check_key(rng, BOTAN_PRIVATE_KEY_STRONG_CHECKS_ON_GENERATE))
       throw Self_Test_Failure("Private key generation failed");
    }

§ 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

Definition at line 17 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(), Botan::RSA_PublicKey::algorithm_identifier(), Botan::McEliece_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), and Botan::TPM_PrivateKey::algorithm_identifier().

    {
    try {
       return OIDS::lookup(algo_name());
       }
    catch(Lookup_Error&)
       {
       throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
       }
    }

§ load_check() [1/2]

void Botan::Public_Key::load_check ( RandomNumberGenerator & rng ) const

protectedvirtualinherited

Self-test after loading a key

Parameters

rng	a random number generator

Reimplemented in Botan::Private_Key.

Definition at line 31 of file pk_keys.cpp.

References Botan::Public_Key::check_key().

Referenced by Botan::Curve25519_PrivateKey::Curve25519_PrivateKey().

    {
    if(!check_key(rng, BOTAN_PUBLIC_KEY_STRONG_CHECKS_ON_LOAD))
       throw Invalid_Argument("Invalid public key");
    }

§ load_check() [2/2]

void Botan::Private_Key::load_check ( RandomNumberGenerator & rng ) const

overrideprotectedvirtualinherited

Self-test after loading a key

Parameters

rng	a random number generator

Reimplemented from Botan::Public_Key.

Definition at line 40 of file pk_keys.cpp.

References Botan::Public_Key::check_key().

Referenced by Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), and Botan::RSA_PrivateKey::RSA_PrivateKey().

    {
    if(!check_key(rng, BOTAN_PRIVATE_KEY_STRONG_CHECKS_ON_LOAD))
       throw Invalid_Argument("Invalid private key");
    }

§ max_input_bits()

size_t Botan::ECDH_PublicKey::max_input_bits ( ) const

inlineoverridevirtualinherited

Get the maximum number of bits allowed to be fed to this key. This is the bitlength of the order of the base point.

Returns: maximum number of input bits

Implements Botan::Public_Key.

Definition at line 49 of file ecdh.h.

50 { return domain().get_order().bits(); }

Botan::BigInt::bits

size_t bits() const

Definition: bigint.cpp:184

Botan::EC_PublicKey::domain

const EC_Group & domain() const

Definition: ecc_key.h:59

Botan::EC_Group::get_order

const BigInt & get_order() const

Definition: ec_group.h:101

§ message_part_size()

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

inlinevirtualinherited

Find out the message part size supported by this scheme/key.

Returns: size of the message parts in bits

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

Definition at line 67 of file pk_keys.h.

67 { return 0; }

§ message_parts()

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

inlinevirtualinherited

Find out the number of message parts supported by this scheme.

Returns: number of message parts

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

Definition at line 61 of file pk_keys.h.

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

61 { return 1; }

§ pkcs8_algorithm_identifier()

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

inlinevirtualinherited

Returns: PKCS #8 AlgorithmIdentifier for this key Might be different from the X.509 identifier, but normally is not

Reimplemented in Botan::GOST_3410_PrivateKey.

Definition at line 109 of file pk_keys.h.

Referenced by Botan::PKCS8::BER_encode().

110 { return algorithm_identifier(); }

Botan::Public_Key::algorithm_identifier

virtual AlgorithmIdentifier algorithm_identifier() const =0

§ pkcs8_private_key()

secure_vector< byte > Botan::EC_PrivateKey::pkcs8_private_key ( ) const

overridevirtualinherited

Returns: PKCS #8 private key encoding for this key object

Implements Botan::Private_Key.

Definition at line 108 of file ecc_key.cpp.

References Botan::DER_Encoder::encode(), Botan::BigInt::encode_1363(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::OCTET_STRING, Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

    {
    return DER_Encoder()
       .start_cons(SEQUENCE)
          .encode(static_cast<size_t>(1))
          .encode(BigInt::encode_1363(m_private_key, m_private_key.bytes()),
                  OCTET_STRING)
       .end_cons()
       .get_contents();
    }

§ private_value()

const BigInt & Botan::EC_PrivateKey::private_value ( ) const

inherited

Get the private key value of this key object.

Returns: the private key value of this key object

Definition at line 73 of file ecc_key.cpp.

    {
    if(m_private_key == 0)
       throw Invalid_State("EC_PrivateKey::private_value - uninitialized");
 
    return m_private_key;
    }

§ public_point()

const PointGFp& Botan::EC_PublicKey::public_point ( ) const

inlineinherited

Get the public point of this key.

Exceptions

Invalid_State is thrown if the domain parameters of this point are not set

Returns: the public point of this key

Definition at line 44 of file ecc_key.h.

Referenced by Botan::EC_PublicKey::check_key(), Botan::ECGDSA_PrivateKey::check_key(), Botan::ECKCDSA_PrivateKey::check_key(), Botan::ECDSA_PrivateKey::check_key(), Botan::EC_PublicKey::EC_PublicKey(), Botan::GOST_3410_PublicKey::x509_subject_public_key(), and Botan::EC_PublicKey::x509_subject_public_key().

44 { return m_public_key; }

Botan::EC_PublicKey::m_public_key

PointGFp m_public_key

Definition: ecc_key.h:88

§ public_value()

std::vector<byte> Botan::ECDH_PrivateKey::public_value ( ) const

inlineoverridevirtual

Implements Botan::PK_Key_Agreement_Key.

Definition at line 86 of file ecdh.h.

References Botan::ECDH_PublicKey::public_value().

Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange().

87 { return ECDH_PublicKey::public_value(); }

Botan::ECDH_PublicKey::public_value

std::vector< byte > public_value() const

Definition: ecdh.h:55

§ set_parameter_encoding()

void Botan::EC_PublicKey::set_parameter_encoding ( EC_Group_Encoding enc )

inherited

Set the domain parameter encoding to be used when encoding this key.

Parameters

enc	the encoding to use

Definition at line 58 of file ecc_key.cpp.

References Botan::EC_DOMPAR_ENC_EXPLICIT, Botan::EC_DOMPAR_ENC_IMPLICITCA, Botan::EC_DOMPAR_ENC_OID, Botan::EC_Group::get_oid(), Botan::EC_PublicKey::m_domain_encoding, and Botan::EC_PublicKey::m_domain_params.

    {
    if(form != EC_DOMPAR_ENC_EXPLICIT &&
       form != EC_DOMPAR_ENC_IMPLICITCA &&
       form != EC_DOMPAR_ENC_OID)
       throw Invalid_Argument("Invalid encoding form for EC-key object specified");
 
    if((form == EC_DOMPAR_ENC_OID) && (m_domain_params.get_oid() == ""))
       throw Invalid_Argument("Invalid encoding form OID specified for "
                              "EC-key object whose corresponding domain "
                              "parameters are without oid");
 
    m_domain_encoding = form;
    }

§ x509_subject_public_key()

std::vector< byte > Botan::EC_PublicKey::x509_subject_public_key ( ) const

overridevirtualinherited

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

Implements Botan::Public_Key.

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 53 of file ecc_key.cpp.

References Botan::PointGFp::COMPRESSED, Botan::EC2OSP(), Botan::EC_PublicKey::public_point(), and Botan::unlock().

    {
    return unlock(EC2OSP(public_point(), PointGFp::COMPRESSED));
    }

Member Data Documentation

§ m_domain_encoding

EC_Group_Encoding Botan::EC_PublicKey::m_domain_encoding

protectedinherited

Definition at line 89 of file ecc_key.h.

Referenced by Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PublicKey::EC_PublicKey(), and Botan::EC_PublicKey::set_parameter_encoding().

§ m_domain_params

EC_Group Botan::EC_PublicKey::m_domain_params

protectedinherited

Definition at line 87 of file ecc_key.h.

Referenced by Botan::EC_PrivateKey::EC_PrivateKey(), Botan::GOST_3410_PublicKey::GOST_3410_PublicKey(), and Botan::EC_PublicKey::set_parameter_encoding().

§ m_private_key

BigInt Botan::EC_PrivateKey::m_private_key

protectedinherited

Definition at line 134 of file ecc_key.h.

§ m_public_key

PointGFp Botan::EC_PublicKey::m_public_key

protectedinherited

Definition at line 88 of file ecc_key.h.

Referenced by Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PublicKey::EC_PublicKey(), and Botan::GOST_3410_PublicKey::GOST_3410_PublicKey().

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

src/lib/pubkey/ecdh/ecdh.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

§ ECDH_PrivateKey() [1/2]

§ ECDH_PrivateKey() [2/2]

Member Function Documentation

§ algo_name()

§ algorithm_identifier()

§ check_key()

§ DER_domain()

§ domain()

§ domain_format()

§ estimated_strength()

§ gen_check()

§ get_oid()

§ load_check() [1/2]

§ load_check() [2/2]

§ max_input_bits()

§ message_part_size()

§ message_parts()

§ pkcs8_algorithm_identifier()

§ pkcs8_private_key()

§ private_value()

§ public_point()

§ public_value()

§ set_parameter_encoding()

§ x509_subject_public_key()

Member Data Documentation

§ m_domain_encoding

§ m_domain_params

§ m_private_key

§ m_public_key