Botan 3.0.0-alpha0
Crypto and TLS for C&
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 &)=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

◆ 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 187 of file ecies.cpp.

188 :
189 m_domain(domain),
190 m_kdf_spec(kdf_spec),
191 m_length(length),
192 m_compression_mode(compression_type),
193 m_flags(flags)
194 {
195 }
const std::string & kdf_spec() const
Definition: ecies.h:110
PointGFp::Compression_Type compression_type() const
Definition: ecies.h:105
const EC_Group & domain() const
Definition: ecies.h:75
Flags flags(Flag flags)
Definition: p11.h:860

◆ 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.

101 {
103 }
@ CHECK_MODE
(decryption only) if set: test if the (ephemeral) public key is on the curve

References Botan::CHECK_MODE.

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

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

References Botan::COFACTOR_MODE.

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

◆ compression_type()

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

Definition at line 105 of file ecies.h.

106 {
107 return m_compression_mode;
108 }

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

◆ kdf_spec()

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

Definition at line 110 of file ecies.h.

111 {
112 return m_kdf_spec;
113 }

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

◆ old_cofactor_mode()

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

Definition at line 95 of file ecies.h.

96 {
98 }
@ OLD_COFACTOR_MODE
if set: use ecdhc instead of ecdh

References Botan::OLD_COFACTOR_MODE.

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

81 {
82 return m_length;
83 }

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

◆ single_hash_mode()

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

Definition at line 85 of file ecies.h.

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

References Botan::SINGLE_HASH_MODE.

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


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