com.amazonaws.internal.keyvaluestore

Class KeyProvider18

java.lang.Object

com.amazonaws.internal.keyvaluestore.KeyProvider18

public class KeyProvider18
extends java.lang.Object

This provider is used on API Levels 18 through 23. It generates a AES 256-bit symmetric key which is used to encrypt the data. It also generates a master key using RSA provided by AndroidKeyStore and uses the RSA key to encrypt the AES key. The size of the RSA key is 2048 bits by default. Once the AES key is encrypted with the RSA key, the encrypted AES key is stored in SharedPreferences. For subsequent calls to getKey, if KeyStore contains the RSA key, it is used to decrypt the AES key stored in SharedPreferences. The AES key is returned in the getKey call.

Method Summary

Modifier and Type	Method and Description
void	deleteKey(java.lang.String keyAlias) Delete the encryption key that is used for encrypting and decrypting data.
java.security.Key	generateKey(java.lang.String rsaKeyAlias) Generate the encryption key that is used for encrypting and decrypting data.
java.security.Key	retrieveKey(java.lang.String keyAlias) Retrieve the encryption key that is used for encrypting and decrypting data.

Methods inherited from class java.lang.Object

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

Method Detail

generateKey

public java.security.Key generateKey(java.lang.String rsaKeyAlias)
                              throws KeyNotGeneratedException

Generate the encryption key that is used for encrypting and decrypting data. The encryption key will be identified by a keyAlias.

Parameters:

rsaKeyAlias - String that identifies the encryption key.

Returns:

the key that can be used to encrypt and decrypt data.

Throws:

KeyNotGeneratedException - when the encryption key cannot be generated successfully. The caller of this method is expected to handle this exception appropriately.

retrieveKey

public java.security.Key retrieveKey(java.lang.String keyAlias)
                              throws KeyNotFoundException

Retrieve the encryption key that is used for encrypting and decrypting data. The encryption key will be identified by a keyAlias.

Parameters:

keyAlias - String that identifies the encryption key.

Returns:

the key that can be used to encrypt and decrypt data.

Throws:

KeyNotFoundException - when the encryption key cannot be found. The caller of this method is expected to handle this exception appropriately.

deleteKey

public void deleteKey(java.lang.String keyAlias)

Delete the encryption key that is used for encrypting and decrypting data. The encryption key will be identified by a keyAlias.

Parameters:

keyAlias - String that identifies the encryption key.