Botan 3.3.0
Crypto and TLS for C&
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
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

std::string algo_name () const override
 
AlgorithmIdentifier algorithm_identifier () const override
 
bool check_key (RandomNumberGenerator &, bool) 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
 
virtual 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)
 
virtual size_t message_part_size () const
 
virtual 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_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
 
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
 

Protected Member Functions

const std::vector< uint8_t > & H_public_key_bits_raw () const
 
const std::vector< uint8_t > & public_key_bits_raw () const
 

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< Kyber_PublicKeyInternal > m_public
 

Friends

class Kyber_KEM_Decryptor
 

Detailed Description

Definition at line 131 of file kyber.h.

Constructor & Destructor Documentation

◆ Kyber_PrivateKey() [1/3]

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

Definition at line 1278 of file kyber.cpp.

1278 {
1279 KyberConstants mode(m);
1280
1281 auto G = mode.G();
1282 auto seed = G->process(rng.random_vec(KyberConstants::kSymBytes));
1283
1284 const auto middle = G->output_length() / 2;
1285
1286 BufferSlicer s(seed);
1287 auto seed1 = s.copy_as_vector(middle);
1288 auto seed2 = s.take(middle);
1289 BOTAN_ASSERT_NOMSG(s.empty());
1290
1291 auto a = PolynomialMatrix::generate(seed1, false, mode);
1292 auto skpv = PolynomialVector::getnoise_eta1(seed2, 0, mode);
1293 auto e = PolynomialVector::getnoise_eta1(seed2, mode.k(), mode);
1294
1295 skpv.ntt();
1296 e.ntt();
1297
1298 // matrix-vector multiplication
1299 auto pkpv = a.pointwise_acc_montgomery(skpv, true);
1300 pkpv += e;
1301 pkpv.reduce();
1302
1303 m_public = std::make_shared<Kyber_PublicKeyInternal>(mode, std::move(pkpv), std::move(seed1));
1304 m_private = std::make_shared<Kyber_PrivateKeyInternal>(
1305 std::move(mode), std::move(skpv), rng.random_vec(KyberConstants::kZLength));
1306}
#define BOTAN_ASSERT_NOMSG(expr)
Definition assert.h:59
std::shared_ptr< Kyber_PublicKeyInternal > m_public
Definition kyber.h:125
KyberMode mode() const
Definition kyber.cpp:1212

References BOTAN_ASSERT_NOMSG, Botan::BufferSlicer::copy_as_vector(), Botan::BufferSlicer::empty(), Botan::Kyber_PublicKey::m_public, Botan::Kyber_PublicKey::mode(), Botan::RandomNumberGenerator::random_vec(), and Botan::BufferSlicer::take().

◆ Kyber_PrivateKey() [2/3]

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

Definition at line 1311 of file kyber.cpp.

1311 {
1312 KyberConstants mode(m);
1313
1314 if(mode.private_key_byte_length() != sk.size()) {
1315 throw Invalid_Argument("kyber private key does not have the correct byte count");
1316 }
1317
1318 BufferSlicer s(sk);
1319
1320 auto skpv = PolynomialVector::from_bytes(s.take(mode.polynomial_vector_byte_length()), mode);
1321 auto pub_key = s.take(mode.public_key_byte_length());
1322 s.skip(KyberConstants::kPublicKeyHashLength);
1323 auto z = s.copy_as_secure_vector(KyberConstants::kZLength);
1324
1325 BOTAN_ASSERT_NOMSG(s.empty());
1326
1327 m_public = initialize_from_encoding(pub_key, m);
1328 m_private = std::make_shared<Kyber_PrivateKeyInternal>(std::move(mode), std::move(skpv), std::move(z));
1329
1330 BOTAN_ASSERT(m_private && m_public, "reading private key encoding");
1331}
#define BOTAN_ASSERT(expr, assertion_made)
Definition assert.h:50
static std::shared_ptr< Kyber_PublicKeyInternal > initialize_from_encoding(std::span< const uint8_t > pub_key, KyberMode m)
Definition kyber.cpp:1228

