Botan::ECIES_KA_Params Class Reference

#include <ecies.h>

Inheritance diagram for Botan::ECIES_KA_Params:

Public Member Functions
bool	check_mode () const
bool	cofactor_mode () const
EC_Point_Format	compression_type () const
const EC_Group &	domain () const
	ECIES_KA_Params (const EC_Group &domain, std::string_view kdf_spec, size_t length, EC_Point_Format compression_type, ECIES_Flags flags)
	ECIES_KA_Params (const ECIES_KA_Params &)=default
const std::string &	kdf_spec () const
bool	old_cofactor_mode () const
ECIES_KA_Params &	operator= (const ECIES_KA_Params &)=delete
size_t	secret_length () const
bool	single_hash_mode () const
virtual	~ECIES_KA_Params ()=default

Detailed Description

Parameters for ECIES secret derivation

Definition at line 56 of file ecies.h.

Constructor & Destructor Documentation

ECIES_KA_Params() [1/2]

Botan::ECIES_KA_Params::ECIES_KA_Params	(	const EC_Group &	domain,
		std::string_view	kdf_spec,
		size_t	length,
		EC_Point_Format	compression_type,
		ECIES_Flags	flags )

Parameters

domain	ec domain parameters of the involved ec keys
kdf_spec	name of the key derivation function
length	length of the secret to be derived
compression_type	format of encoded keys (affects the secret derivation if single_hash_mode is used)
flags	options, see documentation of ECIES_Flags

Definition at line 169 of file ecies.cpp.

                                                    :
      m_domain(domain), m_kdf_spec(kdf_spec), m_length(length), m_compression_mode(compression_type), m_flags(flags) {}

ECIES_KA_Params() [2/2]

Botan::ECIES_KA_Params::ECIES_KA_Params ( const ECIES_KA_Params & )

default

~ECIES_KA_Params()

virtual Botan::ECIES_KA_Params::~ECIES_KA_Params ( )

virtualdefault

Member Function Documentation

check_mode()

bool Botan::ECIES_KA_Params::check_mode ( ) const

inline

Definition at line 90 of file ecies.h.

{ return (m_flags & ECIES_Flags::CheckMode) == ECIES_Flags::CheckMode; }

Referenced by Botan::ECIES_Decryptor::ECIES_Decryptor(), and Botan::ECIES_System_Params::ECIES_System_Params().

cofactor_mode()

bool Botan::ECIES_KA_Params::cofactor_mode ( ) const

inline

Definition at line 84 of file ecies.h.

{ return (m_flags & ECIES_Flags::CofactorMode) == ECIES_Flags::CofactorMode; }

Referenced by Botan::ECIES_System_Params::ECIES_System_Params().

compression_type()

EC_Point_Format Botan::ECIES_KA_Params::compression_type ( ) const

inline

Definition at line 92 of file ecies.h.

{ return m_compression_mode; }

Referenced by Botan::ECIES_KA_Operation::derive_secret(), and Botan::ECIES_Encryptor::ECIES_Encryptor().

domain()

const EC_Group & Botan::ECIES_KA_Params::domain ( ) const

inline

Definition at line 76 of file ecies.h.

{ return m_domain; }

Referenced by Botan::ECIES_KA_Operation::derive_secret(), Botan::ECIES_Decryptor::ECIES_Decryptor(), and Botan::ECIES_Encryptor::ECIES_Encryptor().

kdf_spec()

const std::string & Botan::ECIES_KA_Params::kdf_spec ( ) const

inline

Definition at line 94 of file ecies.h.

{ return m_kdf_spec; }

Referenced by Botan::ECIES_KA_Operation::derive_secret().

old_cofactor_mode()

bool Botan::ECIES_KA_Params::old_cofactor_mode ( ) const

inline

Definition at line 86 of file ecies.h.

                                            {
         return (m_flags & ECIES_Flags::OldCofactorMode) == ECIES_Flags::OldCofactorMode;
      }

Referenced by Botan::ECIES_KA_Operation::derive_secret(), and Botan::ECIES_System_Params::ECIES_System_Params().

operator=()

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

delete

secret_length()

size_t Botan::ECIES_KA_Params::secret_length ( ) const

inline

Definition at line 78 of file ecies.h.

{ return m_length; }

Referenced by Botan::ECIES_KA_Operation::derive_secret().

single_hash_mode()

bool Botan::ECIES_KA_Params::single_hash_mode ( ) const

inline

Definition at line 80 of file ecies.h.

                                           {
         return (m_flags & ECIES_Flags::SingleHashMode) == ECIES_Flags::SingleHashMode;
      }

Referenced by Botan::ECIES_KA_Operation::derive_secret().

---

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

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