Botan  2.4.0
Crypto and TLS for C++11
Public Member Functions | List of all members
Botan::ECIES_KA_Params Class Reference

#include <ecies.h>

Inheritance diagram for Botan::ECIES_KA_Params:
Botan::ECIES_System_Params

Public Member Functions

bool check_mode () const
 
bool cofactor_mode () const
 
PointGFp::Compression_Type compression_type () const
 
const EC_Groupdomain () 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_Paramsoperator= (const ECIES_KA_Params &)=default
 
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 58 of file ecies.h.

Constructor & Destructor Documentation

◆ ECIES_KA_Params() [1/2]

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
domainec domain parameters of the involved ec keys
kdf_specname of the key derivation function
lengthlength of the secret to be derived
compression_typeformat of encoded keys (affects the secret derivation if single_hash_mode is used)
flagsoptions, see documentation of ECIES_Flags

Definition at line 176 of file ecies.cpp.

177  :
178  m_domain(domain),
179  m_kdf_spec(kdf_spec),
180  m_length(length),
181  m_compression_mode(compression_type),
182  m_flags(flags)
183  {
184  }
PointGFp::Compression_Type compression_type() const
Definition: ecies.h:105
Flags flags(Flag flags)
Definition: p11.h:858
const std::string & kdf_spec() const
Definition: ecies.h:110
const EC_Group & domain() const
Definition: ecies.h:75

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

References Botan::CHECK_MODE.

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

101  {
102  return (m_flags & ECIES_Flags::CHECK_MODE) == ECIES_Flags::CHECK_MODE;
103  }
(decryption only) if set: test if the (ephemeral) public key is on the curve

◆ cofactor_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().

91  {
93  }
(decryption only) if set: use cofactor multiplication during (ecdh) key agreement ...

◆ compression_type()

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(), Botan::ECIES_Decryptor::ECIES_Decryptor(), and Botan::ECIES_Encryptor::ECIES_Encryptor().

106  {
107  return m_compression_mode;
108  }

◆ domain()

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().

76  {
77  return m_domain;
78  }

◆ kdf_spec()

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().

111  {
112  return m_kdf_spec;
113  }

◆ old_cofactor_mode()

bool Botan::ECIES_KA_Params::old_cofactor_mode ( ) const
inline

◆ operator=()

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

◆ secret_length()

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().

81  {
82  return m_length;
83  }

◆ single_hash_mode()

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().

86  {
88  }
if set: prefix the input of the (ecdh) key agreement with the encoded (ephemeral) public key ...

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