Botan 3.9.0
Crypto and TLS for C&
Botan::Hybrid_PublicKey Class Referenceabstract

Abstraction for a combined KEM public key. More...

#include <hybrid_kem.h>

Inheritance diagram for Botan::Hybrid_PublicKey:
Botan::Public_Key Botan::Asymmetric_Key Botan::TLS::Hybrid_KEM_PublicKey Botan::TLS::Hybrid_KEM_PrivateKey

Public Member Functions

virtual Signature_Format _default_x509_signature_format () const
virtual std::optional< size_t > _signature_element_size_for_DER_encoding () const
virtual std::string algo_name () const =0
virtual AlgorithmIdentifier algorithm_identifier () const =0
bool check_key (RandomNumberGenerator &rng, bool strong) const override
virtual std::unique_ptr< PK_Ops::Encryptioncreate_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
virtual std::unique_ptr< PK_Ops::KEM_Encryptioncreate_kem_encryption_op (std::string_view params, std::string_view provider) const
virtual std::unique_ptr< PK_Ops::Verificationcreate_verification_op (std::string_view params, std::string_view provider) const
virtual std::unique_ptr< PK_Ops::Verificationcreate_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
virtual std::unique_ptr< Private_Keygenerate_another (RandomNumberGenerator &rng) const =0
virtual const BigIntget_int_field (std::string_view field) const
OID get_oid () const
 Hybrid_PublicKey (const Hybrid_PublicKey &)=delete
 Hybrid_PublicKey (Hybrid_PublicKey &&)=default
 Hybrid_PublicKey (std::vector< std::unique_ptr< Public_Key > > public_keys)
 Constructor for a list of multiple KEM public keys.
size_t key_length () const override
size_t message_part_size () const
size_t message_parts () const
virtual OID object_identifier () const
Hybrid_PublicKeyoperator= (const Hybrid_PublicKey &)=delete
Hybrid_PublicKeyoperator= (Hybrid_PublicKey &&)=default
std::vector< uint8_t > public_key_bits () const override
 Return the public key bits of this hybrid key as the concatenated bytes of the individual public keys (without encoding).
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
 ~Hybrid_PublicKey () override=default

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_PublicKey ()=default

Detailed Description

Abstraction for a combined KEM public key.

Two or more KEM public keys are combined into a single KEM public key. Derived classes must implement the abstract methods to provide the encryption operation, e.g. by specifying how encryption results are combined to the ciphertext and how a KEM combiner is applied to derive the shared secret using the individual shared secrets, ciphertexts, and other context information.

Definition at line 31 of file hybrid_kem.h.

Constructor & Destructor Documentation

◆ Hybrid_PublicKey() [1/4]

Botan::Hybrid_PublicKey::Hybrid_PublicKey ( std::vector< std::unique_ptr< Public_Key > > public_keys)
explicit

Constructor for a list of multiple KEM public keys.

To use KEX algorithms use the KEX_to_KEM_Adapter_PublicKey.

Parameters
public_keysList of public keys to combine

Definition at line 19 of file hybrid_kem.cpp.

19 :
20 m_pks(std::move(pks)), m_key_length(0), m_estimated_strength(0) {
21 BOTAN_ARG_CHECK(m_pks.size() >= 2, "List of public keys must include at least two keys");
22 for(const auto& pk : m_pks) {
23 BOTAN_ARG_CHECK(pk != nullptr, "List of public keys contains a nullptr");
25 fmt("Public key type '{}' does not support key encapsulation", pk->algo_name()).c_str());
26 m_key_length = std::max(m_key_length, pk->key_length());
27 m_estimated_strength = std::max(m_estimated_strength, pk->estimated_strength());
28 }
29}
#define BOTAN_ARG_CHECK(expr, msg)
Definition assert.h:33
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53

References BOTAN_ARG_CHECK, Botan::fmt(), and Botan::KeyEncapsulation.

Referenced by Botan::TLS::Hybrid_KEM_PrivateKey::Hybrid_KEM_PrivateKey(), Botan::TLS::Hybrid_KEM_PublicKey::Hybrid_KEM_PublicKey(), Hybrid_PublicKey(), Hybrid_PublicKey(), operator=(), and operator=().

◆ Hybrid_PublicKey() [2/4]

Botan::Hybrid_PublicKey::Hybrid_PublicKey ( Hybrid_PublicKey && )
default

References Hybrid_PublicKey().

◆ Hybrid_PublicKey() [3/4]

Botan::Hybrid_PublicKey::Hybrid_PublicKey ( const Hybrid_PublicKey & )
delete

References Hybrid_PublicKey().

◆ ~Hybrid_PublicKey()

Botan::Hybrid_PublicKey::~Hybrid_PublicKey ( )
overridedefault

◆ Hybrid_PublicKey() [4/4]

Botan::Hybrid_PublicKey::Hybrid_PublicKey ( )
protecteddefault

Member Function Documentation

◆ _default_x509_signature_format()

Signature_Format Botan::Asymmetric_Key::_default_x509_signature_format ( ) const
virtualinherited

◆ _signature_element_size_for_DER_encoding()

virtual std::optional< size_t > Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding ( ) const
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.

137{ return {}; }

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().

◆ algo_name()

virtual std::string Botan::Asymmetric_Key::algo_name ( ) const
pure virtualinherited

Get the name of the underlying public key scheme.

Returns
name of the public key scheme

Implemented in Botan::Classic_McEliece_PublicKey, Botan::DH_PublicKey, Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::ECDH_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::Ed448_PublicKey, Botan::ElGamal_PublicKey, Botan::FrodoKEM_PublicKey, Botan::GOST_3410_PublicKey, Botan::HSS_LMS_PublicKey, Botan::KEX_to_KEM_Adapter_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, Botan::SphincsPlus_PublicKey, Botan::TLS::Hybrid_KEM_PublicKey, Botan::TPM2::EC_PrivateKey, Botan::TPM2::EC_PublicKey, Botan::TPM_PrivateKey, Botan::X25519_PublicKey, Botan::X448_PublicKey, and Botan::XMSS_PublicKey.

Referenced by Botan::PKCS8::BER_encode(), botan_pubkey_sm2_compute_za(), Botan::TLS::Policy::check_peer_key_acceptable(), Botan::TLS::Handshake_State::choose_sig_format(), Botan::X509_Object::choose_sig_format(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::Private_Key::create_decryption_op(), Botan::Public_Key::create_encryption_op(), Botan::Private_Key::create_kem_decryption_op(), Botan::Public_Key::create_kem_encryption_op(), Botan::Private_Key::create_key_agreement_op(), Botan::Private_Key::create_signature_op(), Botan::Public_Key::create_verification_op(), Botan::Public_Key::create_x509_verification_op(), get_int_field(), object_identifier(), Botan::TLS::Handshake_State::parse_sig_format(), Botan::PK_Decryptor_EME::PK_Decryptor_EME(), Botan::PK_Encryptor_EME::PK_Encryptor_EME(), Botan::PK_KEM_Decryptor::PK_KEM_Decryptor(), Botan::PK_KEM_Encryptor::PK_KEM_Encryptor(), Botan::PK_Key_Agreement::PK_Key_Agreement(), Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), Botan::PK_Verifier::PK_Verifier(), and Botan::Private_Key::raw_private_key_bits().

◆ algorithm_identifier()

◆ check_key()

bool Botan::Hybrid_PublicKey::check_key ( RandomNumberGenerator & rng,
bool strong ) const
overridevirtual

Implements Botan::Asymmetric_Key.

Definition at line 31 of file hybrid_kem.cpp.

31 {
32 return reduce(public_keys(), true, [&](bool ckr, const auto& key) { return ckr && key->check_key(rng, strong); });
33}
const std::vector< std::unique_ptr< Public_Key > > & public_keys() const
Definition hybrid_kem.h:66
RetT reduce(const std::vector< KeyT > &keys, RetT acc, ReducerT reducer)
Definition stl_util.h:39

References public_keys(), and Botan::reduce().

◆ create_encryption_op()

