Botan 3.14.1
Crypto and TLS for C&
Botan::Kyber_PrivateKey Class Referencefinal

#include <kyber.h>

Inheritance diagram for Botan::Kyber_PrivateKey:
Botan::Kyber_PublicKey Botan::Module_Lattice_PrivateKey Botan::Private_Key Botan::Public_Key Botan::Private_Key Botan::Public_Key Botan::Asymmetric_Key Botan::Public_Key Botan::Asymmetric_Key Botan::Asymmetric_Key

Public Member Functions

virtual std::unique_ptr< PK_Ops::Decryption > _create_decryption_op (RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const
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_Decryption > _create_kem_decryption_op (RandomNumberGenerator &rng, const PK_KEM_Options_Reader &options) const override
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::Key_Agreement > _create_key_agreement_op (RandomNumberGenerator &rng, const PK_Key_Agreement_Options_Reader &options) const
virtual std::unique_ptr< PK_Ops::Signature > _create_signature_op (RandomNumberGenerator &rng, const PK_Signature_Options_Reader &options) const
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::Decryption > create_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
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_Decryption > create_kem_decryption_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::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
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_private (std::string_view alg) const
std::string fingerprint_public (std::string_view alg="SHA-256") const
secure_vector< uint8_t > formatted_private_key_bits (MlPrivateKeyFormat format) const override
secure_vector< uint8_t > formatted_raw_private_key_bits (MlPrivateKeyFormat format) const override
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
 Kyber_PrivateKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits)
 Kyber_PrivateKey (RandomNumberGenerator &rng, KyberMode mode)
 Kyber_PrivateKey (std::span< const uint8_t > sk, KyberMode mode)
size_t message_part_size () const
size_t message_parts () const
KyberMode mode () const
OID object_identifier () const override
virtual AlgorithmIdentifier pkcs8_algorithm_identifier () const
secure_vector< uint8_t > private_key_bits () const final
secure_vector< uint8_t > private_key_bits_with_format (MlPrivateKeyFormat format) const
MlPrivateKeyFormat private_key_format () 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 final
std::vector< uint8_t > raw_public_key_bits () const override
virtual std::optional< uint64_t > remaining_operations () const
 Retrieves the number of remaining operations if this is a stateful private key.
virtual bool stateful_operation () const
std::vector< uint8_t > subject_public_key () const
bool supports_operation (PublicKeyOperation op) const override

Static Protected Member Functions

static std::shared_ptr< Kyber_PublicKeyInternal > initialize_from_encoding (std::span< const uint8_t > pub_key, KyberMode m)

Protected Attributes

std::shared_ptr< const Kyber_PublicKeyInternal > m_public

Friends

class Kyber_KEM_Decryptor

Detailed Description

Definition at line 140 of file kyber.h.

Constructor & Destructor Documentation

◆ Kyber_PrivateKey() [1/3]

Botan::Kyber_PrivateKey::Kyber_PrivateKey ( RandomNumberGenerator & rng,
KyberMode mode )

Create a new private key.

New ML-KEM keys are encoded in the format MlPrivateKeyFormat::Seed, new Kyber round 3 keys in MlPrivateKeyFormat::Expanded.

NIST FIPS 203, Algorithms 19 (ML-KEM.KeyGen)

Definition at line 226 of file kyber.cpp.

226 :
227 m_private_key_format(mode.is_ml_kem() ? MlPrivateKeyFormat::Seed : MlPrivateKeyFormat::Expanded) {
228 std::tie(m_public, m_private) =
231 mode);
232}
static constexpr size_t SEED_BYTES
KyberMode mode() const
Definition kyber.cpp:159
std::shared_ptr< const Kyber_PublicKeyInternal > m_public
Definition kyber.h:134
KyberInternalKeypair expand_keypair(KyberPrivateKeySeed seed, KyberConstants mode)
Strong< secure_vector< uint8_t >, struct KyberImplicitRejectionValue_ > KyberImplicitRejectionValue
Secret random value (called Z in the spec), used for implicit rejection in the decapsulation.
Definition kyber_types.h:42
Strong< secure_vector< uint8_t >, struct KyberSeedRandomness_ > KyberSeedRandomness
Principal seed used to generate Kyber key pairs.
Definition kyber_types.h:33

References Botan::Kyber_Algos::expand_keypair(), Botan::Kyber_PublicKey::m_public, Botan::Kyber_PublicKey::mode(), Botan::RandomNumberGenerator::random_vec(), and Botan::KyberConstants::SEED_BYTES.

Referenced by Kyber_PrivateKey().

◆ Kyber_PrivateKey() [2/3]

Botan::Kyber_PrivateKey::Kyber_PrivateKey ( std::span< const uint8_t > sk,
KyberMode mode )

Import a private key using its key bytes.

ML-KEM keys are accepted in all three CHOICE alternatives of RFC 9935 (seed, expanded key, or both) and, for backwards compatibility, as the raw 64-byte seed d || z or the raw expanded key of FIPS 203. Kyber round 3 keys are accepted as the raw expanded key only. The detected format is retained, see private_key_format().

Definition at line 242 of file kyber.cpp.

242 :
243 m_private_key_format(MlPrivateKeyFormat::Expanded) {
244 KyberConstants mode(m);
245
246 if(mode.mode().is_ml_kem()) {
247 auto decoded = decode_ml_kem_private_key(sk, std::move(mode));
248 m_public = std::move(decoded.keypair.first);
249 m_private = std::move(decoded.keypair.second);
250 m_private_key_format = decoded.format;
251 } else if(sk.size() == mode.expanded_private_key_bytes()) {
252 std::tie(m_public, m_private) = Expanded_Keypair_Codec().decode_keypair(sk, std::move(mode));
253 } else if(sk.size() == mode.seed_private_key_bytes()) {
254 throw Decoding_Error("Kyber round 3 private keys do not support the seed format");
255 } else {
256 throw Decoding_Error("Private key does not have the correct byte count");
257 }
258}
KyberDecodedKeypair decode_ml_kem_private_key(std::span< const uint8_t > private_key, KyberConstants mode)

References Botan::Expanded_Keypair_Codec::decode_keypair(), Botan::decode_ml_kem_private_key(), Botan::Kyber_PublicKey::m_public, and Botan::Kyber_PublicKey::mode().

◆ Kyber_PrivateKey() [3/3]

Botan::Kyber_PrivateKey::Kyber_PrivateKey ( const AlgorithmIdentifier & alg_id,
std::span< const uint8_t > key_bits )

Import a private key using its key bytes. See the constructor above for the accepted encodings.

Definition at line 234 of file kyber.cpp.

234 :
235 Kyber_PrivateKey(key_bits, KyberMode(alg_id.oid())) {
236 // The parameter set is identified by the OID; no parameters are defined.
237 if(!alg_id.parameters_are_empty()) {
238 throw Decoding_Error("Unexpected parameters for ML-KEM/Kyber private key");
239 }
240}
Kyber_PrivateKey(RandomNumberGenerator &rng, KyberMode mode)
Definition kyber.cpp:226

References Kyber_PrivateKey(), and Botan::AlgorithmIdentifier::parameters_are_empty().

Member Function Documentation

◆ _create_decryption_op()

std::unique_ptr< PK_Ops::Decryption > Botan::Private_Key::_create_decryption_op ( RandomNumberGenerator & rng,
const PK_Encryption_Options_Reader & options ) const
virtualinherited

This is an internal library function exposed on key types. In all cases applications should use wrappers in pubkey.h

Return a decryption operation for this key/options or throw

Parameters
Random Number Generatorsa 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.
optionswhich specify parameters of the encryption beyond those implicit to the key itself

Reimplemented in Botan::ElGamal_PrivateKey, Botan::RSA_PrivateKey, Botan::SM2_PrivateKey, and Botan::TPM2::RSA_PrivateKey.

Definition at line 130 of file pk_keys.cpp.

131 {
132 BOTAN_UNUSED(rng, options);
133 throw Lookup_Error(fmt("{} does not support decryption", algo_name()));
134}
#define BOTAN_UNUSED
Definition assert.h:151
virtual std::string algo_name() const =0
std::string fmt(std::string_view format, const T &... args)
Definition fmt.h:53

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

Referenced by create_decryption_op(), and Botan::PK_Decryptor_EME::PK_Decryptor_EME().

◆ _create_encryption_op()

std::unique_ptr< PK_Ops::Encryption > Botan::Public_Key::_create_encryption_op ( RandomNumberGenerator & rng,
const PK_Encryption_Options_Reader & options ) 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/options or throw

Parameters
Random Number Generatorsa 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.
optionswhich 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.

108 {
109 BOTAN_UNUSED(rng, options);
110 throw Lookup_Error(fmt("{} does not support encryption", algo_name()));
111}

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

Referenced by create_encryption_op(), and Botan::PK_Encryptor_EME::PK_Encryptor_EME().

◆ _create_kem_decryption_op()

std::unique_ptr< PK_Ops::KEM_Decryption > Botan::Kyber_PrivateKey::_create_kem_decryption_op ( RandomNumberGenerator & rng,
const PK_KEM_Options_Reader & options ) const
overridevirtual

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/options or throw

Parameters
Random Number Generatorsa 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.
optionswhich specify parameters of the KEM beyond those implicit to the key itself

Reimplemented from Botan::Private_Key.

Definition at line 306 of file kyber.cpp.

307 {
308 BOTAN_UNUSED(rng);
310
311#if defined(BOTAN_HAS_KYBER) || defined(BOTAN_HAS_KYBER_90S)
312 if(mode().is_kyber_round3()) {
313 return std::make_unique<Kyber_KEM_Decryptor>(m_private, m_public, options);
314 }
315#endif
316
317#if defined(BOTAN_HAS_ML_KEM)
318 if(mode().is_ml_kem()) {
319 return std::make_unique<ML_KEM_Decryptor>(m_private, m_public, options);
320 }
321#endif
322
324}
#define BOTAN_ASSERT_UNREACHABLE()
Definition assert.h:173
std::string algo_name() const override
Definition kyber.cpp:163
void require_software_provider(const OptionsT &options, std::string_view algo_name)

References Botan::Kyber_PublicKey::algo_name(), BOTAN_ASSERT_UNREACHABLE, BOTAN_UNUSED, Botan::Kyber_PublicKey::m_public, Botan::Kyber_PublicKey::mode(), and Botan::require_software_provider().

◆ _create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::Kyber_PublicKey::_create_kem_encryption_op ( const PK_KEM_Options_Reader & options) const
overridevirtualinherited

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

Parameters
optionswhich specify parameters of the KEM beyond those implicit to the public key itself

Reimplemented from Botan::Public_Key.

Definition at line 287 of file kyber.cpp.

288 {
290
291#if defined(BOTAN_HAS_KYBER) || defined(BOTAN_HAS_KYBER_90S)
292 if(mode().is_kyber_round3()) {
293 return std::make_unique<Kyber_KEM_Encryptor>(m_public, options);
294 }
295#endif
296
297#if defined(BOTAN_HAS_ML_KEM)
298 if(mode().is_ml_kem()) {
299 return std::make_unique<ML_KEM_Encryptor>(m_public, options);
300 }
301#endif
302
304}

References algo_name(), BOTAN_ASSERT_UNREACHABLE, m_public, mode(), and Botan::require_software_provider().

◆ _create_key_agreement_op()

std::unique_ptr< PK_Ops::Key_Agreement > Botan::Private_Key::_create_key_agreement_op ( RandomNumberGenerator & rng,
const PK_Key_Agreement_Options_Reader & options ) const
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/options or throw

Parameters
Random Number Generatorsa 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.
optionswhich specify parameters of the key agreement beyond those implicit to the key itself

Reimplemented in Botan::DH_PrivateKey, Botan::ECDH_PrivateKey, Botan::X25519_PrivateKey, and Botan::X448_PrivateKey.

Definition at line 148 of file pk_keys.cpp.

149 {
150 BOTAN_UNUSED(rng, options);
151 throw Lookup_Error(fmt("{} does not support key agreement", algo_name()));
152}

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

Referenced by create_key_agreement_op(), and Botan::PK_Key_Agreement::PK_Key_Agreement().

◆ _create_signature_op()

std::unique_ptr< PK_Ops::Signature > Botan::Private_Key::_create_signature_op ( RandomNumberGenerator & rng,
const PK_Signature_Options_Reader & options ) const
virtualinherited

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

Parameters
Random Number Generatorsa 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.
optionsallow controlling behavior

Reimplemented in Botan::Dilithium_PrivateKey, Botan::DSA_PrivateKey, Botan::ECDSA_PrivateKey, Botan::ECGDSA_PrivateKey, Botan::ECKCDSA_PrivateKey, Botan::Ed25519_PrivateKey, Botan::Ed448_PrivateKey, Botan::GOST_3410_PrivateKey, Botan::HSS_LMS_PrivateKey, Botan::RSA_PrivateKey, Botan::SM2_PrivateKey, Botan::SphincsPlus_PrivateKey, Botan::TPM2::EC_PrivateKey, Botan::TPM2::RSA_PrivateKey, Botan::TPM_PrivateKey, and Botan::XMSS_PrivateKey.

Definition at line 142 of file pk_keys.cpp.

143 {
144 BOTAN_UNUSED(rng, options);
145 throw Lookup_Error(fmt("{} does not support signatures", algo_name()));
146}

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

Referenced by create_signature_op(), and Botan::PK_Signer::PK_Signer().

◆ _create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Public_Key::_create_verification_op ( const PK_Signature_Options_Reader & options) 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
optionswhich 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.

120 {
121 BOTAN_UNUSED(options);
122 throw Lookup_Error(fmt("{} does not support verification", algo_name()));
123}

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

Referenced by create_verification_op(), and Botan::PK_Verifier::PK_Verifier().

◆ _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 148 of file pk_keys.h.

148{ return {}; }

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

