Client-Side Field Level Encryption

New in MongoDB 4.2, client-side field level encryption allows an application to encrypt specific data fields in addition to pre-existing MongoDB encryption features such as Encryption at Rest and TLS/SSL (Transport Encryption).

With field level encryption, applications can encrypt fields in documents prior to transmitting data over the wire to the server. Client-side field level encryption supports workloads where applications must guarantee that unauthorized parties, including server administrators, cannot read the encrypted data.

See also

The MongoDB documentation on Client Side Field Level Encryption.

Dependencies

To get started using client-side field level encryption in your project, you will need to install the pymongocrypt library as well as the driver itself. Install both the driver and a compatible version of pymongocrypt like this:

  1. $ python -m pip install 'pymongo[encryption]'

Note that installing on Linux requires pip 19 or later for manylinux2010 wheel support. For more information about installing pymongocrypt see the installation instructions on the project’s PyPI page.

mongocryptd

The mongocryptd binary is required for automatic client-side encryption and is included as a component in the MongoDB Enterprise Server package. For detailed installation instructions see the MongoDB documentation on mongocryptd.

mongocryptd performs the following:

  • Parses the automatic encryption rules specified to the database connection. If the JSON schema contains invalid automatic encryption syntax or any document validation syntax, mongocryptd returns an error.

  • Uses the specified automatic encryption rules to mark fields in read and write operations for encryption.

  • Rejects read/write operations that may return unexpected or incorrect results when applied to an encrypted field. For supported and unsupported operations, see Read/Write Support with Automatic Field Level Encryption.

A MongoClient configured with auto encryption will automatically spawn the mongocryptd process from the application’s PATH. Applications can control the spawning behavior as part of the automatic encryption options. For example to set the path to the mongocryptd process:

  1. auto_encryption_opts = AutoEncryptionOpts(
  2.         ...,
  3.         mongocryptd_spawn_path='/path/to/mongocryptd')

To control the logging output of mongocryptd pass options using mongocryptd_spawn_args:

  1. auto_encryption_opts = AutoEncryptionOpts(
  2.         ...,
  3.         mongocryptd_spawn_args=['--logpath=/path/to/mongocryptd.log', '--logappend'])

If your application wishes to manage the mongocryptd process manually, it is possible to disable spawning mongocryptd:

  1. auto_encryption_opts = AutoEncryptionOpts(
  2.         ...,
  3.         mongocryptd_bypass_spawn=True,
  4.         # URI of the local ``mongocryptd`` process.
  5.         mongocryptd_uri='mongodb://localhost:27020')

mongocryptd is only responsible for supporting automatic client-side field level encryption and does not itself perform any encryption or decryption.

Automatic Client-Side Field Level Encryption

Automatic client-side field level encryption is enabled by creating a MongoClient with the auto_encryption_opts option set to an instance of AutoEncryptionOpts. The following examples show how to setup automatic client-side field level encryption using ClientEncryption to create a new encryption data key.

Note

Automatic client-side field level encryption requires MongoDB 4.2 enterprise or a MongoDB 4.2 Atlas cluster. The community version of the server supports automatic decryption as well as Explicit Encryption.

Providing Local Automatic Encryption Rules

The following example shows how to specify automatic encryption rules via the schema_map option. The automatic encryption rules are expressed using a strict subset of the JSON Schema syntax.

Supplying a schema_map provides more security than relying on JSON Schemas obtained from the server. It protects against a malicious server advertising a false JSON Schema, which could trick the client into sending unencrypted data that should be encrypted.

