Skip to content

Commit ca0b364

Browse files
committed
DOCSP-18011: Refactor Enterprise Auth structure
1 parent f7496be commit ca0b364

File tree

5 files changed

+101
-166
lines changed

5 files changed

+101
-166
lines changed

config/redirects

+8
Original file line numberDiff line numberDiff line change
@@ -1879,6 +1879,14 @@ raw: /manual/core/wildcard -> ${base}/manual/core/index-wildcard/
18791879

18801880
[v5.0-*]: /${version}/reference/read-concern-majority/#disable-read-concern-majority -> ${base}/${version}/reference/read-concern-majority/#primary-secondary-arbiter-replica-sets
18811881

1882+
1883+
#
1884+
# Redirects for 5.1 and greater (if pages are removed in 5.0 that used to exist in earlier versions)
1885+
#
1886+
1887+
[v5.0-*]: /${version}/core/core/authentication-mechanisms -> ${base}/${version}/core/authentication
1888+
1889+
18821890
#
18831891
# Upgrade / Downgrade redirects
18841892
#

source/core/authentication-mechanisms-enterprise.txt

-89
This file was deleted.

source/core/authentication-mechanisms.txt

-65
This file was deleted.

source/core/authentication.txt

+82-12
Original file line numberDiff line numberDiff line change
@@ -34,22 +34,90 @@ To get started using access control, follow these tutorials:
3434
- :ref:`authentication-auth-as-user`
3535

3636
.. _available-authentication-mechanisms:
37+
.. _security-authentication-mechanisms:
3738

3839
Authentication Mechanisms
3940
-------------------------
4041

41-
MongoDB Community supports a number of :ref:`authentication mechanisms
42-
<security-authentication-mechanisms>` that clients can use to verify
43-
their identity:
42+
.. _authentication-mechanism-default:
4443

45-
- :ref:`authentication-scram` (*Default*)
46-
- :ref:`x.509 Certificate Authentication <security-auth-x509>`.
44+
SCRAM Authentication
45+
~~~~~~~~~~~~~~~~~~~~
4746

48-
In addition to the preceding mechanisms, MongoDB Atlas and MongoDB
49-
Enterprise support the following mechanisms:
47+
:doc:`Salted Challenge Response Authentication Mechanism (SCRAM)
48+
</core/security-scram>` is the default authentication mechanism for
49+
MongoDB.
5050

51-
- :ref:`LDAP proxy authentication <security-auth-ldap>`, and
52-
- :ref:`Kerberos authentication <security-auth-kerberos>`.
51+
For more information on SCRAM and MongoDB, see:
52+
53+
- :doc:`SCRAM Authentication </core/security-scram>`
54+
- :ref:`scram-client-authentication`
55+
56+
.. _authentication-mechanism-x509:
57+
58+
x.509 Certificate Authentication
59+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
60+
61+
MongoDB supports :doc:`x.509 certificate authentication
62+
</core/security-x.509>` for client authentication and internal
63+
authentication of the members of replica sets and sharded clusters.
64+
x.509 certificate authentication requires a secure :doc:`TLS/SSL
65+
connection </tutorial/configure-ssl>`.
66+
67+
To use MongoDB with x.509, you must use valid certificates generated and
68+
signed by a certificate authority. The client x.509 certificates
69+
must meet the :ref:`client certificate requirements
70+
<client-x509-certificates-requirements>`.
71+
72+
For more information on x.509 and MongoDB, see:
73+
74+
- :doc:`x.509 Certificate Authentication </core/security-x.509>`
75+
- :ref:`x509-client-authentication`
76+
77+
.. _security-auth-kerberos:
78+
79+
Kerberos Authentication
80+
~~~~~~~~~~~~~~~~~~~~~~~
81+
82+
`MongoDB Enterprise
83+
<http://www.mongodb.com/products/mongodb-enterprise-advanced?tck=docs_server>`_
84+
and `MongoDB Atlas
85+
<https://www.mongodb.com/cloud/atlas?tck=docs_server>`__ support
86+
:doc:`Kerberos Authentication </core/kerberos>`. Kerberos is an industry
87+
standard authentication protocol for large client/server systems that
88+
provides authentication using short-lived tokens that are called
89+
tickets.
90+
91+
To use MongoDB with Kerberos, you must have a properly configured
92+
Kerberos deployment, configured :ref:`Kerberos service principals
93+
<kerberos-service-principal>` for MongoDB, and a :ref:`Kerberos user
94+
principal <kerberos-user-principal>` added to MongoDB.
95+
96+
For more information on Kerberos and MongoDB, see:
97+
98+
- :doc:`Kerberos Authentication </core/kerberos>`
99+
- :doc:`/tutorial/control-access-to-mongodb-with-kerberos-authentication`
100+
- :doc:`/tutorial/control-access-to-mongodb-windows-with-kerberos-authentication`
101+
102+
.. _security-auth-ldap:
103+
104+
LDAP Proxy Authentication
105+
~~~~~~~~~~~~~~~~~~~~~~~~~
106+
107+
`MongoDB Enterprise
108+
<http://www.mongodb.com/products/mongodb-enterprise-advanced?tck=docs_server>`_
109+
and `MongoDB Atlas
110+
<https://www.mongodb.com/cloud/atlas?tck=docs_server>`__ support
111+
:doc:`LDAP Proxy Authentication </core/security-ldap>` proxy
112+
authentication through a Lightweight Directory Access Protocol (LDAP)
113+
service.
114+
115+
For more information on Kerberos and MongoDB, see:
116+
117+
- :doc:`LDAP Proxy Authentication </core/security-ldap>`
118+
- :doc:`/tutorial/configure-ldap-sasl-activedirectory`
119+
- :doc:`/tutorial/configure-ldap-sasl-openldap`
120+
- :doc:`/tutorial/authenticate-nativeldap-activedirectory`
53121

54122
These mechanisms allow MongoDB to integrate into your
55123
existing authentication system.
@@ -68,8 +136,10 @@ for more information.
68136
:titlesonly:
69137
:hidden:
70138

71-
/core/security-users
72-
/core/authentication-mechanisms
73-
/core/authentication-mechanisms-enterprise
139+
/core/security-scram
140+
/core/security-x.509
141+
/core/kerberos
142+
/core/security-ldap
74143
/core/security-internal-authentication
75144
/core/localhost-exception
145+
/core/security-users

source/core/authorization.txt

+11
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,16 @@ If these built-in-roles cannot provide the desired set of privileges,
103103
MongoDB provides methods to create and modify :doc:`user-defined roles
104104
</core/security-user-defined-roles>`.
105105

106+
LDAP Authorization
107+
------------------
108+
109+
MongoDB Enterprise supports querying an LDAP server for the LDAP groups the
110+
authenticated user is a member of. MongoDB maps the Distinguished Names (DN)
111+
of each returned group to :ref:`roles <roles>` on the ``admin`` database.
112+
MongoDB authorizes the user based on the mapped roles and their associated
113+
privileges. See :ref:`LDAP Authorization <security-ldap-external>` for more
114+
information.
115+
106116
.. toctree::
107117
:titlesonly:
108118
:hidden:
@@ -112,3 +122,4 @@ MongoDB provides methods to create and modify :doc:`user-defined roles
112122
/tutorial/manage-users-and-roles
113123
/tutorial/change-own-password-and-custom-data
114124
/core/collection-level-access-control
125+
/core/security-ldap-external

0 commit comments

Comments
 (0)