Skip to content

Commit fa6a9fd

Browse files
DOCSP-37138 remove OCSP info from TLS tutorial (#6513) (#6530)
* DOCSP-37138 remove OSCP info from TLS tutorial * update ssl section * cleanup * add refs * add missing word * standardization * present tense * typos * typo
1 parent e767a97 commit fa6a9fd

File tree

2 files changed

+63
-83
lines changed

2 files changed

+63
-83
lines changed
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
To prevent clients with revoked certificates from connecting to the
2+
:binary:`~bin.mongod` or :binary:`~bin.mongos` instance, you can use a
3+
Certificate Revocation List (CRL).

source/tutorial/configure-ssl.txt

Lines changed: 60 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -241,16 +241,15 @@ settings <net-tls-conf-options>` in your
241241
bindIp: localhost,mongodb0.example.net
242242
port: 27017
243243

244-
A :binary:`~bin.mongod` instance that uses the above configuration
245-
can only use TLS/SSL connections:
244+
A :binary:`~bin.mongod` instance that uses the above configuration can
245+
only accept TLS/SSL connections:
246246

247247
.. code-block:: bash
248248

249249
mongod --config <path/to/configuration/file>
250250

251-
That is, clients must specify TLS/SSL connections. See
252-
:ref:`tls-client-connection-only` for more information on
253-
connecting with TLS/SSL.
251+
See :ref:`tls-client-connection-only` for more information on connecting
252+
with TLS/SSL.
254253

255254
.. seealso::
256255

@@ -363,16 +362,16 @@ For example, consider the following :ref:`configuration file
363362
bindIp: localhost,mongodb0.example.net
364363
port: 27017
365364

366-
A :binary:`~bin.mongod` instance that uses the above configuration
367-
can only use TLS/SSL connections and requires valid certificate from
365+
A :binary:`~bin.mongod` instance that uses the above configuration can
366+
only accept TLS/SSL connections and requires a valid certificate from
368367
its clients:
369368

370369
.. code-block:: bash
371370

372371
mongod --config <path/to/configuration/file>
373372

374-
That is, clients must specify TLS/SSL connections and presents its
375-
certificate key file to the instance. See
373+
Clients must specify TLS/SSL connections and present their certificate
374+
key file to the instance. See
376375
:ref:`mongo-connect-require-client-certificates-tls` for more
377376
information on connecting with TLS/SSL.
378377

@@ -390,6 +389,7 @@ information on connecting with TLS/SSL.
390389
:option:`--tlsCertificateKeyFile <mongos --tlsCertificateKeyFile>`,
391390
:option:`--tlsCAFile <mongos --tlsCAFile>`.
392391

392+
.. _block-revoked-certs-tls:
393393

394394
Block Revoked Certificates for Clients
395395
``````````````````````````````````````
@@ -400,46 +400,36 @@ Block Revoked Certificates for Clients
400400
MongoDB 4.2). For procedures using the ``net.ssl`` settings, see
401401
:ref:`configure-ssl`.
402402

403-
To prevent clients with revoked certificates from connecting to the
404-
:binary:`~bin.mongod` or :binary:`~bin.mongos` instance, you can use:
403+
.. include:: /includes/security/block-revoked-certificates-intro.rst
405404

406-
- Online Certificate Status Protocol (OCSP)
407-
Starting in version 4.4, to check for certificate revocation,
408-
MongoDB :parameter:`enables <ocspEnabled>` the use of OCSP
409-
(Online Certificate Status Protocol) by default as an alternative
410-
to specifying a CRL file or using the :setting:`system SSL
411-
certificate store <net.tls.certificateSelector>`.
405+
To specify a :abbr:`CRL (Certificate Revocation List)` file, include
406+
:setting:`net.tls.CRLFile` set to a file that contains revoked
407+
certificates.
412408

413-
In versions 4.0 and 4.2, the use of OCSP is available only
414-
through the use of :setting:`system certificate store
415-
<net.tls.certificateSelector>` on Windows or macOS.
416-
417-
- Certificate Revocation List (CRL)
418-
To specify a CRL file, include
419-
:setting:`net.tls.CRLFile` set to a file that contains revoked
420-
certificates.
421-
422-
For example:
409+
For example:
423410

424-
.. code-block:: yaml
425-
:emphasize-lines: 6
411+
.. code-block:: yaml
412+
:emphasize-lines: 6
426413

427-
net:
428-
tls:
429-
mode: requireTLS
430-
certificateKeyFile: /etc/ssl/mongodb.pem
431-
CAFile: /etc/ssl/caToValidateClientCertificates.pem
432-
CRLFile: /etc/ssl/revokedCertificates.pem
414+
net:
415+
tls:
416+
mode: requireTLS
417+
certificateKeyFile: /etc/ssl/mongodb.pem
418+
CAFile: /etc/ssl/caToValidateClientCertificates.pem
419+
CRLFile: /etc/ssl/revokedCertificates.pem
433420

434-
Clients that present certificates that are listed in the
435-
:file:`/etc/ssl/revokedCertificates.pem` will not be able to connect.
421+
Clients that present certificates that are listed in the
422+
:file:`/etc/ssl/revokedCertificates.pem` file are not able to connect.
436423

437-
.. seealso::
424+
.. seealso::
438425

439-
You can also configure the revoked certificate list using the command-line option.
426+
You can also configure the revoked certificate list using the
427+
command-line option.
440428

441-
- For :binary:`~bin.mongod`, see :option:`--tlsCRLFile <mongod --tlsCRLFile>`.
442-
- For :binary:`~bin.mongos`, see :option:`--tlsCRLFile <mongos --tlsCRLFile>`.
429+
- For :binary:`~bin.mongod`, see :option:`--tlsCRLFile <mongod
430+
--tlsCRLFile>`.
431+
- For :binary:`~bin.mongos`, see :option:`--tlsCRLFile <mongos
432+
--tlsCRLFile>`.
443433

444434
.. _ssl-mongod-weak-certification:
445435

@@ -792,16 +782,15 @@ your :binary:`mongod` / :binary:`mongos` instance's
792782
bindIp: localhost,mongodb0.example.net
793783
port: 27017
794784

795-
A :binary:`~bin.mongod` instance that uses the above configuration
796-
can only use TLS/SSL connections:
785+
A :binary:`~bin.mongod` instance that uses the above configuration can
786+
only accept TLS/SSL connections:
797787

798788
.. code-block:: bash
799789

800790
mongod --config <path/to/configuration/file>
801791

802-
That is, clients must specify TLS/SSL connections. See
803-
:ref:`tls-client-connection-only` for more information on
804-
connecting with TLS/SSL.
792+
See :ref:`tls-client-connection-only` for more information on connecting
793+
with TLS/SSL.
805794

806795
.. seealso::
807796

@@ -905,16 +894,16 @@ For example, consider the following :ref:`configuration file
905894
bindIp: localhost,mongodb0.example.net
906895
port: 27017
907896

908-
A :binary:`~bin.mongod` instance that uses the above configuration
909-
can only use TLS/SSL connections and requires valid certificate from
897+
A :binary:`~bin.mongod` instance that uses the above configuration can
898+
only accept TLS/SSL connections and requires a valid certificate from
910899
its clients:
911900

912901
.. code-block:: bash
913902

914903
mongod --config <path/to/configuration/file>
915904

916-
That is, clients must specify TLS/SSL connections and present their
917-
certificate key file to the instance. See
905+
Clients must specify TLS/SSL connections and present their certificate
906+
key file to the instance. See
918907
:ref:`mongo-connect-require-client-certificates-tls` for more
919908
information on connecting with TLS/SSL.
920909

@@ -932,50 +921,38 @@ information on connecting with TLS/SSL.
932921
:option:`--sslPEMKeyFile <mongos --sslPEMKeyFile>`, and
933922
:option:`--sslCAFile <mongos --sslCAFile>`.
934923

924+
.. _block-revoked-certs-ssl:
925+
935926
Block Revoked Certificates for Clients
936927
``````````````````````````````````````
937928

938-
To prevent clients with revoked certificates from connecting to the
939-
:binary:`~bin.mongod` or :binary:`~bin.mongos` instance, you can use:
940-
941-
- Online Certificate Status Protocol (OCSP)
942-
Starting in version 4.4, to check for certificate revocation,
943-
MongoDB :parameter:`enables <ocspEnabled>` the use of OCSP
944-
(Online Certificate Status Protocol) by default as an alternative
945-
to specifying a CRL file or using the :setting:`system SSL
946-
certificate store <net.ssl.certificateSelector>`.
929+
.. include:: /includes/security/block-revoked-certificates-intro.rst
947930

931+
To specify a :abbr:`CRL (Certificate Revocation List)` file, include
932+
:setting:`net.ssl.CRLFile` set to a file that contains revoked
933+
certificates.
948934

949-
In versions 4.0 and 4.2, the use of OCSP is available only
950-
through the use of :setting:`system certificate store
951-
<net.ssl.certificateSelector>` on Windows or macOS.
952-
953-
- Certificate Revocation List (CRL)
954-
To specify a CRL file, include
955-
:setting:`net.ssl.CRLFile` set to a file that contains revoked
956-
certificates.
957-
958-
For example:
935+
For example:
959936

960-
.. code-block:: yaml
961-
:emphasize-lines: 6
937+
.. code-block:: yaml
938+
:emphasize-lines: 6
962939

963-
net:
964-
ssl:
965-
mode: requireSSL
966-
PEMKeyFile: /etc/ssl/mongodb.pem
967-
CAFile: /etc/ssl/caToValidateClientCertificates.pem
968-
CRLFile: /etc/ssl/revokedCertificates.pem
940+
net:
941+
ssl:
942+
mode: requireSSL
943+
PEMKeyFile: /etc/ssl/mongodb.pem
944+
CAFile: /etc/ssl/caToValidateClientCertificates.pem
945+
CRLFile: /etc/ssl/revokedCertificates.pem
969946

970-
Clients that present certificates that are listed in the
971-
:file:`/etc/ssl/revokedCertificates.pem` will not be able to connect.
947+
Clients that present certificates that are listed in the
948+
:file:`/etc/ssl/revokedCertificates.pem` file are not able to connect.
972949

973-
.. seealso::
950+
.. seealso::
974951

975-
You can also configure the revoked certificate list using the command-line option.
952+
You can also configure the revoked certificate list using the command-line option.
976953

977-
- For :binary:`~bin.mongod`, see :option:`--sslCRLFile <mongod --sslCRLFile>`.
978-
- For :binary:`~bin.mongos`, see :option:`--sslCRLFile <mongos --sslCRLFile>`.
954+
- For :binary:`~bin.mongod`, see :option:`--sslCRLFile <mongod --sslCRLFile>`.
955+
- For :binary:`~bin.mongos`, see :option:`--sslCRLFile <mongos --sslCRLFile>`.
979956

980957
Validate Only if a Client Presents a Certificate
981958
````````````````````````````````````````````````

0 commit comments

Comments
 (0)