Client-Side Field Level Encryption Methods

This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoDB.

Note

For details on a specific method, including syntax and examples, click on the link to the method's reference page.

The mongo client-side field level encryption methods require a database connection with client-side field level encryption enabled. If the current database connection was not initiated with client-side field level encryption enabled, either:

Use the Mongo() constructor from the mongo shell to establish a connection with the required client-side field level encryption options. The Mongo() method supports the following Key Management Service (KMS) providers for Customer Master Key (CMK) management:
or
Use the mongo shell command line options to establish a connection with the required options. The command line options only support the Amazon Web Services KMS provider for CMK management.

The following methods are for the MongoDB mongo shell only. For instructions on implementing client-side field level encryption using a MongoDB 4.2+ compatible driver, defer to the driver documentation. See Driver Compatibility Table for a complete list of 4.2+ compatible drivers with support for client-side field level encryption.

Name	Description
`getKeyVault()`	Returns the key vault object for the current MongoDB connection.
`KeyVault.createKey()`	Creates a data encryption key for use with client-side field level encryption.
`KeyVault.deleteKey()`	Deletes the specified data encryption key from the key vault.
`KeyVault.getKey()`	Retreives the specified data encryption key from the key vault.
`KeyVault.getKeys()`	Retrieves all keys in the key vault.
`KeyVault.addKeyAlternateName()`	Associates a key alternative name to the specified data encryption key.
`KeyVault.removeKeyAlternateName()`	Removes a key alternative name from the specified data encryption key.
`KeyVault.getKeyByAltName()`	Retrieves keys with the specified key alternative name.
`getClientEncryption()`	Returns the client encryption object for supporting explicit encryption/decryption of fields.
`ClientEncryption.encrypt()`	Encrypts a field using a specified data encryption key and encryption algorithm.
`ClientEncryption.decrypt()`	Decrypts a field using the associated data encryption key and encryption algorithm.

Back

_rand()

getKeyVault()