org.waarp.common.crypto.ssl

Class WaarpSecureKeyStore

java.lang.Object

org.waarp.common.crypto.ssl.WaarpSecureKeyStore

public class WaarpSecureKeyStore
extends Object

SecureKeyStore for SLL

Constructor Summary

Constructors

Constructor and Description
WaarpSecureKeyStore(String keyStorePasswd, String keyPassword) Initialize empty KeyStore.
WaarpSecureKeyStore(String keyStoreFilename, String keyStorePasswd, String keyPassword) Initialize the SecureKeyStore with no TrustStore from file
WaarpSecureKeyStore(String keyStoreFilename, String keyStorePasswd, String keyPassword, String trustStoreFilename, String trustStorePasswd, boolean needClientAuthent) Initialize the SecureKeyStore and TrustStore from files

Method Summary

Modifier and Type	Method and Description
boolean	deleteKeyFromKeyStore(String alias) Delete a Key from the KeyStore based on its alias
boolean	deleteKeyFromTrustStore(String alias) Delete a Key from the TrustStore based on its alias
char[]	getCertificatePassword()
KeyManagerFactory	getKeyManagerFactory()
String	getKeyStoreFilename()
char[]	getKeyStorePassword()
char[]	getKeyTrustStorePassword()
WaarpSecureTrustManagerFactory	getSecureTrustManagerFactory()
boolean	initEmptyTrustStore() Initialize an empty TrustStore
void	initKeyStore(String keystoreFilename, String keystorePasswd, String keyPasswordNew) Initialize the SecureKeyStore with no TrustStore from file
void	initTrustStore(String truststoreFilename, String truststorePasswd, boolean needClientAuthent) Initialize the TrustStore from a filename and its password
static Certificate	loadX509Certificate(String filename) Load a certificate from a filename
boolean	saveKeyStore(String filename) Save a KeyStore to a file
boolean	saveTrustStore(String filename) Save the TrustStore to a file
boolean	setKeytoKeyStore(String alias, Key key, Certificate[] chain) Add a Key and its certificates into the KeyStore based on its alias
boolean	setKeytoTrustStore(String alias, Certificate cert) Add a Certificate into the TrustStore based on its alias

Methods inherited from class java.lang.Object

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

Constructor Detail

WaarpSecureKeyStore

public WaarpSecureKeyStore(String keyStorePasswd,
                           String keyPassword)
                    throws CryptoException

Initialize empty KeyStore. No TrustStore is internally created.

Parameters:

keyStorePasswd -

keyPassword -

Throws:

CryptoException

WaarpSecureKeyStore

public WaarpSecureKeyStore(String keyStoreFilename,
                           String keyStorePasswd,
                           String keyPassword)
                    throws CryptoException

Initialize the SecureKeyStore with no TrustStore from file

Parameters:

keyStoreFilename -

keyStorePasswd -

keyPassword -

Throws:

CryptoException

WaarpSecureKeyStore

public WaarpSecureKeyStore(String keyStoreFilename,
                           String keyStorePasswd,
                           String keyPassword,
                           String trustStoreFilename,
                           String trustStorePasswd,
                           boolean needClientAuthent)
                    throws CryptoException

Initialize the SecureKeyStore and TrustStore from files

Parameters:

keyStoreFilename -

keyStorePasswd -

keyPassword -

trustStoreFilename - if Null, no TrustKeyStore will be created

trustStorePasswd -

needClientAuthent - True if the TrustStore is also used for Client Authentication

Throws:

CryptoException

Method Detail

initKeyStore

public void initKeyStore(String keystoreFilename,
                         String keystorePasswd,
                         String keyPasswordNew)
                  throws CryptoException

Initialize the SecureKeyStore with no TrustStore from file

Parameters:

keystoreFilename -

keystorePasswd -

keyPasswordNew -

Throws:

CryptoException

deleteKeyFromKeyStore

public boolean deleteKeyFromKeyStore(String alias)

Delete a Key from the KeyStore based on its alias

Parameters:

alias -

Returns:

True if entry is deleted

setKeytoKeyStore

public boolean setKeytoKeyStore(String alias,
                                Key key,
                                Certificate[] chain)

Add a Key and its certificates into the KeyStore based on its alias

Parameters:

alias -

key -

chain -

Returns:

True if entry is added

saveKeyStore

public boolean saveKeyStore(String filename)

Save a KeyStore to a file

Parameters:

filename -

Returns:

True if keyStore is saved to file

initTrustStore

public void initTrustStore(String truststoreFilename,
                           String truststorePasswd,
                           boolean needClientAuthent)
                    throws CryptoException

Initialize the TrustStore from a filename and its password

Parameters:

truststoreFilename -

truststorePasswd -

needClientAuthent - True if the TrustStore is also to authenticate clients

Throws:

CryptoException

initEmptyTrustStore

public boolean initEmptyTrustStore()

Initialize an empty TrustStore

Returns:

True if correctly initialized empty

deleteKeyFromTrustStore

public boolean deleteKeyFromTrustStore(String alias)

Delete a Key from the TrustStore based on its alias

Parameters:

alias -

Returns:

True if entry is deleted

setKeytoTrustStore

public boolean setKeytoTrustStore(String alias,
                                  Certificate cert)

Add a Certificate into the TrustStore based on its alias

Parameters:

alias -

cert -

Returns:

True if entry is added

saveTrustStore

public boolean saveTrustStore(String filename)

Save the TrustStore to a file

Parameters:

filename -

Returns:

True if keyTrustStore is saved to file

loadX509Certificate

public static Certificate loadX509Certificate(String filename)
                                       throws CertificateException,
                                              FileNotFoundException

Load a certificate from a filename

Parameters:

filename -

Returns:

the X509 Certificate from filename

Throws:

CertificateException

FileNotFoundException

getCertificatePassword

public char[] getCertificatePassword()

Returns:

the certificate Password

getKeyStorePassword

public char[] getKeyStorePassword()

Returns:

the KeyStore Password

getKeyTrustStorePassword

public char[] getKeyTrustStorePassword()

Returns:

the KeyTrustStore Password

getKeyStoreFilename

public String getKeyStoreFilename()

Returns:

the KeyStore Filename

getSecureTrustManagerFactory

public WaarpSecureTrustManagerFactory getSecureTrustManagerFactory()

Returns:

the secureTrustManagerFactory

getKeyManagerFactory

public KeyManagerFactory getKeyManagerFactory()

Returns:

the keyManagerFactory