#include <dsa.h>

Inheritance diagram for Botan::DSA_PrivateKey:

Public Member Functions
std::string	algo_name () const override

AlgorithmIdentifier	algorithm_identifier () const override

bool	check_key (RandomNumberGenerator &rng, bool strong) const override

virtual std::unique_ptr< PK_Ops::Decryption >	create_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const

virtual std::unique_ptr< PK_Ops::Encryption >	create_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const

virtual std::unique_ptr< PK_Ops::KEM_Decryption >	create_kem_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const

virtual std::unique_ptr< PK_Ops::KEM_Encryption >	create_kem_encryption_op (std::string_view params, std::string_view provider) const

virtual std::unique_ptr< PK_Ops::Key_Agreement >	create_key_agreement_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const

std::unique_ptr< PK_Ops::Signature >	create_signature_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override

std::unique_ptr< PK_Ops::Verification >	create_verification_op (std::string_view params, std::string_view provider) const override

std::unique_ptr< PK_Ops::Verification >	create_x509_verification_op (const AlgorithmIdentifier &signature_algorithm, std::string_view provider) const override

virtual Signature_Format	default_x509_signature_format () const

	DSA_PrivateKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits)

	DSA_PrivateKey (const DL_Group &group, const BigInt &private_key)

	DSA_PrivateKey (RandomNumberGenerator &rng, const DL_Group &group)

size_t	estimated_strength () const override

std::string	fingerprint_private (std::string_view alg) const

std::string	fingerprint_public (std::string_view alg="SHA-256") const

const BigInt &	get_int_field (std::string_view field) const override

OID	get_oid () const

size_t	key_length () const override

size_t	message_part_size () const override

size_t	message_parts () const override

virtual OID	object_identifier () const

virtual AlgorithmIdentifier	pkcs8_algorithm_identifier () const

secure_vector< uint8_t >	private_key_bits () const override

secure_vector< uint8_t >	private_key_info () const

std::unique_ptr< Public_Key >	public_key () const override

std::vector< uint8_t >	public_key_bits () const override

secure_vector< uint8_t >	raw_private_key_bits () const override

virtual bool	stateful_operation () const

std::vector< uint8_t >	subject_public_key () const

bool	supports_operation (PublicKeyOperation op) const override

Detailed Description

DSA Private Key

Definition at line 87 of file dsa.h.

Constructor & Destructor Documentation

◆ DSA_PrivateKey() [1/3]

Botan::DSA_PrivateKey::DSA_PrivateKey	(	const AlgorithmIdentifier &	alg_id,
		std::span< const uint8_t >	key_bits
	)

Load a private key from the ASN.1 encoding

Parameters

alg_id	the X.509 algorithm identifier
key_bits	DER encoded key bits in ANSI X9.57 format

Definition at line 90 of file dsa.cpp.

   {
   m_private_key = std::make_shared<DL_PrivateKey>(alg_id, key_bits, DL_Group_Format::ANSI_X9_57);
   m_public_key = m_private_key->public_key();
   }

References Botan::ANSI_X9_57.

◆ DSA_PrivateKey() [2/3]

Botan::DSA_PrivateKey::DSA_PrivateKey	(	RandomNumberGenerator &	rng,
		const DL_Group &	group
	)

Create a new private key.

Parameters

group	the underlying DL group
rng	the RNG to use

Definition at line 76 of file dsa.cpp.

   {
   m_private_key = std::make_shared<DL_PrivateKey>(group, rng);
   m_public_key = m_private_key->public_key();
   }

◆ DSA_PrivateKey() [3/3]

Botan::DSA_PrivateKey::DSA_PrivateKey	(	const DL_Group &	group,
		const BigInt &	private_key
	)

Load a private key

Parameters

group	the underlying DL group
private_key	the private key

Definition at line 83 of file dsa.cpp.

   {
   m_private_key = std::make_shared<DL_PrivateKey>(group, x);
   m_public_key = m_private_key->public_key();
   }

Member Function Documentation

◆ algo_name()

std::string Botan::DSA_PublicKey::algo_name ( ) const

inlineoverridevirtualinherited

Get the name of the underlying public key scheme.

Returns: name of the public key scheme

Implements Botan::Asymmetric_Key.

Definition at line 47 of file dsa.h.

47{ return "DSA"; }

Referenced by create_signature_op(), Botan::DSA_PublicKey::create_verification_op(), Botan::DSA_PublicKey::create_x509_verification_op(), Botan::DSA_PublicKey::get_int_field(), and get_int_field().

◆ algorithm_identifier()

