Botan
2.1.0
Crypto and TLS for C++11
|
#include <xmss_wots_privatekey.h>
Protected Member Functions | |
void | chain (secure_vector< uint8_t > &x, size_t start_idx, size_t steps, XMSS_Address &adrs, const secure_vector< uint8_t > &public_seed) |
Protected Attributes | |
XMSS_Hash | m_hash |
wots_keysig_t | m_key |
secure_vector< uint8_t > | m_public_seed |
XMSS_WOTS_Parameters | m_wots_params |
A Winternitz One Time Signature private key for use with Extended Hash-Based Signatures.
Definition at line 27 of file xmss_wots_privatekey.h.
|
inline |
Creates a WOTS private key for the chosen XMSS WOTS signature method. Members need to be initialized manually.
oid | Identifier for the selected signature method. |
Definition at line 37 of file xmss_wots_privatekey.h.
|
inline |
Creates a WOTS private key for the chosen XMSS WOTS signature method.
oid | Identifier for the selected signature method. |
rng | A random number generator to use for key generation. |
Definition at line 47 of file xmss_wots_privatekey.h.
|
inline |
Constructs a WOTS private key. Chains will be generated on demand applying a hash function to a unique value generated from a secret seed and a counter. The secret seed of length n, will be automatically generated using AutoSeeded_RNG(). "n" equals the element size of the chosen WOTS security parameter set.
oid | Identifier for the selected signature method. |
public_seed | A public seed used for the pseudo random generation of public keys derived from this private key. |
rng | A random number generator to use for key generation. |
Definition at line 67 of file xmss_wots_privatekey.h.
|
inline |
Constructs a WOTS private key. Chains will be generated on demand applying a hash function to a unique value generated from a secret seed and a counter. The secret seed of length n, will be automatically generated using AutoSeeded_RNG(). "n" equals the element size of the chosen WOTS security parameter set.
oid | Identifier for the selected signature method. |
public_seed | A public seed used for the pseudo random generation of public keys derived from this private key. |
Definition at line 87 of file xmss_wots_privatekey.h.
|
inline |
Constructs a WOTS private key. Chains will be generated on demand applying a hash function to a unique value generated from the secret seed and a counter.
oid | Identifier for the selected signature method. |
public_seed | A public seed used for the pseudo random generation of public keys derived from this private key. |
private_seed | A secret uniformly random n-byte value. |
Definition at line 102 of file xmss_wots_privatekey.h.
|
inlineoverridevirtualinherited |
Get the name of the underlying public key scheme.
Implements Botan::Public_Key.
Definition at line 234 of file xmss_wots_publickey.h.
Referenced by Botan::XMSS_WOTS_Addressed_PublicKey::algo_name(), create_signature_op(), and Botan::XMSS_WOTS_PublicKey::create_verification_op().
|
inlineoverridevirtualinherited |
Implements Botan::Public_Key.
Definition at line 239 of file xmss_wots_publickey.h.
Referenced by Botan::XMSS_WOTS_Addressed_PublicKey::algorithm_identifier().
|
protectedinherited |
Algorithm 2: Chaining Function.
Takes an n-byte input string and transforms it into a the function result iterating the cryptographic hash function "F" steps times on the input x using the outputs of the PRNG "G".
[out] | x | An n-byte input string, that will be transformed into the chaining function result. |
start_idx | The start index. | |
steps | A number of steps. | |
adrs | An OTS Hash Address. | |
public_seed | A public seed. |
Definition at line 17 of file xmss_wots_publickey.cpp.
References Botan::XMSS_Address::bytes(), Botan::XMSS_Hash::f(), Botan::XMSS_Address::Key_Mode, Botan::XMSS_WOTS_PublicKey::m_hash, Botan::XMSS_WOTS_PublicKey::m_wots_params, Botan::XMSS_Address::Mask_Mode, Botan::XMSS_Hash::prf(), Botan::XMSS_Address::set_hash_address(), Botan::XMSS_Address::set_key_mask_mode(), Botan::XMSS_WOTS_Parameters::wots_parameter(), and Botan::xor_buf().
Referenced by generate_public_key(), and sign().
|
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 244 of file xmss_wots_publickey.h.
Referenced by Botan::XMSS_WOTS_Addressed_PublicKey::check_key().
|
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::RSA_PrivateKey, and Botan::ElGamal_PrivateKey.
Definition at line 102 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::RSA_PublicKey, and Botan::ElGamal_PublicKey.
Definition at line 79 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::RSA_PrivateKey, and Botan::McEliece_PrivateKey.
Definition at line 110 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::RSA_PublicKey, and Botan::McEliece_PublicKey.
Definition at line 87 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::ECDH_PrivateKey, Botan::Curve25519_PrivateKey, and Botan::DH_PrivateKey.
Definition at line 126 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 82 of file xmss_wots_privatekey.cpp.
References Botan::XMSS_WOTS_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 68 of file xmss_wots_publickey.cpp.
References Botan::XMSS_WOTS_PublicKey::algo_name().
Referenced by Botan::XMSS_WOTS_Addressed_PublicKey::create_verification_op().
|
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.
Definition at line 253 of file xmss_wots_publickey.h.
Referenced by Botan::XMSS_WOTS_Addressed_PublicKey::estimated_strength(), and Botan::XMSS_WOTS_Addressed_PublicKey::key_length().
|
inherited |
Definition at line 57 of file pk_keys.cpp.
References Botan::HashFunction::create(), hash, Botan::hex_encode(), 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().
wots_keysig_t Botan::XMSS_WOTS_PrivateKey::generate_private_key | ( | const secure_vector< uint8_t > & | priv_seed | ) |
XMSS_WOTS_PublicKey Botan::XMSS_WOTS_PrivateKey::generate_public_key | ( | XMSS_Address & | adrs | ) |
Algorithm 4: "WOTS_genPK" Generates a Winternitz One Time Signature+ (WOTS+) Public Key from a given private key.
adrs | Hash function address encoding the address of the WOTS+ key pair within a greater structure. |
Definition at line 32 of file xmss_wots_privatekey.cpp.
References Botan::XMSS_WOTS_PublicKey::m_wots_params, Botan::XMSS_WOTS_Parameters::oid(), and Botan::XMSS_WOTS_PublicKey::public_seed().
Referenced by Botan::XMSS_PrivateKey::tree_hash().
void Botan::XMSS_WOTS_PrivateKey::generate_public_key | ( | XMSS_WOTS_PublicKey & | pub_key, |
wots_keysig_t && | in_key_data, | ||
XMSS_Address & | adrs | ||
) |
Algorithm 4: "WOTS_genPK" Initializes a Winternitz One Time Signature+ (WOTS+) Public Key's key_data() member, with data derived from in_key_data using the WOTS chaining function.
[out] | pub_key | Public key to initialize key_data() member on. |
in_key_data | Input key material from private key used for public key generation. | |
adrs | Hash function address encoding the address of the WOTS+ key pair within a greater structure. |
Definition at line 41 of file xmss_wots_privatekey.cpp.
References BOTAN_ASSERT, Botan::XMSS_WOTS_PublicKey::chain(), Botan::XMSS_WOTS_Parameters::len(), Botan::XMSS_WOTS_PublicKey::m_wots_params, Botan::XMSS_WOTS_PublicKey::public_seed(), Botan::XMSS_Address::set_chain_address(), Botan::XMSS_WOTS_PublicKey::set_key_data(), Botan::XMSS_WOTS_Parameters::wots_parameter(), and Botan::XMSS_WOTS_PublicKey::wots_parameters().
|
virtualinherited |
Get the OID of the underlying public key scheme.
Reimplemented in Botan::XMSS_WOTS_Addressed_PublicKey.
Definition at line 30 of file pk_keys.cpp.
References Botan::Public_Key::algo_name(), and Botan::OIDS::lookup().
Referenced by Botan::DL_Scheme_PublicKey::algorithm_identifier(), Botan::Curve25519_PublicKey::algorithm_identifier(), Botan::McEliece_PublicKey::algorithm_identifier(), Botan::RSA_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), Botan::TPM_PrivateKey::algorithm_identifier(), and Botan::XMSS_WOTS_Addressed_PublicKey::get_oid().
|
inlineinherited |
Definition at line 215 of file xmss_wots_publickey.h.
References m_key.
Referenced by Botan::XMSS_WOTS_Verification_Operation::is_valid_signature().
|
inlineinherited |
|
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.
Definition at line 258 of file xmss_wots_publickey.h.
|
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::GOST_3410_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, and Botan::DSA_PublicKey.
Definition at line 114 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::GOST_3410_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, and Botan::DSA_PublicKey.
Definition at line 103 of file pk_keys.h.
Referenced by Botan::X509_Object::check_signature(), Botan::choose_sig_format(), Botan::PK_Signer::PK_Signer(), and Botan::PK_Verifier::PK_Verifier().
|
inlineinherited |
Convert the key into the raw key data. The key becomes a length len vector of n-byte elements.
Definition at line 193 of file xmss_wots_publickey.h.
References m_key.
|
inlineinherited |
Convert the key into the raw key data. The key becomes a length len vector of n-byte elements.
Definition at line 199 of file xmss_wots_publickey.h.
References m_key.
|
inlineinherited |
Definition at line 273 of file xmss_wots_publickey.h.
|
inlineinherited |
Definition at line 268 of file xmss_wots_publickey.h.
References Botan::XMSS_WOTS_PublicKey::m_key, and m_key.
|
inline |
Retrieves the i-th WOTS private key using pseudo random key (re-)generation.
i | Index of the key to retrieve. |
Definition at line 119 of file xmss_wots_privatekey.h.
References Botan::XMSS_Tools::concat(), and m_hash.
|
inline |
Retrieves the i-th WOTS private key using pseudo random key (re-)generation.
adrs | The address of the key to retrieve. |
Definition at line 135 of file xmss_wots_privatekey.h.
References Botan::XMSS_Address::bytes(), and m_hash.
|
inlineinherited |
Retrieves the i-th element out of the length len chain of n-byte elements contained in the public key.
i | index of the element. |
Definition at line 186 of file xmss_wots_publickey.h.
References m_key.
|
inlineoverridevirtual |
Reimplemented from Botan::Private_Key.
Definition at line 219 of file xmss_wots_privatekey.h.
Referenced by Botan::XMSS_WOTS_Addressed_PrivateKey::pkcs8_algorithm_identifier().
|
inlineoverridevirtual |
Implements Botan::Private_Key.
Definition at line 229 of file xmss_wots_privatekey.h.
Referenced by Botan::XMSS_WOTS_Addressed_PrivateKey::private_key_bits().
|
inherited |
Definition at line 41 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().
|
inline |
Retrieves the secret seed used to generate WOTS+ chains. The seed should be a uniformly random n-byte value.
Definition at line 191 of file xmss_wots_privatekey.h.
Referenced by Botan::XMSS_PrivateKey::raw_private_key().
|
inlineoverridevirtualinherited |
Implements Botan::Public_Key.
Definition at line 263 of file xmss_wots_publickey.h.
Referenced by Botan::XMSS_WOTS_Addressed_PublicKey::public_key_bits().
|
inlineinherited |
Definition at line 201 of file xmss_wots_publickey.h.
Referenced by generate_public_key(), and Botan::XMSS_WOTS_Verification_Operation::is_valid_signature().
|
inlineinherited |
Definition at line 203 of file xmss_wots_publickey.h.
|
inlineinherited |
Definition at line 219 of file xmss_wots_publickey.h.
References m_key.
Referenced by generate_public_key().
|
inlineinherited |
Definition at line 224 of file xmss_wots_publickey.h.
References m_key.
|
inline |
Sets the secret seed used to generate WOTS+ chains. The seed should be a uniformly random n-byte value.
private_seed | Uniformly random n-byte value. |
Definition at line 202 of file xmss_wots_privatekey.h.
Referenced by Botan::XMSS_PrivateKey::XMSS_PrivateKey().
|
inline |
Sets the secret seed used to generate WOTS+ chains. The seed should be a uniformly random n-byte value.
private_seed | Uniformly random n-byte value. |
Definition at line 213 of file xmss_wots_privatekey.h.
|
inlineinherited |
Definition at line 205 of file xmss_wots_publickey.h.
|
inlineinherited |
Definition at line 210 of file xmss_wots_publickey.h.
wots_keysig_t Botan::XMSS_WOTS_PrivateKey::sign | ( | const secure_vector< uint8_t > & | msg, |
XMSS_Address & | adrs | ||
) |
Algorithm 5: "WOTS_sign" Generates a signature from a private key and a message.
msg | A message to sign. |
adrs | An OTS hash address identifying the WOTS+ key pair used for signing. |
Definition at line 59 of file xmss_wots_privatekey.cpp.
References Botan::XMSS_WOTS_Parameters::append_checksum(), Botan::XMSS_WOTS_Parameters::base_w(), Botan::XMSS_WOTS_PublicKey::chain(), Botan::XMSS_WOTS_Parameters::len(), Botan::XMSS_WOTS_Parameters::len_1(), Botan::XMSS_WOTS_PublicKey::m_public_seed, Botan::XMSS_WOTS_PublicKey::m_wots_params, and Botan::XMSS_Address::set_chain_address().
Referenced by Botan::XMSS_WOTS_Signature_Operation::sign().
|
inherited |
Definition at line 17 of file pk_keys.cpp.
References Botan::Public_Key::algorithm_identifier(), Botan::BIT_STRING, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents_unlocked(), Botan::Public_Key::public_key_bits(), Botan::SEQUENCE, and Botan::DER_Encoder::start_cons().
Referenced by Botan::X509::BER_encode(), and Botan::X509::PEM_encode().
|
inlineinherited |
Definition at line 229 of file xmss_wots_publickey.h.
Referenced by generate_public_key(), Botan::XMSS_WOTS_Verification_Operation::is_valid_signature(), Botan::XMSS_PrivateKey::tree_hash(), Botan::XMSS_WOTS_Verification_Operation::update(), Botan::XMSS_WOTS_Signature_Operation::update(), Botan::XMSS_WOTS_Signature_Operation::XMSS_WOTS_Signature_Operation(), and Botan::XMSS_WOTS_Verification_Operation::XMSS_WOTS_Verification_Operation().
|
protectedinherited |
Definition at line 302 of file xmss_wots_publickey.h.
Referenced by Botan::XMSS_WOTS_PublicKey::chain().
|
protectedinherited |
Definition at line 304 of file xmss_wots_publickey.h.
Referenced by Botan::XMSS_WOTS_PublicKey::operator==().
|
protectedinherited |
Definition at line 305 of file xmss_wots_publickey.h.
Referenced by sign().
|
protectedinherited |
Definition at line 301 of file xmss_wots_publickey.h.
Referenced by Botan::XMSS_WOTS_PublicKey::chain(), generate_public_key(), and sign().