Qrypt Security
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
QryptSecurity::IKeyGenDistributedClient Class Referenceabstract

KeyGenDistributedClient. More...

#include <qryptsecurity.h>

Public Member Functions

 IKeyGenDistributedClient ()
 
virtual ~IKeyGenDistributedClient ()
 
virtual void initialize (std::string qryptToken)=0
 Initializes the client.
 
virtual void initialize (std::string qryptToken, std::string caCertPath)=0
 Initializes the client.
 
virtual SymmetricKeyData genInit (const SymmetricKeyMode mode)=0
 Generate symmetric key for this client and metadata for other client.
 
virtual SymmetricKeyData genInit (const SymmetricKeyMode mode, const size_t keySize)=0
 Generate symmetric key for this client and metadata for other client.
 
virtual std::vector< uint8_t > genSync (std::vector< uint8_t > metadata)=0
 Generate symmetric key for this client from metadata.
 

Static Public Member Functions

static std::unique_ptr< IKeyGenDistributedClientcreate ()
 Factory function for creating objects.
 

Detailed Description

KeyGenDistributedClient.

Use cases:

Constructor & Destructor Documentation

◆ IKeyGenDistributedClient()

QryptSecurity::IKeyGenDistributedClient::IKeyGenDistributedClient ( )
inline

◆ ~IKeyGenDistributedClient()

virtual QryptSecurity::IKeyGenDistributedClient::~IKeyGenDistributedClient ( )
inlinevirtual

Member Function Documentation

◆ create()

static std::unique_ptr< IKeyGenDistributedClient > QryptSecurity::IKeyGenDistributedClient::create ( )
static

Factory function for creating objects.

Returns
An unique pointer to the constructed object

◆ genInit() [1/2]

virtual SymmetricKeyData QryptSecurity::IKeyGenDistributedClient::genInit ( const SymmetricKeyMode  mode)
pure virtual

Generate symmetric key for this client and metadata for other client.

Parameters
modeSymmetric key algorithm
Returns
Symmetric key and metadata

◆ genInit() [2/2]

virtual SymmetricKeyData QryptSecurity::IKeyGenDistributedClient::genInit ( const SymmetricKeyMode  mode,
const size_t  keySize 
)
pure virtual

Generate symmetric key for this client and metadata for other client.

The input argument keySize is ignored for SYMMETRIC_KEY_MODE_AES_256 mode.

Parameters
modeSymmetric key algorithm
keySizeSymmetric key size when using OTP mode
Returns
Symmetric key and metadata

◆ genSync()

virtual std::vector< uint8_t > QryptSecurity::IKeyGenDistributedClient::genSync ( std::vector< uint8_t >  metadata)
pure virtual

Generate symmetric key for this client from metadata.

Parameters
metadataSymmetric key metadata
Returns
Symmetric key

◆ initialize() [1/2]

virtual void QryptSecurity::IKeyGenDistributedClient::initialize ( std::string  qryptToken)
pure virtual

Initializes the client.

Parameters
qryptTokenQrypt token to access Qrypt services

◆ initialize() [2/2]

virtual void QryptSecurity::IKeyGenDistributedClient::initialize ( std::string  qryptToken,
std::string  caCertPath 
)
pure virtual

Initializes the client.

Parameters
qryptTokenQrypt token to access Qrypt services
caCertPathAbsolute path to a CA Root Certificate for use with libCurl