Botan 3.7.1
Crypto and TLS for C&
Botan::Dilithium_PublicKey Class Reference

#include <dilithium.h>

Inheritance diagram for Botan::Dilithium_PublicKey:
Botan::Public_Key Botan::Asymmetric_Key Botan::Dilithium_PrivateKey

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 &, bool) const override
 
virtual std::unique_ptr< PK_Ops::Encryptioncreate_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const
 
virtual std::unique_ptr< PK_Ops::KEM_Encryptioncreate_kem_encryption_op (std::string_view params, std::string_view provider) const
 
std::unique_ptr< PK_Ops::Verificationcreate_verification_op (std::string_view params, std::string_view provider) const override
 
std::unique_ptr< PK_Ops::Verificationcreate_x509_verification_op (const AlgorithmIdentifier &signature_algorithm, std::string_view provider) const override
 
Signature_Format default_x509_signature_format () const
 
 Dilithium_PublicKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > pk)
 
 Dilithium_PublicKey (std::span< const uint8_t > pk, DilithiumMode mode)
 
size_t estimated_strength () const override
 
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
 
size_t message_part_size () const
 
size_t message_parts () const
 
OID object_identifier () const override
 
Dilithium_PublicKeyoperator= (const Dilithium_PublicKey &other)=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
 
 ~Dilithium_PublicKey () override=default
 

Protected Member Functions

 Dilithium_PublicKey ()=default
 

Protected Attributes

std::shared_ptr< Dilithium_PublicKeyInternalm_public
 

Friends

class Dilithium_Signature_Operation
 
class Dilithium_Verification_Operation
 

Detailed Description

This implementation is based on https://github.com/pq-crystals/dilithium/commit/3e9b9f1412f6c7435dbeb4e10692ea58f181ee51

Note that this is not compatible with the round 3 submission of the NIST competition.

Definition at line 67 of file dilithium.h.

Constructor & Destructor Documentation

◆ ~Dilithium_PublicKey()

Botan::Dilithium_PublicKey::~Dilithium_PublicKey ( )
overridedefault

◆ Dilithium_PublicKey() [1/3]

Botan::Dilithium_PublicKey::Dilithium_PublicKey ( const AlgorithmIdentifier & alg_id,
std::span< const uint8_t > pk )

Definition at line 318 of file dilithium.cpp.

318 :
319 Dilithium_PublicKey(pk, DilithiumMode(alg_id.oid())) {}

◆ Dilithium_PublicKey() [2/3]

Botan::Dilithium_PublicKey::Dilithium_PublicKey ( std::span< const uint8_t > pk,
DilithiumMode mode )

Definition at line 321 of file dilithium.cpp.

321 {
322 DilithiumConstants mode(m);
323 BOTAN_ARG_CHECK(mode.mode().is_available(), "Dilithium/ML-DSA mode is not available in this build");
324 BOTAN_ARG_CHECK(pk.empty() || pk.size() == mode.public_key_bytes(),
325 "dilithium public key does not have the correct byte count");
326
327 m_public = Dilithium_PublicKeyInternal::decode(std::move(mode), StrongSpan<const DilithiumSerializedPublicKey>(pk));
328}
#define BOTAN_ARG_CHECK(expr, msg)
Definition assert.h:29
static std::shared_ptr< Dilithium_PublicKeyInternal > decode(DilithiumConstants mode, StrongSpan< const DilithiumSerializedPublicKey > raw_pk)
std::shared_ptr< Dilithium_PublicKeyInternal > m_public
Definition dilithium.h:109

References BOTAN_ARG_CHECK, Botan::Dilithium_PublicKeyInternal::decode(), Botan::DilithiumMode::is_available(), m_public, Botan::DilithiumConstants::mode(), and Botan::DilithiumConstants::public_key_bytes().

◆ Dilithium_PublicKey() [3/3]

Botan::Dilithium_PublicKey::Dilithium_PublicKey ( )
protecteddefault

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

136{ return {}; }

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

◆ algo_name()

std::string Botan::Dilithium_PublicKey::algo_name ( ) const
overridevirtual

Get the name of the underlying public key scheme.

Returns
name of the public key scheme

Implements Botan::Asymmetric_Key.

Definition at line 330 of file dilithium.cpp.

330 {
331 // Note: For Dilithium we made the blunder to return the OID's human readable
332 // name, e.g. "Dilithium-4x4-AES". This is inconsistent with the other
333 // public key algorithms which return the generic name only.
334 //
335 // TODO(Botan4): Fix the inconsistency described above, also considering that
336 // there might be other code locations that identify Dilithium
337 // by std::string::starts_with("Dilithium-").
338 // (Above assumes that Dilithium won't be removed entirely!)
339 return (m_public->mode().is_ml_dsa()) ? std::string("ML-DSA") : object_identifier().to_formatted_string();
340}
OID object_identifier() const override

References m_public, object_identifier(), and Botan::OID::to_formatted_string().

Referenced by Botan::Dilithium_PrivateKey::create_signature_op(), create_verification_op(), and create_x509_verification_op().

◆ algorithm_identifier()

AlgorithmIdentifier Botan::Dilithium_PublicKey::algorithm_identifier ( ) const
overridevirtual
Returns
X.509 AlgorithmIdentifier for this key

Implements Botan::Public_Key.

Definition at line 342 of file dilithium.cpp.

