Botan 3.0.0-alpha0
Crypto and TLS for C&
Public Member Functions | Static Public Member Functions | List of all members
Botan::EME Class Referenceabstract

#include <eme.h>

Inheritance diagram for Botan::EME:
Botan::EME_PKCS1v15 Botan::EME_Raw Botan::OAEP

Public Member Functions

secure_vector< uint8_t > encode (const secure_vector< uint8_t > &in, size_t key_length, RandomNumberGenerator &rng) const
 
secure_vector< uint8_t > encode (const uint8_t in[], size_t in_length, size_t key_length, RandomNumberGenerator &rng) const
 
virtual size_t maximum_input_size (size_t keybits) const =0
 
virtual secure_vector< uint8_t > pad (const uint8_t in[], size_t in_length, size_t key_length, RandomNumberGenerator &rng) const =0
 
virtual secure_vector< uint8_t > unpad (uint8_t &valid_mask, const uint8_t in[], size_t in_len) const =0
 
virtual ~EME ()=default
 

Static Public Member Functions

static std::unique_ptr< EMEcreate (const std::string &algo_spec)
 

Detailed Description

Encoding Method for Encryption

Definition at line 21 of file eme.h.

Constructor & Destructor Documentation

◆ ~EME()

virtual Botan::EME::~EME ( )
virtualdefault

Member Function Documentation

◆ create()

std::unique_ptr< EME > Botan::EME::create ( const std::string &  algo_spec)
static

Factory method for EME (message-encoding methods for encryption) objects

Parameters
algo_specthe name of the EME to create
Returns
pointer to newly allocated object of that type

Definition at line 27 of file eme.cpp.

28 {
29#if defined(BOTAN_HAS_EME_RAW)
30 if(algo_spec == "Raw")
31 return std::make_unique<EME_Raw>();
32#endif
33
34#if defined(BOTAN_HAS_EME_PKCS1)
35 if(algo_spec == "PKCS1v15" || algo_spec == "EME-PKCS1-v1_5")
36 return std::make_unique<EME_PKCS1v15>();
37#endif
38
39#if defined(BOTAN_HAS_EME_OAEP)
40 SCAN_Name req(algo_spec);
41
42 if(req.algo_name() == "OAEP" ||
43 req.algo_name() == "EME-OAEP" ||
44 req.algo_name() == "EME1")
45 {
46 if(req.arg_count() == 1 ||
47 ((req.arg_count() == 2 || req.arg_count() == 3) && req.arg(1) == "MGF1"))
48 {
49 if(auto hash = HashFunction::create(req.arg(0)))
50 return std::make_unique<OAEP>(std::move(hash), req.arg(2, ""));
51 }
52 else if(req.arg_count() == 2 || req.arg_count() == 3)
53 {
54 auto mgf_params = parse_algorithm_name(req.arg(1));
55
56 if(mgf_params.size() == 2 && mgf_params[0] == "MGF1")
57 {
58 auto hash = HashFunction::create(req.arg(0));
59 auto mgf1_hash = HashFunction::create(mgf_params[1]);
60
61 if(hash && mgf1_hash)
62 {
63 return std::make_unique<OAEP>(std::move(hash),
64 std::move(mgf1_hash),
65 req.arg(2, ""));
66 }
67 }
68 }
69 }
70#endif
71
72 throw Algorithm_Not_Found(algo_spec);
73 }
static std::unique_ptr< HashFunction > create(const std::string &algo_spec, const std::string &provider="")
Definition: hash.cpp:98
std::vector< std::string > parse_algorithm_name(const std::string &namex)
Definition: parsing.cpp:58
MechanismType hash

References Botan::SCAN_Name::algo_name(), Botan::SCAN_Name::arg(), Botan::SCAN_Name::arg_count(), Botan::HashFunction::create(), hash, and Botan::parse_algorithm_name().

◆ encode() [1/2]

secure_vector< uint8_t > Botan::EME::encode ( const secure_vector< uint8_t > &  in,
size_t  key_length,
RandomNumberGenerator rng 
) const

Encode an input

Parameters
inthe plaintext
key_lengthlength of the key in bits
rnga random number generator
Returns
encoded plaintext

Definition at line 88 of file eme.cpp.

91 {
92 return pad(msg.data(), msg.size(), key_bits, rng);
93 }
virtual secure_vector< uint8_t > pad(const uint8_t in[], size_t in_length, size_t key_length, RandomNumberGenerator &rng) const =0

References pad().

◆ encode() [2/2]

secure_vector< uint8_t > Botan::EME::encode ( const uint8_t  in[],
size_t  in_length,
size_t  key_length,
RandomNumberGenerator rng 
) const

Encode an input

Parameters
inthe plaintext
in_lengthlength of plaintext in bytes
key_lengthlength of the key in bits
rnga random number generator
Returns
encoded plaintext

Definition at line 78 of file eme.cpp.

81 {
82 return pad(msg, msg_len, key_bits, rng);
83 }

References pad().

◆ maximum_input_size()

virtual size_t Botan::EME::maximum_input_size ( size_t  keybits) const
pure virtual

Return the maximum input size in bytes we can support

Parameters
keybitsthe size of the key in bits
Returns
upper bound of input in bytes

Implemented in Botan::EME_Raw, Botan::OAEP, and Botan::EME_PKCS1v15.

◆ pad()

virtual secure_vector< uint8_t > Botan::EME::pad ( const uint8_t  in[],
size_t  in_length,
size_t  key_length,
RandomNumberGenerator rng 
) const
pure virtual

Encode an input

Parameters
inthe plaintext
in_lengthlength of plaintext in bytes
key_lengthlength of the key in bits
rnga random number generator
Returns
encoded plaintext

Implemented in Botan::EME_PKCS1v15.

Referenced by encode().

◆ unpad()

virtual secure_vector< uint8_t > Botan::EME::unpad ( uint8_t &  valid_mask,
const uint8_t  in[],
size_t  in_len 
) const
pure virtual

Decode an input

Parameters
valid_maskwritten to specifies if output is valid
inthe encoded plaintext
in_lenlength of encoded plaintext in bytes
Returns
bytes of out[] written to along with validity mask (0xFF if valid, else 0x00)

Implemented in Botan::EME_PKCS1v15.


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