Package convex.core.crypto

Class PFXTools

java.lang.Object

convex.core.crypto.PFXTools

public class PFXTools
extends Object

Utility class for working with Java Key Stores

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEYSTORE_TYPE

Constructor Summary

Constructors

Constructor	Description
PFXTools()

Method Summary

Modifier and Type	Method	Description
static KeyStore	createStore(File keyFile, String passPhrase)	Creates a new PKCS12 key store.
static AKeyPair	getKeyPair(KeyStore ks, String alias, String passphrase)	Retrieves a key pair from a key store.
static KeyStore	loadStore(File keyFile, String passPhrase)	Loads an existing PKCS12 Key store.
static KeyStore	saveStore(KeyStore ks, File keyFile, String passPhrase)	Saves a PKCS12 Key store to disk.
static KeyStore	setKeyPair(KeyStore ks, AKeyPair kp, String passPhrase)	Adds a key pair to a key store.
static KeyStore	setKeyPair(KeyStore ks, String alias, AKeyPair kp, String passPhrase)	Adds a key pair to a key store.

Methods inherited from class java.lang.Object

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

Field Details

KEYSTORE_TYPE

public static final String KEYSTORE_TYPE

See Also:

• Constant Field Values

Constructor Details

PFXTools

public PFXTools()

Method Details

createStore

public static KeyStore createStore(File keyFile,
 String passPhrase)
                            throws GeneralSecurityException,
IOException

Creates a new PKCS12 key store.

Parameters:

keyFile - File to use for creating the key store

passPhrase - Passphrase used to protect the key store, may be null

Returns:

New KeyStore instance

Throws:

GeneralSecurityException

IOException

loadStore

public static KeyStore loadStore(File keyFile,
 String passPhrase)
                          throws IOException,
GeneralSecurityException

Loads an existing PKCS12 Key store.

Parameters:

keyFile - File for the existing key store

passPhrase - Passphrase for decrypting the key store. May be blank or null if not encrypted.

Returns:

Found key store

Throws:

IOException - If an IO error occurs

GeneralSecurityException - If a security error occurs

saveStore

public static KeyStore saveStore(KeyStore ks,
 File keyFile,
 String passPhrase)
                          throws GeneralSecurityException,
IOException

Saves a PKCS12 Key store to disk.

Parameters:

ks - Key store to save

keyFile - Target file

passPhrase - Passphrase for encrypting the key store. May be blank or null if not need for encryption.

Returns:

Same key store instance.

Throws:

IOException - If an IO error occurs accessing the key store

GeneralSecurityException - if a security exception occurs

getKeyPair

public static AKeyPair getKeyPair(KeyStore ks,
 String alias,
 String passphrase)
                           throws UnrecoverableKeyException,
KeyStoreException,
NoSuchAlgorithmException

Retrieves a key pair from a key store.

Parameters:

ks - Key store

alias - Alias used for finding the key pair in the store

passphrase - Passphrase used for decrypting the key pair. Mandatory.

Returns:

Found key pair

Throws:

UnrecoverableKeyException

KeyStoreException

NoSuchAlgorithmException

setKeyPair

public static KeyStore setKeyPair(KeyStore ks,
 AKeyPair kp,
 String passPhrase)
                           throws IOException,
GeneralSecurityException

Adds a key pair to a key store.

Parameters:

ks - Key store

kp - Key pair

passPhrase - Passphrase for encrypting the key pair. Mandatory.

Returns:

Updated key store.

Throws:

IOException - If an IO error occurs accessing the key store

GeneralSecurityException - if a security exception occurs

setKeyPair

public static KeyStore setKeyPair(KeyStore ks,
 String alias,
 AKeyPair kp,
 String passPhrase)
                           throws IOException,
GeneralSecurityException

Adds a key pair to a key store.

Parameters:

ks - Key store

alias - Alias entry for keystore

kp - Key pair

passPhrase - Passphrase for encrypting the key pair. Mandatory.

Returns:

Updated key store.

Throws:

IOException - If an IO error occurs accessing the key store

GeneralSecurityException - if a security exception occurs