Botan 3.5.0
Crypto and TLS for C&
|
#include <dilithium.h>
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::Decryption > | create_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const |
virtual std::unique_ptr< PK_Ops::Encryption > | create_encryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const |
virtual std::unique_ptr< PK_Ops::KEM_Decryption > | create_kem_decryption_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const |
virtual std::unique_ptr< PK_Ops::KEM_Encryption > | create_kem_encryption_op (std::string_view params, std::string_view provider) const |
virtual std::unique_ptr< PK_Ops::Key_Agreement > | create_key_agreement_op (RandomNumberGenerator &rng, std::string_view params, std::string_view provider) const |
std::unique_ptr< PK_Ops::Signature > | create_signature_op (RandomNumberGenerator &, std::string_view params, std::string_view provider) const override |
std::unique_ptr< PK_Ops::Verification > | create_verification_op (std::string_view params, std::string_view provider) const override |
std::unique_ptr< PK_Ops::Verification > | create_x509_verification_op (const AlgorithmIdentifier &signature_algorithm, std::string_view provider) const override |
virtual Signature_Format | default_x509_signature_format () const |
Dilithium_PrivateKey (const AlgorithmIdentifier &alg_id, std::span< const uint8_t > sk) | |
Dilithium_PrivateKey (RandomNumberGenerator &rng, DilithiumMode mode) | |
Dilithium_PrivateKey (std::span< const uint8_t > sk, DilithiumMode mode) | |
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_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 |
virtual size_t | message_part_size () const |
virtual size_t | message_parts () 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_Key > | public_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 |
Protected Attributes | |
std::shared_ptr< Dilithium_PublicKeyInternal > | m_public |
Friends | |
class | Dilithium_Signature_Operation |
Definition at line 103 of file dilithium.h.
Botan::Dilithium_PrivateKey::Dilithium_PrivateKey | ( | RandomNumberGenerator & | rng, |
DilithiumMode | mode ) |
Generates a new key pair
Definition at line 573 of file dilithium.cpp.
References BOTAN_ASSERT_NOMSG, Botan::DilithiumModeConstants::CRHBYTES, Botan::Dilithium::PolynomialVector::fill_polyvec_uniform_eta(), Botan::DilithiumModeConstants::H(), Botan::DilithiumModeConstants::k(), Botan::DilithiumModeConstants::l(), Botan::Dilithium_PublicKey::m_public, Botan::RandomNumberGenerator::random_vec(), Botan::rho(), and Botan::DilithiumModeConstants::SEEDBYTES.
Botan::Dilithium_PrivateKey::Dilithium_PrivateKey | ( | const AlgorithmIdentifier & | alg_id, |
std::span< const uint8_t > | sk ) |
Read an encoded private key.
Definition at line 609 of file dilithium.cpp.
Botan::Dilithium_PrivateKey::Dilithium_PrivateKey | ( | std::span< const uint8_t > | sk, |
DilithiumMode | mode ) |
Read an encoded private key given the dilithium mode
.
Definition at line 612 of file dilithium.cpp.
References BOTAN_ARG_CHECK, Botan::Dilithium_PublicKey::m_public, and Botan::DilithiumModeConstants::private_key_bytes().
|
overridevirtualinherited |
Get the name of the underlying public key scheme.
Implements Botan::Asymmetric_Key.
Definition at line 515 of file dilithium.cpp.
References Botan::Dilithium_PublicKey::object_identifier(), and Botan::OID::to_formatted_string().
Referenced by create_signature_op(), Botan::Dilithium_PublicKey::create_verification_op(), and Botan::Dilithium_PublicKey::create_x509_verification_op().
|
overridevirtualinherited |
Implements Botan::Public_Key.
Definition at line 519 of file dilithium.cpp.
References Botan::Dilithium_PublicKey::object_identifier(), and Botan::AlgorithmIdentifier::USE_EMPTY_PARAM.
Referenced by Botan::Dilithium_PublicKey::create_x509_verification_op().
|
overridevirtualinherited |
Implements Botan::Public_Key.
Definition at line 545 of file dilithium.cpp.
|
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
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_PrivateKey, Botan::RSA_PrivateKey, and Botan::SM2_PrivateKey.
Definition at line 111 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_Decryptor_EME::PK_Decryptor_EME().
|
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
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 90 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_Encryptor_EME::PK_Encryptor_EME().
|
virtualinherited |
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
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::FrodoKEM_PrivateKey, Botan::Kyber_PrivateKey, Botan::McEliece_PrivateKey, Botan::RSA_PrivateKey, Botan::TLS::Hybrid_KEM_PrivateKey, and Botan::TLS::KEX_to_KEM_Adapter_PrivateKey.
Definition at line 117 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_KEM_Decryptor::PK_KEM_Decryptor().
|
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
params | additional parameters |
provider | the provider to use |
Reimplemented in 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 96 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_KEM_Encryptor::PK_KEM_Encryptor().
|
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
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::DH_PrivateKey, Botan::ECDH_PrivateKey, Botan::X25519_PrivateKey, and Botan::X448_PrivateKey.
Definition at line 129 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_Key_Agreement::PK_Key_Agreement().
|
overridevirtual |
Create a signature operation that produces a Dilithium signature either with "Randomized" or "Deterministic" rhoprime. Pass either of those strings as params
. Default (i.e. empty params
is "Randomized").
Reimplemented from Botan::Private_Key.
Definition at line 628 of file dilithium.cpp.
References Botan::Dilithium_PublicKey::algo_name(), BOTAN_ARG_CHECK, and BOTAN_UNUSED.
|
overridevirtualinherited |
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
params | additional parameters |
provider | the provider to use |
Reimplemented from Botan::Public_Key.
Definition at line 553 of file dilithium.cpp.
References Botan::Dilithium_PublicKey::algo_name(), and BOTAN_ARG_CHECK.
|
overridevirtualinherited |
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.
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 from Botan::Public_Key.
Definition at line 562 of file dilithium.cpp.
References Botan::Dilithium_PublicKey::algo_name(), and Botan::Dilithium_PublicKey::algorithm_identifier().
|
inlinevirtualinherited |
Reimplemented in Botan::GOST_3410_PublicKey.
Definition at line 201 of file pk_keys.h.
Referenced by Botan::X509_Object::choose_sig_format(), and Botan::PK_Verifier::PK_Verifier().
|
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.
Implements Botan::Asymmetric_Key.
Definition at line 531 of file dilithium.cpp.
References Botan::Dilithium_PublicKey::m_public.
|
inherited |
Definition at line 86 of file pk_keys.cpp.
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().
|
inherited |
Definition at line 79 of file pk_keys.cpp.
References Botan::create_hex_fingerprint(), and Botan::Public_Key::subject_public_key().
|
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 549 of file dilithium.cpp.
References Botan::Dilithium_PublicKey::m_public.
|
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::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.
References Botan::Asymmetric_Key::algo_name().
Referenced by Botan::EC_PublicKey::get_int_field(), and Botan::RSA_PublicKey::get_int_field().
|
inlineinherited |
Deprecated version of object_identifier
Definition at line 132 of file pk_keys.h.
|
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 527 of file dilithium.cpp.
References Botan::Dilithium_PublicKey::m_public.
|
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.
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 199 of file pk_keys.h.
Referenced by Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), and Botan::PK_Verifier::PK_Verifier().
|
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.
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.
Referenced by Botan::PK_Signer::PK_Signer(), Botan::PK_Verifier::PK_Verifier(), and Botan::PK_Verifier::PK_Verifier().
|
overridevirtualinherited |
Get the OID of the underlying public key scheme.
Reimplemented from Botan::Asymmetric_Key.
Definition at line 523 of file dilithium.cpp.
References Botan::Dilithium_PublicKey::m_public.
Referenced by Botan::Dilithium_PublicKey::algo_name(), and Botan::Dilithium_PublicKey::algorithm_identifier().
|
inlinevirtualinherited |
Reimplemented in Botan::GOST_3410_PrivateKey, and Botan::HSS_LMS_PrivateKey.
Definition at line 296 of file pk_keys.h.
Referenced by Botan::Private_Key::private_key_info().
|
overridevirtual |
Implements Botan::Private_Key.
Definition at line 624 of file dilithium.cpp.
Referenced by raw_private_key_bits().
|
inherited |
Definition at line 60 of file pk_keys.cpp.
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().
|
overridevirtual |
Allocate a new object for the public key associated with this private key.
Implements Botan::Private_Key.
Definition at line 643 of file dilithium.cpp.
|
overridevirtualinherited |
Implements Botan::Public_Key.
Definition at line 539 of file dilithium.cpp.
References Botan::Dilithium_PublicKey::raw_public_key_bits().
|
overridevirtual |
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 620 of file dilithium.cpp.
References private_key_bits().
|
overridevirtualinherited |
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 535 of file dilithium.cpp.
References Botan::Dilithium_PublicKey::m_public.
Referenced by Botan::Dilithium_PublicKey::public_key_bits().
|
inlinevirtualinherited |
Retrieves the number of remaining operations if this is a stateful private key.
Reimplemented in Botan::HSS_LMS_PrivateKey, and Botan::XMSS_PrivateKey.
Definition at line 309 of file pk_keys.h.
|
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 302 of file pk_keys.h.
|
inherited |
Definition at line 48 of file pk_keys.cpp.
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().
|
inlineoverridevirtualinherited |
Return true if this key could be used for the specified type of operation.
Implements Botan::Asymmetric_Key.
Definition at line 77 of file dilithium.h.
|
friend |
Definition at line 137 of file dilithium.h.
|
protectedinherited |
Definition at line 97 of file dilithium.h.
Referenced by Dilithium_PrivateKey(), Dilithium_PrivateKey(), Botan::Dilithium_PublicKey::Dilithium_PublicKey(), Botan::Dilithium_PublicKey::estimated_strength(), Botan::Dilithium_PublicKey::generate_another(), Botan::Dilithium_PublicKey::key_length(), Botan::Dilithium_PublicKey::object_identifier(), and Botan::Dilithium_PublicKey::raw_public_key_bits().