Botan  2.1.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

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="SHA") 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
 
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)
 
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
 
BigInt m_private_key
 
PointGFp m_public_key
 

Detailed Description

This abstract class represents ECC private keys

Definition at line 110 of file ecc_key.h.

Constructor & Destructor Documentation

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

References BOTAN_ASSERT, Botan::EC_PublicKey::domain(), Botan::EC_DOMPAR_ENC_EXPLICIT, Botan::EC_Group::get_base_point(), Botan::EC_Group::get_order(), Botan::inverse_mod(), 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::BigInt::random_integer().

121  {
122  m_domain_params = ec_group;
124 
125  if(x == 0)
126  {
127  m_private_key = BigInt::random_integer(rng, 1, domain().get_order());
128  }
129  else
130  {
131  m_private_key = x;
132  }
133 
135  ((with_modular_inverse) ? inverse_mod(m_private_key, m_domain_params.get_order()) : m_private_key);
136 
138  "Generated public key point was on the curve");
139  }
BigInt m_private_key
Definition: ecc_key.h:154
const EC_Group & domain() const
Definition: ecc_key.h:73
const PointGFp & get_base_point() const
Definition: ec_group.h:95
PointGFp m_public_key
Definition: ecc_key.h:103
static BigInt random_integer(RandomNumberGenerator &rng, const BigInt &min, const BigInt &max)
Definition: big_rand.cpp:45
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:27
const BigInt & get_order() const
Definition: ec_group.h:101
BigInt inverse_mod(const BigInt &n, const BigInt &mod)
Definition: numthry.cpp:276
bool on_the_curve() const
Definition: point_gfp.cpp:414
EC_Group m_domain_params
Definition: ecc_key.h:102
EC_Group_Encoding m_domain_encoding
Definition: ecc_key.h:104
Botan::EC_PrivateKey::EC_PrivateKey ( const AlgorithmIdentifier alg_id,
const secure_vector< uint8_t > &  key_bits,
bool  with_modular_inverse = false 
)

Definition at line 152 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::OID::empty(), Botan::BER_Decoder::end_cons(), Botan::EC_Group::get_base_point(), Botan::EC_Group::get_order(), Botan::inverse_mod(), Botan::EC_PublicKey::m_domain_encoding, Botan::EC_PublicKey::m_domain_params, m_private_key, Botan::EC_PublicKey::m_public_key, Botan::AlgorithmIdentifier::oid, Botan::PointGFp::on_the_curve(), Botan::OS2ECP(), Botan::AlgorithmIdentifier::parameters, Botan::PRIVATE, Botan::EC_PublicKey::public_key_bits(), Botan::SEQUENCE, and Botan::BER_Decoder::start_cons().

155  {
156  m_domain_params = EC_Group(alg_id.parameters);
158 
159  OID key_parameters;
160  secure_vector<uint8_t> public_key_bits;
161 
162  BER_Decoder(key_bits)
163  .start_cons(SEQUENCE)
164  .decode_and_check<size_t>(1, "Unknown version code for ECC key")
165  .decode_octet_string_bigint(m_private_key)
166  .decode_optional(key_parameters, ASN1_Tag(0), PRIVATE)
167  .decode_optional_string(public_key_bits, BIT_STRING, 1, PRIVATE)
168  .end_cons();
169 
170  if(!key_parameters.empty() && key_parameters != alg_id.oid)
171  throw Decoding_Error("EC_PrivateKey - inner and outer OIDs did not match");
172 
173  if(public_key_bits.empty())
174  {
176  ((with_modular_inverse) ? inverse_mod(m_private_key, m_domain_params.get_order()) : m_private_key);
177 
179  "Public point derived from loaded key was on the curve");
180  }
181  else
182  {
183  m_public_key = OS2ECP(public_key_bits, domain().get_curve());
184  // OS2ECP verifies that the point is on the curve
185  }
186  }
BigInt m_private_key
Definition: ecc_key.h:154
const EC_Group & domain() const
Definition: ecc_key.h:73
const PointGFp & get_base_point() const
Definition: ec_group.h:95
PointGFp m_public_key
Definition: ecc_key.h:103
#define BOTAN_ASSERT(expr, assertion_made)
Definition: assert.h:27
ASN1_Tag
Definition: asn1_obj.h:22
PointGFp OS2ECP(const uint8_t data[], size_t data_len, const CurveGFp &curve)
Definition: point_gfp.cpp:544
const BigInt & get_order() const
Definition: ec_group.h:101
BigInt inverse_mod(const BigInt &n, const BigInt &mod)
Definition: numthry.cpp:276
std::vector< uint8_t > public_key_bits() const override
Definition: ecc_key.cpp:86
bool on_the_curve() const
Definition: point_gfp.cpp:414
EC_Group m_domain_params
Definition: ecc_key.h:102
EC_Group_Encoding m_domain_encoding
Definition: ecc_key.h:104
Botan::EC_PrivateKey::EC_PrivateKey ( const EC_PrivateKey other)
default
Botan::EC_PrivateKey::~EC_PrivateKey ( )
default
Botan::EC_PrivateKey::EC_PrivateKey ( )
protecteddefault

