com.virgilsecurity.sdk.highlevel

Class VirgilKey

java.lang.Object

com.virgilsecurity.sdk.highlevel.VirgilKey

public class VirgilKey
extends Object

This class allows to store Virgil Keys in a storage.

Author:

Andrii Iakovenko

Method Summary

Modifier and Type	Method and Description
CreateCardRequest	buildCardRequest(String identity, String type) Build Create Card Request
CreateCardRequest	buildCardRequest(String identity, String type, Map<String,String> data) Build Create Card Request
static VirgilKey	create(String keyName) Creates a VirgilKey with specified key name.
static VirgilKey	create(String keyName, KeyPair keyPair) Creates a new VirgilKey with custom Public/Private key pair.
static VirgilKey	create(String keyName, KeyPair keyPair, String password) Creates a new VirgilKey with custom Public/Private key pair.
static VirgilKey	create(String keyName, String password) Creates a VirgilKey with specified key name.
byte[]	decrypt(byte[] cipherData) Decrypts the specified cipherdata using VirgilKey.
byte[]	decryptThenVerify(byte[] cipherData, VirgilCard signer) Decrypts and verifies the data.
void	destroy() Destroys the current VirgilKey.
byte[]	export() Exports the VirgilKey to default Virgil Security format.
byte[]	export(String password) Exports the VirgilKey to default Virgil Security format.
String	getKeyName()
KeyPair	getKeyPair()
static VirgilKey	load(String keyName) Loads the VirgilKey by specified key name.
static VirgilKey	load(String keyName, String password) Loads the VirgilKey by specified key name.
void	setKeyName(String keyName)
void	setKeyPair(KeyPair keyPair)
byte[]	sign(byte[] data) Generates a digital signature for specified data using current VirgilKey.
void	signRequest(SignedRequest request, String appId) Signs the request as authority.
byte[]	signThenEncrypt(byte[] data, List<VirgilCard> recipients) Encrypts and signs the data.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static VirgilKey create(String keyName,
                               KeyPair keyPair)

Creates a new VirgilKey with custom Public/Private key pair.

Parameters:

keyName - Name of the key.

keyPair - The key pair.

Returns:

The instance of VirgilKey.

create

public static VirgilKey create(String keyName,
                               KeyPair keyPair,
                               String password)

Creates a new VirgilKey with custom Public/Private key pair.

Parameters:

keyName - Name of the key.

keyPair - The key pair.

password - The password.

Returns:

The instance of VirgilKey.

Throws:

EmptyArgumentException - if key name is blank.

NullArgumentException - if key pair is null.

VirgilKeyIsAlreadyExistsException - if key with the same name already exists at storage.

create

public static VirgilKey create(String keyName)

Creates a VirgilKey with specified key name.

Parameters:

keyName - Name of the key.

Returns:

The instance of VirgilKey.

create

public static VirgilKey create(String keyName,
                               String password)

Creates a VirgilKey with specified key name.

Parameters:

keyName - Name of the key.

password - The password.

Returns:

The instance of VirgilKey.

load

public static VirgilKey load(String keyName)

Loads the VirgilKey by specified key name.

Parameters:

keyName - Name of the key.

Returns:

The instance of VirgilKey.

load

public static VirgilKey load(String keyName,
                             String password)

Loads the VirgilKey by specified key name.

Parameters:

keyName - Name of the key.

password - The password.

Returns:

The instance of VirgilKey.

export

public byte[] export()

Exports the VirgilKey to default Virgil Security format.

Returns:

The private key as byte array.

export

public byte[] export(String password)

Exports the VirgilKey to default Virgil Security format.

Parameters:

password - The password.

Returns:

The private key as byte array.

sign

public byte[] sign(byte[] data)

Generates a digital signature for specified data using current VirgilKey.

Parameters:

data - The data for which the digital signature will be generated.

Returns:

A byte array containing the result from performing the operation.

Throws:

NullArgumentException - if data is null.

decrypt

public byte[] decrypt(byte[] cipherData)

Decrypts the specified cipherdata using VirgilKey.

Parameters:

cipherData - The encrypted data.

Returns:

A byte array containing the result from performing the operation.

Throws:

NullArgumentException - if cipherData is null.

signThenEncrypt

public byte[] signThenEncrypt(byte[] data,
                              List<VirgilCard> recipients)

Encrypts and signs the data.

Parameters:

data - The data to be encrypted.

recipients - The list of VirgilCard recipients.

Returns:

The encrypted data.

Throws:

NullArgumentException - if recipients list is null.

decryptThenVerify

public byte[] decryptThenVerify(byte[] cipherData,
                                VirgilCard signer)

Decrypts and verifies the data.

Parameters:

cipherData - The data to be decrypted.

signer - The signer's VirgilCard.

Returns:

The decrypted data, which is the original plain text before encryption.

buildCardRequest

public CreateCardRequest buildCardRequest(String identity,
                                          String type)

Build Create Card Request

Parameters:

identity - The identity.

type - The identity type.

Returns:

The Create Card Request.

buildCardRequest

public CreateCardRequest buildCardRequest(String identity,
                                          String type,
                                          Map<String,String> data)

Build Create Card Request

Parameters:

identity - The identity.

type - The identity type.

data - The metadata.

Returns:

The Create Card Request.

signRequest

public void signRequest(SignedRequest request,
                        String appId)

Signs the request as authority.

Parameters:

request - The request to sign.

appId - The application identifier.

destroy

public void destroy()

Destroys the current VirgilKey.

getKeyPair

public KeyPair getKeyPair()

Returns:

the keyPair

setKeyPair

public void setKeyPair(KeyPair keyPair)

Parameters:

keyPair - the keyPair to set

getKeyName

public String getKeyName()

Returns:

the keyName

setKeyName

public void setKeyName(String keyName)

Parameters:

keyName - the keyName to set