com.virgilsecurity.crypto

Class VirgilCipherBase

java.lang.Object

com.virgilsecurity.crypto.VirgilCipherBase

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

VirgilChunkCipher, VirgilCipher, VirgilStreamCipher

public class VirgilCipherBase
extends Object
implements AutoCloseable

This class provides configuration methods to all Virgil Cipher classes.

Author:

Andrii Iakovenko

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	swigCMemOwn

Constructor Summary

Constructors

Modifier	Constructor and Description
	VirgilCipherBase() Create a new instance of VirgilCipherBase
protected	VirgilCipherBase(long cPtr, boolean cMemoryOwn)

Method Summary

Modifier and Type	Method and Description
void	addKeyRecipient(byte[] recipientId, byte[] publicKey) Add recipient defined with id and public key.
void	addPasswordRecipient(byte[] pwd) Add recipient defined with password.
void	close()
static byte[]	computeShared(byte[] publicKey, byte[] privateKey) Compute shared secret key on a given keys.
static byte[]	computeShared(byte[] publicKey, byte[] privateKey, byte[] privateKeyPassword) Compute shared secret key on a given keys.
VirgilCustomParams	customParams() Provide access to the object that handles custom parameters.
static long	defineContentInfoSize(byte[] data) Read content info size as part of the data.
void	delete()
protected void	finalize()
byte[]	getContentInfo() Get Virgil Security Cryptogram, that contains public algorithm parameters that was used for encryption.
protected static long	getCPtr(VirgilCipherBase obj)
boolean	keyRecipientExists(byte[] recipientId) Check whether recipient with given identifier exists.
boolean	passwordRecipientExists(byte[] password) Check whether recipient with given password exists.
void	removeAllRecipients() Remove all recipients.
void	removeKeyRecipient(byte[] recipientId) Remove recipient with given identifier.
void	removePasswordRecipient(byte[] pwd) Remove recipient with given password.
void	setContentInfo(byte[] contentInfo) Create content info object from ASN.1 structure.

Methods inherited from class java.lang.Object

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

Field Detail

swigCMemOwn

protected transient boolean swigCMemOwn

Constructor Detail

VirgilCipherBase

protected VirgilCipherBase(long cPtr,
                           boolean cMemoryOwn)

VirgilCipherBase

public VirgilCipherBase()

Create a new instance of VirgilCipherBase

Method Detail

getCPtr

protected static long getCPtr(VirgilCipherBase obj)

finalize

protected void finalize()

Overrides:

finalize in class Object

delete

public void delete()

close

public void close()

Specified by:

close in interface AutoCloseable

addKeyRecipient

public void addKeyRecipient(byte[] recipientId,
                            byte[] publicKey)

Add recipient defined with id and public key.

Parameters:

recipientId - Recipient's unique identifier, MUST not be empty.

publicKey - Recipient's public key, MUST not be empty.

removeKeyRecipient

public void removeKeyRecipient(byte[] recipientId)

Remove recipient with given identifier.

If recipient with given identifier is absent - do nothing.

Parameters:

recipientId - Recipient's unique identifier.

keyRecipientExists

public boolean keyRecipientExists(byte[] recipientId)

Check whether recipient with given identifier exists.

Search order:

• Local structures - useful when cipher is used for encryption.
• ContentInfo structure - useful when cipher is used for decryption.

Parameters:

recipientId - the recipient's unique identifier.

Returns:

true if recipient with given identifier exists, false - otherwise.

addPasswordRecipient

public void addPasswordRecipient(byte[] pwd)

Add recipient defined with password.

Use it for password based encryption.

Parameters:

pwd - Recipient's password, MUST not be empty.

removePasswordRecipient

public void removePasswordRecipient(byte[] pwd)

Remove recipient with given password.

If recipient with given password is absent - do nothing.

Parameters:

pwd - Recipient's password.

passwordRecipientExists

public boolean passwordRecipientExists(byte[] password)

Check whether recipient with given password exists.

Search order:

• Local structures - useful when cipher is used for encryption.

Parameters:

password - Recipient's unique identifier.

Returns:

true if recipient with given password exists, false - otherwise.

removeAllRecipients

public void removeAllRecipients()

Remove all recipients.

getContentInfo

public byte[] getContentInfo()

Get Virgil Security Cryptogram, that contains public algorithm parameters that was used for encryption.

Call this method after encryption process.

Returns:

Encrypted data info.

setContentInfo

public void setContentInfo(byte[] contentInfo)

Create content info object from ASN.1 structure.

Call this method before decryption process.

Parameters:

contentInfo - Virgil Security Cryptogram.

defineContentInfoSize

public static long defineContentInfoSize(byte[] data)

Read content info size as part of the data.

Parameters:

data - the data.

Returns:

Size of the content info if it is exist as part of the data, 0 - otherwise.

customParams

public VirgilCustomParams customParams()

Provide access to the object that handles custom parameters.

Use this method to add custom parameters to the content info object.

Use this method before encryption process.

Returns:

custom params.

computeShared

public static byte[] computeShared(byte[] publicKey,
                                   byte[] privateKey,
                                   byte[] privateKeyPassword)

Compute shared secret key on a given keys.

Keys SHOULD be of the identical type, i.e. both of type Curve25519.

Parameters:

publicKey - the public key.

privateKey - the private key.

privateKeyPassword - the private key password.

Returns:

the shared secret key.

computeShared

public static byte[] computeShared(byte[] publicKey,
                                   byte[] privateKey)

Compute shared secret key on a given keys.

Keys SHOULD be of the identical type, i.e. both of type Curve25519.

Parameters:

publicKey - the public key.

privateKey - the private key.

Returns:

the shared secret key.