Skip to content

Commit e53f275

Browse files
jocelyn-mendez1Jocelyn Mendez
authored and
jeff-allen-mongo
committed
DOCSP-20679 Authentication Page (#382)
* DOCSP-20679 authentication mechanism * DOCSP-20679 authentication mechanism * DOCSP-20679 nit changes * DOCSP-20679 added spacing * DOCSP-20679 technical changes * DOCSP-20679 technical changes * DOCSP-20679 technical changes * DOCSP-20679 clarifications after tech feedback * DOCSP-20679 clarifications after tech feedback * DOCSP-20679 clarifications after tech feedback * DOCSP-20679 nit changes * DOCSP-20679 nit change Co-authored-by: Jocelyn Mendez <jocelyn.mendez@Jocelyns-MacBook-Pro.local>
1 parent 8ad552b commit e53f275

File tree

3 files changed

+213
-6
lines changed

3 files changed

+213
-6
lines changed

‎source/connect/authentication-connection.txt

Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,184 @@ Authentication Connection Tab
1313
:class: singlecol
1414

1515

16+
The :guilabel:`Authentication` tab allows you to connect to deployments that
17+
require authentication. To learn about authentication mechanisms within MongoDB,
18+
see :manual:`Authentication Mechanisms </core/authentication/#authentication-mechanisms>`.
19+
20+
Procedure
21+
---------
22+
23+
.. procedure::
24+
:style: normal
25+
26+
.. step:: Click :guilabel:`Advanced Connection Options`.
27+
28+
.. figure:: /images/compass/advanced-connection-options.png
29+
:figwidth: 690px
30+
:alt: New Advanced Connection Options
31+
32+
.. step:: Click the :guilabel:`Authentication` tab.
33+
34+
Select your authentication method from the following options:
35+
36+
- :ref:`Username / Password <username-password>`
37+
38+
- :ref:`X.509 <x509>`
39+
40+
- :ref:`Kerberos <kerberos-authentication>`
41+
42+
- :ref:`LDAP <ldap-authentication>`
43+
44+
- :ref:`AWS IAM <aws-iam-authentication>`
45+
46+
.. _username-password:
47+
48+
Username / Password
49+
~~~~~~~~~~~~~~~~~~~
50+
51+
Provide the following information:
52+
53+
- Username
54+
55+
- Password
56+
57+
- (Optional) :manual:`Authentication Database </core/security-users/#authentication-database>`
58+
59+
- Authentication Mechancism:
60+
61+
- Default
62+
63+
|
64+
65+
The ``Default`` setting selects the first authentication mechanism
66+
supported by the server according to an order of preference.
67+
68+
|
69+
70+
With the ``Default`` setting, MongoDB tries to authenticate using
71+
the following mechanisms in the order they are listed:
72+
73+
1. ``SCRAM-SHA-256``
74+
75+
#. ``SCRAM-SHA-1``
76+
77+
#. ``MONGODB-CR``
78+
79+
|
80+
81+
- :manual:`SCRAM-SHA-1 </core/security-scram/>`
82+
83+
- :manual:`SCRAM-SHA-256 </core/security-scram/>`
84+
85+
.. _x509:
86+
87+
X.509
88+
~~~~~
89+
90+
Select :guilabel:`X.509` if the deployment uses :manual:`X.509
91+
</core/security-x.509/>` as its authentication mechanism.
92+
93+
.. note::
94+
95+
X.509 Authentication requires a client certificate. To enable
96+
TLS and add a client certificate, see the :ref:`TLS / SSL tab <tls-ssl-tab>`
97+
in |compass-short|.
98+
99+
.. _kerberos-authentication:
100+
101+
Kerberos
102+
~~~~~~~~
103+
104+
Select :guilabel:`Kerberos` if the deployment uses :manual:`Kerberos
105+
</core/kerberos/>` as its authentication mechanism.
106+
107+
Provide the following information:
108+
109+
.. list-table::
110+
:header-rows: 1
111+
:widths: 50, 50
112+
113+
* - Field
114+
- Description
115+
116+
* - Principal
117+
- Every participant in the authenticated communication is known as a
118+
"principal", and every principal must have a unique name.
119+
120+
* - (Optional) Service Name
121+
- Every MongoDB :binary:`mongod` and :binary:`mongos` instance
122+
(or exe or exe on Windows) must have an associated service name. The
123+
default is ``mongodb``.
124+
125+
* - (Optional) Canonicalize Host Name
126+
- Kerberos uses the canonicalized form of the host name ``(cname)``
127+
when constructing the principal for |compass|.
128+
129+
* - (Optional) Service Realm
130+
- The service realm is the domain over which a Kerberos authentication
131+
server has the authority to authenticate a user.
132+
133+
If you choose to :guilabel:`Canonicalize Host Name`, you can specify
134+
one of the following options:
135+
136+
.. list-table::
137+
:header-rows: 1
138+
:widths: 50 50
139+
140+
* - Option
141+
- Description
142+
143+
* - Forward
144+
- The driver does a ``cname`` lookup on the kerberos hostname.
145+
146+
* - Forward and Reverse
147+
- Performs a forward DNS lookup and then a reverse lookup on that
148+
value to canonicalize the hostname.
149+
150+
For more information on principal name canonicalization in Kerberos, see
151+
this `RFC document <https://tools.ietf.org/html/rfc6806.html>`__.
152+
153+
* - (Optional) Provide password directly
154+
- Used to verify your identity.
155+
156+
.. _ldap-authentication:
157+
158+
LDAP
159+
~~~~
160+
161+
Select :guilabel:`LDAP` if the deployment uses :manual:`LDAP
162+
</core/security-ldap-external/>` as its authentication mechanism.
163+
164+
Provide the following information:
165+
166+
- Username
167+
168+
- Password
169+
170+
.. _aws-iam-authentication:
171+
172+
AWS IAM
173+
~~~~~~~
174+
175+
Select :guilabel:`AWS IAM` if the deployment uses `AWS IAM
176+
<https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction.html>`__ as
177+
its authentication mechanism.
178+
179+
The following fields are optional as they can be defined on your platform
180+
using their respective AWS IAM environment variables. |compass| will
181+
use these environment variable values to authenticate; you do not
182+
need to specify them in the connection string.
183+
184+
- (Optional) AWS Access Key Id
185+
186+
- (Optional) AWS Secret Access Key
187+
188+
- (Optional) AWS Session Token
189+
190+
.. step:: (Optional) For advanced connection configuration options, click the :ref:`Advanced <advanced-connection-tab>` tab.
191+
192+
.. step:: Click Connect.
193+
194+
.. seealso::
195+
196+
To disconnect from your deployment, see :ref:`<disconnect-tab>`.

‎source/connect/ssh-connection.txt

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

3-
=========================
4-
SSH Tunnel Connection Tab
5-
=========================
3+
=================================
4+
Proxy / SSH Tunnel Connection Tab
5+
=================================
66

77
.. default-domain:: mongodb
88

‎source/connect/tls-ssl-connection.txt

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _tls-ssl-tab:
22

3-
======================
4-
TLS/SSL Connection Tab
5-
======================
3+
========================
4+
TLS / SSL Connection Tab
5+
========================
66

77
.. default-domain:: mongodb
88

@@ -11,3 +11,29 @@ TLS/SSL Connection Tab
1111
:backlinks: none
1212
:depth: 1
1313
:class: singlecol
14+
15+
The :guilabel:`TLS / SSL` tab allows you to connect deployments via TLS / SSL.
16+
17+
Procedure
18+
---------
19+
20+
.. procedure::
21+
:style: normal
22+
23+
.. step:: Click :guilabel:`Advanced Connection Options`.
24+
25+
.. figure:: /images/compass/advanced-connection-options.png
26+
:figwidth: 690px
27+
:alt: New Advanced Connection Options
28+
29+
.. step:: Click the :guilabel:`TLS / SSL` tab.
30+
31+
You have the option to use a ``Default`` connection or to set the TLS / SSL
32+
connection ``On`` or ``Off``.
33+
34+
Default
35+
~~~~~~~
36+
37+
38+
39+

0 commit comments

Comments
 (0)