Configuration File Options

Externally Sourced Values

The following expansion directives are available:

For complete documentation, see Externally Sourced Configuration File Values.

Expansion Directives and --configExpand

If you are using expansion directives in the configuration file, you must include the --configExpand option when starting the mongod or mongos. For example:

mongod --config /etc/mongod.conf  --configExpand "rest,exec"
mongos --config /etc/mongos.conf  --configExpand "rest,exec"

If the configuration file includes an expansion directive and you start the mongod / mongos without specifying that directive in the --configExpand option, the mongod / mongos fails to start.

For complete documentation, see Externally Sourced Configuration File Values.

systemLog.component Options

systemLog:
   component:
      accessControl:
         verbosity: <int>
      command:
         verbosity: <int>
      # COMMENT some component verbosity settings omitted for brevity
      replication:
         verbosity: <int>
         election:
            verbosity: <int>
         heartbeats:
            verbosity: <int>
         initialSync:
            verbosity: <int>
         rollback:
            verbosity: <int>
      storage:
         verbosity: <int>
         journal:
            verbosity: <int>
         recovery:
            verbosity: <int>
      write:
         verbosity: <int>

systemLog.component.accessControl.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to access control. See ACCESS components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.command.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to commands. See COMMAND components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.control.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to control operations. See CONTROL components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.ftdc.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to diagnostic data collection operations. See FTDC components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.geo.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to geospatial parsing operations. See GEO components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.index.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to indexing operations. See INDEX components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.network.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to networking operations. See NETWORK components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.query.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to query operations. See QUERY components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.replication.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to replication. See REPL components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.replication.election.verbosity

Type: integer

Default: 0

New in version 4.2.

The log message verbosity level for components related to election. See ELECTION components.

If systemLog.component.replication.election.verbosity is unset, systemLog.component.replication.verbosity level also applies to election components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.replication.heartbeats.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to heartbeats. See REPL_HB components.

If systemLog.component.replication.heartbeats.verbosity is unset, systemLog.component.replication.verbosity level also applies to heartbeats components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.replication.initialSync.verbosity

Type: integer

Default: 0

New in version 4.2.

The log message verbosity level for components related to initialSync. See INITSYNC components.

If systemLog.component.replication.initialSync.verbosity is unset, systemLog.component.replication.verbosity level also applies to initialSync components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.replication.rollback.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to rollback. See ROLLBACK components.

If systemLog.component.replication.rollback.verbosity is unset, systemLog.component.replication.verbosity level also applies to rollback components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.sharding.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to sharding. See SHARDING components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to storage. See STORAGE components.

If systemLog.component.storage.journal.verbosity is unset, systemLog.component.storage.verbosity level also applies to journaling components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.journal.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to journaling. See JOURNAL components.

If systemLog.component.storage.journal.verbosity is unset, the journaling components have the same verbosity level as the parent storage components: i.e. either the systemLog.component.storage.verbosity level if set or the default verbosity level.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.recovery.verbosity

Type: integer

Default: 0

New in version 4.0.

The log message verbosity level for components related to recovery. See RECOVERY components.

If systemLog.component.storage.recovery.verbosity is unset, systemLog.component.storage.verbosity level also applies to recovery components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity level for components related to the WiredTiger storage engine. See WT components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtBackup.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity level for components related to backup operations performed by the WiredTiger storage engine. See WTBACKUP components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtCheckpoint.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to checkpoint operations performed by the WiredTiger storage engine. See WTCHKPT components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtCompact.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to compaction operations performed by the WiredTiger storage engine. See WTCMPCT components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtEviction.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to eviction operations performed by the WiredTiger storage engine. See WTEVICT components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtHS.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to history store operations performed by the WiredTiger storage engine. See WTHS components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtRecovery.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to recovery operations performed by the WiredTiger storage engine. See WTRECOV components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtRTS.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to rollback to stable (RTS) operations performed by the WiredTiger storage engine. See WTRTS components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtSalvage.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to salvage operations performed by the WiredTiger storage engine. See WTSLVG components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtTiered.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to tiered storage operations performed by the WiredTiger storage engine. See WTTIER components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtTimestamp.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to timestamps used by the WiredTiger storage engine. See WTTS components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtTransaction.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to transaction operations performed by the WiredTiger storage engine. See WTTXN components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtVerify.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to verification operations performed by the WiredTiger storage engine. See WTVRFY components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.storage.wt.wtWriteLog.verbosity

Type: integer

Default: -1

New in version 5.3.

The log message verbosity for components related to log write operations performed by the WiredTiger storage engine. See WTWRTLOG components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.transaction.verbosity

Type: integer

Default: 0

New in version 4.0.2.

The log message verbosity level for components related to transaction. See TXN components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

systemLog.component.write.verbosity

Type: integer

Default: 0

The log message verbosity level for components related to write operations. See WRITE components.

The verbosity level can range from 0 to 5:

• 0 is the MongoDB's default log verbosity level, to include Informational messages.

• 1 to 5 increases the verbosity level to include Debug messages.

net.unixDomainSocket Options

net:
   unixDomainSocket:
      enabled: <boolean>
      pathPrefix: <string>
      filePermissions: <int>

net.unixDomainSocket.enabled

Type: boolean

Default: true

Enable or disable listening on the UNIX domain socket. net.unixDomainSocket.enabled applies only to Unix-based systems.

When net.unixDomainSocket.enabled is true, mongos or mongod listens on the UNIX socket.

The mongos or mongod process always listens on the UNIX socket unless one of the following is true:

• net.unixDomainSocket.enabled is false

• --nounixsocket is set. The command line option takes precedence over the configuration file setting.

• net.bindIp is not set

• net.bindIp does not specify localhost or its associated IP address

mongos or mongod installed from official .deb and .rpm packages have the bind_ip configuration set to 127.0.0.1 by default.

net.unixDomainSocket.pathPrefix

Type: string

Default: /tmp

The path for the UNIX socket. net.unixDomainSocket.pathPrefix applies only to Unix-based systems.

If this option has no value, the mongos or mongod process creates a socket with /tmp as a prefix. MongoDB creates and listens on a UNIX socket unless one of the following is true:

• net.unixDomainSocket.enabled is false

• --nounixsocket is set

• net.bindIp is not set

• net.bindIp does not specify localhost or its associated IP address

net.unixDomainSocket.filePermissions

Type: int

Default: 0700

Sets the permission for the UNIX domain socket file.

net.unixDomainSocket.filePermissions applies only to Unix-based systems.

net.http Options

net.tls Options

net:
   tls:
      mode: <string>
      certificateKeyFile: <string>
      certificateKeyFilePassword: <string>
      certificateSelector: <string>
      clusterCertificateSelector: <string>
      clusterFile: <string>
      clusterPassword: <string>
      CAFile: <string>
      clusterCAFile: <string>
      CRLFile: <string>
      allowConnectionsWithoutCertificates: <boolean>
      allowInvalidCertificates: <boolean>
      allowInvalidHostnames: <boolean>
      disabledProtocols: <string>
      FIPSMode: <boolean>
      logVersions: <string>

net.tls.mode

Type: string

New in version 4.2.

Enables TLS used for all network connections. The argument to the net.tls.mode setting can be one of the following:

Value	Description
disabled	The server does not use TLS.
allowTLS	Connections between servers do not use TLS. For incoming connections, the server accepts both TLS and non-TLS.
preferTLS	Connections between servers use TLS. For incoming connections, the server accepts both TLS and non-TLS.
requireTLS	The server uses and accepts only TLS encrypted connections.

If --tlsCAFile or tls.CAFile is not specified and you are not using x.509 authentication, the system-wide CA certificate store will be used when connecting to an TLS-enabled server.

If using x.509 authentication, --tlsCAFile or tls.CAFile must be specified unless using --tlsCertificateSelector.

For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.tls.certificateKeyFile

Type: string

New in version 4.2: The .pem file that contains both the TLS certificate and key.

Starting with MongoDB 4.0 on macOS or Windows, you can use the net.tls.certificateSelector setting to specify a certificate from the operating system's secure certificate store instead of a PEM key file. certificateKeyFile and net.tls.certificateSelector are mutually exclusive. You can only specify one.

• On Linux/BSD, you must specify net.tls.certificateKeyFile when TLS is enabled.

• On Windows or macOS, you must specify either net.tls.certificateKeyFile or net.tls.certificateSelector when TLS is enabled.

  Important

  For Windows only, MongoDB 4.0 and later do not support encrypted PEM files. The mongod fails to start if it encounters an encrypted PEM file. To securely store and access a certificate for use with TLS on Windows, use net.tls.certificateSelector.

For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.tls.certificateKeyFilePassword

Type: string

New in version 4.2: The password to de-crypt the certificate-key file (i.e. certificateKeyFile). Use the net.tls.certificateKeyFilePassword option only if the certificate-key file is encrypted. In all cases, the mongos or mongod will redact the password from all logging and reporting output.

Starting in MongoDB 4.0:

• On Linux/BSD, if the private key in the PEM file is encrypted and you do not specify the net.tls.certificateKeyFilePassword option, MongoDB will prompt for a passphrase. See TLS/SSL Certificate Passphrase.

• On macOS, if the private key in the PEM file is encrypted, you must explicitly specify the net.tls.certificateKeyFilePassword option. Alternatively, you can use a certificate from the secure system store (see net.tls.certificateSelector) instead of a PEM key file or use an unencrypted PEM file.

• On Windows, MongoDB does not support encrypted certificates. The mongod fails if it encounters an encrypted PEM file. Use net.tls.certificateSelector instead.

For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.tls.certificateSelector

Type: string

New in version 4.2: Available on Windows and macOS as an alternative to net.tls.certificateKeyFile. In MongoDB 4.0, see net.ssl.certificateSelector.

Specifies a certificate property in order to select a matching certificate from the operating system's certificate store to use for TLS/SSL.

net.tls.certificateKeyFile and net.tls.certificateSelector options are mutually exclusive. You can only specify one.

net.tls.certificateSelector accepts an argument of the format <property>=<value> where the property can be one of the following:

Property	Value type	Description
subject	ASCII string	Subject name or common name on certificate
thumbprint	hex string	A sequence of bytes, expressed as hexadecimal, used to identify a public key by its SHA-1 digest. The thumbprint is sometimes referred to as a fingerprint.

When using the system SSL certificate store, OCSP (Online Certificate Status Protocol) is used to validate the revocation status of certificates.

The mongod searches the operating system's secure certificate store for the CA certificates required to validate the full certificate chain of the specified TLS certificate. Specifically, the secure certificate store must contain the root CA and any intermediate CA certificates required to build the full certificate chain to the TLS certificate. Do not use net.tls.CAFile or net.tls.clusterFile to specify the root and intermediate CA certificate

For example, if the TLS certificate was signed with a single root CA certificate, the secure certificate store must contain that root CA certificate. If the TLS certificate was signed with an intermediate CA certificate, the secure certificate store must contain the intermedia CA certificate and the root CA certificate.

Note

You cannot use the rotateCertificates command or the db.rotateCertificates() shell method when using net.tls.certificateSelector or --tlsCertificateSelector set to thumbprint

net.tls.clusterCertificateSelector

Type: string

New in version 4.2: Available on Windows and macOS as an alternative to net.tls.clusterFile.

Specifies a certificate property to select a matching certificate from the operating system's secure certificate store to use for internal x.509 membership authentication.

net.tls.clusterFile and net.tls.clusterCertificateSelector options are mutually exclusive. You can only specify one.

net.tls.clusterCertificateSelector accepts an argument of the format <property>=<value> where the property can be one of the following:

Property	Value type	Description
subject	ASCII string	Subject name or common name on certificate
thumbprint	hex string	A sequence of bytes, expressed as hexadecimal, used to identify a public key by its SHA-1 digest. The thumbprint is sometimes referred to as a fingerprint.

The mongod searches the operating system's secure certificate store for the CA certificates required to validate the full certificate chain of the specified cluster certificate. Specifically, the secure certificate store must contain the root CA and any intermediate CA certificates required to build the full certificate chain to the cluster certificate. Do not use net.tls.CAFile or net.tls.clusterCAFile to specify the root and intermediate CA certificate.

For example, if the cluster certificate was signed with a single root CA certificate, the secure certificate store must contain that root CA certificate. If the cluster certificate was signed with an intermediate CA certificate, the secure certificate store must contain the intermediate CA certificate and the root CA certificate.

Changed in version 4.4: mongod / mongos logs a warning on connection if the presented x.509 certificate expires within 30 days of the mongod/mongos host system time. See x.509 Certificates Nearing Expiry Trigger Warnings for more information.

net.tls.clusterFile

Type: string

New in version 4.2: The .pem file that contains the x.509 certificate-key file for membership authentication for the cluster or replica set.

Starting with MongoDB 4.0 on macOS or Windows, you can use the net.tls.clusterCertificateSelector option to specify a certificate from the operating system's secure certificate store instead of a PEM key file. net.tls.clusterFile and net.tls.clusterCertificateSelector options are mutually exclusive. You can only specify one.

If net.tls.clusterFile does not specify the .pem file for internal cluster authentication or the alternative net.tls.clusterCertificateSelector, the cluster uses the .pem file specified in the certificateKeyFile setting or the certificate returned by the net.tls.certificateSelector.

If using x.509 authentication, --tlsCAFile or tls.CAFile must be specified unless using --tlsCertificateSelector.

Changed in version 4.4: mongod / mongos logs a warning on connection if the presented x.509 certificate expires within 30 days of the mongod/mongos host system time. See x.509 Certificates Nearing Expiry Trigger Warnings for more information.

For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

Important

For Windows only, MongoDB 4.0 and later do not support encrypted PEM files. The mongod fails to start if it encounters an encrypted PEM file. To securely store and access a certificate for use with membership authentication on Windows, use net.tls.clusterCertificateSelector.

net.tls.clusterPassword

Type: string

New in version 4.2: The password to de-crypt the x.509 certificate-key file specified with --sslClusterFile. Use the net.tls.clusterPassword option only if the certificate-key file is encrypted. In all cases, the mongos or mongod will redact the password from all logging and reporting output.

Starting in MongoDB 4.0:

• On Linux/BSD, if the private key in the x.509 file is encrypted and you do not specify the net.tls.clusterPassword option, MongoDB will prompt for a passphrase. See TLS/SSL Certificate Passphrase.

• On macOS, if the private key in the x.509 file is encrypted, you must explicitly specify the net.tls.clusterPassword option. Alternatively, you can either use a certificate from the secure system store (see net.tls.clusterCertificateSelector) instead of a cluster PEM file or use an unencrypted PEM file.

• On Windows, MongoDB does not support encrypted certificates. The mongod fails if it encounters an encrypted PEM file. Use net.tls.clusterCertificateSelector.

For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.tls.CAFile

Type: string

New in version 4.2: The .pem file that contains the root certificate chain from the Certificate Authority. Specify the file name of the .pem file using relative or absolute paths.

Windows/macOS Only

If using net.tls.certificateSelector and/or net.tls.clusterCertificateSelector, do not use net.tls.CAFile to specify the root and intermediate CA certificates. Store all CA certificates required to validate the full trust chain of the net.tls.certificateSelector and/or net.tls.clusterCertificateSelector certificates in the secure certificate store.

For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.tls.clusterCAFile

Type: string

New in version 4.2: The .pem file that contains the root certificate chain from the Certificate Authority used to validate the certificate presented by a client establishing a connection. Specify the file name of the .pem file using relative or absolute paths. net.tls.clusterCAFile requires that net.tls.CAFile is set.

If net.tls.clusterCAFile does not specify the .pem file for validating the certificate from a client establishing a connection, the cluster uses the .pem file specified in the net.tls.CAFile option.

net.tls.clusterCAFile lets you use separate Certificate Authorities to verify the client to server and server to client portions of the TLS handshake.

Starting in 4.0, on macOS or Windows, you can use a certificate from the operating system's secure store instead of a PEM key file. See net.tls.clusterCertificateSelector. When using the secure store, you do not need to, but can, also specify the net.tls.clusterCAFile.

Windows/macOS Only

If using net.tls.certificateSelector and/or net.tls.clusterCertificateSelector, do not use net.tls.clusterCAFile to specify the root and intermediate CA certificates. Store all CA certificates required to validate the full trust chain of the net.tls.certificateSelector and/or net.tls.clusterCertificateSelector certificates in the secure certificate store.

For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.tls.CRLFile

Type: string

New in version 4.2: In MongoDB 4.0 and earlier, see net.ssl.CRLFile.

The .pem file that contains the Certificate Revocation List. Specify the file name of the .pem file using relative or absolute paths.

Note

• Starting in MongoDB 4.0, you cannot specify net.tls.CRLFile on macOS. Instead, you can use the system SSL certificate store, which uses OCSP (Online Certificate Status Protocol) to validate the revocation status of certificates. See net.ssl.certificateSelector in MongoDB 4.0 and net.tls.certificateSelector in MongoDB 4.2+ to use the system SSL certificate store.

• Starting in version 4.4, to check for certificate revocation, MongoDB enables the use of OCSP (Online Certificate Status Protocol) by default as an alternative to specifying a CRL file or using the system SSL certificate store.

For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.tls.allowConnectionsWithoutCertificates

Type: boolean

New in version 4.2.

For clients that don't provide certificates, mongod or mongos encrypts the TLS/SSL connection, assuming the connection is successfully made.

For clients that present a certificate, however, mongos or mongod performs certificate validation using the root certificate chain specified by CAFile and reject clients with invalid certificates.

Use the net.tls.allowConnectionsWithoutCertificates option if you have a mixed deployment that includes clients that do not or cannot present certificates to the mongos or mongod.

For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.tls.allowInvalidCertificates

Type: boolean

New in version 4.2.

Enable or disable the validation checks for TLS certificates on other servers in the cluster and allows the use of invalid certificates to connect.

Note

If you specify --tlsAllowInvalidCertificates or tls.allowInvalidCertificates: true when using x.509 authentication, an invalid certificate is only sufficient to establish a TLS connection but is insufficient for authentication.

When using the net.tls.allowInvalidCertificates setting, MongoDB logs a warning regarding the use of the invalid certificate.

For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.tls.allowInvalidHostnames

Type: boolean

Default: false

When net.tls.allowInvalidHostnames is true, MongoDB disables the validation of the hostnames in TLS certificates, allowing mongod to connect to MongoDB instances if the hostname their certificates do not match the specified hostname.

For more information about TLS and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.tls.disabledProtocols

Type: string

New in version 4.2.

Prevents a MongoDB server running with TLS from accepting incoming connections that use a specific protocol or protocols. To specify multiple protocols, use a comma separated list of protocols.

net.tls.disabledProtocols recognizes the following protocols: TLS1_0, TLS1_1, TLS1_2, and starting in version 4.0.4 (and 3.6.9), TLS1_3.

• On macOS, you cannot disable TLS1_1 and leave both TLS1_0 and TLS1_2 enabled. You must disable at least one of the other two, for example, TLS1_0,TLS1_1.

• To list multiple protocols, specify as a comma separated list of protocols. For example TLS1_0,TLS1_1.

• Specifying an unrecognized protocol will prevent the server from starting.

• The specified disabled protocols overrides any default disabled protocols.

Starting in version 4.0, MongoDB disables the use of TLS 1.0 if TLS 1.1+ is available on the system. To enable the disabled TLS 1.0, specify none to net.tls.disabledProtocols. See Disable TLS 1.0.

Members of replica sets and sharded clusters must speak at least one protocol in common.

Tip

See also:

Disallow Protocols

net.tls.FIPSMode

Type: boolean

New in version 4.2.

Enable or disable the use of the FIPS mode of the TLS library for the mongos or mongod. Your system must have a FIPS compliant library to use the net.tls.FIPSMode option.

Note

FIPS-compatible TLS/SSL is available only in MongoDB Enterprise. See Configure MongoDB for FIPS for more information.

net.tls.logVersions

Type: string

Instructs mongos or mongod to log a message when a client connects using a specified TLS version.

Specify either a single TLS version or a comma-separated list of multiple TLS versions.

Example

To instruct mongos or mongod to log a message when a client connects using either TLS 1.2 or TLS 1.3, set net.tls.logVersions to "TLS1_2,TLS1_3".

net.ssl Options

net:
   ssl:                            # deprecated since 4.2
      sslOnNormalPorts: <boolean>  # deprecated since 2.6
      mode: <string>
      PEMKeyFile: <string>
      PEMKeyPassword: <string>
      certificateSelector: <string>
      clusterCertificateSelector: <string>
      clusterFile: <string>
      clusterPassword: <string>
      CAFile: <string>
      clusterCAFile: <string>
      CRLFile: <string>
      allowConnectionsWithoutCertificates: <boolean>
      allowInvalidCertificates: <boolean>
      allowInvalidHostnames: <boolean>
      disabledProtocols: <string>
      FIPSMode: <boolean>

net.ssl.sslOnNormalPorts

Type: boolean

Deprecated since version 2.6: Use net.tls.mode: requireTLS instead.

Enable or disable TLS/SSL for mongos or mongod.

With net.ssl.sslOnNormalPorts, a mongos or mongod requires TLS/SSL encryption for all connections on the default MongoDB port, or the port specified by net.port. By default, net.ssl.sslOnNormalPorts is disabled.

For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.ssl.mode

Type: string

Deprecated since version 4.2: Use net.tls.mode instead.

Enables TLS/SSL or mixed TLS/SSL used for all network connections. The argument to the net.ssl.mode setting can be one of the following:

Value	Description
disabled	The server does not use TLS/SSL.
allowSSL	Connections between servers do not use TLS/SSL. For incoming connections, the server accepts both TLS/SSL and non-TLS/non-SSL.
preferSSL	Connections between servers use TLS/SSL. For incoming connections, the server accepts both TLS/SSL and non-TLS/non-SSL.
requireSSL	The server uses and accepts only TLS/SSL encrypted connections.

If --tlsCAFile/net.tls.CAFile (or their aliases --sslCAFile/net.ssl.CAFile) is not specified and you are not using x.509 authentication, the system-wide CA certificate store will be used when connecting to an TLS/SSL-enabled server.

To use x.509 authentication, --tlsCAFile or net.tls.CAFile must be specified unless you are using --tlsCertificateSelector or --net.tls.certificateSelector.

For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.ssl.PEMKeyFile

Type: string

Deprecated since version 4.2: Use net.tls.certificateKeyFile instead.

The .pem file that contains both the TLS/SSL certificate and key.

Starting with MongoDB 4.0 on macOS or Windows, you can use the net.ssl.certificateSelector setting to specify a certificate from the operating system's secure certificate store instead of a PEM key file. PEMKeyFile and net.ssl.certificateSelector are mutually exclusive. You can only specify one.

• On Linux/BSD, you must specify net.ssl.PEMKeyFile when TLS/SSL is enabled.

• On Windows or macOS, you must specify either net.ssl.PEMKeyFile or net.ssl.certificateSelector when TLS/SSL is enabled.

  Important

  For Windows only, MongoDB 4.0 and later do not support encrypted PEM files. The mongod fails to start if it encounters an encrypted PEM file. To securely store and access a certificate for use with TLS/SSL on Windows, use net.ssl.certificateSelector.

For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.ssl.PEMKeyPassword

Type: string

Deprecated since version 4.2: Use net.tls.certificateKeyFilePassword instead.

The password to de-crypt the certificate-key file (i.e. PEMKeyFile). Use the net.ssl.PEMKeyPassword option only if the certificate-key file is encrypted. In all cases, the mongos or mongod will redact the password from all logging and reporting output.

Starting in MongoDB 4.0:

• On Linux/BSD, if the private key in the PEM file is encrypted and you do not specify the net.ssl.PEMKeyPassword option, MongoDB will prompt for a passphrase. See TLS/SSL Certificate Passphrase.

• On macOS, if the private key in the PEM file is encrypted, you must explicitly specify the net.ssl.PEMKeyPassword option. Alternatively, you can use a certificate from the secure system store (see net.ssl.certificateSelector) instead of a PEM key file or use an unencrypted PEM file.

• On Windows, MongoDB does not support encrypted certificates. The mongod fails if it encounters an encrypted PEM file. Use net.ssl.certificateSelector instead.

For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.ssl.certificateSelector

Type: string

Deprecated since version 4.2: Use net.tls.certificateSelector instead.

New in version 4.0: Available on Windows and macOS as an alternative to net.ssl.PEMKeyFile.

Specifies a certificate property in order to select a matching certificate from the operating system's certificate store to use for TLS/SSL.

net.ssl.PEMKeyFile and net.ssl.certificateSelector options are mutually exclusive. You can only specify one.

net.ssl.certificateSelector accepts an argument of the format <property>=<value> where the property can be one of the following:

Property	Value type	Description
subject	ASCII string	Subject name or common name on certificate
thumbprint	hex string	A sequence of bytes, expressed as hexadecimal, used to identify a public key by its SHA-1 digest. The thumbprint is sometimes referred to as a fingerprint.

When using the system SSL certificate store, OCSP (Online Certificate Status Protocol) is used to validate the revocation status of certificates.

The mongod searches the operating system's secure certificate store for the CA certificates required to validate the full certificate chain of the specified TLS/SSL certificate. Specifically, the secure certificate store must contain the root CA and any intermediate CA certificates required to build the full certificate chain to the TLS/SSL certificate. Do not use net.ssl.CAFile or net.ssl.clusterFile to specify the root and intermediate CA certificate

For example, if the TLS/SSL certificate was signed with a single root CA certificate, the secure certificate store must contain that root CA certificate. If the TLS/SSL certificate was signed with an intermediate CA certificate, the secure certificate store must contain the intermedia CA certificate and the root CA certificate.

net.ssl.clusterCertificateSelector

Type: string

Deprecated since version 4.2: Use net.tls.clusterCertificateSelector instead.

New in version 4.0: Available on Windows and macOS as an alternative to net.ssl.clusterFile.

Specifies a certificate property to select a matching certificate from the operating system's secure certificate store to use for internal x.509 membership authentication.

net.ssl.clusterFile and net.ssl.clusterCertificateSelector options are mutually exclusive. You can only specify one.

net.ssl.clusterCertificateSelector accepts an argument of the format <property>=<value> where the property can be one of the following:

Property	Value type	Description
subject	ASCII string	Subject name or common name on certificate
thumbprint	hex string	A sequence of bytes, expressed as hexadecimal, used to identify a public key by its SHA-1 digest. The thumbprint is sometimes referred to as a fingerprint.

The mongod searches the operating system's secure certificate store for the CA certificates required to validate the full certificate chain of the specified cluster certificate. Specifically, the secure certificate store must contain the root CA and any intermediate CA certificates required to build the full certificate chain to the cluster certificate. Do not use net.ssl.CAFile or net.ssl.clusterFile to specify the root and intermediate CA certificate.

For example, if the cluster certificate was signed with a single root CA certificate, the secure certificate store must contain that root CA certificate. If the cluster certificate was signed with an intermediate CA certificate, the secure certificate store must contain the intermedia CA certificate and the root CA certificate.

net.ssl.clusterFile

Type: string

Deprecated since version 4.2: Use net.tls.clusterFile instead.

The .pem file that contains the x.509 certificate-key file for membership authentication for the cluster or replica set.

Starting with MongoDB 4.0 on macOS or Windows, you can use the net.ssl.clusterCertificateSelector option to specify a certificate from the operating system's secure certificate store instead of a PEM key file. net.ssl.clusterFile and net.ssl.clusterCertificateSelector options are mutually exclusive. You can only specify one.

If net.ssl.clusterFile does not specify the .pem file for internal cluster authentication or the alternative net.ssl.clusterCertificateSelector, the cluster uses the .pem file specified in the PEMKeyFile setting or the certificate returned by the net.ssl.certificateSelector.

To use x.509 authentication, --tlsCAFile or net.tls.CAFile must be specified unless you are using --tlsCertificateSelector or --net.tls.certificateSelector.

For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

Important

For Windows only, MongoDB 4.0 and later do not support encrypted PEM files. The mongod fails to start if it encounters an encrypted PEM file. To securely store and access a certificate for use with membership authentication on Windows, use net.ssl.clusterCertificateSelector.

net.ssl.clusterPassword

Type: string

Deprecated since version 4.2: Use net.tls.clusterPassword instead.

The password to de-crypt the x.509 certificate-key file specified with --sslClusterFile. Use the net.ssl.clusterPassword option only if the certificate-key file is encrypted. In all cases, the mongos or mongod will redact the password from all logging and reporting output.

Starting in MongoDB 4.0:

• On Linux/BSD, if the private key in the x.509 file is encrypted and you do not specify the net.ssl.clusterPassword option, MongoDB will prompt for a passphrase. See TLS/SSL Certificate Passphrase.

• On macOS, if the private key in the x.509 file is encrypted, you must explicitly specify the net.ssl.clusterPassword option. Alternatively, you can either use a certificate from the secure system store (see net.ssl.clusterCertificateSelector) instead of a cluster PEM file or use an unencrypted PEM file.

• On Windows, MongoDB does not support encrypted certificates. The mongod fails if it encounters an encrypted PEM file. Use net.ssl.clusterCertificateSelector.

For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.ssl.CAFile

Type: string

Deprecated since version 4.2: Use net.tls.CAFile instead.

The .pem file that contains the root certificate chain from the Certificate Authority. Specify the file name of the .pem file using relative or absolute paths.

Windows/macOS Only

If using net.ssl.certificateSelector and/or net.ssl.clusterCertificateSelector, do not use net.ssl.CAFile to specify the root and intermediate CA certificates. Store all CA certificates required to validate the full trust chain of the net.ssl.certificateSelector and/or net.ssl.clusterCertificateSelector certificates in the secure certificate store.

For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.ssl.clusterCAFile

Type: string

Deprecated since version 4.2: Use net.tls.clusterCAFile instead.

The .pem file that contains the root certificate chain from the Certificate Authority used to validate the certificate presented by a client establishing a connection. Specify the file name of the .pem file using relative or absolute paths. net.ssl.clusterCAFile requires that net.ssl.CAFile is set.

If net.ssl.clusterCAFile does not specify the .pem file for validating the certificate from a client establishing a connection, the cluster uses the .pem file specified in the net.ssl.CAFile option.

net.ssl.clusterCAFile lets you use separate Certificate Authorities to verify the client to server and server to client portions of the TLS handshake.

Starting in 4.0, on macOS or Windows, you can use a certificate from the operating system's secure store instead of a PEM key file. See net.ssl.clusterCertificateSelector. When using the secure store, you do not need to, but can, also specify the net.ssl.clusterCAFile.

Windows/macOS Only

If using net.ssl.certificateSelector and/or net.ssl.clusterCertificateSelector, do not use net.ssl.clusterCAFile to specify the root and intermediate CA certificates. Store all CA certificates required to validate the full trust chain of the net.ssl.certificateSelector and/or net.ssl.clusterCertificateSelector certificates in the secure certificate store.

For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.ssl.CRLFile

Type: string

Deprecated since version 4.2: Use net.tls.CRLFile instead.

The .pem file that contains the Certificate Revocation List. Specify the file name of the .pem file using relative or absolute paths.

Note

• Starting in MongoDB 4.0, you cannot specify net.ssl.CRLFile on macOS. Instead, you can use the system SSL certificate store, which uses OCSP (Online Certificate Status Protocol) to validate the revocation status of certificates. See net.ssl.certificateSelector in MongoDB 4.0 and net.tls.certificateSelector in MongoDB 4.2 to use the system SSL certificate store.

• Starting in version 4.4, MongoDB enables, by default, the use of OCSP (Online Certificate Status Protocol) to check for certificate revocation as an alternative to specifying a CRL file or using the system SSL certificate store.

For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.ssl.allowConnectionsWithoutCertificates

Type: boolean

Deprecated since version 4.2: Use net.tls.allowConnectionsWithoutCertificates instead.

For clients that don't provide certificates, mongod or mongos encrypts the TLS/SSL connection, assuming the connection is successfully made.

For clients that present a certificate, however, mongos or mongod performs certificate validation using the root certificate chain specified by CAFile and reject clients with invalid certificates.

Use the net.ssl.allowConnectionsWithoutCertificates option if you have a mixed deployment that includes clients that do not or cannot present certificates to the mongos or mongod.

For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.ssl.allowInvalidCertificates

Type: boolean

Deprecated since version 4.2: Use net.tls.allowInvalidCertificates instead.

Enable or disable the validation checks for TLS/SSL certificates on other servers in the cluster and allows the use of invalid certificates to connect.

Note

Starting in MongoDB 4.0, if you specify any of the following x.509 authentication options, an invalid certificate is sufficient only to establish a TLS connection but it is insufficient for authentication:

• --sslAllowInvalidCertificates or net.ssl.allowInvalidCertificates: true for MongoDB 4.0 and later

• --tlsAllowInvalidCertificates or net.tls.allowInvalidCertificates: true for MongoDB 4.2 and later

When using the net.ssl.allowInvalidCertificates setting, MongoDB logs a warning regarding the use of the invalid certificate.

For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.ssl.allowInvalidHostnames

Type: boolean

Default: false

Deprecated since version 4.2.

Use net.tls.allowInvalidHostnames instead.

When net.ssl.allowInvalidHostnames is true, MongoDB disables the validation of the hostnames in TLS/SSL certificates, allowing mongod to connect to MongoDB instances if the hostname their certificates do not match the specified hostname.

For more information about TLS/SSL and MongoDB, see Configure mongod and mongos for TLS/SSL and TLS/SSL Configuration for Clients .

net.ssl.disabledProtocols

Type: string

Deprecated since version 4.2: Use net.tls.disabledProtocols instead.

Prevents a MongoDB server running with TLS/SSL from accepting incoming connections that use a specific protocol or protocols. To specify multiple protocols, use a comma separated list of protocols.

net.ssl.disabledProtocols recognizes the following protocols: TLS1_0, TLS1_1, TLS1_2, and starting in version 4.0.4 (and 3.6.9), TLS1_3.

• On macOS, you cannot disable TLS1_1 and leave both TLS1_0 and TLS1_2 enabled. You must disable at least one of the other two, for example, TLS1_0,TLS1_1.

• To list multiple protocols, specify as a comma separated list of protocols. For example TLS1_0,TLS1_1.

• Specifying an unrecognized protocol will prevent the server from starting.

• The specified disabled protocols overrides any default disabled protocols.

Starting in version 4.0, MongoDB disables the use of TLS 1.0 if TLS 1.1+ is available on the system. To enable the disabled TLS 1.0, specify none to net.ssl.disabledProtocols. See Disable TLS 1.0.

Members of replica sets and sharded clusters must speak at least one protocol in common.

Tip

See also:

Disallow Protocols

net.ssl.FIPSMode

Type: boolean

Deprecated since version 4.2: Use net.tls.FIPSMode instead.

Enable or disable the use of the FIPS mode of the TLS/SSL library for the mongos or mongod. Your system must have a FIPS compliant library to use the net.ssl.FIPSMode option.

Note

FIPS-compatible TLS/SSL is available only in MongoDB Enterprise. See Configure MongoDB for FIPS for more information.

net.compression Option

net:
   compression:
      compressors: <string>

net.compression.compressors

Default: snappy,zstd,zlib

Specifies the default compressor(s) to use for communication between this mongod or mongos instance and:

• other members of the deployment if the instance is part of a replica set or a sharded cluster

• mongosh

• drivers that support the OP_COMPRESSED message format.

MongoDB supports the following compressors:

• snappy

• zlib (Available starting in MongoDB 3.6)

• zstd (Available starting in MongoDB 4.2)

In versions 3.6 and 4.0, mongod and mongos enable network compression by default with snappy as the compressor.

Starting in version 4.2, mongod and mongos instances default to both snappy,zstd,zlib compressors, in that order.

To disable network compression, set the value to disabled.

Important

Messages are compressed when both parties enable network compression. Otherwise, messages between the parties are uncompressed.

If you specify multiple compressors, then the order in which you list the compressors matter as well as the communication initiator. For example, if mongosh specifies the following network compressors zlib,snappy and the mongod specifies snappy,zlib, messages between mongosh and mongod uses zlib.

If the parties do not share at least one common compressor, messages between the parties are uncompressed. For example, if mongosh specifies the network compressor zlib and mongod specifies snappy, messages between mongosh and mongod are not compressed.

Key Management Configuration Options

security:
   enableEncryption: <boolean>
   encryptionCipherMode: <string>
   encryptionKeyFile: <string>
   kmip:
      keyIdentifier: <string>
      rotateMasterKey: <boolean>
      serverName: <string>
      port: <string>
      clientCertificateFile: <string>
      clientCertificatePassword: <string>
      clientCertificateSelector: <string>
      serverCAFile: <string>
      connectRetries: <int>
      connectTimeoutMS: <int>
      activateKeys: <boolean>
      keyStatePollingSeconds: <int>

security.enableEncryption

Type: boolean

Default: false

Enables encryption for the WiredTiger storage engine. You must set to true to pass in encryption keys and configurations.

Note

