#include <kyber.h>

Inheritance diagram for Botan::Kyber_PublicKey:

Public Member Functions
std::string	algo_name () const override

AlgorithmIdentifier	algorithm_identifier () const override

KyberKeyEncoding	binary_encoding () const

bool	check_key (RandomNumberGenerator &, bool) const override

virtual std::unique_ptr< PK_Ops::Encryption >	create_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const

std::unique_ptr< PK_Ops::KEM_Encryption >	create_kem_encryption_op (RandomNumberGenerator &rng, const std::string &params, const std::string &provider) const override

virtual std::unique_ptr< PK_Ops::Verification >	create_verification_op (const std::string &params, const std::string &provider) const

virtual Signature_Format	default_x509_signature_format () const

size_t	estimated_strength () const override

std::string	fingerprint_public (const std::string &alg="SHA-256") const

virtual OID	get_oid () const

size_t	key_length () const override

	Kyber_PublicKey (const Kyber_PublicKey &other)

	Kyber_PublicKey (std::vector< uint8_t > pub_key, KyberMode mode, KyberKeyEncoding encoding)

virtual size_t	message_part_size () const

virtual size_t	message_parts () const

KyberMode	mode () const

Kyber_PublicKey &	operator= (const Kyber_PublicKey &other)=default

std::vector< uint8_t >	public_key_bits () const override

void	set_binary_encoding (KyberKeyEncoding encoding)

std::vector< uint8_t >	subject_public_key () const

virtual	~Kyber_PublicKey ()=default

Protected Member Functions
void	initialize_from_encoding (std::vector< uint8_t > pub_key, KyberMode m, KyberKeyEncoding encoding)

	Kyber_PublicKey ()

std::vector< uint8_t >	public_key_bits_der () const

std::vector< uint8_t >	public_key_bits_raw () const

Protected Attributes
KyberKeyEncoding	m_key_encoding

std::shared_ptr< Kyber_PublicKeyInternal >	m_public

Friends
class	Kyber_KEM_Decryptor

class	Kyber_KEM_Encryptor

Detailed Description

Definition at line 68 of file kyber.h.

Constructor & Destructor Documentation

◆ Kyber_PublicKey() [1/3]

Botan::Kyber_PublicKey::Kyber_PublicKey	(	std::vector< uint8_t >	pub_key,
		KyberMode	mode,
		KyberKeyEncoding	encoding
	)

Definition at line 1343 of file kyber.cpp.

   : Kyber_PublicKey()
   {
   initialize_from_encoding(std::move(pub_key), m, encoding);
   }

References initialize_from_encoding().

◆ Kyber_PublicKey() [2/3]

Botan::Kyber_PublicKey::Kyber_PublicKey ( const Kyber_PublicKey & other )

Definition at line 1349 of file kyber.cpp.

   : m_public(std::make_shared<Kyber_PublicKeyInternal>(*other.m_public)), m_key_encoding(other.m_key_encoding)
   {
   }

◆ ~Kyber_PublicKey()

virtual Botan::Kyber_PublicKey::~Kyber_PublicKey ( )

virtualdefault

◆ Kyber_PublicKey() [3/3]

Botan::Kyber_PublicKey::Kyber_PublicKey ( )

inlineprotected

Definition at line 107 of file kyber.h.

                        : m_key_encoding(KyberKeyEncoding::Full)
         {
         }

References Botan::Full.

Member Function Documentation

◆ algo_name()

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

inlineoverridevirtual

Get the name of the underlying public key scheme.

Returns: name of the public key scheme

Implements Botan::Public_Key.

Definition at line 79 of file kyber.h.

79{ return "Kyber-r3"; }

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

◆ algorithm_identifier()

AlgorithmIdentifier Botan::Kyber_PublicKey::algorithm_identifier ( ) const

overridevirtual

Returns: X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 1295 of file kyber.cpp.

   {
   return AlgorithmIdentifier(mode().get_oid(), AlgorithmIdentifier::USE_EMPTY_PARAM);
   }

References Botan::Public_Key::get_oid(), mode(), and Botan::AlgorithmIdentifier::USE_EMPTY_PARAM.

◆ binary_encoding()

KyberKeyEncoding Botan::Kyber_PublicKey::binary_encoding ( ) const

inline

Definition at line 101 of file kyber.h.

         {
         return m_key_encoding;
         }

Referenced by Botan::Kyber_PrivateKey::public_key().

◆ check_key()

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

overridevirtual

Test the key values for consistency.

Parameters

rng	rng to use
strong	whether to perform strong and lengthy version of the test

Returns: true if the test is passed

Implements Botan::Public_Key.

Definition at line 1391 of file kyber.cpp.

   {
   return true; // ??
   }

◆ create_encryption_op()

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

rng	a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
params	additional parameters
provider	the provider to use

Reimplemented in Botan::ElGamal_PublicKey, Botan::RSA_PublicKey, and Botan::SM2_PublicKey.

