Skip to content

Commit 0be947b

Browse files
ajhuh-mdbandf-mongodb
authored andcommitted
DOCS-14389 swap deprecated whitelist language for allowlist
1 parent 79d7b24 commit 0be947b

File tree

4 files changed

+90
-7
lines changed

4 files changed

+90
-7
lines changed

source/administration/security-checklist.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,13 +123,13 @@ Pre-production Checklist/Considerations
123123

124124
- the :setting:`net.bindIp` configuration setting
125125

126-
- the :setting:`security.clusterIpSourceWhitelist` configuration
126+
- the :setting:`security.clusterIpSourceAllowlist` configuration
127127
setting
128128

129129
- the :ref:`authenticationRestrictions
130130
<db-createUser-authenticationRestrictions>` field to the
131131
:method:`db.createUser()` command to specify a per-user IP
132-
whitelist.
132+
allow list.
133133

134134

135135
|arrow| Audit System Activity

source/reference/configuration-options.txt

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2215,7 +2215,7 @@ Core Options
22152215
transitionToAuth: <boolean>
22162216
javascriptEnabled: <boolean>
22172217
redactClientLogData: <boolean>
2218-
clusterIpSourceWhitelist:
2218+
clusterIpSourceAllowlist:
22192219
- <string>
22202220
sasl:
22212221
hostName: <string>
@@ -2433,13 +2433,55 @@ Core Options
24332433
:parameter:`redactClientLogData` parameter to configure this setting.
24342434

24352435

2436-
.. setting:: security.clusterIpSourceWhitelist
2436+
.. setting:: security.clusterIpSourceAllowlist
24372437

24382438
*Type*: list
2439+
2440+
.. versionadded:: 5.0
2441+
2442+
A list of IP addresses/CIDR (`Classless Inter-Domain Routing
2443+
<https://tools.ietf.org/html/rfc4632>`__) ranges against which the
2444+
:binary:`~bin.mongod` validates authentication requests from other
2445+
members of the replica set and, if part of a sharded cluster, the
2446+
:binary:`~bin.mongos` instances. The :binary:`~bin.mongod` verifies
2447+
that the originating IP is either explicitly in the list or belongs
2448+
to a CIDR range in the list. If the IP address is not present, the
2449+
server does not authenticate the :binary:`~bin.mongod` or
2450+
:binary:`~bin.mongos`.
2451+
2452+
:setting:`security.clusterIpSourceAllowlist` has no effect on a
2453+
:binary:`~bin.mongod` started without
2454+
:ref:`authentication <authentication>`.
24392455

24402456

2441-
.. versionadded:: 3.6
2457+
:setting:`security.clusterIpSourceAllowlist` requires specifying each
2458+
IPv4/6 address or Classless Inter-Domain Routing
2459+
(`CIDR <https://tools.ietf.org/html/rfc4632>`_) range as a YAML list:
2460+
2461+
.. code-block:: yaml
2462+
2463+
security:
2464+
clusterIpSourceAllowlist:
2465+
- 192.0.2.0/24
2466+
- 127.0.0.1
2467+
- ::1
2468+
2469+
2470+
.. important::
2471+
2472+
Ensure :setting:`security.clusterIpSourceAllowlist` includes the
2473+
IP address *or* CIDR ranges that include the IP address of each
2474+
replica set member or :binary:`~bin.mongos` in the deployment to
2475+
ensure healthy communication between cluster components.
2476+
2477+
2478+
.. setting:: security.clusterIpSourceWhitelist
2479+
2480+
*Type*: list
24422481

2482+
*Deprecated in version 5.0:* Use
2483+
:setting:`security.clusterIpSourceAllowlist` instead.
2484+
24432485
A list of IP addresses/CIDR (`Classless Inter-Domain Routing
24442486
<https://tools.ietf.org/html/rfc4632>`__) ranges against which the
24452487
:binary:`~bin.mongod` validates authentication requests from other members of

source/reference/program/mongod.txt

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -267,13 +267,44 @@ Core Options
267267

268268
``--bind_ip`` and ``--bind_ip_all`` are mutually exclusive. That
269269
is, you can specify one or the other, but not both.
270+
271+
272+
.. option:: --clusterIpSourceAllowlist <string>
273+
274+
.. versionadded:: 5.0
275+
276+
A list of IP addresses/CIDR (`Classless Inter-Domain Routing
277+
<https://tools.ietf.org/html/rfc4632>`__) ranges against which the
278+
:binary:`~bin.mongod` validates authentication requests from other members of
279+
the replica set and, if part of a sharded cluster, the :binary:`~bin.mongos`
280+
instances. The :binary:`~bin.mongod` verifies that the originating IP is
281+
either explicitly in the list or belongs to a CIDR range in the list. If the
282+
IP address is not present, the server does not authenticate the
283+
:binary:`~bin.mongod` or :binary:`~bin.mongos`.
284+
285+
:option:`--clusterIpSourceAllowlist` has no effect on a :binary:`~bin.mongod` started without
286+
:ref:`authentication <authentication>`.
270287

288+
289+
:option:`--clusterIpSourceAllowlist` accepts multiple comma-separated IPv4/6 addresses or Classless
290+
Inter-Domain Routing (`CIDR <https://tools.ietf.org/html/rfc4632>`_) ranges:
291+
292+
.. code-block:: bash
293+
294+
mongod --clusterIpSourceAllowlist 192.0.2.0/24,127.0.0.1,::1
295+
296+
297+
.. important::
298+
299+
Ensure :option:`--clusterIpSourceAllowlist` includes the IP address *or* CIDR ranges that include the
300+
IP address of each replica set member or :binary:`~bin.mongos` in the
301+
deployment to ensure healthy communication between cluster components.
271302

272303

273304
.. option:: --clusterIpSourceWhitelist <string>
274305

275-
276-
.. versionadded:: 3.6
306+
*Deprecated in version 5.0:*
307+
Use :option:`--clusterIpSourceAllowlist` instead.
277308

278309
A list of IP addresses/CIDR (`Classless Inter-Domain Routing
279310
<https://tools.ietf.org/html/rfc4632>`__) ranges against which the

source/release-notes/5.0-compatibility.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -328,6 +328,16 @@ Deprecations
328328

329329
.. include:: /includes/deprecated-rs.printSlaveReplicationInfo.rst
330330

331+
- :setting:`security.clusterIpSourceWhitelist`
332+
333+
*Deprecated in version 5.0:* Use
334+
:setting:`security.clusterIpSourceAllowlist` instead.
335+
336+
- :option:`--clusterIpSourceWhitelist`
337+
338+
*Deprecated in version 5.0:* Use :option:`--clusterIpSourceAllowlist`
339+
instead.
340+
331341
- :dbcommand:`logout`
332342

333343
*Deprecated in version 5.0:* Disconnect from the server to end your

0 commit comments

Comments
 (0)