An SLH-DSA private key. More...

#include <sphincsplus.h>

Inheritance diagram for Botan::SphincsPlus_PrivateKey:

Public Member Functions
virtual Signature_Format	_default_x509_signature_format () const

virtual std::optional< size_t >	_signature_element_size_for_DER_encoding () const

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

Signature_Format	default_x509_signature_format () const

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

std::unique_ptr< Private_Key >	generate_another (RandomNumberGenerator &rng) const final

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

OID	get_oid () const

size_t	key_length () const override

size_t	message_part_size () const

size_t	message_parts () const

OID	object_identifier () const override

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

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

virtual std::optional< uint64_t >	remaining_operations () const
	Retrieves the number of remaining operations if this is a stateful private key.

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

	SphincsPlus_PrivateKey (RandomNumberGenerator &rng, Sphincs_Parameter_Set type, Sphincs_Hash_Type hash)

	SphincsPlus_PrivateKey (RandomNumberGenerator &rng, Sphincs_Parameters params)

	SphincsPlus_PrivateKey (std::span< const uint8_t > private_key, Sphincs_Parameter_Set type, Sphincs_Hash_Type hash)

	SphincsPlus_PrivateKey (std::span< const uint8_t > private_key, Sphincs_Parameters params)

virtual bool	stateful_operation () const

std::vector< uint8_t >	subject_public_key () const

bool	supports_operation (PublicKeyOperation op) const override

	~SphincsPlus_PrivateKey () override

Protected Attributes
std::shared_ptr< SphincsPlus_PublicKeyInternal >	m_public

Detailed Description

An SLH-DSA private key.

This class represents an SLH-DSA private key (or a SPHINCS+ Round 3.1 private key). Supported are all parameter sets defined in FIPS 205, Section 11. Parameter sets are specified using the Sphincs_Parameter_Set and Sphincs_Hash_Type enums, for example SLH-DSA-SHA2-128s is defined as Sphincs_Parameter_Set::SLHDSA128Small and Sphincs_Hash_Type::Sha256.

For legacy usage of SPHINCS+ Round 3 (not recommended), the parameter sets Sphincs128Small, ..., Sphincs256Fast are used.

Note that the parameter sets denoted as 'small' optimize for signature size at the expense of signing speed, whereas 'fast' trades larger signatures for faster signing speeds.

This implementation is based on the SPHINCS+ https://github.com/sphincs/sphincsplus/commit/06f42f47491085ac879a72b486ca8edb10891963 which implements SPHINCS+ Specification Round 3.1 (https://sphincs.org/data/sphincs+-r3.1-specification.pdf). The used tweaked hashes are implemented according to the variant 'simple' ('robust' is not supported).

Definition at line 90 of file sphincsplus.h.

Constructor & Destructor Documentation

◆ SphincsPlus_PrivateKey() [1/5]

Botan::SphincsPlus_PrivateKey::SphincsPlus_PrivateKey	(	std::span< const uint8_t >	private_key,
		Sphincs_Parameter_Set	type,
		Sphincs_Hash_Type	hash )

Definition at line 285 of file sphincsplus.cpp.

287 :

288 SphincsPlus_PrivateKey(private_key, Sphincs_Parameters::create(type, hash)) {}

Botan::SphincsPlus_PrivateKey::SphincsPlus_PrivateKey

SphincsPlus_PrivateKey(std::span< const uint8_t > private_key, Sphincs_Parameter_Set type, Sphincs_Hash_Type hash)

Definition sphincsplus.cpp:285

Botan::Sphincs_Parameters::create

static Sphincs_Parameters create(Sphincs_Parameter_Set set, Sphincs_Hash_Type hash)

Definition sp_parameters.cpp:349

◆ SphincsPlus_PrivateKey() [2/5]

Botan::SphincsPlus_PrivateKey::SphincsPlus_PrivateKey	(	std::span< const uint8_t >	private_key,
		Sphincs_Parameters	params )

Definition at line 293 of file sphincsplus.cpp.

                                                                                                            :
      SphincsPlus_PublicKey(slice_off_public_key(params.object_identifier(), private_key), params) {
   if(!params.is_available()) {
      throw Not_Implemented("This SPHINCS+ parameter set is not available in this configuration");
   }
 
   const auto private_portion_bytes = params.private_key_bytes() - params.public_key_bytes();
   BOTAN_ASSERT_NOMSG(private_key.size() >= private_portion_bytes);
 
   m_private = std::make_shared<SphincsPlus_PrivateKeyInternal>(params, private_key.first(private_portion_bytes));
}