◆ algo_name()

std::string Botan::Kyber_PublicKey::algo_name ( ) const
overridevirtualinherited

Get the name of the underlying public key scheme.

Returns
name of the public key scheme

Implements Botan::Asymmetric_Key.

Definition at line 163 of file kyber.cpp.

163 {
164 return mode().is_ml_kem() ? "ML-KEM" : "Kyber";
165}
bool is_ml_kem() const
Definition kyber.cpp:128

References Botan::KyberMode::is_ml_kem(), and mode().

Referenced by Botan::Kyber_PrivateKey::_create_kem_decryption_op(), _create_kem_encryption_op(), and ~Kyber_PublicKey().

◆ algorithm_identifier()

AlgorithmIdentifier Botan::Kyber_PublicKey::algorithm_identifier ( ) const
overridevirtualinherited

Return the X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 167 of file kyber.cpp.

167 {
168 // draft-ietf-lamps-kyber-certificates-latest (22 July 2024) The
169 // AlgorithmIdentifier for a ML-KEM public key MUST use one of the
170 // id-alg-ml-kem object identifiers [...]. The parameters field of the
171 // AlgorithmIdentifier for the ML-KEM public key MUST be absent.
172 return AlgorithmIdentifier(mode().object_identifier(), AlgorithmIdentifier::USE_EMPTY_PARAM);
173}
OID object_identifier() const override
Definition kyber.cpp:175

References mode(), object_identifier(), and Botan::AlgorithmIdentifier::USE_EMPTY_PARAM.

Referenced by ~Kyber_PublicKey().

◆ check_key()

bool Botan::Kyber_PrivateKey::check_key ( RandomNumberGenerator & rng,
bool strong ) const
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.

Parameters
Random Number Generatorsrng to use for randomized testing (may be ignored)
strongwhether to perform strong and lengthy version of the test, however for many algorithms this has no effect
Returns
true if the tests passed

Implements Botan::Asymmetric_Key.

Definition at line 264 of file kyber.cpp.

264 {
265 // The expanded encoding embeds ek and H(ek); their lengths, the coefficient
266 // ranges and the hash are all verified when the key is decoded. Both ML-KEM
267 // and Kyber round 3 also perform a pairwise consistency check during decoding.
268 // The strong check below performs an additional encaps/decaps round trip.
269
270 if(!Kyber_PublicKey::check_key(rng, strong)) {
271 return false;
272 }
273
274 if(!strong) {
275 return true;
276 }
277
278 PK_KEM_Encryptor enc(*this, "Raw");
279 PK_KEM_Decryptor dec(*this, rng, "Raw");
280
281 const auto [c, K] = KEM_Encapsulation::destructure(enc.encrypt(rng));
282 const auto K_prime = dec.decrypt(c);
283
284 return K == K_prime;
285}
static std::pair< std::vector< uint8_t >, secure_vector< uint8_t > > destructure(KEM_Encapsulation &&kem)
Definition pubkey.h:654
bool check_key(RandomNumberGenerator &rng, bool strong) const override
Definition kyber.cpp:213

References Botan::Kyber_PublicKey::check_key(), Botan::PK_KEM_Decryptor::decrypt(), Botan::KEM_Encapsulation::destructure(), and Botan::PK_KEM_Encryptor::encrypt().

◆ create_decryption_op()

std::unique_ptr< PK_Ops::Decryption > Botan::Private_Key::create_decryption_op ( RandomNumberGenerator & rng,
std::string_view params,
std::string_view provider ) const
inherited

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

Parameters
Random Number Generatorsa 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

Definition at line 185 of file pk_keys.cpp.

