Botan  2.8.0
Crypto and TLS for C++11
Public Member Functions | Protected Attributes | List of all members
Botan::ECDSA_PrivateKey Class Referencefinal

#include <ecdsa.h>

Inheritance diagram for Botan::ECDSA_PrivateKey:
Botan::ECDSA_PublicKey Botan::EC_PrivateKey Botan::EC_PublicKey Botan::EC_PublicKey Botan::Private_Key Botan::Public_Key Botan::Public_Key Botan::Public_Key

Public Member Functions

std::string algo_name () const override
 
AlgorithmIdentifier algorithm_identifier () const override
 
bool check_key (RandomNumberGenerator &rng, bool) 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
 
std::unique_ptr< PK_Ops::Signaturecreate_signature_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const override
 
std::unique_ptr< PK_Ops::Verificationcreate_verification_op (const std::string &params, const std::string &provider) const override
 
std::vector< uint8_t > DER_domain () const
 
const EC_Groupdomain () const
 
EC_Group_Encoding domain_format () const
 
 ECDSA_PrivateKey (const AlgorithmIdentifier &alg_id, const secure_vector< uint8_t > &key_bits)
 
 ECDSA_PrivateKey (RandomNumberGenerator &rng, const EC_Group &domain, const BigInt &x=0)
 
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
 
size_t message_part_size () const override
 
size_t message_parts () const override
 
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
 

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 class represents ECDSA Private Keys

Definition at line 63 of file ecdsa.h.

Constructor & Destructor Documentation

◆ ECDSA_PrivateKey() [1/2]

Botan::ECDSA_PrivateKey::ECDSA_PrivateKey ( const AlgorithmIdentifier alg_id,
const secure_vector< uint8_t > &  key_bits 
)
inline

Load a private key

Parameters
alg_idthe X.509 algorithm identifier
key_bitsECPrivateKey bits

Definition at line 73 of file ecdsa.h.

74  :
75  EC_PrivateKey(alg_id, key_bits) {}

◆ ECDSA_PrivateKey() [2/2]

Botan::ECDSA_PrivateKey::ECDSA_PrivateKey ( RandomNumberGenerator rng,
const EC_Group domain,
const BigInt x = 0 
)
inline

Create a private key.

Parameters
rnga random number generator
domainparameters to used for this key
xthe private key (if zero, generate a new random key)

Definition at line 83 of file ecdsa.h.

85  :
86  EC_PrivateKey(rng, domain, x) {}
const EC_Group & domain() const
Definition: ecc_key.h:72

Member Function Documentation

◆ algo_name()

std::string Botan::ECDSA_PublicKey::algo_name ( ) const
inlineoverridevirtualinherited

Get this keys algorithm name.

Returns
this keys algorithm name ("ECDSA")

Implements Botan::Public_Key.

Definition at line 46 of file ecdsa.h.

Referenced by create_signature_op(), and Botan::ECDSA_PublicKey::create_verification_op().

46 { return "ECDSA"; }

◆ 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::ECDSA_PrivateKey::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

Reimplemented from Botan::EC_PublicKey.

Definition at line 32 of file ecdsa.cpp.

References Botan::EC_PublicKey::public_point(), and Botan::KeyPair::signature_consistency_check().

34  {
35  if(!public_point().on_the_curve())
36  return false;
37 
38  if(!strong)
39  return true;
40 
41  return KeyPair::signature_consistency_check(rng, *this, "EMSA1(SHA-256)");
42  }
const PointGFp & public_point() const
Definition: ecc_key.h:57
bool signature_consistency_check(RandomNumberGenerator &rng, const Private_Key &private_key, const Public_Key &public_key, const std::string &padding)
Definition: keypair.cpp:49

◆ 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_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_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::ECDSA_PrivateKey::create_signature_op ( RandomNumberGenerator rng,
const std::string &  params,
const std::string &  provider 
) const
overridevirtual

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 from Botan::Private_Key.

Definition at line 218 of file ecdsa.cpp.

References Botan::ECDSA_PublicKey::algo_name().

221  {
222 #if defined(BOTAN_HAS_BEARSSL)
223  if(provider == "bearssl" || provider.empty())
224  {
225  try
226  {
227  return make_bearssl_ecdsa_sig_op(*this, params);
228  }
229  catch(Lookup_Error& e)
230  {
231  if(provider == "bearssl")
232  throw;
233  }
234  }
235 #endif
236 
237 #if defined(BOTAN_HAS_OPENSSL)
238  if(provider == "openssl" || provider.empty())
239  {
240  try
241  {
242  return make_openssl_ecdsa_sig_op(*this, params);
243  }
244  catch(Lookup_Error& e)
245  {
246  if(provider == "openssl")
247  throw;
248  }
249  }
250 #endif
251 
252  if(provider == "base" || provider.empty())
253  return std::unique_ptr<PK_Ops::Signature>(new ECDSA_Signature_Operation(*this, params, rng));
254 
255  throw Provider_Not_Found(algo_name(), provider);
256  }
std::string algo_name() const override
Definition: ecdsa.h:46

◆ create_verification_op()

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

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 from Botan::Public_Key.

Definition at line 178 of file ecdsa.cpp.

References Botan::ECDSA_PublicKey::algo_name().

180  {
181 #if defined(BOTAN_HAS_BEARSSL)
182  if(provider == "bearssl" || provider.empty())
183  {
184  try
185  {
186  return make_bearssl_ecdsa_ver_op(*this, params);
187  }
188  catch(Lookup_Error& e)
189  {
190  if(provider == "bearssl")
191  throw;
192  }
193  }
194 #endif
195 
196 #if defined(BOTAN_HAS_OPENSSL)
197  if(provider == "openssl" || provider.empty())
198  {
199  try
200  {
201  return make_openssl_ecdsa_ver_op(*this, params);
202  }
203  catch(Lookup_Error& e)
204  {
205  if(provider == "openssl")
206  throw;
207  }
208  }
209 #endif
210 
211  if(provider == "base" || provider.empty())
212  return std::unique_ptr<PK_Ops::Verification>(new ECDSA_Verification_Operation(*this, params));
213 
214  throw Provider_Not_Found(algo_name(), provider);
215  }
std::string algo_name() const override
Definition: ecdsa.h:46

◆ 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:593

◆ 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(), Botan::EC_PrivateKey::EC_PrivateKey(), Botan::EC_PublicKey::EC_PublicKey(), Botan::GOST_3410_PublicKey::GOST_3410_PublicKey(), Botan::EC_PublicKey::key_length(), and Botan::SM2_PrivateKey::SM2_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:439
const EC_Group & domain() const
Definition: ecc_key.h:72

◆ message_part_size()

size_t Botan::ECDSA_PublicKey::message_part_size ( ) const
inlineoverridevirtualinherited

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 from Botan::Public_Key.

Definition at line 50 of file ecdsa.h.

51  { return domain().get_order().bytes(); }
const BigInt & get_order() const
Definition: ec_group.cpp:479
const EC_Group & domain() const
Definition: ecc_key.h:72
size_t bytes() const
Definition: bigint.cpp:221

◆ message_parts()

size_t Botan::ECDSA_PublicKey::message_parts ( ) const
inlineoverridevirtualinherited

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 from Botan::Public_Key.

Definition at line 48 of file ecdsa.h.

48 { return 2; }

◆ 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
overridevirtualinherited
Returns
BER encoded private key bits

Implements Botan::Private_Key.

Definition at line 145 of file ecc_key.cpp.

References Botan::BIT_STRING, Botan::BigInt::bytes(), Botan::DER_Encoder::encode(), Botan::PointGFp::encode(), Botan::BigInt::encode_1363(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::EC_PrivateKey::m_private_key, Botan::EC_PublicKey::m_public_key, Botan::OCTET_STRING, Botan::PRIVATE, 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  .start_cons(ASN1_Tag(1), PRIVATE)
152  .encode(m_public_key.encode(PointGFp::Compression_Type::UNCOMPRESSED), BIT_STRING)
153  .end_cons()
154  .end_cons()
155  .get_contents();
156  }
BigInt m_private_key
Definition: ecc_key.h:167
std::vector< uint8_t > encode(PointGFp::Compression_Type format) const
Definition: point_gfp.cpp:597
PointGFp m_public_key
Definition: ecc_key.h:115
ASN1_Tag
Definition: asn1_obj.h:22
size_t bytes() const
Definition: bigint.cpp:221
static secure_vector< uint8_t > encode_1363(const BigInt &n, size_t bytes)
Definition: big_code.cpp:124

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

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 Botan::EC_PrivateKey::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 Botan::EC_PrivateKey::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

Get the public point of this key.

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

Definition at line 57 of file ecc_key.h.

Referenced by botan_pubkey_sm2_compute_za(), Botan::EC_PublicKey::check_key(), Botan::ECGDSA_PrivateKey::check_key(), Botan::ECKCDSA_PrivateKey::check_key(), check_key(), Botan::SM2_PrivateKey::check_key(), Botan::EC_PublicKey::EC_PublicKey(), Botan::GOST_3410_PublicKey::public_key_bits(), and Botan::EC_PublicKey::public_key_bits().

57 { return m_public_key; }
PointGFp m_public_key
Definition: ecc_key.h:115

◆ 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:524
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
protectedinherited

◆ m_public_key

PointGFp Botan::EC_PublicKey::m_public_key
protectedinherited

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