Interface IKeystoreModule
interface IKeystoreModule
Extends com.amazon.apmf.IStandard
This is the top level interface for retrieving handles to a keystore.
Methods
getNamedKeystore()
Get a keystore by name. This will typically be used to retrieve special purpose keystores that may be pre-provisioned with keys for a specific purpose. Many such keystores will require privileges for access.IKeystore*getNamedKeystore(stringname)
Parameters
name
string — Required
The name of the keystore to retrieve.
Returns
IKeystore*
A keystore.
Throws
NoSuchKeystoreError— if no matching keystore exists.SecurityError— if the caller does not have access to the keystore.
getPrivateKeystore()
Get a keystore whose keys are scoped to the given security principal.IKeystore*getPrivateKeystore(com.amazon.apmf.ICredential*cred,SecurityLevel*level)
Parameters
cred
com.amazon.apmf.ICredential* — Required
Credential representing the security principal who owns the
keystore.
level
SecurityLevel* — Required
The desired security level of the keystore
Returns
IKeystore*
A keystore.
Throws
NoSuchKeystoreError— if no matching keystore exists.
getMostSecurePrivateKeystore()
Get the most secure keystore whose keys are scoped to the given security principal.IKeystore*getMostSecurePrivateKeystore(com.amazon.apmf.ICredential*cred)
Parameters
cred
com.amazon.apmf.ICredential* — Required
Credential representing the security principal who owns the
keystore.
Returns
IKeystore*
A keystore.
Throws
NoSuchKeystoreError— if no matching keystore exists.SecurityError— if the caller does not have access to the keystore.
getFastestPrivateKeystore()
Get the fastest keystore whose keys are scoped to the given security principal.IKeystore*getFastestPrivateKeystore(com.amazon.apmf.ICredential*cred)
Parameters
cred
com.amazon.apmf.ICredential* — Required
Credential representing the security principal who owns the
keystore.
Returns
IKeystore*
A keystore
Throws
NoSuchKeystoreError— if no matching keystore exists.
