#include <dl_algo.h>

Inheritance diagram for Botan::DL_Scheme_PrivateKey:

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 MemoryRegion< byte > &key_bits, DL_Group::Format group_format)
const DL_Group &	get_domain () const
virtual OID	get_oid () const
const BigInt &	get_x () const
const BigInt &	get_y () const
virtual DL_Group::Format	group_format () const =0
const BigInt &	group_g () const
const BigInt &	group_p () const
const BigInt &	group_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
MemoryVector< byte >	pkcs8_private_key () const
MemoryVector< byte >	x509_subject_public_key () const

Protected Member Functions
	DL_Scheme_PrivateKey ()
void	gen_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 85 of file dl_algo.h.

Constructor & Destructor Documentation

◆ DL_Scheme_PrivateKey() [1/2]

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

Definition at line 41 of file dl_algo.cpp.

   {
   DataSource_Memory source(alg_id.parameters);
   group.BER_decode(source, format);
 
   BER_Decoder(key_bits).decode(x);
   }

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

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

◆ DL_Scheme_PrivateKey() [2/2]

Botan::DL_Scheme_PrivateKey::DL_Scheme_PrivateKey ( )

inlineprotected

Definition at line 104 of file dl_algo.h.

104{}

Member Function Documentation

◆ algo_name()

virtual std::string Botan::Public_Key::algo_name ( ) const

pure virtualinherited

Get the name of the underlying public key scheme.

Returns: name of the public key scheme

Implemented in Botan::DH_PublicKey, Botan::DSA_PublicKey, Botan::ECDH_PublicKey, Botan::ECDSA_PublicKey, Botan::ElGamal_PublicKey, Botan::NR_PublicKey, Botan::RSA_PublicKey, and Botan::RW_PublicKey.

References get_oid().

Referenced by Botan::Certificate_Verify::Certificate_Verify(), Botan::EAC_Signed_Object::check_signature(), Botan::X509_Object::check_signature(), Botan::choose_sig_format(), Botan::X509::find_constraints(), Botan::Private_Key::gen_check(), get_oid(), Botan::Private_Key::load_check(), load_check(), Botan::PK_Decryptor_EME::PK_Decryptor_EME(), Botan::PK_Encryptor_EME::PK_Encryptor_EME(), Botan::PK_Key_Agreement::PK_Key_Agreement(), Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), Botan::Server_Hello::Server_Hello(), Botan::Server_Key_Exchange::Server_Key_Exchange(), and Botan::CMS_Encoder::sign().

◆ algorithm_identifier()

AlgorithmIdentifier Botan::DL_Scheme_PublicKey::algorithm_identifier ( ) const

virtualinherited

Returns: X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 15 of file dl_algo.cpp.

   {
   return AlgorithmIdentifier(get_oid(),
                              group.DER_encode(group_format()));
   }

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

◆ check_key()

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

virtual

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::DSA_PrivateKey, Botan::ElGamal_PrivateKey, and Botan::NR_PrivateKey.

Definition at line 67 of file dl_algo.cpp.

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

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::DSA_PrivateKey::check_key(), Botan::ElGamal_PrivateKey::check_key(), and Botan::NR_PrivateKey::check_key().

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

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

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

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

◆ get_domain()

const DL_Group & Botan::DL_Scheme_PublicKey::get_domain ( ) const

inlineinherited

Get the DL domain parameters of this key.

Returns: DL domain parameters of this key

Definition at line 33 of file dl_algo.h.

33{ return group; }

References group.

Referenced by Botan::Server_Key_Exchange::Server_Key_Exchange().

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

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

References algo_name(), Botan::OIDS::lookup(), and Botan::Lookup_Error::Lookup_Error().

Referenced by algo_name(), Botan::DL_Scheme_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), and Botan::IF_Scheme_PublicKey::algorithm_identifier().

◆ get_x()

const BigInt & Botan::DL_Scheme_PrivateKey::get_x ( ) const

inline

Get the secret key x.

Returns: secret key

Definition at line 95 of file dl_algo.h.

95{ return x; }

References x.

Referenced by Botan::ElGamal_Decryption_Operation::ElGamal_Decryption_Operation().

◆ get_y()

const BigInt & Botan::DL_Scheme_PublicKey::get_y ( ) const

inlineinherited

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.

38{ return y; }

References y.

Referenced by Botan::ElGamal_Encryption_Operation::ElGamal_Encryption_Operation().

◆ group_format()

virtual DL_Group::Format Botan::DL_Scheme_PublicKey::group_format ( ) const

pure virtualinherited

Get the underlying groups encoding format.

Returns: encoding format

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

References DL_Scheme_PublicKey(), and group_format().

Referenced by algorithm_identifier(), and group_format().

◆ group_g()

const BigInt & Botan::DL_Scheme_PublicKey::group_g ( ) const

inlineinherited

Get the generator g of the underlying DL group.

Returns: generator g

Definition at line 56 of file dl_algo.h.

56{ return group.get_g(); }

Botan::DL_Group::get_g

const BigInt & get_g() const

Definition dl_group.cpp:185

References group.

Referenced by Botan::DL_Scheme_PrivateKey::check_key(), Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::DSA_Verification_Operation::DSA_Verification_Operation(), Botan::ElGamal_Encryption_Operation::ElGamal_Encryption_Operation(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), Botan::NR_PrivateKey::NR_PrivateKey(), Botan::NR_PrivateKey::NR_PrivateKey(), and Botan::NR_Verification_Operation::NR_Verification_Operation().

