com.virgilsecurity.sdk.crypto

Class CipherBase

java.lang.Object

com.virgilsecurity.sdk.crypto.CipherBase

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

ChunkCipher, Cipher, StreamCipher

public class CipherBase
extends Object
implements AutoCloseable

This class provides basic functionality of a cryptographic cipher for encryption and decryption.

Author:

Andrii Iakovenko

Field Summary

Fields

Modifier and Type	Field and Description
protected VirgilCipherBase	cipher

Constructor Summary

Constructors

Modifier	Constructor and Description
	CipherBase() Create a new instance of CipherBase
protected	CipherBase(VirgilCipherBase cipher) Create a new instance of CipherBase

Method Summary

Modifier and Type	Method and Description
void	addKeyRecipient(Recipient recipient, PublicKey publicKey) Add key recipient to Cipher.
void	addKeyRecipient(String recipientId, PublicKey publicKey) Add key recipient to Cipher.
void	addPasswordRecipient(Password password) Add password recipient to Cipher.
void	addPasswordRecipient(String password) Add password recipient to Cipher.
void	close()
CustomParams	customParams()
static long	defineContentInfoSize(byte[] data) Define size of content information.
byte[]	getContentInfo() Returns the content information.
void	removeAllRecipients() Remove all recipients from Cipher.
void	removeKeyRecipient(Recipient recipient) Remove key recipient from Cipher.
void	removePasswordRecipient(Password password) Remove password recipient from Cipher.
void	setContentInfo(byte[] contentInfo) Sets the content information.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cipher

protected VirgilCipherBase cipher

Constructor Detail

CipherBase

public CipherBase()

Create a new instance of CipherBase

CipherBase

protected CipherBase(VirgilCipherBase cipher)

Create a new instance of CipherBase

Parameters:

cipher - the VirgilCipherBase which will be wrapped by this istance of CipherBase.

Method Detail

addKeyRecipient

public void addKeyRecipient(Recipient recipient,
                            PublicKey publicKey)

Add key recipient to Cipher.

Parameters:

recipient - the recipient.

publicKey - the public key of recipient.

See Also:

Recipient, PublicKey

addKeyRecipient

public void addKeyRecipient(String recipientId,
                            PublicKey publicKey)

Add key recipient to Cipher.

Parameters:

recipientId - the recipient's identifier.

publicKey - the public key of recipient.

removeKeyRecipient

public void removeKeyRecipient(Recipient recipient)

Remove key recipient from Cipher.

Parameters:

recipient - the recipient

addPasswordRecipient

public void addPasswordRecipient(Password password)

Add password recipient to Cipher.

Parameters:

password - the password for data encryption.

addPasswordRecipient

public void addPasswordRecipient(String password)

Add password recipient to Cipher.

Parameters:

password - the password for data encryption.

removePasswordRecipient

public void removePasswordRecipient(Password password)

Remove password recipient from Cipher.

Parameters:

password - the password to be removed.

removeAllRecipients

public void removeAllRecipients()

Remove all recipients from Cipher.

getContentInfo

public byte[] getContentInfo()

Returns the content information.

Returns:

the content information.

setContentInfo

public void setContentInfo(byte[] contentInfo)

Sets the content information.

Parameters:

contentInfo - the content information.

defineContentInfoSize

public static long defineContentInfoSize(byte[] data)

Define size of content information.

Parameters:

data - the content information.

Returns:

the size of content information

customParams

public CustomParams customParams()

Returns:

the custom parameters.

See Also:

CustomParams

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception