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

#include <ecdh.h>

Inheritance diagram for Botan::ECDH_PublicKey:
Botan::EC_PublicKey Botan::Public_Key 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
 
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
 
virtual std::unique_ptr< PK_Ops::Verificationcreate_verification_op (const std::string &params, const std::string &provider) const
 
std::vector< byteDER_domain () const
 
const EC_Groupdomain () const
 
EC_Group_Encoding domain_format () const
 
 ECDH_PublicKey (const AlgorithmIdentifier &alg_id, const secure_vector< byte > &key_bits)
 
 ECDH_PublicKey (const EC_Group &dom_par, const PointGFp &public_point)
 
size_t estimated_strength () const override
 
virtual OID get_oid () const
 
size_t key_length () const override
 
virtual size_t message_part_size () const
 
virtual size_t message_parts () const
 
const PointGFppublic_point () const
 
std::vector< bytepublic_value () const
 
std::vector< bytepublic_value (PointGFp::Compression_Type type) const
 
void set_parameter_encoding (EC_Group_Encoding enc)
 
std::vector< bytex509_subject_public_key () const override
 

Protected Member Functions

 ECDH_PublicKey ()
 

Protected Attributes

EC_Group_Encoding m_domain_encoding
 
EC_Group m_domain_params
 
PointGFp m_public_key
 

Detailed Description

This class represents ECDH Public Keys.

Definition at line 20 of file ecdh.h.

Constructor & Destructor Documentation

§ ECDH_PublicKey() [1/3]

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

Create an ECDH public key.

Parameters
alg_idalgorithm identifier
key_bitsDER encoded public key bits

Definition at line 28 of file ecdh.h.

29  :
30  EC_PublicKey(alg_id, key_bits) {}

§ ECDH_PublicKey() [2/3]

Botan::ECDH_PublicKey::ECDH_PublicKey ( const EC_Group dom_par,
const PointGFp public_point 
)
inline

Construct a public key from a given public point.

Parameters
dom_parthe domain parameters associated with this key
public_pointthe public point defining this key

Definition at line 37 of file ecdh.h.

38  :
39  EC_PublicKey(dom_par, public_point) {}
const PointGFp & public_point() const
Definition: ecc_key.h:54

§ ECDH_PublicKey() [3/3]

Botan::ECDH_PublicKey::ECDH_PublicKey ( )
protected

Definition at line 19 of file ecdh.cpp.

19 {}

Member Function Documentation

§ algo_name()

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

Get this keys algorithm name.

Returns
this keys algorithm name

Implements Botan::Public_Key.

Definition at line 45 of file ecdh.h.

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