AlgorithmIdentifier Botan::DSA_PublicKey::algorithm_identifier ( ) const

overridevirtualinherited

Returns: X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 42 of file dsa.cpp.

   {
   return AlgorithmIdentifier(
      object_identifier(),
      m_public_key->group().DER_encode(DL_Group_Format::ANSI_X9_57));
   }

References Botan::ANSI_X9_57, and Botan::Asymmetric_Key::object_identifier().

◆ check_key()

bool Botan::DSA_PrivateKey::check_key	(	RandomNumberGenerator &	rng,
		bool	strong
	)		const

overridevirtual

Reimplemented from Botan::DSA_PublicKey.

Definition at line 97 of file dsa.cpp.

   {
   if(!m_private_key->check_key(rng, strong))
      return false;
 
   if(m_private_key->private_key() >= m_private_key->group().get_q())
      return false;
 
   return KeyPair::signature_consistency_check(rng, *this, "SHA-256");
   }

References Botan::KeyPair::signature_consistency_check().

◆ create_decryption_op()

std::unique_ptr< PK_Ops::Decryption > Botan::Private_Key::create_decryption_op	(	RandomNumberGenerator &	rng,
		std::string_view	params,
		std::string_view	provider
	)		const

virtualinherited

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

Return an decryption operation for this key/params or throw

Parameters

rng	a 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.
params	additional parameters
provider	the provider to use

Reimplemented in Botan::ElGamal_PrivateKey, Botan::RSA_PrivateKey, and Botan::SM2_PrivateKey.

Definition at line 131 of file pk_keys.cpp.

   {
   throw Lookup_Error(fmt("{} does not support decryption", algo_name()));
   }

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

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

◆ create_encryption_op()

