Botan::PK_KEM_Encryptor Class Reference

#include <pubkey.h>

Public Member Functions
void	encrypt (secure_vector< uint8_t > &out_encapsulated_key, secure_vector< uint8_t > &out_shared_key, size_t desired_shared_key_len, Botan::RandomNumberGenerator &rng)
template<typename Alloc >
void	encrypt (secure_vector< uint8_t > &out_encapsulated_key, secure_vector< uint8_t > &out_shared_key, size_t desired_shared_key_len, Botan::RandomNumberGenerator &rng, const std::vector< uint8_t, Alloc > &salt)
void	encrypt (secure_vector< uint8_t > &out_encapsulated_key, secure_vector< uint8_t > &out_shared_key, size_t desired_shared_key_len, Botan::RandomNumberGenerator &rng, const uint8_t salt[], size_t salt_len)
PK_KEM_Encryptor &	operator= (const PK_KEM_Encryptor &)=delete
PK_KEM_Encryptor &	operator= (PK_KEM_Encryptor &&)=delete
	PK_KEM_Encryptor (const PK_KEM_Encryptor &)=delete
	PK_KEM_Encryptor (const Public_Key &key, RandomNumberGenerator &rng, const std::string &kem_param="", const std::string &provider="")
	PK_KEM_Encryptor (PK_KEM_Encryptor &&)=delete
	~PK_KEM_Encryptor ()

Detailed Description

Public Key Key Encapsulation Mechanism Encryption.

Definition at line 572 of file pubkey.h.

Constructor & Destructor Documentation

PK_KEM_Encryptor() [1/3]

Botan::PK_KEM_Encryptor::PK_KEM_Encryptor	(	const Public_Key &	key,
		RandomNumberGenerator &	rng,
		const std::string &	kem_param = "",
		const std::string &	provider = ""
	)

Construct an instance.

Parameters

key	the key to use inside the encryptor
rng	the RNG to use
kem_param	additional KEM parameters
provider	the provider to use

Definition at line 138 of file pubkey.cpp.

   {
   m_op = key.create_kem_encryption_op(rng, param, provider);
   if(!m_op)
      throw Invalid_Argument("Key type " + key.algo_name() + " does not support KEM encryption");
   }

References Botan::Public_Key::algo_name(), and Botan::Public_Key::create_kem_encryption_op().

~PK_KEM_Encryptor()

Botan::PK_KEM_Encryptor::~PK_KEM_Encryptor ( )

default

PK_KEM_Encryptor() [2/3]

Botan::PK_KEM_Encryptor::PK_KEM_Encryptor ( const PK_KEM_Encryptor &  )

delete

PK_KEM_Encryptor() [3/3]

Botan::PK_KEM_Encryptor::PK_KEM_Encryptor ( PK_KEM_Encryptor &&  )

delete

Member Function Documentation

encrypt() [1/3]

void Botan::PK_KEM_Encryptor::encrypt ( secure_vector< uint8_t > &  out_encapsulated_key, secure_vector< uint8_t > &  out_shared_key, size_t  desired_shared_key_len, Botan::RandomNumberGenerator &  rng  )

inline

Generate a shared key for data encryption.

Parameters

out_encapsulated_key	the generated encapsulated key
out_shared_key	the generated shared key
desired_shared_key_len	desired size of the shared key in bytes
rng	the RNG to use

Definition at line 640 of file pubkey.h.

         {
         this->encrypt(out_encapsulated_key,
                       out_shared_key,
                       desired_shared_key_len,
                       rng,
                       nullptr,
                       0);
         }

References Botan::CryptoBox::encrypt().

encrypt() [2/3]

template<typename Alloc >

void Botan::PK_KEM_Encryptor::encrypt ( secure_vector< uint8_t > &  out_encapsulated_key, secure_vector< uint8_t > &  out_shared_key, size_t  desired_shared_key_len, Botan::RandomNumberGenerator &  rng, const std::vector< uint8_t, Alloc > &  salt  )

inline

Generate a shared key for data encryption.

Parameters

out_encapsulated_key	the generated encapsulated key
out_shared_key	the generated shared key
desired_shared_key_len	desired size of the shared key in bytes
rng	the RNG to use
salt	a salt value used in the KDF

Definition at line 619 of file pubkey.h.

         {
         this->encrypt(out_encapsulated_key,
                       out_shared_key,
                       desired_shared_key_len,
                       rng,
                       salt.data(), salt.size());
         }

References Botan::CryptoBox::encrypt().

encrypt() [3/3]

void Botan::PK_KEM_Encryptor::encrypt	(	secure_vector< uint8_t > &	out_encapsulated_key,
		secure_vector< uint8_t > &	out_shared_key,
		size_t	desired_shared_key_len,
		Botan::RandomNumberGenerator &	rng,
		const uint8_t	salt[],
		size_t	salt_len
	)

Generate a shared key for data encryption.

Parameters

out_encapsulated_key	the generated encapsulated key
out_shared_key	the generated shared key
desired_shared_key_len	desired size of the shared key in bytes
rng	the RNG to use
salt	a salt value used in the KDF
salt_len	size of the salt value in bytes

Definition at line 150 of file pubkey.cpp.

   {
   m_op->kem_encrypt(out_encapsulated_key,
                     out_shared_key,
                     desired_shared_key_len,
                     rng,
                     salt,
                     salt_len);
   }

References salt_len.

operator=() [1/2]

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

delete

operator=() [2/2]

PK_KEM_Encryptor & Botan::PK_KEM_Encryptor::operator= ( PK_KEM_Encryptor &&  )

delete

---

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

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