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

#include <ecc_key.h>

Inheritance diagram for Botan::EC_PrivateKey:
Botan::EC_PublicKey Botan::Private_Key Botan::Public_Key Botan::Public_Key Botan::ECDH_PrivateKey Botan::ECDSA_PrivateKey Botan::ECGDSA_PrivateKey Botan::ECKCDSA_PrivateKey Botan::GOST_3410_PrivateKey Botan::SM2_Encryption_PrivateKey Botan::SM2_Signature_PrivateKey

Public Member Functions

virtual std::string algo_name () const =0
 
AlgorithmIdentifier algorithm_identifier () const override
 
bool check_key (RandomNumberGenerator &rng, bool strong) const override
 
virtual std::unique_ptr< PK_Ops::Decryptioncreate_decryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
 
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_Decryptioncreate_kem_decryption_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::Key_Agreementcreate_key_agreement_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const
 
virtual std::unique_ptr< PK_Ops::Signaturecreate_signature_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
 
std::vector< uint8_t > DER_domain () const
 
const EC_Groupdomain () const
 
EC_Group_Encoding domain_format () const
 
 EC_PrivateKey (RandomNumberGenerator &rng, const EC_Group &domain, const BigInt &x, bool with_modular_inverse=false)
 
 EC_PrivateKey (const AlgorithmIdentifier &alg_id, const secure_vector< uint8_t > &key_bits, bool with_modular_inverse=false)
 
 EC_PrivateKey (const EC_PrivateKey &other)=default
 
size_t estimated_strength () const override
 
std::string fingerprint (const std::string &alg) const
 
std::string fingerprint_private (const std::string &alg) const
 
std::string fingerprint_public (const std::string &alg="SHA-256") const
 
virtual OID get_oid () const
 
size_t key_length () const override
 
virtual size_t message_part_size () const
 
virtual size_t message_parts () const
 
EC_PrivateKeyoperator= (const EC_PrivateKey &other)=default
 
virtual AlgorithmIdentifier pkcs8_algorithm_identifier () const
 
PointGFp::Compression_Type point_encoding () const
 
secure_vector< uint8_t > private_key_bits () const override
 
secure_vector< uint8_t > private_key_info () const
 
const BigIntprivate_value () const
 
std::vector< uint8_t > public_key_bits () const override
 
const PointGFppublic_point () const
 
void set_parameter_encoding (EC_Group_Encoding enc)
 
void set_point_encoding (PointGFp::Compression_Type enc)
 
std::vector< uint8_t > subject_public_key () const
 
 ~EC_PrivateKey ()=default
 

Protected Member Functions

 EC_PrivateKey ()=default
 

Protected Attributes

EC_Group_Encoding m_domain_encoding
 
EC_Group m_domain_params
 
PointGFp::Compression_Type m_point_encoding = PointGFp::UNCOMPRESSED
 
BigInt m_private_key
 
PointGFp m_public_key
 

Detailed Description

This abstract class represents ECC private keys

Definition at line 123 of file ecc_key.h.

Constructor & Destructor Documentation

◆ EC_PrivateKey() [1/4]

Botan::EC_PrivateKey::EC_PrivateKey ( RandomNumberGenerator rng,
const EC_Group ec_group,
const BigInt x,
bool  with_modular_inverse = false 
)

EC_PrivateKey constructor

Definition at line 110 of file ecc_key.cpp.

References BOTAN_ASSERT, Botan::EC_PublicKey::domain(), Botan::EC_DOMPAR_ENC_EXPLICIT, Botan::EC_DOMPAR_ENC_OID, Botan::OID::empty(), Botan::EC_Group::get_base_point(), Botan::EC_Group::get_curve_oid(), Botan::EC_Group::inverse_mod_order(), Botan::EC_PublicKey::m_domain_encoding, Botan::EC_PublicKey::m_domain_params, m_private_key, Botan::EC_PublicKey::m_public_key, Botan::PointGFp::on_the_curve(), and Botan::EC_Group::random_scalar().

114  {
115  m_domain_params = ec_group;
116  if (!ec_group.get_curve_oid().empty())
118  else
120 
121  if(x == 0)
122  {
123  m_private_key = ec_group.random_scalar(rng);
124  }
125  else
126  {
127  m_private_key = x;
128  }
129 
130  // Can't use rng here because ffi load functions use Null_RNG
131  if(with_modular_inverse)
132  {
133  // ECKCDSA
135  }
136  else
137  {
139  }
140 
142  "Generated public key point was on the curve");
143  }
BigInt m_private_key
Definition: ecc_key.h:167
PointGFp m_public_key
Definition: ecc_key.h:115
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:43
const PointGFp & get_base_point() const
Definition: ec_group.cpp:495
const EC_Group & domain() const
Definition: ecc_key.h:72
bool on_the_curve() const
Definition: point_gfp.cpp:540
EC_Group m_domain_params
Definition: ecc_key.h:114
EC_Group_Encoding m_domain_encoding
Definition: ecc_key.h:116
BigInt inverse_mod_order(const BigInt &x) const
Definition: ec_group.cpp:540

◆ EC_PrivateKey() [2/4]

Botan::EC_PrivateKey::EC_PrivateKey ( const AlgorithmIdentifier alg_id,
const secure_vector< uint8_t > &  key_bits,
bool  with_modular_inverse = false 
)

Definition at line 156 of file ecc_key.cpp.

References Botan::BIT_STRING, BOTAN_ASSERT, Botan::BER_Decoder::decode_and_check(), Botan::BER_Decoder::decode_optional(), Botan::BER_Decoder::decode_optional_string(), Botan::EC_PublicKey::domain(), Botan::EC_DOMPAR_ENC_EXPLICIT, Botan::EC_DOMPAR_ENC_OID, Botan::OID::empty(), Botan::BER_Decoder::end_cons(), Botan::EC_Group::get_base_point(), Botan::EC_Group::get_curve_oid(), Botan::AlgorithmIdentifier::get_parameters(), Botan::EC_Group::inverse_mod_order(), Botan::EC_PublicKey::m_domain_encoding, Botan::EC_PublicKey::m_domain_params, m_private_key, Botan::EC_PublicKey::m_public_key, Botan::PointGFp::on_the_curve(), Botan::EC_Group::OS2ECP(), Botan::PRIVATE, Botan::EC_PublicKey::public_key_bits(), Botan::SEQUENCE, and Botan::BER_Decoder::start_cons().

159  {
160  m_domain_params = EC_Group(alg_id.get_parameters());
162 
163  if (!domain().get_curve_oid().empty())
165  else
167 
168  OID key_parameters;
169  secure_vector<uint8_t> public_key_bits;
170 
171  BER_Decoder(key_bits)
172  .start_cons(SEQUENCE)
173  .decode_and_check<size_t>(1, "Unknown version code for ECC key")
174  .decode_octet_string_bigint(m_private_key)
175  .decode_optional(key_parameters, ASN1_Tag(0), PRIVATE)
176  .decode_optional_string(public_key_bits, BIT_STRING, 1, PRIVATE)
177  .end_cons();
178 
179  if(public_key_bits.empty())
180  {
181  if(with_modular_inverse)
182  {
183  // ECKCDSA
185  }
186  else
187  {
189  }
190 
192  "Public point derived from loaded key was on the curve");
193  }
194  else
195  {
197  // OS2ECP verifies that the point is on the curve
198  }
199  }
BigInt m_private_key
Definition: ecc_key.h:167
const OID & get_curve_oid() const
Definition: ec_group.cpp:545
PointGFp m_public_key
Definition: ecc_key.h:115
ASN1_Tag
Definition: asn1_obj.h:22
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:43
const PointGFp & get_base_point() const
Definition: ec_group.cpp:495
const EC_Group & domain() const
Definition: ecc_key.h:72
bool empty() const
Definition: asn1_oid.h:30
PointGFp OS2ECP(const uint8_t bits[], size_t len) const
Definition: ec_group.cpp:550
bool on_the_curve() const
Definition: point_gfp.cpp:540
std::vector< uint8_t > public_key_bits() const override
Definition: ecc_key.cpp:69
EC_Group m_domain_params
Definition: ecc_key.h:114
EC_Group_Encoding m_domain_encoding
Definition: ecc_key.h:116
BigInt inverse_mod_order(const BigInt &x) const
Definition: ec_group.cpp:540

◆ EC_PrivateKey() [3/4]

Botan::EC_PrivateKey::EC_PrivateKey ( const EC_PrivateKey other)
default

◆ ~EC_PrivateKey()

Botan::EC_PrivateKey::~EC_PrivateKey ( )
default

◆ EC_PrivateKey() [4/4]

Botan::EC_PrivateKey::EC_PrivateKey ( )
protecteddefault

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::EC_PublicKey::algorithm_identifier ( ) const
overridevirtualinherited
Returns
X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 64 of file ecc_key.cpp.

References Botan::EC_PublicKey::DER_domain(), and Botan::Public_Key::get_oid().

Referenced by Botan::GOST_3410_PrivateKey::pkcs8_algorithm_identifier().

65  {
66  return AlgorithmIdentifier(get_oid(), DER_domain());
67  }
virtual OID get_oid() const
Definition: pk_keys.cpp:53
std::vector< uint8_t > DER_domain() const
Definition: ecc_key.h:90

◆ check_key()

bool Botan::EC_PublicKey::check_key ( RandomNumberGenerator rng,
bool  strong 
) const
overridevirtualinherited

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::ECDSA_PrivateKey, Botan::ECGDSA_PrivateKey, Botan::ECKCDSA_PrivateKey, Botan::SM2_Signature_PrivateKey, and Botan::SM2_Encryption_PrivateKey.

Definition at line 56 of file ecc_key.cpp.

References Botan::EC_PublicKey::m_domain_params, Botan::EC_PublicKey::public_point(), Botan::EC_Group::verify_group(), and Botan::EC_Group::verify_public_element().

58  {
59  return m_domain_params.verify_group(rng) &&
61  }
const PointGFp & public_point() const
Definition: ecc_key.h:57
bool verify_public_element(const PointGFp &y) const
Definition: ec_group.cpp:678
EC_Group m_domain_params
Definition: ecc_key.h:114
bool verify_group(RandomNumberGenerator &rng, bool strong=false) const
Definition: ec_group.cpp:701

◆ create_decryption_op()

std::unique_ptr< PK_Ops::Decryption > Botan::Private_Key::create_decryption_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 decryption 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_PrivateKey, Botan::SM2_Encryption_PrivateKey, and Botan::ElGamal_PrivateKey.

Definition at line 117 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_Decryptor_EME::PK_Decryptor_EME().

120  {
121  throw Lookup_Error(algo_name() + " does not support decryption");
122  }
virtual std::string algo_name() const =0

◆ 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 94 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

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

◆ create_kem_decryption_op()

std::unique_ptr< PK_Ops::KEM_Decryption > Botan::Private_Key::create_kem_decryption_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 decryption 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_PrivateKey, and Botan::McEliece_PrivateKey.

Definition at line 125 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_KEM_Decryptor::PK_KEM_Decryptor().

128  {
129  throw Lookup_Error(algo_name() + " does not support KEM decryption");
130  }
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 102 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

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

◆ create_key_agreement_op()

std::unique_ptr< PK_Ops::Key_Agreement > Botan::Private_Key::create_key_agreement_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 key agreement 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::ECDH_PrivateKey, Botan::Curve25519_PrivateKey, and Botan::DH_PrivateKey.

Definition at line 141 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_Key_Agreement::PK_Key_Agreement().

144  {
145  throw Lookup_Error(algo_name() + " does not support key agreement");
146  }
virtual std::string algo_name() const =0

◆ create_signature_op()

std::unique_ptr< PK_Ops::Signature > Botan::Private_Key::create_signature_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 signature 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::XMSS_PrivateKey, Botan::TPM_PrivateKey, Botan::RSA_PrivateKey, Botan::Ed25519_PrivateKey, Botan::GOST_3410_PrivateKey, Botan::ECDSA_PrivateKey, Botan::ECGDSA_PrivateKey, Botan::ECKCDSA_PrivateKey, Botan::SM2_Signature_PrivateKey, and Botan::DSA_PrivateKey.

Definition at line 133 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_Signer::PK_Signer().

136  {
137  throw Lookup_Error(algo_name() + " does not support signatures");
138  }
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 110 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().

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

◆ DER_domain()

std::vector<uint8_t> Botan::EC_PublicKey::DER_domain ( ) const
inlineinherited

Return the DER encoding of this keys domain in whatever format is preset for this particular key

Definition at line 90 of file ecc_key.h.

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

91  { return domain().DER_encode(domain_format()); }
const EC_Group & domain() const
Definition: ecc_key.h:72
EC_Group_Encoding domain_format() const
Definition: ecc_key.h:97
std::vector< uint8_t > DER_encode(EC_Group_Encoding form) const
Definition: ec_group.cpp:605

◆ domain()

const EC_Group& Botan::EC_PublicKey::domain ( ) const
inlineinherited

Get the domain parameters of this key.

Exceptions
Invalid_Stateis thrown if the domain parameters of this point are not set
Returns
the domain parameters of this key

Definition at line 72 of file ecc_key.h.

Referenced by Botan::GOST_3410_PublicKey::algorithm_identifier(), botan_pubkey_sm2_compute_za(), EC_PrivateKey(), Botan::EC_PublicKey::EC_PublicKey(), Botan::GOST_3410_PublicKey::GOST_3410_PublicKey(), Botan::EC_PublicKey::key_length(), and Botan::SM2_Signature_PrivateKey::SM2_Signature_PrivateKey().

72 { return m_domain_params; }
EC_Group m_domain_params
Definition: ecc_key.h:114

◆ domain_format()

EC_Group_Encoding Botan::EC_PublicKey::domain_format ( ) const
inlineinherited

Get the domain parameter encoding to be used when encoding this key.

Returns
the encoding to use

Definition at line 97 of file ecc_key.h.

98  { return m_domain_encoding; }
EC_Group_Encoding m_domain_encoding
Definition: ecc_key.h:116

◆ estimated_strength()

size_t Botan::EC_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 25 of file ecc_key.cpp.

References Botan::ecp_work_factor(), and Botan::EC_PublicKey::key_length().

26  {
27  return ecp_work_factor(key_length());
28  }
size_t ecp_work_factor(size_t bits)
Definition: workfactor.cpp:14
size_t key_length() const override
Definition: ecc_key.cpp:20

◆ fingerprint()

std::string Botan::Private_Key::fingerprint ( const std::string &  alg) const
inlineinherited

Definition at line 203 of file pk_keys.h.

204  {
205  return fingerprint_private(alg); // match behavior in previous versions
206  }
std::string fingerprint_private(const std::string &alg) const
Definition: pk_keys.cpp:88

◆ fingerprint_private()

std::string Botan::Private_Key::fingerprint_private ( const std::string &  alg) const
inherited
Returns
Hash of the PKCS #8 encoding for this key object

Definition at line 88 of file pk_keys.cpp.

References Botan::create_hex_fingerprint(), hash_algo, and Botan::Private_Key::private_key_bits().

Referenced by Botan::Certificate_Store_In_SQL::find_certs_for_key(), Botan::Certificate_Store_In_SQL::insert_key(), and Botan::Certificate_Store_In_SQL::remove_key().

89  {
91  }
virtual secure_vector< uint8_t > private_key_bits() const =0
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

◆ 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 80 of file pk_keys.cpp.

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

81  {
83  }
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_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 53 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::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().

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

◆ key_length()

size_t Botan::EC_PublicKey::key_length ( ) const
overridevirtualinherited

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