187 {
188 const auto options = parse_legacy_enc_options(*this, params).with_provider(provider);
189 const auto reader = PK_Options_Reader_Access::read(options);
190 auto op = this->_create_decryption_op(rng, reader);
192 return op;
193}
PK_Encryption_Options with_provider(std::string_view provider)
static void throw_if_unexamined(const ReaderT &reader, std::string_view algo_name)
static PK_Encryption_Options_Reader read(const PK_Encryption_Options &options)
virtual std::unique_ptr< PK_Ops::Decryption > _create_decryption_op(RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const
Definition pk_keys.cpp:130
PK_Encryption_Options parse_legacy_enc_options(const Public_Key &key, std::string_view params)

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

◆ 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
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

Parameters
Random Number Generatorsa 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

Definition at line 175 of file pk_keys.cpp.

177 {
178 const auto options = parse_legacy_enc_options(*this, params).with_provider(provider);
179 const auto reader = PK_Options_Reader_Access::read(options);
180 auto op = this->_create_encryption_op(rng, reader);
182 return op;
183}
virtual std::unique_ptr< PK_Ops::Encryption > _create_encryption_op(RandomNumberGenerator &rng, const PK_Encryption_Options_Reader &options) const
Definition pk_keys.cpp:107

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

◆ create_kem_decryption_op()

std::unique_ptr< PK_Ops::KEM_Decryption > Botan::Private_Key::create_kem_decryption_op ( RandomNumberGenerator & rng,
std::string_view params,
std::string_view provider ) const
inherited

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

Parameters
Random Number Generatorsa 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

Definition at line 204 of file pk_keys.cpp.

206 {
207 const auto options = parse_legacy_kem_options(params).with_provider(provider);
208 const auto reader = PK_Options_Reader_Access::read(options);
209 auto op = this->_create_kem_decryption_op(rng, reader);
211 return op;
212}
PK_KEM_Options with_provider(std::string_view provider)
virtual std::unique_ptr< PK_Ops::KEM_Decryption > _create_kem_decryption_op(RandomNumberGenerator &rng, const PK_KEM_Options_Reader &options) const
Definition pk_keys.cpp:136
PK_KEM_Options parse_legacy_kem_options(std::string_view params)

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

◆ 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
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

Parameters
paramsadditional parameters
providerthe provider to use

Definition at line 195 of file pk_keys.cpp.

196 {
197 const auto options = parse_legacy_kem_options(params).with_provider(provider);
198 const auto reader = PK_Options_Reader_Access::read(options);
199 auto op = this->_create_kem_encryption_op(reader);
201 return op;
202}
virtual std::unique_ptr< PK_Ops::KEM_Encryption > _create_kem_encryption_op(const PK_KEM_Options_Reader &options) const
Definition pk_keys.cpp:113

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

◆ create_key_agreement_op()

std::unique_ptr< PK_Ops::Key_Agreement > Botan::Private_Key::create_key_agreement_op ( RandomNumberGenerator & rng,
std::string_view params,
std::string_view provider ) const
inherited

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

Parameters
Random Number Generatorsa 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

Definition at line 214 of file pk_keys.cpp.

216 {
217 const auto options = parse_legacy_ka_options(params).with_provider(provider);
218 const auto reader = PK_Options_Reader_Access::read(options);
219 auto op = this->_create_key_agreement_op(rng, reader);
221 return op;
222}
PK_Key_Agreement_Options with_provider(std::string_view provider)
virtual std::unique_ptr< PK_Ops::Key_Agreement > _create_key_agreement_op(RandomNumberGenerator &rng, const PK_Key_Agreement_Options_Reader &options) const
Definition pk_keys.cpp:148
PK_Key_Agreement_Options parse_legacy_ka_options(std::string_view params)

References _create_key_agreement_op(), Botan::Asymmetric_Key::algo_name(), Botan::parse_legacy_ka_options(), Botan::PK_Options_Reader_Access::read(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Key_Agreement_Options::with_provider().

◆ create_signature_op()

std::unique_ptr< PK_Ops::Signature > Botan::Private_Key::create_signature_op ( RandomNumberGenerator & rng,
std::string_view params,
std::string_view provider ) const
inherited

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

Parameters
Random Number Generatorsa 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

Definition at line 165 of file pk_keys.cpp.

167 {
168 const auto options = parse_legacy_sig_options(*this, params).with_provider(provider);
169 const auto reader = PK_Options_Reader_Access::for_signing(options);
170 auto op = this->_create_signature_op(rng, reader);
172 return op;
173}
static PK_Signature_Options_Reader for_signing(const PK_Signature_Options &options)
PK_Signature_Options with_provider(std::string_view provider)
virtual std::unique_ptr< PK_Ops::Signature > _create_signature_op(RandomNumberGenerator &rng, const PK_Signature_Options_Reader &options) const
Definition pk_keys.cpp:142
PK_Signature_Options parse_legacy_sig_options(const Public_Key &key, std::string_view params)

References _create_signature_op(), Botan::Asymmetric_Key::algo_name(), Botan::PK_Options_Reader_Access::for_signing(), Botan::parse_legacy_sig_options(), Botan::PK_Options_Reader_Access::throw_if_unexamined(), and Botan::PK_Signature_Options::with_provider().

◆ create_verification_op()

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

Parameters
paramsadditional parameters
providerthe provider to use

Definition at line 156 of file pk_keys.cpp.

157 {
158 const auto options = parse_legacy_sig_options(*this, params).with_provider(provider);
159 const auto reader = PK_Options_Reader_Access::for_verification(options);
160 auto op = this->_create_verification_op(reader);
162 return op;
163}
static PK_Signature_Options_Reader for_verification(const PK_Signature_Options &options)
virtual std::unique_ptr< PK_Ops::Verification > _create_verification_op(const PK_Signature_Options_Reader &options) const
Definition pk_keys.cpp:119

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

◆ 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 125 of file pk_keys.cpp.

126 {
127 throw Lookup_Error(fmt("{} does not support X.509 verification", algo_name()));
128}

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 245 of file pk_keys.h.

245 {
247 }
virtual Signature_Format _default_x509_signature_format() const
Definition pk_keys.cpp:32

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

Referenced by default_x509_signature_format().

◆ estimated_strength()

size_t Botan::Kyber_PublicKey::estimated_strength ( ) const
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.

Returns
estimated strength in bits

Implements Botan::Asymmetric_Key.

Definition at line 179 of file kyber.cpp.

179 {
180 return m_public->mode().estimated_strength();
181}

References m_public.

Referenced by ~Kyber_PublicKey().

◆ fingerprint_private()

std::string Botan::Private_Key::fingerprint_private ( std::string_view alg) const
inherited
Returns
Hash of the algorithm specific private key encoding
Warning
This hashes private_key_bits(), which does not include the algorithm identifier; keys of different algorithms with identical raw encodings (such as an Ed25519 and an X25519 key built from the same 32 bytes) share a fingerprint.

Definition at line 103 of file pk_keys.cpp.

103 {
104 return create_hex_fingerprint(private_key_bits(), hash_algo);
105}
virtual secure_vector< uint8_t > private_key_bits() const =0
std::string create_hex_fingerprint(std::span< const uint8_t > bits, std::string_view hash_name)
Definition pk_keys.cpp:40

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

◆ 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 96 of file pk_keys.cpp.

96 {
97 return create_hex_fingerprint(subject_public_key(), hash_algo);
98}
std::vector< uint8_t > subject_public_key() const
Definition pk_keys.cpp:65

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

Referenced by public_key_bits().

◆ formatted_private_key_bits()

secure_vector< uint8_t > Botan::Kyber_PrivateKey::formatted_private_key_bits ( MlPrivateKeyFormat format) const
overridevirtual

The ML-KEM-PrivateKey CHOICE encoding of RFC 9935 in the given format, i.e. the content of the PKCS#8 privateKey field. Kyber round 3 keys are encoded as the raw expanded key (MlPrivateKeyFormat::Expanded only).

Exceptions
Encoding_Errorif the key cannot be encoded in format (see formatted_raw_private_key_bits())

Implements Botan::Module_Lattice_PrivateKey.

Definition at line 349 of file kyber.cpp.

349 {
350 if(mode().is_ml_kem()) {
351 return encode_ml_kem_private_key({m_public, m_private}, format);
352 }
353 // Kyber round 3 has no ASN.1 wrapping, the raw expanded key is the PKCS#8 content
354 if(format != MlPrivateKeyFormat::Expanded) {
355 throw Encoding_Error("Kyber round 3 private keys only support the expanded format");
356 }
357 return formatted_raw_private_key_bits(format);
358}
secure_vector< uint8_t > formatted_raw_private_key_bits(MlPrivateKeyFormat format) const override
Definition kyber.cpp:330
secure_vector< uint8_t > encode_ml_kem_private_key(const KyberInternalKeypair &keypair, MlPrivateKeyFormat format)

References Botan::encode_ml_kem_private_key(), Botan::Expanded, formatted_raw_private_key_bits(), Botan::Kyber_PublicKey::m_public, and Botan::Kyber_PublicKey::mode().

◆ formatted_raw_private_key_bits()

secure_vector< uint8_t > Botan::Kyber_PrivateKey::formatted_raw_private_key_bits ( MlPrivateKeyFormat format) const
overridevirtual

The raw key material in the given format: the 64-byte seed d || z or the expanded key of FIPS 203, without ASN.1 wrapping.

Exceptions
Encoding_Errorfor MlPrivateKeyFormat::Both (no raw encoding exists), for MlPrivateKeyFormat::Seed if the key was loaded from an expanded key (and thus holds no seed), and for anything but MlPrivateKeyFormat::Expanded on Kyber round 3 keys.

Implements Botan::Module_Lattice_PrivateKey.

Definition at line 330 of file kyber.cpp.

330 {
331 switch(format) {
333 if(mode().is_kyber_round3()) {
334 throw Encoding_Error("Kyber round 3 private keys only support the expanded format");
335 }
336 if(!m_private->seed().d.has_value()) {
337 throw Encoding_Error("Expanded private keys do not support the seed format");
338 }
339 return Seed_Expanding_Keypair_Codec().encode_keypair({m_public, m_private});
341 return Expanded_Keypair_Codec().encode_keypair({m_public, m_private});
343 throw Encoding_Error(
344 "there is no raw encoding of an ML-KEM private key containing both seed and expanded key");
345 }
347}

References BOTAN_ASSERT_UNREACHABLE, Botan::Both, Botan::Expanded_Keypair_Codec::encode_keypair(), Botan::Seed_Expanding_Keypair_Codec::encode_keypair(), Botan::Expanded, Botan::Kyber_PublicKey::m_public, Botan::Kyber_PublicKey::mode(), and Botan::Seed.

Referenced by formatted_private_key_bits(), and private_key_bits_with_format().

◆ generate_another()

std::unique_ptr< Private_Key > Botan::Kyber_PublicKey::generate_another ( RandomNumberGenerator & rng) const
finalvirtualinherited

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 219 of file kyber.cpp.

219 {
220 return std::make_unique<Kyber_PrivateKey>(rng, mode());
221}

References mode().

Referenced by ~Kyber_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 20 of file pk_keys.cpp.

20 {
21 throw Unknown_PK_Field_Name(algo_name(), field);
22}

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 172 of file pk_keys.h.

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

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

Referenced by get_oid().

◆ initialize_from_encoding()

std::shared_ptr< Kyber_PublicKeyInternal > Botan::Kyber_PublicKey::initialize_from_encoding ( std::span< const uint8_t > pub_key,
KyberMode m )
staticprotectedinherited

◆ key_length()

size_t Botan::Kyber_PublicKey::key_length ( ) const
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 209 of file kyber.cpp.

209 {
210 return m_public->mode().canonical_parameter_set_identifier();
211}

References m_public.

Referenced by ~Kyber_PublicKey().

◆ message_part_size()

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

Returns
size of the message parts in bits

Definition at line 236 of file pk_keys.h.

236 {
237 return _signature_element_size_for_DER_encoding().value_or(0);
238 }

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 223 of file pk_keys.h.

223 {
225 }

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

Referenced by message_parts().

◆ mode()

◆ object_identifier()

OID Botan::Kyber_PublicKey::object_identifier ( ) const
overridevirtualinherited

Get the OID of the underlying public key scheme.

Returns
OID of the public key scheme

Reimplemented from Botan::Asymmetric_Key.

Definition at line 175 of file kyber.cpp.

175 {
176 return mode().object_identifier();
177}
OID object_identifier() const
Definition kyber.cpp:91

References mode(), and Botan::KyberMode::object_identifier().

Referenced by algorithm_identifier(), and ~Kyber_PublicKey().

◆ pkcs8_algorithm_identifier()

virtual AlgorithmIdentifier Botan::Private_Key::pkcs8_algorithm_identifier ( ) const
inlinevirtualinherited

Return the PKCS #8 AlgorithmIdentifier for this key

Note
normally this is the same as the public key identifier, but a few oddball algorithms use a different value

Reimplemented in Botan::GOST_3410_PrivateKey, and Botan::HSS_LMS_PrivateKey.

Definition at line 390 of file pk_keys.h.

390{ return algorithm_identifier(); }
virtual AlgorithmIdentifier algorithm_identifier() const =0

References Botan::Public_Key::algorithm_identifier().

Referenced by private_key_info().

◆ private_key_bits()

secure_vector< uint8_t > Botan::Module_Lattice_PrivateKey::private_key_bits ( ) const
finalvirtualinherited

Equivalent to formatted_private_key_bits(private_key_format())

Implements Botan::Private_Key.

Definition at line 14 of file module_lattice_keys.cpp.

14 {
16}
virtual MlPrivateKeyFormat private_key_format() const =0
virtual secure_vector< uint8_t > formatted_private_key_bits(MlPrivateKeyFormat format) const =0

References formatted_private_key_bits(), and private_key_format().

Referenced by formatted_private_key_bits().

◆ private_key_bits_with_format()

secure_vector< uint8_t > Botan::Kyber_PrivateKey::private_key_bits_with_format ( MlPrivateKeyFormat format) const
inline

Definition at line 211 of file kyber.h.

211 {
212 return formatted_raw_private_key_bits(format);
213 }

References formatted_raw_private_key_bits(), and private_key_bits_with_format().

Referenced by private_key_bits_with_format().

◆ private_key_format()

MlPrivateKeyFormat Botan::Kyber_PrivateKey::private_key_format ( ) const
overridevirtual

The format this key was loaded from, or the default format of a newly generated key (MlPrivateKeyFormat::Seed for ML-KEM). It is the format used for private_key_bits(), private_key_info() and raw_private_key_bits().

Note that keys that contain the seed can be serialized in any format using the formatted_*() methods, whereas keys loaded from an expanded key can NOT be serialized as seed.

Implements Botan::Module_Lattice_PrivateKey.

Definition at line 326 of file kyber.cpp.

326 {
327 return m_private_key_format;
328}

◆ private_key_info()

secure_vector< uint8_t > Botan::Private_Key::private_key_info ( ) const
inherited

Return PKCS #8 private key encoding for this key object

Definition at line 77 of file pk_keys.cpp.

77 {
78 const size_t PKCS8_VERSION = 0;
79
80 return DER_Encoder()
81 .start_sequence()
82 .encode(PKCS8_VERSION)
85 .end_cons()
86 .get_contents();
87}
virtual AlgorithmIdentifier pkcs8_algorithm_identifier() const
Definition pk_keys.h:390

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

◆ public_key()

std::unique_ptr< Public_Key > Botan::Kyber_PrivateKey::public_key ( ) const
overridevirtual

Allocate a new object for the public key associated with this private key.

Returns
public key

Implements Botan::Private_Key.

Definition at line 260 of file kyber.cpp.

260 {
261 return std::make_unique<Kyber_PublicKey>(*this);
262}

◆ public_key_bits()

std::vector< uint8_t > Botan::Kyber_PublicKey::public_key_bits ( ) const
overridevirtualinherited

Return the subject public key encoding of this public key

Note
this excludes the parameters field and may not be reliably decodable

Implements Botan::Public_Key.

Definition at line 203 of file kyber.cpp.

203 {
204 // Currently, there isn't a finalized definition of an ASN.1 structure for
205 // Kyber aka ML-KEM public keys. Therefore, we return the raw public key bits.
206 return raw_public_key_bits();
207}
std::vector< uint8_t > raw_public_key_bits() const override
Definition kyber.cpp:199

References raw_public_key_bits().

Referenced by ~Kyber_PublicKey().

◆ raw_private_key_bits()

secure_vector< uint8_t > Botan::Module_Lattice_PrivateKey::raw_private_key_bits ( ) const
finalvirtualinherited

Equivalent to formatted_raw_private_key_bits(private_key_format()).

Note
Keys in the format MlPrivateKeyFormat::Both, which has no raw encoding, return the seed instead.

Reimplemented from Botan::Private_Key.

Definition at line 18 of file module_lattice_keys.cpp.

18 {
19 // The "both" format has no raw encoding; the seed is its minimal raw representation.
20 const auto format = private_key_format();
22}
virtual secure_vector< uint8_t > formatted_raw_private_key_bits(MlPrivateKeyFormat format) const =0

References Botan::Both, formatted_raw_private_key_bits(), private_key_format(), and Botan::Seed.

Referenced by formatted_private_key_bits().

◆ raw_public_key_bits()

std::vector< uint8_t > Botan::Kyber_PublicKey::raw_public_key_bits ( ) const
overridevirtualinherited

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.

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 199 of file kyber.cpp.

199 {
200 return m_public->public_key_bits_raw().get();
201}

References m_public.

Referenced by public_key_bits(), and ~Kyber_PublicKey().

◆ remaining_operations()

virtual std::optional< uint64_t > Botan::Private_Key::remaining_operations ( ) const
inlinevirtualinherited

Retrieves the number of remaining operations if this is a stateful private key.

Returns
the number of remaining operations or std::nullopt if not applicable.

Reimplemented in Botan::HSS_LMS_PrivateKey, and Botan::XMSS_PrivateKey.

Definition at line 403 of file pk_keys.h.

403{ return std::nullopt; }

◆ stateful_operation()

virtual bool Botan::Private_Key::stateful_operation ( ) const
inlinevirtualinherited

Indicates if this key is stateful, ie that performing a private key operation requires updating the key storage.

Reimplemented in Botan::HSS_LMS_PrivateKey, and Botan::XMSS_PrivateKey.

Definition at line 396 of file pk_keys.h.

396{ return false; }

◆ subject_public_key()

std::vector< uint8_t > Botan::Public_Key::subject_public_key ( ) const
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.

65 {
66 std::vector<uint8_t> output;
67
68 DER_Encoder(output)
69 .start_sequence()
70 .encode(algorithm_identifier())
71 .encode_octet_aligned_bitstring(public_key_bits())
72 .end_cons();
73
74 return output;
75}
virtual std::vector< uint8_t > public_key_bits() const =0

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

◆ supports_operation()

bool Botan::Kyber_PublicKey::supports_operation ( PublicKeyOperation op) const
inlineoverridevirtualinherited

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

Implements Botan::Asymmetric_Key.

Definition at line 115 of file kyber.h.

115 {
117 }

References Botan::KeyEncapsulation.

◆ Kyber_KEM_Decryptor

friend class Kyber_KEM_Decryptor
friend

Definition at line 216 of file kyber.h.

References Kyber_KEM_Decryptor.

Referenced by Kyber_KEM_Decryptor.

Member Data Documentation

◆ m_public


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