接口 AutoEncryptionOptions

interface AutoEncryptionOptions {
    bypassAutoEncryption?: boolean;
    bypassQueryAnalysis?: boolean;
    encryptedFieldsMap?: Document;
    extraOptions?: {
        cryptSharedLibPath?: string;
        cryptSharedLibRequired?: boolean;
        mongocryptdBypassSpawn?: boolean;
        mongocryptdSpawnArgs?: string[];
        mongocryptdSpawnPath?: string;
        mongocryptdURI?: string;
    };
    keyVaultClient?: MongoClient;
    keyVaultNamespace?: string;
    kmsProviders?: {
        aws?: | {
            accessKeyId: string;
            secretAccessKey: string;
            sessionToken?: string;
        }
        | Record<string, never>;
        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<ArrayBufferLike>;
            }
            | { accessToken: string };
        kmip?: { endpoint?: string };
        local?: { key: string | Buffer<ArrayBufferLike> };
    };
    options?: {
        logger?: (level: AutoEncryptionLoggerLevel, message: string) => void;
    };
    proxyOptions?: ProxyOptions;
    schemaMap?: Document;
    tlsOptions?: {
        aws?: AutoEncryptionTlsOptions;
        azure?: AutoEncryptionTlsOptions;
        gcp?: AutoEncryptionTlsOptions;
        kmip?: AutoEncryptionTlsOptions;
        local?: AutoEncryptionTlsOptions;
    };
}

索引

属性

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

属性

`可选`bypassAutoEncryption

bypassAutoEncryption?: boolean

Allows the user to bypass auto encryption, maintaining implicit decryption

`可选` `实验性`bypassQueryAnalysis

bypassQueryAnalysis?: boolean

Public Technical Preview: Allows users to bypass query analysis

`可选` `实验性`encryptedFieldsMap

encryptedFieldsMap?: Document

Public Technical Preview: Supply a schema for the encrypted fields in the document

`可选`extraOptions

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

类型声明

可选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.
可选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.
可选mongocryptdBypassSpawn?: boolean
If true, autoEncryption will not attempt to spawn a mongocryptd before connecting
可选mongocryptdSpawnArgs?: string[]
Command line arguments to use when auto-spawning a mongocryptd
可选mongocryptdSpawnPath?: string
The path to the mongocryptd executable on the system
可选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

`可选`keyVaultClient

keyVaultClient?: MongoClient

A MongoClient used to fetch keys from a key vault

`可选`keyVaultNamespace

keyVaultNamespace?: string

The namespace where keys are stored in the key vault

`可选`kmsProviders

kmsProviders?: {
    aws?:
        | {
            accessKeyId: string;
            secretAccessKey: string;
            sessionToken?: string;
        }
        | Record<string, never>;
    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<ArrayBufferLike>;
        }
        | { accessToken: string };
    kmip?: { endpoint?: string };
    local?: { key: string | Buffer<ArrayBufferLike> };
}

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

类型声明

可选aws?:
    | {
        accessKeyId: string;
        secretAccessKey: string;
        sessionToken?: string;
    }
    | Record<string, never>
Configuration options for using 'aws' as your KMS provider
可选azure?:
    | Record<string, never>
    | {
        clientId: string;
        clientSecret: string;
        identityPlatformEndpoint?: string;
        tenantId: string;
    }
    | { accessToken: string }
Configuration options for using 'azure' as your KMS provider
可选gcp?:
    | Record<string, never>
    | {
        email: string;
        endpoint?: string;
        privateKey: string | Buffer<ArrayBufferLike>;
    }
    | { accessToken: string }
Configuration options for using 'gcp' as your KMS provider
可选kmip?: { endpoint?: string }
Configuration options for using 'kmip' as your KMS provider
- 可选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.
可选local?: { key: string | Buffer<ArrayBufferLike> }
Configuration options for using 'local' as your KMS provider
- key: string | Buffer<ArrayBufferLike>
  The master key used to encrypt/decrypt data keys. A 96-byte long Buffer or base64 encoded string.

