接続での TLS の有効化

Overview

このガイドでは、TLS セキュリティ プロトコルを使用して MongoDB インスタンスに接続する方法を学習できます。

TLS を使用するように接続を構成するには、TLS オプションを有効にし、検証用の証明書を提供します。

TLS の有効化

MongoDB インスタンスへの接続で TLS を有効にするには、次の方法があります。

• MongoClientOptionsオブジェクトで tlsオプションをtrueに設定する

• 接続stringで tls オプションを true に設定する

const client = new MongoClient(uri, { tls: true });

const uri = "mongodb://<hostname>:<port>?tls=true";
const client = new MongoClient(uri, myClientSettings);

tlsクライアント オプションに加えて、ドライバーには接続で TLS を構成するための追加オプションが用意されています。 テスト目的では、 tlsAllowInvalidHostnames 、 tlsAllowInvalidCertificates 、 tlsInsecureクライアント オプションを設定できます。

tlsAllowInvalidHostnamesオプションをtrueに設定するとホスト名検証が無効になり、 tlsAllowInvalidCertificatesをtrueに設定すると証明書の検証が無効になります。 tlsInsecureオプションをtrueに設定すると、証明書とホスト名の両方の検証が無効になります。

クライアント オプションの完全なリストについては、「 接続オプション 」を参照してください。

証明書の構成

TLS 要求を正常に開始するには、アプリケーションが暗号化証明書を参照して ID を証明する必要があります。 TLS を使用して MongoDB に接続するには、証明書を PEM ファイルとして保存する必要があります。

次のリストでは、TLS との接続を確立するために必要なコンポーネントについて説明します。

クライアントでの証明書の参照

クライアントが接続する前にサーバーが証明書を検証できるように、 MongoClientOptionsオブジェクトで証明書を参照する必要があります。 証明書は、次の方法で参照できます。

• 証明書を保存するためのSecureContextオブジェクトの作成（推奨）

• 証明書を指すファイルパス文字列を指定する

• 証明書を保存するためのBufferオブジェクトの作成

// Create a SecureContext object
const secureContext = tls.createSecureContext({
  ca: fs.readFileSync(`<path to CA certificate>`),
  cert: fs.readFileSync(`<path to public client certificate>`),
  key: fs.readFileSync(`<path to private client key>`),
});
// Pass the SecureContext as a client option
const client = new MongoClient(uri, { tls: true, secureContext });

// Pass filepaths as client options
const client = new MongoClient(uri, {
  tls: true,
  tlsCAFile: `<path to CA certificate>`,
  tlsCertificateFile: `<path to public client certificate>`,
  tlsCertificateKeyFile: `<path to private client key>`,
});

// Read file contents
const ca = fs.readFileSync(`<path to CA certificate>`);
const cert = fs.readFileSync(`<path to public client certificate>`);
const key = fs.readFileSync(`<path to private client key>`);
// Pass Buffers as client options
const client = new MongoClient(uri, { tls: true, ca, cert, key });

SecureContext の例

この例では、 SecureContextオブジェクトと TLS オプションを含むMongoClientインスタンスを作成する方法を示します。 この例では MongoDB に接続し、検索クエリを実行します。

import { MongoClient } from "mongodb";
import * as fs from "fs";
import * as tls from "tls";
// Replace the uri string with your connection string.
const uri = "<connection uri>";
// Replace the filepaths with your certificate filepaths.
const secureContext = tls.createSecureContext({
  ca: fs.readFileSync(`<path to CA certificate>`),
  cert: fs.readFileSync(`<path to public client certificate>`),
  key: fs.readFileSync(`<path to private client key>`),
});
// Create a client with the secureContext option
const client = new MongoClient(uri, { tls: true, secureContext });
async function run() {
  try {
    const db = client.db("myDB");
    const myColl = db.collection("myColl");
    const doc = await myColl.findOne({});
    console.log(doc);
  } finally {
    await client.close();
  }
}
run().catch(console.dir);

詳細情報

接続で TLS を有効にする方法の詳細については、次のサーバー マニュアル ドキュメントを参照してください。

• TLS/SSL (トランスポート暗号化)

• クライアントの TLS/SSL 設定