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::Decryption > | create_decryption_op (RandomNumberGenerator &rng, const std::string ¶ms, const std::string &provider) const |
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_Decryption > | create_kem_decryption_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 |
virtual std::unique_ptr< PK_Ops::Key_Agreement > | create_key_agreement_op (RandomNumberGenerator &rng, const std::string ¶ms, const std::string &provider) const |
std::unique_ptr< PK_Ops::Signature > | create_signature_op (RandomNumberGenerator &, const std::string &, const std::string &provider) const override |
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 (const std::string &alg) const |
std::string | fingerprint_private (const std::string &alg) const |
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 |
virtual AlgorithmIdentifier | pkcs8_algorithm_identifier () const |
secure_vector< uint8_t > & | prf () |
const secure_vector< uint8_t > & | prf () const |
secure_vector< uint8_t > | private_key_bits () const override |
secure_vector< uint8_t > | private_key_info () const |
std::vector< uint8_t > | public_key_bits () const override |
virtual secure_vector< uint8_t > & | public_seed () |
const secure_vector< uint8_t > & | public_seed () const override |
secure_vector< uint8_t > | raw_private_key () const |
virtual std::vector< uint8_t > | raw_public_key () const |
size_t | reserve_unused_leaf_index () |
secure_vector< uint8_t > & | root () |
const secure_vector< uint8_t > & | root () const |
void | set_public_seed (const secure_vector< uint8_t > &public_seed) override |
void | set_public_seed (secure_vector< uint8_t > &&public_seed) override |
void | set_root (const secure_vector< uint8_t > &root) |
void | set_root (secure_vector< uint8_t > &&root) |
void | set_unused_leaf_index (size_t idx) |
void | set_xmss_oid (XMSS_Parameters::xmss_algorithm_t xmss_oid) |
size_t | size () const override |
bool | stateful_operation () const override |
std::vector< uint8_t > | subject_public_key () const |
secure_vector< uint8_t > | tree_hash (size_t start_idx, size_t target_node_height, XMSS_Address &adrs) |
size_t | unused_leaf_index () const |
XMSS_WOTS_Parameters::ots_algorithm_t | wots_oid () const |
const XMSS_WOTS_Parameters & | wots_parameters () const |
XMSS_WOTS_PrivateKey & | wots_private_key () |
const XMSS_WOTS_PrivateKey & | wots_private_key () const |
std::string | xmss_hash_function () const |
XMSS_Parameters::xmss_algorithm_t | xmss_oid () const |
const XMSS_Parameters & | xmss_parameters () const |
XMSS_PrivateKey (const secure_vector< uint8_t > &raw_key) | |
XMSS_PrivateKey (XMSS_Parameters::xmss_algorithm_t xmss_algo_id, RandomNumberGenerator &rng) | |
XMSS_PrivateKey (XMSS_Parameters::xmss_algorithm_t xmss_algo_id, size_t idx_leaf, const secure_vector< uint8_t > &wots_priv_seed, const secure_vector< uint8_t > &prf, const secure_vector< uint8_t > &root, const 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 private key. The XMSS private key does not support the X509 and PKCS7 standard. Instead the raw format described in [1] is used.
[1] XMSS: Extended Hash-Based Signatures, Request for Comments: 8391 Release: May 2018. https://datatracker.ietf.org/doc/rfc8391/
Botan::XMSS_PrivateKey::XMSS_PrivateKey | ( | XMSS_Parameters::xmss_algorithm_t | xmss_algo_id, |
RandomNumberGenerator & | rng | ||
) |
Creates a new XMSS private key for the chosen XMSS signature method. New seeds for public/private key and pseudo random function input are generated using the provided RNG. The appropriate WOTS signature method will be automatically set based on the chosen XMSS signature method.
xmss_algo_id | Identifier for the selected XMSS signature method. |
rng | A random number generator to use for key generation. |
Definition at line 101 of file xmss_privatekey.cpp.
References Botan::XMSS_PublicKey::m_xmss_params, Botan::XMSS_PublicKey::set_root(), and tree_hash().
Botan::XMSS_PrivateKey::XMSS_PrivateKey | ( | const secure_vector< uint8_t > & | raw_key | ) |
Creates an XMSS_PrivateKey from a byte sequence produced by raw_private_key().
raw_key | An XMSS private key serialized using raw_private_key(). |
Definition at line 51 of file xmss_privatekey.cpp.
References Botan::XMSS_Parameters::element_size(), Botan::XMSS_WOTS_Parameters::element_size(), Botan::XMSS_PublicKey::m_wots_params, Botan::XMSS_PublicKey::m_xmss_params, Botan::XMSS_WOTS_PrivateKey::set_private_seed(), set_unused_leaf_index(), Botan::XMSS_PublicKey::size(), and size().
Botan::XMSS_PrivateKey::XMSS_PrivateKey | ( | XMSS_Parameters::xmss_algorithm_t | xmss_algo_id, |
size_t | idx_leaf, | ||
const secure_vector< uint8_t > & | wots_priv_seed, | ||
const secure_vector< uint8_t > & | prf, | ||
const secure_vector< uint8_t > & | root, | ||
const secure_vector< uint8_t > & | public_seed | ||
) |
Creates a new XMSS private key for the chosen XMSS signature method using precomputed seeds for public/private keys and pseudo random function input. The appropriate WOTS signature method will be automatically set, based on the chosen XMSS signature method.
xmss_algo_id | Identifier for the selected XMSS signature method. |
idx_leaf | Index of the next unused leaf. |
wots_priv_seed | A seed to generate a Winternitz-One-Time- Signature private key from. |
prf | a secret n-byte key sourced from a secure source of uniformly random data. |
root | Root node of the binary hash tree. |
public_seed | The public seed. |
Definition at line 119 of file xmss_privatekey.cpp.
References set_unused_leaf_index().
|
inlineoverridevirtualinherited |
Get the name of the underlying public key scheme.
Implements Botan::Public_Key.
Definition at line 186 of file xmss.h.
Referenced by create_signature_op(), and Botan::XMSS_PublicKey::create_verification_op().
|
inlineoverridevirtualinherited |
Implements Botan::Public_Key.
Definition at line 191 of file xmss.h.
|
inlineoverridevirtualinherited |
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 decryption 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_PrivateKey, Botan::RSA_PrivateKey, and Botan::SM2_PrivateKey.
Definition at line 114 of file pk_keys.cpp.
References Botan::Public_Key::algo_name().
Referenced by Botan::PK_Decryptor_EME::PK_Decryptor_EME().
|
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 decryption 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_PrivateKey, and Botan::RSA_PrivateKey.
Definition at line 122 of file pk_keys.cpp.
References Botan::Public_Key::algo_name().
Referenced by Botan::PK_KEM_Decryptor::PK_KEM_Decryptor().
|
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().
|
virtualinherited |
This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h
Return a key agreement 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::Curve25519_PrivateKey, Botan::DH_PrivateKey, and Botan::ECDH_PrivateKey.
Definition at line 138 of file pk_keys.cpp.
References Botan::Public_Key::algo_name().
Referenced by Botan::PK_Key_Agreement::PK_Key_Agreement().
|
overridevirtual |
This is an internal library function exposed on key types. In almost all cases applications should use wrappers in pubkey.h
Return a signature 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 from Botan::Private_Key.
Definition at line 394 of file xmss_privatekey.cpp.
References Botan::XMSS_PublicKey::algo_name().
|
overridevirtualinherited |
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 Botan::XMSS_PublicKey::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().
|
inlineoverridevirtualinherited |
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.
|
inlineinherited |
|
inherited |
Definition at line 85 of file pk_keys.cpp.
References Botan::create_hex_fingerprint(), hash_algo, 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().
|
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().
|
inlineoverridevirtualinherited |
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().
|
inlinevirtualinherited |
Reimplemented in Botan::GOST_3410_PrivateKey, Botan::XMSS_WOTS_PrivateKey, and Botan::XMSS_WOTS_Addressed_PrivateKey.
Definition at line 204 of file pk_keys.h.
Referenced by Botan::Private_Key::private_key_info().
|
inline |
|
inline |
|
overridevirtual |
Implements Botan::Private_Key.
Definition at line 319 of file xmss_privatekey.cpp.
References Botan::DER_Encoder::encode(), Botan::DER_Encoder::get_contents(), Botan::OCTET_STRING, and raw_private_key().
|
inherited |
Definition at line 61 of file pk_keys.cpp.
References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::OCTET_STRING, Botan::Private_Key::pkcs8_algorithm_identifier(), Botan::Private_Key::private_key_bits(), Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().
Referenced by Botan::PKCS8::BER_encode(), Botan::PKCS8::BER_encode_encrypted_pbkdf_iter(), and Botan::PKCS8::BER_encode_encrypted_pbkdf_msec().
|
overridevirtualinherited |
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 Botan::XMSS_PublicKey::raw_public_key().
|
inlinevirtualinherited |
|
inlineoverridevirtual |
Reimplemented from Botan::XMSS_PublicKey.
Definition at line 382 of file xmss.h.
Referenced by tree_hash().
secure_vector< uint8_t > Botan::XMSS_PrivateKey::raw_private_key | ( | ) | const |
Generates a non standartized byte sequence representing the XMSS private key.
Definition at line 372 of file xmss_privatekey.cpp.
References Botan::XMSS_WOTS_PrivateKey::private_seed(), Botan::XMSS_PublicKey::raw_public_key(), size(), and unused_leaf_index().
Referenced by private_key_bits().
|
virtualinherited |
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 Botan::XMSS_PublicKey::m_public_seed, Botan::XMSS_PublicKey::m_root, Botan::XMSS_PublicKey::m_xmss_params, and Botan::XMSS_Parameters::oid().
Referenced by Botan::XMSS_PublicKey::public_key_bits(), and raw_private_key().
size_t Botan::XMSS_PrivateKey::reserve_unused_leaf_index | ( | ) |
Definition at line 356 of file xmss_privatekey.cpp.
References Botan::XMSS_PublicKey::m_xmss_params.
|
inlineinherited |
|
inlineinherited |
|
inlineoverridevirtual |
Reimplemented from Botan::XMSS_PublicKey.
Definition at line 369 of file xmss.h.
|
inlineoverridevirtual |
|
inlineinherited |
Definition at line 151 of file xmss.h.
Referenced by XMSS_PrivateKey().
|
inlineinherited |
void Botan::XMSS_PrivateKey::set_unused_leaf_index | ( | size_t | idx | ) |
Sets the last unused leaf index of the private key. The leaf index will be updated automatically during every signing operation, and should not be set manually.
idx | Index of the last unused leaf. |
Definition at line 334 of file xmss_privatekey.cpp.
References Botan::XMSS_PublicKey::m_xmss_params.
Referenced by XMSS_PrivateKey(), and XMSS_PrivateKey().
|
inlineinherited |
Sets the chosen XMSS signature method
Definition at line 96 of file xmss.h.
|
inlineoverridevirtual |
Size in bytes of the serialized XMSS public key produced by raw_public_key().
Reimplemented from Botan::XMSS_PublicKey.
Definition at line 394 of file xmss.h.
Referenced by raw_private_key(), and XMSS_PrivateKey().
|
inlineoverridevirtual |
|
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().
secure_vector< uint8_t > Botan::XMSS_PrivateKey::tree_hash | ( | size_t | start_idx, |
size_t | target_node_height, | ||
XMSS_Address & | adrs | ||
) |
Algorithm 9: "treeHash" Computes the internal n-byte nodes of a Merkle tree.
start_idx | The start index. |
target_node_height | Height of the target node. |
adrs | Address of the tree containing the target node. |
Definition at line 137 of file xmss_privatekey.cpp.
References BOTAN_ASSERT, BOTAN_ASSERT_NOMSG, Botan::Thread_Pool::global_instance(), Botan::XMSS_PublicKey::m_xmss_params, public_seed(), Botan::XMSS_Common_Ops::randomize_tree_hash(), Botan::Thread_Pool::run(), and Botan::Thread_Pool::worker_count().
Referenced by XMSS_PrivateKey().
size_t Botan::XMSS_PrivateKey::unused_leaf_index | ( | ) | const |
Retrieves the last unused leaf index of the private key. Reusing a leaf by utilizing leaf indices lower than the last unused leaf index will compromise security.
Definition at line 367 of file xmss_privatekey.cpp.
Referenced by raw_private_key().
|
inlineinherited |
Retrieves the Winternitz One Time Signature (WOTS) method, corresponding to the chosen XMSS signature method.
|
inlineinherited |
Retrieves the Winternitz One Time Signature (WOTS) parameters corresponding to the chosen XMSS signature method.
|
inline |
|
inline |
|
inlineinherited |
Retrieves the XMSS parameters determined by the chosen XMSS Signature method.
|
inlineinherited |
Retrieves the chosen XMSS signature method.
|
inlineinherited |
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().
|
protectedinherited |
Definition at line 248 of file xmss.h.
Referenced by Botan::XMSS_PublicKey::raw_public_key(), and Botan::XMSS_PublicKey::XMSS_PublicKey().
|
protectedinherited |
Definition at line 244 of file xmss.h.
Referenced by Botan::XMSS_PublicKey::XMSS_PublicKey().
|
protectedinherited |
Definition at line 247 of file xmss.h.
Referenced by Botan::XMSS_PublicKey::raw_public_key(), and Botan::XMSS_PublicKey::XMSS_PublicKey().
|
protectedinherited |
Definition at line 246 of file xmss.h.
Referenced by XMSS_PrivateKey().
|
protectedinherited |
Definition at line 245 of file xmss.h.
Referenced by Botan::XMSS_PublicKey::raw_public_key(), reserve_unused_leaf_index(), set_unused_leaf_index(), tree_hash(), XMSS_PrivateKey(), XMSS_PrivateKey(), and Botan::XMSS_PublicKey::XMSS_PublicKey().