Botan::PK_Key_Agreement Class Reference

#include <pubkey.h>

Public Member Functions
SymmetricKey	derive_key (size_t key_len, const byte in[], size_t in_len, const byte params[], size_t params_len) const
SymmetricKey	derive_key (size_t key_len, const byte in[], size_t in_len, const std::string &params="") const
SymmetricKey	derive_key (size_t key_len, const MemoryRegion< byte > &in, const byte params[], size_t params_len) const
SymmetricKey	derive_key (size_t key_len, const MemoryRegion< byte > &in, const std::string &params="") const
	PK_Key_Agreement (const PK_Key_Agreement_Key &key, const std::string &kdf)
	~PK_Key_Agreement ()

Detailed Description

Key used for key agreement

Definition at line 312 of file pubkey.h.

Constructor & Destructor Documentation

PK_Key_Agreement()

Botan::PK_Key_Agreement::PK_Key_Agreement	(	const PK_Key_Agreement_Key &	key,
		const std::string &	kdf )

Construct a PK Key Agreement.

Parameters

key	the key to use
kdf	name of the KDF to use (or 'Raw' for no KDF)

Definition at line 359 of file pubkey.cpp.

   {
   Algorithm_Factory::Engine_Iterator i(global_state().algorithm_factory());
 
   op = 0;
 
   while(const Engine* engine = i.next())
      {
      op = engine->get_key_agreement_op(key);
      if(op)
         break;
      }
 
   if(!op)
      throw Lookup_Error("Key agreement with " + key.algo_name() + " not supported");
 
   kdf = (kdf_name == "Raw") ? 0 : get_kdf(kdf_name);
   }

References Botan::Public_Key::algo_name(), Botan::get_kdf(), Botan::global_state(), Botan::Lookup_Error::Lookup_Error(), and Botan::Algorithm_Factory::Engine_Iterator::next().

Referenced by Botan::get_pk_kas().

~PK_Key_Agreement()

Botan::PK_Key_Agreement::~PK_Key_Agreement ( )

inline

Definition at line 386 of file pubkey.h.

{ delete op; delete kdf; }

Member Function Documentation

derive_key() [1/4]

SymmetricKey Botan::PK_Key_Agreement::derive_key	(	size_t	key_len,
		const byte	in[],
		size_t	in_len,
		const byte	params[],
		size_t	params_len ) const

Definition at line 379 of file pubkey.cpp.

   {
   SecureVector<byte> z = op->agree(in, in_len);
 
   if(!kdf)
      return z;
 
   return kdf->derive_key(key_len, z, params, params_len);
   }

Referenced by Botan::Client_Key_Exchange::Client_Key_Exchange(), derive_key(), derive_key(), derive_key(), and Botan::Client_Key_Exchange::pre_master_secret().

derive_key() [2/4]

SymmetricKey Botan::PK_Key_Agreement::derive_key ( size_t key_len, const byte in[], size_t in_len, const std::string & params = "" ) const

inline

Definition at line 354 of file pubkey.h.

         {
         return derive_key(key_len, in, in_len,
                           reinterpret_cast<const byte*>(params.data()),
                           params.length());
         }

References derive_key().

derive_key() [3/4]

SymmetricKey Botan::PK_Key_Agreement::derive_key ( size_t key_len, const MemoryRegion< byte > & in, const byte params[], size_t params_len ) const

inline

Definition at line 338 of file pubkey.h.

         {
         return derive_key(key_len, &in[0], in.size(),
                           params, params_len);
         }

References derive_key(), and Botan::MemoryRegion< T >::size().

derive_key() [4/4]

SymmetricKey Botan::PK_Key_Agreement::derive_key ( size_t key_len, const MemoryRegion< byte > & in, const std::string & params = "" ) const

inline

Definition at line 369 of file pubkey.h.

         {
         return derive_key(key_len, &in[0], in.size(),
                           reinterpret_cast<const byte*>(params.data()),
                           params.length());
         }

References derive_key(), and Botan::MemoryRegion< T >::size().

---

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

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