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

#include <kyber.h>

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

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::Decryptioncreate_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
 
virtual std::unique_ptr< PK_Ops::Encryptioncreate_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
 
std::unique_ptr< PK_Ops::KEM_Decryptioncreate_kem_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const override
 
std::unique_ptr< PK_Ops::KEM_Encryptioncreate_kem_encryption_op (std::string_view params, std::string_view provider) const override
 
virtual std::unique_ptr< PK_Ops::Key_Agreementcreate_key_agreement_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
 
virtual std::unique_ptr< PK_Ops::Signaturecreate_signature_op (RandomNumberGenerator &rng, 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_private (std::string_view alg) const
 
std::string fingerprint_public (std::string_view alg="SHA-256") const
 
std::unique_ptr< Private_Keygenerate_another (RandomNumberGenerator &rng) const final
 
virtual const BigIntget_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 override
 
secure_vector< uint8_t > private_key_bits_with_format (MlPrivateKeyFormat format) const
 
MlPrivateKeyFormat private_key_format () const
 
secure_vector< uint8_t > private_key_info () const
 
std::unique_ptr< Public_Keypublic_key () const override
 
std::vector< uint8_t > public_key_bits () const override
 
secure_vector< uint8_t > raw_private_key_bits () const override
 
std::vector< uint8_t > raw_public_key_bits () const override
 
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_PublicKeyInternalinitialize_from_encoding (std::span< const uint8_t > pub_key, KyberMode m)
 

Protected Attributes

std::shared_ptr< Kyber_PublicKeyInternalm_public
 

Friends

class Kyber_KEM_Decryptor
 

Detailed Description

Definition at line 149 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. The private key will be encoded as the 64 byte seed.

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

Definition at line 232 of file kyber.cpp.

232 {
233 std::tie(m_public, m_private) =
236 mode);
237}
static constexpr size_t SEED_BYTES
std::shared_ptr< Kyber_PublicKeyInternal > m_public
Definition kyber.h:143
KyberMode mode() const
Definition kyber.cpp:163
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. Supported are key bytes as 64-byte seeds (not supported for Kyber Round 3 instances), as well as the expanded encoding specified by FIPS 203. Note that the encoding used in this constructor is reflected by the calls for private_key_bits, private_key_info, etc.

Definition at line 242 of file kyber.cpp.

242 {
243 KyberConstants mode(m);
244
245 if(mode.mode().is_ml_kem() && sk.size() == mode.seed_private_key_bytes()) {
246 std::tie(m_public, m_private) = Seed_Expanding_Keypair_Codec().decode_keypair(sk, std::move(mode));
247 } else if(sk.size() == mode.expanded_private_key_bytes()) {
248 std::tie(m_public, m_private) = Expanded_Keypair_Codec().decode_keypair(sk, std::move(mode));
249 } else if(!mode.mode().is_ml_kem() && sk.size() == mode.seed_private_key_bytes()) {
250 throw Invalid_Argument("Kyber round 3 private keys do not support the seed format");
251 } else {
252 throw Invalid_Argument("Private key does not have the correct byte count");
253 }
254}

References Botan::Expanded_Keypair_Codec::decode_keypair(), Botan::Seed_Expanding_Keypair_Codec::decode_keypair(), 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. Supported are key bytes as 64-byte seeds (not supported for Kyber Round 3 instances), as well as the expanded encoding specified by FIPS 203. Note that the encoding used in this constructor is reflected by the calls for private_key_bits, private_key_info, etc.

Definition at line 239 of file kyber.cpp.

239 :
240 Kyber_PrivateKey(key_bits, KyberMode(alg_id.oid())) {}
Kyber_PrivateKey(RandomNumberGenerator &rng, KyberMode mode)
Definition kyber.cpp:232

References Kyber_PrivateKey().

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

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

167 {
168 return mode().is_ml_kem() ? "ML-KEM" : "Kyber";
169}
bool is_ml_kem() const
Definition kyber.cpp:132

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
Returns
X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 171 of file kyber.cpp.

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

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

Implements Botan::Asymmetric_Key.

Definition at line 268 of file kyber.cpp.

