Authentication Mechanisms身份验证机制

DEFAULT

The DEFAULT authentication mechanism is a fallback setting that instructs the driver to negotiate the first authentication mechanism supported by the server in the following order of preference:DEFAULT身份验证机制是一种回退设置，指示驱动程序按照以下首选顺序协商服务器支持的第一个身份验证机制：

1. SCRAM-SHA-256
2. SCRAM-SHA-1
3. MONGODB-CR

If the DEFAULT option is specified, the driver first attempts to authenticate using SCRAM-SHA-256. 如果指定了DEFAULT选项，则驱动程序首先尝试使用SCRAM-SHA-256进行身份验证。If the version of the MongoDB instance does not support that mechanism, the driver attempts to authenticate using SCRAM-SHA-1. 如果MongoDB实例的版本不支持该机制，则驱动程序会尝试使用SCRAM-SHA-1进行身份验证。If the instance does not support that mechanism either, the driver attempts to authenticate using MONGODB-CR.如果实例也不支持该机制，则驱动程序会尝试使用MONGODB-CR进行身份验证。

You can specify this authentication mechanism by setting the authMechanism parameter to DEFAULT in the connection string, or by omitting the parameter since it is the default value. 您可以通过在连接字符串中将authMechanism参数设置为DEFAULT来指定此身份验证机制，或者由于该参数是默认值而省略该参数。Also include your username and password as shown in the code below.还包括您的用户名和密码，如下面的代码所示。

const { MongoClient } = require("mongodb");

// Replace the following with values for your environment.将以下内容替换为适用于您的环境的值。
const username = encodeURIComponent("<username>");
const password = encodeURIComponent("<password>");
const clusterUrl = "<MongoDB cluster url>";

const authMechanism = "DEFAULT";

// Replace the following with your MongoDB deployment's connection string.将以下内容替换为MongoDB部署的连接字符串。
const uri =
  `mongodb+srv://${username}:${password}@${clusterUrl}/?authMechanism=${authMechanism}`;

// Create a new MongoClient创建一个新的MongoClient
const client = new MongoClient(uri);

// Function to connect to the server用于连接到服务器的函数
async function run() {
  try {
    // Establish and verify connection建立并验证连接
    await client.db("admin").command({ ping: 1 });
    console.log("Connected successfully to server");
  } finally {
    // Ensures that the client will close when you finish/error确保客户端在您完成/出错时关闭
    await client.close();
  }
}
run().catch(console.dir);

For more information on the challenge-response (CR) and salted challenge-response authentication mechanisms (SCRAM) that MongoDB supports, see the SCRAM section of the manual.有关MongoDB支持的质询-响应（CR）和盐水质询-响应身份验证机制（SCRAM）的更多信息，请参阅手册的SCRAM部分。

SCRAM-SHA-256

SCRAM-SHA-256 is a salted challenge-response authentication mechanism (SCRAM) that uses your username and password, encrypted with the SHA-256 algorithm to authenticate your user.是一种咸挑战响应身份验证机制（SCRAM），它使用您的用户名和密码，并使用SHA-256算法加密以验证您的用户。

You can specify this authentication mechanism by setting the authMechanism to the value SCRAM-SHA-256 in the connection string as shown in the following sample code.您可以通过在连接字符串中将authMechanism设置为值SCRAM-SHA-256来指定此身份验证机制，如以下示例代码所示。

const { MongoClient } = require("mongodb");

// Replace the following with values for your environment.将以下内容替换为适用于您的环境的值。
const username = encodeURIComponent("<username>");
const password = encodeURIComponent("<password>");
const clusterUrl = "<MongoDB cluster url>";

const authMechanism = "SCRAM-SHA-256";

// Replace the following with your MongoDB deployment's connection string.将以下内容替换为MongoDB部署的连接字符串。
const uri =
  `mongodb+srv://${username}:${password}@${clusterUrl}/?authMechanism=${authMechanism}`;

// Create a new MongoClient创建一个新的MongoClient
const client = new MongoClient(uri);

// Function to connect to the server用于连接到服务器的函数
async function run() {
  try {
    // Establish and verify connection建立并验证连接
    await client.db("admin").command({ ping: 1 });
    console.log("Connected successfully to server");
  } finally {
    // Ensures that the client will close when you finish/error确保客户端在您完成/出错时关闭
    await client.close();
  }
}
run().catch(console.dir);

SCRAM-SHA-1

SCRAM-SHA-1 is a salted challenge-response mechanism (SCRAM) that uses your username and password, encrypted with the SHA-1 algorithm to authenticate your user.是一种盐水挑战响应机制（SCRAM），使用您的用户名和密码，使用SHA-1算法加密以验证您的用户。

You can specify this authentication mechanism by setting the authMechanism parameter to the value SCRAM-SHA-1 in the connection string as shown in the following sample code.您可以通过将authMechanism参数设置为连接字符串中的值SCRAM-SHA-1来指定此身份验证机制，如以下示例代码所示。

const { MongoClient } = require("mongodb");

// Replace the following with values for your environment.将以下内容替换为适用于您的环境的值。
const username = encodeURIComponent("<username>");
const password = encodeURIComponent("<password>");
const clusterUrl = "<MongoDB cluster url>";

const authMechanism = "SCRAM-SHA-1";

// Replace the following with your MongoDB deployment's connection string.将以下内容替换为MongoDB部署的连接字符串。
const uri =
  `mongodb+srv://${username}:${password}@${clusterUrl}/?authMechanism=${authMechanism}`;

// Create a new MongoClient创建一个新的MongoClient
const client = new MongoClient(uri);

// Function to connect to the server用于连接到服务器的函数
async function run() {
  try {
    // Establish and verify connection建立并验证连接
    await client.db("admin").command({ ping: 1 });
    console.log("Connected successfully to server");
  } finally {
    // Ensures that the client will close when you finish/error确保客户端在您完成/出错时关闭
    await client.close();
  }
}
run().catch(console.dir);

MONGODB-CR

MONGODB-CR is a challenge-response authentication mechanism that uses your username and password to authenticate your user.是一种质询-响应身份验证机制，使用您的用户名和密码对用户进行身份验证。

You can specify this option by setting the authMechanism parameter to value MONGODB-CR in the connection string as shown in the following sample code.您可以通过在连接字符串中将authMechanism参数设置为值MONGODB-CR来指定此选项，如以下示例代码所示。

const { MongoClient } = require("mongodb");

// Replace the following with values for your environment.将以下内容替换为适用于您的环境的值。
const username = encodeURIComponent("<username>");
const password = encodeURIComponent("<password>");
const clusterUrl = "<MongoDB cluster url>";

// Replace the following with your MongoDB deployment's connection string.将以下内容替换为MongoDB部署的连接字符串。
const uri =
  `mongodb+srv://${username}:${password}@${clusterUrl}/?authMechanism=${authMechanism}&tls=true&tlsCertificateKeyFile=${clientPEMFile}`;

// Create a new MongoClient创建一个新的MongoClient
const client = new MongoClient(uri);

// Function to connect to the server用于连接到服务器的函数
async function run() {
  try {
    // Establish and verify connection建立并验证连接
    await client.db("admin").command({ ping: 1 });
    console.log("Connected successfully to server");
  } finally {
    // Ensures that the client will close when you finish/error确保客户端在您完成/出错时关闭
    await client.close();
  }
}
run().catch(console.dir);

MONGODB-AWS

The MONGODB-AWS authentication mechanism uses your Amazon Web Services Identity and Access Management (AWS IAM) credentials to authenticate your user. MONGODB-AWS身份验证机制使用您的亚马逊网络服务身份和访问管理（AWS IAM）凭据来验证您的用户。If you do not already have the AWS signature library, use the following npm command to install it:如果您还没有AWS签名库，请使用以下npm命令进行安装：

npm install aws4

To connect to a MongoDB instance with MONGODB-AWS authentication enabled, specify the MONGODB-AWS authentication mechanism.要连接到启用MongoDB-AWS身份验证的MongoDB实例，请指定MongoDB-AWS身份验证机制。

The driver checks for your credentials in the following sources in order:驱动程序按顺序在以下来源中检查您的凭据：

1. Connection string连接字符串
2. Environment variables环境变量
3. Web identity token fileWeb标识令牌文件
4. AWS ECS endpoint specified in AWS_CONTAINER_CREDENTIALS_RELATIVE_URI中指定的AWS ECS端点
5. AWS EC2 endpoint. For more information, see IAM Roles for Tasks.AWS EC2终点。有关更多信息，请参阅IAM任务角色。

X.509

The X.509 authentication mechanism uses TLS with X.509 certificates to authenticate by retrieving the distinguished name (DN) from the client certificate.X.509身份验证机制通过从客户端证书中检索可分辨名称（DN），使用带有X.509证书的TLS进行身份验证。

You can specify this authentication mechanism by setting the following parameters of your connection string:您可以通过设置连接字符串的以下参数来指定此身份验证机制：

• Set the authMechanism parameter to MONGODB-X509将authMechanism参数设置为MONGODB-X509
• Set the tls parameter to true将tls参数设置为true

Pass the location of your client certificate file as the value of tlsCertificateKeyFile as a parameter of the connection URI.将客户端证书文件的位置作为tlsCertificateKeyFile的值作为连接URI的参数传递。

const { MongoClient } = require("mongodb");

// Replace the following with values for your environment.将以下内容替换为适用于您的环境的值。
const clusterUrl = "<MongoDB cluster url>";
const clientPEMFile = encodeURIComponent("<path to the client pem certificate file>");

const authMechanism = "MONGODB-X509";

// Replace the following with your MongoDB deployment's connection string.将以下内容替换为MongoDB部署的连接字符串。
const uri =
  `mongodb+srv://${clusterUrl}/?authMechanism=${authMechanism}&tls=true&tlsCertificateKeyFile=${clientPEMFile}`;

// Create a new MongoClient创建一个新的MongoClient
const client = new MongoClient(uri);

// Function to connect to the server用于连接到服务器的函数
async function run() {
  try {
    // Establish and verify connection建立并验证连接
    await client.db("admin").command({ ping: 1 });
    console.log("Connected successfully to server");
  } finally {
    // Ensures that the client will close when you finish/error确保客户端在您完成/出错时关闭
    await client.close();
  }
}
run().catch(console.dir);