認証メカニズム

Overview

このガイドでは、 Cドライバーで使用してMongoDB .にユーザーを認証するメカニズムについて説明します。

SCRAM-SHA-256

SCRAM-SHA-256 （ RFC7677 で定義） は、 MongoDB v を実行している MongoDB 配置のデフォルトの認証メカニズムです。40以降に更新します。

SCRAM-SHA-256 を使用して認証するには、次の接続オプションを設定します。

• username: 認証するユーザー名。 接続 URI に含める前に、この値をパーセント エンコードします。

• password: 認証するパスワード。 接続 URI に含める前に、この値をパーセント エンコードします。

• authSource: 認証するMongoDBデータベース 。 デフォルトでは 、 Cドライバーは接続 URI に データベースを含めている場合、データベースに対して認証します。 認証データベースを指定しない場合、adminデータベースに対して認証が行われます。

• authMechanism: SCRAM-SHA-256に設定します。

次のコード例に示すように、接続文字列のパラメーターを使用してこれらのオプションを設定できます。

const char *uri = "mongodb://<percent-encoded username>:<percent-encoded password>@<hostname>:<port>/?authMechanism=SCRAM-SHA-256&authSource=<authentication database>";
mongoc_client_t *client = mongoc_client_new(uri);

SCRAM-SHA-1

SCRAM-SHA-1 （ RFC5802 で定義） は、 MongoDB v を実行している MongoDB 配置のデフォルトの認証メカニズムです。 。36

このメカニズムで認証するには、次の接続オプションを設定します。

• username: 認証するユーザー名。 接続 URI に含める前に、この値をパーセント エンコードします。

• password: 認証するパスワード。 接続 URI に含める前に、この値をパーセント エンコードします。

• authSource: 認証するMongoDBデータベース 。 デフォルトでは 、 Cドライバーは adminデータベースに対して認証します。

• authMechanism: "SCRAM-SHA-1"に設定します。

次のコード例に示すように、接続文字列のパラメーターを使用してこれらのオプションを設定できます。

const char *uri = "mongodb://<percent-encoded username>:<percent-encoded password>@<hostname>:<port>/?authMechanism=SCRAM-SHA-1&authSource=<authentication database>";
mongoc_client_t *client = mongoc_client_new(uri);

MONGODB-X509

TLS サポートでCドライバーをコンパイルすると、 Cドライバーは TLS ハンドシェイク中に ID を証明するために、X.509クライアント証明書をMongoDBに提示できます。 MONGODB-X509認証メカニズムは、この証明書を使用してクライアントを認証します。

このメカニズムで認証するには、次の手順を実行します。

1. mongoc_ssl_opt_t 構造を作成します。 この構造で、pem_fileフィールドを、クライアント証明書と秘密キー を含む .pemファイルのファイルパスに設定します。

2. 接続 URI で、authMechanism 接続オプションを "MONGODB-X509" に設定します。

次のコード例は、 MONGODB-X509 メカニズムを使用して認証するMongoDBクライアントを作成する方法を示しています。

mongoc_client_t *client;
mongoc_ssl_opt_t ssl_opts = {0};
ssl_opts.pem_file = "mycert.pem";
const char *uri = "mongodb://<percent-encoded username>@<hostname>:<port>/?authMechanism=MONGODB-X509";
mongoc_client_t *client = mongoc_client_new(uri);
mongoc_client_set_ssl_opts(client, &ssl_opts);

MongoDB-AWS

MONGODB-AWS認証メカニズムは、 Amazon Web Services IAM（Amazon Web Services Identity and Access Management、 Amazon Web Services Lambda の認証情報）を使用してアプリケーションを認証します。 このメカニズムを使用してアプリケーション を認証するには、まず $externalデータベースで関連付けられたAmazonリソース名（ARN） を持つユーザーを作成します。 次に、接続 URI で MONGODB-AWS authMechanism を指定します。

MONGODB-AWS メカニズムを使用すると、 Cドライバーは次のソースからAmazon Web Services の認証情報を登録されている順序で検索しようとします。

1. 接続 URI に渡される名前付きパラメータ

2. 環境変数

3. Amazon Web Services EKS AssumeRoleWithWebIdentityリクエスト

4. ECSコンテナのメタデータ

5. EC 2インスタンスのメタデータ

次のセクションでは、 Cドライバーを使用してこれらのソースから認証情報を取得し、その情報を使用してアプリケーション を認証する方法について説明します。

const char *uri = "mongodb://<AWS IAM access key ID>:<AWS IAM secret access key>@<hostname>:<port>/?authMechanism=MONGODB-AWS");
mongoc_client_t *client = mongoc_client_new(uri);

const char *uri = "mongodb://<AWS IAM access key ID>:<AWS IAM secret access key>@<hostname>:<port>/?authMechanism=MONGODB-AWS&authMechanismProperties=AWS_SESSION_TOKEN:<token>");
mongoc_client_t *client = mongoc_client_new(uri);

export AWS_ACCESS_KEY_ID=<AWS IAM access key ID>
export AWS_SECRET_ACCESS_KEY=<AWS IAM secret access key>
export AWS_SESSION_TOKEN=<AWS session token>

const char *uri = "mongodb://<hostname>:<port>/?authMechanism=MONGODB-AWS");
mongoc_client_t *client = mongoc_client_new(uri);

export AWS_CONTAINER_CREDENTIALS_RELATIVE_URI=<URI of the ECS endpoint>

const char *uri = "mongodb://<hostname>:<port>/?authMechanism=MONGODB-AWS");
mongoc_client_t *client = mongoc_client_new(uri);

const char *uri = "mongodb://<hostname>:<port>/?authMechanism=MONGODB-AWS");
mongoc_client_t *client = mongoc_client_new(uri);

API ドキュメント

Cドライバーでアプリケーションを認証する方法の詳細については、次のAPIドキュメントを参照してください。

• mongoc_client_t

• mongoc_uri_t