268 {
269 // As we do not support loading a private key in extended format but rather
270 // always extract it from a 64-byte seed, these checks (as described in
271 // FIPS 203, Section 7.1) should never fail. Particularly, the length checks
272 // and the hash consistency check described in Section 7.2 and 7.3 are
273 // trivial when the private key is always extracted from a seed. The encaps/
274 // decaps roundtrip test is added for completeness.
275
276 if(!Kyber_PublicKey::check_key(rng, strong)) {
277 return false;
278 }
279
280 PK_KEM_Encryptor enc(*this, "Raw");
281 PK_KEM_Decryptor dec(*this, rng, "Raw");
282
283 const auto [c, K] = KEM_Encapsulation::destructure(enc.encrypt(rng));
284 const auto K_prime = dec.decrypt(c);
285
286 return K == K_prime;
287}
static std::pair< std::vector< uint8_t >, secure_vector< uint8_t > > destructure(KEM_Encapsulation &&kem)
Definition pubkey.h:569
bool check_key(RandomNumberGenerator &rng, bool strong) const override
Definition kyber.cpp:212
BOTAN_FORCE_INLINE BOTAN_FN_ISA_AES void dec(uint8x16_t &B, uint8x16_t K)
Definition aes_armv8.cpp:45
BOTAN_FORCE_INLINE BOTAN_FN_ISA_AES void enc(uint8x16_t &B, uint8x16_t K)
Definition aes_armv8.cpp:21

References Botan::Kyber_PublicKey::check_key(), and Botan::KEM_Encapsulation::destructure().

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

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

Return an decryption operation for this key/params or throw

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_PrivateKey, Botan::RSA_PrivateKey, Botan::SM2_PrivateKey, and Botan::TPM2::RSA_PrivateKey.

Definition at line 119 of file pk_keys.cpp.

121 {
122 throw Lookup_Error(fmt("{} does not support decryption", algo_name()));
123}
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(), and Botan::fmt().

Referenced by Botan::PK_Decryptor_EME::PK_Decryptor_EME().

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

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

Referenced by 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,
std::string_view params,
std::string_view provider ) 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/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 from Botan::Private_Key.

Definition at line 309 of file kyber.cpp.

311 {
312 BOTAN_UNUSED(rng);
313 if(provider.empty() || provider == "base") {
314#if defined(BOTAN_HAS_KYBER) || defined(BOTAN_HAS_KYBER_90S)
315 if(mode().is_kyber_round3()) {
316 return std::make_unique<Kyber_KEM_Decryptor>(m_private, m_public, params);
317 }
318#endif
319
320#if defined(BOTAN_HAS_ML_KEM)
321 if(mode().is_ml_kem()) {
322 return std::make_unique<ML_KEM_Decryptor>(m_private, m_public, params);
323 }
324#endif
325
327 }
328 throw Provider_Not_Found(algo_name(), provider);
329}
#define BOTAN_UNUSED
Definition assert.h:120
#define BOTAN_ASSERT_UNREACHABLE()
Definition assert.h:139
std::string algo_name() const override
Definition kyber.cpp:167

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

◆ create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::Kyber_PublicKey::create_kem_encryption_op ( std::string_view params,
std::string_view provider ) 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/params or throw

Parameters
paramsadditional parameters
providerthe provider to use

Reimplemented from Botan::Public_Key.

Definition at line 289 of file kyber.cpp.

290 {
291 if(provider.empty() || provider == "base") {
292#if defined(BOTAN_HAS_KYBER) || defined(BOTAN_HAS_KYBER_90S)
293 if(mode().is_kyber_round3()) {
294 return std::make_unique<Kyber_KEM_Encryptor>(m_public, params);
295 }
296#endif
297
298#if defined(BOTAN_HAS_ML_KEM)
299 if(mode().is_ml_kem()) {
300 return std::make_unique<ML_KEM_Encryptor>(m_public, params);
301 }
302#endif
303
305 }
306 throw Provider_Not_Found(algo_name(), provider);
307}

References algo_name(), BOTAN_ASSERT_UNREACHABLE, m_public, and mode().

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

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

Return a key agreement operation for this key/params or throw

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::DH_PrivateKey, Botan::ECDH_PrivateKey, Botan::X25519_PrivateKey, and Botan::X448_PrivateKey.

Definition at line 137 of file pk_keys.cpp.

139 {
140 throw Lookup_Error(fmt("{} does not support key agreement", algo_name()));
141}

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

Referenced by Botan::PK_Key_Agreement::PK_Key_Agreement().

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

133 {
134 throw Lookup_Error(fmt("{} does not support signatures", algo_name()));
135}

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

Referenced by Botan::PK_Signer::PK_Signer().

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

228 {
230 }
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::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 183 of file kyber.cpp.

183 {
184 return m_public->mode().estimated_strength();
185}

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 PKCS #8 encoding for this key object

Definition at line 94 of file pk_keys.cpp.

94 {
95 return create_hex_fingerprint(private_key_bits(), hash_algo);
96}
virtual secure_vector< uint8_t > private_key_bits() const =0
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 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 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

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

Referenced by public_key_bits().

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

225 {
226 return std::make_unique<Kyber_PrivateKey>(rng, mode());
227}

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

◆ initialize_from_encoding()

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

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

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

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