std::unique_ptr< PK_Ops::Encryption > Botan::Public_Key::create_encryption_op ( RandomNumberGenerator & rng,
std::string_view params,
std::string_view provider ) const
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

Parameters
rnga 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.
paramsadditional parameters
providerthe 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.

100 {
101 throw Lookup_Error(fmt("{} does not support encryption", algo_name()));
102}
virtual std::string algo_name() const =0

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

Referenced by Botan::PK_Encryptor_EME::PK_Encryptor_EME().

◆ create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::Public_Key::create_kem_encryption_op ( std::string_view params,
std::string_view provider ) const
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

Parameters
paramsadditional parameters
providerthe 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.

105 {
106 throw Lookup_Error(fmt("{} does not support KEM encryption", algo_name()));
107}

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

Referenced by Botan::PK_KEM_Encryptor::PK_KEM_Encryptor().

◆ create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Public_Key::create_verification_op ( std::string_view params,
std::string_view provider ) const
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

Parameters
paramsadditional parameters
providerthe 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::SM2_PublicKey, Botan::SphincsPlus_PublicKey, Botan::TPM2::EC_PublicKey, Botan::TPM2::RSA_PublicKey, and Botan::XMSS_PublicKey.

Definition at line 109 of file pk_keys.cpp.

110 {
111 throw Lookup_Error(fmt("{} does not support verification", algo_name()));
112}

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

Referenced by Botan::PK_Verifier::PK_Verifier().

◆ create_x509_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Public_Key::create_x509_verification_op ( const AlgorithmIdentifier & signature_algorithm,
std::string_view provider ) const
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.

Parameters
signature_algorithmis the X.509 algorithm identifier encoding the padding scheme and hash hash function used in the signature if applicable.
providerthe 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 114 of file pk_keys.cpp.

115 {
116 throw Lookup_Error(fmt("{} does not support X.509 verification", algo_name()));
117}

References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().

Referenced by Botan::PK_Verifier::PK_Verifier().

◆ default_x509_signature_format()

Signature_Format Botan::Public_Key::default_x509_signature_format ( ) const
inlineinherited

Definition at line 229 of file pk_keys.h.

229 {
231 }
virtual Signature_Format _default_x509_signature_format() const
Definition pk_keys.cpp:30

References Botan::Asymmetric_Key::_default_x509_signature_format(), and default_x509_signature_format().

Referenced by default_x509_signature_format().

◆ estimated_strength()

size_t Botan::Hybrid_PublicKey::estimated_strength ( ) const
inlineoverridevirtual

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.

Returns
estimated strength in bits

Implements Botan::Asymmetric_Key.

Definition at line 47 of file hybrid_kem.h.

47{ return m_estimated_strength; }

◆ fingerprint_public()

std::string Botan::Public_Key::fingerprint_public ( std::string_view alg = "SHA-256") const
inherited
Returns
Hash of the subject public key

Definition at line 87 of file pk_keys.cpp.

87 {
88 return create_hex_fingerprint(subject_public_key(), hash_algo);
89}
std::vector< uint8_t > subject_public_key() const
Definition pk_keys.cpp:56
std::string create_hex_fingerprint(const uint8_t bits[], size_t bits_len, std::string_view hash_name)
Definition pk_keys.cpp:38

References Botan::create_hex_fingerprint(), and subject_public_key().

Referenced by public_key_bits().

◆ generate_another()

◆ generate_other_sks_from_pks()

std::vector< std::unique_ptr< Private_Key > > Botan::Hybrid_PublicKey::generate_other_sks_from_pks ( RandomNumberGenerator & rng) const
protected

Helper function for generate_another. Generate a new private key for each public key in this hybrid key.

Definition at line 45 of file hybrid_kem.cpp.

46 {
47 std::vector<std::unique_ptr<Private_Key>> new_private_keys;
48 new_private_keys.reserve(public_keys().size());
49 for(const auto& pk : public_keys()) {
50 new_private_keys.push_back(pk->generate_another(rng));
51 }
52 return new_private_keys;
53}

References public_keys().

Referenced by Botan::TLS::Hybrid_KEM_PublicKey::generate_another(), and Hybrid_PublicKey().

