Botan  1.11.15
Public Member Functions | Protected Member Functions | Protected Attributes
Botan::EC_PrivateKey Class Reference

#include <ecc_key.h>

Inheritance diagram for Botan::EC_PrivateKey:
Botan::EC_PublicKey Botan::Private_Key Botan::Public_Key Botan::Public_Key Botan::ECDH_PrivateKey Botan::ECDSA_PrivateKey Botan::GOST_3410_PrivateKey

List of all members.

Public Member Functions

virtual std::string algo_name () const =0
AlgorithmIdentifier algorithm_identifier () const
bool check_key (RandomNumberGenerator &rng, bool strong) const
std::vector< byteDER_domain () const
const EC_Groupdomain () const
EC_Group_Encoding domain_format () const
 EC_PrivateKey (RandomNumberGenerator &rng, const EC_Group &domain, const BigInt &private_key)
 EC_PrivateKey (const AlgorithmIdentifier &alg_id, const secure_vector< byte > &key_bits)
size_t estimated_strength () const override
virtual OID get_oid () const
virtual size_t max_input_bits () const =0
virtual size_t message_part_size () const
virtual size_t message_parts () const
virtual AlgorithmIdentifier pkcs8_algorithm_identifier () const
secure_vector< bytepkcs8_private_key () const
const BigIntprivate_value () const
const PointGFppublic_point () const
void set_parameter_encoding (EC_Group_Encoding enc)
std::vector< bytex509_subject_public_key () const

Protected Member Functions

 EC_PrivateKey ()
void gen_check (RandomNumberGenerator &rng) const
virtual void load_check (RandomNumberGenerator &rng) const
void load_check (RandomNumberGenerator &rng) const

Protected Attributes

EC_Group_Encoding domain_encoding
EC_Group domain_params
BigInt private_key
PointGFp public_key

Detailed Description

This abstract class represents ECC private keys

Definition at line 95 of file ecc_key.h.


Constructor & Destructor Documentation

Botan::EC_PrivateKey::EC_PrivateKey ( RandomNumberGenerator rng,
const EC_Group ec_group,
const BigInt x 
)
Botan::EC_PrivateKey::EC_PrivateKey ( const AlgorithmIdentifier alg_id,
const secure_vector< byte > &  key_bits 
)

Definition at line 115 of file ecc_key.cpp.

References Botan::BIT_STRING, BOTAN_ASSERT, Botan::BER_Decoder::decode_and_check(), Botan::BER_Decoder::decode_optional(), Botan::BER_Decoder::decode_optional_string(), Botan::EC_PublicKey::domain(), Botan::EC_PublicKey::domain_encoding, Botan::EC_PublicKey::domain_params, Botan::EC_DOMPAR_ENC_EXPLICIT, Botan::OID::empty(), Botan::BER_Decoder::end_cons(), Botan::EC_Group::get_base_point(), Botan::AlgorithmIdentifier::oid, Botan::PointGFp::on_the_curve(), Botan::OS2ECP(), Botan::AlgorithmIdentifier::parameters, Botan::PRIVATE, private_key, Botan::EC_PublicKey::public_key, Botan::SEQUENCE, and Botan::BER_Decoder::start_cons().

   {
   domain_params = EC_Group(alg_id.parameters);
   domain_encoding = EC_DOMPAR_ENC_EXPLICIT;

   OID key_parameters;
   secure_vector<byte> public_key_bits;

   BER_Decoder(key_bits)
      .start_cons(SEQUENCE)
         .decode_and_check<size_t>(1, "Unknown version code for ECC key")
         .decode_octet_string_bigint(private_key)
         .decode_optional(key_parameters, ASN1_Tag(0), PRIVATE)
         .decode_optional_string(public_key_bits, BIT_STRING, 1, PRIVATE)
      .end_cons();

   if(!key_parameters.empty() && key_parameters != alg_id.oid)
      throw Decoding_Error("EC_PrivateKey - inner and outer OIDs did not match");

   if(public_key_bits.empty())
      {
      public_key = domain().get_base_point() * private_key;

      BOTAN_ASSERT(public_key.on_the_curve(),
                   "Public point derived from loaded key was on the curve");
      }
   else
      {
      public_key = OS2ECP(public_key_bits, domain().get_curve());
      // OS2ECP verifies that the point is on the curve
      }
   }
Botan::EC_PrivateKey::EC_PrivateKey ( ) [inline, protected]

Definition at line 114 of file ecc_key.h.

{}

Member Function Documentation

virtual std::string Botan::Public_Key::algo_name ( ) const [pure virtual, inherited]
Returns:
X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 50 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());
   }
bool Botan::EC_PublicKey::check_key ( RandomNumberGenerator rng,
bool  strong 
) const [virtual, inherited]

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.

Definition at line 44 of file ecc_key.cpp.

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

   {
   return public_point().on_the_curve();
   }
std::vector<byte> Botan::EC_PublicKey::DER_domain ( ) const [inline, inherited]

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

Definition at line 72 of file ecc_key.h.

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

         { return domain().DER_encode(domain_format()); }