JSON Schemas supplied in the schema_map only apply to configuring automatic client-side field level encryption. Other validation rules in the JSON schema will not be enforced by the driver and will result in an error.:

  1. import os
  3. from bson.codec_options import CodecOptions
  4. from bson import json_util
  6. from pymongo import MongoClient
  7. from pymongo.encryption import (Algorithm,
  8.                                 ClientEncryption)
  9. from pymongo.encryption_options import AutoEncryptionOpts
  12. def create_json_schema_file(kms_providers, key_vault_namespace,
  13.                             key_vault_client):
  14.     client_encryption = ClientEncryption(
  15.         kms_providers,
  16.         key_vault_namespace,
  17.         key_vault_client,
  18.         # The CodecOptions class used for encrypting and decrypting.
  19.         # This should be the same CodecOptions instance you have configured
  20.         # on MongoClient, Database, or Collection. We will not be calling
  21.         # encrypt() or decrypt() in this example so we can use any
  22.         # CodecOptions.
  23.         CodecOptions())
  25.     # Create a new data key and json schema for the encryptedField.
  26.     # https://dochub.mongodb.org/core/client-side-field-level-encryption-automatic-encryption-rules
  27.     data_key_id = client_encryption.create_data_key(
  28.         'local', key_alt_names=['pymongo_encryption_example_1'])
  29.     schema = {
  30.         "properties": {
  31.             "encryptedField": {
  32.                 "encrypt": {
  33.                     "keyId": [data_key_id],
  34.                     "bsonType": "string",
  35.                     "algorithm":
  36.                         Algorithm.AEAD_AES_256_CBC_HMAC_SHA_512_Deterministic
  37.                 }
  38.             }
  39.         },
  40.         "bsonType": "object"
  41.     }
  42.     # Use CANONICAL_JSON_OPTIONS so that other drivers and tools will be
  43.     # able to parse the MongoDB extended JSON file.
  44.     json_schema_string = json_util.dumps(
  45.         schema, json_options=json_util.CANONICAL_JSON_OPTIONS)
  47.     with open('jsonSchema.json', 'w') as file:
  48.         file.write(json_schema_string)
  51. def main():
  52.     # The MongoDB namespace (db.collection) used to store the
  53.     # encrypted documents in this example.
  54.     encrypted_namespace = "test.coll"
  56.     # This must be the same master key that was used to create
  57.     # the encryption key.
  58.     local_master_key = os.urandom(96)
  59.     kms_providers = {"local": {"key": local_master_key}}
  61.     # The MongoDB namespace (db.collection) used to store
  62.     # the encryption data keys.
  63.     key_vault_namespace = "encryption.__pymongoTestKeyVault"
  64.     key_vault_db_name, key_vault_coll_name = key_vault_namespace.split(".", 1)
  66.     # The MongoClient used to access the key vault (key_vault_namespace).
  67.     key_vault_client = MongoClient()
  68.     key_vault = key_vault_client[key_vault_db_name][key_vault_coll_name]
  69.     # Ensure that two data keys cannot share the same keyAltName.
  70.     key_vault.drop()
  71.     key_vault.create_index(
  72.         "keyAltNames",
  73.         unique=True,
  74.         partialFilterExpression={"keyAltNames": {"$exists": True}})
  76.     create_json_schema_file(
  77.         kms_providers, key_vault_namespace, key_vault_client)
  79.     # Load the JSON Schema and construct the local schema_map option.
  80.     with open('jsonSchema.json', 'r') as file:
  81.         json_schema_string = file.read()
  82.     json_schema = json_util.loads(json_schema_string)
  83.     schema_map = {encrypted_namespace: json_schema}
  85.     auto_encryption_opts = AutoEncryptionOpts(
  86.         kms_providers, key_vault_namespace, schema_map=schema_map)
  88.     client = MongoClient(auto_encryption_opts=auto_encryption_opts)
  89.     db_name, coll_name = encrypted_namespace.split(".", 1)
  90.     coll = client[db_name][coll_name]
  91.     # Clear old data
  92.     coll.drop()
  94.     coll.insert_one({"encryptedField": "123456789"})
  95.     print('Decrypted document: %s' % (coll.find_one(),))
  96.     unencrypted_coll = MongoClient()[db_name][coll_name]
  97.     print('Encrypted document: %s' % (unencrypted_coll.find_one(),))
  100. if __name__ == "__main__":
  101.     main()

Server-Side Field Level Encryption Enforcement

The MongoDB 4.2 server supports using schema validation to enforce encryption of specific fields in a collection. This schema validation will prevent an application from inserting unencrypted values for any fields marked with the "encrypt" JSON schema keyword.

