Botan::PK_Encryptor_EME Class Reference

#include <pubkey.h>

Inheritance diagram for Botan::PK_Encryptor_EME:

Public Member Functions
size_t	ciphertext_length (size_t ptext_len) const override
std::vector< uint8_t >	encrypt (const uint8_t in[], size_t length, RandomNumberGenerator &rng) const
std::vector< uint8_t >	encrypt (std::span< const uint8_t > in, RandomNumberGenerator &rng) const
size_t	maximum_input_size () const override
PK_Encryptor_EME &	operator= (const PK_Encryptor_EME &)=delete
PK_Encryptor_EME &	operator= (PK_Encryptor_EME &&) noexcept
	PK_Encryptor_EME (const PK_Encryptor_EME &)=delete
	PK_Encryptor_EME (const Public_Key &key, RandomNumberGenerator &rng, std::string_view padding, std::string_view provider="")
	PK_Encryptor_EME (PK_Encryptor_EME &&) noexcept
	~PK_Encryptor_EME () override

Detailed Description

Encryption using a standard message recovery algorithm like RSA or ElGamal, paired with an encoding scheme like OAEP.

Definition at line 476 of file pubkey.h.

Constructor & Destructor Documentation

PK_Encryptor_EME() [1/3]

Botan::PK_Encryptor_EME::PK_Encryptor_EME	(	const Public_Key &	key,
		RandomNumberGenerator &	rng,
		std::string_view	padding,
		std::string_view	provider = "" )

Construct an instance.

Parameters

key	the key to use inside the encryptor
rng	the RNG to use
padding	the message encoding scheme to use (eg "OAEP(SHA-256)")
provider	the provider to use

Definition at line 87 of file pubkey.cpp.

                                                            {
   m_op = key.create_encryption_op(rng, padding, provider);
   if(!m_op) {
      throw Invalid_Argument(fmt("Key type {} does not support encryption", key.algo_name()));
   }
}

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

~PK_Encryptor_EME()

Botan::PK_Encryptor_EME::~PK_Encryptor_EME ( )

overridedefault

PK_Encryptor_EME() [2/3]

Botan::PK_Encryptor_EME::PK_Encryptor_EME ( const PK_Encryptor_EME & )

delete

PK_Encryptor_EME() [3/3]

Botan::PK_Encryptor_EME::PK_Encryptor_EME ( PK_Encryptor_EME && )

defaultnoexcept

Member Function Documentation

ciphertext_length()

size_t Botan::PK_Encryptor_EME::ciphertext_length ( size_t ptext_len ) const

overridevirtual

Return an upper bound on the ciphertext length for a particular plaintext input length

Implements Botan::PK_Encryptor.

Definition at line 102 of file pubkey.cpp.

                                                                 {
   return m_op->ciphertext_length(ptext_len);
}

References ciphertext_length().

Referenced by ciphertext_length().

encrypt() [1/2]

std::vector< uint8_t > Botan::PK_Encryptor::encrypt ( const uint8_t in[], size_t length, RandomNumberGenerator & rng ) const

inlineinherited

Encrypt a message.

Parameters

in	the message as a byte array
length	the length of the above byte array
rng	the random number source to use

Returns

encrypted message

Definition at line 37 of file pubkey.h.

                                                                                                      {
         return enc(in, length, rng);
      }

Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), and Botan::KeyPair::encryption_consistency_check().

encrypt() [2/2]

std::vector< uint8_t > Botan::PK_Encryptor::encrypt ( std::span< const uint8_t > in, RandomNumberGenerator & rng ) const

inlineinherited

Encrypt a message.

Parameters

in	the message
rng	the random number source to use

Returns

encrypted message

Definition at line 47 of file pubkey.h.

                                                                                              {
         return enc(in.data(), in.size(), rng);
      }

maximum_input_size()

size_t Botan::PK_Encryptor_EME::maximum_input_size ( ) const

overridevirtual

Return the maximum allowed message size in bytes.

Returns

maximum message size in bytes

Implements Botan::PK_Encryptor.

Definition at line 110 of file pubkey.cpp.

                                                  {
   return m_op->max_input_bits() / 8;
}

Referenced by Botan::KeyPair::encryption_consistency_check().

operator=() [1/2]

PK_Encryptor_EME & Botan::PK_Encryptor_EME::operator= ( const PK_Encryptor_EME & )

delete

operator=() [2/2]

PK_Encryptor_EME & Botan::PK_Encryptor_EME::operator= ( PK_Encryptor_EME && )

defaultnoexcept

---

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

• src/lib/pubkey/pubkey.h
• src/lib/pubkey/pubkey.cpp