Botan 3.14.1
Crypto and TLS for C&
Botan::XMSS_PublicKey Class Reference

#include <xmss.h>

Inheritance diagram for Botan::XMSS_PublicKey:
Botan::Public_Key Botan::Asymmetric_Key Botan::XMSS_PrivateKey

Public Member Functions

virtual std::unique_ptr< PK_Ops::Encryption > _create_encryption_op (RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const
virtual std::unique_ptr< PK_Ops::KEM_Encryption > _create_kem_encryption_op (const PK_KEM_Options_Reader &options) const
std::unique_ptr< PK_Ops::Verification > _create_verification_op (const PK_Signature_Options_Reader &options) const override
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
std::unique_ptr< PK_Ops::Encryption > create_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
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
std::unique_ptr< PK_Ops::Verification > create_x509_verification_op (const AlgorithmIdentifier &alg_id, std::string_view provider) const override
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
size_t message_part_size () const
size_t message_parts () const
virtual OID object_identifier () const
std::vector< uint8_t > public_key_bits () const override
std::vector< uint8_t > raw_public_key () const
std::vector< uint8_t > raw_public_key_bits () const override
std::vector< uint8_t > subject_public_key () const
bool supports_operation (PublicKeyOperation op) const override
 XMSS_PublicKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits)
BOTAN_FUTURE_EXPLICIT XMSS_PublicKey (std::span< const uint8_t > key_bits)
 XMSS_PublicKey (XMSS_Parameters::xmss_algorithm_t xmss_oid, RandomNumberGenerator &rng)
 XMSS_PublicKey (XMSS_Parameters::xmss_algorithm_t xmss_oid, secure_vector< uint8_t > root, secure_vector< uint8_t > public_seed)

Protected Types

enum class  Key_Encoding : uint8_t { PublicKey , PrivateKey }

Protected Member Functions

const secure_vector< uint8_t > & public_seed () const
const secure_vector< uint8_t > & root () const
const XMSS_Parameters & xmss_parameters () const
 XMSS_PublicKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits, Key_Encoding encoding)

Friends

class XMSS_Verification_Operation

Detailed Description

An XMSS: Extended Hash-Based Signature public key.

[1] XMSS: Extended Hash-Based Signatures, Request for Comments: 8391 Release: May 2018. https://datatracker.ietf.org/doc/rfc8391/

Definition at line 36 of file xmss.h.

Member Enumeration Documentation

◆ Key_Encoding

enum class Botan::XMSS_PublicKey::Key_Encoding : uint8_t
strongprotected

Which key the serialization in key_bits holds. A private key encoding carries the public key followed by the private key body.

Enumerator
PublicKey 
PrivateKey 

Definition at line 129 of file xmss.h.

Constructor & Destructor Documentation

◆ XMSS_PublicKey() [1/5]

Botan::XMSS_PublicKey::XMSS_PublicKey ( XMSS_Parameters::xmss_algorithm_t xmss_oid,
RandomNumberGenerator & rng )

Creates an XMSS public key with a random public seed and an all-zero root. No private key corresponds to this public key, so it cannot be used to verify signatures. To generate a new key use XMSS_PrivateKey.

Parameters
xmss_oidIdentifier for the selected XMSS signature method.
Random Number GeneratorsA random number generator used to create the public seed.

Definition at line 102 of file xmss_publickey.cpp.

102 {
103 const auto params = XMSS_Parameters::from_id(xmss_oid);
104 m_public_key = std::make_shared<XMSS_PublicKey_Internal>(
105 params, secure_vector<uint8_t>(params.element_size()), rng.random_vec(params.element_size()));
106}
static XMSS_Parameters from_id(xmss_algorithm_t id)
std::vector< T, secure_allocator< T > > secure_vector
Definition secmem.h:128

References Botan::XMSS_Parameters::from_id(), and Botan::RandomNumberGenerator::random_vec().

Referenced by Botan::XMSS_PrivateKey::XMSS_PrivateKey(), Botan::XMSS_PrivateKey::XMSS_PrivateKey(), XMSS_PublicKey(), and XMSS_PublicKey().

◆ XMSS_PublicKey() [2/5]

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

Loads a public key from an X.509 SubjectPublicKeyInfo.

Public key must be encoded as in draft-vangeest-x509-hash-sigs-03.

Parameters
alg_idthe X.509 AlgorithmIdentifier
key_bitsDER encoded public key bits

Definition at line 110 of file xmss_publickey.cpp.

110 :
111 XMSS_PublicKey(alg_id, key_bits, Key_Encoding::PublicKey) {}
XMSS_PublicKey(XMSS_Parameters::xmss_algorithm_t xmss_oid, RandomNumberGenerator &rng)

References XMSS_PublicKey().

◆ XMSS_PublicKey() [3/5]

Botan::XMSS_PublicKey::XMSS_PublicKey ( std::span< const uint8_t > key_bits)

Loads a public key.

Public key must be encoded as in draft-vangeest-x509-hash-sigs-03.

Parameters
key_bitsDER encoded public key bits

Definition at line 108 of file xmss_publickey.cpp.

108: XMSS_PublicKey(AlgorithmIdentifier(), key_bits) {}

References XMSS_PublicKey().

◆ XMSS_PublicKey() [4/5]

Botan::XMSS_PublicKey::XMSS_PublicKey ( XMSS_Parameters::xmss_algorithm_t xmss_oid,
secure_vector< uint8_t > root,
secure_vector< uint8_t > public_seed )

Creates a new XMSS public key for a chosen XMSS signature method as well as pre-computed root node and public_seed values.

Parameters
xmss_oidIdentifier for the selected XMSS signature method.
rootRoot node value.
public_seedPublic seed value.

Definition at line 143 of file xmss_publickey.cpp.

145 {
146 const auto params = XMSS_Parameters::from_id(xmss_oid);
147 BOTAN_ARG_CHECK(root.size() == params.element_size(), "XMSS: unexpected byte length of root hash");
148 BOTAN_ARG_CHECK(public_seed.size() == params.element_size(), "XMSS: unexpected byte length of public seed");
149 m_public_key = std::make_shared<XMSS_PublicKey_Internal>(params, std::move(root), std::move(public_seed));
150}
#define BOTAN_ARG_CHECK(expr, msg)
Definition assert.h:33
const secure_vector< uint8_t > & root() const
const secure_vector< uint8_t > & public_seed() const

References BOTAN_ARG_CHECK, Botan::XMSS_Parameters::from_id(), public_seed(), and root().

◆ XMSS_PublicKey() [5/5]

Botan::XMSS_PublicKey::XMSS_PublicKey ( const AlgorithmIdentifier & alg_id,
std::span< const uint8_t > key_bits,
Key_Encoding encoding )
protected

Definition at line 113 of file xmss_publickey.cpp.

115 {
116 // The XMSS parameter set is carried in the key bits; no AlgorithmIdentifier parameters are defined
117 if(!alg_id.parameters_are_empty()) {
118 throw Decoding_Error("Unexpected parameters for XMSS public key");
119 }
120
121 const auto raw_key = extract_raw_public_key(key_bits);
122 const auto xmss_oid = deserialize_xmss_oid(raw_key);
123 const auto params = XMSS_Parameters::from_id(xmss_oid);
124
125 if(encoding == Key_Encoding::PublicKey) {
126 if(raw_key.size() != params.raw_public_key_size()) {
127 throw Decoding_Error("Invalid XMSS public key size detected");
128 }
129 } else if(raw_key.size() != params.raw_private_key_size() &&
130 raw_key.size() != params.raw_legacy_private_key_size()) {
131 throw Decoding_Error("Invalid XMSS private key size");
132 }
133
134 BufferSlicer s(raw_key);
135 s.skip(4 /* algorithm ID -- already consumed by `deserialize_xmss_oid()` */);
136
137 auto root = s.copy_as_secure_vector(params.element_size());
138 auto public_seed = s.copy_as_secure_vector(params.element_size());
139
140 m_public_key = std::make_shared<XMSS_PublicKey_Internal>(params, std::move(root), std::move(public_seed));
141}

References Botan::BufferSlicer::copy_as_secure_vector(), Botan::XMSS_Parameters::from_id(), Botan::AlgorithmIdentifier::parameters_are_empty(), public_seed(), PublicKey, root(), and Botan::BufferSlicer::skip().

Member Function Documentation

◆ _create_encryption_op()

std::unique_ptr< PK_Ops::Encryption > Botan::Public_Key::_create_encryption_op ( RandomNumberGenerator & rng,
const PK_Encryption_Options_Reader & options ) 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/options or throw

Parameters
Random Number Generatorsa 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.
optionswhich specify parameters of the encryption beyond those implicit to the public key itself

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

Definition at line 107 of file pk_keys.cpp.

108 {
109 BOTAN_UNUSED(rng, options);
110 throw Lookup_Error(fmt("{} does not support encryption", algo_name()));
111}
#define BOTAN_UNUSED
Definition assert.h:151
virtual std::string algo_name() const =0
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53

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

Referenced by create_encryption_op(), and 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 ( const PK_KEM_Options_Reader & options) 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/options or throw

Parameters
optionswhich specify parameters of the KEM beyond those implicit to the public key itself

Reimplemented in Botan::Classic_McEliece_PublicKey, Botan::FrodoKEM_PublicKey, Botan::KEX_to_KEM_Adapter_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, and Botan::TLS::Hybrid_KEM_PublicKey.

Definition at line 113 of file pk_keys.cpp.

114 {
115 BOTAN_UNUSED(options);
116 throw Lookup_Error(fmt("{} does not support KEM encryption", algo_name()));
117}

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

Referenced by create_kem_encryption_op(), and Botan::PK_KEM_Encryptor::PK_KEM_Encryptor().

◆ _create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::XMSS_PublicKey::_create_verification_op ( const PK_Signature_Options_Reader & options) 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
optionswhich specify parameters of the signature beyond those implicit to the public key itself

Reimplemented from Botan::Public_Key.

Definition at line 180 of file xmss_publickey.cpp.

181 {
182 validate_for_hash_based_signature(options, "XMSS", xmss_parameters().hash_function_name());
183
185
186 return std::make_unique<XMSS_Verification_Operation>(*this);
187}
const XMSS_Parameters & xmss_parameters() const
std::string algo_name() const override
Definition xmss.h:81
void require_software_provider(const OptionsT &options, std::string_view algo_name)
void validate_for_hash_based_signature(const PK_Signature_Options_Reader &options, std::string_view algo_name, std::string_view hash_fn)

References algo_name(), Botan::require_software_provider(), Botan::validate_for_hash_based_signature(), and xmss_parameters().

◆ _default_x509_signature_format()

Signature_Format Botan::Asymmetric_Key::_default_x509_signature_format ( ) const
virtualinherited

◆ _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 148 of file pk_keys.h.

148{ return {}; }

Referenced by _default_x509_signature_format(), Botan::Public_Key::message_part_size(), Botan::Public_Key::message_parts(), Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), and Botan::PK_Verifier::PK_Verifier().

◆ algo_name()

std::string Botan::XMSS_PublicKey::algo_name ( ) const
inlineoverridevirtual

Get the name of the underlying public key scheme.

Returns
name of the public key scheme

Implements Botan::Asymmetric_Key.

Definition at line 81 of file xmss.h.

81{ return "XMSS"; }

Referenced by Botan::XMSS_PrivateKey::_create_signature_op(), _create_verification_op(), and create_x509_verification_op().

◆ algorithm_identifier()

AlgorithmIdentifier Botan::XMSS_PublicKey::algorithm_identifier ( ) const
inlineoverridevirtual

Return the X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 83 of file xmss.h.

83 {
84 return AlgorithmIdentifier(object_identifier(), AlgorithmIdentifier::USE_EMPTY_PARAM);
85 }
virtual OID object_identifier() const
Definition pk_keys.cpp:24

References Botan::Asymmetric_Key::object_identifier(), and Botan::AlgorithmIdentifier::USE_EMPTY_PARAM.

Referenced by create_x509_verification_op().

◆ check_key()

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

Test the key values for consistency.

Note this function is always "best effort"; for many algorithms it is not computationally possible to ensure the key is correctly formed in all respects. There is always the possibility a malformed key will be accepted; this is especially the case for public keys.

Parameters
Random Number Generatorsrng to use for randomized testing (may be ignored)
strongwhether to perform strong and lengthy version of the test, however for many algorithms this has no effect
Returns
true if the tests passed

Implements Botan::Asymmetric_Key.

Definition at line 172 of file xmss_publickey.cpp.

172 {
173 // The public key consists of (OID, root hash, public seed). The OID is
174 // validated and the byte lengths of root and public_seed are verified
175 // against the parameter set during deserialization. These are opaque
176 // hash outputs with no further structural invariants to check.
177 return true;
178}

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

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
Random Number Generatorsa 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

Definition at line 175 of file pk_keys.cpp.

177 {
178 const auto options = parse_legacy_enc_options(*this, params).with_provider(provider);
179 const auto reader = PK_Options_Reader_Access::read(options);
180 auto op = this->_create_encryption_op(rng, reader);
182 return op;
183}
PK_Encryption_Options with_provider(std::string_view provider)
static void throw_if_unexamined(const ReaderT &reader, std::string_view algo_name)
static PK_Encryption_Options_Reader read(const PK_Encryption_Options &options)
virtual std::unique_ptr< PK_Ops::Encryption > _create_encryption_op(RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const
Definition pk_keys.cpp:107
PK_Encryption_Options parse_legacy_enc_options(const Public_Key &key, std::string_view params)

References _create_encryption_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_enc_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Encryption_Options::with_provider().

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

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
paramsadditional parameters
providerthe provider to use

Definition at line 195 of file pk_keys.cpp.

196 {
197 const auto options = parse_legacy_kem_options(params).with_provider(provider);
198 const auto reader = PK_Options_Reader_Access::read(options);
199 auto op = this->_create_kem_encryption_op(reader);
201 return op;
202}
PK_KEM_Options with_provider(std::string_view provider)
virtual std::unique_ptr< PK_Ops::KEM_Encryption > _create_kem_encryption_op(const PK_KEM_Options_Reader &options) const
Definition pk_keys.cpp:113
PK_KEM_Options parse_legacy_kem_options(std::string_view params)

References _create_kem_encryption_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_kem_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_KEM_Options::with_provider().

◆ create_verification_op()

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

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
paramsadditional parameters
providerthe provider to use

Definition at line 156 of file pk_keys.cpp.

157 {
158 const auto options = parse_legacy_sig_options(*this, params).with_provider(provider);
159 const auto reader = PK_Options_Reader_Access::for_verification(options);
160 auto op = this->_create_verification_op(reader);
162 return op;
163}
static PK_Signature_Options_Reader for_verification(const PK_Signature_Options &options)
PK_Signature_Options with_provider(std::string_view provider)
virtual std::unique_ptr< PK_Ops::Verification > _create_verification_op(const PK_Signature_Options_Reader &options) const
Definition pk_keys.cpp:119
PK_Signature_Options parse_legacy_sig_options(const Public_Key &key, std::string_view params)

References _create_verification_op(), Botan::Asymmetric_Key::algo_name(), Botan::PK_Options_Reader_Access::for_verification(), Botan::parse_legacy_sig_options(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Signature_Options::with_provider().

◆ create_x509_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::XMSS_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_algorithmis the X.509 algorithm identifier encoding the padding scheme and hash hash function used in the signature if applicable.
providerthe provider to use

Reimplemented from Botan::Public_Key.

Definition at line 189 of file xmss_publickey.cpp.

190 {
191 if(provider == "base" || provider.empty()) {
192 if(alg_id != this->algorithm_identifier()) {
193 throw Decoding_Error("Unexpected AlgorithmIdentifier for XMSS X509 signature");
194 }
195 return std::make_unique<XMSS_Verification_Operation>(*this);
196 }
197 throw Provider_Not_Found(algo_name(), provider);
198}
AlgorithmIdentifier algorithm_identifier() const override
Definition xmss.h:83

References algo_name(), and algorithm_identifier().

◆ default_x509_signature_format()

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

Definition at line 245 of file pk_keys.h.

245 {
247 }
virtual Signature_Format _default_x509_signature_format() const
Definition pk_keys.cpp:32

References Botan::Asymmetric_Key::_default_x509_signature_format(), and default_x509_signature_format().

Referenced by default_x509_signature_format().

◆ estimated_strength()

size_t Botan::XMSS_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 164 of file xmss_publickey.cpp.

164 {
166}
size_t estimated_strength() const

References Botan::XMSS_Parameters::estimated_strength(), and xmss_parameters().

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

96 {
97 return create_hex_fingerprint(subject_public_key(), hash_algo);
98}
std::vector< uint8_t > subject_public_key() const
Definition pk_keys.cpp:65
std::string create_hex_fingerprint(std::span< const uint8_t > bits, std::string_view hash_name)
Definition pk_keys.cpp:40

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

Referenced by public_key_bits().

◆ generate_another()

std::unique_ptr< Private_Key > Botan::XMSS_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 214 of file xmss_publickey.cpp.

214 {
215 // Note: Given only an XMSS public key we cannot know which WOTS key
216 // derivation method was used to build the XMSS tree. Hence, we have to
217 // use the default here.
218 return std::make_unique<XMSS_PrivateKey>(xmss_parameters().oid(), rng);
219}

References xmss_parameters().

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

20 {
21 throw Unknown_PK_Field_Name(algo_name(), field);
22}

References algo_name().

Referenced by estimated_strength(), 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 172 of file pk_keys.h.

172{ return this->object_identifier(); }

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

Referenced by get_oid().

◆ key_length()

size_t Botan::XMSS_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 168 of file xmss_publickey.cpp.

168 {
170}

References Botan::XMSS_Parameters::estimated_strength(), and xmss_parameters().

◆ message_part_size()

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

Returns how large each of the message parts referred 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 236 of file pk_keys.h.

236 {
237 return _signature_element_size_for_DER_encoding().value_or(0);
238 }

References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_part_size().

Referenced by message_part_size().

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

223 {
225 }

References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_parts().

Referenced by message_parts().

◆ object_identifier()

◆ public_key_bits()

std::vector< uint8_t > Botan::XMSS_PublicKey::public_key_bits ( ) const
overridevirtual

Returns the encoded public key as defined in RFC draft-vangeest-x509-hash-sigs-03.

Returns
encoded public key bits

Implements Botan::Public_Key.

Definition at line 204 of file xmss_publickey.cpp.

204 {
205 std::vector<uint8_t> output;
206 DER_Encoder(output).encode(raw_public_key_bits(), ASN1_Type::OctetString);
207 return output;
208}
std::vector< uint8_t > raw_public_key_bits() const override

References Botan::DER_Encoder::encode(), Botan::OctetString, and raw_public_key_bits().

◆ public_seed()

const secure_vector< uint8_t > & Botan::XMSS_PublicKey::public_seed ( ) const
protected

Definition at line 152 of file xmss_publickey.cpp.

152 {
153 return m_public_key->public_seed();
154}

Referenced by Botan::XMSS_PrivateKey::public_key(), Botan::XMSS_PrivateKey::XMSS_PrivateKey(), XMSS_PublicKey(), and XMSS_PublicKey().

◆ raw_public_key()

std::vector< uint8_t > Botan::XMSS_PublicKey::raw_public_key ( ) const

Definition at line 210 of file xmss_publickey.cpp.

210 {
211 return raw_public_key_bits();
212}

References raw_public_key_bits().

Referenced by Botan::XMSS_PrivateKey::raw_private_key().

◆ raw_public_key_bits()

std::vector< uint8_t > Botan::XMSS_PublicKey::raw_public_key_bits ( ) const
overridevirtual

Generates a byte sequence representing the XMSS public key, as defined in [1] (p. 23, "XMSS Public Key")

Returns
4-byte OID, followed by n-byte root node, followed by public seed.

Implements Botan::Public_Key.

Definition at line 200 of file xmss_publickey.cpp.

200 {
201 return m_public_key->raw_public_key_bits();
202}

Referenced by public_key_bits(), and raw_public_key().

◆ root()

const secure_vector< uint8_t > & Botan::XMSS_PublicKey::root ( ) const
protected

◆ subject_public_key()

std::vector< uint8_t > Botan::Public_Key::subject_public_key ( ) const
inherited

Return the SubjectPublicKeyInfo encoding of this public key

This is the subjectPublicKey field plus the algorithm-specific parameters

Definition at line 65 of file pk_keys.cpp.

65 {
66 std::vector<uint8_t> output;
67
68 DER_Encoder(output)
69 .start_sequence()
70 .encode(algorithm_identifier())
71 .encode_octet_aligned_bitstring(public_key_bits())
72 .end_cons();
73
74 return output;
75}
virtual AlgorithmIdentifier algorithm_identifier() const =0
virtual std::vector< uint8_t > public_key_bits() const =0

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

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

◆ supports_operation()

bool Botan::XMSS_PublicKey::supports_operation ( PublicKeyOperation op) const
inlineoverridevirtual

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

Implements Botan::Asymmetric_Key.

Definition at line 114 of file xmss.h.

References Botan::Signature, and supports_operation().

Referenced by supports_operation().

◆ xmss_parameters()

const XMSS_Parameters & Botan::XMSS_PublicKey::xmss_parameters ( ) const
protected

◆ XMSS_Verification_Operation

friend class XMSS_Verification_Operation
friend

Definition at line 123 of file xmss.h.

References XMSS_Verification_Operation.

Referenced by XMSS_Verification_Operation.


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