The following example shows how to setup automatic client-side field level encryption using ClientEncryption to create a new encryption data key and create a collection with the Automatic Encryption JSON Schema Syntax:

  1. import os
  3. from bson.codec_options import CodecOptions
  4. from bson.binary import STANDARD
  6. from pymongo import MongoClient
  7. from pymongo.encryption import (Algorithm,
  8.                                 ClientEncryption)
  9. from pymongo.encryption_options import AutoEncryptionOpts
  10. from pymongo.errors import OperationFailure
  11. from pymongo.write_concern import WriteConcern
  14. def main():
  15.     # The MongoDB namespace (db.collection) used to store the
  16.     # encrypted documents in this example.
  17.     encrypted_namespace = "test.coll"
  19.     # This must be the same master key that was used to create
  20.     # the encryption key.
  21.     local_master_key = os.urandom(96)
  22.     kms_providers = {"local": {"key": local_master_key}}
  24.     # The MongoDB namespace (db.collection) used to store
  25.     # the encryption data keys.
  26.     key_vault_namespace = "encryption.__pymongoTestKeyVault"
  27.     key_vault_db_name, key_vault_coll_name = key_vault_namespace.split(".", 1)
  29.     # The MongoClient used to access the key vault (key_vault_namespace).
  30.     key_vault_client = MongoClient()
  31.     key_vault = key_vault_client[key_vault_db_name][key_vault_coll_name]
  32.     # Ensure that two data keys cannot share the same keyAltName.
  33.     key_vault.drop()
  34.     key_vault.create_index(
  35.         "keyAltNames",
  36.         unique=True,
  37.         partialFilterExpression={"keyAltNames": {"$exists": True}})
  39.     client_encryption = ClientEncryption(
  40.         kms_providers,
  41.         key_vault_namespace,
  42.         key_vault_client,
  43.         # The CodecOptions class used for encrypting and decrypting.
  44.         # This should be the same CodecOptions instance you have configured
  45.         # on MongoClient, Database, or Collection. We will not be calling
  46.         # encrypt() or decrypt() in this example so we can use any
  47.         # CodecOptions.
  48.         CodecOptions())
  50.     # Create a new data key and json schema for the encryptedField.
  51.     data_key_id = client_encryption.create_data_key(
  52.         'local', key_alt_names=['pymongo_encryption_example_2'])
  53.     json_schema = {
  54.         "properties": {
  55.             "encryptedField": {
  56.                 "encrypt": {
  57.                     "keyId": [data_key_id],
  58.                     "bsonType": "string",
  59.                     "algorithm":
  60.                         Algorithm.AEAD_AES_256_CBC_HMAC_SHA_512_Deterministic
  61.                 }
  62.             }
  63.         },
  64.         "bsonType": "object"
  65.     }
  67.     auto_encryption_opts = AutoEncryptionOpts(
  68.         kms_providers, key_vault_namespace)
  69.     client = MongoClient(auto_encryption_opts=auto_encryption_opts)
  70.     db_name, coll_name = encrypted_namespace.split(".", 1)
  71.     db = client[db_name]
  72.     # Clear old data
  73.     db.drop_collection(coll_name)
  74.     # Create the collection with the encryption JSON Schema.
  75.     db.create_collection(
  76.         coll_name,
  77.         # uuid_representation=STANDARD is required to ensure that any
  78.         # UUIDs in the $jsonSchema document are encoded to BSON Binary
  79.         # with the standard UUID subtype 4. This is only needed when
  80.         # running the "create" collection command with an encryption
  81.         # JSON Schema.
  82.         codec_options=CodecOptions(uuid_representation=STANDARD),
  83.         write_concern=WriteConcern(w="majority"),
  84.         validator={"$jsonSchema": json_schema})
  85.     coll = client[db_name][coll_name]
  87.     coll.insert_one({"encryptedField": "123456789"})
  88.     print('Decrypted document: %s' % (coll.find_one(),))
  89.     unencrypted_coll = MongoClient()[db_name][coll_name]
  90.     print('Encrypted document: %s' % (unencrypted_coll.find_one(),))
  91.     try:
  92.         unencrypted_coll.insert_one({"encryptedField": "123456789"})
  93.     except OperationFailure as exc:
  94.         print('Unencrypted insert failed: %s' % (exc.details,))
  97. if __name__ == "__main__":
  98.     main()

Explicit Encryption

Explicit encryption is a MongoDB community feature and does not use the mongocryptd process. Explicit encryption is provided by the ClientEncryption class, for example:

  1. import os
  3. from pymongo import MongoClient
  4. from pymongo.encryption import (Algorithm,
  5.                                 ClientEncryption)
  8. def main():
  9.     # This must be the same master key that was used to create
  10.     # the encryption key.
  11.     local_master_key = os.urandom(96)
  12.     kms_providers = {"local": {"key": local_master_key}}
  14.     # The MongoDB namespace (db.collection) used to store
  15.     # the encryption data keys.
  16.     key_vault_namespace = "encryption.__pymongoTestKeyVault"
  17.     key_vault_db_name, key_vault_coll_name = key_vault_namespace.split(".", 1)
  19.     # The MongoClient used to read/write application data.
  20.     client = MongoClient()
  21.     coll = client.test.coll
  22.     # Clear old data
  23.     coll.drop()
  25.     # Set up the key vault (key_vault_namespace) for this example.
  26.     key_vault = client[key_vault_db_name][key_vault_coll_name]
  27.     # Ensure that two data keys cannot share the same keyAltName.
  28.     key_vault.drop()
  29.     key_vault.create_index(
  30.         "keyAltNames",
  31.         unique=True,
  32.         partialFilterExpression={"keyAltNames": {"$exists": True}})
  34.     client_encryption = ClientEncryption(
  35.         kms_providers,
  36.         key_vault_namespace,
  37.         # The MongoClient to use for reading/writing to the key vault.
  38.         # This can be the same MongoClient used by the main application.
  39.         client,
  40.         # The CodecOptions class used for encrypting and decrypting.
  41.         # This should be the same CodecOptions instance you have configured
  42.         # on MongoClient, Database, or Collection.
  43.         coll.codec_options)
  45.     # Create a new data key for the encryptedField.
  46.     data_key_id = client_encryption.create_data_key(
  47.         'local', key_alt_names=['pymongo_encryption_example_3'])
  49.     # Explicitly encrypt a field:
  50.     encrypted_field = client_encryption.encrypt(
  51.         "123456789",
  52.         Algorithm.AEAD_AES_256_CBC_HMAC_SHA_512_Deterministic,
  53.         key_id=data_key_id)
  54.     coll.insert_one({"encryptedField": encrypted_field})
  55.     doc = coll.find_one()
  56.     print('Encrypted document: %s' % (doc,))
  58.     # Explicitly decrypt the field:
  59.     doc["encryptedField"] = client_encryption.decrypt(doc["encryptedField"])
  60.     print('Decrypted document: %s' % (doc,))
  62.     # Cleanup resources.
  63.     client_encryption.close()
  64.     client.close()
  67. if __name__ == "__main__":
  68.     main()

Explicit Encryption with Automatic Decryption

Although automatic encryption requires MongoDB 4.2 enterprise or a MongoDB 4.2 Atlas cluster, automatic decryption is supported for all users. To configure automatic decryption without automatic encryption set bypass_auto_encryption=True in AutoEncryptionOpts:

  1. import os
  3. from pymongo import MongoClient
  4. from pymongo.encryption import (Algorithm,
  5.                                 ClientEncryption)
  6. from pymongo.encryption_options import AutoEncryptionOpts
  9. def main():
  10.     # This must be the same master key that was used to create
  11.     # the encryption key.
  12.     local_master_key = os.urandom(96)
  13.     kms_providers = {"local": {"key": local_master_key}}
  15.     # The MongoDB namespace (db.collection) used to store
  16.     # the encryption data keys.
  17.     key_vault_namespace = "encryption.__pymongoTestKeyVault"
  18.     key_vault_db_name, key_vault_coll_name = key_vault_namespace.split(".", 1)
  20.     # bypass_auto_encryption=True disable automatic encryption but keeps
  21.     # the automatic _decryption_ behavior. bypass_auto_encryption will
  22.     # also disable spawning mongocryptd.
  23.     auto_encryption_opts = AutoEncryptionOpts(
  24.         kms_providers, key_vault_namespace, bypass_auto_encryption=True)
  26.     client = MongoClient(auto_encryption_opts=auto_encryption_opts)
  27.     coll = client.test.coll
  28.     # Clear old data
  29.     coll.drop()
  31.     # Set up the key vault (key_vault_namespace) for this example.
  32.     key_vault = client[key_vault_db_name][key_vault_coll_name]
  33.     # Ensure that two data keys cannot share the same keyAltName.
  34.     key_vault.drop()
  35.     key_vault.create_index(
  36.         "keyAltNames",
  37.         unique=True,
  38.         partialFilterExpression={"keyAltNames": {"$exists": True}})
  40.     client_encryption = ClientEncryption(
  41.         kms_providers,
  42.         key_vault_namespace,
  43.         # The MongoClient to use for reading/writing to the key vault.
  44.         # This can be the same MongoClient used by the main application.
  45.         client,
  46.         # The CodecOptions class used for encrypting and decrypting.
  47.         # This should be the same CodecOptions instance you have configured
  48.         # on MongoClient, Database, or Collection.
  49.         coll.codec_options)
  51.     # Create a new data key for the encryptedField.
  52.     data_key_id = client_encryption.create_data_key(
  53.         'local', key_alt_names=['pymongo_encryption_example_4'])
  55.     # Explicitly encrypt a field:
  56.     encrypted_field = client_encryption.encrypt(
  57.         "123456789",
  58.         Algorithm.AEAD_AES_256_CBC_HMAC_SHA_512_Deterministic,
  59.         key_alt_name='pymongo_encryption_example_4')
  60.     coll.insert_one({"encryptedField": encrypted_field})
  61.     # Automatically decrypts any encrypted fields.
  62.     doc = coll.find_one()
  63.     print('Decrypted document: %s' % (doc,))
  64.     unencrypted_coll = MongoClient().test.coll
  65.     print('Encrypted document: %s' % (unencrypted_coll.find_one(),))
  67.     # Cleanup resources.
  68.     client_encryption.close()
  69.     client.close()
  72. if __name__ == "__main__":
  73.     main()