-
Notifications
You must be signed in to change notification settings - Fork 1.8k
chore(NODE-4285): rename csfle shared library references #3280
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -324,40 +324,40 @@ export interface AutoEncryptionOptions { | |
| /** Command line arguments to use when auto-spawning a mongocryptd */ | ||
| mongocryptdSpawnArgs?: string[]; | ||
| /** | ||
| * Full path to a CSFLE shared library to be used (instead of mongocryptd). | ||
| * 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 CSFLE shared library files from different | ||
| * 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 CSFLE shared library could be loaded | ||
| * 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 `csfleRequired` is not specified, | ||
| * 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. | ||
| */ | ||
| csflePath?: string; | ||
| cryptSharedLibPath?: string; | ||
| /** | ||
| * If specified, never use mongocryptd and instead fail when the CSFLE shared library | ||
| * could not be loaded. | ||
| * If specified, never use mongocryptd and instead fail when the MongoDB Crypt | ||
| * shared library could not be loaded. | ||
| * | ||
| * This is always true when `csflePath` is specified. | ||
| * This is always true when `cryptSharedLibPath` is specified. | ||
| */ | ||
| csfleRequired?: boolean; | ||
| cryptSharedLibRequired?: boolean; | ||
| /** | ||
| * Search paths for a CSFLE shared library to be used (instead of mongocryptd) | ||
| * Search paths for a MongoDB Crypt shared library to be used (instead of mongocryptd) | ||
| * Only for driver testing! | ||
| * @internal | ||
| */ | ||
| csfleSearchPaths?: string[]; | ||
| cryptSharedLibSearchPaths?: string[]; | ||
| }; | ||
| proxyOptions?: ProxyOptions; | ||
| /** The TLS options to use connecting to the KMS provider */ | ||
|
|
@@ -378,5 +378,5 @@ export interface AutoEncrypter { | |
| teardown(force: boolean, callback: Callback): void; | ||
| encrypt(ns: string, cmd: Document, options: any, callback: Callback<Document>): void; | ||
| decrypt(cmd: Document, options: any, callback: Callback<Document>): void; | ||
| readonly csfleVersionInfo: { version: bigint; versionStr: string } | null; | ||
| readonly cryptSharedLibVersionInfo: { version: bigint; versionStr: string } | null; | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Would we also want to mark this property with a tag?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah, that makes sense. I think this is also the only |
||
| } | ||
Uh oh!
There was an error while loading. Please reload this page.