Skip to content

DOCSP-50021: Remove eol server mentions #97

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.

Sign up for GitHub

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
May 22, 2025
Merged

DOCSP-50021: Remove eol server mentions #97

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
58 changes: 11 additions & 47 deletions source/security/authentication.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,24 +33,18 @@ server to ensure security.
:ref:`Enterprise Authentication Mechanisms guide <kotlin-sync-enterprise-auth>`.

.. _kotlin-sync-auth-default:
.. _kotlin-sync-auth-scramsha256:

Default
-------

The default authentication mechanism setting uses one of the following
authentication mechanisms depending on what your MongoDB server supports:

#. ``SCRAM-SHA-256``: An authentication mechanism that
uses your database username and password, encrypted with the ``SHA-256``
algorithm
#. ``SCRAM-SHA-1``: An authentication mechanism that
uses your database username and password, encrypted with the ``SHA-1``
algorithm
SCRAM-SHA-256
-------------

{+mdb-server+} versions 4.0 and later use ``SCRAM-SHA-256`` as the default
authentication mechanism.
``SCRAM-SHA-256``, as defined by `RFC 7677 <https://www.rfc-editor.org/rfc/rfc7677>`__,
is a Salted Challenge Response Authentication Mechanism
(SCRAM) that uses your username and password, encrypted with the ``SHA-256``
algorithm, to authenticate your user. This is the default authentication
mechanism.

The following code snippets show how to use the default authentication mechanism by
The following code snippets show how to specify this default authentication mechanism by
using the following placeholders:

* ``db_username``: Your MongoDB database username.
Expand Down Expand Up @@ -93,34 +87,8 @@ mechanism:
:end-before: end-default-mongo-cred
:dedent:

For more information about using SCRAM with MongoDB, see the
:manual:`SCRAM </core/security-scram/>` section of the {+mdb-server+} manual.

.. _kotlin-sync-auth-scramsha256:

SCRAM-SHA-256
-------------

.. note::

``SCRAM-SHA-256`` is the default authentication method for {+mdb-server+}
versions 4.0 and later.

``SCRAM-SHA-256``, as defined by `RFC 7677 <https://www.rfc-editor.org/rfc/rfc7677>`__,
is a Salted Challenge Response Authentication Mechanism
(SCRAM) that uses your username and password, encrypted with the ``SHA-256``
algorithm, to authenticate your user.

The following code snippets show how to specify the authentication mechanism by
using the following placeholders:

* ``db_username``: Your MongoDB database username.
* ``db_password``: Your MongoDB database user's password.
* ``hostname``: The network address of your MongoDB deployment, accessible by your client.
* ``port``: The port number of your MongoDB deployment.
* ``authenticationDb``: The MongoDB database that contains your user's
authentication data. If you omit this parameter, the driver uses the
default value ``admin``.
You can also explicitly specify the `SCRAM-SHA-256`` authentication mechanism,
as shown in the following code snippets.

Select the :guilabel:`Connection String` or the :guilabel:`MongoCredential`
tab below for instructions and sample code for specifying this authentication
Expand Down Expand Up @@ -161,10 +129,6 @@ mechanism:
SCRAM-SHA-1
-----------

.. note::
``SCRAM-SHA-1`` is the default authentication method for MongoDB versions
{+mdb-server+} versions 3.6 and earlier.

``SCRAM-SHA-1``, as defined by `RFC 5802 <https://www.rfc-editor.org/rfc/rfc5802>`__,
is a Salted Challenge Response Authentication Mechanism (SCRAM) that uses your
username and password, encrypted with the ``SHA-1`` algorithm, to authenticate
Expand Down
Loading