Botan  2.6.0
Crypto and TLS for C++11
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Botan::DL_Scheme_PublicKey Class Referenceabstract

#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::DH_PrivateKey Botan::DH_PrivateKey Botan::DSA_PrivateKey Botan::ElGamal_PrivateKey Botan::DSA_PrivateKey Botan::ElGamal_PrivateKey

Public Member Functions

virtual std::string algo_name () const =0
 
AlgorithmIdentifier algorithm_identifier () const override
 
bool check_key (RandomNumberGenerator &rng, bool) const override
 
virtual std::unique_ptr< PK_Ops::Encryptioncreate_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
 
virtual std::unique_ptr< PK_Ops::KEM_Encryptioncreate_kem_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
 
virtual std::unique_ptr< PK_Ops::Verificationcreate_verification_op (const std::string &params, const std::string &provider) const
 
size_t estimated_strength () const override
 
std::string fingerprint_public (const std::string &alg="SHA-256") const
 
const DL_Groupget_domain () const
 
const DL_Groupget_group () 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
 
size_t key_length () const override
 
virtual size_t message_part_size () const
 
virtual size_t message_parts () const
 
DL_Scheme_PublicKeyoperator= (const DL_Scheme_PublicKey &other)=default
 
std::vector< uint8_t > public_key_bits () const override
 
std::vector< uint8_t > subject_public_key () const
 

Protected Member Functions

 DL_Scheme_PublicKey ()=default
 
 DL_Scheme_PublicKey (const AlgorithmIdentifier &alg_id, const std::vector< uint8_t > &key_bits, DL_Group::Format group_format)
 
 DL_Scheme_PublicKey (const DL_Group &group, const BigInt &y)
 

Protected Attributes

DL_Group m_group
 
BigInt m_y
 

Detailed Description

This class represents discrete logarithm (DL) public keys.

Definition at line 19 of file dl_algo.h.

Constructor & Destructor Documentation

◆ DL_Scheme_PublicKey() [1/3]

Botan::DL_Scheme_PublicKey::DL_Scheme_PublicKey ( )
protecteddefault

◆ DL_Scheme_PublicKey() [2/3]

Botan::DL_Scheme_PublicKey::DL_Scheme_PublicKey ( const AlgorithmIdentifier alg_id,
const std::vector< uint8_t > &  key_bits,
DL_Group::Format  group_format 
)
protected

Create a public key.

Parameters
alg_idthe X.509 algorithm identifier
key_bitsDER encoded public key bits
group_formatthe underlying groups encoding format

Definition at line 42 of file dl_algo.cpp.

44  :
45  m_group(alg_id.get_parameters(), format)
46  {
47  BER_Decoder(key_bits).decode(m_y);
48  }

◆ DL_Scheme_PublicKey() [3/3]

Botan::DL_Scheme_PublicKey::DL_Scheme_PublicKey ( const DL_Group group,
const BigInt y 
)
protected

Definition at line 36 of file dl_algo.cpp.

36  :
37  m_y(y),
38  m_group(group)
39  {
40  }

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::XMSS_WOTS_PublicKey, Botan::XMSS_PublicKey, Botan::TPM_PrivateKey, Botan::XMSS_WOTS_Addressed_PublicKey, Botan::ECDSA_PublicKey, Botan::ECDH_PublicKey, Botan::GOST_3410_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::SM2_Signature_PublicKey, Botan::SM2_Encryption_PublicKey, Botan::RSA_PublicKey, Botan::McEliece_PublicKey, Botan::DH_PublicKey, Botan::DSA_PublicKey, Botan::Ed25519_PublicKey, Botan::ElGamal_PublicKey, and Botan::Curve25519_PublicKey.

Referenced by Botan::PKCS8::BER_encode(), botan_pubkey_sm2_compute_za(), Botan::TLS::Policy::check_peer_key_acceptable(), Botan::TLS::Handshake_State::choose_sig_format(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::EMSA1::config_for_x509(), Botan::PSSR::config_for_x509(), Botan::EMSA_PKCS1v15::config_for_x509(), Botan::Private_Key::create_decryption_op(), Botan::Public_Key::create_encryption_op(), Botan::Private_Key::create_kem_decryption_op(), Botan::Public_Key::create_kem_encryption_op(), Botan::Private_Key::create_key_agreement_op(), Botan::Private_Key::create_signature_op(), Botan::Public_Key::create_verification_op(), Botan::Public_Key::get_oid(), Botan::TLS::Handshake_State::parse_sig_format(), Botan::PK_Decryptor_EME::PK_Decryptor_EME(), Botan::PK_Encryptor_EME::PK_Encryptor_EME(), Botan::PK_KEM_Decryptor::PK_KEM_Decryptor(), Botan::PK_KEM_Encryptor::PK_KEM_Encryptor(), Botan::PK_Key_Agreement::PK_Key_Agreement(), Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), Botan::verify_cert_constraints_valid_for_key_type(), and Botan::X509_Object::verify_signature().

