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

#include <dl_algo.h>

Inheritance diagram for Botan::DL_Scheme_PrivateKey:
Botan::DL_Scheme_PublicKey Botan::Private_Key Botan::Public_Key Botan::Public_Key Botan::DH_PrivateKey Botan::DSA_PrivateKey Botan::ElGamal_PrivateKey Botan::NR_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) const
 DL_Scheme_PrivateKey (const AlgorithmIdentifier &alg_id, const secure_vector< byte > &key_bits, DL_Group::Format group_format)
size_t estimated_strength () const override
const DL_Groupget_domain () const
virtual OID get_oid () const
const BigIntget_x () const
const BigIntget_y () const
virtual DL_Group::Format group_format () const =0
const BigIntgroup_g () const
const BigIntgroup_p () const
const BigIntgroup_q () 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
std::vector< bytex509_subject_public_key () const

Protected Member Functions

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

Protected Attributes

DL_Group group
BigInt x
BigInt y

Detailed Description

This class represents discrete logarithm (DL) private keys.

Definition at line 87 of file dl_algo.h.


Constructor & Destructor Documentation

Botan::DL_Scheme_PrivateKey::DL_Scheme_PrivateKey ( const AlgorithmIdentifier alg_id,
const secure_vector< byte > &  key_bits,
DL_Group::Format  group_format 
)

Definition at line 46 of file dl_algo.cpp.

References Botan::DL_Group::BER_decode(), Botan::BER_Decoder::decode(), Botan::DL_Scheme_PublicKey::group, Botan::AlgorithmIdentifier::parameters, and x.

   {
   group.BER_decode(alg_id.parameters, format);

   BER_Decoder(key_bits).decode(x);
   }

Definition at line 106 of file dl_algo.h.

{}

Member Function Documentation

virtual std::string Botan::Public_Key::algo_name ( ) const [pure virtual, inherited]
bool Botan::DL_Scheme_PrivateKey::check_key ( RandomNumberGenerator rng,
bool  strong 
) const [virtual]

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

Reimplemented from Botan::DL_Scheme_PublicKey.

Reimplemented in Botan::DSA_PrivateKey, Botan::NR_PrivateKey, and Botan::ElGamal_PrivateKey.

Definition at line 71 of file dl_algo.cpp.

References Botan::DL_Scheme_PublicKey::group, Botan::DL_Scheme_PublicKey::group_g(), Botan::DL_Scheme_PublicKey::group_p(), Botan::power_mod(), Botan::DL_Group::verify_group(), x, and Botan::DL_Scheme_PublicKey::y.

Referenced by Botan::ElGamal_PrivateKey::check_key(), Botan::NR_PrivateKey::check_key(), and Botan::DSA_PrivateKey::check_key().

   {
   const BigInt& p = group_p();
   const BigInt& g = group_g();

   if(y < 2 || y >= p || x < 2 || x >= p)
      return false;
   if(!group.verify_group(rng, strong))
      return false;

   if(!strong)
      return true;

   if(y != power_mod(g, x, p))
      return false;

   return true;
   }
size_t Botan::DL_Scheme_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 16 of file dl_algo.cpp.

References Botan::BigInt::bits(), Botan::dl_work_factor(), Botan::DL_Group::get_p(), and Botan::DL_Scheme_PublicKey::group.

   {
   return dl_work_factor(group.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");
   }
const DL_Group& Botan::DL_Scheme_PublicKey::get_domain ( ) const [inline, inherited]

Get the DL domain parameters of this key.

Returns:
DL domain parameters of this key

Definition at line 33 of file dl_algo.h.

{ return group; }
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");
      }
   }
const BigInt& Botan::DL_Scheme_PrivateKey::get_x ( ) const [inline]

Get the secret key x.

Returns:
secret key

Definition at line 97 of file dl_algo.h.

References x.

{ return x; }
const BigInt& Botan::DL_Scheme_PublicKey::get_y ( ) const [inline, inherited]

Get the public value y with y = g^x mod p where x is the secret key.

Definition at line 38 of file dl_algo.h.

References y.

{ return y; }
virtual DL_Group::Format Botan::DL_Scheme_PublicKey::group_format ( ) const [pure virtual, inherited]

Get the underlying groups encoding format.

Returns:
encoding format

Implemented in Botan::DH_PublicKey, Botan::DSA_PublicKey, Botan::NR_PublicKey, and Botan::ElGamal_PublicKey.

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

const BigInt& Botan::DL_Scheme_PublicKey::group_g ( ) const [inline, inherited]

Get the generator g of the underlying DL group.

Returns:
generator g

Definition at line 56 of file dl_algo.h.

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

{ return group.get_g(); }
const BigInt& Botan::DL_Scheme_PublicKey::group_p ( ) const [inline, inherited]
const BigInt& Botan::DL_Scheme_PublicKey::group_q ( ) const [inline, inherited]

Get the prime q of the underlying DL group.

Returns:
prime q

Definition at line 50 of file dl_algo.h.

Referenced by Botan::NR_PrivateKey::check_key(), Botan::DSA_PrivateKey::check_key(), Botan::DSA_PrivateKey::DSA_PrivateKey(), and Botan::NR_PrivateKey::NR_PrivateKey().

{ return group.get_q(); }
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::DL_Scheme_PrivateKey::pkcs8_private_key ( ) const [virtual]
Returns:
PKCS #8 private key encoding for this key object

Implements Botan::Private_Key.

Definition at line 41 of file dl_algo.cpp.

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

   {
   return DER_Encoder().encode(x).get_contents();
   }
std::vector< byte > Botan::DL_Scheme_PublicKey::x509_subject_public_key ( ) const [virtual, inherited]
Returns:
X.509 subject key encoding for this key object

Implements Botan::Public_Key.

Definition at line 27 of file dl_algo.cpp.

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::get_contents_unlocked(), and Botan::DL_Scheme_PublicKey::y.

   {
   return DER_Encoder().encode(y).get_contents_unlocked();
   }

Member Data Documentation

BigInt Botan::DL_Scheme_PublicKey::y [protected, inherited]

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