An SLH-DSA (or SPHINCS+ Round 3.1) public key. More...

#include <sphincsplus.h>

Inheritance diagram for Botan::SphincsPlus_PublicKey:

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::Encryption >	create_encryption_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

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

size_t	estimated_strength () const override

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

virtual size_t	message_part_size () const

virtual size_t	message_parts () const

OID	object_identifier () const override

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

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

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

	SphincsPlus_PublicKey (std::span< const uint8_t > pub_key, Sphincs_Parameter_Set type, Sphincs_Hash_Type hash)

	SphincsPlus_PublicKey (std::span< const uint8_t > pub_key, Sphincs_Parameters params)

std::vector< uint8_t >	subject_public_key () const

bool	supports_operation (PublicKeyOperation op) const override

	~SphincsPlus_PublicKey () override

Protected Member Functions
	SphincsPlus_PublicKey ()=default

Protected Attributes
std::shared_ptr< SphincsPlus_PublicKeyInternal >	m_public

Detailed Description

An SLH-DSA (or SPHINCS+ Round 3.1) public key.

For more information see the documentation of SphincsPlus_PrivateKey.

Definition at line 31 of file sphincsplus.h.

Constructor & Destructor Documentation

◆ SphincsPlus_PublicKey() [1/4]

Botan::SphincsPlus_PublicKey::SphincsPlus_PublicKey	(	std::span< const uint8_t >	pub_key,
		Sphincs_Parameter_Set	type,
		Sphincs_Hash_Type	hash )

Definition at line 125 of file sphincsplus.cpp.

127 :

128 SphincsPlus_PublicKey(pub_key, Sphincs_Parameters::create(type, hash)) {}

Botan::SphincsPlus_PublicKey::SphincsPlus_PublicKey

SphincsPlus_PublicKey()=default

Botan::Sphincs_Parameters::create

static Sphincs_Parameters create(Sphincs_Parameter_Set set, Sphincs_Hash_Type hash)

Definition sp_parameters.cpp:349

◆ SphincsPlus_PublicKey() [2/4]

Botan::SphincsPlus_PublicKey::SphincsPlus_PublicKey	(	std::span< const uint8_t >	pub_key,
		Sphincs_Parameters	params )

Definition at line 130 of file sphincsplus.cpp.

                                                                                                      :
      m_public(std::make_shared<SphincsPlus_PublicKeyInternal>(params, pub_key)) {
   BOTAN_ARG_CHECK(params.is_available(),
                   "The selected parameter-set-hash combination is not activated in this build.");
}

References BOTAN_ARG_CHECK, and Botan::Sphincs_Parameters::is_available().

◆ SphincsPlus_PublicKey() [3/4]

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

Definition at line 136 of file sphincsplus.cpp.

136 :

137 SphincsPlus_PublicKey(key_bits, Sphincs_Parameters::create(alg_id.oid())) {}

◆ ~SphincsPlus_PublicKey()

Botan::SphincsPlus_PublicKey::~SphincsPlus_PublicKey ( )

overridedefault

◆ SphincsPlus_PublicKey() [4/4]

Botan::SphincsPlus_PublicKey::SphincsPlus_PublicKey ( )

protecteddefault

Member Function Documentation

◆ algo_name()

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

overridevirtual

Get the name of the underlying public key scheme.

Returns: name of the public key scheme

Implements Botan::Asymmetric_Key.

Definition at line 145 of file sphincsplus.cpp.

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

References m_public.

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

◆ algorithm_identifier()

AlgorithmIdentifier Botan::SphincsPlus_PublicKey::algorithm_identifier ( ) const

overridevirtual

Returns: X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 153 of file sphincsplus.cpp.

                                                                      {
   return m_public->parameters().algorithm_identifier();
}

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

Referenced by create_x509_verification_op().

◆ check_key()

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

overridevirtual

Implements Botan::Public_Key.

Definition at line 161 of file sphincsplus.cpp.

                                                                        {
   // Nothing to check. It's literally just hashes. :-)
   return true;
}

◆ 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 90 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_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::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 96 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_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::SphincsPlus_PublicKey::create_verification_op	(	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 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 241 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 algo_name(), and 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

overridevirtual

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 249 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 algo_name(), algorithm_identifier(), and m_public.

◆ 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 201 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::SphincsPlus_PublicKey::estimated_strength ( ) const

overridevirtual

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 149 of file sphincsplus.cpp.

                                                       {
   return m_public->parameters().bitsec();
}

References m_public.

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

◆ generate_another()

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

finalvirtual

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 176 of file sphincsplus.cpp.

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

References 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.

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.

                                                                      {
   throw Unknown_PK_Field_Name(algo_name(), field);
}

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 132 of file pk_keys.h.

132{ 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

overridevirtual

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 141 of file sphincsplus.cpp.

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

References m_public.

◆ message_part_size()

virtual size_t Botan::Public_Key::message_part_size ( ) const

inlinevirtualinherited

Returns how large each of the message parts refered to by message_parts() is

This function is public but applications should have few reasons to ever call this.

Returns: size of the message parts in bits

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

Definition at line 199 of file pk_keys.h.

199{ return 0; }

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

◆ message_parts()

virtual size_t Botan::Public_Key::message_parts ( ) const

inlinevirtualinherited

Returns more than 1 if the output of this algorithm (ciphertext, signature) should be treated as more than one value. This is used for algorithms like DSA and ECDSA, where the (r,s) output pair can be encoded as either a plain binary list or a TLV tagged DER encoding depending on the protocol.

This function is public but applications should have few reasons to ever call this.

Returns: number of message parts

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

Definition at line 188 of file pk_keys.h.

188{ return 1; }

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

◆ object_identifier()

OID Botan::SphincsPlus_PublicKey::object_identifier ( ) const

overridevirtual

Get the OID of the underlying public key scheme.

Returns: OID of the public key scheme

Reimplemented from Botan::Asymmetric_Key.

Definition at line 157 of file sphincsplus.cpp.

                                                   {
   return m_public->parameters().object_identifier();
}

References m_public.

◆ public_key_bits()

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

overridevirtual

Returns: BER encoded public key bits

Implements Botan::Public_Key.

Definition at line 170 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 raw_public_key_bits().

◆ raw_public_key_bits()

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

overridevirtual

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 166 of file sphincsplus.cpp.

                                                                    {
   return m_public->key_bits();
}

References m_public.

Referenced by public_key_bits().

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

overridevirtual

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

Implements Botan::Asymmetric_Key.

Definition at line 260 of file sphincsplus.cpp.

                                                                          {
   return op == PublicKeyOperation::Signature;
}

References Botan::Signature.

Member Data Documentation

◆ m_public

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

protected

Definition at line 63 of file sphincsplus.h.

Referenced by algo_name(), algorithm_identifier(), Botan::SphincsPlus_PrivateKey::create_signature_op(), create_verification_op(), create_x509_verification_op(), estimated_strength(), generate_another(), key_length(), object_identifier(), Botan::SphincsPlus_PrivateKey::private_key_bits(), raw_public_key_bits(), and Botan::SphincsPlus_PrivateKey::SphincsPlus_PrivateKey().

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 Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SphincsPlus_PublicKey() [1/4]

◆ SphincsPlus_PublicKey() [2/4]

◆ SphincsPlus_PublicKey() [3/4]

◆ ~SphincsPlus_PublicKey()

◆ SphincsPlus_PublicKey() [4/4]

Member Function Documentation

◆ algo_name()

◆ algorithm_identifier()

◆ check_key()

◆ create_encryption_op()

◆ create_kem_encryption_op()

◆ create_verification_op()

◆ create_x509_verification_op()

◆ default_x509_signature_format()

◆ estimated_strength()

◆ fingerprint_public()

◆ generate_another()

◆ get_int_field()

◆ get_oid()

◆ key_length()

◆ message_part_size()

◆ message_parts()

◆ object_identifier()

◆ public_key_bits()

◆ raw_public_key_bits()

◆ subject_public_key()

◆ supports_operation()

Member Data Documentation

◆ m_public