Enforcing access control on a replica set requires configuring:
Security between members of the replica set using Internal Authentication, and
Security between connecting clients and the replica set using Role-Based Access Control in Self-Managed Deployments.
For this tutorial, each member of the replica set uses the same internal authentication mechanism and settings.
Enforcing internal authentication also enforces user access control. To connect to the replica set, clients like mongosh need to use a user account. See Users and Authentication Mechanisms.
If you are currently using or are planning to use Cloud Manager or Ops Manager, see the Cloud Manager manual or the Ops Manager manual for enforcing access control.
ImportantTo avoid configuration updates due to IP address changes, use DNS hostnames instead of IP addresses. It is particularly important to use a DNS hostname instead of an IP address when configuring replica set members or sharded cluster members.
Use hostnames instead of IP addresses to configure clusters across a split network horizon. Starting in MongoDB 5.0, nodes that are only configured with an IP address fail startup validation and do not start.
mongod and mongos bind to localhost by default. If the members of your deployment are run on different hosts or if you wish remote clients to connect to your deployment, you must specify --bind_ip or net.bindIp.
This tutorial primarily refers to the mongod process. Windows users should use the mongod.exe program instead.
We recommend keyfiles only for testing and development environments, due to their limitations in manageability and cryptographic strength. For production environments, we strongly advise using X.509 certificates. While keyfiles can be secure in specific, controlled scenarios, they present scalability and management challenges in complex deployments. X.509 certificates offer more robust security features, enable better key management, support individual authentication, and adhere to industry standards for sensitive data protection.
This tutorial covers creating the minimum number of administrative users on the admin database only. For the user authentication, the tutorial uses the default SCRAM authentication mechanism. Challenge-response security mechanisms are best suited for testing or development environments. For production environments, we recommend using X.509 certificates or Self-Managed LDAP Proxy Authentication (available for MongoDB Enterprise only) or Kerberos Authentication on Self-Managed Deployments (available for MongoDB Enterprise only).
For details on creating users for specific authentication mechanism, refer to the specific authentication mechanism pages.
See ➤ Configure Role-Based Access Control for best practices for user creation and management.
ImportantTo avoid configuration updates due to IP address changes, use DNS hostnames instead of IP addresses. It is particularly important to use a DNS hostname instead of an IP address when configuring replica set members or sharded cluster members.
Use hostnames instead of IP addresses to configure clusters across a split network horizon. Starting in MongoDB 5.0, nodes that are only configured with an IP address fail startup validation and do not start.
With keyfile authentication, each mongod instances in the replica set uses the contents of the keyfile as the shared password for authenticating other members in the deployment. Only mongod instances with the correct keyfile can join the replica set.
Keyfiles for internal membership authentication use YAML format to allow for multiple keys in a keyfile. The YAML format accepts either:
A single key string (same as in earlier versions)
A sequence of key strings
The YAML format is compatible with the existing single-key keyfiles that use the text file format.
A key's length must be between 6 and 1024 characters and may only contain characters in the base64 set. All members of the replica set must share at least one common key.
NoteOn UNIX systems, the keyfile must not have group or world permissions. On Windows systems, keyfile permissions are not checked.
You can generate a keyfile using any method you choose. For example, the following operation uses openssl to generate a complex pseudo-random 1024 character string to use as a shared password. It then uses chmod to change file permissions to provide read permissions for the file owner only:
openssl rand -base64 756 > <path-to-keyfile>chmod 400 <path-to-keyfile>See Keyfiles for additional details and requirements for using keyfiles.
Copy the keyfile to each server hosting the replica set members. Ensure that the user running the mongod instances is the owner of the file and can access the keyfile.
Avoid storing the keyfile on storage mediums that can be easily disconnected from the hardware hosting the mongod instances, such as a USB drive or a network attached storage device.
For each member in the replica set, start the mongod with either the security.keyFile configuration file setting or the --keyFile command-line option. Running mongod with the --keyFile command-line option or the security.keyFile configuration file setting enforces both Self-Managed Internal/Membership Authentication and Role-Based Access Control in Self-Managed Deployments.
If using a configuration file, set
security.keyFile to the keyfile's path, and
replication.replSetName to the replica set name.
Include additional options as required for your configuration. For instance, if you wish remote clients to connect to your deployment or your deployment members are run on different hosts, specify the net.bindIp setting.
security: keyFile: <path-to-keyfile>replication: replSetName: <replicaSetName>net: bindIp: localhost,<hostname(s)|ip address(es)>Start the mongod using the configuration file:
mongod --config <path-to-config-file>For more information on the configuration file, see configuration options.
If using the command line options, start the mongod with the following options:
--keyFile set to the keyfile's path, and
--replSet set to the replica set name.
Include additional options as required for your configuration. For instance, if you wish remote clients to connect to your deployment or your deployment members are run on different hosts, specify the --bind_ip.
mongod --keyFile <path-to-keyfile> --replSet <replicaSetName> --bind_ip localhost,<hostname(s)|ip address(es)>To avoid configuration updates due to IP address changes, use DNS hostnames instead of IP addresses. It is particularly important to use a DNS hostname instead of an IP address when configuring replica set members or sharded cluster members.
Use hostnames instead of IP addresses to configure clusters across a split network horizon. Starting in MongoDB 5.0, nodes that are only configured with an IP address fail startup validation and do not start.
For more information on command-line options, see the mongod reference page.
From mongosh, run the rs.initiate() method.
rs.initiate() can take an optional replica set configuration document. In the replica set configuration document, include:
The _id field set to the replica set name specified in either the replication.replSetName or the --replSet option.
The members array with a document per each member of the replica set.
The following example initates a three member replica set.
ImportantTo avoid configuration updates due to IP address changes, use DNS hostnames instead of IP addresses. It is particularly important to use a DNS hostname instead of an IP address when configuring replica set members or sharded cluster members.
Use hostnames instead of IP addresses to configure clusters across a split network horizon. Starting in MongoDB 5.0, nodes that are only configured with an IP address fail startup validation and do not start.
rs.initiate( { _id : "myReplSet", members: [ { _id : 0, host : "mongo1.example.net:27017" }, { _id : 1, host : "mongo2.example.net:27017" }, { _id : 2, host : "mongo3.example.net:27017" } ] })rs.initiate() triggers an election and elects one of the members to be the primary.
Connect to the primary before continuing. Use rs.status() to locate the primary member.
After you create the first user, the localhost exception is no longer available.
The first user must have privileges to create other users, such as a user with the userAdminAnyDatabase. This ensures that you can create additional users after the Localhost Exception in Self-Managed Deployments closes.
If at least one user does not have privileges to create users, once the localhost exception closes you may be unable to create or modify users with new privileges, and therefore unable to access necessary operations.
Add a user using the db.createUser() method. The user should have at minimum the userAdminAnyDatabase role on the admin database.
You must be connected to the primary to create users.
The following example creates the user fred with the userAdminAnyDatabase role on the admin database.
Passwords should be random, long, and complex to ensure system security and to prevent or delay malicious access.
TipYou can use the passwordPrompt() method in conjunction with various user authentication management methods and commands to prompt for the password instead of specifying the password directly in the method or command call. However, you can still specify the password directly as you would with earlier versions of the mongo shell.
admin = db.getSiblingDB("admin")admin.createUser( { user: "fred", pwd: passwordPrompt(), roles: [ { role: "userAdminAnyDatabase", db: "admin" } ] })Enter the password when prompted. See Database User Roles for a full list of built-in roles related to database administration operations.
Authenticate to the admin database.
In mongosh, use db.auth() to authenticate. For example, the following authenticate as the user administrator fred:
You can use the passwordPrompt() method in conjunction with various user authentication management methods and commands to prompt for the password instead of specifying the password directly in the method or command call. However, you can still specify the password directly as you would with earlier versions of the mongo shell.
db.getSiblingDB("admin").auth("fred", passwordPrompt()) Alternatively, connect a new mongosh instance to the primary replica set member using the -u <username>, -p <password>, and the --authenticationDatabase parameters.
mongosh -u "fred" -p --authenticationDatabase "admin"If you do not specify the password to the -p command-line option, mongosh prompts for the password.
The clusterAdmin role grants access to replication operations, such as configuring the replica set.
Create a cluster administrator user and assign the clusterAdmin role in the admin database:
You can use the passwordPrompt() method in conjunction with various user authentication management methods and commands to prompt for the password instead of specifying the password directly in the method or command call. However, you can still specify the password directly as you would with earlier versions of the mongo shell.
db.getSiblingDB("admin").createUser( { "user" : "ravi", "pwd" : passwordPrompt(), // or cleartext password roles: [ { "role" : "clusterAdmin", "db" : "admin" } ] })Enter the password when prompted.
See Cluster Administration Roles for a full list of built-in roles related to replica set and sharded cluster operations.
Create users to allow clients to connect and interact with the replica set. See Database User Roles for basic built-in roles to use in creating read-only and read-write users.
You may also want additional administrative users. For more information on users, see Users in Self-Managed Deployments.
For details on using X.509 for internal authentication, see Use X.509 Certificates for Membership Authentication with Self-Managed MongoDB.
To upgrade from keyfile internal authentication to X.509 internal authentication, see Upgrade Self-Managed MongoDB from Keyfile Authentication to X.509 Authentication.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4