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 std::vector< byte > &in, 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 std::vector< byte > &in, const std::string &params="") const
PK_Key_Agreement &	operator= (const PK_Key_Agreement &)=delete
	PK_Key_Agreement (const PK_Key_Agreement_Key &key, const std::string &kdf)
	PK_Key_Agreement (const PK_Key_Agreement_Key &)=delete
	~PK_Key_Agreement ()

Detailed Description

Key used for key agreement

Definition at line 323 of file pubkey.h.

Constructor & Destructor Documentation

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 355 of file pubkey.cpp.

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

   {
   Algorithm_Factory::Engine_Iterator i(global_state().algorithm_factory());

   while(const Engine* engine = i.next())
      {
      op = engine->get_key_agreement_op(key);
      if(op)
         break;
      }

   if(!op)
      throw Lookup_Error("PK_Key_Agreement: No working engine for " +
                         key.algo_name());

   kdf = (kdf_name == "Raw") ? nullptr : get_kdf(kdf_name);
   }

Botan::PK_Key_Agreement::PK_Key_Agreement ( const PK_Key_Agreement_Key &  )

delete

Botan::PK_Key_Agreement::~PK_Key_Agreement ( )

inline

Definition at line 400 of file pubkey.h.

{ delete op; delete kdf; }

Member Function Documentation

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 374 of file pubkey.cpp.

References Botan::PK_Ops::Key_Agreement::agree(), and Botan::KDF::derive_key().

Referenced by Botan::TLS::Client_Key_Exchange::Client_Key_Exchange().

   {
   secure_vector<byte> z = op->agree(in, in_len);

   if(!kdf)
      return z;

   return kdf->derive_key(key_len, z, params, params_len);
   }

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

inline

Definition at line 349 of file pubkey.h.

References Botan::TLS::derive_key().

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

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 365 of file pubkey.h.

References Botan::TLS::derive_key().

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

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

inline

Definition at line 380 of file pubkey.h.

References Botan::TLS::derive_key().

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

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

delete

---

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

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