◆ get_int_field()

const BigInt & Botan::Asymmetric_Key::get_int_field ( std::string_view field) const
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.

18 {
19 throw Unknown_PK_Field_Name(algo_name(), field);
20}

References algo_name().

Referenced by estimated_strength(), Botan::EC_PublicKey::get_int_field(), and Botan::RSA_PublicKey::get_int_field().

◆ get_oid()

OID Botan::Public_Key::get_oid ( ) const
inlineinherited

Deprecated version of object_identifier

Definition at line 161 of file pk_keys.h.

161{ return this->object_identifier(); }
virtual OID object_identifier() const
Definition pk_keys.cpp:22

References get_oid(), and Botan::Asymmetric_Key::object_identifier().

Referenced by get_oid().

◆ key_length()

size_t Botan::Hybrid_PublicKey::key_length ( ) const
inlineoverridevirtual

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.

49{ return m_key_length; }

◆ message_part_size()

size_t Botan::Public_Key::message_part_size ( ) const
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.

Returns
size of the message parts in bits

Definition at line 221 of file pk_keys.h.

221 {
222 return _signature_element_size_for_DER_encoding().value_or(0);
223 }

References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_part_size().

Referenced by message_part_size().

◆ message_parts()

size_t Botan::Public_Key::message_parts ( ) const
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.

Returns
number of message parts

Definition at line 208 of file pk_keys.h.

208 {
210 }

References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_parts().

Referenced by message_parts().

◆ object_identifier()

◆ operator=() [1/2]

Hybrid_PublicKey & Botan::Hybrid_PublicKey::operator= ( const Hybrid_PublicKey & )
delete

References Hybrid_PublicKey().

◆ operator=() [2/2]

Hybrid_PublicKey & Botan::Hybrid_PublicKey::operator= ( Hybrid_PublicKey && )
default

References Hybrid_PublicKey().

◆ public_key_bits()

std::vector< uint8_t > Botan::Hybrid_PublicKey::public_key_bits ( ) const
inlineoverridevirtual

Return the public key bits of this hybrid key as the concatenated bytes of the individual public keys (without encoding).

Returns
the public key bytes

Implements Botan::Public_Key.

Definition at line 61 of file hybrid_kem.h.

61{ return raw_public_key_bits(); }
std::vector< uint8_t > raw_public_key_bits() const override

References raw_public_key_bits().

◆ public_keys()

const std::vector< std::unique_ptr< Public_Key > > & Botan::Hybrid_PublicKey::public_keys ( ) const
inline

◆ raw_public_key_bits()

std::vector< uint8_t > Botan::Hybrid_PublicKey::raw_public_key_bits ( ) const
overridevirtual
Returns
binary public key bits, with no additional encoding

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 35 of file hybrid_kem.cpp.

35 {
36 return reduce(public_keys(), std::vector<uint8_t>(), [](auto pkb, const auto& key) {
37 return concat(pkb, key->raw_public_key_bits());
38 });
39}
constexpr auto concat(Rs &&... ranges)
Definition stl_util.h:255

References Botan::concat(), public_keys(), and Botan::reduce().

Referenced by public_key_bits().

◆ subject_public_key()

std::vector< uint8_t > Botan::Public_Key::subject_public_key ( ) const
inherited
Returns
X.509 subject key encoding for this key object

Definition at line 56 of file pk_keys.cpp.

56 {
57 std::vector<uint8_t> output;
58
59 DER_Encoder(output)
60 .start_sequence()
61 .encode(algorithm_identifier())
63 .end_cons();
64
65 return output;
66}
virtual AlgorithmIdentifier algorithm_identifier() const =0
virtual std::vector< uint8_t > public_key_bits() const =0

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().

◆ supports_operation()

bool Botan::Hybrid_PublicKey::supports_operation ( PublicKeyOperation op) const
overridevirtual

Return true if this key could be used for the specified type of operation.

Implements Botan::Asymmetric_Key.

Definition at line 41 of file hybrid_kem.cpp.

41 {
43}

References Botan::KeyEncapsulation.


The documentation for this class was generated from the following files: