Botan  1.11.11
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Botan::DH_PrivateKey Class Referenceabstract

#include <dh.h>

Inheritance diagram for Botan::DH_PrivateKey:
Botan::DH_PublicKey Botan::PK_Key_Agreement_Key Botan::DL_Scheme_PrivateKey Botan::DL_Scheme_PublicKey Botan::Private_Key Botan::DL_Scheme_PublicKey Botan::Private_Key Botan::Public_Key Botan::Public_Key Botan::Public_Key Botan::Public_Key

Public Member Functions

std::string algo_name () const
 
AlgorithmIdentifier algorithm_identifier () const
 
bool check_key (RandomNumberGenerator &rng, bool) const
 
bool check_key (RandomNumberGenerator &rng, bool) const
 
 DH_PrivateKey (const AlgorithmIdentifier &alg_id, const secure_vector< byte > &key_bits, RandomNumberGenerator &rng)
 
 DH_PrivateKey (RandomNumberGenerator &rng, const DL_Group &grp, const BigInt &x=0)
 
size_t estimated_strength () const override
 
const DL_Groupget_domain () const
 
virtual OID get_oid () const
 
const BigIntget_x () const
 
const BigIntget_y () const
 
DL_Group::Format group_format () const
 
const BigIntgroup_g () const
 
const BigIntgroup_p () const
 
const BigIntgroup_q () const
 
size_t max_input_bits () const
 
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
 
virtual secure_vector< bytepkcs8_private_key () const =0
 
std::vector< bytepublic_value () const
 
std::vector< bytex509_subject_public_key () const
 

Protected Member Functions

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 Diffie-Hellman private keys.

Definition at line 48 of file dh.h.

Constructor & Destructor Documentation

Botan::DH_PrivateKey::DH_PrivateKey ( const AlgorithmIdentifier alg_id,
const secure_vector< byte > &  key_bits,
RandomNumberGenerator rng 
)

Load a DH private key

Parameters
alg_idthe algorithm id
key_bitsthe subject public key
rnga random number generator

Definition at line 59 of file dh.cpp.

References Botan::DL_Scheme_PublicKey::group_g(), Botan::DL_Scheme_PublicKey::group_p(), Botan::Private_Key::load_check(), Botan::power_mod(), Botan::DL_Scheme_PrivateKey::x, and Botan::DL_Scheme_PublicKey::y.

61  :
63  {
64  if(y == 0)
65  y = power_mod(group_g(), x, group_p());
66 
67  load_check(rng);
68  }
void load_check(RandomNumberGenerator &rng) const
Definition: pk_keys.cpp:40
const BigInt & group_p() const
Definition: dl_algo.h:44
BigInt power_mod(const BigInt &base, const BigInt &exp, const BigInt &mod)
Definition: numthry.cpp:219
const BigInt & group_g() const
Definition: dl_algo.h:56
Botan::DH_PrivateKey::DH_PrivateKey ( RandomNumberGenerator rng,
const DL_Group grp,
const BigInt x = 0 
)

Construct a private key with predetermined value.

Parameters
rngrandom number generator to use
grpthe group to be used in the key
xthe key's secret value (or if zero, generate a new key)

Definition at line 34 of file dh.cpp.

References Botan::BigInt::bits(), Botan::dl_work_factor(), Botan::Private_Key::gen_check(), Botan::DL_Scheme_PublicKey::group, Botan::DL_Scheme_PublicKey::group_g(), Botan::DL_Scheme_PublicKey::group_p(), Botan::Private_Key::load_check(), Botan::power_mod(), Botan::BigInt::randomize(), Botan::DL_Scheme_PrivateKey::x, and Botan::DL_Scheme_PublicKey::y.

