Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas Device SDKs
/
Node.js SDK
/
Realm Files

Encrypt a Realm - Node.js SDK

On this page

  • Store & Reuse Keys
  • Performance Impact
  • Encryption and Atlas Device Sync
  • Access an Encrypted Realm from Multiple Processes
  • Encrypt App Services App Metadata

You can encrypt the realm 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).

Warning

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

Note

Encrypt a Realm on Open or Copy Unencrypted Realm

You must encrypt a realm the first time you open it. If you try to open an existing unencrypted realm using a configuration that contains an encryption key, Realm throws an error.

Alternatively, you can copy the unencrypted realm data to a new encrypted realm using the Realm.writeCopyTo() method. Refer to Copy Data and Open a New Realm for more information.

The following code demonstrates how to generate an encryption key and open an encrypted realm:

// Retrieve encryption key from secure location or create one
const encryptionKey = new ArrayBuffer(64);
// Use encryption key in realm configuration
const config = {
  schema: [Task],
  encryptionKey: encryptionKey,
};
const realm = await Realm.open(config);
// Retrieve encryption key from secure location or create one
const encryptionKey = new ArrayBuffer(64);
// Use encryption key in realm configuration
const config: Configuration = {
  schema: [Task],
  encryptionKey: encryptionKey,
};
const realm = await Realm.open(config);

Store & Reuse Keys

You must pass the same encryption key every time you open the encrypted realm. If you don't provide a key or specify the wrong key for an encrypted realm, the Realm SDK throws an error.

Apps should store the encryption key securely, typically in the target platform's secure key/value storage, so that other apps cannot read the key.

Performance Impact

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

Encryption and Atlas Device Sync

You can encrypt a synced realm.

Realm only encrypts the data on the device and stores the data unencrypted in your Atlas data source. Any users with authorized access to the Atlas data source can read the data, but the following still applies:

  • Users must have the correct read permissions to read the synced data.

  • Data stored in Atlas is always encrypted at a volume (disk) level.

  • The transfer between client and server is always fully encrypted.

You can also enable Customer Key Management to encrypt stored Atlas data using your cloud provider's key (e.g. AWS KMS, Azure Key Vault, Google Cloud KMS).

If you need unique keys for each user of your application, you can use an OAuth provider or use one of the Realm authentication providers and an authentication trigger to create a 64-bit key and store that key in a user object.

Access an Encrypted Realm from Multiple Processes

Changed in version realm@11.8.0.

Starting with Realm Node.js SDK version v11.8.0, Realm supports opening the same encrypted realm in multiple processes.

If your app uses Realm Node.js SDK version v11.7.0 or earlier, attempting to open an encrypted realm from multiple processes throws this error: Encrypted interprocess sharing is currently unsupported.

Encrypt App Services App Metadata

If you use Atlas Device Sync with your realm, your App Services App uses an on-device metadata file to determine changes that should sync.

You can encrypt this metadata file in a similar manner as encrypting your realm.

To learn more, refer to Encrypt App Metadata.

Back

Bundle a Realm

Next

Model Data