Member Function Documentation

virtual std::string Botan::Public_Key::algo_name ( ) const
pure virtualinherited
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 81 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().

82  {
83  return AlgorithmIdentifier(get_oid(), DER_domain());
84  }
virtual OID get_oid() const
Definition: pk_keys.cpp:30
std::vector< uint8_t > DER_domain() const
Definition: ecc_key.h:85
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, and Botan::ECKCDSA_PrivateKey.

Definition at line 47 of file ecc_key.cpp.

References Botan::EC_Group::get_cofactor(), Botan::EC_Group::get_order(), Botan::CT::is_zero(), Botan::PointGFp::is_zero(), Botan::EC_PublicKey::m_domain_params, Botan::PointGFp::on_the_curve(), Botan::EC_PublicKey::public_point(), and Botan::EC_Group::verify_group().

49  {
50  //verify domain parameters
52  {
53  return false;
54  }
55  //check that public point is not at infinity
56  if(public_point().is_zero())
57  {
58  return false;
59  }
60  //check that public point is on the curve
61  if(!public_point().on_the_curve())
62  {
63  return false;
64  }
66  {
68  {
69  return false;
70  }
71  //check that public point has order q
73  {
74  return false;
75  }
76  }
77  return true;
78  }
const PointGFp & public_point() const
Definition: ecc_key.h:58
const BigInt & get_order() const
Definition: ec_group.h:101
T is_zero(T x)
Definition: ct_utils.h:110
bool on_the_curve() const
Definition: point_gfp.cpp:414
bool is_zero() const
Definition: point_gfp.h:177
bool verify_group(RandomNumberGenerator &rng, bool strong=false) const
Definition: ec_group.cpp:134
EC_Group m_domain_params
Definition: ecc_key.h:102
const BigInt & get_cofactor() const
Definition: ec_group.h:107
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, and Botan::ElGamal_PrivateKey.

Definition at line 102 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

105  {
106  throw Lookup_Error(algo_name() + " does not support decryption");
107  }
virtual std::string algo_name() const =0
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, and Botan::ElGamal_PublicKey.

Definition at line 79 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

82  {
83  throw Lookup_Error(algo_name() + " does not support encryption");
84  }
virtual std::string algo_name() const =0
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 110 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

113  {
114  throw Lookup_Error(algo_name() + " does not support KEM decryption");
115  }
virtual std::string algo_name() const =0
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 87 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

90  {
91  throw Lookup_Error(algo_name() + " does not support KEM encryption");
92  }
virtual std::string algo_name() const =0
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 126 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

129  {
130  throw Lookup_Error(algo_name() + " does not support key agreement");
131  }
virtual std::string algo_name() const =0
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_WOTS_PrivateKey, Botan::XMSS_PrivateKey, Botan::TPM_PrivateKey, Botan::RSA_PrivateKey, Botan::GOST_3410_PrivateKey, Botan::ECDSA_PrivateKey, Botan::ECGDSA_PrivateKey, Botan::ECKCDSA_PrivateKey, and Botan::DSA_PrivateKey.

Definition at line 118 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

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