Enterprise Feature

Available in MongoDB Enterprise only.

security.encryptionCipherMode

Type: string

Default: AES256-CBC

The cipher mode to use for encryption at rest:

Mode	Description
AES256-CBC	256-bit Advanced Encryption Standard in Cipher Block Chaining Mode
AES256-GCM	256-bit Advanced Encryption Standard in Galois/Counter Mode Available only on Linux. Changed in version 4.0: MongoDB Enterprise on Windows no longer supports AES256-GCM. This cipher is now available only on Linux.

Note

Enterprise Feature

Available in MongoDB Enterprise only.

security.encryptionKeyFile

Type: string

The path to the local keyfile when managing keys via process other than KMIP. Only set when managing keys via process other than KMIP. If data is already encrypted using KMIP, MongoDB will throw an error.

Requires security.enableEncryption to be true.

Note

Enterprise Feature

Available in MongoDB Enterprise only.

security.kmip.keyIdentifier

Type: string

Unique KMIP identifier for an existing key within the KMIP server. Include to use the key associated with the identifier as the system key. You can only use the setting the first time you enable encryption for the mongod instance. Requires security.enableEncryption to be true.

If unspecified, MongoDB will request that the KMIP server create a new key to utilize as the system key.

If the KMIP server cannot locate a key with the specified identifier or the data is already encrypted with a key, MongoDB will throw an error.

Note

Enterprise Feature

Available in MongoDB Enterprise only.

security.kmip.rotateMasterKey

Type: boolean

Default: false

If true, rotate the master key and re-encrypt the internal keystore.

Note

Enterprise Feature

Available in MongoDB Enterprise only.

Tip

See also:

KMIP Master Key Rotation

security.kmip.serverName

Type: string

Hostname or IP address of the KMIP server to connect to. security.enableEncryption must be set to true.

Starting in MongoDB 4.2.1 (and 4.0.14), you can specify multiple KMIP servers as a comma-separated list.

Example

To specify both server1.example.com and server2.example.com as KMIP servers, set security.kmip.serverName to "server1.example.com,server2.example.com".

You cannot specify the port number in security.kmip.serverName. Instead, specify the port with security.kmip.port. You may only specify one port and each host must use that port.

On startup, mongod attempts to establish a connection to each server in the order listed and selects the first server it can connect to. KMIP server selection only occurs at startup.

mongod verifies the connection to the KMIP server on startup.

The server name specified in --kmipServerName must match either the Subject Alternative Name SAN or the Common Name CN on the certificate presented by the KMIP server. SAN can be a system name or an IP address.

If SAN is present, mongod does not try to match against CN.

If the hostname or IP address of the KMIP server does does not match either SAN or CN, mongod does not start.

Starting in MongoDB 4.2, when performing comparison of SAN, MongoDB supports comparison of DNS names or IP addresses. In previous versions, MongoDB only supports comparisons of DNS names.

Note

Enterprise Feature

Available in MongoDB Enterprise only.

security.kmip.port

Type: string

Default: 5696

Port number to use to communicate with the KMIP server. Requires security.kmip.serverName. Requires security.enableEncryption to be true.

If specifying multiple KMIP servers with security.kmip.serverName, the mongod will use the port specified with security.kmip.port for all provided KMIP servers.

Note

Enterprise Feature

Available in MongoDB Enterprise only.

security.kmip.clientCertificateFile

Type: string

Path to the .pem file used to authenticate MongoDB to the KMIP server. The specified .pem file must contain both the TLS/SSL certificate and key.

To use this setting, you must also specify the security.kmip.serverName setting.

Note

Starting in 4.0, on macOS or Windows, you can use a certificate from the operating system's secure store instead of a PEM key file. See security.kmip.clientCertificateSelector.

Note

Enterprise Feature

Available in MongoDB Enterprise only.

security.kmip.clientCertificatePassword

Type: string

The password to decrypt the client certificate (i.e. security.kmip.clientCertificateFile), used to authenticate MongoDB to the KMIP server. Use the option only if the certificate is encrypted.

Note

Enterprise Feature

Available in MongoDB Enterprise only.

security.kmip.clientCertificateSelector

Type: string

New in version 4.0: (and 4.2.15, 4.4.7, and 5.0)

Available on Windows and macOS as an alternative to security.kmip.clientCertificateFile.

security.kmip.clientCertificateFile and security.kmip.clientCertificateSelector options are mutually exclusive. You can only specify one.

Specifies a certificate property in order to select a matching certificate from the operating system's certificate store to authenticate MongoDB to the KMIP server.

security.kmip.clientCertificateSelector accepts an argument of the format <property>=<value> where the property can be one of the following:

Property	Value type	Description
subject	ASCII string	Subject name or common name on certificate
thumbprint	hex string	A sequence of bytes, expressed as hexadecimal, used to identify a public key by its SHA-1 digest. The thumbprint is sometimes referred to as a fingerprint.

Note

Enterprise Feature

Available in MongoDB Enterprise only.

security.kmip.serverCAFile

Type: string

Path to CA File. Used for validating secure client connection to KMIP server.

Note

Starting in 4.0, on macOS or Windows, you can use a certificate from the operating system's secure store instead of a PEM key file. See security.kmip.clientCertificateSelector. When using the secure store, you do not need to, but can, also specify the security.kmip.serverCAFile.

Note

Enterprise Feature

Available in MongoDB Enterprise only.

security.kmip.connectRetries

Type: int

Default: 0

New in version 4.4.

How many times to retry the initial connection to the KMIP server. Use together with connectTimeoutMS to control how long the mongod waits for a response between each retry.

Note

Enterprise Feature

Available in MongoDB Enterprise only.

security.kmip.connectTimeoutMS

Type: int

Default: 5000

New in version 4.4.

Timeout in milliseconds to wait for a response from the KMIP server. If the connectRetries setting is specified, the mongod will wait up to the value specified with connectTimeoutMS for each retry.

Value must be 1000 or greater.

Note

Enterprise Feature

Available in MongoDB Enterprise only.

security.kmip.activateKeys

Type: boolean

Default: true

New in version 5.3.

Activates all newly created KMIP keys upon creation and then periodically checks those keys are in an active state.

When security.kmip.activateKeys is true and you have existing keys on a KMIP server, the key must be activated first or the mongod node will fail to start.

If the key being used by the mongod transitions into a non-active state, the mongod node will shut down unless kmipActivateKeys is false. To ensure you have an active key, rotate the KMIP master key by using security.kmip.rotateMasterKey.

security.kmip.keyStatePollingSeconds

Type: int

Default: 900 seconds

New in version 5.3.

Frequency in seconds at which mongod polls the KMIP server for active keys.

To disable disable polling, set the value to -1.

security.kmip.useLegacyProtocol

Type: boolean

Default: false

New in version 7.0: (and 6.0.6)

When true, mongod uses KMIP protocol version 1.0 or 1.1 instead of the default version. The default KMIP protocol is version 1.2.

To use audit log encryption with KMIP version 1.0 or 1.1, you must specify auditEncryptKeyWithKMIPGet at startup.

To use KMIP protocol version 1.0 or 1.1, substitute your local values and add an entry like this to your mongod configuration file:

security:
  enableEncryption: true
  kmip:
    serverName: "mdbhost.somecompany.com"
    serverCAFile: "security/libs/trusted-ca.pem"
    clientCertificateFile: "security/libs/trusted-client.pem"
    useLegacyProtocol: true

security.sasl Options

security:
   sasl:
      hostName: <string>
      serviceName: <string>
      saslauthdSocketPath: <string>

security.sasl.hostName

Type: string

A fully qualified server domain name for the purpose of configuring SASL and Kerberos authentication. The SASL hostname overrides the hostname only for the configuration of SASL and Kerberos.

security.sasl.serviceName

Type: string

Registered name of the service using SASL. This option allows you to override the default Kerberos service name component of the Kerberos principal name, on a per-instance basis. If unspecified, the default value is mongodb.

MongoDB permits setting this option only at startup. The setParameter can not change this setting.

This option is available only in MongoDB Enterprise.

Important

Ensure that your driver supports alternate service names. For mongosh and other MongoDB tools to connect to the new serviceName, see the gssapiServiceName option.

security.sasl.saslauthdSocketPath

Type: string

The path to the UNIX domain socket file for saslauthd.

security.ldap Options

security:
   ldap:
      servers: <string>
      bind:
         method: <string>
         saslMechanisms: <string>
         queryUser: <string>
         queryPassword: <string | array>
         useOSDefaults: <boolean>
      transportSecurity: <string>
      timeoutMS: <int>
      retryCount: <int>
      userToDNMapping: <string>
      authz:
         queryTemplate: <string>
      validateLDAPServerConfig: <boolean>

security.ldap.servers

Type: string

Available in MongoDB Enterprise only.

The LDAP server against which the mongod or mongos authenticates users or determines what actions a user is authorized to perform on a given database. If the LDAP server specified has any replicated instances, you may specify the host and port of each replicated server in a comma-delimited list.

If your LDAP infrastructure partitions the LDAP directory over multiple LDAP servers, specify one LDAP server or any of its replicated instances to security.ldap.servers. MongoDB supports following LDAP referrals as defined in RFC 4511 4.1.10. Do not use security.ldap.servers for listing every LDAP server in your infrastructure.

This setting can be configured on a running mongod or mongos using setParameter.

If unset, mongod or mongos cannot use LDAP authentication or authorization.

security.ldap.bind.queryUser

Type: string

Available in MongoDB Enterprise only.

The identity with which mongod or mongos binds as, when connecting to or performing queries on an LDAP server.

Only required if any of the following are true:

• Using LDAP authorization.

• Using an LDAP query for security.ldap.userToDNMapping.

• The LDAP server disallows anonymous binds

You must use queryUser with queryPassword.

If unset, mongod or mongos will not attempt to bind to the LDAP server.

This setting can be configured on a running mongod or mongos using setParameter.

Note

Windows MongoDB deployments can use useOSDefaults instead of queryUser and queryPassword. You cannot specify both queryUser and useOSDefaults at the same time.

security.ldap.bind.queryPassword

Type: string or array

Available in MongoDB Enterprise only.

The password used to bind to an LDAP server when using queryUser. You must use queryPassword with queryUser.

If not set, mongod or mongos does not attempt to bind to the LDAP server.

You can configure this setting on a running mongod or mongos using setParameter.

Starting in MongoDB 4.4, the ldapQueryPassword setParameter command accepts either a string or an array of strings. If ldapQueryPassword is set to an array, MongoDB tries each password in order until one succeeds. Use a password array to roll over the LDAP account password without downtime.

Note

Windows MongoDB deployments can use useOSDefaults instead of queryUser and queryPassword. You cannot specify both queryPassword and useOSDefaults at the same time.

security.ldap.bind.useOSDefaults

Type: boolean

Default: false

Available in MongoDB Enterprise for the Windows platform only.

Allows mongod or mongos to authenticate, or bind, using your Windows login credentials when connecting to the LDAP server.

Only required if:

• Using LDAP authorization.

• Using an LDAP query for username transformation.

• The LDAP server disallows anonymous binds

Use useOSDefaults to replace queryUser and queryPassword.

security.ldap.bind.method

Type: string

Default: simple

Available in MongoDB Enterprise only.

The method mongod or mongos uses to authenticate to an LDAP server. Use with queryUser and queryPassword to connect to the LDAP server.

method supports the following values:

• simple - mongod or mongos uses simple authentication.

• sasl - mongod or mongos uses SASL protocol for authentication

If you specify sasl, you can configure the available SASL mechanisms using security.ldap.bind.saslMechanisms. mongod or mongos defaults to using DIGEST-MD5 mechanism.

security.ldap.bind.saslMechanisms

Type: string

Default: DIGEST-MD5

Available in MongoDB Enterprise only.

A comma-separated list of SASL mechanisms mongod or mongos can use when authenticating to the LDAP server. The mongod or mongos and the LDAP server must agree on at least one mechanism. The mongod or mongos dynamically loads any SASL mechanism libraries installed on the host machine at runtime.

Install and configure the appropriate libraries for the selected SASL mechanism(s) on both the mongod or mongos host and the remote LDAP server host. Your operating system may include certain SASL libraries by default. Defer to the documentation associated with each SASL mechanism for guidance on installation and configuration.

If using the GSSAPI SASL mechanism for use with Kerberos Authentication, verify the following for the mongod or mongos host machine:

Linux

• The KRB5_CLIENT_KTNAME environment variable resolves to the name of the client Linux Keytab Files for the host machine. For more on Kerberos environment variables, please defer to the Kerberos documentation.

• The client keytab includes a User Principal for the mongod or mongos to use when connecting to the LDAP server and execute LDAP queries.

Windows

If connecting to an Active Directory server, the Windows Kerberos configuration automatically generates a Ticket-Granting-Ticket when the user logs onto the system. Set useOSDefaults to true to allow mongod or mongos to use the generated credentials when connecting to the Active Directory server and execute queries.

Set method to sasl to use this option.

Note

For a complete list of SASL mechanisms see the IANA listing. Defer to the documentation for your LDAP or Active Directory service for identifying the SASL mechanisms compatible with the service.

MongoDB is not a source of SASL mechanism libraries, nor is the MongoDB documentation a definitive source for installing or configuring any given SASL mechanism. For documentation and support, defer to the SASL mechanism library vendor or owner.

For more information on SASL, defer to the following resources:

• For Linux, please see the Cyrus SASL documentation.

• For Windows, please see the Windows SASL documentation.

security.ldap.transportSecurity

Type: string

Default: tls

Available in MongoDB Enterprise only.

By default, mongod or mongos creates a TLS/SSL secured connection to the LDAP server.

For Linux deployments, you must configure the appropriate TLS Options in /etc/openldap/ldap.conf file. Your operating system's package manager creates this file as part of the MongoDB Enterprise installation, via the libldap dependency. See the documentation for TLS Options in the ldap.conf OpenLDAP documentation for more complete instructions.

For Windows deployment, you must add the LDAP server CA certificates to the Windows certificate management tool. The exact name and functionality of the tool may vary depending on operating system version. Please see the documentation for your version of Windows for more information on certificate management.

Set transportSecurity to none to disable TLS/SSL between mongod or mongos and the LDAP server.

Warning

Setting transportSecurity to none transmits plaintext information and possibly credentials between mongod or mongos and the LDAP server.

security.ldap.timeoutMS

Type: int

Default: 10000

Available in MongoDB Enterprise only.

The amount of time in milliseconds mongod or mongos should wait for an LDAP server to respond to a request.

Increasing the value of timeoutMS may prevent connection failure between the MongoDB server and the LDAP server, if the source of the failure is a connection timeout. Decreasing the value of timeoutMS reduces the time MongoDB waits for a response from the LDAP server.

This setting can be configured on a running mongod or mongos using setParameter.

security.ldap.retryCount

New in version 6.1.

Type: int

Default: 0

Available in MongoDB Enterprise only.