◆ group_p()

const BigInt & Botan::DL_Scheme_PublicKey::group_p ( ) const

inlineinherited

Get the prime p of the underlying DL group.

Returns: prime p

Definition at line 44 of file dl_algo.h.

44{ return group.get_p(); }

Botan::DL_Group::get_p

const BigInt & get_p() const

Definition dl_group.cpp:176

References group.

Referenced by Botan::DL_Scheme_PrivateKey::check_key(), check_key(), Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::DSA_Verification_Operation::DSA_Verification_Operation(), Botan::ElGamal_Decryption_Operation::ElGamal_Decryption_Operation(), Botan::ElGamal_Encryption_Operation::ElGamal_Encryption_Operation(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), Botan::DH_PublicKey::max_input_bits(), Botan::ElGamal_PublicKey::max_input_bits(), Botan::NR_PrivateKey::NR_PrivateKey(), Botan::NR_PrivateKey::NR_PrivateKey(), Botan::NR_Verification_Operation::NR_Verification_Operation(), and Botan::DH_PublicKey::public_value().

◆ group_q()

const BigInt & Botan::DL_Scheme_PublicKey::group_q ( ) const

inlineinherited

Get the prime q of the underlying DL group.

Returns: prime q

Definition at line 50 of file dl_algo.h.

50{ return group.get_q(); }

Botan::DL_Group::get_q

const BigInt & get_q() const

Definition dl_group.cpp:194

References group.

Referenced by Botan::DSA_PrivateKey::check_key(), Botan::NR_PrivateKey::check_key(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::DSA_Verification_Operation::DSA_Verification_Operation(), Botan::DSA_PublicKey::max_input_bits(), Botan::NR_PublicKey::max_input_bits(), Botan::DSA_PublicKey::message_part_size(), Botan::NR_PublicKey::message_part_size(), Botan::NR_PrivateKey::NR_PrivateKey(), and Botan::NR_Verification_Operation::NR_Verification_Operation().

◆ load_check()

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

protectedvirtualinherited

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.

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

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

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

◆ max_input_bits()

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

pure virtualinherited

Get the maximum message size in bits supported by this public key.

Returns: maximum message size in bits

Implemented in Botan::DH_PublicKey, Botan::DSA_PublicKey, Botan::ECDH_PublicKey, Botan::ECDSA_PublicKey, Botan::ElGamal_PublicKey, Botan::IF_Scheme_PublicKey, and Botan::NR_PublicKey.

Referenced by Botan::choose_sig_format().

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

Definition at line 56 of file pk_keys.h.

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

Definition at line 50 of file pk_keys.h.

50{ return 1; }

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

◆ 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

Definition at line 98 of file pk_keys.h.

99 { return algorithm_identifier(); }

Botan::Public_Key::algorithm_identifier

virtual AlgorithmIdentifier algorithm_identifier() const =0

References Botan::Public_Key::algorithm_identifier().

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

◆ pkcs8_private_key()

MemoryVector< 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 36 of file dl_algo.cpp.

   {
   return DER_Encoder().encode(x).get_contents();
   }

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

◆ x509_subject_public_key()

MemoryVector< byte > Botan::DL_Scheme_PublicKey::x509_subject_public_key ( ) const

virtualinherited

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

Implements Botan::Public_Key.

Definition at line 21 of file dl_algo.cpp.

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

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

Member Data Documentation

◆ group

DL_Group Botan::DL_Scheme_PublicKey::group

protectedinherited

The DL group

Definition at line 79 of file dl_algo.h.

Referenced by algorithm_identifier(), Botan::DL_Scheme_PrivateKey::check_key(), check_key(), Botan::DH_PrivateKey::DH_PrivateKey(), Botan::DH_PublicKey::DH_PublicKey(), Botan::DL_Scheme_PrivateKey::DL_Scheme_PrivateKey(), DL_Scheme_PublicKey(), Botan::DSA_PrivateKey::DSA_PrivateKey(), Botan::DSA_PublicKey::DSA_PublicKey(), Botan::ElGamal_PrivateKey::ElGamal_PrivateKey(), Botan::ElGamal_PublicKey::ElGamal_PublicKey(), get_domain(), group_g(), group_p(), group_q(), Botan::NR_PrivateKey::NR_PrivateKey(), and Botan::NR_PublicKey::NR_PublicKey().

◆ x

BigInt Botan::DL_Scheme_PrivateKey::x

protected

The DL private key

Definition at line 109 of file dl_algo.h.

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

◆ y

BigInt Botan::DL_Scheme_PublicKey::y

protectedinherited

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

src/pubkey/dl_algo/dl_algo.h
src/pubkey/dl_algo/dl_algo.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DL_Scheme_PrivateKey() [1/2]

◆ DL_Scheme_PrivateKey() [2/2]

Member Function Documentation

◆ algo_name()

◆ algorithm_identifier()

◆ check_key()

◆ gen_check()

◆ get_domain()

◆ get_oid()

◆ get_x()

◆ get_y()

◆ group_format()

◆ group_g()

◆ group_p()

◆ group_q()

◆ load_check()

◆ max_input_bits()

◆ message_part_size()

◆ message_parts()

◆ pkcs8_algorithm_identifier()

◆ pkcs8_private_key()

◆ x509_subject_public_key()

Member Data Documentation

◆ group

◆ x

◆ y