|
Botan 3.13.0
Crypto and TLS for C&
|
#include <xmss.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::Encryption > | create_encryption_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 |
| 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 &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_Key > | generate_another (RandomNumberGenerator &rng) const final |
| virtual const BigInt & | get_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_Parameters & | xmss_parameters () const |
Friends | |
| class | XMSS_Verification_Operation |
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. |
| Random Number Generators | A random number generator to use for key generation. |
Definition at line 100 of file xmss_publickey.cpp.
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().
| 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.
| alg_id | the X.509 AlgorithmIdentifier |
| key_bits | DER encoded public key bits |
Definition at line 108 of file xmss_publickey.cpp.
References Botan::BufferSlicer::copy_as_secure_vector(), Botan::XMSS_Parameters::from_id(), Botan::AlgorithmIdentifier::parameters_are_empty(), public_seed(), root(), and Botan::BufferSlicer::skip().
| 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.
| key_bits | DER encoded public key bits |
Definition at line 106 of file xmss_publickey.cpp.
References XMSS_PublicKey().
| 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.
| xmss_oid | Identifier for the selected XMSS signature method. |
| root | Root node value. |
| public_seed | Public seed value. |
Definition at line 130 of file xmss_publickey.cpp.
References BOTAN_ARG_CHECK, Botan::XMSS_Parameters::from_id(), public_seed(), and root().
|
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 144 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().
|
inlineoverridevirtual |
Get the name of the underlying public key scheme.
Implements Botan::Asymmetric_Key.
Definition at line 81 of file xmss.h.
Referenced by Botan::XMSS_PrivateKey::create_signature_op(), create_verification_op(), and create_x509_verification_op().
|
inlineoverridevirtual |
Return the X.509 AlgorithmIdentifier for this key
Implements Botan::Public_Key.
Definition at line 83 of file xmss.h.
References Botan::Asymmetric_Key::object_identifier(), and Botan::AlgorithmIdentifier::USE_EMPTY_PARAM.
Referenced by create_x509_verification_op().
|
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.
| Random Number Generators | rng to use for randomized testing (may be ignored) |
| strong | whether to perform strong and lengthy version of the test, however for many algorithms this has no effect |
Implements Botan::Asymmetric_Key.
Definition at line 159 of file xmss_publickey.cpp.
|
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
| Random Number Generators | 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 105 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 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 111 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_KEM_Encryptor::PK_KEM_Encryptor().
|
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
| params | additional parameters |
| provider | the provider to use |
Reimplemented from Botan::Public_Key.
Definition at line 167 of file xmss_publickey.cpp.
References algo_name().
|
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.
| 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 175 of file xmss_publickey.cpp.
References algo_name(), and algorithm_identifier().
|
inlineinherited |
Definition at line 241 of file pk_keys.h.
References Botan::Asymmetric_Key::_default_x509_signature_format(), and default_x509_signature_format().
Referenced by default_x509_signature_format().
|
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.
Implements Botan::Asymmetric_Key.
Definition at line 151 of file xmss_publickey.cpp.
References Botan::XMSS_Parameters::estimated_strength(), and xmss_parameters().
|
inherited |
Definition at line 94 of file pk_keys.cpp.
References Botan::create_hex_fingerprint(), and subject_public_key().
Referenced by public_key_bits().
|
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.
References xmss_parameters().
|
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 168 of file pk_keys.h.
References get_oid(), and Botan::Asymmetric_Key::object_identifier().
Referenced by get_oid().
|
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.
References Botan::XMSS_Parameters::estimated_strength(), and xmss_parameters().
|
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.
Definition at line 232 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 219 of file pk_keys.h.
References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_parts().
Referenced by message_parts().
|
virtualinherited |
Get the OID of the underlying public key scheme.
Reimplemented in Botan::Classic_McEliece_PublicKey, Botan::Dilithium_PublicKey, Botan::FrodoKEM_PublicKey, Botan::HSS_LMS_PublicKey, Botan::Kyber_PublicKey, and Botan::SphincsPlus_PublicKey.
Definition at line 22 of file pk_keys.cpp.
References algo_name(), Botan::fmt(), and Botan::OID::from_string().
Referenced by Botan::DH_PublicKey::algorithm_identifier(), Botan::DSA_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), Botan::Ed25519_PublicKey::algorithm_identifier(), Botan::Ed448_PublicKey::algorithm_identifier(), Botan::ElGamal_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::McEliece_PublicKey::algorithm_identifier(), Botan::RSA_PublicKey::algorithm_identifier(), Botan::TPM_PrivateKey::algorithm_identifier(), Botan::X25519_PublicKey::algorithm_identifier(), Botan::X448_PublicKey::algorithm_identifier(), Botan::XMSS_PublicKey::algorithm_identifier(), estimated_strength(), and Botan::Public_Key::get_oid().
|
overridevirtual |
Returns the encoded public key as defined in RFC draft-vangeest-x509-hash-sigs-03.
Implements Botan::Public_Key.
Definition at line 190 of file xmss_publickey.cpp.
References Botan::DER_Encoder::encode(), Botan::OctetString, and raw_public_key_bits().
|
protected |
Definition at line 139 of file xmss_publickey.cpp.
Referenced by Botan::XMSS_PrivateKey::public_key(), Botan::XMSS_PrivateKey::XMSS_PrivateKey(), XMSS_PublicKey(), XMSS_PublicKey(), and XMSS_Verification_Operation.
| std::vector< uint8_t > Botan::XMSS_PublicKey::raw_public_key | ( | ) | const |
Definition at line 196 of file xmss_publickey.cpp.
References raw_public_key_bits().
Referenced by Botan::XMSS_PrivateKey::raw_private_key().
|
overridevirtual |
Generates a byte sequence representing the XMSS public key, as defined in [1] (p. 23, "XMSS Public Key")
Implements Botan::Public_Key.
Definition at line 186 of file xmss_publickey.cpp.
Referenced by public_key_bits(), and raw_public_key().
|
protected |
Definition at line 143 of file xmss_publickey.cpp.
Referenced by Botan::XMSS_PrivateKey::XMSS_PrivateKey(), XMSS_PublicKey(), XMSS_PublicKey(), and XMSS_Verification_Operation.
|
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.
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().
|
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().
|
protected |
Definition at line 147 of file xmss_publickey.cpp.
Referenced by estimated_strength(), generate_another(), key_length(), Botan::XMSS_PrivateKey::public_key(), Botan::XMSS_PrivateKey::XMSS_PrivateKey(), Botan::XMSS_PrivateKey::XMSS_PrivateKey(), and 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.