com.adobe.granite.crypto.spi

Interface KeyProvider

All Known Implementing Classes:

KeyProviderBase

public interface KeyProvider

The KeyProvider provides a simple API to obtain cryptographic keys stored in a storage system.The underlying storage system is indicated by the getLabel() method. Currently supported algorithm are defined in Algorithms

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	STORAGE_SUPPORT The service registration property indicating which storage support to use for this bundle instance ("granite.crypto.storage").

Method Summary

Modifier and Type	Method and Description
java.lang.String	getStorageType() Returns a short description of the support bundle to indicate what kind of storage is going to be used.
byte[]	obtainKey(Algorithms algorithm) Obtain the current cryptographic key present in the storage.

Field Detail

STORAGE_SUPPORT

static final java.lang.String STORAGE_SUPPORT

The service registration property indicating which storage support to use for this bundle instance ("granite.crypto.storage").

See Also:

Constant Field Values

Method Detail

getStorageType

java.lang.String getStorageType()

Returns a short description of the support bundle to indicate what kind of storage is going to be used.

Returns:

a short human readable description

obtainKey

byte[] obtainKey(Algorithms algorithm)
          throws CryptoException

Obtain the current cryptographic key present in the storage. The storage used for the key returned must be protected by additional means such as access control against abuse of the key. The key is generated once at startup via the KeyGenerator and stays the same for the lifetime of the service (unless is physically erased in the storage system)

Parameters:

algorithm - the standard string name of the algorithm. Currently supported algorithm are defined in Algorithms

Returns:

the related stored key

Throws:

CryptoException - If any problem occurs while obtaining the key