Number of operation retries by the server LDAP manager after a network error.

This setting can be configured on a running mongod or mongos using setParameter.

security.ldap.userToDNMapping

Type: string

Available in MongoDB Enterprise only.

Maps the username provided to mongod or mongos for authentication to a LDAP Distinguished Name (DN). You may need to use userToDNMapping to transform a username into an LDAP DN in the following scenarios:

• Performing LDAP authentication with simple LDAP binding, where users authenticate to MongoDB with usernames that are not full LDAP DNs.

• Using an LDAP authorization query template that requires a DN.

• Transforming the usernames of clients authenticating to Mongo DB using different authentication mechanisms (e.g. x.509, kerberos) to a full LDAP DN for authorization.

userToDNMapping expects a quote-enclosed JSON-string representing an ordered array of documents. Each document contains a regular expression match and either a substitution or ldapQuery template used for transforming the incoming username.

Each document in the array has the following form:

{
  match: "<regex>"
  substitution: "<LDAP DN>" | ldapQuery: "<LDAP Query>"
}

Field	Description	Example
match	An ECMAScript-formatted regular expression (regex) to match against a provided username. Each parenthesis-enclosed section represents a regex capture group used by substitution or ldapQuery.	"(.+)ENGINEERING" "(.+)DBA"
substitution	An LDAP distinguished name (DN) formatting template that converts the authentication name matched by the match regex into a LDAP DN. Each curly bracket-enclosed numeric value is replaced by the corresponding regex capture group extracted from the authentication username via the match regex. The result of the substitution must be an RFC4514 escaped string.	"cn={0},ou=engineering, dc=example,dc=com"
ldapQuery	A LDAP query formatting template that inserts the authentication name matched by the match regex into an LDAP query URI encoded respecting RFC4515 and RFC4516. Each curly bracket-enclosed numeric value is replaced by the corresponding regex capture group extracted from the authentication username via the match expression. mongod or mongos executes the query against the LDAP server to retrieve the LDAP DN for the authenticated user. mongod or mongos requires exactly one returned result for the transformation to be successful, or mongod or mongos skips this transformation.	"ou=engineering,dc=example, dc=com??one?(user={0})"

Note

An explanation of RFC4514, RFC4515, RFC4516, or LDAP queries is out of scope for the MongoDB Documentation. Please review the RFC directly or use your preferred LDAP resource.

For each document in the array, you must use either substitution or ldapQuery. You cannot specify both in the same document.

When performing authentication or authorization, mongod or mongos steps through each document in the array in the given order, checking the authentication username against the match filter. If a match is found, mongod or mongos applies the transformation and uses the output for authenticating the user. mongod or mongos does not check the remaining documents in the array.

If the given document does not match the provided authentication name, mongod or mongos continues through the list of documents to find additional matches. If no matches are found in any document, or the transformation the document describes fails, mongod or mongos returns an error.

Starting in MongoDB 4.4, mongod or mongos also returns an error if one of the transformations cannot be evaluated due to networking or authentication failures to the LDAP server. mongod or mongos rejects the connection request and does not check the remaining documents in the array.

Starting in MongoDB 5.0, userToDNMapping accepts an empty string "" or empty array [ ] in place of a mapping documnent. If providing an empty string or empty array to userToDNMapping, MongoDB will map the authenticated username as the LDAP DN. Previously, providing an empty mapping document would cause mapping to fail.

Example

The following shows two transformation documents. The first document matches against any string ending in @ENGINEERING, placing anything preceeding the suffix into a regex capture group. The second document matches against any string ending in @DBA, placing anything preceeding the suffix into a regex capture group.

Important

You must pass the array to userToDNMapping as a string.

"[
   {
      match: "(.+)@ENGINEERING.EXAMPLE.COM",
      substitution: "cn={0},ou=engineering,dc=example,dc=com"
   },
   {
      match: "(.+)@DBA.EXAMPLE.COM",
      ldapQuery: "ou=dba,dc=example,dc=com??one?(user={0})"
   }
]"

A user with username alice@ENGINEERING.EXAMPLE.COM matches the first document. The regex capture group {0} corresponds to the string alice. The resulting output is the DN "cn=alice,ou=engineering,dc=example,dc=com".

A user with username bob@DBA.EXAMPLE.COM matches the second document. The regex capture group {0} corresponds to the string bob. The resulting output is the LDAP query "ou=dba,dc=example,dc=com??one?(user=bob)". mongod or mongos executes this query against the LDAP server, returning the result "cn=bob,ou=dba,dc=example,dc=com".

If userToDNMapping is unset, mongod or mongos applies no transformations to the username when attempting to authenticate or authorize a user against the LDAP server.

This setting can be configured on a running mongod or mongos using the setParameter database command.

security.ldap.authz.queryTemplate

Type: string

Available in MongoDB Enterprise only.

A relative LDAP query URL formatted conforming to RFC4515 and RFC4516 that mongod executes to obtain the LDAP groups to which the authenticated user belongs to. The query is relative to the host or hosts specified in security.ldap.servers.

In the URL, you can use the following substitution tokens:

Substitution Token	Description
{USER}	Substitutes the authenticated username, or the transformed username if a userToDNMapping is specified.
{PROVIDED_USER}	Substitutes the supplied username, i.e. before either authentication or LDAP transformation. New in version 4.2.

When constructing the query URL, ensure that the order of LDAP parameters respects RFC4516:

[ dn  [ ? [attributes] [ ? [scope] [ ? [filter] [ ? [Extensions] ] ] ] ] ]

If your query includes an attribute, mongod assumes that the query retrieves a list of the DNs which this entity is a member of.

If your query does not include an attribute, mongod assumes the query retrieves all entities which the user is member of.

For each LDAP DN returned by the query, mongod assigns the authorized user a corresponding role on the admin database. If a role on the on the admin database exactly matches the DN, mongod grants the user the roles and privileges assigned to that role. See the db.createRole() method for more information on creating roles.

Example

This LDAP query returns any groups listed in the LDAP user object's memberOf attribute.

"{USER}?memberOf?base"

Your LDAP configuration may not include the memberOf attribute as part of the user schema, may possess a different attribute for reporting group membership, or may not track group membership through attributes. Configure your query with respect to your own unique LDAP configuration.

If unset, mongod cannot authorize users using LDAP.

This setting can be configured on a running mongod using the setParameter database command.

Note

An explanation of RFC4515, RFC4516 or LDAP queries is out of scope for the MongoDB Documentation. Please review the RFC directly or use your preferred LDAP resource.

security.ldap.validateLDAPServerConfig

Type: boolean

Default: true

Available in MongoDB Enterprise

A flag that determines if the mongod or mongos instance checks the availability of the LDAP server(s) as part of its startup:

• If true, the mongod or mongos instance performs the availability check and only continues to start up if the LDAP server is available.

• If false, the mongod or mongos instance skips the availability check; i.e. the instance starts up even if the LDAP server is unavailable.

LDAP Parameters

setParameter.ldapUserCacheInvalidationInterval

Type: int

Default: 30

For use with mongod servers using LDAP Authorization.

The interval (in seconds) mongod waits between external user cache flushes. After mongod flushes the external user cache, MongoDB reacquires authorization data from the LDAP server the next time an LDAP-authorized user issues an operation.

Increasing the value specified increases the amount of time mongod and the LDAP server can be out of sync, but reduces the load on the LDAP server. Conversely, decreasing the value specified decreases the time mongod and the LDAP server can be out of sync while increasing the load on the LDAP server.

setParameter:
   ldapUserCacheInvalidationInterval: <int>