179 {
180 return mode().object_identifier();
181}
OID object_identifier() const
Definition kyber.cpp:95

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
Returns
PKCS #8 AlgorithmIdentifier for this key Might be different from the X.509 identifier, but normally is not

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

Definition at line 323 of file pk_keys.h.

323{ 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::Kyber_PrivateKey::private_key_bits ( ) const
overridevirtual
Returns
BER encoded private key bits

Implements Botan::Private_Key.

Definition at line 264 of file kyber.cpp.

264 {
266}
MlPrivateKeyFormat private_key_format() const
Definition kyber.cpp:331
secure_vector< uint8_t > private_key_bits_with_format(MlPrivateKeyFormat format) const
Definition kyber.cpp:338

References private_key_bits_with_format(), and private_key_format().

Referenced by raw_private_key_bits().

◆ private_key_bits_with_format()

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

Encode the private key in the specified format. Note that the seed format is only available for new ML-KEM keys and those loaded from seeds.

Exceptions
Encoding_Errorif the private key cannot be encoded in the requested format.

Definition at line 338 of file kyber.cpp.

338 {
340 throw Encoding_Error("Expanded private keys do not support the seed format");
341 }
342 const auto codec = [&]() -> std::unique_ptr<Kyber_Keypair_Codec> {
343 switch(format) {
345 return std::make_unique<Seed_Expanding_Keypair_Codec>();
347 return std::make_unique<Expanded_Keypair_Codec>();
348 }
350 }();
351 return codec->encode_keypair({m_public, m_private});
352}
@ Expanded
The expanded format, i.e., the format specified in FIPS-203/204.
Definition kyber.h:88

References BOTAN_ASSERT_UNREACHABLE, Botan::Expanded, Botan::Kyber_PublicKey::m_public, private_key_format(), and Botan::Seed.

Referenced by private_key_bits().

◆ private_key_format()

MlPrivateKeyFormat Botan::Kyber_PrivateKey::private_key_format ( ) const

The private key format from which the key was loaded. It is the format used for the private_key_bits(), raw_private_key_bits() andFIPS private_key_info() methods.

Note that keys in Seed format can be serialized to Expanded format using the method private_key_bits_with_format but NOT the other way around.

Definition at line 331 of file kyber.cpp.

331 {
332 if(mode().is_ml_kem() && m_private->seed().d.has_value()) {
334 }
336}

References Botan::Expanded, Botan::Kyber_PublicKey::mode(), and Botan::Seed.

Referenced by private_key_bits(), and private_key_bits_with_format().

◆ private_key_info()

secure_vector< uint8_t > Botan::Private_Key::private_key_info ( ) const
inherited
Returns
PKCS #8 private key encoding for this key object

Definition at line 68 of file pk_keys.cpp.

68 {
69 const size_t PKCS8_VERSION = 0;
70
71 return DER_Encoder()
72 .start_sequence()
73 .encode(PKCS8_VERSION)
76 .end_cons()
77 .get_contents();
78}
virtual AlgorithmIdentifier pkcs8_algorithm_identifier() const
Definition pk_keys.h:323

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

256 {
257 return std::make_unique<Kyber_PublicKey>(*this);
258}

◆ public_key_bits()

std::vector< uint8_t > Botan::Kyber_PublicKey::public_key_bits ( ) const
overridevirtualinherited
Returns
BER encoded public key bits

Implements Botan::Public_Key.

Definition at line 202 of file kyber.cpp.

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

References raw_public_key_bits().

Referenced by ~Kyber_PublicKey().

◆ raw_private_key_bits()

secure_vector< uint8_t > Botan::Kyber_PrivateKey::raw_private_key_bits ( ) const
overridevirtual
Returns
binary private key bits, with no additional encoding

Note: some algorithms (for example RSA) do not have an obvious encoding for this value due to having many different values, and thus not implement this function. The default implementation throws Not_Implemented

Reimplemented from Botan::Private_Key.

Definition at line 260 of file kyber.cpp.

260 {
261 return this->private_key_bits();
262}
secure_vector< uint8_t > private_key_bits() const override
Definition kyber.cpp:264

References private_key_bits().

◆ raw_public_key_bits()

std::vector< uint8_t > Botan::Kyber_PublicKey::raw_public_key_bits ( ) const
overridevirtualinherited
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 198 of file kyber.cpp.

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

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

336{ 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 329 of file pk_keys.h.

329{ return false; }

◆ 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 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::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 124 of file kyber.h.

124 {
126 }

References Botan::KeyEncapsulation.

Friends And Related Symbol Documentation

◆ Kyber_KEM_Decryptor

friend class Kyber_KEM_Decryptor
friend

Definition at line 209 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: