Botan 3.9.0
Crypto and TLS for C&
|
An HSS/LMS private key. More...
#include <hss_lms.h>
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::Decryption > | create_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const |
virtual std::unique_ptr< PK_Ops::Encryption > | create_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const |
virtual std::unique_ptr< PK_Ops::KEM_Decryption > | create_kem_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const |
virtual std::unique_ptr< PK_Ops::KEM_Encryption > | create_kem_encryption_op (std::string_view params, std::string_view provider) const |
virtual std::unique_ptr< PK_Ops::Key_Agreement > | create_key_agreement_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const |
std::unique_ptr< PK_Ops::Signature > | create_signature_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override |
std::unique_ptr< PK_Ops::Verification > | create_verification_op (std::string_view params, std::string_view provider) const override |
std::unique_ptr< PK_Ops::Verification > | create_x509_verification_op (const AlgorithmIdentifier &signature_algorithm, std::string_view provider) const override |
Signature_Format | default_x509_signature_format () const |
size_t | estimated_strength () const override |
std::string | fingerprint_private (std::string_view alg) const |
std::string | fingerprint_public (std::string_view alg="SHA-256") const |
std::unique_ptr< Private_Key > | generate_another (RandomNumberGenerator &rng) const override |
virtual const BigInt & | get_int_field (std::string_view field) const |
OID | get_oid () const |
HSS_LMS_PrivateKey (const HSS_LMS_PrivateKey &other)=delete | |
HSS_LMS_PrivateKey (HSS_LMS_PrivateKey &&other)=default | |
HSS_LMS_PrivateKey (RandomNumberGenerator &rng, std::string_view algo_params) | |
Construct a new hss lms privatekey object. | |
BOTAN_FUTURE_EXPLICIT | HSS_LMS_PrivateKey (std::span< const uint8_t > private_key_bytes) |
Load an existing LMS private key using its bytes. | |
size_t | key_length () const override |
size_t | message_part_size () const |
size_t | message_parts () const |
OID | object_identifier () const override |
HSS_LMS_PrivateKey & | operator= (const HSS_LMS_PrivateKey &other)=delete |
HSS_LMS_PrivateKey & | operator= (HSS_LMS_PrivateKey &&other)=delete |
AlgorithmIdentifier | pkcs8_algorithm_identifier () const override |
secure_vector< uint8_t > | private_key_bits () const override |
secure_vector< uint8_t > | private_key_info () const |
std::unique_ptr< Public_Key > | public_key () const override |
std::vector< uint8_t > | public_key_bits () const override |
secure_vector< uint8_t > | raw_private_key_bits () const override |
std::vector< uint8_t > | raw_public_key_bits () const override |
std::optional< uint64_t > | remaining_operations () const override |
bool | stateful_operation () const override |
std::vector< uint8_t > | subject_public_key () const |
bool | supports_operation (PublicKeyOperation op) const override |
~HSS_LMS_PrivateKey () override |
Protected Attributes | |
std::shared_ptr< HSS_LMS_PublicKeyInternal > | m_public |
An HSS/LMS private key.
HSS/LMS is a statefule hash-based signature scheme. This means the private key must be (securely) updated after using it for signing. Also, there is a maximal number of signatures that can be created using one HSS/LMS key pair, which depends on the number and size of LMS layers of the chosen HSS/LMS instance. For the selection of a sensible parameter set, refer to RFC 8554 6.4.
The format of the HSS/LMS private key is not defined in RFC 8554. We use the following format (big endian):
PrivateKey = u32str(L) || u64str(idx) || u32str(LMS algorithm id (root layer)) || u32str(LMOTS algorithm id (root layer)) || ... || u32str(LMS algorithm id (bottom layer)) || u32str(LMOTS algorithm id (bottom layer)) || HSS_SEED || HSS_Identifier
L: Number of LMS layers Idx: Number of signatures already created using this private key HSS_SEED: Seed to derive LMS Seeds (see RFC 8554 Appendix A) like in SECRET_METHOD 2 of https://github.com/cisco/hash-sigs. As long as the hash functions output length. HSS_Identifier: 16 bytes long.
The HSS/LMS instance to use for creating new keys is defined using an algorithm parameter sting, i.e. to define which hash function (hash), LMS tree height (h) and OTS Winternitz coefficient widths (w) to use. The syntax is the following:
HSS-LMS(<hash>,HW(<h>,<w>),HW(<h>,<w>),...)
e.g. 'HSS-LMS(SHA-256,HW(5,1),HW(5,1))' to use SHA-256 in a two-layer HSS instance with a LMS tree hights 5 and w=1. The following parameters are allowed (which are specified in RFC 8554 and draft-fluhrer-lms-more-parm-sets-11):
hash: 'SHA-256', 'Truncated(SHA-256,192)', 'SHAKE-256(256)', SHAKE-256(192) h: '5', '10', '15', '20', '25' w: '1', '2', '4', '8'
Note: The selected hash function is also used for seed derivation.
Botan::HSS_LMS_PrivateKey::HSS_LMS_PrivateKey | ( | std::span< const uint8_t > | private_key_bytes | ) |
Load an existing LMS private key using its bytes.
Definition at line 117 of file hss_lms.cpp.
References Botan::HSS_LMS_PublicKeyInternal::create(), Botan::HSS_LMS_PrivateKeyInternal::from_bytes_or_throw(), Botan::HSS_LMS_PublicKey::m_public, Botan::CT::scoped_poison(), and Botan::CT::unpoison().
Referenced by generate_another(), HSS_LMS_PrivateKey(), HSS_LMS_PrivateKey(), operator=(), and operator=().
Botan::HSS_LMS_PrivateKey::HSS_LMS_PrivateKey | ( | RandomNumberGenerator & | rng, |
std::string_view | algo_params ) |
Construct a new hss lms privatekey object.
rng | random number generator |
algo_params | string is format 'HSS-LMS(<hash>,HW(<h>,<w>),HW(<h>,<w>),...)' |
Definition at line 124 of file hss_lms.cpp.
References Botan::HSS_LMS_PublicKeyInternal::create(), Botan::HSS_LMS_PublicKey::m_public, Botan::CT::scoped_poison(), and Botan::CT::unpoison().
|
overridedefault |
|
delete |
References HSS_LMS_PrivateKey().
|
default |
References HSS_LMS_PrivateKey().
|
virtualinherited |
Reimplemented in Botan::GOST_3410_PublicKey.
Definition at line 30 of file pk_keys.cpp.
References _signature_element_size_for_DER_encoding(), Botan::DerSequence, and Botan::Standard.
Referenced by Botan::X509_Object::choose_sig_format(), Botan::Public_Key::default_x509_signature_format(), and Botan::PK_Verifier::PK_Verifier().
|
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 137 of file pk_keys.h.
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().
|
overridevirtualinherited |
Get the name of the underlying public key scheme.
Implements Botan::Asymmetric_Key.
Definition at line 34 of file hss_lms.cpp.
References m_public.
Referenced by Botan::HSS_LMS_PrivateKey::create_signature_op(), create_verification_op(), create_x509_verification_op(), and operator=().
|
overridevirtualinherited |
Implements Botan::Public_Key.
Definition at line 38 of file hss_lms.cpp.
References m_public.
Referenced by create_x509_verification_op(), and operator=().
|
overridevirtualinherited |
Implements Botan::Asymmetric_Key.
Definition at line 46 of file hss_lms.cpp.
Referenced by operator=().
|
virtualinherited |
This is an internal library function exposed on key types. In 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, Botan::SM2_PrivateKey, and Botan::TPM2::RSA_PrivateKey.
Definition at line 119 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
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, Botan::SM2_PublicKey, and Botan::TPM2::RSA_PublicKey.
Definition at line 98 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_Encryptor_EME::PK_Encryptor_EME().
|
virtualinherited |
This is an internal library function exposed on key types. In 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::Classic_McEliece_PrivateKey, Botan::FrodoKEM_PrivateKey, Botan::KEX_to_KEM_Adapter_PrivateKey, Botan::Kyber_PrivateKey, Botan::McEliece_PrivateKey, Botan::RSA_PrivateKey, and Botan::TLS::Hybrid_KEM_PrivateKey.
Definition at line 125 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
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
params | additional parameters |
provider | the 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 104 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_KEM_Encryptor::PK_KEM_Encryptor().
|
virtualinherited |
This is an internal library function exposed on key types. In 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::DH_PrivateKey, Botan::ECDH_PrivateKey, Botan::X25519_PrivateKey, and Botan::X448_PrivateKey.
Definition at line 137 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_Key_Agreement::PK_Key_Agreement().
|
overridevirtual |
This is an internal library function exposed on key types. In 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 198 of file hss_lms.cpp.
References Botan::HSS_LMS_PublicKey::algo_name(), BOTAN_ARG_CHECK, BOTAN_UNUSED, and Botan::HSS_LMS_PublicKey::m_public.
|
overridevirtualinherited |
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
params | additional parameters |
provider | the provider to use |
Reimplemented from Botan::Public_Key.
Definition at line 88 of file hss_lms.cpp.
References algo_name(), and m_public.
Referenced by operator=().
|
overridevirtualinherited |
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.
signature_algorithm | is the X.509 algorithm identifier encoding the padding scheme and hash hash function used in the signature if applicable. |
provider | the provider to use |
Reimplemented from Botan::Public_Key.
Definition at line 96 of file hss_lms.cpp.
References algo_name(), algorithm_identifier(), and m_public.
Referenced by operator=().
|
inlineinherited |
Definition at line 229 of file pk_keys.h.
References Botan::Asymmetric_Key::_default_x509_signature_format(), and default_x509_signature_format().
Referenced by default_x509_signature_format().
|
overridevirtualinherited |
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::Asymmetric_Key.
Definition at line 26 of file hss_lms.cpp.
References m_public.
Referenced by operator=().
|
inherited |
Definition at line 94 of file pk_keys.cpp.
References Botan::create_hex_fingerprint(), and 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 87 of file pk_keys.cpp.
References Botan::create_hex_fingerprint(), and subject_public_key().
Referenced by public_key_bits().
|
overridevirtual |
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 164 of file hss_lms.cpp.
References HSS_LMS_PrivateKey().
|
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.
References algo_name().
Referenced by estimated_strength(), Botan::EC_PublicKey::get_int_field(), and Botan::RSA_PublicKey::get_int_field().
|
inlineinherited |
Deprecated version of object_identifier
Definition at line 161 of file pk_keys.h.
References get_oid(), and Botan::Asymmetric_Key::object_identifier().
Referenced by get_oid().
|
overridevirtualinherited |
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 22 of file hss_lms.cpp.
References m_public.
Referenced by operator=().
|
inlineinherited |
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.
Definition at line 221 of file pk_keys.h.
References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_part_size().
Referenced by message_part_size().
|
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.
Definition at line 208 of file pk_keys.h.
References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_parts().
Referenced by message_parts().
|
overridevirtualinherited |
Get the OID of the underlying public key scheme.
Reimplemented from Botan::Asymmetric_Key.
Definition at line 42 of file hss_lms.cpp.
References m_public.
Referenced by operator=().
|
delete |
References HSS_LMS_PrivateKey().
|
delete |
|
overridevirtual |
Reimplemented from Botan::Private_Key.
Definition at line 156 of file hss_lms.cpp.
References Botan::OID::from_string(), and Botan::AlgorithmIdentifier::USE_EMPTY_PARAM.
Referenced by operator=().
|
overridevirtual |
Implements Botan::Private_Key.
Definition at line 140 of file hss_lms.cpp.
References Botan::CT::driveby_unpoison(), and Botan::CT::scoped_poison().
Referenced by operator=(), and raw_private_key_bits().
|
inherited |
Definition at line 68 of file pk_keys.cpp.
References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::OctetString, pkcs8_algorithm_identifier(), private_key_bits(), and Botan::DER_Encoder::start_sequence().
Referenced by Botan::PKCS8::BER_encode(), Botan::PKCS8::BER_encode_encrypted_pbkdf_iter(), Botan::PKCS8::BER_encode_encrypted_pbkdf_msec(), Botan::PKCS8::PEM_encode(), and public_key().
|
overridevirtual |
Allocate a new object for the public key associated with this private key.
Implements Botan::Private_Key.
Definition at line 149 of file hss_lms.cpp.
Referenced by operator=().
|
overridevirtualinherited |
Implements Botan::Public_Key.
Definition at line 55 of file hss_lms.cpp.
References raw_public_key_bits().
Referenced by operator=().
|
overridevirtual |
Note: some algorithms (for example RSA) do not have an obvious encoding for this value due to having many different values, and thus not implement this function. The default implementation throws Not_Implemented
Reimplemented from Botan::Private_Key.
Definition at line 145 of file hss_lms.cpp.
References private_key_bits().
Referenced by operator=().
|
overridevirtualinherited |
For key agreements this is an alias for PK_Key_Agreement_Key::public_value.
Note: some algorithms (for example RSA) do not have an obvious encoding for this value due to having many different values, and thus throw Not_Implemented when invoking this method.
Implements Botan::Public_Key.
Definition at line 51 of file hss_lms.cpp.
References m_public.
Referenced by operator=(), and public_key_bits().
|
overridevirtual |
Retrieves the number of remaining signatures for this private key.
Reimplemented from Botan::Private_Key.
Definition at line 160 of file hss_lms.cpp.
|
inlineoverridevirtual |
Indicates if this key is stateful, ie that performing a private key operation requires updating the key storage.
Reimplemented from Botan::Private_Key.
Definition at line 148 of file hss_lms.h.
|
inherited |
Definition at line 56 of file pk_keys.cpp.
References algorithm_identifier(), Botan::BitString, Botan::DER_Encoder::encode(), 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().
|
overridevirtualinherited |
Return true if this key could be used for the specified type of operation.
Implements Botan::Asymmetric_Key.
Definition at line 107 of file hss_lms.cpp.
References Botan::Signature.
Referenced by operator=().
|
protectedinherited |
Definition at line 74 of file hss_lms.h.
Referenced by algo_name(), algorithm_identifier(), Botan::HSS_LMS_PrivateKey::create_signature_op(), create_verification_op(), create_x509_verification_op(), estimated_strength(), Botan::HSS_LMS_PrivateKey::HSS_LMS_PrivateKey(), Botan::HSS_LMS_PrivateKey::HSS_LMS_PrivateKey(), HSS_LMS_PublicKey(), key_length(), object_identifier(), and raw_public_key_bits().