Skip to content

Commit 358652a

Browse files
authored
DOCSP-31290: ssl options deprecated in v6.0 (#731)
* DOCSP-31290-ssl-deprecation-v6.0 * highlighting fix * small fix * CC suggestions
1 parent 5344333 commit 358652a

File tree

3 files changed

+23
-9
lines changed

3 files changed

+23
-9
lines changed

source/fundamentals/authentication/mechanisms.txt

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -281,11 +281,16 @@ Pass the location of your client certificate file as the value of
281281
.. literalinclude:: /code-snippets/authentication/x509.js
282282
:language: javascript
283283

284-
TLS/SSL Options
285-
~~~~~~~~~~~~~~~
284+
.. tip::
285+
286+
To learn more about enabling TLS on a connection, see
287+
:ref:`node-connect-tls`.
288+
289+
TLS Options
290+
~~~~~~~~~~~
286291

287-
The following table describes each of the TLS/SSL options that can be passed
288-
as a parameter in the connection URI.
292+
The following table describes the TLS options that you can set in a
293+
connection URI.
289294

290295
.. list-table::
291296
:widths: 35 12 10 43
@@ -299,7 +304,7 @@ as a parameter in the connection URI.
299304
* - ``tls``
300305
- boolean
301306
- ``false``
302-
- Specifies whether to use TLS/SSL connections.
307+
- Specifies whether to enable TLS on the connection.
303308

304309
* - ``tlsInsecure``
305310
- boolean

source/fundamentals/connection/tls.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -189,16 +189,15 @@ You can include the filepaths for your certificates as client options to
189189
retrieve your certificates while connecting with TLS.
190190

191191
The following code shows how to provide certificate filepaths as options
192-
in your ``MongoClient``:
192+
in your ``MongoClient``:
193193

194194
.. code-block:: js
195-
:emphasize-lines: 4-6
195+
:emphasize-lines: 4-5
196196

197197
// Pass filepaths as client options
198198
const client = new MongoClient(uri, {
199199
tls: true,
200200
tlsCAFile: `<path to CA certificate>`,
201-
tlsCertificateFile: `<path to public client certificate>`,
202201
tlsCertificateKeyFile: `<path to private client key>`,
203202
});
204203

source/whats-new.txt

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,21 @@ What's New in 6.0
4848

4949
The {+driver-short+} v6.0 release includes the following features:
5050

51+
.. important:: Deprecation Notice
52+
53+
All of the ``ssl``-prefixed options in the ``MongoClientOptions``
54+
type are deprecated. In addition, the ``tlsCertificateFile`` option
55+
is deprecated.
56+
57+
Instead, you should store your certificates in a ``SecureContext``
58+
object or set the ``tls``-prefixed options in your
59+
``MongoClientOptions`` instance. To learn more, see :ref:`node-connect-tls`.
60+
5161
- Removes support for the ``addUser()`` helper command. Use the
5262
:manual:`createUser </reference/command/createUser>` MongoDB Shell command instead.
5363
- Removes support for the ``collStats`` operation. Use the
5464
:manual:`$collStats </reference/operator/aggregation/collStats>` aggregation operator
55-
instead.
65+
instead.
5666

5767
.. _version-5.7:
5868

0 commit comments

Comments
 (0)