Virgil Security Crypto library  2.6.3
Public Member Functions | List of all members
virgil::crypto::pfs::VirgilPFSSession Class Reference

This is model object that represent session in PFS communication. More...

#include <VirgilPFSSession.h>

Public Member Functions

 VirgilPFSSession ()
 Create empty session.
 
 VirgilPFSSession (VirgilByteArray identifier, VirgilByteArray encryptionSecretKey, VirgilByteArray decryptionSecretKey, VirgilByteArray additionalData)
 
bool isEmpty () const
 
const VirgilByteArray & getIdentifier () const
 Getter. More...
 
const VirgilByteArray & getEncryptionSecretKey () const
 Getter. More...
 
const VirgilByteArray & getDecryptionSecretKey () const
 Getter. More...
 
const VirgilByteArray & getAdditionalData () const
 Getter. More...
 

Detailed Description

This is model object that represent session in PFS communication.

Session is a set of parameters that is unique for each communication.

See also
VirgilPFS

Constructor & Destructor Documentation

virgil::crypto::pfs::VirgilPFSSession::VirgilPFSSession ( VirgilByteArray  identifier,
VirgilByteArray  encryptionSecretKey,
VirgilByteArray  decryptionSecretKey,
VirgilByteArray  additionalData 
)
Parameters
identifier- session unique identifier.
encryptionSecretKey- key that is used for encryption.
decryptionSecretKey- key that is used for decryption.
additionalData- data that is associated with both sides that is used in communication.

Member Function Documentation

const VirgilByteArray& virgil::crypto::pfs::VirgilPFSSession::getAdditionalData ( ) const

Getter.

See also
VirgilPFSSession()
const VirgilByteArray& virgil::crypto::pfs::VirgilPFSSession::getDecryptionSecretKey ( ) const

Getter.

See also
VirgilPFSSession()
const VirgilByteArray& virgil::crypto::pfs::VirgilPFSSession::getEncryptionSecretKey ( ) const

Getter.

See also
VirgilPFSSession()
const VirgilByteArray& virgil::crypto::pfs::VirgilPFSSession::getIdentifier ( ) const

Getter.

See also
VirgilPFSSession()
bool virgil::crypto::pfs::VirgilPFSSession::isEmpty ( ) const
Returns
True if session is not defined.

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