Botan 3.13.0
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 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::Encryptioncreate_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
virtual std::unique_ptr< PK_Ops::KEM_Encryptioncreate_kem_encryption_op (std::string_view params, std::string_view provider) const
std::unique_ptr< PK_Ops::Verificationcreate_verification_op (std::string_view params, std::string_view provider) const override
std::unique_ptr< PK_Ops::Verificationcreate_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_Keygenerate_another (RandomNumberGenerator &rng) const final
virtual const BigIntget_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 Member Functions

const secure_vector< uint8_t > & public_seed () const
const secure_vector< uint8_t > & root () const
const XMSS_Parametersxmss_parameters () const

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.

Constructor & Destructor Documentation

◆ XMSS_PublicKey() [1/4]

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

Creates a new XMSS public key for the chosen XMSS signature method. New public and prf seeds are generated using rng. The appropriate WOTS signature method will be automatically set based on the chosen XMSS signature method.

Parameters
xmss_oidIdentifier for the selected XMSS signature method.
Random Number GeneratorsA random number generator to use for key generation.

Definition at line 100 of file xmss_publickey.cpp.

100 {
101 const auto params = XMSS_Parameters::from_id(xmss_oid);
102 m_public_key = std::make_shared<XMSS_PublicKey_Internal>(
103 params, secure_vector<uint8_t>(params.element_size()), rng.random_vec(params.element_size()));
104}
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(), and XMSS_PublicKey().

◆ XMSS_PublicKey() [2/4]

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 108 of file xmss_publickey.cpp.

108 {
109 // The XMSS parameter set is carried in the key bits; no AlgorithmIdentifier parameters are defined
110 if(!alg_id.parameters_are_empty()) {
111 throw Decoding_Error("Unexpected parameters for XMSS public key");
112 }
113
114 const auto raw_key = extract_raw_public_key(key_bits);
115 const auto xmss_oid = deserialize_xmss_oid(raw_key);
116 const auto params = XMSS_Parameters::from_id(xmss_oid);
117 if(raw_key.size() < params.raw_public_key_size()) {
118 throw Decoding_Error("Invalid XMSS public key size detected");
119 }
120
121 BufferSlicer s(raw_key);
122 s.skip(4 /* algorithm ID -- already consumed by `deserialize_xmss_oid()` */);
123
124 auto root = s.copy_as_secure_vector(params.element_size());
125 auto public_seed = s.copy_as_secure_vector(params.element_size());
126
127 m_public_key = std::make_shared<XMSS_PublicKey_Internal>(params, std::move(root), std::move(public_seed));
128}
const secure_vector< uint8_t > & root() const
const secure_vector< uint8_t > & public_seed() const

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

◆ XMSS_PublicKey() [3/4]

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 106 of file xmss_publickey.cpp.

106: XMSS_PublicKey(AlgorithmIdentifier(), key_bits) {}
XMSS_PublicKey(XMSS_Parameters::xmss_algorithm_t xmss_oid, RandomNumberGenerator &rng)

References XMSS_PublicKey().

◆ XMSS_PublicKey() [4/4]

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 130 of file xmss_publickey.cpp.

132 {
133 const auto params = XMSS_Parameters::from_id(xmss_oid);
134 BOTAN_ARG_CHECK(root.size() == params.element_size(), "XMSS: unexpected byte length of root hash");
135 BOTAN_ARG_CHECK(public_seed.size() == params.element_size(), "XMSS: unexpected byte length of public seed");
136 m_public_key = std::make_shared<XMSS_PublicKey_Internal>(params, std::move(root), std::move(public_seed));
137}
#define BOTAN_ARG_CHECK(expr, msg)
Definition assert.h:33

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

Member Function Documentation

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

144{ return {}; }

Referenced by _default_x509_signature_format(), Botan::Public_Key::message_part_size(), Botan::Public_Key::message_parts(), 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:22

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 159 of file xmss_publickey.cpp.

159 {
160 // The public key consists of (OID, root hash, public seed). The OID is
161 // validated and the byte lengths of root and public_seed are verified
162 // against the parameter set during deserialization. These are opaque
163 // hash outputs with no further structural invariants to check.
164 return true;
165}

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

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

Definition at line 105 of file pk_keys.cpp.

107 {
108 throw Lookup_Error(fmt("{} does not support encryption", algo_name()));
109}
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(), 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
paramsadditional parameters
providerthe provider to use

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

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

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

Reimplemented from Botan::Public_Key.

Definition at line 167 of file xmss_publickey.cpp.

168 {
169 if(provider == "base" || provider.empty()) {
170 return std::make_unique<XMSS_Verification_Operation>(*this);
171 }
172 throw Provider_Not_Found(algo_name(), provider);
173}
std::string algo_name() const override
Definition xmss.h:81

References algo_name().

◆ 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 175 of file xmss_publickey.cpp.

176 {
177 if(provider == "base" || provider.empty()) {
178 if(alg_id != this->algorithm_identifier()) {
179 throw Decoding_Error("Unexpected AlgorithmIdentifier for XMSS X509 signature");
180 }
181 return std::make_unique<XMSS_Verification_Operation>(*this);
182 }
183 throw Provider_Not_Found(algo_name(), provider);
184}
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 241 of file pk_keys.h.

241 {
243 }
virtual Signature_Format _default_x509_signature_format() const
Definition pk_keys.cpp:30

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 151 of file xmss_publickey.cpp.

151 {
153}
size_t estimated_strength() const
const XMSS_Parameters & xmss_parameters() 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 94 of file pk_keys.cpp.

94 {
95 return create_hex_fingerprint(subject_public_key(), hash_algo);
96}
std::vector< uint8_t > subject_public_key() const
Definition pk_keys.cpp:63
std::string create_hex_fingerprint(std::span< const uint8_t > bits, std::string_view hash_name)
Definition pk_keys.cpp:38

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 200 of file xmss_publickey.cpp.

200 {
201 // Note: Given only an XMSS public key we cannot know which WOTS key
202 // derivation method was used to build the XMSS tree. Hence, we have to
203 // use the default here.
204 return std::make_unique<XMSS_PrivateKey>(xmss_parameters().oid(), rng);
205}

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

18 {
19 throw Unknown_PK_Field_Name(algo_name(), field);
20}

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

168{ 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 155 of file xmss_publickey.cpp.

155 {
157}

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

232 {
233 return _signature_element_size_for_DER_encoding().value_or(0);
234 }

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

219 {
221 }

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 190 of file xmss_publickey.cpp.

190 {
191 std::vector<uint8_t> output;
192 DER_Encoder(output).encode(raw_public_key_bits(), ASN1_Type::OctetString);
193 return output;
194}
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 139 of file xmss_publickey.cpp.

139 {
140 return m_public_key->public_seed();
141}

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

◆ raw_public_key()

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

Definition at line 196 of file xmss_publickey.cpp.

196 {
197 return raw_public_key_bits();
198}

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 186 of file xmss_publickey.cpp.

186 {
187 return m_public_key->raw_public_key_bits();
188}

Referenced by public_key_bits(), and raw_public_key().

◆ root()

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

Definition at line 143 of file xmss_publickey.cpp.

143 {
144 return m_public_key->root();
145}

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

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

63 {
64 std::vector<uint8_t> output;
65
66 DER_Encoder(output)
67 .start_sequence()
68 .encode(algorithm_identifier())
69 .encode_octet_aligned_bitstring(public_key_bits())
70 .end_cons();
71
72 return output;
73}
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 public_seed(), root(), xmss_parameters(), and XMSS_Verification_Operation.

Referenced by XMSS_Verification_Operation.


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