342 {
343 return AlgorithmIdentifier(object_identifier(), AlgorithmIdentifier::USE_EMPTY_PARAM);
344}

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

Referenced by create_x509_verification_op().

◆ check_key()

bool Botan::Dilithium_PublicKey::check_key ( RandomNumberGenerator & ,
bool  ) const
overridevirtual

Implements Botan::Asymmetric_Key.

Definition at line 368 of file dilithium.cpp.

368 {
369 return true; // ???
370}

◆ 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}
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_Encryptor_EME::PK_Encryptor_EME().

◆ create_kem_encryption_op()

std::unique_ptr< PK_Ops::KEM_Encryption > Botan::Public_Key::create_kem_encryption_op ( std::string_view params,
std::string_view provider ) const
virtualinherited

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 in Botan::Classic_McEliece_PublicKey, Botan::FrodoKEM_PublicKey, Botan::Kyber_PublicKey, Botan::McEliece_PublicKey, Botan::RSA_PublicKey, Botan::TLS::Hybrid_KEM_PublicKey, and Botan::TLS::KEX_to_KEM_Adapter_PublicKey.

Definition at line 104 of file pk_keys.cpp.

105 {
106 throw Lookup_Error(fmt("{} does not support KEM encryption", algo_name()));
107}

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

Referenced by Botan::PK_KEM_Encryptor::PK_KEM_Encryptor().

◆ create_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Dilithium_PublicKey::create_verification_op ( 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 verification operation for this key/params or throw

Parameters
paramsadditional parameters
providerthe provider to use

Reimplemented from Botan::Public_Key.

Definition at line 376 of file dilithium.cpp.

377 {
378 BOTAN_ARG_CHECK(params.empty() || params == "Pure", "Unexpected parameters for verifying with Dilithium");
379 if(provider.empty() || provider == "base") {
380 return std::make_unique<Dilithium_Verification_Operation>(m_public);
381 }
382 throw Provider_Not_Found(algo_name(), provider);
383}
std::string algo_name() const override

References algo_name(), BOTAN_ARG_CHECK, and m_public.

◆ create_x509_verification_op()

std::unique_ptr< PK_Ops::Verification > Botan::Dilithium_PublicKey::create_x509_verification_op ( const AlgorithmIdentifier & signature_algorithm,
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 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 from Botan::Public_Key.

Definition at line 385 of file dilithium.cpp.

386 {
387 if(provider.empty() || provider == "base") {
388 if(alg_id != this->algorithm_identifier()) {
389 throw Decoding_Error("Unexpected AlgorithmIdentifier for Dilithium X.509 signature");
390 }
391 return std::make_unique<Dilithium_Verification_Operation>(m_public);
392 }
393 throw Provider_Not_Found(algo_name(), provider);
394}
AlgorithmIdentifier algorithm_identifier() const override

References algo_name(), algorithm_identifier(), and m_public.

◆ default_x509_signature_format()

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

Definition at line 227 of file pk_keys.h.

227 {
229 }
virtual Signature_Format _default_x509_signature_format() const
Definition pk_keys.cpp:30

◆ estimated_strength()

size_t Botan::Dilithium_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 354 of file dilithium.cpp.

354 {
355 return m_public->mode().lambda();
356}

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 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
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 Botan::Public_Key::subject_public_key().

◆ generate_another()

std::unique_ptr< Private_Key > Botan::Dilithium_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 372 of file dilithium.cpp.

372 {
373 return std::make_unique<Dilithium_PrivateKey>(rng, m_public->mode().mode());
374}

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.

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

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

◆ key_length()

size_t Botan::Dilithium_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 350 of file dilithium.cpp.

350 {
351 return m_public->mode().canonical_parameter_set_identifier();
352}

References m_public.

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

220 {
221 return _signature_element_size_for_DER_encoding().value_or(0);
222 }

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

207 {
209 }

◆ object_identifier()

OID Botan::Dilithium_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 346 of file dilithium.cpp.

346 {
347 return m_public->mode().mode().object_identifier();
348}

References m_public.

Referenced by algo_name(), and algorithm_identifier().

◆ operator=()

Dilithium_PublicKey & Botan::Dilithium_PublicKey::operator= ( const Dilithium_PublicKey & other)
default

◆ public_key_bits()

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

Implements Botan::Public_Key.

Definition at line 362 of file dilithium.cpp.

362 {
363 // Currently, there isn't a finalized definition of an ASN.1 structure for
364 // Dilithium aka ML-DSA public keys. Therefore, we return the raw public key bits.
365 return raw_public_key_bits();
366}
std::vector< uint8_t > raw_public_key_bits() const override

References raw_public_key_bits().

◆ raw_public_key_bits()

std::vector< uint8_t > Botan::Dilithium_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 358 of file dilithium.cpp.

358 {
359 return m_public->raw_pk().get();
360}

References 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 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 AlgorithmIdentifier algorithm_identifier() const =0
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::Dilithium_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 89 of file dilithium.h.

Friends And Related Symbol Documentation

◆ Dilithium_Signature_Operation

friend class Dilithium_Signature_Operation
friend

Definition at line 107 of file dilithium.h.

◆ Dilithium_Verification_Operation

friend class Dilithium_Verification_Operation
friend

Definition at line 106 of file dilithium.h.

Member Data Documentation

◆ m_public


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