Botan::FrodoKEM_PublicKey Class Reference

#include <frodokem.h>

Inheritance diagram for Botan::FrodoKEM_PublicKey:

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::Encryption >	create_encryption_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 override
virtual 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_public (std::string_view alg="SHA-256") const
	FrodoKEM_PublicKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > key_bits)
	FrodoKEM_PublicKey (const FrodoKEM_PublicKey &other)
	FrodoKEM_PublicKey (FrodoKEM_PublicKey &&)=default
	FrodoKEM_PublicKey (std::span< const uint8_t > pub_key, FrodoKEMMode mode)
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
size_t	message_part_size () const
size_t	message_parts () const
OID	object_identifier () const override
FrodoKEM_PublicKey &	operator= (const FrodoKEM_PublicKey &other)
FrodoKEM_PublicKey &	operator= (FrodoKEM_PublicKey &&)=default
std::vector< uint8_t >	public_key_bits () const override
std::vector< uint8_t >	raw_public_key_bits () const override
std::vector< uint8_t >	subject_public_key () const
bool	supports_operation (PublicKeyOperation op) const override
	~FrodoKEM_PublicKey () override=default

Protected Member Functions
	FrodoKEM_PublicKey ()=default

Protected Attributes
std::shared_ptr< FrodoKEM_PublicKeyInternal >	m_public

Detailed Description

FrodoKEM is an unstructured lattice-based post-quantum secure KEM. It is a round 3 candidate in NIST's PQC competition but was eventually not considered for standardization by NIST. Nevertheless, it is endorsed by the German Federal Office for Information Security for its conservative security assumptions and is being standardized as an ISO standard.

Definition at line 33 of file frodokem.h.

Constructor & Destructor Documentation

FrodoKEM_PublicKey() [1/5]

Botan::FrodoKEM_PublicKey::FrodoKEM_PublicKey	(	std::span< const uint8_t >	pub_key,
		FrodoKEMMode	mode )

Definition at line 245 of file frodokem.cpp.

                                                                                        {
   FrodoKEMConstants constants(mode);
   if(pub_key.size() != constants.len_public_key_bytes()) {
      throw Invalid_Argument("FrodoKEM public key does not have the correct byte count");
   }
 
   BufferSlicer pk_bs(pub_key);
   auto seed_a = pk_bs.copy<FrodoSeedA>(constants.len_a_bytes());
   const auto packed_b = pk_bs.take<FrodoPackedMatrix>(constants.d() * constants.n() * constants.n_bar() / 8);
   BOTAN_ASSERT_NOMSG(pk_bs.empty());
 
   auto b = FrodoMatrix::unpack(constants, std::tuple(constants.n(), constants.n_bar()), packed_b);
 
   m_public = std::make_shared<FrodoKEM_PublicKeyInternal>(std::move(constants), std::move(seed_a), std::move(b));
}

References BOTAN_ASSERT_NOMSG, Botan::BufferSlicer::copy(), Botan::FrodoKEMConstants::d(), Botan::BufferSlicer::empty(), Botan::FrodoKEMConstants::len_a_bytes(), Botan::FrodoKEMConstants::len_public_key_bytes(), m_public, Botan::FrodoKEMConstants::n(), Botan::FrodoKEMConstants::n_bar(), Botan::BufferSlicer::take(), and Botan::FrodoMatrix::unpack().

Referenced by FrodoKEM_PublicKey(), FrodoKEM_PublicKey(), FrodoKEM_PublicKey(), operator=(), and operator=().

FrodoKEM_PublicKey() [2/5]

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

Definition at line 261 of file frodokem.cpp.

                                                                                                         :
      FrodoKEM_PublicKey(key_bits, FrodoKEMMode(alg_id.oid())) {}

References FrodoKEM_PublicKey().

FrodoKEM_PublicKey() [3/5]

Botan::FrodoKEM_PublicKey::FrodoKEM_PublicKey

(

const FrodoKEM_PublicKey &

other

)

Definition at line 264 of file frodokem.cpp.

                                                                      {
   m_public = std::make_shared<FrodoKEM_PublicKeyInternal>(
      other.m_public->constants(), other.m_public->seed_a(), other.m_public->b());
}

