org.nhindirect.common.crypto

Interface MutableKeyStoreProtectionManager

All Superinterfaces:

KeyStoreProtectionManager

All Known Implementing Classes:

AbstractPKCS11TokenKeyStoreProtectionManager, DynamicPKCS11TokenKeyStoreProtectionManager, StaticCachedPKCS11TokenKeyStoreProtectionManager, StaticPKCS11TokenKeyStoreProtectionManager

public interface MutableKeyStoreProtectionManager
extends KeyStoreProtectionManager

Interface for setting and clearing the secret keys for keystore and private key protection. This interface is implemented by stores that allow manipulation of the key material.

This interface assumes that key material is generated outside of the key store manager.

Since:

1.3

Author:

Greg Meyer

Method Summary

Modifier and Type	Method and Description
void	clearEntry(String alias) Generic method to clear an arbitrary entry.
void	clearKey(String alias) Generic method to clear an arbitrary key.
void	clearKeyStoreProtectionKey() Clears the key use to protect the key store.
void	clearPrivateKeyProtectionKey() Clears the key use to protect the private key.
KeyStore	getKS() Gets the underlying KeyStore object.
void	setEntry(String alias, KeyStore.Entry entry) Generic method to set an arbitrary entry.
void	setKey(String alias, Key key) Generic method to set an arbitrary key.
void	setKeyStoreProtectionKey(Key key) Sets key used to protect the key store as a Key object.
void	setKeyStoreProtectionKeyAsBytes(byte[] key) Sets key used to protect the key store as a byte array.
void	setKeyStoreProtectionKeyAsString(String key) Sets key used to protect the key store as a string.
void	setPrivateKeyProtectionKey(Key key) Sets key used to protect the private key as a Key object.
void	setPrivateKeyProtectionKeyAsBytes(byte[] key) Sets the key used to protect the private key as a byte array.
void	setPrivateKeyProtectionKeyAsString(String key) Sets the key used to protect the private key as a string.

Methods inherited from interface org.nhindirect.common.crypto.KeyStoreProtectionManager

getAllEntries, getAllKeys, getEntry, getKey, getKeyStoreProtectionKey, getPrivateKeyProtectionKey

Method Detail

setPrivateKeyProtectionKey

void setPrivateKeyProtectionKey(Key key)
                         throws CryptoException

Sets key used to protect the private key as a Key object.

Parameters:

key - The key used to protect private keys.

Throws:

CryptoException

setPrivateKeyProtectionKeyAsBytes

void setPrivateKeyProtectionKeyAsBytes(byte[] key)
                                throws CryptoException

Sets the key used to protect the private key as a byte array.

Parameters:

key - The key used to protect private keys.

Throws:

CryptoException

setPrivateKeyProtectionKeyAsString

void setPrivateKeyProtectionKeyAsString(String key)
                                 throws CryptoException

Sets the key used to protect the private key as a string. This is useful when pass phrases are generated by a plain text tool.

Parameters:

key - The key used to protect private keys.

Throws:

CryptoException

clearPrivateKeyProtectionKey

void clearPrivateKeyProtectionKey()
                           throws CryptoException

Clears the key use to protect the private key. Some implementations require that the key be cleared before a new value can be set. For deterministic results, you should always clear the key before setting a new value.

Throws:

CryptoException

setKeyStoreProtectionKey

void setKeyStoreProtectionKey(Key key)
                       throws CryptoException

Sets key used to protect the key store as a Key object.

Parameters:

key - The key used to protect the key store.

Throws:

CryptoException

setKeyStoreProtectionKeyAsBytes

void setKeyStoreProtectionKeyAsBytes(byte[] key)
                              throws CryptoException

Sets key used to protect the key store as a byte array.

Parameters:

key - The key used to protect the key store.

Throws:

CryptoException

setKeyStoreProtectionKeyAsString

void setKeyStoreProtectionKeyAsString(String key)
                               throws CryptoException

Sets key used to protect the key store as a string. This is useful when pass phrases are generated by a plain text tool.

Parameters:

key - The key used to protect the key store.

Throws:

CryptoException

clearKeyStoreProtectionKey

void clearKeyStoreProtectionKey()
                         throws CryptoException

Clears the key use to protect the key store. Some implementations require that the key be cleared before a new value can be set. For deterministic results, you should always clear the key before setting a new value.

Throws:

CryptoException

setKey

void setKey(String alias,
            Key key)
     throws CryptoException

Generic method to set an arbitrary key.

Parameters:

alias - Alias of the key that will be set.

key - The key that will be set.

Throws:

CryptoException

clearKey

void clearKey(String alias)
       throws CryptoException

Generic method to clear an arbitrary key.

Parameters:

alias - Alias of the key that will be cleared.

Throws:

CryptoException

setEntry

void setEntry(String alias,
              KeyStore.Entry entry)
       throws CryptoException

Generic method to set an arbitrary entry.

Parameters:

alias - Alias of the entry that will be set.

entry - The entry that will be set.

Throws:

CryptoException

clearEntry

void clearEntry(String alias)
         throws CryptoException

Generic method to clear an arbitrary entry.

Parameters:

alias - Alias of the entry that will be cleared.

Throws:

CryptoException

getKS

KeyStore getKS()

Gets the underlying KeyStore object.

Returns:

The KeyStore object backing the protection manager.