Botan::ECIES_System_Params Class Reference

#include <ecies.h>

Inheritance diagram for Botan::ECIES_System_Params:

Public Member Functions
bool	check_mode () const
bool	cofactor_mode () const
PointGFp::Compression_Type	compression_type () const
std::unique_ptr< Cipher_Mode >	create_cipher (Botan::Cipher_Dir direction) const
	creates an instance of the data encryption method More...
std::unique_ptr< MessageAuthenticationCode >	create_mac () const
	creates an instance of the message authentication code More...
size_t	dem_keylen () const
	returns the length of the key used by the data encryption method More...
const EC_Group &	domain () const
	ECIES_System_Params (const EC_Group &domain, const std::string &kdf_spec, const std::string &dem_algo_spec, size_t dem_key_len, const std::string &mac_spec, size_t mac_key_len)
	ECIES_System_Params (const EC_Group &domain, const std::string &kdf_spec, const std::string &dem_algo_spec, size_t dem_key_len, const std::string &mac_spec, size_t mac_key_len, PointGFp::Compression_Type compression_type, ECIES_Flags flags)
	ECIES_System_Params (const ECIES_System_Params &)=default
const std::string &	kdf_spec () const
size_t	mac_keylen () const
	returns the length of the key used by the message authentication code More...
bool	old_cofactor_mode () const
ECIES_System_Params &	operator= (const ECIES_System_Params &)=default
size_t	secret_length () const
bool	single_hash_mode () const
virtual	~ECIES_System_Params ()=default

Detailed Description

Definition at line 123 of file ecies.h.

Constructor & Destructor Documentation

ECIES_System_Params() [1/3]

Botan::ECIES_System_Params::ECIES_System_Params	(	const EC_Group &	domain,
		const std::string &	kdf_spec,
		const std::string &	dem_algo_spec,
		size_t	dem_key_len,
		const std::string &	mac_spec,
		size_t	mac_key_len
	)

Parameters

domain	ec domain parameters of the involved ec keys
kdf_spec	name of the key derivation function
dem_algo_spec	name of the data encryption method
dem_key_len	length of the key used for the data encryption method
mac_spec	name of the message authentication code
mac_key_len	length of the key used for the message authentication code

Definition at line 211 of file ecies.cpp.

                                                                                        :
   ECIES_System_Params(domain, kdf_spec, dem_algo_spec, dem_key_len, mac_spec, mac_key_len, PointGFp::UNCOMPRESSED,
                         ECIES_Flags::NONE)
   {
   }

ECIES_System_Params() [2/3]

Botan::ECIES_System_Params::ECIES_System_Params	(	const EC_Group &	domain,
		const std::string &	kdf_spec,
		const std::string &	dem_algo_spec,
		size_t	dem_key_len,
		const std::string &	mac_spec,
		size_t	mac_key_len,
		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
dem_algo_spec	name of the data encryption method
dem_key_len	length of the key used for the data encryption method
mac_spec	name of the message authentication code
mac_key_len	length of the key used for the message authentication code
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 194 of file ecies.cpp.

References Botan::ECIES_KA_Params::check_mode(), Botan::ECIES_KA_Params::cofactor_mode(), and Botan::ECIES_KA_Params::old_cofactor_mode().

                                                                                                       :
   ECIES_KA_Params(domain, kdf_spec, dem_key_len + mac_key_len, compression_type, flags),
   m_dem_spec(dem_algo_spec),
   m_dem_keylen(dem_key_len),
   m_mac_spec(mac_spec),
   m_mac_keylen(mac_key_len)
   {
   // ISO 18033: "At most one of CofactorMode, OldCofactorMode, and CheckMode may be 1."
   if(size_t(cofactor_mode()) + size_t(old_cofactor_mode()) + size_t(check_mode()) > 1)
      {
      throw Invalid_Argument("ECIES: only one of cofactor_mode, old_cofactor_mode and check_mode can be set");
      }
   }

ECIES_System_Params() [3/3]

Botan::ECIES_System_Params::ECIES_System_Params ( const ECIES_System_Params &  )

default

~ECIES_System_Params()

virtual Botan::ECIES_System_Params::~ECIES_System_Params ( )

virtualdefault

Member Function Documentation

check_mode()

bool Botan::ECIES_KA_Params::check_mode ( ) const

inlineinherited

Definition at line 99 of file ecies.h.

References Botan::CHECK_MODE.

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

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

cofactor_mode()

bool Botan::ECIES_KA_Params::cofactor_mode ( ) const

inlineinherited

Definition at line 89 of file ecies.h.

References Botan::COFACTOR_MODE.

Referenced by ECIES_System_Params().

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

compression_type()

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

inlineinherited

Definition at line 104 of file ecies.h.

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

         {
         return m_compression_mode;
         }

create_cipher()

std::unique_ptr< Cipher_Mode > Botan::ECIES_System_Params::create_cipher

(

Botan::Cipher_Dir

direction

)

const

creates an instance of the data encryption method

Definition at line 224 of file ecies.cpp.

References Botan::Cipher_Mode::create_or_throw().

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

   {
   return Cipher_Mode::create_or_throw(m_dem_spec, direction);
   }

create_mac()

std::unique_ptr< MessageAuthenticationCode > Botan::ECIES_System_Params::create_mac

(

)

const

creates an instance of the message authentication code

Definition at line 219 of file ecies.cpp.

References Botan::MessageAuthenticationCode::create_or_throw().

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

   {
   return Botan::MessageAuthenticationCode::create_or_throw(m_mac_spec);
   }

dem_keylen()

size_t Botan::ECIES_System_Params::dem_keylen ( ) const

inline

returns the length of the key used by the data encryption method

Definition at line 162 of file ecies.h.

         {
         return m_dem_keylen;
         }

domain()

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

inlineinherited

Definition at line 74 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;
         }

kdf_spec()

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

inlineinherited

Definition at line 109 of file ecies.h.

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

         {
         return m_kdf_spec;
         }

mac_keylen()

size_t Botan::ECIES_System_Params::mac_keylen ( ) const

inline

returns the length of the key used by the message authentication code

Definition at line 168 of file ecies.h.

         {
         return m_mac_keylen;
         }

old_cofactor_mode()

bool Botan::ECIES_KA_Params::old_cofactor_mode ( ) const

inlineinherited

Definition at line 94 of file ecies.h.

References Botan::OLD_COFACTOR_MODE.

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

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

operator=()

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

default

secret_length()

size_t Botan::ECIES_KA_Params::secret_length ( ) const

inlineinherited

Definition at line 79 of file ecies.h.

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

         {
         return m_length;
         }

single_hash_mode()

bool Botan::ECIES_KA_Params::single_hash_mode ( ) const

inlineinherited

Definition at line 84 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