121  {
122  throw Lookup_Error(algo_name() + " does not support signatures");
123  }
virtual std::string algo_name() const =0
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_WOTS_PublicKey, Botan::XMSS_PublicKey, Botan::RSA_PublicKey, Botan::XMSS_WOTS_Addressed_PublicKey, Botan::GOST_3410_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, and Botan::DSA_PublicKey.

Definition at line 95 of file pk_keys.cpp.

References Botan::Public_Key::algo_name().

Referenced by Botan::PK_Verifier::PK_Verifier().

97  {
98  throw Lookup_Error(algo_name() + " does not support verification");
99  }
virtual std::string algo_name() const =0
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 85 of file ecc_key.h.

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

86  { return domain().DER_encode(domain_format()); }
const EC_Group & domain() const
Definition: ecc_key.h:73
std::vector< uint8_t > DER_encode(EC_Group_Encoding form) const
Definition: ec_group.cpp:92
EC_Group_Encoding domain_format() const
Definition: ecc_key.h:92
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 73 of file ecc_key.h.

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

73 { return m_domain_params; }
EC_Group m_domain_params
Definition: ecc_key.h:102
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 92 of file ecc_key.h.

93  { return m_domain_encoding; }
EC_Group_Encoding m_domain_encoding
Definition: ecc_key.h:104
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 26 of file ecc_key.cpp.

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

27  {
28  return ecp_work_factor(key_length());
29  }
size_t ecp_work_factor(size_t bits)
Definition: workfactor.cpp:14
size_t key_length() const override
Definition: ecc_key.cpp:21
std::string Botan::Private_Key::fingerprint ( const std::string &  alg = "SHA") const
inherited
Returns
Hash of the PKCS #8 encoding for this key object

Definition at line 57 of file pk_keys.cpp.

References Botan::HashFunction::create(), hash, Botan::hex_encode(), 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().

58  {
59  secure_vector<uint8_t> buf = private_key_bits();
60  std::unique_ptr<HashFunction> hash(HashFunction::create(alg));
61  hash->update(buf);
62  const auto hex_print = hex_encode(hash->final());
63 
64  std::string formatted_print;
65 
66  for(size_t i = 0; i != hex_print.size(); i += 2)
67  {
68  formatted_print.push_back(hex_print[i]);
69  formatted_print.push_back(hex_print[i+1]);
70 
71  if(i != hex_print.size() - 2)
72  formatted_print.push_back(':');
73  }
74 
75  return formatted_print;
76  }
virtual secure_vector< uint8_t > private_key_bits() const =0
static std::unique_ptr< HashFunction > create(const std::string &algo_spec, const std::string &provider="")
Definition: hash.cpp:93
void hex_encode(char output[], const uint8_t input[], size_t input_length, bool uppercase)
Definition: hex.cpp:14
MechanismType hash
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 30 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::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().

31  {
32  try {
33  return OIDS::lookup(algo_name());
34  }
35  catch(Lookup_Error&)
36  {
37  throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
38  }
39  }
virtual std::string algo_name() const =0
std::string lookup(const OID &oid)
Definition: oids.cpp:18
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 21 of file ecc_key.cpp.

References Botan::BigInt::bits(), Botan::EC_PublicKey::domain(), Botan::EC_Group::get_curve(), and Botan::CurveGFp::get_p().

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

22  {
23  return domain().get_curve().get_p().bits();
24  }
const EC_Group & domain() const
Definition: ecc_key.h:73
size_t bits() const
Definition: bigint.cpp:184
const CurveGFp & get_curve() const
Definition: ec_group.h:89
const BigInt & get_p() const
Definition: curve_gfp.h:91
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, and Botan::DSA_PublicKey.

Definition at line 114 of file pk_keys.h.

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

114 { return 0; }
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, and Botan::DSA_PublicKey.

Definition at line 103 of file pk_keys.h.

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

103 { return 1; }
EC_PrivateKey& Botan::EC_PrivateKey::operator= ( const EC_PrivateKey other)
default
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 188 of file pk_keys.h.

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

189  { return algorithm_identifier(); }
virtual AlgorithmIdentifier algorithm_identifier() const =0
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 141 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().