37  {
38  group = grp;
39  x = x_arg;
40 
41  if(x == 0)
42  {
43  const BigInt& p = group_p();
44  x.randomize(rng, 2 * dl_work_factor(p.bits()));
45  }
46 
47  if(y == 0)
48  y = power_mod(group_g(), x, group_p());
49 
50  if(x == 0)
51  gen_check(rng);
52  else
53  load_check(rng);
54  }
void load_check(RandomNumberGenerator &rng) const
Definition: pk_keys.cpp:40
const BigInt & group_p() const
Definition: dl_algo.h:44
void randomize(RandomNumberGenerator &rng, size_t bitsize=0)
Definition: big_rand.cpp:16
BigInt power_mod(const BigInt &base, const BigInt &exp, const BigInt &mod)
Definition: numthry.cpp:219
const BigInt & group_g() const
Definition: dl_algo.h:56
size_t dl_work_factor(size_t bits)
Definition: workfactor.cpp:19
void gen_check(RandomNumberGenerator &rng) const
Definition: pk_keys.cpp:49

Member Function Documentation

std::string Botan::DH_PublicKey::algo_name ( ) const
inlinevirtualinherited

Get the name of the underlying public key scheme.

Returns
name of the public key scheme

Implements Botan::Public_Key.

Definition at line 24 of file dh.h.

24 { return "DH"; }
AlgorithmIdentifier Botan::DL_Scheme_PublicKey::algorithm_identifier ( ) const
virtualinherited
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(), Botan::DL_Scheme_PublicKey::group, and Botan::DL_Scheme_PublicKey::group_format().

22  {
23  return AlgorithmIdentifier(get_oid(),
25  }
virtual OID get_oid() const
Definition: pk_keys.cpp:17
std::vector< byte > DER_encode(Format format) const
Definition: dl_group.cpp:202
virtual DL_Group::Format group_format() const =0
bool Botan::DL_Scheme_PublicKey::check_key ( RandomNumberGenerator rng,
bool  strong 
) const
virtualinherited

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

Definition at line 58 of file dl_algo.cpp.

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

60  {
61  if(y < 2 || y >= group_p())
62  return false;
63  if(!group.verify_group(rng, strong))
64  return false;
65  return true;
66  }
const BigInt & group_p() const
Definition: dl_algo.h:44
bool verify_group(RandomNumberGenerator &rng, bool strong) const
Definition: dl_group.cpp:151
bool Botan::DL_Scheme_PrivateKey::check_key ( RandomNumberGenerator rng,
bool  strong 
) const
virtualinherited

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::ElGamal_PrivateKey, and Botan::NR_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(), Botan::DL_Scheme_PrivateKey::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().

73  {
74  const BigInt& p = group_p();
75  const BigInt& g = group_g();
76 
77  if(y < 2 || y >= p || x < 2 || x >= p)
78  return false;
79  if(!group.verify_group(rng, strong))
80  return false;
81 
82  if(!strong)
83  return true;
84 
85  if(y != power_mod(g, x, p))
86  return false;
87 
88  return true;
89  }
const BigInt & group_p() const
Definition: dl_algo.h:44
bool verify_group(RandomNumberGenerator &rng, bool strong) const
Definition: dl_group.cpp:151
BigInt power_mod(const BigInt &base, const BigInt &exp, const BigInt &mod)
Definition: numthry.cpp:219
const BigInt & group_g() const
Definition: dl_algo.h:56
size_t Botan::DL_Scheme_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 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.

17  {
18  return dl_work_factor(group.get_p().bits());
19  }
const BigInt & get_p() const
Definition: dl_group.cpp:173
size_t bits() const
Definition: bigint.cpp:233
size_t dl_work_factor(size_t bits)
Definition: workfactor.cpp:19
void Botan::Private_Key::gen_check ( RandomNumberGenerator rng) const
protectedinherited

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

50  {
51  if(!check_key(rng, BOTAN_PRIVATE_KEY_STRONG_CHECKS_ON_GENERATE))
52  throw Self_Test_Failure(algo_name() + " private key generation failed");
53  }
virtual bool check_key(RandomNumberGenerator &rng, bool strong) const =0
virtual std::string algo_name() const =0
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; }
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.

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

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

18  {
19  try {
20  return OIDS::lookup(algo_name());
21  }
22  catch(Lookup_Error)
23  {
24  throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
25  }
26  }
virtual std::string algo_name() const =0
std::string lookup(const OID &oid)
Definition: oids.cpp:111
const BigInt& Botan::DL_Scheme_PrivateKey::get_x ( ) const
inlineinherited

Get the secret key x.

Returns
secret key

Definition at line 97 of file dl_algo.h.

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

97 { return x; }
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.

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

38 { return y; }
DL_Group::Format Botan::DH_PublicKey::group_format ( ) const
inlinevirtualinherited

Get the underlying groups encoding format.

Returns
encoding format

Implements Botan::DL_Scheme_PublicKey.

Definition at line 29 of file dh.h.

References Botan::DL_Group::ANSI_X9_42.

const BigInt& Botan::DL_Scheme_PublicKey::group_g ( ) const
inlineinherited
const BigInt& Botan::DL_Scheme_PublicKey::group_p ( ) const
inlineinherited
const BigInt& Botan::DL_Scheme_PublicKey::group_q ( ) const
inlineinherited
void Botan::Public_Key::load_check ( RandomNumberGenerator rng) const
protectedvirtualinherited

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

32  {
33  if(!check_key(rng, BOTAN_PUBLIC_KEY_STRONG_CHECKS_ON_LOAD))
34  throw Invalid_Argument(algo_name() + ": Invalid public key");
35  }
virtual bool check_key(RandomNumberGenerator &rng, bool strong) const =0
virtual std::string algo_name() const =0
std::invalid_argument Invalid_Argument
Definition: exceptn.h:20
void Botan::Private_Key::load_check ( RandomNumberGenerator rng) const
protectedvirtualinherited

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

41  {
42  if(!check_key(rng, BOTAN_PRIVATE_KEY_STRONG_CHECKS_ON_LOAD))
43  throw Invalid_Argument(algo_name() + ": Invalid private key");
44  }
virtual bool check_key(RandomNumberGenerator &rng, bool strong) const =0
virtual std::string algo_name() const =0
std::invalid_argument Invalid_Argument
Definition: exceptn.h:20
size_t Botan::DH_PublicKey::max_input_bits ( ) const
inlinevirtualinherited

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

Returns
maximum message size in bits

Implements Botan::Public_Key.

Definition at line 27 of file dh.h.

27 { return group_p().bits(); }
const BigInt & group_p() const
Definition: dl_algo.h:44
size_t bits() const
Definition: bigint.cpp:233
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::GOST_3410_PublicKey, Botan::ECDSA_PublicKey, Botan::NR_PublicKey, and Botan::DSA_PublicKey.

Definition at line 67 of file pk_keys.h.

67 { return 0; }
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::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().

61 { return 1; }
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

Reimplemented in Botan::GOST_3410_PrivateKey.

Definition at line 109 of file pk_keys.h.

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

110  { return algorithm_identifier(); }
virtual AlgorithmIdentifier algorithm_identifier() const =0
secure_vector< byte > Botan::DL_Scheme_PrivateKey::pkcs8_private_key ( ) const
virtualinherited
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 Botan::DL_Scheme_PrivateKey::x.

42  {
43  return DER_Encoder().encode(x).get_contents();
44  }
virtual secure_vector<byte> Botan::Private_Key::pkcs8_private_key ( ) const
pure virtualinherited
Returns
PKCS #8 private key encoding for this key object

Implemented in Botan::McEliece_PrivateKey, Botan::EC_PrivateKey, Botan::DL_Scheme_PrivateKey, and Botan::IF_Scheme_PrivateKey.

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

std::vector< byte > Botan::DH_PrivateKey::public_value ( ) const
virtual

Implements Botan::PK_Key_Agreement_Key.

Definition at line 73 of file dh.cpp.

References Botan::DH_PublicKey::public_value().

Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange().

74  {
76  }
std::vector< byte > public_value() const
Definition: dh.cpp:26
std::vector< 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 27 of file dl_algo.cpp.

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

28  {
29  return DER_Encoder().encode(y).get_contents_unlocked();
30  }

Member Data Documentation

DL_Group Botan::DL_Scheme_PublicKey::group
protectedinherited
BigInt Botan::DL_Scheme_PrivateKey::x
protectedinherited
BigInt Botan::DL_Scheme_PublicKey::y
protectedinherited

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