Botan::PK_KEM_Decryptor Class Reference

#include <pubkey.h>

Public Member Functions
template<typename Alloc1 , typename Alloc2 >
secure_vector< uint8_t >	decrypt (const std::vector< uint8_t, Alloc1 > &encap_key, size_t desired_shared_key_len, const std::vector< uint8_t, Alloc2 > &salt)
secure_vector< uint8_t >	decrypt (const uint8_t encap_key[], size_t encap_key_len, size_t desired_shared_key_len)
secure_vector< uint8_t >	decrypt (const uint8_t encap_key[], size_t encap_key_len, size_t desired_shared_key_len, const uint8_t salt[], size_t salt_len)
PK_KEM_Decryptor &	operator= (const PK_KEM_Decryptor &)=delete
PK_KEM_Decryptor &	operator= (PK_KEM_Decryptor &&)=delete
	PK_KEM_Decryptor (const PK_KEM_Decryptor &)=delete
	PK_KEM_Decryptor (const Private_Key &key, RandomNumberGenerator &rng, const std::string &kem_param="", const std::string &provider="")
	PK_KEM_Decryptor (PK_KEM_Decryptor &&)=delete
	~PK_KEM_Decryptor ()

Detailed Description

Public Key Key Encapsulation Mechanism Decryption.

Definition at line 660 of file pubkey.h.

Constructor & Destructor Documentation

PK_KEM_Decryptor() [1/3]

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

Construct an instance.

Parameters

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

Definition at line 165 of file pubkey.cpp.

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

References Botan::Public_Key::algo_name(), and Botan::Private_Key::create_kem_decryption_op().

~PK_KEM_Decryptor()

Botan::PK_KEM_Decryptor::~PK_KEM_Decryptor ( )

default

PK_KEM_Decryptor() [2/3]

Botan::PK_KEM_Decryptor::PK_KEM_Decryptor ( const PK_KEM_Decryptor &  )

delete

PK_KEM_Decryptor() [3/3]

Botan::PK_KEM_Decryptor::PK_KEM_Decryptor ( PK_KEM_Decryptor &&  )

delete

Member Function Documentation

decrypt() [1/3]

template<typename Alloc1 , typename Alloc2 >

secure_vector< uint8_t > Botan::PK_KEM_Decryptor::decrypt ( const std::vector< uint8_t, Alloc1 > &  encap_key, size_t  desired_shared_key_len, const std::vector< uint8_t, Alloc2 > &  salt  )

inline

Decrypts the shared key for data encryption.

Parameters

encap_key	the encapsulated key
desired_shared_key_len	desired size of the shared key in bytes
salt	a salt value used in the KDF

Returns

the shared data encryption key

Definition at line 720 of file pubkey.h.

         {
         return this->decrypt(encap_key.data(), encap_key.size(),
                              desired_shared_key_len,
                              salt.data(), salt.size());
         }

References Botan::CryptoBox::decrypt().

decrypt() [2/3]

secure_vector< uint8_t > Botan::PK_KEM_Decryptor::decrypt ( const uint8_t  encap_key[], size_t  encap_key_len, size_t  desired_shared_key_len  )

inline

Decrypts the shared key for data encryption.

Parameters

encap_key	the encapsulated key
encap_key_len	size of the encapsulated key in bytes
desired_shared_key_len	desired size of the shared key in bytes

Returns

the shared data encryption key

Definition at line 703 of file pubkey.h.

         {
         return this->decrypt(encap_key, encap_key_len,
                              desired_shared_key_len,
                              nullptr, 0);
         }

References Botan::CryptoBox::decrypt().

decrypt() [3/3]

secure_vector< uint8_t > Botan::PK_KEM_Decryptor::decrypt	(	const uint8_t	encap_key[],
		size_t	encap_key_len,
		size_t	desired_shared_key_len,
		const uint8_t	salt[],
		size_t	salt_len
	)

Decrypts the shared key for data encryption.

Parameters

encap_key	the encapsulated key
encap_key_len	size of the encapsulated key in bytes
desired_shared_key_len	desired size of the shared key in bytes
salt	a salt value used in the KDF
salt_len	size of the salt value in bytes

Returns

the shared data encryption key

Definition at line 177 of file pubkey.cpp.

   {
   return m_op->kem_decrypt(encap_key, encap_key_len,
                            desired_shared_key_len,
                            salt, salt_len);
   }

References salt_len.

operator=() [1/2]

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

delete

operator=() [2/2]

PK_KEM_Decryptor & Botan::PK_KEM_Decryptor::operator= ( PK_KEM_Decryptor &&  )

delete

---

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

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