References FrodoKEM_PublicKey(), and m_public.

FrodoKEM_PublicKey() [4/5]

Botan::FrodoKEM_PublicKey::FrodoKEM_PublicKey ( FrodoKEM_PublicKey && )

default

References FrodoKEM_PublicKey().

~FrodoKEM_PublicKey()

Botan::FrodoKEM_PublicKey::~FrodoKEM_PublicKey ( )

overridedefault

FrodoKEM_PublicKey() [5/5]

Botan::FrodoKEM_PublicKey::FrodoKEM_PublicKey ( )

protecteddefault

Member Function Documentation

_default_x509_signature_format()

Signature_Format Botan::Asymmetric_Key::_default_x509_signature_format ( ) const

virtualinherited

Reimplemented in Botan::GOST_3410_PublicKey.

Definition at line 30 of file pk_keys.cpp.

                                                                      {
   if(_signature_element_size_for_DER_encoding()) {
      return Signature_Format::DerSequence;
   } else {
      return Signature_Format::Standard;
   }
}

References _signature_element_size_for_DER_encoding(), Botan::DerSequence, and Botan::Standard.

Referenced by Botan::X509_Object::choose_sig_format(), Botan::Public_Key::default_x509_signature_format(), and Botan::PK_Verifier::PK_Verifier().

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

