Skip to content

Commit abca930

Browse files
committed
Second round of RR feedback
1 parent fd61149 commit abca930

File tree

1 file changed

+13
-18
lines changed

1 file changed

+13
-18
lines changed

source/connect/tls.txt

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,6 @@ In this guide, you can learn how to use the
2424
:wikipedia:`TLS <w/index.php?title=Transport_Layer_Security&oldid=1239598620>`
2525
security protocol when connecting to MongoDB by using the {+driver-short+}.
2626

27-
.. note:: Debugging TLS
28-
29-
If you experience trouble setting up your TLS connection, you can
30-
use the ``-Djavax.net.debug=all`` system property to view helpful
31-
log statements. See `Debugging SSL/TLS connections
32-
<https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/ReadDebug.html>`__
33-
in the Java language documentation for more information.
34-
3527
.. _kotlin-sync-tls-enable:
3628

3729
Enable TLS
@@ -59,8 +51,8 @@ in the following ways:
5951
.. tab:: Connection String
6052
:tabid: connectionstring
6153

62-
To enable TLS on a connection by using a connection string, set the connection string
63-
parameter ``tls`` to ``true`` in the connection string passed to
54+
To enable TLS on a connection by using a connection string, set the
55+
``tls`` option to ``true`` in the options parameter and pass the string to
6456
``MongoClient.create()``, as shown in the following code:
6557

6658
.. literalinclude:: /includes/connect/tls.kt
@@ -84,6 +76,14 @@ in the following ways:
8476
:copyable:
8577
:dedent:
8678

79+
.. note:: Debugging TLS
80+
81+
If you experience trouble setting up your TLS connection, you can
82+
use the ``-Djavax.net.debug=all`` system property to view helpful
83+
log statements. See `Debugging SSL/TLS connections
84+
<https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/ReadDebug.html>`__
85+
in the Java language documentation for more information.
86+
8787
.. _tls_configure-certificates:
8888

8989
Configure Certificates
@@ -106,7 +106,7 @@ Configure the JVM Trust Store
106106

107107
By default, the JRE includes many commonly used public certificates
108108
from signing authorities such as `Let's Encrypt
109-
<https://letsencrypt.org/>`__. As a result, you can connect to a
109+
<https://letsencrypt.org/>`__. As a result, you can enable TLS when connecting to a
110110
:atlas:`MongoDB Atlas </>` instance, or any other
111111
server whose certificate is signed by an authority in the JRE's default
112112
certificate store, with TLS enabled without configuring the trust store.
@@ -147,11 +147,6 @@ Configure the JVM Key Store
147147
validation. You must configure the key store if you configured your MongoDB
148148
instance to validate client certificates.
149149

150-
The JVM key store saves certificates that securely identify your {+language+}
151-
application to other applications. By using these certificates, other
152-
applications can prove that the connection to your application is
153-
genuine and secure from tampering by third parties.
154-
155150
An application that initiates TLS requests must set the following JVM system
156151
properties to ensure that the client presents a TLS certificate to
157152
the MongoDB server:
@@ -180,7 +175,7 @@ You can configure a client-specific trust store and key store by using the
180175
``init()`` method of the ``SSLContext`` class.
181176

182177
Find an example showing how to configure a client to use an ``SSLContext``
183-
instance in the :ref:`Customize TLS Configuration with an SSLContext section of this guide <kotlin-sync-tls-custom-sslContext>`.
178+
instance in the :ref:`<kotlin-sync-tls-custom-sslContext>` section of this guide.
184179

185180
Disable Hostname Verification
186181
-----------------------------
@@ -210,7 +205,7 @@ Restrict Connections to TLS 1.2 Only
210205
------------------------------------
211206

212207
To restrict your application to use only the TLS 1.2 protocol, set the
213-
``jdk.tls.client.protocols`` system property to "TLSv1.2".
208+
``jdk.tls.client.protocols`` system property to ``"TLSv1.2"``.
214209

215210
.. note::
216211

0 commit comments

Comments
 (0)