DOCSP-41508: TLS #37
Merged
DOCSP-41508: TLS #37
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-kotlin-sync ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
rustagir
requested changes
Aug 15, 2024
source/connect/tls.txt
Outdated
Comment on lines
218
to
223
| .. warning:: | ||
|
|
||
| Disabling hostname verification can make your configuration | ||
| `insecure <https://tlseminar.github.io/docs/mostdangerous.pdf>`__. | ||
| Disable hostname verification only for testing purposes or | ||
| when there is no other alternative. |
There was a problem hiding this comment.
Specifying this option in a production environment makes your application insecure and potentially vulnerable to expired certificates and foreign processes posing as valid client instances.
There was a problem hiding this comment.
Will modify the warning.
rustagir
approved these changes
Aug 15, 2024
source/connect/tls.txt
Outdated
Comment on lines
27
to
33
| .. note:: Debugging TLS | ||
|
|
||
| If you experience trouble setting up your TLS connection, you can | ||
| use the ``-Djavax.net.debug=all`` system property to view helpful | ||
| log statements. See `Debugging SSL/TLS connections | ||
| <https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/ReadDebug.html>`__ | ||
| in the Java language documentation for more information. |
There was a problem hiding this comment.
S; i think this note is coming too early in the page. Could move to the end of the Enable TLS section?
source/connect/tls.txt
Outdated
Comment on lines
62
to
64
| To enable TLS on a connection by using a connection string, set the connection string | ||
| parameter ``tls`` to ``true`` in the connection string passed to | ||
| ``MongoClient.create()``, as shown in the following code: |
There was a problem hiding this comment.
S: reduce the number of times "connection string" is mentioned:
Suggested change
| To enable TLS on a connection by using a connection string, set the connection string | |
| parameter ``tls`` to ``true`` in the connection string passed to | |
| ``MongoClient.create()``, as shown in the following code: | |
| To enable TLS on a connection by using a connection string, set the | |
| ``tls`` option to ``true`` in the options parameter and pass the string to | |
| ``MongoClient.create()``, as shown in the following code: |
source/connect/tls.txt
Outdated
Comment on lines
109
to
112
| <https://letsencrypt.org/>`__. As a result, you can connect to a | ||
| :atlas:`MongoDB Atlas </>` instance, or any other | ||
| server whose certificate is signed by an authority in the JRE's default | ||
| certificate store, with TLS enabled without configuring the trust store. |
There was a problem hiding this comment.
Suggested change
| <https://letsencrypt.org/>`__. As a result, you can connect to a | |
| :atlas:`MongoDB Atlas </>` instance, or any other | |
| server whose certificate is signed by an authority in the JRE's default | |
| certificate store, with TLS enabled without configuring the trust store. | |
| <https://letsencrypt.org/>`__. As a result, you can enable TLS when connecting to a | |
| :atlas:`MongoDB Atlas </>` instance, or any other | |
| server whose certificate is signed by an authority in the JRE's default | |
| certificate store, without configuring the trust store. |
|
|
||
| An application that initiates TLS/SSL requests needs to set two JVM system | ||
| properties to ensure that the client presents a TLS/SSL certificate to | ||
| the MongoDB server: |
source/connect/tls.txt
Outdated
Comment on lines
150
to
153
| The JVM key store saves certificates that securely identify your {+language+} | ||
| application to other applications. By using these certificates, other | ||
| applications can prove that the connection to your application is | ||
| genuine and secure from tampering by third parties. |
There was a problem hiding this comment.
S: I think this is a duplicate paragraph from the prev section. Consider removing
source/connect/tls.txt
Outdated
Comment on lines
182
to
183
| Find an example showing how to configure a client to use an ``SSLContext`` | ||
| instance in the :ref:`Customize TLS Configuration with an SSLContext section of this guide <kotlin-sync-tls-custom-sslContext>`. |
There was a problem hiding this comment.
Suggested change
| Find an example showing how to configure a client to use an ``SSLContext`` | |
| instance in the :ref:`Customize TLS Configuration with an SSLContext section of this guide <kotlin-sync-tls-custom-sslContext>`. | |
| Find an example showing how to configure a client to use an ``SSLContext`` | |
| instance in the :ref:`kotlin-sync-tls-custom-sslContext` section of this guide. |
source/connect/tls.txt
Outdated
Comment on lines
212
to
213
| To restrict your application to use only the TLS 1.2 protocol, set the | ||
| ``jdk.tls.client.protocols`` system property to "TLSv1.2". |
There was a problem hiding this comment.
Suggested change
| To restrict your application to use only the TLS 1.2 protocol, set the | |
| ``jdk.tls.client.protocols`` system property to "TLSv1.2". | |
| To restrict your application to use only the TLS 1.2 protocol, set the | |
| ``jdk.tls.client.protocols`` system property to ``"TLSv1.2"``. |
mcmorisi
requested review from
a team,
stIncMale and
rozza
and removed request for
a team
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For the most part, completely lifted from the Coroutine version.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-41508
Staging - https://preview-mongodbmcmorisi.gatsbyjs.io/kotlin-sync/DOCSP-41508-TLS/connect/tls/
Self-Review Checklist