#include <ecies.h>

Inheritance diagram for Botan::ECIES_System_Params:

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

Detailed Description

Definition at line 155 of file ecies.h.

Constructor & Destructor Documentation

◆ ECIES_System_Params() [1/4]

Botan::ECIES_System_Params::ECIES_System_Params	(	const EC_Group &	group,
		std::string_view	kdf_spec,
		std::string_view	dem_algo_spec,
		size_t	dem_key_len,
		std::string_view	mac_spec,
		size_t	mac_key_len,
		EC_Point_Format	point_format = EC_Point_Format::Uncompressed,
		bool	single_hash_mode = false )

Parameters

group	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 256 of file ecies.cpp.

                                                                :
      ECIES_KA_Params(group, kdf, dem_key_len + mac_key_len, point_format, single_hash_mode),
      m_dem_spec(dem_algo_spec),
      m_dem_keylen(dem_key_len),
      m_mac_spec(mac_spec),
      m_mac_keylen(mac_key_len) {}

References Botan::ECIES_KA_Params::ECIES_KA_Params(), Botan::ECIES_KA_Params::group(), Botan::ECIES_KA_Params::kdf(), Botan::ECIES_KA_Params::point_format(), and Botan::ECIES_KA_Params::single_hash_mode().

Referenced by ECIES_System_Params(), ECIES_System_Params(), operator=(), and operator=().

◆ ECIES_System_Params() [2/4]

Botan::ECIES_System_Params::ECIES_System_Params	(	const EC_Group &	group,
		std::string_view	kdf_spec,
		std::string_view	dem_algo_spec,
		size_t	dem_key_len,
		std::string_view	mac_spec,
		size_t	mac_key_len,
		EC_Point_Format	point_format,
		ECIES_Flags	flags )

Parameters

group	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
point_format	format of encoded keys (affects the secret derivation if single_hash_mode is used)
flags	options, see documentation of ECIES_Flags

This constructor makes sense only if you are using the CofactorMode or OldCofactorMode flags. Support for cofactors in EC_Group is deprecated and will be removed in Botan4.

TODO(Botan4) remove this constructor when cofactor support is removed

Definition at line 237 of file ecies.cpp.

                                                            :
      ECIES_KA_Params(group, kdf, dem_key_len + mac_key_len, point_format, 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");
   }
}

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

◆ ECIES_System_Params() [3/4]

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

default

References ECIES_System_Params().

◆ ECIES_System_Params() [4/4]

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

default

References ECIES_System_Params().

◆ ~ECIES_System_Params()

Botan::ECIES_System_Params::~ECIES_System_Params ( )

overridedefault

References create_cipher(), and create_mac().

Member Function Documentation

◆ check_mode()

bool Botan::ECIES_KA_Params::check_mode ( ) const

inlineinherited

Definition at line 132 of file ecies.h.

132{ return m_check_mode; }

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

◆ cofactor_mode()

bool Botan::ECIES_KA_Params::cofactor_mode ( ) const

inlineinherited

Definition at line 126 of file ecies.h.

126{ return m_cofactor_mode; }

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

◆ compression_type()

EC_Point_Format Botan::ECIES_KA_Params::compression_type ( ) const

inlineinherited

Definition at line 142 of file ecies.h.

142{ return point_format(); }

References compression_type(), and point_format().

Referenced by compression_type().

◆ create_cipher()

std::unique_ptr< Cipher_Mode > Botan::ECIES_System_Params::create_cipher ( Cipher_Dir direction ) const

creates an instance of the data encryption method

Definition at line 274 of file ecies.cpp.

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

References Botan::Cipher_Mode::create_or_throw().

Referenced by ~ECIES_System_Params().

◆ create_mac()

std::unique_ptr< MessageAuthenticationCode > Botan::ECIES_System_Params::create_mac ( ) const

creates an instance of the message authentication code

Definition at line 270 of file ecies.cpp.

                                                                               {
   return MessageAuthenticationCode::create_or_throw(m_mac_spec);
}

References Botan::MessageAuthenticationCode::create_or_throw().

Referenced by ~ECIES_System_Params().

◆ 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 213 of file ecies.h.

213{ return m_dem_keylen; }

◆ domain()

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

inlineinherited

Definition at line 140 of file ecies.h.

140{ return group(); }

References domain(), and group().

Referenced by domain().

◆ group()

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

inlineinherited

Definition at line 119 of file ecies.h.

119{ return m_group; }

Referenced by domain(), ECIES_KA_Params(), ECIES_KA_Params(), Botan::ECIES_System_Params::ECIES_System_Params(), and Botan::ECIES_System_Params::ECIES_System_Params().

◆ kdf()

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

inlineinherited

Definition at line 136 of file ecies.h.

136{ return m_kdf; }

Referenced by ECIES_KA_Params(), ECIES_KA_Params(), Botan::ECIES_System_Params::ECIES_System_Params(), Botan::ECIES_System_Params::ECIES_System_Params(), and kdf_spec().

◆ kdf_spec()

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

inlineinherited

Definition at line 138 of file ecies.h.

138{ return kdf(); }

References kdf(), and kdf_spec().

Referenced by 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 216 of file ecies.h.

216{ return m_mac_keylen; }

◆ old_cofactor_mode()

bool Botan::ECIES_KA_Params::old_cofactor_mode ( ) const

inlineinherited

Definition at line 129 of file ecies.h.

129{ return m_old_cofactor_mode; }

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

◆ operator=() [1/2]

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

delete

References ECIES_System_Params().

◆ operator=() [2/2]

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

delete

References ECIES_System_Params().

◆ point_format()

EC_Point_Format Botan::ECIES_KA_Params::point_format ( ) const

inlineinherited

Definition at line 134 of file ecies.h.

134{ return m_point_format; }

Referenced by compression_type(), Botan::ECIES_Encryptor::ECIES_Encryptor(), ECIES_KA_Params(), ECIES_KA_Params(), Botan::ECIES_System_Params::ECIES_System_Params(), and Botan::ECIES_System_Params::ECIES_System_Params().

◆ secret_length()

size_t Botan::ECIES_KA_Params::secret_length ( ) const

inlineinherited

Definition at line 121 of file ecies.h.

121{ return m_length; }

◆ single_hash_mode()

bool Botan::ECIES_KA_Params::single_hash_mode ( ) const

inlineinherited

Definition at line 123 of file ecies.h.

123{ return m_single_hash_mode; }

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

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ECIES_System_Params() [1/4]

◆ ECIES_System_Params() [2/4]

◆ ECIES_System_Params() [3/4]

◆ ECIES_System_Params() [4/4]

◆ ~ECIES_System_Params()

Member Function Documentation

◆ check_mode()

◆ cofactor_mode()

◆ compression_type()

◆ create_cipher()

◆ create_mac()

◆ dem_keylen()

◆ domain()

◆ group()

◆ kdf()

◆ kdf_spec()

◆ mac_keylen()

◆ old_cofactor_mode()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ point_format()

◆ secret_length()

◆ single_hash_mode()