const EC_Group& Botan::EC_PublicKey::domain ( ) const [inline, inherited]

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

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

{ return domain_params; }

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

Returns:
the encoding to use

Definition at line 79 of file ecc_key.h.

         { return domain_encoding; }
size_t Botan::EC_PublicKey::estimated_strength ( ) const [override, virtual, inherited]

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());
   }
void Botan::Private_Key::gen_check ( RandomNumberGenerator rng) const [protected, inherited]

Self-test after generating a key

Parameters:
rnga random number generator

Definition at line 49 of file pk_keys.cpp.

References Botan::Public_Key::algo_name(), and Botan::Public_Key::check_key().

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

   {
   if(!check_key(rng, BOTAN_PRIVATE_KEY_STRONG_CHECKS_ON_GENERATE))
      throw Self_Test_Failure(algo_name() + " private key generation failed");
   }
OID Botan::Public_Key::get_oid ( ) const [virtual, inherited]

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::IF_Scheme_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), and Botan::McEliece_PublicKey::algorithm_identifier().

   {
   try {
      return OIDS::lookup(algo_name());
      }
   catch(Lookup_Error)
      {
      throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
      }
   }
void Botan::Public_Key::load_check ( RandomNumberGenerator rng) const [protected, virtual, inherited]

Self-test after loading a key

Parameters:
rnga random number generator

Reimplemented in Botan::Private_Key.

Definition at line 31 of file pk_keys.cpp.

References Botan::Public_Key::algo_name(), and Botan::Public_Key::check_key().

   {
   if(!check_key(rng, BOTAN_PUBLIC_KEY_STRONG_CHECKS_ON_LOAD))
      throw Invalid_Argument(algo_name() + ": Invalid public key");
   }
void Botan::Private_Key::load_check ( RandomNumberGenerator rng) const [protected, virtual, inherited]

Self-test after loading a key

Parameters:
rnga random number generator

Reimplemented from Botan::Public_Key.

Definition at line 40 of file pk_keys.cpp.

References Botan::Public_Key::algo_name(), and Botan::Public_Key::check_key().

Referenced by Botan::Curve25519_PrivateKey::Curve25519_PrivateKey(), Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), Botan::IF_Scheme_PrivateKey::IF_Scheme_PrivateKey(), and Botan::NR_PrivateKey::NR_PrivateKey().

   {
   if(!check_key(rng, BOTAN_PRIVATE_KEY_STRONG_CHECKS_ON_LOAD))
      throw Invalid_Argument(algo_name() + ": Invalid private key");
   }
virtual size_t Botan::Public_Key::max_input_bits ( ) const [pure virtual, inherited]
virtual size_t Botan::Public_Key::message_part_size ( ) const [inline, virtual, inherited]

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

Definition at line 67 of file pk_keys.h.

{ return 0; }
virtual size_t Botan::Public_Key::message_parts ( ) const [inline, virtual, inherited]

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

Definition at line 61 of file pk_keys.h.

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

{ return 1; }
virtual AlgorithmIdentifier Botan::Private_Key::pkcs8_algorithm_identifier ( ) const [inline, virtual, inherited]
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().

         { return algorithm_identifier(); }
secure_vector< byte > Botan::EC_PrivateKey::pkcs8_private_key ( ) const [virtual]
Returns:
PKCS #8 private key encoding for this key object

Implements Botan::Private_Key.

Definition at line 104 of file ecc_key.cpp.

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

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

Get the private key value of this key object.

Returns:
the private key value of this key object

Definition at line 75 of file ecc_key.cpp.

References private_key.

   {
   if(private_key == 0)
      throw Invalid_State("EC_PrivateKey::private_value - uninitialized");

   return private_key;
   }
const PointGFp& Botan::EC_PublicKey::public_point ( ) const [inline, inherited]

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

Referenced by Botan::EC_PublicKey::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().

{ return public_key; }

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

Parameters:
encthe encoding to use

Definition at line 60 of file ecc_key.cpp.

References Botan::EC_PublicKey::domain_encoding, Botan::EC_PublicKey::domain_params, Botan::EC_DOMPAR_ENC_EXPLICIT, Botan::EC_DOMPAR_ENC_IMPLICITCA, Botan::EC_DOMPAR_ENC_OID, and Botan::EC_Group::get_oid().

Referenced by Botan::DE_EAC::create_cvc_req(), Botan::DE_EAC::link_cvca(), and Botan::DE_EAC::sign_request().

   {
   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) && (domain_params.get_oid() == ""))
      throw Invalid_Argument("Invalid encoding form OID specified for "
                             "EC-key object whose corresponding domain "
                             "parameters are without oid");

   domain_encoding = form;
   }
std::vector< byte > Botan::EC_PublicKey::x509_subject_public_key ( ) const [virtual, inherited]
Returns:
X.509 subject key encoding for this key object

Implements Botan::Public_Key.

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 55 of file ecc_key.cpp.

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


Member Data Documentation

Definition at line 116 of file ecc_key.h.

Referenced by EC_PrivateKey(), pkcs8_private_key(), and private_value().

PointGFp Botan::EC_PublicKey::public_key [protected, inherited]

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