Botan::PK_Key_Agreement Class Reference

#include <pubkey.h>

Public Member Functions
size_t	agreed_value_size () const
SymmetricKey	derive_key (size_t key_len, const uint8_t peer_key[], size_t peer_key_len, const uint8_t salt[], size_t salt_len) const
SymmetricKey	derive_key (size_t key_len, const uint8_t peer_key[], size_t peer_key_len, std::string_view salt="") const
SymmetricKey	derive_key (size_t key_len, std::span< const uint8_t > peer_key, const uint8_t salt[], size_t salt_len) const
SymmetricKey	derive_key (size_t key_len, std::span< const uint8_t > peer_key, std::string_view salt="") const
PK_Key_Agreement &	operator= (const PK_Key_Agreement &)=delete
PK_Key_Agreement &	operator= (PK_Key_Agreement &&) noexcept
	PK_Key_Agreement (const PK_Key_Agreement &)=delete
	PK_Key_Agreement (const Private_Key &key, RandomNumberGenerator &rng, std::string_view kdf, std::string_view provider="")
	PK_Key_Agreement (PK_Key_Agreement &&) noexcept
	~PK_Key_Agreement ()

Detailed Description

Object used for key agreement

Definition at line 397 of file pubkey.h.

Constructor & Destructor Documentation

PK_Key_Agreement() [1/3]

Botan::PK_Key_Agreement::PK_Key_Agreement	(	const Private_Key &	key,
		RandomNumberGenerator &	rng,
		std::string_view	kdf,
		std::string_view	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 215 of file pubkey.cpp.

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

References Botan::Asymmetric_Key::algo_name(), Botan::Private_Key::create_key_agreement_op(), and Botan::fmt().

~PK_Key_Agreement()

Botan::PK_Key_Agreement::~PK_Key_Agreement ( )

default

PK_Key_Agreement() [2/3]

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

delete

PK_Key_Agreement() [3/3]

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

defaultnoexcept

Member Function Documentation

agreed_value_size()

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

                                                 {
   return m_op->agreed_value_size();
}

References agreed_value_size().

Referenced by agreed_value_size().

derive_key() [1/4]

SymmetricKey Botan::PK_Key_Agreement::derive_key	(	size_t	key_len,
		const uint8_t	peer_key[],
		size_t	peer_key_len,
		const uint8_t	salt[],
		size_t	salt_len ) const

Perform Key Agreement Operation

Parameters

key_len	the desired key output size (ignored if "Raw" KDF is used)
peer_key	the other parties key
peer_key_len	the length of peer_key in bytes
salt	extra derivation salt
salt_len	the length of salt in bytes

Definition at line 248 of file pubkey.cpp.

                                                                                                               {
   return SymmetricKey(m_op->agree(key_len, {peer_key, peer_key_len}, {salt, salt_len}));
}

Referenced by derive_key(), derive_key(), Botan::ECIES_KA_Operation::derive_secret(), and Botan::TLS::Callbacks::tls_ephemeral_key_agreement().

derive_key() [2/4]

SymmetricKey Botan::PK_Key_Agreement::derive_key	(	size_t	key_len,
		const uint8_t	peer_key[],
		size_t	peer_key_len,
		std::string_view	salt = "" ) const

Perform Key Agreement Operation

Parameters

key_len	the desired key output size (ignored if "Raw" KDF is used)
peer_key	the other parties key
peer_key_len	the length of peer_key in bytes
salt	extra derivation info

Definition at line 234 of file pubkey.cpp.

                                                                     {
   return this->derive_key(key_len, peer_key, peer_key_len, cast_char_ptr_to_uint8(salt.data()), salt.length());
}

References Botan::cast_char_ptr_to_uint8(), and derive_key().

derive_key() [3/4]

SymmetricKey Botan::PK_Key_Agreement::derive_key ( size_t key_len, std::span< const uint8_t > peer_key, const uint8_t salt[], size_t salt_len ) const

inline

Perform Key Agreement Operation

Parameters

key_len	the desired key output size (ignored if "Raw" KDF is used)
peer_key	the other parties key
salt	extra derivation salt
salt_len	the length of salt in bytes

Definition at line 437 of file pubkey.h.

                                                     {
         return derive_key(key_len, peer_key.data(), peer_key.size(), salt, salt_len);
      }

derive_key() [4/4]

SymmetricKey Botan::PK_Key_Agreement::derive_key	(	size_t	key_len,
		std::span< const uint8_t >	peer_key,
		std::string_view	salt = "" ) const

Perform Key Agreement Operation

Parameters

key_len	the desired key output size (ignored if "Raw" KDF is used)
peer_key	the other parties key
salt	extra derivation info

Definition at line 241 of file pubkey.cpp.

                                                                     {
   return this->derive_key(
      key_len, peer_key.data(), peer_key.size(), cast_char_ptr_to_uint8(salt.data()), salt.length());
}

References Botan::cast_char_ptr_to_uint8(), and derive_key().

operator=() [1/2]

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

delete

operator=() [2/2]

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

defaultnoexcept

---

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

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