◆ algorithm_identifier()

AlgorithmIdentifier Botan::DL_Scheme_PublicKey::algorithm_identifier ( ) const
overridevirtual
Returns
X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 25 of file dl_algo.cpp.

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

26  {
27  return AlgorithmIdentifier(get_oid(),
29  }
virtual OID get_oid() const
Definition: pk_keys.cpp:51
std::vector< uint8_t > DER_encode(Format format) const
Definition: dl_group.cpp:455
virtual DL_Group::Format group_format() const =0

◆ check_key()

bool Botan::DL_Scheme_PublicKey::check_key ( RandomNumberGenerator rng,
bool  strong 
) const
overridevirtual

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

Definition at line 67 of file dl_algo.cpp.

References m_group, m_y, Botan::DL_Group::verify_group(), and Botan::DL_Group::verify_public_element().

69  {
70  return m_group.verify_group(rng, strong) && m_group.verify_public_element(m_y);
71  }
bool verify_group(RandomNumberGenerator &rng, bool strong=true) const
Definition: dl_group.cpp:342
bool verify_public_element(const BigInt &y) const
Definition: dl_group.cpp:309

◆ create_encryption_op()

std::unique_ptr< PK_Ops::Encryption > Botan::Public_Key::create_encryption_op ( RandomNumberGenerator rng,
const std::string &  params,
const std::string &  provider 
) const
virtualinherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return an encryption operation for this key/params or throw

Parameters
rnga random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
paramsadditional parameters
providerthe provider to use

Reimplemented in Botan::RSA_PublicKey, Botan::SM2_Encryption_PublicKey, and Botan::ElGamal_PublicKey.

Definition at line 92 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_Encryptor_EME::PK_Encryptor_EME().

95  {
96  throw Lookup_Error(algo_name() + " does not support encryption");
97  }
virtual std::string algo_name() const =0

◆ create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::Public_Key::create_kem_encryption_op ( RandomNumberGenerator rng,
const std::string &  params,
const std::string &  provider 
) const
virtualinherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return a KEM encryption operation for this key/params or throw

Parameters
rnga random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
paramsadditional parameters
providerthe provider to use

Reimplemented in Botan::RSA_PublicKey, and Botan::McEliece_PublicKey.

Definition at line 100 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_KEM_Encryptor::PK_KEM_Encryptor().

103  {
104  throw Lookup_Error(algo_name() + " does not support KEM encryption");
105  }
virtual std::string algo_name() const =0

◆ create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Public_Key::create_verification_op ( const std::string &  params,
const std::string &  provider 
) const
virtualinherited

This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h

Return a verification operation for this key/params or throw

Parameters
paramsadditional parameters
providerthe provider to use

Reimplemented in Botan::XMSS_PublicKey, Botan::RSA_PublicKey, Botan::XMSS_WOTS_Addressed_PublicKey, Botan::GOST_3410_PublicKey, Botan::Ed25519_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::SM2_Signature_PublicKey, and Botan::DSA_PublicKey.

Definition at line 108 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::XMSS_WOTS_Addressed_PublicKey::create_verification_op(), and Botan::PK_Verifier::PK_Verifier().

110  {
111  throw Lookup_Error(algo_name() + " does not support verification");
112  }
virtual std::string algo_name() const =0

◆ estimated_strength()

size_t Botan::DL_Scheme_PublicKey::estimated_strength ( ) const
overridevirtual

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

References Botan::DL_Group::estimated_strength(), and m_group.

21  {
22  return m_group.estimated_strength();
23  }
size_t estimated_strength() const
Definition: dl_group.cpp:416

◆ fingerprint_public()

std::string Botan::Public_Key::fingerprint_public ( const std::string &  alg = "SHA-256") const
inherited
Returns
Hash of the subject public key

Definition at line 78 of file pk_keys.cpp.

References Botan::create_hex_fingerprint(), hash_algo, and Botan::Public_Key::subject_public_key().

79  {
81  }
AlgorithmIdentifier hash_algo
Definition: x509_obj.cpp:23
std::string create_hex_fingerprint(const uint8_t bits[], size_t bits_len, const std::string &hash_name)
Definition: pk_keys.cpp:17
std::vector< uint8_t > subject_public_key() const
Definition: pk_keys.cpp:38

◆ get_domain()

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

Get the DL domain parameters of this key.

Returns
DL domain parameters of this key

Definition at line 32 of file dl_algo.h.

32 { return m_group; }

◆ get_group()

const DL_Group& Botan::DL_Scheme_PublicKey::get_group ( ) const
inline

Get the DL domain parameters of this key.

Returns
DL domain parameters of this key

Definition at line 38 of file dl_algo.h.

38 { return m_group; }

◆ 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

Reimplemented in Botan::XMSS_WOTS_Addressed_PublicKey.

Definition at line 51 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::Ed25519_PublicKey::algorithm_identifier(), Botan::McEliece_PublicKey::algorithm_identifier(), Botan::RSA_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), Botan::TPM_PrivateKey::algorithm_identifier(), and Botan::XMSS_WOTS_Addressed_PublicKey::get_oid().

