This class provides high-level interface to encrypt / decrypt data using Virgil Security keys. More...

#include <VirgilCipher.h>

Inheritance diagram for virgil::crypto::VirgilCipher:

Public Member Functions
VirgilByteArray	encrypt (const VirgilByteArray &data, bool embedContentInfo=true)
	Encrypt given data. More...

VirgilByteArray	decryptWithKey (const VirgilByteArray &encryptedData, const VirgilByteArray &recipientId, const VirgilByteArray &privateKey, const VirgilByteArray &privateKeyPassword=VirgilByteArray())
	Decrypt given data for recipient defined by id and private key. More...

VirgilByteArray	decryptWithPassword (const VirgilByteArray &encryptedData, const VirgilByteArray &pwd)
	Decrypt given data for recipient defined by password. More...

Public Member Functions inherited from virgil::crypto::VirgilCipherBase
	VirgilCipherBase ()
	Initialize submodules.

void	addKeyRecipient (const VirgilByteArray &recipientId, const VirgilByteArray &publicKey)
	Add recipient defined with id and public key. More...

void	removeKeyRecipient (const VirgilByteArray &recipientId)
	Remove recipient with given identifier. More...

bool	keyRecipientExists (const VirgilByteArray &recipientId) const
	Check whether recipient with given identifier exists. More...

void	addPasswordRecipient (const VirgilByteArray &pwd)
	Add recipient defined with password. More...

void	removePasswordRecipient (const VirgilByteArray &pwd)
	Remove recipient with given password. More...

bool	passwordRecipientExists (const VirgilByteArray &password) const
	Check whether recipient with given password exists. More...

void	removeAllRecipients ()
	Remove all recipients.

VirgilCustomParams &	customParams ()
	Provide access to the object that handles custom parameters. More...

const VirgilCustomParams &	customParams () const
	Provide readonly access to the object that handles custom parameters. More...

VirgilByteArray	getContentInfo () const
	Return content info. More...

void	setContentInfo (const VirgilByteArray &contentInfo)
	Create content info object from ASN.1 structure. More...

Additional Inherited Members
Static Public Member Functions inherited from virgil::crypto::VirgilCipherBase
static VirgilByteArray	computeShared (const VirgilByteArray &publicKey, const VirgilByteArray &privateKey, const VirgilByteArray &privateKeyPassword=VirgilByteArray())
	Compute shared secret key on a given keys. More...

static size_t	defineContentInfoSize (const VirgilByteArray &data)
	Read content info size as part of the data. More...

Protected Member Functions inherited from virgil::crypto::VirgilCipherBase
VirgilByteArray	filterAndSetupContentInfo (const VirgilByteArray &encryptedData, bool isLastChunk)
	Extract content info from the encrypted data and setup it. More...

void	initEncryption ()
	Configures symmetric cipher for encryption. More...

void	initDecryptionWithPassword (const VirgilByteArray &pwd)
	Stores recipient's password that is used for cipher's key decryption when content becomes available. More...

void	initDecryptionWithKey (const VirgilByteArray &recipientId, const VirgilByteArray &privateKey, const VirgilByteArray &privateKeyPassword)
	Stores recipient's information that is used for cipher's key decryption when content becomes available. More...

bool	isInited () const

bool	isReadyForEncryption () const

bool	isReadyForDecryption () const

virgil::crypto::foundation::VirgilSymmetricCipher &	getSymmetricCipher ()
	Return symmetric cipher configure by one of the methods: initEncryption(), initDecryptionWithPassword(), initDecryptionWithKey.

void	buildContentInfo ()
	Build VirgilContentInfo object. More...

void	clear ()
	Clear all information related to the cipher. More...

Detailed Description

This class provides high-level interface to encrypt / decrypt data using Virgil Security keys.

Member Function Documentation

VirgilByteArray virgil::crypto::VirgilCipher::decryptWithKey	(	const VirgilByteArray &	encryptedData,
		const VirgilByteArray &	recipientId,
		const VirgilByteArray &	privateKey,
		const VirgilByteArray &	privateKeyPassword = `VirgilByteArray()`
	)

Decrypt given data for recipient defined by id and private key.

Note: Content info MUST be defined, if it was not embedded to the encrypted data.

See also: method setContentInfo().

Returns: Decrypted data.

VirgilByteArray virgil::crypto::VirgilCipher::decryptWithPassword	(	const VirgilByteArray &	encryptedData,
		const VirgilByteArray &	pwd
	)

Decrypt given data for recipient defined by password.

Note: Content info MUST be defined, if it was not embedded to the encrypted data.

See also: method setContentInfo().

Returns: Decrypted data.

VirgilByteArray virgil::crypto::VirgilCipher::encrypt	(	const VirgilByteArray &	data,
		bool	embedContentInfo = `true`
	)

Encrypt given data.

Parameters

data	- data to be encrypted.
embedContentInfo	- determines whether to embed content info the the encrypted data, or not.

Note: Store content info to use it for decription process, if embedContentInfo parameter is false.

See also: getContentInfo()

Returns: encrypted data.

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

include/virgil/crypto/VirgilCipher.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation