Botan 3.9.0
Crypto and TLS for C&
|
#include <mceliece.h>
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::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 |
std::unique_ptr< Private_Key > | generate_another (RandomNumberGenerator &rng) const final |
size_t | get_code_length () const |
virtual const BigInt & | get_int_field (std::string_view field) const |
size_t | get_message_word_bit_length () const |
OID | get_oid () const |
const std::vector< uint8_t > & | get_public_matrix () const |
size_t | get_t () const |
size_t | key_length () const override |
McEliece_PublicKey (const McEliece_PublicKey &other)=default | |
McEliece_PublicKey (const std::vector< uint8_t > &pub_matrix, size_t t, size_t the_code_length) | |
McEliece_PublicKey (std::span< const uint8_t > key_bits) | |
size_t | message_part_size () const |
size_t | message_parts () const |
virtual OID | object_identifier () const |
bool | operator!= (const McEliece_PublicKey &other) const |
McEliece_PublicKey & | operator= (const McEliece_PublicKey &other)=default |
bool | operator== (const McEliece_PublicKey &other) const |
std::vector< uint8_t > | public_key_bits () const override |
secure_vector< uint8_t > | random_plaintext_element (RandomNumberGenerator &rng) const |
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 |
~McEliece_PublicKey () override=default |
Protected Member Functions | |
McEliece_PublicKey () |
Protected Attributes | |
size_t | m_code_length |
std::vector< uint8_t > | m_public_matrix |
size_t | m_t |
Definition at line 25 of file mceliece.h.
|
explicit |
Definition at line 106 of file mceliece_key.cpp.
References m_code_length, m_public_matrix, m_t, and Botan::OctetString.
Referenced by Botan::McEliece_PrivateKey::McEliece_PrivateKey(), McEliece_PublicKey(), operator!=(), operator=(), Botan::McEliece_PrivateKey::operator==(), and operator==().
|
inline |
|
default |
References McEliece_PublicKey().
|
overridedefault |
References random_plaintext_element().
|
inlineprotected |
|
virtualinherited |
Reimplemented in Botan::GOST_3410_PublicKey.
Definition at line 30 of file pk_keys.cpp.
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().
|
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 137 of file pk_keys.h.
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().
|
inlineoverridevirtual |
Get the name of the underlying public key scheme.
Implements Botan::Asymmetric_Key.
Definition at line 38 of file mceliece.h.
Referenced by Botan::McEliece_PrivateKey::create_kem_decryption_op(), and create_kem_encryption_op().
|
overridevirtual |
Implements Botan::Public_Key.
Definition at line 77 of file mceliece_key.cpp.
References Botan::Asymmetric_Key::object_identifier(), and Botan::AlgorithmIdentifier::USE_EMPTY_PARAM.
|
inlineoverridevirtual |
|
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, Botan::SM2_PublicKey, and Botan::TPM2::RSA_PublicKey.
Definition at line 98 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_Encryptor_EME::PK_Encryptor_EME().
|
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
params | additional parameters |
provider | the provider to use |
Reimplemented from Botan::Public_Key.
Definition at line 356 of file mceliece_key.cpp.
References algo_name().
|
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
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 109 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_Verifier::PK_Verifier().
|
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.
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 114 of file pk_keys.cpp.
References Botan::Asymmetric_Key::algo_name(), and Botan::fmt().
Referenced by Botan::PK_Verifier::PK_Verifier().
|
inlineinherited |
Definition at line 229 of file pk_keys.h.
References Botan::Asymmetric_Key::_default_x509_signature_format(), and default_x509_signature_format().
Referenced by default_x509_signature_format().
|
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.
Implements Botan::Asymmetric_Key.
Definition at line 102 of file mceliece_key.cpp.
References m_code_length, m_t, and Botan::mceliece_work_factor().
|
inherited |
Definition at line 87 of file pk_keys.cpp.
References Botan::create_hex_fingerprint(), and subject_public_key().
Referenced by public_key_bits().
|
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 352 of file mceliece_key.cpp.
References get_code_length(), and get_t().
|
inline |
Definition at line 52 of file mceliece.h.
References m_code_length.
Referenced by generate_another(), Botan::mceliece_decrypt(), Botan::mceliece_decrypt(), Botan::mceliece_encrypt(), Botan::McEliece_PrivateKey::private_key_bits(), Botan::McEliece_PrivateKey::public_key(), and public_key_bits().
|
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.
References algo_name().
Referenced by estimated_strength(), Botan::EC_PublicKey::get_int_field(), and Botan::RSA_PublicKey::get_int_field().
size_t Botan::McEliece_PublicKey::get_message_word_bit_length | ( | ) | const |
Definition at line 57 of file mceliece_key.cpp.
References Botan::ceil_log2(), m_code_length, and m_t.
Referenced by Botan::mceliece_decrypt(), and random_plaintext_element().
|
inlineinherited |
Deprecated version of object_identifier
Definition at line 161 of file pk_keys.h.
References get_oid(), and Botan::Asymmetric_Key::object_identifier().
Referenced by get_oid().
|
inline |
Definition at line 56 of file mceliece.h.
References m_public_matrix.
Referenced by Botan::mceliece_encrypt(), and Botan::McEliece_PrivateKey::public_key().
|
inline |
Definition at line 50 of file mceliece.h.
References m_t.
Referenced by generate_another(), Botan::mceliece_encrypt(), Botan::McEliece_PrivateKey::private_key_bits(), Botan::McEliece_PrivateKey::public_key(), and public_key_bits().
|
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 98 of file mceliece_key.cpp.
References m_code_length.
|
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.
Definition at line 221 of file pk_keys.h.
References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_part_size().
Referenced by message_part_size().
|
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.
Definition at line 208 of file pk_keys.h.
References Botan::Asymmetric_Key::_signature_element_size_for_DER_encoding(), and message_parts().
Referenced by message_parts().
|
virtualinherited |
Get the OID of the underlying public key scheme.
Reimplemented in Botan::Classic_McEliece_PublicKey, Botan::Dilithium_PublicKey, Botan::FrodoKEM_PublicKey, Botan::HSS_LMS_PublicKey, Botan::Kyber_PublicKey, and Botan::SphincsPlus_PublicKey.
Definition at line 22 of file pk_keys.cpp.
References algo_name(), Botan::fmt(), and Botan::OID::from_string().
Referenced by Botan::DH_PublicKey::algorithm_identifier(), Botan::DSA_PublicKey::algorithm_identifier(), Botan::EC_PublicKey::algorithm_identifier(), Botan::Ed25519_PublicKey::algorithm_identifier(), Botan::Ed448_PublicKey::algorithm_identifier(), Botan::ElGamal_PublicKey::algorithm_identifier(), Botan::GOST_3410_PublicKey::algorithm_identifier(), Botan::McEliece_PublicKey::algorithm_identifier(), Botan::RSA_PublicKey::algorithm_identifier(), Botan::TPM_PrivateKey::algorithm_identifier(), Botan::X25519_PublicKey::algorithm_identifier(), Botan::X448_PublicKey::algorithm_identifier(), Botan::XMSS_PublicKey::algorithm_identifier(), estimated_strength(), and Botan::Public_Key::get_oid().
|
inline |
Definition at line 60 of file mceliece.h.
References McEliece_PublicKey().
|
default |
References McEliece_PublicKey().
bool Botan::McEliece_PublicKey::operator== | ( | const McEliece_PublicKey & | other | ) | const |
Definition at line 270 of file mceliece_key.cpp.
References m_code_length, m_public_matrix, m_t, and McEliece_PublicKey().
|
overridevirtual |
Implements Botan::Public_Key.
Definition at line 85 of file mceliece_key.cpp.
References Botan::DER_Encoder::encode(), Botan::DER_Encoder::end_cons(), get_code_length(), get_t(), m_public_matrix, Botan::OctetString, and Botan::DER_Encoder::start_sequence().
secure_vector< uint8_t > Botan::McEliece_PublicKey::random_plaintext_element | ( | RandomNumberGenerator & | rng | ) | const |
Definition at line 62 of file mceliece_key.cpp.
References get_message_word_bit_length(), and Botan::RandomNumberGenerator::randomize().
Referenced by Botan::McEliece_PrivateKey::check_key(), and ~McEliece_PublicKey().
|
overridevirtual |
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 81 of file mceliece_key.cpp.
References m_public_matrix.
|
inherited |
Definition at line 56 of file pk_keys.cpp.
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().
|
inlineoverridevirtual |
Return true if this key could be used for the specified type of operation.
Implements Botan::Asymmetric_Key.
Definition at line 64 of file mceliece.h.
References Botan::KeyEncapsulation.
|
protected |
Definition at line 76 of file mceliece.h.
Referenced by estimated_strength(), get_code_length(), get_message_word_bit_length(), key_length(), Botan::McEliece_PrivateKey::McEliece_PrivateKey(), McEliece_PublicKey(), McEliece_PublicKey(), McEliece_PublicKey(), and operator==().
|
protected |
Definition at line 74 of file mceliece.h.
Referenced by get_public_matrix(), Botan::McEliece_PrivateKey::McEliece_PrivateKey(), McEliece_PublicKey(), McEliece_PublicKey(), operator==(), Botan::McEliece_PrivateKey::private_key_bits(), public_key_bits(), and raw_public_key_bits().
|
protected |
Definition at line 75 of file mceliece.h.
Referenced by estimated_strength(), get_message_word_bit_length(), get_t(), Botan::McEliece_PrivateKey::McEliece_PrivateKey(), McEliece_PublicKey(), McEliece_PublicKey(), McEliece_PublicKey(), and operator==().