142  {
143  return DER_Encoder()
144  .start_cons(SEQUENCE)
145  .encode(static_cast<size_t>(1))
147  OCTET_STRING)
148  .end_cons()
149  .get_contents();
150  }
BigInt m_private_key
Definition: ecc_key.h:154
static secure_vector< uint8_t > encode_1363(const BigInt &n, size_t bytes)
Definition: big_code.cpp:82
size_t bytes() const
Definition: bigint.cpp:176
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 41 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().

42  {
43  const size_t PKCS8_VERSION = 0;
44 
45  return DER_Encoder()
46  .start_cons(SEQUENCE)
47  .encode(PKCS8_VERSION)
49  .encode(private_key_bits(), OCTET_STRING)
50  .end_cons()
51  .get_contents();
52  }
virtual secure_vector< uint8_t > private_key_bits() const =0
virtual AlgorithmIdentifier pkcs8_algorithm_identifier() const
Definition: pk_keys.h:188
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 106 of file ecc_key.cpp.

References m_private_key.

107  {
108  if(m_private_key == 0)
109  throw Invalid_State("EC_PrivateKey::private_value - uninitialized");
110 
111  return m_private_key;
112  }
BigInt m_private_key
Definition: ecc_key.h:154
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 86 of file ecc_key.cpp.

References Botan::PointGFp::COMPRESSED, Botan::EC2OSP(), Botan::EC_PublicKey::public_point(), and Botan::unlock().

Referenced by EC_PrivateKey().

87  {
89  }
secure_vector< uint8_t > EC2OSP(const PointGFp &point, uint8_t format)
Definition: point_gfp.cpp:470
const PointGFp & public_point() const
Definition: ecc_key.h:58
std::vector< T > unlock(const secure_vector< T > &in)
Definition: secmem.h:125
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 58 of file ecc_key.h.

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

58 { return m_public_key; }
PointGFp m_public_key
Definition: ecc_key.h:103
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 91 of file ecc_key.cpp.

References Botan::EC_DOMPAR_ENC_EXPLICIT, Botan::EC_DOMPAR_ENC_IMPLICITCA, Botan::EC_DOMPAR_ENC_OID, Botan::EC_Group::get_oid(), Botan::EC_PublicKey::m_domain_encoding, and Botan::EC_PublicKey::m_domain_params.

92  {
93  if(form != EC_DOMPAR_ENC_EXPLICIT &&
94  form != EC_DOMPAR_ENC_IMPLICITCA &&
95  form != EC_DOMPAR_ENC_OID)
96  throw Invalid_Argument("Invalid encoding form for EC-key object specified");
97 
98  if((form == EC_DOMPAR_ENC_OID) && (m_domain_params.get_oid() == ""))
99  throw Invalid_Argument("Invalid encoding form OID specified for "
100  "EC-key object whose corresponding domain "
101  "parameters are without oid");
102 
103  m_domain_encoding = form;
104  }
std::string get_oid() const
Definition: ec_group.h:115
EC_Group m_domain_params
Definition: ecc_key.h:102
EC_Group_Encoding m_domain_encoding
Definition: ecc_key.h:104
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 17 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(), and Botan::X509::PEM_encode().

18  {
19  return DER_Encoder()
20  .start_cons(SEQUENCE)
21  .encode(algorithm_identifier())
22  .encode(public_key_bits(), BIT_STRING)
23  .end_cons()
24  .get_contents_unlocked();
25  }
virtual std::vector< uint8_t > public_key_bits() const =0
virtual AlgorithmIdentifier algorithm_identifier() const =0

Member Data Documentation

EC_Group_Encoding Botan::EC_PublicKey::m_domain_encoding
protectedinherited

Definition at line 104 of file ecc_key.h.

Referenced by EC_PrivateKey(), and Botan::EC_PublicKey::set_parameter_encoding().

EC_Group Botan::EC_PublicKey::m_domain_params
protectedinherited
BigInt Botan::EC_PrivateKey::m_private_key
protected

Definition at line 154 of file ecc_key.h.

Referenced by EC_PrivateKey(), private_key_bits(), and private_value().

PointGFp Botan::EC_PublicKey::m_public_key
protectedinherited

Definition at line 103 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: