com.amazonaws.cloudhsm.jce.provider

Class KeyStoreWithAttributes

java.lang.Object

java.security.KeyStore

com.amazonaws.cloudhsm.jce.provider.KeyStoreWithAttributes

public class KeyStoreWithAttributes
extends java.security.KeyStore

KeyStoreWithAttributes provides a KeyStore implementation with the ability to specify CloudHSM key attributes for operations.

See Also:

KeyAttribute, KeyStore

Nested Class Summary

Nested classes/interfaces inherited from class java.security.KeyStore

java.security.KeyStore.Builder, java.security.KeyStore.CallbackHandlerProtection, java.security.KeyStore.Entry, java.security.KeyStore.LoadStoreParameter, java.security.KeyStore.PasswordProtection, java.security.KeyStore.PrivateKeyEntry, java.security.KeyStore.ProtectionParameter, java.security.KeyStore.SecretKeyEntry, java.security.KeyStore.TrustedCertificateEntry

Method Summary

Modifier and Type	Method and Description
static KeyStoreWithAttributes	getInstance(java.lang.String type) Gets an instance of a CloudHSM KeyStore.
static KeyStoreWithAttributes	getInstance(java.lang.String type, java.security.Provider provider) Gets an instance of a CloudHSM KeyStore.
static KeyStoreWithAttributes	getInstance(java.lang.String type, java.lang.String provider) Gets an instance of a CloudHSM KeyStore.
java.security.Key	getKey(java.security.spec.KeySpec keySpec) Finds a key that matches the provided key spec.
java.util.List<java.security.Key>	getKeys(java.security.spec.KeySpec keySpec) Returns the keys that matches the provided key spec.

Methods inherited from class java.security.KeyStore

aliases, containsAlias, deleteEntry, entryInstanceOf, getCertificate, getCertificateAlias, getCertificateChain, getCreationDate, getDefaultType, getEntry, getKey, getProvider, getType, isCertificateEntry, isKeyEntry, load, load, setCertificateEntry, setEntry, setKeyEntry, setKeyEntry, size, store, store

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static KeyStoreWithAttributes getInstance(java.lang.String type)
                                          throws java.security.KeyStoreException

Gets an instance of a CloudHSM KeyStore.

Parameters:

type - KeyStore type. This must refer to CloudHsmProvider.CLOUDHSM_KEYSTORE_TYPE.

Returns:

KeyStoreWithAttributes instance for the given type.

Throws:

java.security.KeyStoreException - if the given parameters are not set as documented here.

getInstance

public static KeyStoreWithAttributes getInstance(java.lang.String type,
                                                 java.lang.String provider)
                                          throws java.security.KeyStoreException,
                                                 java.security.NoSuchProviderException

Gets an instance of a CloudHSM KeyStore.

Parameters:

type - KeyStore type. This must be CloudHsmProvider.CLOUDHSM_KEYSTORE_TYPE.

provider - JCE Provider. This must be an instance of CloudHsmProvider.

Returns:

KeyStoreWithAttributes instance for the given type.

Throws:

java.security.KeyStoreException - if the given parameters are not set as documented here.

java.security.NoSuchProviderException - if the CloudHSM provider has not been registered with Security.

getInstance

public static KeyStoreWithAttributes getInstance(java.lang.String type,
                                                 java.security.Provider provider)
                                          throws java.security.KeyStoreException

Gets an instance of a CloudHSM KeyStore.

Parameters:

type - KeyStore type. This must refer to CloudHsmProvider.CLOUDHSM_KEYSTORE_TYPE.

provider - JCE Provider. This must be an instance of CloudHsmProvider.

Returns:

KeyStoreWithAttributes instance for the given type.

Throws:

java.security.KeyStoreException - if the given parameters are not set as documented here.

getKey

public final java.security.Key getKey(java.security.spec.KeySpec keySpec)
                               throws java.security.spec.InvalidKeySpecException

Finds a key that matches the provided key spec.

Parameters:

keySpec - a CloudHSM key spec, e.g. KeyAttributesMap or KeyReferenceSpec.

Returns:

A key object retrieved by the provided key spec in keySpec.

Throws:

java.security.spec.InvalidKeySpecException - If the provided key spec is invalid.

See Also:

KeyAttributesMap, KeyReferenceSpec

getKeys

public final java.util.List<java.security.Key> getKeys(java.security.spec.KeySpec keySpec)
                                                throws java.security.spec.InvalidKeySpecException

Returns the keys that matches the provided key spec.

Parameters:

keySpec - a CloudHSM key spec, e.g. KeyAttributesMap or KeyReferenceSpec.

Returns:

A list of key objects retrieved by the provided key spec in keySpec.

Throws:

java.security.spec.InvalidKeySpecException - If the provided key spec is invalid.

See Also:

KeyAttributesMap, KeyReferenceSpec