References BOTAN_ASSERT_NOMSG, Botan::Sphincs_Parameters::is_available(), Botan::Sphincs_Parameters::private_key_bytes(), and Botan::Sphincs_Parameters::public_key_bytes().

◆ SphincsPlus_PrivateKey() [3/5]

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

Definition at line 290 of file sphincsplus.cpp.

290 :

291 SphincsPlus_PrivateKey(key_bits, Sphincs_Parameters::create(alg_id.oid())) {}

◆ SphincsPlus_PrivateKey() [4/5]

Botan::SphincsPlus_PrivateKey::SphincsPlus_PrivateKey	(	RandomNumberGenerator &	rng,
		Sphincs_Parameter_Set	type,
		Sphincs_Hash_Type	hash )

Definition at line 305 of file sphincsplus.cpp.

307 :

308 SphincsPlus_PrivateKey(rng, Sphincs_Parameters::create(type, hash)) {}

◆ SphincsPlus_PrivateKey() [5/5]

Botan::SphincsPlus_PrivateKey::SphincsPlus_PrivateKey	(	RandomNumberGenerator &	rng,
		Sphincs_Parameters	params )

Definition at line 311 of file sphincsplus.cpp.

                                                                                                    {
   if(!params.is_available()) {
      throw Not_Implemented("This SPHINCS+ parameter set is not available in this configuration");
   }
   auto sk_seed = rng.random_vec<SphincsSecretSeed>(params.n());
   auto sk_prf = rng.random_vec<SphincsSecretPRF>(params.n());
 
   m_private = std::make_shared<SphincsPlus_PrivateKeyInternal>(std::move(sk_seed), std::move(sk_prf));
 
   auto pub_seed = rng.random_vec<SphincsPublicSeed>(params.n());
   auto hashes = Sphincs_Hash_Functions::create(params, pub_seed);
   auto root = xmss_gen_root(params, m_private->seed(), *hashes);
 
   m_public = std::make_shared<SphincsPlus_PublicKeyInternal>(params, std::move(pub_seed), std::move(root));
}

References Botan::Sphincs_Hash_Functions::create(), Botan::Sphincs_Parameters::is_available(), Botan::SphincsPlus_PublicKey::m_public, Botan::Sphincs_Parameters::n(), Botan::RandomNumberGenerator::random_vec(), Botan::root(), and Botan::xmss_gen_root().

◆ ~SphincsPlus_PrivateKey()

Botan::SphincsPlus_PrivateKey::~SphincsPlus_PrivateKey ( )

overridedefault

Member Function Documentation

◆ _default_x509_signature_format()

Signature_Format Botan::Asymmetric_Key::_default_x509_signature_format ( ) const

virtualinherited

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 30 of file pk_keys.cpp.

                                                                      {
   if(_signature_element_size_for_DER_encoding()) {
      return Signature_Format::DerSequence;
   } else {
      return Signature_Format::Standard;
   }
}

References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), Botan::DerSequence, and Botan::Standard.

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

◆ _signature_element_size_for_DER_encoding()

virtual std::optional< size_t > Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding ( ) const

inlinevirtualinherited

Certain signatures schemes such as ECDSA have more than one element, and certain unfortunate protocols decided the thing to do was not concatenate them as normally done, but instead DER encode each of the elements as independent values.

If this returns a value x then the signature is checked to be exactly 2*x bytes and split in half for DER encoding.

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

Definition at line 136 of file pk_keys.h.

136{ return {}; }

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

◆ algo_name()

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

overridevirtualinherited

Get the name of the underlying public key scheme.

Returns: name of the public key scheme

Implements Botan::Asymmetric_Key.

Definition at line 146 of file sphincsplus.cpp.

146 {

147 return m_public->parameters().is_slh_dsa() ? "SLH-DSA" : "SPHINCS+";

148}

References Botan::SphincsPlus_PublicKey::m_public.

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

◆ algorithm_identifier()

AlgorithmIdentifier Botan::SphincsPlus_PublicKey::algorithm_identifier ( ) const

