devliving.online.securedpreferencestore

Class SecuredPreferenceStore

java.lang.Object

devliving.online.securedpreferencestore.SecuredPreferenceStore

All Implemented Interfaces:

android.content.SharedPreferences

public class SecuredPreferenceStore
extends java.lang.Object
implements android.content.SharedPreferences

Created by Mehedi on 8/21/16.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SecuredPreferenceStore.Editor
static interface	SecuredPreferenceStore.KeyStoreRecoveryNotifier
class	SecuredPreferenceStore.MigrationFailedException

Nested classes/interfaces inherited from interface android.content.SharedPreferences

android.content.SharedPreferences.OnSharedPreferenceChangeListener

Method Summary

Modifier and Type	Method and Description
boolean	contains(java.lang.String key)
SecuredPreferenceStore.Editor	edit()
java.util.Map<java.lang.String,java.lang.Object>	getAll()
boolean	getBoolean(java.lang.String key, boolean defValue)
byte[]	getBytes(java.lang.String key)
EncryptionManager	getEncryptionManager()
float	getFloat(java.lang.String key, float defValue)
int	getInt(java.lang.String key, int defValue)
long	getLong(java.lang.String key, long defValue)
static SecuredPreferenceStore	getSharedInstance()
java.lang.String	getString(java.lang.String key, java.lang.String defValue)
java.util.Set<java.lang.String>	getStringSet(java.lang.String key, java.util.Set<java.lang.String> defValues)
static void	init(android.content.Context appContext, RecoveryHandler recoveryHandler) Deprecated. Use the full constructor for better security, specially on older OS versions
static void	init(android.content.Context appContext, java.lang.String storeName, java.lang.String keyPrefix, byte[] bitShiftingKey, RecoveryHandler recoveryHandler) Must be called once before using the SecuredPreferenceStore to initialize the shared instance.
void	registerOnSharedPreferenceChangeListener(android.content.SharedPreferences.OnSharedPreferenceChangeListener onSharedPreferenceChangeListener)
static void	setRecoveryHandler(RecoveryHandler recoveryHandler)
void	unregisterOnSharedPreferenceChangeListener(android.content.SharedPreferences.OnSharedPreferenceChangeListener onSharedPreferenceChangeListener)

Methods inherited from class java.lang.Object

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

Method Detail

setRecoveryHandler

public static void setRecoveryHandler(RecoveryHandler recoveryHandler)

getSharedInstance

public static SecuredPreferenceStore getSharedInstance()

init

public static void init(android.content.Context appContext,
                        java.lang.String storeName,
                        java.lang.String keyPrefix,
                        byte[] bitShiftingKey,
                        RecoveryHandler recoveryHandler)
                 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,
                        SecuredPreferenceStore.MigrationFailedException

Must be called once before using the SecuredPreferenceStore to initialize the shared instance. You may call it in @code{onCreate} method of your application class or launcher activity

Parameters:

appContext - application context

storeName - optional name of the preference file

keyPrefix - optional prefix for encryption key aliases

bitShiftingKey - seed for randomization and bit shifting, enhances security on older OS versions

recoveryHandler - recovery handler to use if necessary

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

SecuredPreferenceStore.MigrationFailedException

init

public static void init(android.content.Context appContext,
                        RecoveryHandler recoveryHandler)
                 throws java.io.IOException,
                        java.security.cert.CertificateException,
                        java.security.NoSuchAlgorithmException,
                        java.security.InvalidKeyException,
                        java.security.UnrecoverableEntryException,
                        java.security.InvalidAlgorithmParameterException,
                        javax.crypto.NoSuchPaddingException,
                        java.security.NoSuchProviderException,
                        java.security.KeyStoreException,
                        SecuredPreferenceStore.MigrationFailedException

Deprecated. Use the full constructor for better security, specially on older OS versions

Throws:

java.io.IOException

java.security.cert.CertificateException

java.security.NoSuchAlgorithmException

java.security.InvalidKeyException

java.security.UnrecoverableEntryException

java.security.InvalidAlgorithmParameterException

javax.crypto.NoSuchPaddingException

java.security.NoSuchProviderException

java.security.KeyStoreException

SecuredPreferenceStore.MigrationFailedException

See Also:

init(Context, String, String, byte[], RecoveryHandler)

getEncryptionManager

public EncryptionManager getEncryptionManager()

getAll

public java.util.Map<java.lang.String,java.lang.Object> getAll()

Specified by:

getAll in interface android.content.SharedPreferences

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String defValue)

Specified by:

getString in interface android.content.SharedPreferences

getStringSet

public java.util.Set<java.lang.String> getStringSet(java.lang.String key,
                                                    java.util.Set<java.lang.String> defValues)

Specified by:

getStringSet in interface android.content.SharedPreferences

getInt

public int getInt(java.lang.String key,
                  int defValue)

Specified by:

getInt in interface android.content.SharedPreferences

getLong

public long getLong(java.lang.String key,
                    long defValue)

Specified by:

getLong in interface android.content.SharedPreferences

getFloat

public float getFloat(java.lang.String key,
                      float defValue)

Specified by:

getFloat in interface android.content.SharedPreferences

getBoolean

public boolean getBoolean(java.lang.String key,
                          boolean defValue)

Specified by:

getBoolean in interface android.content.SharedPreferences

getBytes

public byte[] getBytes(java.lang.String key)

contains

public boolean contains(java.lang.String key)

Specified by:

contains in interface android.content.SharedPreferences

edit

public SecuredPreferenceStore.Editor edit()

Specified by:

edit in interface android.content.SharedPreferences

registerOnSharedPreferenceChangeListener

public void registerOnSharedPreferenceChangeListener(android.content.SharedPreferences.OnSharedPreferenceChangeListener onSharedPreferenceChangeListener)

Specified by:

registerOnSharedPreferenceChangeListener in interface android.content.SharedPreferences

unregisterOnSharedPreferenceChangeListener

public void unregisterOnSharedPreferenceChangeListener(android.content.SharedPreferences.OnSharedPreferenceChangeListener onSharedPreferenceChangeListener)

Specified by:

unregisterOnSharedPreferenceChangeListener in interface android.content.SharedPreferences