Botan 3.14.1
Crypto and TLS for C&
Botan::EncryptionPaddingScheme Class Referenceabstract

#include <enc_padding.h>

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

Public Member Functions

virtual size_t maximum_input_size (size_t keybits) const =0
virtual size_t pad (std::span< uint8_t > output, std::span< const uint8_t > input, size_t key_length, RandomNumberGenerator &rng) const =0
virtual CT::Option< size_t > unpad (std::span< uint8_t > output, std::span< const uint8_t > input) const =0
virtual ~EncryptionPaddingScheme ()

Static Public Member Functions

static std::unique_ptr< EncryptionPaddingScheme > create_or_throw (const PK_Encryption_Options_Reader &options)

Detailed Description

Encoding Method for Encryption

Definition at line 24 of file enc_padding.h.

Constructor & Destructor Documentation

◆ ~EncryptionPaddingScheme()

Botan::EncryptionPaddingScheme::~EncryptionPaddingScheme ( )
virtualdefault

References create_or_throw().

Member Function Documentation

◆ create_or_throw()

std::unique_ptr< EncryptionPaddingScheme > Botan::EncryptionPaddingScheme::create_or_throw ( const PK_Encryption_Options_Reader & options)
static

Factory method for encryption padding schemes

Parameters
optionsthe padding scheme and its parameters
Returns
pointer to newly allocated object of that type, or throws

Definition at line 26 of file enc_padding.cpp.

27 {
28 // Encrypting without padding is dangerous, so it must be requested explicitly
29 if(!options.using_padding()) {
30 throw Lookup_Error("Public key encryption requires specifying a padding scheme");
31 }
32
33 const std::string& padding = options.padding().value();
34
35 // Any option not examined by the selected scheme is rejected by the caller
36
37#if defined(BOTAN_HAS_EME_RAW)
38 if(padding == "Raw") {
39 return std::make_unique<EME_Raw>();
40 }
41#endif
42
43#if defined(BOTAN_HAS_EME_PKCS1)
44 if(padding == "PKCS1v15") {
45 return std::make_unique<EME_PKCS1v15>();
46 }
47#endif
48
49#if defined(BOTAN_HAS_EME_OAEP)
50 if(padding == "OAEP") {
51 return std::make_unique<OAEP>(options);
52 }
53#endif
54
55 throw Lookup_Error("Invalid or unavailable encryption padding scheme " + options.to_string());
56}

References Botan::PK_Encryption_Options_Reader::padding(), Botan::PK_Encryption_Options_Reader::to_string(), and Botan::PK_Encryption_Options_Reader::using_padding().

Referenced by ~EncryptionPaddingScheme().

◆ maximum_input_size()

virtual size_t Botan::EncryptionPaddingScheme::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::OAEP.

◆ pad()

virtual size_t Botan::EncryptionPaddingScheme::pad ( std::span< uint8_t > output,
std::span< const uint8_t > input,
size_t key_length,
RandomNumberGenerator & rng ) const
pure virtual

Encode an input

Parameters
outputbuffer that is written to
inputthe plaintext
key_lengthlength of the key in bits
Random Number Generatorsa random number generator
Returns
number of bytes written to output

◆ unpad()

virtual CT::Option< size_t > Botan::EncryptionPaddingScheme::unpad ( std::span< uint8_t > output,
std::span< const uint8_t > input ) const
pure virtual

Decode an input

Parameters
outputbuffer where output is placed
inputthe encoded plaintext
Returns
number of bytes written to output if valid, or an empty option if invalid. If an empty option is returned the contents of output are undefined

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