# `encryption_options` – Automatic Client-Side Field Level Encryption

Support for automatic client-side field level encryption.

See also

This module is compatible with both the synchronous and asynchronous PyMongo APIs.

class pymongo.encryption_options.AutoEncryptionOpts(kms_providers, key_vault_namespace, key_vault_client=None, schema_map=None, bypass_auto_encryption=False, mongocryptd_uri='mongodb://localhost:27020', mongocryptd_bypass_spawn=False, mongocryptd_spawn_path='mongocryptd', mongocryptd_spawn_args=None, kms_tls_options=None, crypt_shared_lib_path=None, crypt_shared_lib_required=False, bypass_query_analysis=False, encrypted_fields_map=None, key_expiration_ms=None)

  Options to configure automatic client-side field level encryption.

  Automatic client-side field level encryption requires MongoDB >=4.2 enterprise or a MongoDB >=4.2 Atlas cluster. Automatic encryption is not supported for operations on a database or view and will result in error.

  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`. Explicit encryption and explicit decryption is also supported for all users with the `AsyncClientEncryption` and `ClientEncryption` classes.

  See client-side field level encryption for an example.

  Parameters:

    - kms_providers (Mapping[str, Any]) –

      Map of KMS provider options. The kms_providers map values differ by provider:

      > - aws: Map with “accessKeyId” and “secretAccessKey” as strings. These are the AWS access key ID and AWS secret access key used to generate KMS messages. An optional “sessionToken” may be included to support temporary AWS credentials.

      > - azure: Map with “tenantId”, “clientId”, and “clientSecret” as strings. Additionally, “identityPlatformEndpoint” may also be specified as a string (defaults to ‘login.microsoftonline.com’). These are the Azure Active Directory credentials used to generate Azure Key Vault messages.

      > - gcp: Map with “email” as a string and “privateKey” as bytes or a base64 encoded string. Additionally, “endpoint” may also be specified as a string (defaults to ‘oauth2.googleapis.com’). These are the credentials used to generate Google Cloud KMS messages.

      > - kmip: Map with “endpoint” as a host with required port. For example: `{"endpoint": "example.com:443"}`.

      > - local: Map with “key” as bytes (96 bytes in length) or a base64 encoded string which decodes to 96 bytes. “key” is the master key used to encrypt/decrypt data keys. This key should be generated and stored as securely as possible.

      KMS providers may be specified with an optional name suffix separated by a colon, for example “kmip:name” or “aws:name”. Named KMS providers do not support CSFLE on-demand credentials. Named KMS providers enables more than one of each KMS provider type to be configured. For example, to configure multiple local KMS providers:

          kms_providers = {
              "local": {"key": local_kek1},        # Unnamed KMS provider.
              "local:myname": {"key": local_kek2}, # Named KMS provider with name "myname".
          }

    - key_vault_namespace (str) – The namespace for the key vault collection. The key vault collection contains all data keys used for encryption and decryption. Data keys are stored as documents in this MongoDB collection. Data keys are protected with encryption by a KMS provider.

    - key_vault_client (Optional[_AgnosticMongoClient]) – By default, the key vault collection is assumed to reside in the same MongoDB cluster as the encrypted AsyncMongoClient/MongoClient. Use this option to route data key queries to a separate MongoDB cluster.

    - schema_map (Optional[Mapping[str, Any]]) –

      Map of collection namespace (“db.coll”) to JSON Schema. By default, a collection’s JSONSchema is periodically polled with the listCollections command. But a JSONSchema may be specified locally with the schemaMap option.

      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.

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

    - bypass_auto_encryption (bool) – If `True`, automatic encryption will be disabled but automatic decryption will still be enabled. Defaults to `False`.

    - mongocryptd_uri (str) – The MongoDB URI used to connect to the local mongocryptd process. Defaults to `'mongodb://localhost:27020'`.

    - mongocryptd_bypass_spawn (bool) – If `True`, the encrypted AsyncMongoClient/MongoClient will not attempt to spawn the mongocryptd process. Defaults to `False`.

    - mongocryptd_spawn_path (str) – Used for spawning the mongocryptd process. Defaults to `'mongocryptd'` and spawns mongocryptd from the system path.

    - mongocryptd_spawn_args (Optional[list[str]]) – A list of string arguments to use when spawning the mongocryptd process. Defaults to `['--idleShutdownTimeoutSecs=60']`. If the list does not include the `idleShutdownTimeoutSecs` option then `'--idleShutdownTimeoutSecs=60'` will be added.

    - kms_tls_options (Optional[Mapping[str, Any]]) –

      A map of KMS provider names to TLS options to use when creating secure connections to KMS providers. Accepts the same TLS options as `pymongo.mongo_client.AsyncMongoClient` and `pymongo.mongo_client.MongoClient`. For example, to override the system default CA file:

          kms_tls_options={'kmip': {'tlsCAFile': certifi.where()}}

      Or to supply a client certificate:

          kms_tls_options={'kmip': {'tlsCertificateKeyFile': 'client.pem'}}

    - crypt_shared_lib_path (Optional[str]) – Override the path to load the crypt_shared library.

    - crypt_shared_lib_required (bool) – If True, raise an error if libmongocrypt is unable to load the crypt_shared library.

    - bypass_query_analysis (bool) – If `True`, disable automatic analysis of outgoing commands. Set bypass_query_analysis to use explicit encryption on indexed fields without the MongoDB Enterprise Advanced licensed crypt_shared library.

    - encrypted_fields_map (Optional[Mapping[str, Any]]) –

      Map of collection namespace (“db.coll”) to documents that described the encrypted fields for Queryable Encryption. For example:

          {
            "db.encryptedCollection": {
                "escCollection": "enxcol_.encryptedCollection.esc",
                "ecocCollection": "enxcol_.encryptedCollection.ecoc",
                "fields": [
                    {
                        "path": "firstName",
                        "keyId": Binary.from_uuid(UUID('00000000-0000-0000-0000-000000000000')),
                        "bsonType": "string",
                        "queries": {"queryType": "equality"}
                    },
                    {
                        "path": "ssn",
                        "keyId": Binary.from_uuid(UUID('04104104-1041-0410-4104-104104104104')),
                        "bsonType": "string"
                    }
                ]
            }
          }

    - key_expiration_ms (Optional[int]) – The cache expiration time for data encryption keys. Defaults to `None` which defers to libmongocrypt’s default which is currently 60000. Set to 0 to disable key expiration.

  Changed in version 4.12: Added the key_expiration_ms parameter.

  Changed in version 4.2: Added the encrypted_fields_map, crypt_shared_lib_path, crypt_shared_lib_required, and bypass_query_analysis parameters.

  Changed in version 4.0: Added the kms_tls_options parameter and the “kmip” KMS provider.

  Added in version 3.9.

class pymongo.encryption_options.PrefixOpts

  BETA Options for prefix text queries.

  PrefixOpts is currently unstable API and subject to backwards breaking changes.

class pymongo.encryption_options.RangeOpts(sparsity=None, trim_factor=None, min=None, max=None, precision=None)

  Options to configure encrypted queries using the range algorithm.

  Parameters:

    - sparsity (Optional[int]) – An integer.

    - trim_factor (Optional[int]) – An integer.

    - min (Optional[Any]) – A BSON scalar value corresponding to the type being queried.

    - max (Optional[Any]) – A BSON scalar value corresponding to the type being queried.

    - precision (Optional[int]) – An integer, may only be set for double or decimal128 types.

  Added in version 4.4.

class pymongo.encryption_options.SubstringOpts

  BETA Options for substring text queries.

  SubstringOpts is currently unstable API and subject to backwards breaking changes.

class pymongo.encryption_options.SuffixOpts

  BETA Options for suffix text queries.

  SuffixOpts is currently unstable API and subject to backwards breaking changes.

class pymongo.encryption_options.TextOpts(substring=None, prefix=None, suffix=None, case_sensitive=None, diacritic_sensitive=None)

  Options to configure encrypted queries using the text algorithm.

  Parameters:

    - substring (Optional[SubstringOpts]) – Further options to support substring queries.

    - prefix (Optional[PrefixOpts]) – Further options to support prefix queries.

    - suffix (Optional[SuffixOpts]) – Further options to support suffix queries.

    - case_sensitive (Optional[bool]) – Whether text indexes for this field are case sensitive.

    - diacritic_sensitive (Optional[bool]) – Whether text indexes for this field are diacritic sensitive.

  Added in version 4.15.

pymongo.encryption_options.check_min_pymongocrypt()

  Raise an appropriate error if the min pymongocrypt is not installed.

  Return type:

    None