Interface AutoEncryptionOptions

Hierarchy

  • AutoEncryptionOptions

Properties

bypassAutoEncryption? bypassQueryAnalysis? encryptedFieldsMap? extraOptions? keyVaultClient? keyVaultNamespace? kmsProviders? options? proxyOptions? schemaMap? tlsOptions?

Properties

Optional bypassAutoEncryption

bypassAutoEncryption?: boolean

Allows the user to bypass auto encryption, maintaining implicit decryption

Optional bypassQueryAnalysis

bypassQueryAnalysis?: boolean

Allows users to bypass query analysis

Optional encryptedFieldsMap

encryptedFieldsMap?: mongoose.mongo.BSON.Document

Supply a schema for the encrypted fields in the document

Optional extraOptions

extraOptions?: {
    cryptSharedLibPath?: string;
    cryptSharedLibRequired?: boolean;
    mongocryptdBypassSpawn?: boolean;
    mongocryptdSpawnArgs?: string[];
    mongocryptdSpawnPath?: string;
    mongocryptdURI?: string;
}

Type declaration

  • Optional cryptSharedLibPath?: string

    Full path to a MongoDB Crypt shared library to be used (instead of mongocryptd).

    This needs to be the path to the file itself, not a directory. It can be an absolute or relative path. If the path is relative and its first component is $ORIGIN, it will be replaced by the directory containing the mongodb-client-encryption native addon file. Otherwise, the path will be interpreted relative to the current working directory.

    Currently, loading different MongoDB Crypt shared library files from different MongoClients in the same process is not supported.

    If this option is provided and no MongoDB Crypt shared library could be loaded from the specified location, creating the MongoClient will fail.

    If this option is not provided and cryptSharedLibRequired is not specified, the AutoEncrypter will attempt to spawn and/or use mongocryptd according to the mongocryptd-specific extraOptions options.

    Specifying a path prevents mongocryptd from being used as a fallback.

    Requires the MongoDB Crypt shared library, available in MongoDB 6.0 or higher.

  • Optional cryptSharedLibRequired?: boolean

    If specified, never use mongocryptd and instead fail when the MongoDB Crypt shared library could not be loaded.

    This is always true when cryptSharedLibPath is specified.

    Requires the MongoDB Crypt shared library, available in MongoDB 6.0 or higher.

  • Optional mongocryptdBypassSpawn?: boolean

    If true, autoEncryption will not attempt to spawn a mongocryptd before connecting

  • Optional mongocryptdSpawnArgs?: string[]

    Command line arguments to use when auto-spawning a mongocryptd

  • Optional mongocryptdSpawnPath?: string

    The path to the mongocryptd executable on the system

  • Optional mongocryptdURI?: string

    A local process the driver communicates with to determine how to encrypt values in a command. Defaults to "mongodb://%2Fvar%2Fmongocryptd.sock" if domain sockets are available or "mongodb://localhost:27020" otherwise

Optional keyVaultClient

keyVaultClient?: MongoClient

A MongoClient used to fetch keys from a key vault

Optional keyVaultNamespace

keyVaultNamespace?: string

The namespace where keys are stored in the key vault

Optional kmsProviders

kmsProviders?: {
    aws?: Record<string, never> | {
        accessKeyId: string;
        secretAccessKey: string;
        sessionToken?: string;
    };
    azure?: Record<string, never> | {
        clientId: string;
        clientSecret: string;
        identityPlatformEndpoint?: string;
        tenantId: string;
    } | {
        accessToken: string;
    };
    gcp?: Record<string, never> | {
        email: string;
        endpoint?: string;
        privateKey: string | Buffer;
    } | {
        accessToken: string;
    };
    kmip?: {
        endpoint?: string;
    };
    local?: {
        key: string | Buffer;
    };
}

Configuration options that are used by specific KMS providers during key generation, encryption, and decryption.

Type declaration

  • Optional aws?: Record<string, never> | {
        accessKeyId: string;
        secretAccessKey: string;
        sessionToken?: string;
    }

    Configuration options for using 'aws' as your KMS provider

  • Optional azure?: Record<string, never> | {
        clientId: string;
        clientSecret: string;
        identityPlatformEndpoint?: string;
        tenantId: string;
    } | {
        accessToken: string;
    }

    Configuration options for using 'azure' as your KMS provider

  • Optional gcp?: Record<string, never> | {
        email: string;
        endpoint?: string;
        privateKey: string | Buffer;
    } | {
        accessToken: string;
    }

    Configuration options for using 'gcp' as your KMS provider

  • Optional kmip?: {
        endpoint?: string;
    }

    Configuration options for using 'kmip' as your KMS provider

    • Optional endpoint?: string

      The output endpoint string. The endpoint consists of a hostname and port separated by a colon. E.g. "example.com:123". A port is always present.

  • Optional local?: {
        key: string | Buffer;
    }

    Configuration options for using 'local' as your KMS provider

    • key: string | Buffer

      The master key used to encrypt/decrypt data keys. A 96-byte long Buffer or base64 encoded string.

Optional options

options?: {
    logger?: ((level, message) => void);
}

Type declaration

  • Optional logger?: ((level, message) => void)
      • (level, message): void

      • An optional hook to catch logging messages from the underlying encryption engine

        Parameters

        Returns void

Optional proxyOptions

proxyOptions?: ProxyOptions

Optional schemaMap

schemaMap?: mongoose.mongo.BSON.Document

A map of namespaces to a local JSON schema for encryption

NOTE: Supplying options.schemaMap 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 decrypted data that should be encrypted. Schemas supplied in the schemaMap only apply to configuring automatic encryption for 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.

Optional tlsOptions

tlsOptions?: {
    aws?: AutoEncryptionTlsOptions;
    azure?: AutoEncryptionTlsOptions;
    gcp?: AutoEncryptionTlsOptions;
    kmip?: AutoEncryptionTlsOptions;
    local?: AutoEncryptionTlsOptions;
}

The TLS options to use connecting to the KMS provider

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc