Skip to content

fix build errors with broken mongosh refs #5557

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 14, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions source/appendix/security/appendixC-openssl-client.txt
Original file line number Diff line number Diff line change
Expand Up @@ -174,10 +174,9 @@ B. Generate the Test PEM File for Client

mongosh --tls --tlsCertificateSelector subject="<TestClientCertificateCommonName>"

Although still available, :option:`--ssl <mongosh --ssl>` and
:option:`--sslCertificateSelector <mongo
--sslCertificateSelector>` are :ref:`deprecated as of MongoDB 4.2
<4.2-tls>`.
Although still available, ``--ssl`` and
``--sslCertificateSelector`` are
:ref:`deprecated as of MongoDB 4.2 <4.2-tls>`.

**For MongoDB 4.0 and earlier**

Expand Down
8 changes: 4 additions & 4 deletions source/core/security-x.509.txt
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,12 @@ To connect and authenticate using x.509 client certificate:

- For MongoDB 4.0 and earlier, include the following options for the client:

- :option:`--ssl <mongosh --ssl>`
- ``--ssl``

- :option:`--sslPEMKeyFile <mongosh --sslPEMKeyFile>`
- ``--sslPEMKeyFile``

- :option:`--sslPEMKeyPassword <mongosh --sslPEMKeyPassword>` option if
the :option:`--sslPEMKeyFile <mongosh --sslPEMKeyFile>` is encrypted.
- ``--sslPEMKeyPassword`` option if
the ``--sslPEMKeyFile`` is encrypted.

