com.virgilsecurity.crypto

Class VirgilKeyPair

java.lang.Object

com.virgilsecurity.crypto.VirgilKeyPair

All Implemented Interfaces:

AutoCloseable

public class VirgilKeyPair
extends Object
implements AutoCloseable

This class handles information about Virgil Security key pair.

Author:

Andrii Iakovenko

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VirgilKeyPair.Type Type of the keypair.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	swigCMemOwn

Constructor Summary

Constructors

Modifier	Constructor and Description
	VirgilKeyPair(byte[] publicKey, byte[] privateKey) Create a new instance of VirgilKeyPair
protected	VirgilKeyPair(long cPtr, boolean cMemoryOwn)
	VirgilKeyPair(VirgilKeyPair other) Create a new instance of VirgilKeyPair

Method Summary

Modifier and Type	Method and Description
static boolean	checkPrivateKeyPassword(byte[] key, byte[] pwd) Check if given private key and it's password matches.
void	close()
static byte[]	decryptPrivateKey(byte[] privateKey, byte[] privateKeyPassword) Decrypt the given private key and return result.
void	delete()
static byte[]	encryptPrivateKey(byte[] privateKey, byte[] privateKeyPassword) Encrypt the given private key and return result.
static byte[]	extractPublicKey(byte[] privateKey, byte[] privateKeyPassword) Extract public key from the private key.
protected void	finalize()
static VirgilKeyPair	generate(VirgilKeyPair.Type type) Generate new key pair given type.
static VirgilKeyPair	generate(VirgilKeyPair.Type type, byte[] pwd) Generate new key pair given type.
static VirgilKeyPair	generateFrom(VirgilKeyPair donorKeyPair) Generate new key pair of the same type based on the donor key pair.
static VirgilKeyPair	generateFrom(VirgilKeyPair donorKeyPair, byte[] donorPrivateKeyPassword) Generate new key pair of the same type based on the donor key pair.
static VirgilKeyPair	generateFrom(VirgilKeyPair donorKeyPair, byte[] donorPrivateKeyPassword, byte[] newKeyPairPassword) Generate new key pair of the same type based on the donor key pair.
static VirgilKeyPair	generateRecommended() Generate new key pair with recommended most safe type.
static VirgilKeyPair	generateRecommended(byte[] pwd) Generate new key pair with recommended most safe type.
protected static long	getCPtr(VirgilKeyPair obj)
static boolean	isKeyPairMatch(byte[] publicKey, byte[] privateKey) Check if a public-private pair of keys matches.
static boolean	isKeyPairMatch(byte[] publicKey, byte[] privateKey, byte[] privateKeyPassword) Check if a public-private pair of keys matches.
static boolean	isPrivateKeyEncrypted(byte[] privateKey) Check if given private key is encrypted.
byte[]	privateKey() Provide access to the private key.
static byte[]	privateKeyToDER(byte[] privateKey) Convert given private key to the DER format.
static byte[]	privateKeyToDER(byte[] privateKey, byte[] privateKeyPassword) Convert given private key to the DER format.
static byte[]	privateKeyToPEM(byte[] privateKey) Convert given private key to the PEM format.
static byte[]	privateKeyToPEM(byte[] privateKey, byte[] privateKeyPassword) Convert given private key to the PEM format.
byte[]	publicKey() Provide access to the public key.
static byte[]	publicKeyToDER(byte[] publicKey) Convert given public key to the DER format.
static byte[]	publicKeyToPEM(byte[] publicKey) Convert given public key to the PEM format.
static byte[]	resetPrivateKeyPassword(byte[] privateKey, byte[] oldPassword, byte[] newPassword) Reset password for the given private key.

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

VirgilKeyPair

protected VirgilKeyPair(long cPtr,
                        boolean cMemoryOwn)

VirgilKeyPair

public VirgilKeyPair(byte[] publicKey,
                     byte[] privateKey)

Create a new instance of VirgilKeyPair

Parameters:

publicKey -

privateKey -

VirgilKeyPair

public VirgilKeyPair(VirgilKeyPair other)

Create a new instance of VirgilKeyPair

Parameters:

other - the source key pair.

Method Detail

getCPtr

protected static long getCPtr(VirgilKeyPair obj)

finalize

protected void finalize()

Overrides:

finalize in class Object

delete

public void delete()

close

public void close()

Specified by:

close in interface AutoCloseable

generate

public static VirgilKeyPair generate(VirgilKeyPair.Type type,
                                     byte[] pwd)

Generate new key pair given type.

Parameters:

type - the private key type to be generated.

pwd - the private key password.

Returns:

generated key pair.

generate

public static VirgilKeyPair generate(VirgilKeyPair.Type type)

Generate new key pair given type.

Parameters:

type - the private key type to be generated.

Returns:

generated key pair.

generateRecommended

public static VirgilKeyPair generateRecommended(byte[] pwd)

Generate new key pair with recommended most safe type.

Parameters:

pwd - Private key password.

Returns:

generated key pair.

generateRecommended

public static VirgilKeyPair generateRecommended()

Generate new key pair with recommended most safe type.

Returns:

generated key pair.

generateFrom

