io.realm.android

Class SecureUserStore

java.lang.Object

io.realm.android.SecureUserStore

All Implemented Interfaces:

UserStore

public class SecureUserStore
extends Object
implements UserStore

Encrypt and decrypt the token (SyncUser) using Android built in KeyStore capabilities. According to the Android API this picks the right algorithm to perfom the operations. Prior to API 18 there were no AndroidKeyStore API, but the UNIX deamon existed to it's possible with the help of this code: https://github.com/nelenkov/android-keystore. On API > = 18, we generate an AES key to encrypt we then generate and uses the RSA key inside the KeyStore to encrypt the AES key that we store along the encrypted data inside a private SharedPreferences. This throws a KeyStoreException in case of an error or KeyStore being unvailable (unlocked). See also: io.realm.internal.android.crypto.class.CipherClient

See Also:

Android KeyStore

Field Summary

Fields inherited from interface io.realm.UserStore

CURRENT_USER_KEY

Constructor Summary

Constructors

Constructor and Description
SecureUserStore(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
Collection<SyncUser>	allUsers() Returns a collection of all users saved in the User store.
void	clear() Removes all saved users.
SyncUser	get(String key) Retrieves the SyncUser by decrypting first the serialised Json.
SyncUser	put(String key, SyncUser user) Store user as serialised and encrypted (Json), inside the private SharedPreferences.
SyncUser	remove(String key) Removes the user with the given key from the store.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecureUserStore

public SecureUserStore(android.content.Context context)
                throws KeyStoreException

Throws:

KeyStoreException

Method Detail

put

public SyncUser put(String key,
                    SyncUser user)

Store user as serialised and encrypted (Json), inside the private SharedPreferences.

Specified by:

put in interface UserStore

Parameters:

key - the SharedPreferences key.

user - we want to save.

Returns:

The previous user saved with this key or null if no user was replaced.

get

public SyncUser get(String key)

Retrieves the SyncUser by decrypting first the serialised Json.

Specified by:

get in interface UserStore

Parameters:

key - the SharedPreferences key.

Returns:

the SyncUser with the given key.

remove

public SyncUser remove(String key)

Description copied from interface: UserStore

Removes the user with the given key from the store.

Specified by:

remove in interface UserStore

Parameters:

key - key for the user to remove.

Returns:

SyncUser that was removed or null if no user matched the key.

allUsers

public Collection<SyncUser> allUsers()

Description copied from interface: UserStore

Returns a collection of all users saved in the User store.

Specified by:

allUsers in interface UserStore

Returns:

Collection of all users. If no users exist, an empty collection is returned.

clear

public void clear()

Description copied from interface: UserStore

Removes all saved users.

Specified by:

clear in interface UserStore