- :option:`--authenticationDatabase '$external'
<mongo --authenticationDatabase>`
Expand Down
2 changes: 1 addition & 1 deletion source/reference/connection-string.txt
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,7 @@ Alternatively, you can also use the equivalent :urioption:`ssl=true

If the :binary:`mongo` shell specifies additional
:ref:`tls/ssl <mongo-shell-ssl>` options from the
command-line, use the :option:`--ssl <mongosh --ssl>`
command-line, use the ``--ssl``
command-line option instead.

* - .. urioption:: tlsCertificateKeyFile
Expand Down
27 changes: 13 additions & 14 deletions source/tutorial/configure-ssl-clients.txt
Original file line number Diff line number Diff line change
Expand Up @@ -201,9 +201,8 @@ On Windows and macOS,
mongosh --tls --host hostname.example.com --tlsCertificateSelector subject="myclient.example.net"

Although still available, :mongosh:`mongosh </>`
:option:`--ssl <mongosh --ssl>`, :option:`--sslCAFile <mongo
--sslCAFile>`, :option:`--sslPEMKeyFile <mongosh --sslPEMKeyFile>`,
:option:`--sslCertificateSelector <mongosh --sslCertificateSelector>`
``--ssl``, ``--sslCAFile``, ``--sslPEMKeyFile``, and
``--sslCertificateSelector`` options
are :ref:`deprecated as of MongoDB 4.2 <4.2-tls>`.

Avoid Use of ``--tlsAllowInvalidCertificates`` Option
Expand Down Expand Up @@ -243,31 +242,31 @@ Avoid Use of ``--tlsAllowInvalidCertificates`` Option
* - SSL Option (Deprecated in 4.2)
- Notes

* - :option:`--ssl <mongosh --ssl>`
* - ``--ssl``
- Enables TLS/SSL connection.

* - :option:`--sslPEMKeyFile <mongosh --sslPEMKeyFile>`
* - ``--sslPEMKeyFile``

- Specifies the :file:`.pem` file that contains
:mongosh:`mongosh </>`'s certificate and key to present to
the :binary:`~bin.mongod` or :binary:`~bin.mongos` instance.

* - :option:`--sslPEMKeyPassword <mongosh --sslPEMKeyPassword>`
* - ``--sslPEMKeyPassword``

- If :mongosh:`mongosh </>`'s certificate key file is encrypted.

* - :option:`--sslCAFile <mongosh --sslCAFile>`
* - ``--sslCAFile``

- Specifies the Certificate Authority (CA) :file:`.pem` file for
verification of the certificate presented by the
:binary:`~bin.mongod` or the :binary:`~bin.mongos` instance.

* - :option:`--sslCertificateSelector <mongosh --sslCertificateSelector>`
* - ``--sslCertificateSelector``

- If running on Windows or macOS, use a certificate from the
system certificate store. (*New in version 4.0*)

For a complete list of :mongosh:`mongosh </>`'s ``ssl``
For a complete list of ``ssl``
options, see :ref:`SSL Options <mongo-shell-ssl>`.

For TLS/SSL connections, :mongosh:`mongosh </>` validates the
Expand Down Expand Up @@ -303,7 +302,7 @@ To connect to a :binary:`~bin.mongod` or :binary:`~bin.mongos` instance
that requires :ref:`encrypted communication <ssl-mongod-ssl-cert-key>`,
start :mongosh:`mongosh </>` with:

- :option:`--ssl <mongosh --ssl>`
- ``--ssl``

- :option:`--host <mongosh --host>` and :option:`--sslCAFile <mongo
--sslCAFile>` to validate the server certificate.
Expand Down Expand Up @@ -341,12 +340,12 @@ To connect to a :binary:`~bin.mongod` or :binary:`~bin.mongos` that
requires :ref:`CA-signed client certificates
<ssl-mongod-ca-signed-ssl-cert-key>`, start :mongosh:`mongosh </>` with:

- :option:`--ssl <mongosh --ssl>`
- ``--ssl``

- :option:`--host <mongosh --host>` and the :option:`--sslCAFile <mongo
--sslCAFile>` to validate the server certificate,

- :option:`--sslPEMKeyFile <mongosh --sslPEMKeyFile>` option to specify
- ``--sslPEMKeyFile`` option to specify
the client certificate to present to the server.

For example, consider a :binary:`~bin.mongod` instance running on
Expand All @@ -367,9 +366,9 @@ On Windows and macOS,
You can also use the :option:`--sslCertificateSelector <mongo
--sslCertificateSelector>` option to specify the client certificate
from the system certificate store instead of using
:option:`--sslPEMKeyFile <mongosh --sslPEMKeyFile>`. If the CA file
``--sslPEMKeyFile``. If the CA file
is also in the system certificate store, you can omit the
:option:`--sslCAFile <mongosh --sslCAFile>` option as well. For
``--sslCAFile`` option as well. For
example, to use a certificate with the ``CN`` (Common Name) of
``myclient.example.net`` and the CA file from the system certificate
store on macOS, start :mongosh:`mongosh </>` with the following
Expand Down
12 changes: 6 additions & 6 deletions source/tutorial/configure-x509-client-authentication.txt
Original file line number Diff line number Diff line change
Expand Up @@ -463,13 +463,13 @@ authenticate with the client certificate.
* - Option
- Notes

* - :option:`--ssl <mongosh --ssl>`
* - ``--ssl``
-

* - :option:`--sslPEMKeyFile <mongosh --sslPEMKeyFile>`
* - ``--sslPEMKeyFile``
- Client's x.509 file.

* - :option:`--sslCAFile <mongosh --sslCAFile>`
* - ``--sslCAFile``

- Certificate Authority file to verify the
certificate presented by
Expand Down Expand Up @@ -506,13 +506,13 @@ authenticate with the client certificate.
* - Option
- Notes

* - :option:`--ssl <mongosh --ssl>`
* - ``--ssl``
-

* - :option:`--sslPEMKeyFile <mongosh --sslPEMKeyFile>`
* - ``--sslPEMKeyFile``
- Client's x.509 file.

* - :option:`--sslCAFile <mongosh --sslCAFile>`
* - ``--sslCAFile``

- Certificate Authority file to verify the
certificate presented by
Expand Down