Botan::ECIES_Encryptor Class Reference

#include <ecies.h>

Inheritance diagram for Botan::ECIES_Encryptor:

Public Member Functions
	ECIES_Encryptor (const PK_Key_Agreement_Key &private_key, const ECIES_System_Params &ecies_params, RandomNumberGenerator &rng)
	ECIES_Encryptor (RandomNumberGenerator &rng, const ECIES_System_Params &ecies_params)
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
void	set_initialization_vector (const InitializationVector &iv)
	Set the initialization vector for the data encryption method.
void	set_label (std::string_view label)
	Set the label which is appended to the input for the message authentication code.
void	set_other_key (const EC_AffinePoint &pt)
	Set the public key of the other party.

Detailed Description

ECIES Encryption according to ISO 18033-2

Definition at line 215 of file ecies.h.

Constructor & Destructor Documentation

ECIES_Encryptor() [1/2]

Botan::ECIES_Encryptor::ECIES_Encryptor	(	const PK_Key_Agreement_Key &	private_key,
		const ECIES_System_Params &	ecies_params,
		RandomNumberGenerator &	rng )

Parameters

private_key	the (ephemeral) private key which is used for the key agreement
ecies_params	settings for ecies
rng	random generator to use

Definition at line 260 of file ecies.cpp.

                                                             :
      m_ka(private_key, ecies_params, true, rng),
      m_params(ecies_params),
      m_eph_public_key_bin(private_key.public_value()),  // returns the uncompressed public key, see conversion below
      m_iv(),
      m_other_point(),
      m_label() {
   if(ecies_params.compression_type() != EC_Point_Format::Uncompressed) {
      // ISO 18033: step d
      // convert only if necessary; m_eph_public_key_bin has been initialized with the uncompressed format
      m_eph_public_key_bin =
         EC_AffinePoint(m_params.domain(), m_eph_public_key_bin).serialize(ecies_params.compression_type());
   }
   m_mac = m_params.create_mac();
   m_cipher = m_params.create_cipher(Cipher_Dir::Encryption);
}

References Botan::ECIES_KA_Params::compression_type(), Botan::ECIES_System_Params::create_cipher(), Botan::ECIES_System_Params::create_mac(), Botan::Encryption, and Botan::Uncompressed.

ECIES_Encryptor() [2/2]

Botan::ECIES_Encryptor::ECIES_Encryptor	(	RandomNumberGenerator &	rng,
		const ECIES_System_Params &	ecies_params )

Creates an ephemeral private key which is used for the key agreement

Parameters

rng	random generator used during private key generation
ecies_params	settings for ecies

Definition at line 282 of file ecies.cpp.

                                                                                                    :
      ECIES_Encryptor(ECDH_PrivateKey(rng, ecies_params.domain()), ecies_params, rng) {}

Member Function Documentation

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);
      }

set_initialization_vector()

void Botan::ECIES_Encryptor::set_initialization_vector ( const InitializationVector & iv )

inline

Set the initialization vector for the data encryption method.

Definition at line 244 of file ecies.h.

{ m_iv = iv; }

set_label()

void Botan::ECIES_Encryptor::set_label ( std::string_view label )

inline

Set the label which is appended to the input for the message authentication code.

Definition at line 247 of file ecies.h.

{ m_label.assign(label.begin(), label.end()); }

set_other_key()

void Botan::ECIES_Encryptor::set_other_key ( const EC_AffinePoint & pt )

inline

Set the public key of the other party.

Definition at line 241 of file ecies.h.

{ m_other_point = pt; }

---

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

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