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

#include <dl_algo.h>

Inheritance diagram for Botan::DL_Scheme_PublicKey:
Botan::Public_Key Botan::DH_PublicKey Botan::DL_Scheme_PrivateKey Botan::DSA_PublicKey Botan::ElGamal_PublicKey Botan::NR_PublicKey Botan::DH_PrivateKey Botan::DH_PrivateKey Botan::DSA_PrivateKey Botan::ElGamal_PrivateKey Botan::NR_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_PublicKey (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_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
std::vector< bytex509_subject_public_key () const

Protected Member Functions

 DL_Scheme_PublicKey ()
virtual void load_check (RandomNumberGenerator &rng) const

Protected Attributes

DL_Group group
BigInt y

Detailed Description

This class represents discrete logarithm (DL) public keys.

Definition at line 20 of file dl_algo.h.


Constructor & Destructor Documentation

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

Definition at line 32 of file dl_algo.cpp.

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

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

   BER_Decoder(key_bits).decode(y);
   }

Definition at line 71 of file dl_algo.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.

Definition at line 21 of file dl_algo.cpp.

References Botan::DL_Group::DER_encode(), Botan::Public_Key::get_oid(), group, and group_format().

   {
   return AlgorithmIdentifier(get_oid(),
                              group.DER_encode(group_format()));
   }
bool Botan::DL_Scheme_PublicKey::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

Implements Botan::Public_Key.

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

Definition at line 58 of file dl_algo.cpp.

References group, group_p(), and Botan::DL_Group::verify_group().

   {
   if(y < 2 || y >= group_p())
      return false;
   if(!group.verify_group(rng, strong))
      return false;
   return true;
   }
size_t Botan::DL_Scheme_PublicKey::estimated_strength ( ) const [override, virtual]

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

   {
   return dl_work_factor(group.get_p().bits());
   }

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 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_PublicKey::get_y ( ) const [inline]

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; }

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 algorithm_identifier().

const BigInt& Botan::DL_Scheme_PublicKey::group_g ( ) const [inline]
const BigInt& Botan::DL_Scheme_PublicKey::group_p ( ) const [inline]
const BigInt& Botan::DL_Scheme_PublicKey::group_q ( ) const [inline]

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");
   }
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; }
std::vector< byte > Botan::DL_Scheme_PublicKey::x509_subject_public_key ( ) const [virtual]
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 y.

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

Member Data Documentation


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