References Botan::EC_PublicKey::domain(), and Botan::EC_Group::get_p_bits().

Referenced by Botan::EC_PublicKey::estimated_strength().

21  {
22  return domain().get_p_bits();
23  }
size_t get_p_bits() const
Definition: ec_group.cpp:460
const EC_Group & domain() const
Definition: ecc_key.h:72

◆ 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=()

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

◆ 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

Reimplemented in Botan::XMSS_WOTS_PrivateKey, Botan::GOST_3410_PrivateKey, and Botan::XMSS_WOTS_Addressed_PrivateKey.

Definition at line 192 of file pk_keys.h.

Referenced by Botan::Private_Key::private_key_info().

193  { return algorithm_identifier(); }
virtual AlgorithmIdentifier algorithm_identifier() const =0

◆ point_encoding()

PointGFp::Compression_Type Botan::EC_PublicKey::point_encoding ( ) const
inlineinherited

Get the point encoding method to be used when encoding this key.

Returns
the encoding to use

Definition at line 104 of file ecc_key.h.

Referenced by Botan::EC_PublicKey::public_key_bits().

105  { return m_point_encoding; }
PointGFp::Compression_Type m_point_encoding
Definition: ecc_key.h:117

◆ private_key_bits()

secure_vector< uint8_t > Botan::EC_PrivateKey::private_key_bits ( ) const
overridevirtual
Returns
BER encoded private key bits

Implements Botan::Private_Key.

Definition at line 145 of file ecc_key.cpp.

References Botan::BigInt::bytes(), Botan::DER_Encoder::encode(), Botan::BigInt::encode_1363(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), m_private_key, Botan::OCTET_STRING, Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

146  {
147  return DER_Encoder()
148  .start_cons(SEQUENCE)
149  .encode(static_cast<size_t>(1))
151  OCTET_STRING)
152  .end_cons()
153  .get_contents();
154  }
BigInt m_private_key
Definition: ecc_key.h:167
size_t bytes() const
Definition: bigint.cpp:220
static secure_vector< uint8_t > encode_1363(const BigInt &n, size_t bytes)
Definition: big_code.cpp:82

◆ private_key_info()

secure_vector< uint8_t > Botan::Private_Key::private_key_info ( ) const
inherited
Returns
PKCS #8 private key encoding for this key object

Definition at line 64 of file pk_keys.cpp.

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::OCTET_STRING, Botan::Private_Key::pkcs8_algorithm_identifier(), Botan::Private_Key::private_key_bits(), Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().

Referenced by Botan::PKCS8::BER_encode(), Botan::PKCS8::BER_encode_encrypted_pbkdf_iter(), and Botan::PKCS8::BER_encode_encrypted_pbkdf_msec().

65  {
66  const size_t PKCS8_VERSION = 0;
67 
68  return DER_Encoder()
69  .start_cons(SEQUENCE)
70  .encode(PKCS8_VERSION)
72  .encode(private_key_bits(), OCTET_STRING)
73  .end_cons()
74  .get_contents();
75  }
virtual secure_vector< uint8_t > private_key_bits() const =0
virtual AlgorithmIdentifier pkcs8_algorithm_identifier() const
Definition: pk_keys.h:192

◆ private_value()

const BigInt & Botan::EC_PrivateKey::private_value ( ) const

Get the private key value of this key object.

Returns
the private key value of this key object

Definition at line 99 of file ecc_key.cpp.

References m_private_key.

100  {
101  if(m_private_key == 0)
102  throw Invalid_State("EC_PrivateKey::private_value - uninitialized");
103 
104  return m_private_key;
105  }
BigInt m_private_key
Definition: ecc_key.h:167

◆ public_key_bits()

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

Implements Botan::Public_Key.

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 69 of file ecc_key.cpp.

References Botan::PointGFp::encode(), Botan::EC_PublicKey::point_encoding(), and Botan::EC_PublicKey::public_point().

Referenced by EC_PrivateKey().

70  {
72  }
std::vector< uint8_t > encode(PointGFp::Compression_Type format) const
Definition: point_gfp.cpp:597
const PointGFp & public_point() const
Definition: ecc_key.h:57
PointGFp::Compression_Type point_encoding() const
Definition: ecc_key.h:104

◆ public_point()

const PointGFp& Botan::EC_PublicKey::public_point ( ) const
inlineinherited

◆ set_parameter_encoding()

void Botan::EC_PublicKey::set_parameter_encoding ( EC_Group_Encoding  enc)
inherited

Set the domain parameter encoding to be used when encoding this key.

Parameters
encthe encoding to use

Definition at line 84 of file ecc_key.cpp.

References Botan::EC_DOMPAR_ENC_EXPLICIT, Botan::EC_DOMPAR_ENC_IMPLICITCA, Botan::EC_DOMPAR_ENC_OID, Botan::OID::empty(), Botan::EC_Group::get_curve_oid(), Botan::EC_PublicKey::m_domain_encoding, and Botan::EC_PublicKey::m_domain_params.

85  {
86  if(form != EC_DOMPAR_ENC_EXPLICIT &&
87  form != EC_DOMPAR_ENC_IMPLICITCA &&
88  form != EC_DOMPAR_ENC_OID)
89  throw Invalid_Argument("Invalid encoding form for EC-key object specified");
90 
92  throw Invalid_Argument("Invalid encoding form OID specified for "
93  "EC-key object whose corresponding domain "
94  "parameters are without oid");
95 
96  m_domain_encoding = form;
97  }
const OID & get_curve_oid() const
Definition: ec_group.cpp:545
bool empty() const
Definition: asn1_oid.h:30
EC_Group m_domain_params
Definition: ecc_key.h:114
EC_Group_Encoding m_domain_encoding
Definition: ecc_key.h:116

◆ set_point_encoding()

void Botan::EC_PublicKey::set_point_encoding ( PointGFp::Compression_Type  enc)
inherited

Set the point encoding method to be used when encoding this key.

Parameters
encthe encoding to use

Definition at line 74 of file ecc_key.cpp.

References Botan::PointGFp::COMPRESSED, Botan::PointGFp::HYBRID, Botan::EC_PublicKey::m_point_encoding, and Botan::PointGFp::UNCOMPRESSED.

75  {
76  if(enc != PointGFp::COMPRESSED &&
77  enc != PointGFp::UNCOMPRESSED &&
78  enc != PointGFp::HYBRID)
79  throw Invalid_Argument("Invalid point encoding for EC_PublicKey");
80 
81  m_point_encoding = enc;
82  }
PointGFp::Compression_Type m_point_encoding
Definition: ecc_key.h:117

◆ 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::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  std::vector<uint8_t> output;
41 
42  DER_Encoder(output).start_cons(SEQUENCE)
43  .encode(algorithm_identifier())
44  .encode(public_key_bits(), BIT_STRING)
45  .end_cons();
46 
47  return output;
48  }
virtual std::vector< uint8_t > public_key_bits() const =0
virtual AlgorithmIdentifier algorithm_identifier() const =0

Member Data Documentation

◆ m_domain_encoding

EC_Group_Encoding Botan::EC_PublicKey::m_domain_encoding
protectedinherited

◆ m_domain_params

EC_Group Botan::EC_PublicKey::m_domain_params
protectedinherited

◆ m_point_encoding

PointGFp::Compression_Type Botan::EC_PublicKey::m_point_encoding = PointGFp::UNCOMPRESSED
protectedinherited

Definition at line 117 of file ecc_key.h.

Referenced by Botan::EC_PublicKey::set_point_encoding().

◆ m_private_key

BigInt Botan::EC_PrivateKey::m_private_key
protected

◆ m_public_key

PointGFp Botan::EC_PublicKey::m_public_key
protectedinherited

Definition at line 115 of file ecc_key.h.

Referenced by EC_PrivateKey(), and Botan::GOST_3410_PublicKey::GOST_3410_PublicKey().


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