devliving.online.securedpreferencestore

Class EncryptionManager

java.lang.Object

devliving.online.securedpreferencestore.EncryptionManager

public class EncryptionManager
extends java.lang.Object

Created by Mehedi on 8/21/16.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EncryptionManager.EncryptedData
class	EncryptionManager.InvalidMacException

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	AES_KEY_ALIAS
protected static java.lang.String	DEFAULT_KEY_ALIAS_PREFIX
protected java.lang.String	IS_COMPAT_MODE_KEY_ALIAS
protected java.lang.String	MAC_KEY_ALIAS
protected static java.lang.String	OVERRIDING_KEY_ALIAS_PREFIX_NAME

Constructor Summary

Constructors

Constructor and Description
EncryptionManager(android.content.Context context, android.content.SharedPreferences prefStore, SecuredPreferenceStore.KeyStoreRecoveryNotifier recoveryNotifier) Deprecated. Use the full constructor for better security on older versions of Android
EncryptionManager(android.content.Context context, android.content.SharedPreferences prefStore, java.lang.String keyAliasPrefix, byte[] bitShiftingKey, SecuredPreferenceStore.KeyStoreRecoveryNotifier recoveryHandler)

Method Summary

Modifier and Type	Method and Description
static byte[]	base64Decode(java.lang.String text)
static java.lang.String	base64Encode(byte[] data)
byte[]	decrypt(EncryptionManager.EncryptedData data)
EncryptionManager.EncryptedData	encrypt(byte[] bytes)
static java.lang.String	getHashed(java.lang.String text)
byte[]	tryDecrypt(EncryptionManager.EncryptedData data) tries recovery once if a Keystore error occurs
EncryptionManager.EncryptedData	tryEncrypt(byte[] bytes) Tries to recover once if a Keystore error occurs

Methods inherited from class java.lang.Object

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

Field Detail

AES_KEY_ALIAS

protected final java.lang.String AES_KEY_ALIAS

MAC_KEY_ALIAS

protected final java.lang.String MAC_KEY_ALIAS

OVERRIDING_KEY_ALIAS_PREFIX_NAME

protected static final java.lang.String OVERRIDING_KEY_ALIAS_PREFIX_NAME

See Also:

Constant Field Values

DEFAULT_KEY_ALIAS_PREFIX

protected static final java.lang.String DEFAULT_KEY_ALIAS_PREFIX

See Also:

Constant Field Values

IS_COMPAT_MODE_KEY_ALIAS

protected final java.lang.String IS_COMPAT_MODE_KEY_ALIAS

Constructor Detail

EncryptionManager

public EncryptionManager(android.content.Context context,
                         android.content.SharedPreferences prefStore,
                         SecuredPreferenceStore.KeyStoreRecoveryNotifier recoveryNotifier)
                  throws java.io.IOException,
                         java.security.cert.CertificateException,
                         java.security.NoSuchAlgorithmException,
                         java.security.KeyStoreException,
                         java.security.UnrecoverableEntryException,
                         java.security.InvalidAlgorithmParameterException,
                         javax.crypto.NoSuchPaddingException,
                         java.security.InvalidKeyException,
                         java.security.NoSuchProviderException

Deprecated. Use the full constructor for better security on older versions of Android

Parameters:

context -

prefStore -

recoveryNotifier -

Throws:

java.io.IOException

java.security.cert.CertificateException

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

java.security.UnrecoverableEntryException

java.security.InvalidAlgorithmParameterException

javax.crypto.NoSuchPaddingException

java.security.InvalidKeyException

java.security.NoSuchProviderException

EncryptionManager

public EncryptionManager(android.content.Context context,
                         android.content.SharedPreferences prefStore,
                         java.lang.String keyAliasPrefix,
                         byte[] bitShiftingKey,
                         SecuredPreferenceStore.KeyStoreRecoveryNotifier recoveryHandler)
                  throws java.io.IOException,
                         java.security.NoSuchAlgorithmException,
                         java.security.InvalidAlgorithmParameterException,
                         java.security.NoSuchProviderException,
                         javax.crypto.NoSuchPaddingException,
                         java.security.cert.CertificateException,
                         java.security.KeyStoreException,
                         java.security.UnrecoverableEntryException,
                         java.security.InvalidKeyException,
                         java.lang.IllegalStateException

Parameters:

context - application context

prefStore - backing store for storing information

keyAliasPrefix - prefix for key aliases

bitShiftingKey - a key to use for randomization (seed) and bit shifting, this enhances the security on older OS versions a bit

recoveryHandler - callback/listener for recovery notification

Throws:

java.io.IOException

java.security.NoSuchAlgorithmException

java.security.InvalidAlgorithmParameterException

java.security.NoSuchProviderException

javax.crypto.NoSuchPaddingException

java.security.cert.CertificateException

java.security.KeyStoreException

java.security.UnrecoverableEntryException

java.security.InvalidKeyException

java.lang.IllegalStateException

Method Detail

tryEncrypt

public EncryptionManager.EncryptedData tryEncrypt(byte[] bytes)
                                           throws javax.crypto.NoSuchPaddingException,
                                                  java.security.InvalidAlgorithmParameterException,
                                                  java.security.NoSuchAlgorithmException,
                                                  java.io.IOException,
                                                  javax.crypto.BadPaddingException,
                                                  javax.crypto.IllegalBlockSizeException,
                                                  java.security.NoSuchProviderException,
                                                  java.security.InvalidKeyException,
                                                  java.security.KeyStoreException,
                                                  java.security.UnrecoverableEntryException

Tries to recover once if a Keystore error occurs

Parameters:

bytes -

Returns:

Throws:

javax.crypto.NoSuchPaddingException

java.security.InvalidAlgorithmParameterException

java.security.NoSuchAlgorithmException

java.io.IOException

javax.crypto.BadPaddingException

javax.crypto.IllegalBlockSizeException

java.security.NoSuchProviderException

java.security.InvalidKeyException

java.security.KeyStoreException

java.security.UnrecoverableEntryException

tryDecrypt

public byte[] tryDecrypt(EncryptionManager.EncryptedData data)
                  throws javax.crypto.NoSuchPaddingException,
                         java.security.InvalidAlgorithmParameterException,
                         java.security.NoSuchAlgorithmException,
                         java.security.KeyStoreException,
                         java.security.UnrecoverableEntryException,
                         java.security.NoSuchProviderException,
                         java.security.InvalidKeyException,
                         java.io.IOException,
                         javax.crypto.BadPaddingException,
                         javax.crypto.IllegalBlockSizeException,
                         EncryptionManager.InvalidMacException

tries recovery once if a Keystore error occurs

Parameters:

data -

Returns:

Throws:

javax.crypto.NoSuchPaddingException

java.security.InvalidAlgorithmParameterException

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

java.security.UnrecoverableEntryException

java.security.NoSuchProviderException

java.security.InvalidKeyException

java.io.IOException

javax.crypto.BadPaddingException

javax.crypto.IllegalBlockSizeException

EncryptionManager.InvalidMacException

encrypt

public EncryptionManager.EncryptedData encrypt(byte[] bytes)
                                        throws javax.crypto.NoSuchPaddingException,
                                               java.security.NoSuchAlgorithmException,
                                               java.security.InvalidKeyException,
                                               java.io.IOException,
                                               javax.crypto.BadPaddingException,
                                               java.security.NoSuchProviderException,
                                               javax.crypto.IllegalBlockSizeException,
                                               java.security.InvalidAlgorithmParameterException

Parameters:

bytes -

Returns:

Throws:

javax.crypto.NoSuchPaddingException

java.security.NoSuchAlgorithmException

java.security.InvalidKeyException

java.io.IOException

javax.crypto.BadPaddingException

java.security.NoSuchProviderException

javax.crypto.IllegalBlockSizeException

java.security.InvalidAlgorithmParameterException

decrypt

public byte[] decrypt(EncryptionManager.EncryptedData data)
               throws java.io.IOException,
                      javax.crypto.NoSuchPaddingException,
                      java.security.InvalidAlgorithmParameterException,
                      java.security.NoSuchAlgorithmException,
                      javax.crypto.IllegalBlockSizeException,
                      javax.crypto.BadPaddingException,
                      EncryptionManager.InvalidMacException,
                      java.security.NoSuchProviderException,
                      java.security.InvalidKeyException

Parameters:

data -

Returns:

Throws:

java.io.IOException

javax.crypto.NoSuchPaddingException

java.security.InvalidAlgorithmParameterException

java.security.NoSuchAlgorithmException

javax.crypto.IllegalBlockSizeException

javax.crypto.BadPaddingException

EncryptionManager.InvalidMacException

java.security.NoSuchProviderException

java.security.InvalidKeyException

getHashed

public static java.lang.String getHashed(java.lang.String text)
                                  throws java.security.NoSuchAlgorithmException,
                                         java.io.UnsupportedEncodingException

Throws:

java.security.NoSuchAlgorithmException

java.io.UnsupportedEncodingException

base64Encode

public static java.lang.String base64Encode(byte[] data)

base64Decode

public static byte[] base64Decode(java.lang.String text)