{ 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::FrodoKEM_PublicKey::algo_name ( ) const

inlineoverridevirtual

Get the name of the underlying public key scheme.

Returns

name of the public key scheme

Implements Botan::Asymmetric_Key.

Definition at line 46 of file frodokem.h.

{ return "FrodoKEM"; }

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

algorithm_identifier()

AlgorithmIdentifier Botan::FrodoKEM_PublicKey::algorithm_identifier ( ) const

overridevirtual

Returns

X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 277 of file frodokem.cpp.

                                                                   {
   return AlgorithmIdentifier(object_identifier(), AlgorithmIdentifier::USE_EMPTY_PARAM);
}

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

check_key()

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

overridevirtual

Implements Botan::Asymmetric_Key.

Definition at line 303 of file frodokem.cpp.

                                                                         {
   // The public key consists of (seed_a, b) where b is a matrix of elements
   // mod q = 2^d. Length validation is performed in the constructor, and bit
   // unpacking naturally constrains all matrix elements to [0, 2^d - 1] which
   // is the full valid range, leaving no further structural checks to perform.
   return true;
}

Referenced by Botan::FrodoKEM_PrivateKey::check_key().

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

Random Number Generators	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, Botan::SM2_PublicKey, and Botan::TPM2::RSA_PublicKey.

Definition at line 105 of file pk_keys.cpp.

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

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

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

create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::FrodoKEM_PublicKey::create_kem_encryption_op ( std::string_view params, std::string_view 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

params	additional parameters
provider	the provider to use

Reimplemented from Botan::Public_Key.

Definition at line 315 of file frodokem.cpp.

                                                                                                                    {
   if(provider.empty() || provider == "base") {
      return std::make_unique<Frodo_KEM_Encryptor>(m_public, params);
   }
   throw Provider_Not_Found(algo_name(), provider);
}

References algo_name(), and m_public.

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

params	additional parameters
provider	the 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 116 of file pk_keys.cpp.

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

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_algorithm	is the X.509 algorithm identifier encoding the padding scheme and hash hash function used in the signature if applicable.
provider	the 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 121 of file pk_keys.cpp.

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

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

                                                                                                           {
         return _default_x509_signature_format();
      }

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

Referenced by default_x509_signature_format().

estimated_strength()

size_t Botan::FrodoKEM_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::Asymmetric_Key.

Definition at line 289 of file frodokem.cpp.

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

References m_public.

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

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

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

Referenced by public_key_bits().

generate_another()

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

finalvirtual

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 311 of file frodokem.cpp.

                                                                                                {
   return std::make_unique<FrodoKEM_PrivateKey>(rng, m_public->constants().mode());
}

References m_public.

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.

                                                                      {
   throw Unknown_PK_Field_Name(algo_name(), field);
}

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

{ return this->object_identifier(); }

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

Referenced by get_oid().

key_length()

size_t Botan::FrodoKEM_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 285 of file frodokem.cpp.

                                            {
   return m_public->constants().n();
}

References m_public.

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

                                                                                     {
         return _signature_element_size_for_DER_encoding().value_or(0);
      }

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

                                                                                 {
         return _signature_element_size_for_DER_encoding() ? 2 : 1;
      }

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

Referenced by message_parts().

object_identifier()

OID Botan::FrodoKEM_PublicKey::object_identifier ( ) const

overridevirtual

Get the OID of the underlying public key scheme.

Returns

OID of the public key scheme

Reimplemented from Botan::Asymmetric_Key.

Definition at line 281 of file frodokem.cpp.

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

References m_public.

Referenced by algorithm_identifier().

operator=() [1/2]

FrodoKEM_PublicKey & Botan::FrodoKEM_PublicKey::operator=

(

const FrodoKEM_PublicKey &

other

)

Definition at line 269 of file frodokem.cpp.

                                                                               {
   if(this != &other) {
      m_public = std::make_shared<FrodoKEM_PublicKeyInternal>(
         other.m_public->constants(), other.m_public->seed_a(), other.m_public->b());
   }
   return *this;
}

References FrodoKEM_PublicKey(), and m_public.

operator=() [2/2]

FrodoKEM_PublicKey & Botan::FrodoKEM_PublicKey::operator= ( FrodoKEM_PublicKey && )

default

References FrodoKEM_PublicKey().

public_key_bits()

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

overridevirtual

Returns

BER encoded public key bits

Implements Botan::Public_Key.

Definition at line 297 of file frodokem.cpp.

                                                             {
   // Currently, there isn't a finalized definition of an ASN.1 structure for
   // FrodoKEM public keys. Therefore, we return the raw public key bits.
   return raw_public_key_bits();
}

References raw_public_key_bits().

raw_public_key_bits()

std::vector< uint8_t > Botan::FrodoKEM_PublicKey::raw_public_key_bits ( ) const

overridevirtual

Returns

binary public key bits, with no additional encoding

For key agreements this is an alias for PK_Key_Agreement_Key::public_value.

Note: some algorithms (for example RSA) do not have an obvious encoding for this value due to having many different values, and thus throw Not_Implemented when invoking this method.

Implements Botan::Public_Key.

Definition at line 293 of file frodokem.cpp.

                                                                 {
   return concat<std::vector<uint8_t>>(m_public->seed_a(), m_public->b().pack(m_public->constants()));
}

References Botan::concat(), and m_public.

Referenced by public_key_bits().

subject_public_key()

std::vector< uint8_t > Botan::Public_Key::subject_public_key ( ) const

inherited

Returns

X.509 subject key encoding for this key object

Definition at line 63 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 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::FrodoKEM_PublicKey::supports_operation ( PublicKeyOperation op ) const

inlineoverridevirtual

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

Implements Botan::Asymmetric_Key.

Definition at line 62 of file frodokem.h.

                                                                    {
         return (op == PublicKeyOperation::KeyEncapsulation);
      }

References Botan::KeyEncapsulation.

Member Data Documentation

m_public

std::shared_ptr<FrodoKEM_PublicKeyInternal> Botan::FrodoKEM_PublicKey::m_public

protected

Definition at line 75 of file frodokem.h.

Referenced by Botan::FrodoKEM_PrivateKey::create_kem_decryption_op(), create_kem_encryption_op(), estimated_strength(), Botan::FrodoKEM_PrivateKey::FrodoKEM_PrivateKey(), Botan::FrodoKEM_PrivateKey::FrodoKEM_PrivateKey(), FrodoKEM_PublicKey(), FrodoKEM_PublicKey(), generate_another(), key_length(), object_identifier(), operator=(), Botan::FrodoKEM_PrivateKey::raw_private_key_bits(), and raw_public_key_bits().

---

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

• src/lib/pubkey/frodokem/frodokem_common/frodokem.h
• src/lib/pubkey/frodokem/frodokem_common/frodokem.cpp