Interface ClientEncryptionOptions

Additional settings to provide when creating a new ClientEncryption instance.

interface ClientEncryptionOptions {
    credentialProviders?: CredentialProviders;
    keyExpirationMS?: number;
    keyVaultClient?: MongoClient;
    keyVaultNamespace: string;
    kmsConnectCallback?: KMSConnectCallback;
    kmsProviders?: KMSProviders;
    proxyOptions?: ProxyOptions;
    timeoutMS?: number;
    tlsOptions?: CSFLEKMSTlsOptions;
}

Properties

credentialProviders? keyExpirationMS? keyVaultClient? keyVaultNamespace kmsConnectCallback? kmsProviders? proxyOptions? timeoutMS? tlsOptions?

Properties

OptionalcredentialProviders

credentialProviders?: CredentialProviders

Options for user provided custom credential providers.

OptionalkeyExpirationMS

keyExpirationMS?: number

Sets the expiration time for the DEK in the cache in milliseconds. Defaults to 60000. 0 means no timeout.

OptionalkeyVaultClient

keyVaultClient?: MongoClient

A MongoClient used to fetch keys from a key vault. Defaults to client.

keyVaultNamespace

keyVaultNamespace: string

The namespace of the key vault, used to store encryption keys

OptionalkmsConnectCallback

kmsConnectCallback?: KMSConnectCallback

A callback that establishes the socket used to connect to a KMS host, e.g. to route KMS requests through an HTTP proxy via the HTTP CONNECT method. Mutually exclusive with proxyOptions. See KMSConnectCallback for a usage example.

OptionalkmsProviders

kmsProviders?: KMSProviders

Options for specific KMS providers to use

OptionalproxyOptions

proxyOptions?: ProxyOptions

Options for specifying a Socks5 proxy to use for connecting to the KMS.

OptionaltimeoutMS

timeoutMS?: number

The timeout setting to be used for all the operations on ClientEncryption.

Deprecated

timeoutMS has no effect and will be removed in a future release.

OptionaltlsOptions

tlsOptions?: CSFLEKMSTlsOptions

TLS options for kms providers to use.

Settings

Member Visibility

On This Page

Properties