#include <pubkey.h>

Public Member Functions
size_t	agreed_value_size () const

SymmetricKey	derive_key (size_t key_len, const uint8_t in[], size_t in_len, const uint8_t params[], size_t params_len) const

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

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

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

PK_Key_Agreement &	operator= (PK_Key_Agreement &&)

PK_Key_Agreement &	operator= (const PK_Key_Agreement &)=delete

	PK_Key_Agreement (const Private_Key &key, RandomNumberGenerator &rng, const std::string &kdf, const std::string &provider="")

	PK_Key_Agreement (PK_Key_Agreement &&)

	PK_Key_Agreement (const PK_Key_Agreement &)=delete

	~PK_Key_Agreement ()

Detailed Description

Object used for key agreement

Definition at line 413 of file pubkey.h.

Constructor & Destructor Documentation

Botan::PK_Key_Agreement::PK_Key_Agreement	(	const Private_Key &	key,
		RandomNumberGenerator &	rng,
		const std::string &	kdf,
		const std::string &	provider = `""`
	)

Construct a PK Key Agreement.

Parameters

key	the key to use
rng	the random generator to use
kdf	name of the KDF to use (or 'Raw' for no KDF)
provider	the algo provider to use (or empty for default)

Definition at line 188 of file pubkey.cpp.

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

    {
    m_op = key.create_key_agreement_op(rng, kdf, provider);
    if(!m_op)
       throw Invalid_Argument("Key type " + key.algo_name() + " does not support key agreement");
    }

Botan::PK_Key_Agreement::~PK_Key_Agreement ( )

Definition at line 198 of file pubkey.cpp.

198 { /* for unique_ptr */ }

Botan::PK_Key_Agreement::PK_Key_Agreement ( PK_Key_Agreement && other )

Definition at line 209 of file pubkey.cpp.

                                                            :
    m_op(std::move(other.m_op))
    {}

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

delete

Member Function Documentation

size_t Botan::PK_Key_Agreement::agreed_value_size ( ) const

Return the underlying size of the value that is agreed. If derive_key is called with a length of 0 with a "Raw" KDF, it will return a value of this size.

Definition at line 213 of file pubkey.cpp.

    {
    return m_op->agreed_value_size();
    }

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

Perform Key Agreement Operation

Parameters

key_len	the desired key output size
in	the other parties key
in_len	the length of in in bytes
params	extra derivation params
params_len	the length of params in bytes

Definition at line 218 of file pubkey.cpp.

Referenced by botan_pk_op_key_agreement(), Botan::TLS::Client_Key_Exchange::Client_Key_Exchange(), Botan::ECIES_KA_Operation::derive_secret(), Botan::TLS::Callbacks::tls_dh_agree(), and Botan::TLS::Callbacks::tls_ecdh_agree().

    {
    return m_op->agree(key_len, in, in_len, salt, salt_len);
    }

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

inline

Perform Key Agreement Operation

Parameters

key_len	the desired key output size
in	the other parties key
params	extra derivation params
params_len	the length of params in bytes

Definition at line 474 of file pubkey.h.

          {
          return derive_key(key_len, in.data(), in.size(),
                            params, params_len);
          }

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

inline

Perform Key Agreement Operation

Parameters

key_len	the desired key output size
in	the other parties key
in_len	the length of in in bytes
params	extra derivation params

Definition at line 490 of file pubkey.h.

References Botan::cast_char_ptr_to_uint8().

          {
          return derive_key(key_len, in, in_len,
                            cast_char_ptr_to_uint8(params.data()),
                            params.length());
          }

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

inline

Perform Key Agreement Operation

Parameters

key_len	the desired key output size
in	the other parties key
params	extra derivation params

Definition at line 505 of file pubkey.h.

References Botan::cast_char_ptr_to_uint8().

          {
          return derive_key(key_len, in.data(), in.size(),
                            cast_char_ptr_to_uint8(params.data()),
                            params.length());
          }

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

Definition at line 200 of file pubkey.cpp.

    {
    if(this != &other)
       {
       m_op = std::move(other.m_op);
       }
    return (*this);
    }

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/lib/pubkey/pubkey.h
src/lib/pubkey/pubkey.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation