io.realm.android

Class CipherClient

java.lang.Object

io.realm.android.CipherClient

public class CipherClient
extends Object

A Helper to use the crypto API, it allows encryption/decryption and has methods to help test if the KeyStore is locked and help unlocked it. This hides the complexity of different Android API to achieve those operations. This support Android API 9 and forwards. This cipher uses the KeyStore provided by Android, hence we to need to be sure that the KeyStore is available before doing any encrypt(String)/decrypt(String) by calling isKeystoreUnlocked() then unlockKeystore(), note that the latter will open the system Activity to set a password/PIN/Pattern required to unlock the screen & the KeyStore.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	decrypt(String user_encrypted) Takes a previously encrypt(String) to decrypted it using the Android Key Store.
String	encrypt(String user) Takes some plain text String and return the encrypted version of this String using the Android Key Store.
boolean	isKeystoreUnlocked() Checks whether the Android KeyStore is available.
void	unlockKeystore() Helps unlock the KeyStore this will launch the appropriate Intent to start the platform system Activity to create/unlock the KeyStore.

Methods inherited from class java.lang.Object

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

Constructor Detail

CipherClient

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

Throws:

KeyStoreException

Method Detail

encrypt

public String encrypt(String user)
               throws KeyStoreException

Takes some plain text String and return the encrypted version of this String using the Android Key Store.

Parameters:

user - represents the Token of a SyncUser.

Returns:

the encrypted Token.

Throws:

KeyStoreException - in case the Key Store is locked or other error.

decrypt

public String decrypt(String user_encrypted)
               throws KeyStoreException

Takes a previously encrypt(String) to decrypted it using the Android Key Store.

Parameters:

user_encrypted - represents the encrypted Token of a SyncUser.

Returns:

the decrypted Token.

Throws:

KeyStoreException - in case the KeyStore is locked or other error.

isKeystoreUnlocked

public boolean isKeystoreUnlocked()
                           throws KeyStoreException

Checks whether the Android KeyStore is available. This should be called before encrypt(String) or decrypt(String) as those need the KeyStore unlocked.

Returns:

true if the Android KeyStore in unlocked.

Throws:

KeyStoreException - in case of error.

unlockKeystore

public void unlockKeystore()
                    throws KeyStoreException

Helps unlock the KeyStore this will launch the appropriate Intent to start the platform system Activity to create/unlock the KeyStore.

Throws:

KeyStoreException - in case of error.