`可选`options

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

类型声明

可选logger?: (level: AutoEncryptionLoggerLevel, message: string) => void
An optional hook to catch logging messages from the underlying encryption engine

`可选`proxyOptions

proxyOptions?: ProxyOptions

`可选`schemaMap

schemaMap?: 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.

`可选`tlsOptions

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

The TLS options to use connecting to the KMS provider

接口 AutoEncryptionOptions

索引

属性

属性

`可选`bypassAutoEncryption

`可选` `实验性`bypassQueryAnalysis

`可选` `实验性`encryptedFieldsMap

`可选`extraOptions

类型声明

`可选`cryptSharedLibPath?: string

`可选`cryptSharedLibRequired?: boolean

`可选`mongocryptdBypassSpawn?: boolean

`可选`mongocryptdSpawnArgs?: string[]

`可选`mongocryptdSpawnPath?: string

`可选`mongocryptdURI?: string

`可选`keyVaultClient

`可选`keyVaultNamespace

`可选`kmsProviders

类型声明

`可选`aws?:
    | {
        accessKeyId: string;
        secretAccessKey: string;
        sessionToken?: string;
    }
    | Record<string, never>

`可选`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<ArrayBufferLike>;
    }
    | { accessToken: string }

`可选`kmip?: { endpoint?: string }

`可选`endpoint?: string

`可选`local?: { key: string | Buffer<ArrayBufferLike> }

key: string | Buffer<ArrayBufferLike>

`可选`options

类型声明

`可选`logger?: (level: AutoEncryptionLoggerLevel, message: string) => void

`可选`proxyOptions

`可选`schemaMap

`可选`tlsOptions

显示设置

目录

接口 AutoEncryptionOptions

索引

属性

属性

可选bypassAutoEncryption

可选 实验性bypassQueryAnalysis

可选 实验性encryptedFieldsMap

可选extraOptions

类型声明

可选cryptSharedLibPath?: string

可选cryptSharedLibRequired?: boolean

可选mongocryptdBypassSpawn?: boolean

可选mongocryptdSpawnArgs?: string[]

可选mongocryptdSpawnPath?: string

可选mongocryptdURI?: string

可选keyVaultClient

可选keyVaultNamespace

可选kmsProviders

类型声明

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

可选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<ArrayBufferLike>; } | { accessToken: string }

可选kmip?: { endpoint?: string }

可选endpoint?: string

可选local?: { key: string | Buffer<ArrayBufferLike> }

key: string | Buffer<ArrayBufferLike>

可选options

类型声明

可选logger?: (level: AutoEncryptionLoggerLevel, message: string) => void

可选proxyOptions

可选schemaMap

可选tlsOptions

显示设置

目录

`可选`bypassAutoEncryption

`可选` `实验性`bypassQueryAnalysis

`可选` `实验性`encryptedFieldsMap

`可选`extraOptions

`可选`cryptSharedLibPath?: string

`可选`cryptSharedLibRequired?: boolean

`可选`mongocryptdBypassSpawn?: boolean

`可选`mongocryptdSpawnArgs?: string[]

`可选`mongocryptdSpawnPath?: string

`可选`mongocryptdURI?: string

`可选`keyVaultClient

`可选`keyVaultNamespace

`可选`kmsProviders

`可选`aws?:
| {
accessKeyId: string;
secretAccessKey: string;
sessionToken?: string;
}
| Record<string, never>

`可选`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<ArrayBufferLike>;
}
| { accessToken: string }

`可选`kmip?: { endpoint?: string }

`可选`endpoint?: string

`可选`local?: { key: string | Buffer<ArrayBufferLike> }

`可选`options

`可选`logger?: (level: AutoEncryptionLoggerLevel, message: string) => void

`可选`proxyOptions

`可选`schemaMap

`可选`tlsOptions