Skip to content

Commit ca9902b

Browse files
committed
Merge branch 'v4.8' of github.com:mongodb/docs-java into v4.8
2 parents eaafd35 + 3eb6a43 commit ca9902b

File tree

4 files changed

+28
-21
lines changed

4 files changed

+28
-21
lines changed

source/fundamentals/connection/tls.txt

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@ Enable TLS/SSL on a Connection
1010
:depth: 2
1111
:class: singlecol
1212

13+
.. facet::
14+
:name: genre
15+
:values: tutorial
16+
17+
.. meta::
18+
:keywords: code example, security, connection options
19+
1320
Overview
1421
--------
1522

@@ -23,7 +30,7 @@ or `MongoClientSettings <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoCl
2330
.. note:: Debugging TLS/SSL
2431

2532
If you experience trouble setting up your TLS/SSL connection, you can
26-
use the ``-Djavax.net.debug=all`` system property to view additional
33+
use the ``-Djavax.net.debug=all`` system property to view more
2734
log statements. See `the Oracle guide to debugging TLS/SSL connections
2835
<https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/ReadDebug.html>`__
2936
for more information.
@@ -86,7 +93,7 @@ Configure Certificates
8693

8794
Java applications that initiate TLS/SSL requests require access to
8895
cryptographic certificates that prove identity for the application
89-
itself as well as other applications with which the application
96+
itself and other applications with which the application
9097
interacts. You can configure access to these certificates in your application with
9198
the following mechanisms:
9299

@@ -121,7 +128,7 @@ application is genuine and secure from tampering by third parties.
121128
If your MongoDB instance uses a certificate that is signed by an
122129
authority that is not present in the JRE's default certificate store,
123130
your application must configure two system properties to initiate
124-
SSL/TLS requests. These properties ensure that your application is able to
131+
SSL/TLS requests. These properties ensure that your application can
125132
validate the TLS/SSL certificate presented by a connected MongoDB instance.
126133

127134
- ``javax.net.ssl.trustStore``: the path to a trust store containing the
@@ -145,8 +152,8 @@ Configure the JVM Key Store
145152
.. note::
146153

147154
By default, MongoDB instances do not perform client certificate
148-
validation. You only need to configure the key store if you explicitly
149-
configured your MongoDB instance to validate client certificates.
155+
validation. You must configure the key store if you configured your MongoDB
156+
instance to validate client certificates.
150157

151158
The JVM key store saves certificates that securely identify your Java
152159
application to other applications. Using these certificates, other
@@ -165,11 +172,11 @@ the MongoDB deployment:
165172

166173
You can create a key store with the `keytool
167174
<https://docs.oracle.com/javase/8/docs/technotes/tools/unix/keytool.html>`__
168-
or `openssl <https://www.openssl.org/docs/apps/openssl.html>`__ command
169-
line tools.
175+
or `openssl <https://www.openssl.org/docs/manmaster/man1/openssl.html>`__
176+
command line tool.
170177

171178
For more information on configuring a Java application to use TLS/SSL,
172-
please refer to the `JSSE Reference Guide
179+
please see the `JSSE Reference Guide
173180
<https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html>`__.
174181

175182
.. _tls-disable-hostname-verification:
@@ -192,7 +199,7 @@ Disable Hostname Verification
192199

193200
By default, the driver ensures that the hostname included in the server's
194201
TLS/SSL certificates matches the hostnames provided when constructing
195-
a ``MongoClient``. If you need to disable hostname verification for your
202+
a ``MongoClient``. To disable hostname verification for your
196203
application, you can explicitly disable this by setting the
197204
``invalidHostNameAllowed`` property of the builder to ``true`` in the
198205
``applytoSslSettings()`` builder lambda:
@@ -210,7 +217,7 @@ application, you can explicitly disable this by setting the
210217

211218
Disabling hostname verification can make your configuration
212219
`insecure <https://tlseminar.github.io/docs/mostdangerous.pdf>`__.
213-
You should only disable hostname verification for testing purposes or
220+
Disable hostname verification only for testing purposes or
214221
when there is no other alternative.
215222

216223
.. _tls-restrict-tls-1.2:
@@ -223,17 +230,17 @@ To restrict your application to use only the TLS 1.2 protocol, set the
223230

224231
.. note::
225232

226-
Java Runtime Environments (JREs) prior to Java 8 only enabled
233+
Java Runtime Environments (JREs) before Java 8 only enabled
227234
the TLS 1.2 protocol in update releases. If your JRE has not enabled
228-
the TLS 1.2 protocol, you may need to upgrade to a later release to
229-
connect using TLS 1.2.
235+
the TLS 1.2 protocol, upgrade to a later release to connect by using
236+
TLS 1.2.
230237

231238
.. _tls-custom-sslContext:
232239

233240
Customize TLS/SSL Configuration through the Java SE SSLContext
234241
--------------------------------------------------------------
235242

236-
If your TLS/SSL configuration requires additional customization, you can
243+
If your TLS/SSL configuration requires customization, you can
237244
set the ``sslContext`` property of your ``MongoClient`` by
238245
passing an `SSLContext
239246
<https://docs.oracle.com/javase/8/docs/api/javax/net/ssl/SSLContext.html>`__
@@ -297,7 +304,7 @@ Online Certificate Status Protocol (OCSP)
297304

298305
OCSP is a standard used to check whether X.509 certificates have been
299306
revoked. A certificate authority can add an X.509 certificate to the
300-
Certificate Revocation List (CRL) prior to the expiry time to invalidate
307+
Certificate Revocation List (CRL) before the expiry time to invalidate
301308
the certificate. When a client sends an X.509 certificate during the TLS
302309
handshake, the CA's revocation server checks the CRL and returns a status
303310
of "good", "revoked", or "unknown".
@@ -371,7 +378,7 @@ properties:
371378
|
372379
| If unset or set to ``false``, the connection can proceed regardless of the presence or status of the certificate revocation response.
373380

374-
For additional information about OCSP, check out the following resources:
381+
For more information about OCSP, check out the following resources:
375382

376383
- Oracle JDK 8 Documentation on `how to enable OCSP for an application <https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/ocsp.html>`__
377384
- :rfc:`Official IETF specification for OCSP (RFC 6960) <6960>`

source/fundamentals/crud/read-operations/cursor.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ locally present without blocking:
7272
:start-after: begin availableExample
7373
:end-before: end availableExample
7474

75-
The method returns ``0`` if the application has already iterated though
75+
The method returns ``0`` if the application has already iterated through
7676
all the documents in the cursor or if the cursor is closed.
7777

7878
Into

source/index.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ MongoDB Java Driver
1818
:titlesonly:
1919
:maxdepth: 1
2020

21-
/quick-start
21+
Quick Start </quick-start>
2222
/quick-reference
2323
/whats-new
2424
/usage-examples

source/quick-start.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _java-sync-quickstart:
22

3-
===========
4-
Quick Start
5-
===========
3+
=======================
4+
Java Driver Quick Start
5+
=======================
66

77
.. facet::
88
:name: genre

0 commit comments

Comments
 (0)