std::unique_ptr< PK_Ops::Encryption > Botan::Public_Key::create_encryption_op	(	RandomNumberGenerator &	rng,
		std::string_view	params,
		std::string_view	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

rng	a 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.
params	additional parameters
provider	the provider to use

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

Definition at line 102 of file pk_keys.cpp.

   {
   throw Lookup_Error(fmt("{} does not support encryption", algo_name()));
   }

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

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

◆ create_kem_decryption_op()

std::unique_ptr< PK_Ops::KEM_Decryption > Botan::Private_Key::create_kem_decryption_op	(	RandomNumberGenerator &	rng,
		std::string_view	params,
		std::string_view	provider
	)		const

virtualinherited

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

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

Parameters

rng	a 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.
params	additional parameters
provider	the provider to use

Reimplemented in Botan::Kyber_PrivateKey, Botan::McEliece_PrivateKey, and Botan::RSA_PrivateKey.

Definition at line 139 of file pk_keys.cpp.

   {
   throw Lookup_Error(fmt("{} does not support KEM decryption", algo_name()));
   }

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

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

◆ create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::Public_Key::create_kem_encryption_op	(	std::string_view	params,
		std::string_view	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

params	additional parameters
provider	the provider to use

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

Definition at line 110 of file pk_keys.cpp.

   {
   throw Lookup_Error(fmt("{} does not support KEM encryption", algo_name()));
   }

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

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

◆ create_key_agreement_op()

std::unique_ptr< PK_Ops::Key_Agreement > Botan::Private_Key::create_key_agreement_op	(	RandomNumberGenerator &	rng,
		std::string_view	params,
		std::string_view	provider
	)		const

virtualinherited

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

Return a key agreement operation for this key/params or throw

Parameters

rng	a 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.
params	additional parameters
provider	the provider to use

Reimplemented in Botan::Curve25519_PrivateKey, Botan::DH_PrivateKey, and Botan::ECDH_PrivateKey.

Definition at line 155 of file pk_keys.cpp.

   {
   throw Lookup_Error(fmt("{} does not support key agreement", algo_name()));
   }

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

◆ create_signature_op()

std::unique_ptr< PK_Ops::Signature > Botan::DSA_PrivateKey::create_signature_op	(	RandomNumberGenerator &	rng,
		std::string_view	params,
		std::string_view	provider
	)		const

overridevirtual

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

Return a signature operation for this key/params or throw

Parameters

rng	a 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.
params	additional parameters
provider	the provider to use

Reimplemented from Botan::Private_Key.

Definition at line 295 of file dsa.cpp.

   {
   if(provider == "base" || provider.empty())
      return std::make_unique<DSA_Signature_Operation>(this->m_private_key, params, rng);
   throw Provider_Not_Found(algo_name(), provider);
   }

References Botan::DSA_PublicKey::algo_name().

◆ create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::DSA_PublicKey::create_verification_op	(	std::string_view	params,
		std::string_view	provider
	)		const

overridevirtualinherited

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

Return a verification operation for this key/params or throw

Parameters

params	additional parameters
provider	the provider to use

Reimplemented from Botan::Public_Key.

Definition at line 276 of file dsa.cpp.

   {
   if(provider == "base" || provider.empty())
      return std::make_unique<DSA_Verification_Operation>(this->m_public_key, params);
   throw Provider_Not_Found(algo_name(), provider);
   }

References Botan::DSA_PublicKey::algo_name().

◆ create_x509_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::DSA_PublicKey::create_x509_verification_op	(	const AlgorithmIdentifier &	signature_algorithm,
		std::string_view	provider
	)		const

overridevirtualinherited

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

Return a verification operation for this combination of key and signature algorithm or throw.

Parameters

signature_algorithm	is the X.509 algorithm identifier encoding the padding scheme and hash hash function used in the signature if applicable.
provider	the provider to use

Reimplemented from Botan::Public_Key.

Definition at line 285 of file dsa.cpp.

   {
   if(provider == "base" || provider.empty())
      return std::make_unique<DSA_Verification_Operation>(this->m_public_key, signature_algorithm);
 
   throw Provider_Not_Found(algo_name(), provider);
   }

References Botan::DSA_PublicKey::algo_name().

◆ default_x509_signature_format()

virtual Signature_Format Botan::Public_Key::default_x509_signature_format ( ) const

inlinevirtualinherited

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 184 of file pk_keys.h.

         {
         return (this->message_parts() >= 2) ? Signature_Format::DerSequence : Signature_Format::Standard;
         }

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

◆ estimated_strength()

size_t Botan::DSA_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::Asymmetric_Key.

Definition at line 27 of file dsa.cpp.

   {
   return m_public_key->estimated_strength();
   }

◆ fingerprint_private()

std::string Botan::Private_Key::fingerprint_private ( std::string_view alg ) const

inherited

Returns: Hash of the PKCS #8 encoding for this key object

Definition at line 96 of file pk_keys.cpp.

   {
   return create_hex_fingerprint(private_key_bits(), hash_algo);
   }

References Botan::create_hex_fingerprint(), 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().

◆ fingerprint_public()

std::string Botan::Public_Key::fingerprint_public ( std::string_view alg = "SHA-256" ) const

inherited

Returns: Hash of the subject public key

Definition at line 88 of file pk_keys.cpp.

   {
   return create_hex_fingerprint(subject_public_key(), hash_algo);
   }

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

◆ get_int_field()

const BigInt & Botan::DSA_PrivateKey::get_int_field ( std::string_view field ) const

overridevirtual

Access an algorithm specific field

If the field is not known for this algorithm, an Invalid_Argument is thrown. The interpretation of the result requires knowledge of which algorithm is involved. For instance for RSA "p" represents one of the secret primes, while for DSA "p" is the public prime.

Some algorithms may not implement this method at all.

This is primarily used to implement the FFI botan_pubkey_get_field and botan_privkey_get_field functions.

Reimplemented from Botan::DSA_PublicKey.

Definition at line 118 of file dsa.cpp.

   {
   return m_private_key->get_int_field(algo_name(), field);
   }

References Botan::DSA_PublicKey::algo_name().

◆ get_oid()

OID Botan::Public_Key::get_oid ( ) const

inlineinherited

Deprecated version of object_identifier

Definition at line 122 of file pk_keys.h.

         {
         return this->object_identifier();
         }

◆ key_length()

size_t Botan::DSA_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 32 of file dsa.cpp.

   {
   return m_public_key->p_bits();
   }

◆ message_part_size()

size_t Botan::DSA_PublicKey::message_part_size ( ) const

overridevirtualinherited

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 22 of file dsa.cpp.

   {
   return m_public_key->group().q_bytes();
   }

◆ message_parts()

size_t Botan::DSA_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 49 of file dsa.h.

49{ return 2; }

◆ object_identifier()

OID Botan::Asymmetric_Key::object_identifier ( ) const

virtualinherited

Get the OID of the underlying public key scheme.

Returns: OID of the public key scheme

Reimplemented in Botan::Dilithium_PublicKey, and Botan::Kyber_PublicKey.

Definition at line 22 of file pk_keys.cpp.

   {
   try
      {
      return OID::from_string(algo_name());
      }
   catch(Lookup_Error&)
      {
      throw Lookup_Error(fmt("Public key algorithm {} has no defined OIDs", algo_name()));
      }
   }

References Botan::Asymmetric_Key::algo_name(), Botan::fmt(), and Botan::OID::from_string().

◆ 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::GOST_3410_PrivateKey.

Definition at line 285 of file pk_keys.h.

286 { return algorithm_identifier(); }

Botan::Public_Key::algorithm_identifier

virtual AlgorithmIdentifier algorithm_identifier() const =0

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

◆ private_key_bits()

secure_vector< uint8_t > Botan::DSA_PrivateKey::private_key_bits ( ) const

overridevirtual

Returns: BER encoded private key bits

Implements Botan::Private_Key.

Definition at line 108 of file dsa.cpp.

   {
   return m_private_key->DER_encode();
   }

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

   {
   const size_t PKCS8_VERSION = 0;
 
   return DER_Encoder()
         .start_sequence()
            .encode(PKCS8_VERSION)
            .encode(pkcs8_algorithm_identifier())
            .encode(private_key_bits(), ASN1_Type::OctetString)
         .end_cons()
      .get_contents();
   }

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::OctetString, Botan::Private_Key::pkcs8_algorithm_identifier(), Botan::Private_Key::private_key_bits(), and Botan::DER_Encoder::start_sequence().

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

◆ public_key()

std::unique_ptr< Public_Key > Botan::DSA_PrivateKey::public_key ( ) const

overridevirtual

Allocate a new object for the public key associated with this private key.

Returns: public key

Implements Botan::Private_Key.

Definition at line 123 of file dsa.cpp.

   {
   // can't use make_unique here due to private constructor
   return std::unique_ptr<DSA_PublicKey>(new DSA_PublicKey(m_public_key));
   }

◆ public_key_bits()

std::vector< uint8_t > Botan::DSA_PublicKey::public_key_bits ( ) const

overridevirtualinherited

Returns: BER encoded public key bits

Implements Botan::Public_Key.

Definition at line 49 of file dsa.cpp.

   {
   return m_public_key->DER_encode();
   }

◆ raw_private_key_bits()

secure_vector< uint8_t > Botan::DSA_PrivateKey::raw_private_key_bits ( ) const

overridevirtual

Returns: binary private key bits, with no additional encoding

Note: some algorithms (for example RSA) do not have an obvious encoding for this value due to having many different values, and thus not implement this function. The default implementation throws Not_Implemented

Reimplemented from Botan::Private_Key.

Definition at line 113 of file dsa.cpp.

   {
   return m_private_key->raw_private_key_bits();
   }

◆ stateful_operation()

virtual bool Botan::Private_Key::stateful_operation ( ) const

inlinevirtualinherited

Indicates if this key is stateful, ie that performing a private key operation requires updating the key storage.

Reimplemented in Botan::XMSS_PrivateKey.

Definition at line 292 of file pk_keys.h.

292{ return false; }

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

   {
   std::vector<uint8_t> output;
 
   DER_Encoder(output).start_sequence()
         .encode(algorithm_identifier())
         .encode(public_key_bits(), ASN1_Type::BitString)
      .end_cons();
 
   return output;
   }

References Botan::Public_Key::algorithm_identifier(), Botan::BitString, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::Public_Key::public_key_bits(), and Botan::DER_Encoder::start_sequence().

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

◆ supports_operation()

bool Botan::DSA_PublicKey::supports_operation ( PublicKeyOperation op ) const

inlineoverridevirtualinherited

Return true if this key could be used for the specified type of operation.

Implements Botan::Asymmetric_Key.

Definition at line 27 of file dsa.h.

         {
         return (op == PublicKeyOperation::Signature);
         }

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

src/lib/pubkey/dsa/dsa.h
src/lib/pubkey/dsa/dsa.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DSA_PrivateKey() [1/3]

◆ DSA_PrivateKey() [2/3]

◆ DSA_PrivateKey() [3/3]

Member Function Documentation

◆ algo_name()

◆ algorithm_identifier()

◆ check_key()

◆ create_decryption_op()

◆ create_encryption_op()

◆ create_kem_decryption_op()

◆ create_kem_encryption_op()

◆ create_key_agreement_op()

◆ create_signature_op()

◆ create_verification_op()

◆ create_x509_verification_op()

◆ default_x509_signature_format()

◆ estimated_strength()

◆ fingerprint_private()

◆ fingerprint_public()

◆ get_int_field()

◆ get_oid()

◆ key_length()

◆ message_part_size()

◆ message_parts()

◆ object_identifier()

◆ pkcs8_algorithm_identifier()

◆ private_key_bits()

◆ private_key_info()

◆ public_key()

◆ public_key_bits()

◆ raw_private_key_bits()

◆ stateful_operation()

◆ subject_public_key()

◆ supports_operation()