Definition at line 91 of file pk_keys.cpp.

   {
   throw Lookup_Error(algo_name() + " does not support encryption");
   }

References Botan::Public_Key::algo_name().

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

◆ create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::Kyber_PublicKey::create_kem_encryption_op	(	RandomNumberGenerator &	rng,
		const std::string &	params,
		const std::string &	provider
	)		const

overridevirtual

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

Return a KEM encryption operation for this key/params or throw

Parameters

rng	a random number generator. The PK_Op may maintain a reference to the RNG and use it many times. The rng must outlive any operations which reference it.
params	additional parameters
provider	the provider to use

Reimplemented from Botan::Public_Key.

Definition at line 1540 of file kyber.cpp.

   {
   BOTAN_UNUSED(rng);
   if(provider.empty() || provider == "base")
      return std::make_unique<Kyber_KEM_Encryptor>(*this, params);
   throw Provider_Not_Found(algo_name(), provider);
   }

References algo_name(), and BOTAN_UNUSED.

◆ create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Public_Key::create_verification_op	(	const std::string &	params,
		const std::string &	provider
	)		const

virtualinherited

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

Return a verification operation for this key/params or throw

Parameters

params	additional parameters
provider	the provider to use

Reimplemented in Botan::XMSS_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, and Botan::XMSS_WOTS_Addressed_PublicKey.

Definition at line 107 of file pk_keys.cpp.

   {
   throw Lookup_Error(algo_name() + " does not support verification");
   }

References Botan::Public_Key::algo_name().

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

◆ default_x509_signature_format()

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

inlinevirtualinherited

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 125 of file pk_keys.h.

         {
         return (this->message_parts() >= 2) ? DER_SEQUENCE : IEEE_1363;
         }

References Botan::DER_SEQUENCE, and Botan::IEEE_1363.

Referenced by Botan::X509_Object::choose_sig_format(), and Botan::X509_Object::verify_signature().

◆ estimated_strength()

size_t Botan::Kyber_PublicKey::estimated_strength ( ) const

overridevirtual

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::Public_Key.

Definition at line 1300 of file kyber.cpp.

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

References m_public.

◆ fingerprint_public()

std::string Botan::Public_Key::fingerprint_public ( const std::string & alg = "SHA-256" ) const

inherited

Returns: Hash of the subject public key

Definition at line 77 of file pk_keys.cpp.

   {
   return create_hex_fingerprint(subject_public_key(), hash_algo);
   }

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

◆ get_oid()

OID Botan::Public_Key::get_oid ( ) const

virtualinherited

Get the OID of the underlying public key scheme.

Returns: OID of the public key scheme

Reimplemented in Botan::XMSS_WOTS_Addressed_PublicKey.

Definition at line 53 of file pk_keys.cpp.

   {
   OID o = OIDS::str2oid_or_empty(algo_name());
   if(o.empty())
      throw Lookup_Error("PK algo " + algo_name() + " has no defined OIDs");
   return o;
   }

References Botan::Public_Key::algo_name(), Botan::OID::empty(), and Botan::OIDS::str2oid_or_empty().

Referenced by Botan::TPM_PrivateKey::algorithm_identifier(), Botan::Curve25519_PublicKey::algorithm_identifier(), Botan::DL_Scheme_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), Botan::Ed25519_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), algorithm_identifier(), Botan::McEliece_PublicKey::algorithm_identifier(), Botan::RSA_PublicKey::algorithm_identifier(), and Botan::XMSS_WOTS_Addressed_PublicKey::get_oid().

◆ initialize_from_encoding()

void Botan::Kyber_PublicKey::initialize_from_encoding	(	std::vector< uint8_t >	pub_key,
		KyberMode	m,
		KyberKeyEncoding	encoding
	)

protected

Definition at line 1305 of file kyber.cpp.

   {
   KyberConstants mode(m);
 
   std::vector<uint8_t> poly_vec, seed;
 
   switch(encoding)
      {
      case KyberKeyEncoding::Full:
         BER_Decoder(pub_key)
         .start_sequence()
         .decode(poly_vec, ASN1_Type::OctetString)
         .decode(seed, ASN1_Type::OctetString)
         .end_cons();
         break;
      case KyberKeyEncoding::Raw:
         if(pub_key.size() != mode.public_key_byte_length())
            {
            throw Botan::Invalid_Argument("kyber public key does not have the correct byte count");
            }
         poly_vec = std::vector<uint8_t>(pub_key.begin(), pub_key.end() - KyberConstants::kSeedLength);
         seed = std::vector<uint8_t>(pub_key.end() - KyberConstants::kSeedLength, pub_key.end());
         break;
      }
 
   if(poly_vec.size() != mode.polynomial_vector_byte_length())
      {
      throw Botan::Invalid_Argument("kyber public key t-param does not have the correct byte count");
      }
 
   if(seed.size() != KyberConstants::kSeedLength)
      {
      throw Botan::Invalid_Argument("kyber public key rho-param does not have the correct byte count");
      }
 
   m_public = std::make_shared<Kyber_PublicKeyInternal>(std::move(mode), std::move(poly_vec), std::move(seed));
   }

