Survey

Please help us improve by answering a few questions at our user survey.

TLS/SSL

The Node.js driver supports TLS/SSL connections to MongoDB that support TLS/SSL support.

No Certificate Validation

If the MongoDB instance does not perform any validation of the certificate chain, include the ssl=true in the URI Connection String .

const MongoClient = require('mongodb').MongoClient;

const client = new MongoClient('mongodb://localhost:27017?ssl=true');

client.connect(function(err) {
  client.close();
});

Validate Server Certificate

If the MongoDB instance presents a certificate, to validate the server’s certificate, pass the following when creating a MongoClient:

  • A URI Connection String that includes ssl=true setting,

  • A connections options with the certificate for the Certificate Authority (sslCA) and the sslValidate setting set to true

const MongoClient = require('mongodb').MongoClient;
const fs = require('fs');

// Read the certificate authority
const ca = [fs.readFileSync(__dirname + "/ssl/ca.pem")];

const client = new MongoClient('mongodb://localhost:27017?ssl=true', {
  sslValidate:true,
  sslCA:ca
});

// Connect validating the returned certificates from the server
client.connect(function(err) {
  client.close();
});

Disable Hostname Verification

By default, the driver ensures that the hostname included in the server’s SSL certificate(s) matches the hostname(s) provided in the URI connection string. If you need to disable the hostname verification, but otherwise validate the server’s certificate, pass to the new MongoClient:

  • A URI Connection String that includes ssl=true setting,

  • A connections options with the certificate for the Certificate Authority (sslCA) and the sslValidate setting set to true but checkServerIdentity set to false.

const MongoClient = require('mongodb').MongoClient;
const fs = require('fs');

// Read the certificate authority
const ca = [fs.readFileSync(__dirname + "/ssl/ca.pem")];

const client = new MongoClient('mongodb://localhost:27017?ssl=true', {
  sslValidate:true,
  checkServerIdentity:false,
  sslCA:ca
});

// Connect validating the returned certificates from the server
client.connect(function(err) {
  client.close();
});

Validate Server Certificate and Present Valid Certificate

If the MongoDB server performs certificate validation, the client must pass its certificate to the server. To pass the client’s certificate as well as to validate the server’s certificate, pass to the new MongoClient:

  • A URI Connection String that includes ssl=true setting,

  • A connections options with the sslValidate setting set to true, the certificate for the Certificate Authority (sslCA), the client’s certificate (sslCert) and private key file (sslKey). If the client’s key file is encrypted, include the password (sslPass).

const MongoClient = require('mongodb').MongoClient;
const fs = require('fs');

// Read the certificates
const ca = [fs.readFileSync(__dirname + "/ssl/ca.pem")];
const cert = fs.readFileSync(__dirname + "/ssl/client.pem");
const key = fs.readFileSync(__dirname + "/ssl/client.pem");

const client = new MongoClient('mongodb://localhost:27017?ssl=true', {
  sslValidate:true,
  sslCA:ca,
  sslKey:key,
  sslCert:cert,
  sslPass:'10gen',
});

// Connect validating the returned certificates from the server
client.connect(function(err) {
  client.close();
});

Connect with X.509

X.509 authentication requires the use of TLS/SSL connections with certificate validation. MongoDB uses the X.509 certificate presented during SSL negotiation to authenticate a user whose name is derived from the distinguished name of the X.509 certificate.

To connect using the X.509 authentication mechanism, specify MONGODB-X509 as the mechanism in the URI connection string, ssl=true, and the username. Use enodeURIComponent to encode the username string.

In addition to the connection string, pass to the new MongoClient a connections options with the X.509 certificate and other TLS/SSL connections options.

const MongoClient = require('mongodb').MongoClient;
const fs = require('fs');

// Read the cert and key
const cert = fs.readFileSync(__dirname + "/ssl/x509/client.pem");
const key = fs.readFileSync(__dirname + "/ssl/x509/client.pem");

// User name
const userName = "CN=client,OU=kerneluser,O=10Gen,L=New York City,ST=New York,C=US";

const client = new MongoClient(`mongodb://${encodeURIComponent(userName)}@server:27017?authMechanism=MONGODB-X509&ssl=true`, {
  sslKey:key,
  sslCert:cert,
});

// Connect using the MONGODB-X509 authentication mechanism
client.connect(function(err) {
  client.close();
});

TLS/SSL Options

The following TLS/SSL options are available.

Parameter Type Description
ssl {Boolean, default: false} Use ssl connection
sslValidate {Boolean, default: true} Validate server certificate against certificate authority.
sslCA {Buffer[]|string[], default: null} Array of valid certificates for Certificate Authority either as Buffers or Strings.
sslCRL {Buffer[]|string[], default: null} Array of revocation certificates as Buffers or Strings.
sslCert {Buffer|string, default: null} String or buffer containing the client certificate.
sslPass {Buffer|string, default: null} String or buffer containing the client certificate password.

To connect to a single MongoDB instance, specify the TLS/SSL connection options.

const MongoClient = require('mongodb').MongoClient;
const fs = require('fs');

// Read the certificates
const ca = [fs.readFileSync(__dirname + "/ssl/ca.pem")];
const cert = fs.readFileSync(__dirname + "/ssl/client.pem");
const key = fs.readFileSync(__dirname + "/ssl/client.pem");

const client = new MongoClient('mongodb://server:27017?ssl=true', {
  sslCA:ca,
  sslKey:key,
  sslCert:cert,
});

client.connect(function(err) {
  client.close();
});

To connect to a replica set, specify the TLS/SSL connection options.

const MongoClient = require('mongodb').MongoClient;
const fs = require('fs');

// Read the certificates
const ca = [fs.readFileSync(__dirname + "/ssl/ca.pem")];
const cert = fs.readFileSync(__dirname + "/ssl/client.pem");
const key = fs.readFileSync(__dirname + "/ssl/client.pem");

const client = new MongoClient('mongodb://server:27017?replicaSet=foo&ssl=true', {
  sslCA:ca,
  sslKey:key,
  sslCert:cert,
});

client.connect(function(err) {
  client.close();
});

To connect to a mongos we pass in the options at the top level, just as for replicasets and single server connections.

const MongoClient = require('mongodb').MongoClient;
const fs = require('fs');

// Read the certificates
const ca = [fs.readFileSync(__dirname + "/ssl/ca.pem")];
const cert = fs.readFileSync(__dirname + "/ssl/client.pem");
const key = fs.readFileSync(__dirname + "/ssl/client.pem");

const client = new MongoClient('mongodb://server:27017?ssl=true', {
  sslCA:ca,
  sslKey:key,
  sslCert:cert,
});

client.connect(function(err) {
  client.close();
});