45 { 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 53 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().

54  {
55  return AlgorithmIdentifier(get_oid(), DER_domain());
56  }
virtual OID get_oid() const
Definition: pk_keys.cpp:20
std::vector< byte > DER_domain() const
Definition: ecc_key.h:81

§ check_key()

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

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::ECDSA_PrivateKey, Botan::ECGDSA_PrivateKey, and Botan::ECKCDSA_PrivateKey.

Definition at line 47 of file ecc_key.cpp.

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

49  {
50  return public_point().on_the_curve();
51  }
const PointGFp & public_point() const
Definition: ecc_key.h:54
bool on_the_curve() const
Definition: point_gfp.cpp:460

§ 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, and Botan::ElGamal_PublicKey.

Definition at line 56 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

59  {
60  throw Lookup_Error(algo_name() + " does not support encryption");
61  }
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 64 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

67  {
68  throw Lookup_Error(algo_name() + " does not support KEM encryption");
69  }
virtual std::string algo_name() const =0

§ create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Public_Key::create_verification_op ( 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 verification operation for this key/params or throw

Parameters
paramsadditional parameters
providerthe provider to use

Reimplemented in Botan::XMSS_WOTS_PublicKey, Botan::XMSS_PublicKey, Botan::RSA_PublicKey, Botan::XMSS_WOTS_Addressed_PublicKey, Botan::GOST_3410_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, and Botan::DSA_PublicKey.

Definition at line 72 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

74  {
75  throw Lookup_Error(algo_name() + " does not support verification");
76  }
virtual std::string algo_name() const =0

§ 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 81 of file ecc_key.h.

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

82  { return domain().DER_encode(domain_format()); }
const EC_Group & domain() const
Definition: ecc_key.h:69
std::vector< byte > DER_encode(EC_Group_Encoding form) const
Definition: ec_group.cpp:91
EC_Group_Encoding domain_format() const
Definition: ecc_key.h:88

§ domain()

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

Get the domain parameters of this key.

Exceptions
Invalid_Stateis thrown if the domain parameters of this point are not set
Returns
the domain parameters of this key

Definition at line 69 of file ecc_key.h.

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

69 { return m_domain_params; }
EC_Group m_domain_params
Definition: ecc_key.h:98

§ 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 88 of file ecc_key.h.

89  { return m_domain_encoding; }
EC_Group_Encoding m_domain_encoding
Definition: ecc_key.h:100

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

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

27  {
28  return ecp_work_factor(key_length());
29  }
size_t ecp_work_factor(size_t bits)
Definition: workfactor.cpp:14
size_t key_length() const override
Definition: ecc_key.cpp:21

§ 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 20 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::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(), and Botan::XMSS_WOTS_Addressed_PublicKey::get_oid().

21  {
22  try {
23  return OIDS::lookup(algo_name());
24  }
25  catch(Lookup_Error&)
26  {
27  throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
28  }
29  }
virtual std::string algo_name() const =0
std::string lookup(const OID &oid)
Definition: oids.cpp:18

§ key_length()

size_t Botan::EC_PublicKey::key_length ( ) const
overridevirtualinherited

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

References Botan::BigInt::bits(), Botan::EC_PublicKey::domain(), Botan::EC_Group::get_curve(), and Botan::CurveGFp::get_p().

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

22  {
23  return domain().get_curve().get_p().bits();
24  }
size_t bits() const
Definition: bigint.cpp:184
const EC_Group & domain() const
Definition: ecc_key.h:69
const CurveGFp & get_curve() const
Definition: ec_group.h:89
const BigInt & get_p() const
Definition: curve_gfp.h:91

§ 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, and Botan::DSA_PublicKey.

Definition at line 106 of file pk_keys.h.

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

106 { 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, and Botan::DSA_PublicKey.

Definition at line 95 of file pk_keys.h.

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

95 { return 1; }

§ public_point()

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

Get the public point of this key.

Exceptions
Invalid_Stateis thrown if the domain parameters of this point are not set
Returns
the public point of this key

Definition at line 54 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().

54 { return m_public_key; }
PointGFp m_public_key
Definition: ecc_key.h:99

§ public_value() [1/2]

std::vector<byte> Botan::ECDH_PublicKey::public_value ( ) const
inline
Returns
public point value

Definition at line 50 of file ecdh.h.

References Botan::EC2OSP(), Botan::PointGFp::UNCOMPRESSED, and Botan::unlock().

Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), and Botan::ECDH_PrivateKey::public_value().

const PointGFp & public_point() const
Definition: ecc_key.h:54
secure_vector< byte > EC2OSP(const PointGFp &point, byte format)
Definition: point_gfp.cpp:516
std::vector< T > unlock(const secure_vector< T > &in)
Definition: secmem.h:117

§ public_value() [2/2]

std::vector<byte> Botan::ECDH_PublicKey::public_value ( PointGFp::Compression_Type  type) const
inline
Returns
public point value

Definition at line 56 of file ecdh.h.

References Botan::EC2OSP(), and Botan::unlock().

57  { return unlock(EC2OSP(public_point(), type)); }
const PointGFp & public_point() const
Definition: ecc_key.h:54
secure_vector< byte > EC2OSP(const PointGFp &point, byte format)
Definition: point_gfp.cpp:516
MechanismType type
std::vector< T > unlock(const secure_vector< T > &in)
Definition: secmem.h:117

§ 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
encthe encoding to use

Definition at line 63 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.

64  {
65  if(form != EC_DOMPAR_ENC_EXPLICIT &&
66  form != EC_DOMPAR_ENC_IMPLICITCA &&
67  form != EC_DOMPAR_ENC_OID)
68  throw Invalid_Argument("Invalid encoding form for EC-key object specified");
69 
70  if((form == EC_DOMPAR_ENC_OID) && (m_domain_params.get_oid() == ""))
71  throw Invalid_Argument("Invalid encoding form OID specified for "
72  "EC-key object whose corresponding domain "
73  "parameters are without oid");
74 
75  m_domain_encoding = form;
76  }
EC_Group m_domain_params
Definition: ecc_key.h:98
std::string get_oid() const
Definition: ec_group.h:115
EC_Group_Encoding m_domain_encoding
Definition: ecc_key.h:100

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

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

59  {
61  }
const PointGFp & public_point() const
Definition: ecc_key.h:54
secure_vector< byte > EC2OSP(const PointGFp &point, byte format)
Definition: point_gfp.cpp:516
std::vector< T > unlock(const secure_vector< T > &in)
Definition: secmem.h:117

Member Data Documentation

§ m_domain_encoding

EC_Group_Encoding Botan::EC_PublicKey::m_domain_encoding
protectedinherited

§ m_domain_params

EC_Group Botan::EC_PublicKey::m_domain_params
protectedinherited

§ m_public_key

PointGFp Botan::EC_PublicKey::m_public_key
protectedinherited

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