References Botan::BER_Decoder::decode(), Botan::BER_Decoder::end_cons(), Botan::Full, mode(), Botan::OctetString, Botan::Raw, and Botan::BER_Decoder::start_sequence().

Referenced by Kyber_PublicKey().

◆ key_length()

size_t Botan::Kyber_PublicKey::key_length ( ) const

overridevirtual

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

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

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

123{ return 0; }

Referenced by Botan::PK_Signer::PK_Signer(), 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 112 of file pk_keys.h.

112{ return 1; }

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

◆ mode()

KyberMode Botan::Kyber_PublicKey::mode ( ) const

Definition at line 1290 of file kyber.cpp.

   {
   return m_public->mode().mode();
   }

References m_public.

Referenced by algorithm_identifier(), initialize_from_encoding(), and Botan::Kyber_PrivateKey::Kyber_PrivateKey().

◆ operator=()

Kyber_PublicKey & Botan::Kyber_PublicKey::operator= ( const Kyber_PublicKey & other )

default

◆ public_key_bits()

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

overridevirtual

Returns: BER encoded public key bits

Implements Botan::Public_Key.

Definition at line 1354 of file kyber.cpp.

   {
   switch(m_key_encoding)
      {
      case KyberKeyEncoding::Full:
         return public_key_bits_der();
      case KyberKeyEncoding::Raw:
         return public_key_bits_raw();
      }
 
   Botan::unreachable();
   }

References Botan::Full, m_key_encoding, public_key_bits_der(), public_key_bits_raw(), Botan::Raw, and Botan::unreachable().

◆ public_key_bits_der()

std::vector< uint8_t > Botan::Kyber_PublicKey::public_key_bits_der ( ) const

protected

Definition at line 1373 of file kyber.cpp.

   {
   std::vector<uint8_t> output;
   DER_Encoder der(output);
 
   der.start_sequence()
      .encode(m_public->polynomials().to_bytes<std::vector<uint8_t>>(), ASN1_Type::OctetString)
      .encode(m_public->seed(), ASN1_Type::OctetString)
      .end_cons();
 
   return output;
   }

References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), m_public, Botan::OctetString, and Botan::DER_Encoder::start_sequence().

Referenced by public_key_bits().

◆ public_key_bits_raw()

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

protected

Definition at line 1367 of file kyber.cpp.

   {
   return concat(m_public->polynomials().to_bytes<std::vector<uint8_t>>(),
                 m_public->seed());
   }

References Botan::concat(), and m_public.

Referenced by public_key_bits().

◆ set_binary_encoding()

void Botan::Kyber_PublicKey::set_binary_encoding ( KyberKeyEncoding encoding )

inline

Definition at line 97 of file kyber.h.

         {
         m_key_encoding = encoding;
         }

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

   {
   std::vector<uint8_t> output;
 
   DER_Encoder(output).start_sequence()
         .encode(algorithm_identifier())
         .encode(public_key_bits(), ASN1_Type::BitString)
      .end_cons();
 
   return output;
   }

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

Friends And Related Function Documentation

◆ Kyber_KEM_Decryptor

friend class Kyber_KEM_Decryptor

friend

Definition at line 118 of file kyber.h.

◆ Kyber_KEM_Encryptor

friend class Kyber_KEM_Encryptor

friend

Definition at line 117 of file kyber.h.

Member Data Documentation

◆ m_key_encoding

KyberKeyEncoding Botan::Kyber_PublicKey::m_key_encoding

protected

Definition at line 121 of file kyber.h.

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

◆ m_public

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

protected

Definition at line 120 of file kyber.h.

Referenced by estimated_strength(), key_length(), mode(), public_key_bits_der(), and public_key_bits_raw().

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

src/lib/pubkey/kyber/kyber_common/kyber.h
src/lib/pubkey/kyber/kyber_common/kyber.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Kyber_PublicKey() [1/3]

◆ Kyber_PublicKey() [2/3]

◆ ~Kyber_PublicKey()

◆ Kyber_PublicKey() [3/3]

Member Function Documentation

◆ algo_name()

◆ algorithm_identifier()

◆ binary_encoding()

◆ check_key()

◆ create_encryption_op()

◆ create_kem_encryption_op()

◆ create_verification_op()

◆ default_x509_signature_format()

◆ estimated_strength()

◆ fingerprint_public()

◆ get_oid()

◆ initialize_from_encoding()

◆ key_length()

◆ message_part_size()

◆ message_parts()

◆ mode()

◆ operator=()

◆ public_key_bits()

◆ public_key_bits_der()

◆ public_key_bits_raw()

◆ set_binary_encoding()

◆ subject_public_key()

Friends And Related Function Documentation

◆ Kyber_KEM_Decryptor

◆ Kyber_KEM_Encryptor

Member Data Documentation

◆ m_key_encoding

◆ m_public