public static VirgilKeyPair generateFrom(VirgilKeyPair donorKeyPair,
                                         byte[] donorPrivateKeyPassword,
                                         byte[] newKeyPairPassword)

Generate new key pair of the same type based on the donor key pair.

Parameters:

donorKeyPair - Public key or private key is used to determine the new key pair type.

donorPrivateKeyPassword - Donor private key password, optional if public key is defined.

newKeyPairPassword - Private key password of the new key pair.

Returns:

generated key pair.

generateFrom

public static VirgilKeyPair generateFrom(VirgilKeyPair donorKeyPair,
                                         byte[] donorPrivateKeyPassword)

Generate new key pair of the same type based on the donor key pair.

Parameters:

donorKeyPair - Public key or private key is used to determine the new key pair type.

donorPrivateKeyPassword - Donor private key password, optional if public key is defined.

Returns:

generated key pair.

generateFrom

public static VirgilKeyPair generateFrom(VirgilKeyPair donorKeyPair)

Generate new key pair of the same type based on the donor key pair.

Parameters:

donorKeyPair - Public key or private key is used to determine the new key pair type.

Returns:

generated key pair.

isKeyPairMatch

public static boolean isKeyPairMatch(byte[] publicKey,
                                     byte[] privateKey,
                                     byte[] privateKeyPassword)

Check if a public-private pair of keys matches.

Parameters:

publicKey - Public key in DER or PEM format.

privateKey - Private key in DER or PEM format.

privateKeyPassword - Private key password if exists.

Returns:

true if keys matche.

isKeyPairMatch

public static boolean isKeyPairMatch(byte[] publicKey,
                                     byte[] privateKey)

Check if a public-private pair of keys matches.

Parameters:

publicKey - Public key in DER or PEM format.

privateKey - Private key in DER or PEM format.

Returns:

true if keys matche.

checkPrivateKeyPassword

public static boolean checkPrivateKeyPassword(byte[] key,
                                              byte[] pwd)

Check if given private key and it's password matches.

Parameters:

key - Private key in DER or PEM format.

pwd - Private key password.

Returns:

true if private key and it's password matches.

isPrivateKeyEncrypted

public static boolean isPrivateKeyEncrypted(byte[] privateKey)

Check if given private key is encrypted.

Parameters:

privateKey - Private key in DER or PEM format.

Returns:

true - if private key is encrypted.

resetPrivateKeyPassword

public static byte[] resetPrivateKeyPassword(byte[] privateKey,
                                             byte[] oldPassword,
                                             byte[] newPassword)

Reset password for the given private key.

Re-encrypt given Private Key with a new password.

Parameters:

privateKey - Private key that is encrypted with old password.

oldPassword - Current Private Key password.

newPassword - New Private Key password.

Returns:

Private key that is encrypted with the new password.

encryptPrivateKey

public static byte[] encryptPrivateKey(byte[] privateKey,
                                       byte[] privateKeyPassword)

Encrypt the given private key and return result.

Parameters:

privateKey - Private key in the plain text.

privateKeyPassword - New Private Key password.

Returns:

Encrypted private key in PKCS#8 format.

decryptPrivateKey

public static byte[] decryptPrivateKey(byte[] privateKey,
                                       byte[] privateKeyPassword)

Decrypt the given private key and return result.

Parameters:

privateKey - Encrypted Private Key.

privateKeyPassword - Current Private Key password.

Returns:

Plain (non encrypted) private key.

extractPublicKey

public static byte[] extractPublicKey(byte[] privateKey,
                                      byte[] privateKeyPassword)

Extract public key from the private key.

Parameters:

privateKey - Private key.

privateKeyPassword - Private key password.

Returns:

Public key.

publicKeyToPEM

public static byte[] publicKeyToPEM(byte[] publicKey)

Convert given public key to the PEM format.

Parameters:

publicKey - Public key to be converted.

Returns:

Public key in the PEM format.

publicKeyToDER

public static byte[] publicKeyToDER(byte[] publicKey)

Convert given public key to the DER format.

Parameters:

publicKey - Public key to be converted.

Returns:

Public key in the DER format.

privateKeyToPEM

public static byte[] privateKeyToPEM(byte[] privateKey,
                                     byte[] privateKeyPassword)

Convert given private key to the PEM format.

Parameters:

privateKey - Private key to be converted.

privateKeyPassword - Private key password.

Returns:

Private key in the PEM format.

privateKeyToPEM

public static byte[] privateKeyToPEM(byte[] privateKey)

Convert given private key to the PEM format.

Parameters:

privateKey - Private key to be converted.

Returns:

Private key in the PEM format.

privateKeyToDER

public static byte[] privateKeyToDER(byte[] privateKey,
                                     byte[] privateKeyPassword)

Convert given private key to the DER format.

Parameters:

privateKey - Private key to be converted.

privateKeyPassword - Private key password.

Returns:

Private key in the DER format.

privateKeyToDER

public static byte[] privateKeyToDER(byte[] privateKey)

Convert given private key to the DER format.

Parameters:

privateKey - Private key to be converted.

Returns:

Private key in the DER format.

publicKey

public byte[] publicKey()

Provide access to the public key.

Returns:

the public key.

privateKey

public byte[] privateKey()

Provide access to the private key.

Returns:

the private key.