Botan 3.6.1
Crypto and TLS for C&
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
 
EC_Point_Format compression_type () const
 
const EC_Groupdomain () const
 
 ECIES_KA_Params (const EC_Group &domain, std::string_view kdf_spec, size_t length, EC_Point_Format 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,
std::string_view kdf_spec,
size_t length,
EC_Point_Format 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 164 of file ecies.cpp.

168 :
169 m_domain(domain), m_kdf_spec(kdf_spec), m_length(length), m_compression_mode(compression_type), m_flags(flags) {}
EC_Point_Format compression_type() const
Definition ecies.h:93
const std::string & kdf_spec() const
Definition ecies.h:95
const EC_Group & domain() const
Definition ecies.h:77

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

91{ return (m_flags & ECIES_Flags::CheckMode) == ECIES_Flags::CheckMode; }
@ CheckMode
(decryption only) if set: test if the (ephemeral) public key is on the curve

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

@ CofactorMode
(decryption only) if set: use cofactor multiplication during (ecdh) key agreement

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

◆ compression_type()

EC_Point_Format Botan::ECIES_KA_Params::compression_type ( ) const
inline

Definition at line 93 of file ecies.h.

93{ return m_compression_mode; }

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

Definition at line 77 of file ecies.h.

77{ return m_domain; }

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

◆ kdf_spec()

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

Definition at line 95 of file ecies.h.

95{ return m_kdf_spec; }

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

◆ old_cofactor_mode()

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

Definition at line 87 of file ecies.h.

87 {
89 }
@ OldCofactorMode
if set: use ecdhc instead of ecdh

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

79{ return m_length; }

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

◆ single_hash_mode()

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

Definition at line 81 of file ecies.h.

81 {
83 }
@ SingleHashMode
if set: prefix the input of the (ecdh) key agreement with the encoded (ephemeral) public key

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


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