Skip to content

docs(NODE-4778): update tls option notes #3671

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.

Sign up for GitHub

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

Merged
dariakp merged 5 commits into from
May 16, 2023
Merged

docs(NODE-4778): update tls option notes #3671

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f555d71
chore(NODE-4778): update tls option notes
durran May 15, 2023
1568903
chore: update table
durran May 16, 2023
b483fca
chore: update table and notes
durran May 16, 2023
32ac0a3
docs: update table
durran May 16, 2023
6d30ef7
docs: typo
dariakp May 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 19 additions & 9 deletions src/mongo_client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -772,19 +772,29 @@ export interface MongoOptions
/**
* # NOTE ABOUT TLS Options
*
* If set TLS enabled, equivalent to setting the ssl option.
* If `tls` is provided as an option, it is equivalent to setting the `ssl` option.
*
* NodeJS native TLS options are passed through to the socket and retain their original types.
*
* ### Additional options:
*
* | nodejs option | MongoDB equivalent | type |
* |:---------------------|--------------------------------------------------------- |:---------------------------------------|
* | `ca` | `sslCA`, `tlsCAFile` | `string \| Buffer \| Buffer[]` |
* | `crl` | `sslCRL` | `string \| Buffer \| Buffer[]` |
* | `cert` | `sslCert`, `tlsCertificateFile`, `tlsCertificateKeyFile` | `string \| Buffer \| Buffer[]` |
* | `key` | `sslKey`, `tlsCertificateKeyFile` | `string \| Buffer \| KeyObject[]` |
* | `passphrase` | `sslPass`, `tlsCertificateKeyFilePassword` | `string` |
* | `rejectUnauthorized` | `sslValidate` | `boolean` |
* | nodejs native option | driver spec compliant option name | legacy option name | driver option type |
* |:----------------------|:----------------------------------------------|:-------------------|:-------------------|
* | `ca` | `tlsCAFile` | `sslCA` | `string` |
* | `crl` | N/A | `sslCRL` | `string` |
* | `cert` | `tlsCertificateFile`, `tlsCertificateKeyFile` | `sslCert` | `string` |
* | `key` | `tlsCertificateKeyFile` | `sslKey` | `string` |
* | `passphrase` | `tlsCertificateKeyFilePassword` | `sslPass` | `string` |
* | `rejectUnauthorized` | `tlsAllowInvalidCertificates` | `sslValidate` | `boolean` |
* | `checkServerIdentity` | `tlsAllowInvalidHostnames` | N/A | `boolean` |
* | see note below | `tlsInsecure` | N/A | `boolean` |
*
* If `tlsInsecure` is set to `true`, then it will set the node native options `checkServerIdentity`
* to a no-op and `rejectUnauthorized` to `false`.
*
* If `tlsInsecure` is set to `false`, then it will set the node native options `checkServerIdentity`
* to a no-op and `rejectUnauthorized` to the inverse value of `tlsAllowInvalidCertificates`. If
* `tlsAllowInvalidCertificates` is not set, then `rejectUnauthorized` will be set to `true`.
*/
tls: boolean;

Expand Down