Botan 2.19.3
Crypto and TLS for C&
|
#include <xmss.h>
Public Member Functions | |
std::string | algo_name () const override |
AlgorithmIdentifier | algorithm_identifier () const override |
bool | check_key (RandomNumberGenerator &, bool) const override |
virtual std::unique_ptr< PK_Ops::Encryption > | create_encryption_op (RandomNumberGenerator &rng, const std::string ¶ms, const std::string &provider) const |
virtual std::unique_ptr< PK_Ops::KEM_Encryption > | create_kem_encryption_op (RandomNumberGenerator &rng, const std::string ¶ms, const std::string &provider) const |
std::unique_ptr< PK_Ops::Verification > | create_verification_op (const std::string &, const std::string &provider) const override |
virtual Signature_Format | default_x509_signature_format () const |
size_t | estimated_strength () const override |
std::string | fingerprint_public (const std::string &alg="SHA-256") const |
virtual OID | get_oid () const |
size_t | key_length () const override |
virtual size_t | message_part_size () const |
virtual size_t | message_parts () const |
std::vector< uint8_t > | public_key_bits () const override |
virtual secure_vector< uint8_t > & | public_seed () |
virtual const secure_vector< uint8_t > & | public_seed () const |
virtual std::vector< uint8_t > | raw_public_key () const |
secure_vector< uint8_t > & | root () |
const secure_vector< uint8_t > & | root () const |
virtual void | set_public_seed (const secure_vector< uint8_t > &public_seed) |
virtual void | set_public_seed (secure_vector< uint8_t > &&public_seed) |
void | set_root (const secure_vector< uint8_t > &root) |
void | set_root (secure_vector< uint8_t > &&root) |
void | set_xmss_oid (XMSS_Parameters::xmss_algorithm_t xmss_oid) |
virtual size_t | size () const |
std::vector< uint8_t > | subject_public_key () const |
XMSS_WOTS_Parameters::ots_algorithm_t | wots_oid () const |
const XMSS_WOTS_Parameters & | wots_parameters () const |
std::string | xmss_hash_function () const |
XMSS_Parameters::xmss_algorithm_t | xmss_oid () const |
const XMSS_Parameters & | xmss_parameters () const |
XMSS_PublicKey (const std::vector< uint8_t > &key_bits) | |
XMSS_PublicKey (XMSS_Parameters::xmss_algorithm_t xmss_oid, const secure_vector< uint8_t > &root, const secure_vector< uint8_t > &public_seed) | |
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 Attributes | |
secure_vector< uint8_t > | m_public_seed |
std::vector< uint8_t > | m_raw_key |
secure_vector< uint8_t > | m_root |
XMSS_WOTS_Parameters | m_wots_params |
XMSS_Parameters | m_xmss_params |
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/
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.
xmss_oid | Identifier for the selected XMSS signature method. |
rng | A random number generator to use for key generation. |
Definition at line 44 of file xmss_publickey.cpp.
Botan::XMSS_PublicKey::XMSS_PublicKey | ( | const std::vector< uint8_t > & | key_bits | ) |
Loads a public key.
Public key must be encoded as in RFC draft-vangeest-x509-hash-sigs-03.
key_bits | DER encoded public key bits |
Definition at line 51 of file xmss_publickey.cpp.
References Botan::XMSS_Parameters::element_size(), m_public_seed, m_raw_key, m_root, m_xmss_params, and size().
|
inline |
Creates a new XMSS public key for a chosen XMSS signature method as well as pre-computed root node and public_seed values.
xmss_oid | Identifier for the selected XMSS signature method. |
root | Root node value. |
public_seed | Public seed value. |
Definition at line 63 of file xmss.h.
|
inline |
|
inlineoverridevirtual |
Get the name of the underlying public key scheme.
Implements Botan::Public_Key.
Definition at line 186 of file xmss.h.
Referenced by Botan::XMSS_PrivateKey::create_signature_op(), and create_verification_op().
|
inlineoverridevirtual |
Implements Botan::Public_Key.
Definition at line 191 of file xmss.h.
|
inlineoverridevirtual |
Test the key values for consistency.
rng | rng to use |
strong | whether to perform strong and lengthy version of the test |
Implements Botan::Public_Key.
Definition at line 196 of file xmss.h.
|
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
rng | a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it. |
params | additional parameters |
provider | the provider to use |
Reimplemented in Botan::ElGamal_PublicKey, Botan::RSA_PublicKey, and Botan::SM2_PublicKey.
Definition at line 91 of file pk_keys.cpp.
References Botan::Public_Key::algo_name().
Referenced by Botan::PK_Encryptor_EME::PK_Encryptor_EME().
|
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
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::McEliece_PublicKey, and Botan::RSA_PublicKey.
Definition at line 99 of file pk_keys.cpp.
References Botan::Public_Key::algo_name().
Referenced by Botan::PK_KEM_Encryptor::PK_KEM_Encryptor().
|
overridevirtual |
This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h
Return a verification operation for this key/params or throw
params | additional parameters |
provider | the provider to use |
Reimplemented from Botan::Public_Key.
Definition at line 93 of file xmss_publickey.cpp.
References algo_name().
|
inlinevirtualinherited |
Reimplemented in Botan::GOST_3410_PublicKey.
Definition at line 125 of file pk_keys.h.
References Botan::DER_SEQUENCE, and Botan::IEEE_1363.
Referenced by Botan::X509_Object::choose_sig_format(), and Botan::X509_Object::verify_signature().
|
inlineoverridevirtual |
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.
Implements Botan::Public_Key.
|
inherited |
Definition at line 77 of file pk_keys.cpp.
References Botan::create_hex_fingerprint(), hash_algo, and Botan::Public_Key::subject_public_key().
|
virtualinherited |
Get the OID of the underlying public key scheme.
Reimplemented in Botan::XMSS_WOTS_Addressed_PublicKey.
Definition at line 53 of file pk_keys.cpp.
References Botan::Public_Key::algo_name(), Botan::OID::empty(), and Botan::OIDS::str2oid_or_empty().
Referenced by Botan::TPM_PrivateKey::algorithm_identifier(), Botan::Curve25519_PublicKey::algorithm_identifier(), Botan::DL_Scheme_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), Botan::Ed25519_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::McEliece_PublicKey::algorithm_identifier(), Botan::RSA_PublicKey::algorithm_identifier(), and Botan::XMSS_WOTS_Addressed_PublicKey::get_oid().
|
inlineoverridevirtual |
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.
|
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.
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 123 of file pk_keys.h.
Referenced by Botan::PK_Signer::PK_Signer(), and Botan::PK_Verifier::PK_Verifier().
|
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.
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 112 of file pk_keys.h.
Referenced by Botan::PK_Signer::PK_Signer(), and Botan::PK_Verifier::PK_Verifier().
|
overridevirtual |
Returns the encoded public key as defined in RFC draft-vangeest-x509-hash-sigs-03.
Implements Botan::Public_Key.
Definition at line 122 of file xmss_publickey.cpp.
References Botan::DER_Encoder::encode(), Botan::OCTET_STRING, and raw_public_key().
|
inlinevirtual |
|
inlinevirtual |
Reimplemented in Botan::XMSS_PrivateKey.
|
virtual |
Generates a byte sequence representing the XMSS public key, as defined in [1] (p. 23, "XMSS Public Key")
Definition at line 104 of file xmss_publickey.cpp.
References m_public_seed, m_root, m_xmss_params, and Botan::XMSS_Parameters::oid().
Referenced by public_key_bits(), and Botan::XMSS_PrivateKey::raw_private_key().
|
inline |
|
inline |
|
inlinevirtual |
Reimplemented in Botan::XMSS_PrivateKey.
|
inlinevirtual |
Reimplemented in Botan::XMSS_PrivateKey.
|
inline |
Definition at line 151 of file xmss.h.
Referenced by Botan::XMSS_PrivateKey::XMSS_PrivateKey().
|
inline |
|
inline |
|
inlinevirtual |
Size in bytes of the serialized XMSS public key produced by raw_public_key().
Reimplemented in Botan::XMSS_PrivateKey.
Definition at line 229 of file xmss.h.
Referenced by Botan::XMSS_PrivateKey::XMSS_PrivateKey(), and XMSS_PublicKey().
|
inherited |
Definition at line 38 of file pk_keys.cpp.
References Botan::Public_Key::algorithm_identifier(), Botan::BIT_STRING, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::Public_Key::public_key_bits(), Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().
Referenced by Botan::X509::BER_encode(), Botan::PKCS10_Request::create(), Botan::Public_Key::fingerprint_public(), and Botan::X509::PEM_encode().
|
inline |
|
inline |
Retrieves the Winternitz One Time Signature (WOTS) parameters corresponding to the chosen XMSS signature method.
|
inline |
Retrieves the XMSS parameters determined by the chosen XMSS Signature method.
|
inline |
Retrieves the chosen XMSS signature method.
|
inline |
Retrieves the XMSS parameters determined by the chosen XMSS Signature method.
Definition at line 108 of file xmss.h.
Referenced by Botan::XMSS_Verification_Operation::is_valid_signature().
|
protected |
Definition at line 248 of file xmss.h.
Referenced by raw_public_key(), and XMSS_PublicKey().
|
protected |
Definition at line 244 of file xmss.h.
Referenced by XMSS_PublicKey().
|
protected |
Definition at line 247 of file xmss.h.
Referenced by raw_public_key(), and XMSS_PublicKey().
|
protected |
Definition at line 246 of file xmss.h.
Referenced by Botan::XMSS_PrivateKey::XMSS_PrivateKey().
|
protected |
Definition at line 245 of file xmss.h.
Referenced by raw_public_key(), Botan::XMSS_PrivateKey::reserve_unused_leaf_index(), Botan::XMSS_PrivateKey::set_unused_leaf_index(), Botan::XMSS_PrivateKey::tree_hash(), Botan::XMSS_PrivateKey::XMSS_PrivateKey(), Botan::XMSS_PrivateKey::XMSS_PrivateKey(), and XMSS_PublicKey().