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
PointGFp::Compression_Type	compression_type () const
const EC_Group &	domain () const
	ECIES_KA_Params (const EC_Group &domain, const std::string &kdf_spec, size_t length, PointGFp::Compression_Type 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 57 of file ecies.h.

Constructor & Destructor Documentation

Botan::ECIES_KA_Params::ECIES_KA_Params	(	const EC_Group &	domain,
		const std::string &	kdf_spec,
		size_t	length,
		PointGFp::Compression_Type	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 182 of file ecies.cpp.

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

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

default

virtual Botan::ECIES_KA_Params::~ECIES_KA_Params ( )

virtualdefault

Member Function Documentation

bool Botan::ECIES_KA_Params::check_mode ( ) const

inline

Definition at line 100 of file ecies.h.

References Botan::CHECK_MODE.

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

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

bool Botan::ECIES_KA_Params::cofactor_mode ( ) const

inline

Definition at line 90 of file ecies.h.

References Botan::COFACTOR_MODE.

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

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

PointGFp::Compression_Type Botan::ECIES_KA_Params::compression_type ( ) const

inline

Definition at line 105 of file ecies.h.

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

         {
         return m_compression_mode;
         }

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

inline

Definition at line 75 of file ecies.h.

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

         {
         return m_domain;
         }

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

inline

Definition at line 110 of file ecies.h.

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

         {
         return m_kdf_spec;
         }

bool Botan::ECIES_KA_Params::old_cofactor_mode ( ) const

inline

Definition at line 95 of file ecies.h.

References Botan::OLD_COFACTOR_MODE.

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

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

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

delete

size_t Botan::ECIES_KA_Params::secret_length ( ) const

inline

Definition at line 80 of file ecies.h.

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

         {
         return m_length;
         }

bool Botan::ECIES_KA_Params::single_hash_mode ( ) const

inline

Definition at line 85 of file ecies.h.

References Botan::SINGLE_HASH_MODE.

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

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

---

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

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