Navigation

Encrypt a Realm - Android SDK

On this page

  • Store & Reuse Keys
  • Generate and Store an Encryption Key
  • Access an Existing Encryption Key
  • Open an Encrypted Realm

You can encrypt the realm database file on disk with AES-256 + SHA-2 by supplying a 64-byte encryption key when opening a realm.

Realm transparently encrypts and decrypts data with standard AES-256 encryption using the first 256 bits of the given 512-bit encryption key. Realm uses the other 256 bits of the 512-bit encryption key to validate integrity using a hash-based message authentication code (HMAC).

Note
Performance Impact

Reads and writes on encrypted realms can be up to 10% slower than equivalent reads and writes to unencrypted realms.

Important
Encryption and Realm Sync

You can encrypt a synced realm, but MongoDB Realm only encrypts the data on the device. MongoDB Realm stores the data unencrypted in your data source.

To repeatedly access an encrypted realm, you must pass the same encryption key to RealmConfiguration.Builder.encryptionKey() each time you open the realm. Apps should store the encryption key in the Android KeyStore so that other apps cannot read the key. The following steps describe the recommended way to use the KeyStore for encryption with Realm:

  1. Generate an asymmetric RSA key that Android can securely store and retrieve using the Android KeyStore.

    Note
    Android Version M and Above: Keystore Security

    Versions M and above require user PIN or fingerprint to unlock the KeyStore.

  2. Generate a symmetric key (AES) you can use to encrypt the realm.
  3. Encrypt the symmetric AES key using your private RSA key.
  4. Store the encrypted AES key on filesystem (in a SharedPreferences, for example).

When you need to use your encrypted realm:

  1. Retrieve your encrypted AES key.
  2. Decrypt your encrypted AES key using the public RSA key.
  3. Use the decrypted AES key in the RealmConfiguration to open the encrypted realm.
Tip
See also:

For an end-to-end example of storing and reusing encryption keys, see the store_password example project, which demonstrates the fingerprint API.

Warning

Do not use cryptographically-weak hashes for realm encryption keys. For optimal security, we recommend generating random rather than derived encryption keys.

The following code demonstrates how to securely generate and store an encryption key for a realm:

The following code demonstrates how to access and decrypt a securely stored encryption key for a realm:

The following code demonstrates how to open an encrypted realm with the encryptionKey() method:

Give Feedback

On this page

  • Store & Reuse Keys
  • Generate and Store an Encryption Key
  • Access an Existing Encryption Key
  • Open an Encrypted Realm