overridevirtualinherited

Returns: X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 154 of file sphincsplus.cpp.

154 {

155 return m_public->parameters().algorithm_identifier();

156}

References Botan::SphincsPlus_PublicKey::m_public, and Botan::AlgorithmIdentifier::parameters().

Referenced by Botan::SphincsPlus_PublicKey::create_x509_verification_op().

◆ check_key()

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

overridevirtualinherited

Implements Botan::Asymmetric_Key.

Definition at line 162 of file sphincsplus.cpp.

162 {

163 // Nothing to check. It's literally just hashes. :-)

164 return true;

165}

◆ 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, Botan::SM2_PrivateKey, and Botan::TPM2::RSA_PrivateKey.

Definition at line 119 of file pk_keys.cpp.

121 {

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

123}

Botan::Asymmetric_Key::algo_name

virtual std::string algo_name() const =0

Botan::fmt

std::string fmt(std::string_view format, const T &... args)

Definition fmt.h:53

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, Botan::SM2_PublicKey, and Botan::TPM2::RSA_PublicKey.

Definition at line 98 of file pk_keys.cpp.

100 {

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

102}

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::Classic_McEliece_PrivateKey, Botan::FrodoKEM_PrivateKey, Botan::Kyber_PrivateKey, Botan::McEliece_PrivateKey, Botan::RSA_PrivateKey, Botan::TLS::Hybrid_KEM_PrivateKey, and Botan::TLS::KEX_to_KEM_Adapter_PrivateKey.

Definition at line 125 of file pk_keys.cpp.

127 {

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

129}

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::Classic_McEliece_PublicKey, Botan::FrodoKEM_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::TLS::Hybrid_KEM_PublicKey, and Botan::TLS::KEX_to_KEM_Adapter_PublicKey.

Definition at line 104 of file pk_keys.cpp.

105 {

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

107}

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::DH_PrivateKey, Botan::ECDH_PrivateKey, Botan::X25519_PrivateKey, and Botan::X448_PrivateKey.

Definition at line 137 of file pk_keys.cpp.

139 {

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

141}

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

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

◆ create_signature_op()

std::unique_ptr< PK_Ops::Signature > Botan::SphincsPlus_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 430 of file sphincsplus.cpp.

                                                                                                              {
   BOTAN_UNUSED(rng);
   BOTAN_ARG_CHECK(params.empty() || params == "Deterministic" || params == "Randomized",
                   "Unexpected parameters for signing with SLH-DSA (or SPHINCS+)");
 
   // FIPS 205, Section 9.2
   //   The hedged variant is the default and should be used on platforms where
   //   side-channel attacks are a concern.
   const bool randomized = (params.empty() || params == "Randomized");
   if(provider.empty() || provider == "base") {
      return std::make_unique<SphincsPlus_Signature_Operation>(m_private, m_public, randomized);
   }
   throw Provider_Not_Found(algo_name(), provider);
}

References Botan::SphincsPlus_PublicKey::algo_name(), BOTAN_ARG_CHECK, BOTAN_UNUSED, and Botan::SphincsPlus_PublicKey::m_public.

◆ create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::SphincsPlus_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 244 of file sphincsplus.cpp.

                                                                                                                   {
   if(provider.empty() || provider == "base") {
      return std::make_unique<SphincsPlus_Verification_Operation>(m_public);
   }
   throw Provider_Not_Found(algo_name(), provider);
}

References Botan::SphincsPlus_PublicKey::algo_name(), and Botan::SphincsPlus_PublicKey::m_public.

◆ create_x509_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::SphincsPlus_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 252 of file sphincsplus.cpp.

                                                                                  {
   if(provider.empty() || provider == "base") {
      if(signature_algorithm != this->algorithm_identifier()) {
         throw Decoding_Error("Unexpected AlgorithmIdentifier for SLH-DSA (or SPHINCS+) signature");
      }
      return std::make_unique<SphincsPlus_Verification_Operation>(m_public);
   }
   throw Provider_Not_Found(algo_name(), provider);
}

References Botan::SphincsPlus_PublicKey::algo_name(), Botan::SphincsPlus_PublicKey::algorithm_identifier(), and Botan::SphincsPlus_PublicKey::m_public.

◆ default_x509_signature_format()

Signature_Format Botan::Public_Key::default_x509_signature_format ( ) const

inlineinherited

Definition at line 227 of file pk_keys.h.

227 {

228 return _default_x509_signature_format();

229 }

Botan::Asymmetric_Key::_default_x509_signature_format

virtual Signature_Format _default_x509_signature_format() const

Definition pk_keys.cpp:30

◆ estimated_strength()

size_t Botan::SphincsPlus_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 150 of file sphincsplus.cpp.

150 {

151 return m_public->parameters().bitsec();

152}

References Botan::SphincsPlus_PublicKey::m_public.

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

94 {

95 return create_hex_fingerprint(private_key_bits(), hash_algo);

96}

Botan::Private_Key::private_key_bits

virtual secure_vector< uint8_t > private_key_bits() const =0

Botan::create_hex_fingerprint

std::string create_hex_fingerprint(const uint8_t bits[], size_t bits_len, std::string_view hash_name)

Definition pk_keys.cpp:38

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

87 {

88 return create_hex_fingerprint(subject_public_key(), hash_algo);

89}

Botan::Public_Key::subject_public_key

std::vector< uint8_t > subject_public_key() const

Definition pk_keys.cpp:56

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

◆ generate_another()

std::unique_ptr< Private_Key > Botan::SphincsPlus_PublicKey::generate_another ( RandomNumberGenerator & rng ) const

finalvirtualinherited

Generate another (cryptographically independent) key pair using the same algorithm parameters as this key. This is most useful for algorithms that support PublicKeyOperation::KeyAgreement to generate a fitting ephemeral key pair. For other key types it might throw Not_Implemented.

Implements Botan::Asymmetric_Key.

Definition at line 177 of file sphincsplus.cpp.

177 {

178 return std::make_unique<SphincsPlus_PrivateKey>(rng, m_public->parameters());

179}

References Botan::SphincsPlus_PublicKey::m_public.

◆ get_int_field()

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

virtualinherited

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.

TODO(Botan4) Change this to return by value

Reimplemented in Botan::DH_PrivateKey, Botan::DH_PublicKey, Botan::DSA_PrivateKey, Botan::DSA_PublicKey, Botan::EC_PrivateKey, Botan::EC_PublicKey, Botan::ElGamal_PrivateKey, Botan::ElGamal_PublicKey, Botan::RSA_PrivateKey, and Botan::RSA_PublicKey.

Definition at line 18 of file pk_keys.cpp.

18 {

19 throw Unknown_PK_Field_Name(algo_name(), field);

20}

References Botan::Asymmetric_Key::algo_name().

Referenced by Botan::EC_PublicKey::get_int_field(), and Botan::RSA_PublicKey::get_int_field().

◆ get_oid()

OID Botan::Public_Key::get_oid ( ) const

inlineinherited

Deprecated version of object_identifier

Definition at line 160 of file pk_keys.h.

160{ return this->object_identifier(); }

Botan::Asymmetric_Key::object_identifier

virtual OID object_identifier() const

Definition pk_keys.cpp:22

◆ key_length()

size_t Botan::SphincsPlus_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 142 of file sphincsplus.cpp.

142 {

143 return m_public->parameters().n() * 8;

144}

References Botan::SphincsPlus_PublicKey::m_public.

◆ message_part_size()

size_t Botan::Public_Key::message_part_size ( ) const

inlineinherited

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

Definition at line 220 of file pk_keys.h.

220 {

221 return _signature_element_size_for_DER_encoding().value_or(0);

222 }

◆ message_parts()

size_t Botan::Public_Key::message_parts ( ) const

inlineinherited

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

Definition at line 207 of file pk_keys.h.

207 {

208 return _signature_element_size_for_DER_encoding() ? 2 : 1;

209 }

◆ object_identifier()

OID Botan::SphincsPlus_PublicKey::object_identifier ( ) const

overridevirtualinherited

Get the OID of the underlying public key scheme.

Returns: OID of the public key scheme

Reimplemented from Botan::Asymmetric_Key.

Definition at line 158 of file sphincsplus.cpp.

158 {

159 return m_public->parameters().object_identifier();

160}

References Botan::SphincsPlus_PublicKey::m_public.

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

Definition at line 322 of file pk_keys.h.

322{ 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::SphincsPlus_PrivateKey::private_key_bits ( ) const

overridevirtual

Returns: BER encoded private key bits

Implements Botan::Private_Key.

Definition at line 329 of file sphincsplus.cpp.

329 {

330 return concat(m_private->key_bits(), m_public->key_bits());

331}

Botan::concat

constexpr auto concat(Rs &&... ranges)

Definition stl_util.h:263

References Botan::concat(), and Botan::SphincsPlus_PublicKey::m_public.

Referenced by raw_private_key_bits().

◆ 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 68 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::SphincsPlus_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 337 of file sphincsplus.cpp.

337 {

338 return std::make_unique<SphincsPlus_PublicKey>(*this);

339}

◆ public_key_bits()

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

overridevirtualinherited

Returns: BER encoded public key bits

Implements Botan::Public_Key.

Definition at line 171 of file sphincsplus.cpp.

                                                                {
   // Currently, there isn't a finalized definition of an ASN.1 structure for
   // SLH-DSA or SPHINCS+ public keys. Therefore, we return the raw public key bits.
   return raw_public_key_bits();
}

References Botan::SphincsPlus_PublicKey::raw_public_key_bits().

◆ raw_private_key_bits()

secure_vector< uint8_t > Botan::SphincsPlus_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 333 of file sphincsplus.cpp.

333 {

334 return this->private_key_bits();

335}

Botan::SphincsPlus_PrivateKey::private_key_bits

secure_vector< uint8_t > private_key_bits() const override

Definition sphincsplus.cpp:329

References private_key_bits().

◆ raw_public_key_bits()

std::vector< uint8_t > Botan::SphincsPlus_PublicKey::raw_public_key_bits ( ) const

overridevirtualinherited

Returns: binary public key bits, with no additional encoding

For key agreements this is an alias for PK_Key_Agreement_Key::public_value.

Note: some algorithms (for example RSA) do not have an obvious encoding for this value due to having many different values, and thus throw Not_Implemented when invoking this method.

Implements Botan::Public_Key.

Definition at line 167 of file sphincsplus.cpp.

167 {

168 return m_public->key_bits();

169}

References Botan::SphincsPlus_PublicKey::m_public.

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

◆ remaining_operations()

virtual std::optional< uint64_t > Botan::Private_Key::remaining_operations ( ) const

inlinevirtualinherited

Retrieves the number of remaining operations if this is a stateful private key.

Returns: the number of remaining operations or std::nullopt if not applicable.

Reimplemented in Botan::HSS_LMS_PrivateKey, and Botan::XMSS_PrivateKey.

Definition at line 335 of file pk_keys.h.

335{ return std::nullopt; }

◆ 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::HSS_LMS_PrivateKey, and Botan::XMSS_PrivateKey.

Definition at line 328 of file pk_keys.h.

328{ 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 56 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::SphincsPlus_PublicKey::supports_operation ( PublicKeyOperation op ) const

overridevirtualinherited

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

Implements Botan::Asymmetric_Key.

Definition at line 263 of file sphincsplus.cpp.

263 {

264 return op == PublicKeyOperation::Signature;

265}

Botan::PublicKeyOperation::Signature

@ Signature

References Botan::Signature.

Member Data Documentation

◆ m_public

std::shared_ptr<SphincsPlus_PublicKeyInternal> Botan::SphincsPlus_PublicKey::m_public

protectedinherited

Definition at line 63 of file sphincsplus.h.

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

src/lib/pubkey/sphincsplus/sphincsplus_common/sphincsplus.h
src/lib/pubkey/sphincsplus/sphincsplus_common/sphincsplus.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SphincsPlus_PrivateKey() [1/5]

◆ SphincsPlus_PrivateKey() [2/5]

◆ SphincsPlus_PrivateKey() [3/5]

◆ SphincsPlus_PrivateKey() [4/5]

◆ SphincsPlus_PrivateKey() [5/5]

◆ ~SphincsPlus_PrivateKey()

Member Function Documentation

◆ _default_x509_signature_format()

◆ _signature_element_size_for_DER_encoding()

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

◆ generate_another()

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

◆ raw_public_key_bits()

◆ remaining_operations()

◆ stateful_operation()

◆ subject_public_key()

◆ supports_operation()

Member Data Documentation

◆ m_public