|
Botan 3.14.1
Crypto and TLS for C&
|
#include <hybrid_public_key.h>
Public Member Functions | |
| virtual std::unique_ptr< PK_Ops::Encryption > | _create_encryption_op (RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const |
| std::unique_ptr< PK_Ops::KEM_Encryption > | _create_kem_encryption_op (const PK_KEM_Options_Reader &options) const override |
| virtual std::unique_ptr< PK_Ops::Verification > | _create_verification_op (const PK_Signature_Options_Reader &options) const |
| 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 |
| std::unique_ptr< PK_Ops::Encryption > | create_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const |
| 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 |
| virtual std::unique_ptr< PK_Ops::Verification > | create_x509_verification_op (const AlgorithmIdentifier &signature_algorithm, std::string_view provider) const |
| 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 |
| Hybrid_KEM_PublicKey (std::vector< std::unique_ptr< Public_Key > > pks) | |
| 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 |
| const std::vector< std::unique_ptr< Public_Key > > & | public_keys () 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 |
Static Public Member Functions | |
| static std::unique_ptr< Hybrid_KEM_PublicKey > | load_for_group (Group_Params group, std::span< const uint8_t > concatenated_public_values) |
Protected Member Functions | |
| std::vector< std::unique_ptr< Private_Key > > | generate_other_sks_from_pks (RandomNumberGenerator &rng) const |
| Helper function for generate_another. Generate a new private key for each public key in this hybrid key. | |
| Hybrid_KEM_PublicKey ()=default | |
Composes a number of public keys as defined in this IETF draft: https://datatracker.ietf.org/doc/html/draft-ietf-tls-hybrid-design-04
To an upstream user, this composite key pair is presented as a KEM. Each individual key pair must either work as a KEX or as a KEM. Currently, the class can deal with ECC keys and Kyber.
The typical use case provides exactly two keys (one traditional KEX and one post-quantum secure KEM). However, this class technically allows composing any number of such keys. Composing more than two keys simply generates a shared secret based on more algorithms.
Note that this class is not generic enough for arbitrary use cases but serializes and parses keys and ciphertexts as described in the above-mentioned IETF draft for a post-quantum TLS 1.3.
Definition at line 41 of file hybrid_public_key.h.
|
explicit |
Definition at line 263 of file hybrid_public_key.cpp.
References Hybrid_KEM_PublicKey(), and Botan::Hybrid_PublicKey::Hybrid_PublicKey().
Referenced by Hybrid_KEM_PublicKey().
|
protecteddefault |
|
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/options 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. |
| options | which specify parameters of the encryption beyond those implicit to the public key itself |
Reimplemented in Botan::ElGamal_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, and Botan::TPM2::RSA_PublicKey.
Definition at line 107 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), BOTAN_UNUSED, and Botan::fmt().
Referenced by create_encryption_op(), and Botan::PK_Encryptor_EME::PK_Encryptor_EME().
|
overridevirtual |
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/options or throw
| options | which specify parameters of the KEM beyond those implicit to the public key itself |
Reimplemented from Botan::Public_Key.
Definition at line 308 of file hybrid_public_key.cpp.
References Botan::PK_KEM_Options_Reader::provider(), Botan::Hybrid_PublicKey::public_keys(), Botan::PK_KEM_Options_Reader::using_kdf(), and Botan::PK_KEM_Options_Reader::using_raw_shared_key().
|
virtualinherited |
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
| options | which specify parameters of the signature beyond those implicit to the public key itself |
Reimplemented in Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::Ed448_PublicKey, Botan::GOST_3410_PublicKey, Botan::HSS_LMS_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, Botan::SphincsPlus_PublicKey, Botan::TPM2::EC_PublicKey, Botan::TPM2::RSA_PublicKey, and Botan::XMSS_PublicKey.
Definition at line 119 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), BOTAN_UNUSED, and Botan::fmt().
Referenced by create_verification_op(), and Botan::PK_Verifier::PK_Verifier().
|
virtualinherited |
Reimplemented in Botan::GOST_3410_PublicKey.
Definition at line 32 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 148 of file pk_keys.h.
Referenced by _default_x509_signature_format(), Botan::Public_Key::message_part_size(), Botan::Public_Key::message_parts(), Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), and Botan::PK_Verifier::PK_Verifier().
|
overridevirtual |
Get the name of the underlying public key scheme.
Implements Botan::Asymmetric_Key.
Definition at line 270 of file hybrid_public_key.cpp.
References algo_name(), and Botan::Hybrid_PublicKey::public_keys().
Referenced by algo_name().
|
overridevirtual |
Return the X.509 AlgorithmIdentifier for this key
Implements Botan::Public_Key.
Definition at line 283 of file hybrid_public_key.cpp.
|
overridevirtualinherited |
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 29 of file hybrid_kem.cpp.
References public_keys(), and Botan::reduce().
|
inherited |
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 |
Definition at line 175 of file pk_keys.cpp.
References _create_encryption_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_enc_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Encryption_Options::with_provider().
|
inherited |
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 |
Definition at line 195 of file pk_keys.cpp.
References _create_kem_encryption_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_kem_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_KEM_Options::with_provider().
|
inherited |
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 |
Definition at line 156 of file pk_keys.cpp.
References _create_verification_op(), Botan::Asymmetric_Key::algo_name(), Botan::PK_Options_Reader_Access::for_verification(), Botan::parse_legacy_sig_options(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Signature_Options::with_provider().
|
virtualinherited |
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 in Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::Ed448_PublicKey, Botan::GOST_3410_PublicKey, Botan::HSS_LMS_PublicKey, Botan::RSA_PublicKey, Botan::SphincsPlus_PublicKey, and Botan::XMSS_PublicKey.
Definition at line 125 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_Verifier::PK_Verifier().
|
inlineinherited |
Definition at line 245 of file pk_keys.h.
References Botan::Asymmetric_Key::_default_x509_signature_format(), and default_x509_signature_format().
Referenced by default_x509_signature_format().
|
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::Asymmetric_Key.
Definition at line 47 of file hybrid_kem.h.
|
inherited |
Definition at line 96 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 304 of file hybrid_public_key.cpp.
References Botan::Hybrid_PublicKey::generate_other_sks_from_pks().
|
protectedinherited |
Helper function for generate_another. Generate a new private key for each public key in this hybrid key.
Definition at line 43 of file hybrid_kem.cpp.
References public_keys().
Referenced by Botan::TLS::Hybrid_KEM_PublicKey::generate_another(), and Hybrid_PublicKey().
|
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 20 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 172 of file pk_keys.h.
References get_oid(), and Botan::Asymmetric_Key::object_identifier().
Referenced by 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.
Definition at line 49 of file hybrid_kem.h.
|
static |
Definition at line 240 of file hybrid_public_key.cpp.
References BOTAN_ARG_CHECK, BOTAN_ASSERT_NOMSG, Botan::BufferSlicer::empty(), Botan::TLS::Group_Params::is_pqc_hybrid(), load_for_group(), Botan::load_public_key(), Botan::reduce(), and Botan::BufferSlicer::take().
Referenced by load_for_group(), and Botan::TLS::Callbacks::tls_deserialize_peer_public_key().
|
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 236 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 223 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 24 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 |
Return the subject public key encoding of this public key
Implements Botan::Public_Key.
Definition at line 287 of file hybrid_public_key.cpp.
References raw_public_key_bits().
|
inlineinherited |
Definition at line 66 of file hybrid_kem.h.
Referenced by Botan::TLS::Hybrid_KEM_PublicKey::_create_kem_encryption_op(), Botan::TLS::Hybrid_KEM_PublicKey::algo_name(), check_key(), generate_other_sks_from_pks(), raw_public_key_bits(), and Botan::TLS::Hybrid_KEM_PublicKey::raw_public_key_bits().
|
overridevirtual |
Return the raw public key bits (algorithm specific) with no extra encoding
For key agreements this is an alias for PK_Key_Agreement_Key::public_value.
Implements Botan::Public_Key.
Definition at line 291 of file hybrid_public_key.cpp.
References Botan::concat(), Botan::Hybrid_PublicKey::public_keys(), and Botan::reduce().
Referenced by public_key_bits().
|
inherited |
Return the SubjectPublicKeyInfo encoding of this public key
This is the subjectPublicKey field plus the algorithm-specific parameters
Definition at line 65 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().
|
overridevirtualinherited |
Return true if this key could be used for the specified type of operation.
Implements Botan::Asymmetric_Key.
Definition at line 39 of file hybrid_kem.cpp.
References Botan::KeyEncapsulation.