org.nhindirect.common.crypto

Interface KeyStoreProtectionManager

All Known Subinterfaces:

MutableKeyStoreProtectionManager

All Known Implementing Classes:

AbstractPKCS11TokenKeyStoreProtectionManager, BootstrappedKeyStoreProtectionManager, DynamicPKCS11TokenKeyStoreProtectionManager, StaticCachedPKCS11TokenKeyStoreProtectionManager, StaticPKCS11TokenKeyStoreProtectionManager

public interface KeyStoreProtectionManager

Interface definition for accessing key store pass phrases. PKCS12 keystores generally have two layers of protection with each being options:

• Pass phrase protection for the entire key store.
• Pass phrase protection for private keys associated with a public key

This interface assumes that all private keys are stores with the same pass phrase. Pass phrases may stored in a multitude of mediums such as protected files, databases, or PKCS11 tokens.

Since:

1.3

Author:

Greg Meyer

Method Summary

Modifier and Type	Method and Description
Map<String,KeyStore.Entry>	getAllEntries() Gets a Map of all entries managed by the token.
Map<String,Key>	getAllKeys() Gets a Map of all keys managed by the token.
KeyStore.Entry	getEntry(String entryName) Gets a specific entry by name
Key	getKey(String keyName) Gets a specific key by name.
Key	getKeyStoreProtectionKey() Gets the key protecting private keys in the key store.
Key	getPrivateKeyProtectionKey() Gets the key protecting the key store as a whole.

Method Detail

getPrivateKeyProtectionKey

Key getPrivateKeyProtectionKey()
                        throws CryptoException

Gets the key protecting the key store as a whole.

Returns:

The key protecting the key store as a whole.

Throws:

CryptoException

getKeyStoreProtectionKey

Key getKeyStoreProtectionKey()
                      throws CryptoException

Gets the key protecting private keys in the key store.

Returns:

The key protecting private keys in the key store.

Throws:

CryptoException

getAllKeys

Map<String,Key> getAllKeys()
                    throws CryptoException

Gets a Map of all keys managed by the token.

Returns:

Returns a map of all keys in the token. The mapping is string alias to the key.

Throws:

CryptoException

getKey

Key getKey(String keyName)
    throws CryptoException

Gets a specific key by name.

Parameters:

keyName - The name of the key to retrieve. Returns null if the key doesn't exist.

Returns:

They key specified by the name.

Throws:

CryptoException

getAllEntries

Map<String,KeyStore.Entry> getAllEntries()
                                  throws CryptoException

Gets a Map of all entries managed by the token.

Returns:

Returns a map of all entries in the token. The mapping is a string alias to the entry.

Throws:

CryptoException

getEntry

KeyStore.Entry getEntry(String entryName)
                 throws CryptoException

Gets a specific entry by name

Parameters:

entryName - The name of the entry to retrieve. Returns null if the entry doesn't exist.

Returns:

They entry specified by the name.

Throws:

CryptoException