52  {
53  try {
54  return OIDS::lookup(algo_name());
55  }
56  catch(Lookup_Error&)
57  {
58  throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
59  }
60  }
virtual std::string algo_name() const =0
std::string lookup(const OID &oid)
Definition: oids.cpp:113

◆ get_y()

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 43 of file dl_algo.h.

43 { return m_y; }

◆ group_format()

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

Get the underlying groups encoding format.

Returns
encoding format

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

Referenced by algorithm_identifier().

◆ group_g()

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

Get the generator g of the underlying DL group.

Returns
generator g

Definition at line 61 of file dl_algo.h.

61 { return m_group.get_g(); }
const BigInt & get_g() const
Definition: dl_group.cpp:388

◆ group_p()

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

Get the prime p of the underlying DL group.

Returns
prime p

Definition at line 49 of file dl_algo.h.

Referenced by Botan::DH_PublicKey::public_value().

49 { return m_group.get_p(); }
const BigInt & get_p() const
Definition: dl_group.cpp:380

◆ group_q()

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 55 of file dl_algo.h.

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

55 { return m_group.get_q(); }
const BigInt & get_q() const
Definition: dl_group.cpp:396

◆ key_length()

size_t Botan::DL_Scheme_PublicKey::key_length ( ) const
overridevirtual

Return an integer value best approximating the length of the primary security parameter. For example for RSA this will be the size of the modulus, for ECDSA the size of the ECC group, and for McEliece the size of the code will be returned.

Implements Botan::Public_Key.

Definition at line 15 of file dl_algo.cpp.

References m_group, and Botan::DL_Group::p_bits().

16  {
17  return m_group.p_bits();
18  }
size_t p_bits() const
Definition: dl_group.cpp:406

◆ message_part_size()

virtual size_t Botan::Public_Key::message_part_size ( ) const
inlinevirtualinherited

Returns how large each of the message parts refered to by message_parts() is

This function is public but applications should have few reasons to ever call this.

Returns
size of the message parts in bits

Reimplemented in Botan::GOST_3410_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::SM2_Signature_PublicKey, and Botan::DSA_PublicKey.

Definition at line 118 of file pk_keys.h.

Referenced by Botan::PK_Signer::PK_Signer(), and Botan::PK_Verifier::PK_Verifier().

118 { return 0; }

◆ message_parts()

virtual size_t Botan::Public_Key::message_parts ( ) const
inlinevirtualinherited

Returns more than 1 if the output of this algorithm (ciphertext, signature) should be treated as more than one value. This is used for algorithms like DSA and ECDSA, where the (r,s) output pair can be encoded as either a plain binary list or a TLV tagged DER encoding depending on the protocol.

This function is public but applications should have few reasons to ever call this.

Returns
number of message parts

Reimplemented in Botan::GOST_3410_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::SM2_Signature_PublicKey, and Botan::DSA_PublicKey.

Definition at line 107 of file pk_keys.h.

Referenced by Botan::X509_Object::choose_sig_format(), Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), and Botan::X509_Object::verify_signature().

107 { return 1; }

◆ operator=()

DL_Scheme_PublicKey& Botan::DL_Scheme_PublicKey::operator= ( const DL_Scheme_PublicKey other)
default

◆ public_key_bits()

std::vector< uint8_t > Botan::DL_Scheme_PublicKey::public_key_bits ( ) const
overridevirtual
Returns
BER encoded public key bits

Implements Botan::Public_Key.

Definition at line 31 of file dl_algo.cpp.

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::get_contents_unlocked(), and m_y.

32  {
33  return DER_Encoder().encode(m_y).get_contents_unlocked();
34  }

◆ subject_public_key()

std::vector< uint8_t > Botan::Public_Key::subject_public_key ( ) const
inherited
Returns
X.509 subject key encoding for this key object

Definition at line 38 of file pk_keys.cpp.

References Botan::Public_Key::algorithm_identifier(), Botan::BIT_STRING, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents_unlocked(), Botan::Public_Key::public_key_bits(), Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

Referenced by Botan::X509::BER_encode(), Botan::PKCS10_Request::create(), Botan::Public_Key::fingerprint_public(), and Botan::X509::PEM_encode().

39  {
40  return DER_Encoder()
41  .start_cons(SEQUENCE)
42  .encode(algorithm_identifier())
43  .encode(public_key_bits(), BIT_STRING)
44  .end_cons()
45  .get_contents_unlocked();
46  }
virtual std::vector< uint8_t > public_key_bits() const =0
virtual AlgorithmIdentifier algorithm_identifier() const =0

Member Data Documentation

◆ m_group

DL_Group Botan::DL_Scheme_PublicKey::m_group
protected

◆ m_y

BigInt Botan::DL_Scheme_PublicKey::m_y
protected

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