References BOTAN_ASSERT, BOTAN_ASSERT_NOMSG, Botan::BufferSlicer::copy_as_secure_vector(), Botan::BufferSlicer::empty(), Botan::Kyber_PublicKey::initialize_from_encoding(), Botan::Kyber_PublicKey::m_public, Botan::Kyber_PublicKey::mode(), Botan::BufferSlicer::skip(), and Botan::BufferSlicer::take().

◆ Kyber_PrivateKey() [3/3]

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

Definition at line 1308 of file kyber.cpp.

1308 :
1309 Kyber_PrivateKey(key_bits, KyberMode(alg_id.oid())) {}
Kyber_PrivateKey(RandomNumberGenerator &rng, KyberMode mode)
Definition kyber.cpp:1278

Member Function Documentation

◆ algo_name()

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

Get the name of the underlying public key scheme.

Returns
name of the public key scheme

Implements Botan::Asymmetric_Key.

Definition at line 87 of file kyber.h.

87{ return "Kyber"; }

Referenced by create_kem_decryption_op(), and Botan::Kyber_PublicKey::create_kem_encryption_op().

◆ algorithm_identifier()

AlgorithmIdentifier Botan::Kyber_PublicKey::algorithm_identifier ( ) const
overridevirtualinherited
Returns
X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 1216 of file kyber.cpp.

1216 {
1217 return AlgorithmIdentifier(mode().object_identifier(), AlgorithmIdentifier::USE_EMPTY_PARAM);
1218}
OID object_identifier() const override
Definition kyber.cpp:1220

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

◆ check_key()

bool Botan::Kyber_PublicKey::check_key ( RandomNumberGenerator & ,
bool  ) const
overridevirtualinherited

Implements Botan::Public_Key.

Definition at line 1270 of file kyber.cpp.

1270 {
1271 return true; // ??
1272}

◆ 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, and Botan::SM2_PrivateKey.

Definition at line 111 of file pk_keys.cpp.

113 {
114 throw Lookup_Error(fmt("{} does not support decryption", algo_name()));
115}
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, and Botan::SM2_PublicKey.

Definition at line 90 of file pk_keys.cpp.

92 {
93 throw Lookup_Error(fmt("{} does not support encryption", algo_name()));
94}

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

1358 {
1359 BOTAN_UNUSED(rng);
1360 if(provider.empty() || provider == "base") {
1361 return std::make_unique<Kyber_KEM_Decryptor>(*this, params);
1362 }
1363 throw Provider_Not_Found(algo_name(), provider);
1364}
#define BOTAN_UNUSED
Definition assert.h:118
std::string algo_name() const override
Definition kyber.h:87

References Botan::Kyber_PublicKey::algo_name(), and BOTAN_UNUSED.

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

1349 {
1350 if(provider.empty() || provider == "base") {
1351 return std::make_unique<Kyber_KEM_Encryptor>(*this, params);
1352 }
1353 throw Provider_Not_Found(algo_name(), provider);
1354}

References Botan::Kyber_PublicKey::algo_name().

◆ 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::Curve25519_PrivateKey, Botan::DH_PrivateKey, and Botan::ECDH_PrivateKey.

Definition at line 129 of file pk_keys.cpp.

131 {
132 throw Lookup_Error(fmt("{} does not support key agreement", algo_name()));
133}

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::XMSS_PrivateKey, Botan::TPM_PrivateKey, Botan::DSA_PrivateKey, Botan::ECDSA_PrivateKey, Botan::ECGDSA_PrivateKey, Botan::ECKCDSA_PrivateKey, Botan::Ed25519_PrivateKey, Botan::GOST_3410_PrivateKey, Botan::RSA_PrivateKey, Botan::SM2_PrivateKey, and Botan::SphincsPlus_PrivateKey.

Definition at line 123 of file pk_keys.cpp.

125 {
126 throw Lookup_Error(fmt("{} does not support signatures", algo_name()));
127}

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::GOST_3410_PublicKey, Botan::RSA_PublicKey, Botan::SM2_PublicKey, Botan::SphincsPlus_PublicKey, and Botan::XMSS_PublicKey.

Definition at line 101 of file pk_keys.cpp.

102 {
103 throw Lookup_Error(fmt("{} does not support verification", algo_name()));
104}

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::RSA_PublicKey, Botan::XMSS_PublicKey, Botan::Dilithium_PublicKey, Botan::DSA_PublicKey, Botan::ECDSA_PublicKey, Botan::ECGDSA_PublicKey, Botan::ECKCDSA_PublicKey, Botan::Ed25519_PublicKey, Botan::GOST_3410_PublicKey, and Botan::SphincsPlus_PublicKey.

Definition at line 106 of file pk_keys.cpp.

107 {
108 throw Lookup_Error(fmt("{} does not support X.509 verification", algo_name()));
109}

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

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

◆ default_x509_signature_format()

virtual Signature_Format Botan::Public_Key::default_x509_signature_format ( ) const
inlinevirtualinherited

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

1224 {
1225 return m_public->mode().estimated_strength();
1226}

References Botan::Kyber_PublicKey::m_public.

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

86 {
87 return create_hex_fingerprint(private_key_bits(), hash_algo);
88}
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:30

References Botan::create_hex_fingerprint(), and Botan::Private_Key::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 79 of file pk_keys.cpp.

79 {
80 return create_hex_fingerprint(subject_public_key(), hash_algo);
81}
std::vector< uint8_t > subject_public_key() const
Definition pk_keys.cpp:48

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

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

1274 {
1275 return std::make_unique<Kyber_PrivateKey>(rng, mode());
1276}

References Botan::Kyber_PublicKey::mode().

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

Reimplemented in Botan::EC_PrivateKey, Botan::DH_PublicKey, Botan::DH_PrivateKey, Botan::DSA_PublicKey, Botan::DSA_PrivateKey, Botan::EC_PublicKey, Botan::ElGamal_PublicKey, Botan::ElGamal_PrivateKey, Botan::RSA_PublicKey, and Botan::RSA_PrivateKey.

Definition at line 18 of file pk_keys.cpp.

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

References Botan::Asymmetric_Key::algo_name().

Referenced by 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 132 of file pk_keys.h.

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

◆ H_public_key_bits_raw()

const std::vector< uint8_t > & Botan::Kyber_PublicKey::H_public_key_bits_raw ( ) const
protectedinherited

Definition at line 1262 of file kyber.cpp.

1262 {
1263 return m_public->H_public_key_bits_raw();
1264}

References Botan::Kyber_PublicKey::m_public.

Referenced by private_key_bits().

◆ initialize_from_encoding()

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

Definition at line 1228 of file kyber.cpp.

1229 {
1230 KyberConstants mode(m);
1231
1232 if(pub_key.size() != mode.public_key_byte_length()) {
1233 throw Invalid_Argument("kyber public key does not have the correct byte count");
1234 }
1235
1236 BufferSlicer s(pub_key);
1237
1238 auto poly_vec = s.take(mode.polynomial_vector_byte_length());
1239 auto seed = s.copy_as_vector(KyberConstants::kSeedLength);
1240 BOTAN_ASSERT_NOMSG(s.empty());
1241
1242 return std::make_shared<Kyber_PublicKeyInternal>(std::move(mode), poly_vec, std::move(seed));
1243}

References BOTAN_ASSERT_NOMSG, Botan::BufferSlicer::copy_as_vector(), Botan::BufferSlicer::empty(), Botan::Kyber_PublicKey::mode(), and Botan::BufferSlicer::take().

Referenced by Kyber_PrivateKey().

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

1266 {
1267 return m_public->mode().public_key_byte_length();
1268}

References Botan::Kyber_PublicKey::m_public.

◆ message_part_size()

virtual size_t Botan::Public_Key::message_part_size ( ) const
inlinevirtualinherited

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

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

188{ return 0; }

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

◆ message_parts()

virtual size_t Botan::Public_Key::message_parts ( ) const
inlinevirtualinherited

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

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

177{ return 1; }

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

◆ mode()

KyberMode Botan::Kyber_PublicKey::mode ( ) const
inherited

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

1220 {
1221 return mode().object_identifier();
1222}
OID object_identifier() const
Definition kyber.cpp:96

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

Referenced by Botan::Kyber_PublicKey::algorithm_identifier().

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

Definition at line 285 of file pk_keys.h.

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

Referenced by Botan::Private_Key::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 1341 of file kyber.cpp.

1341 {
1342 return concat(m_private->polynomials().to_bytes<secure_vector<uint8_t>>(),
1345 m_private->z());
1346}
const std::vector< uint8_t > & H_public_key_bits_raw() const
Definition kyber.cpp:1262
const std::vector< uint8_t > & public_key_bits_raw() const
Definition kyber.cpp:1258
decltype(auto) concat(Ts &&... buffers)
Definition stl_util.h:257

References Botan::concat(), Botan::Kyber_PublicKey::H_public_key_bits_raw(), and Botan::Kyber_PublicKey::public_key_bits_raw().

Referenced by raw_private_key_bits().

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

60 {
61 const size_t PKCS8_VERSION = 0;
62
63 return DER_Encoder()
64 .start_sequence()
65 .encode(PKCS8_VERSION)
68 .end_cons()
69 .get_contents();
70}
virtual AlgorithmIdentifier pkcs8_algorithm_identifier() const
Definition pk_keys.h:285

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::DER_Encoder::get_contents(), Botan::OctetString, Botan::Private_Key::pkcs8_algorithm_identifier(), Botan::Private_Key::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(), and Botan::PKCS8::PEM_encode().

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

1333 {
1334 return std::make_unique<Kyber_PublicKey>(*this);
1335}

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

1254 {
1255 return public_key_bits_raw();
1256}

References Botan::Kyber_PublicKey::public_key_bits_raw().

◆ public_key_bits_raw()

const std::vector< uint8_t > & Botan::Kyber_PublicKey::public_key_bits_raw ( ) const
protectedinherited

Definition at line 1258 of file kyber.cpp.

1258 {
1259 return m_public->public_key_bits_raw();
1260}

References Botan::Kyber_PublicKey::m_public.

Referenced by private_key_bits(), and Botan::Kyber_PublicKey::public_key_bits().

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

1337 {
1338 return this->private_key_bits();
1339}
secure_vector< uint8_t > private_key_bits() const override
Definition kyber.cpp:1341

References private_key_bits().

◆ 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::XMSS_PrivateKey.

Definition at line 298 of file pk_keys.h.

298{ 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::XMSS_PrivateKey.

Definition at line 291 of file pk_keys.h.

291{ 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 48 of file pk_keys.cpp.

48 {
49 std::vector<uint8_t> output;
50
51 DER_Encoder(output)
52 .start_sequence()
53 .encode(algorithm_identifier())
55 .end_cons();
56
57 return output;
58}
virtual std::vector< uint8_t > public_key_bits() const =0

References Botan::Public_Key::algorithm_identifier(), Botan::BitString, Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), Botan::Public_Key::public_key_bits(), and Botan::DER_Encoder::start_sequence().

Referenced by Botan::X509::BER_encode(), Botan::PKCS10_Request::create(), Botan::Public_Key::fingerprint_public(), and Botan::X509::PEM_encode().

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

103 {
105 }

Friends And Related Symbol Documentation

◆ Kyber_KEM_Decryptor

friend class Kyber_KEM_Decryptor
friend

Definition at line 151 of file kyber.h.

Member Data Documentation

◆ m_public

std::shared_ptr<Kyber_PublicKeyInternal> Botan::Kyber_PublicKey::m_public
protectedinherited

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