使用中の暗号化

Queryable Encryption

Queryable Encryption (QE) は、使用中の暗号化機能で、暗号化されたフィールド値に対して、等価、範囲、プレフィックス、サフィックス、および部分文字列のクエリを実行できます。範囲クエリのサポートにはMongoDB Server 8.0 以降が必要です。プレフィックス、サフィックス、および部分文字列クエリのサポートにはMongoDB Server 9.0 以降が必要です。

Queryable Encryptionの詳細については、 MongoDB Serverマニュアルの「 Queryable Encryption 」を参照してください。

クライアントサイドのフィールド レベル暗号化

クライアント側フィールド レベル暗号化（ CSFLE ）はMongoDB Serverバージョン 4.2 で導入され、暗号化されたフィールドの等価検索をサポートしています。 CSFLE は、フィールドを暗号化するために決定的またはランダムな暗号化アルゴリズムのいずれかを選択できる点で Queryable Encryption と異なります。 CSFLE を使用している場合は、決定的な暗号化アルゴリズムを使用する暗号化されたフィールドのみをクエリできます。 CSFLE のフィールドを暗号化するためにランダムな暗号化アルゴリズムを使用する場合、それらは復号化することはできますが、それらのフィールドに対して等価クエリを実行することはできません。 Queryable Encryption を使用する場合、暗号化アルゴリズムを指定することはできませんが、すべての暗号化されたフィールドをクエリできます。

値を確定的に暗号化すると、同じ入力値によって同じ出力値が生成されます。 決定的な暗号化を使用すると、暗号化されたフィールドに対してクエリを実行できますが、濃度の低い暗号化データは、頻度分析によるコードの影響を受けやすくなります。

CSFLEの詳細については、サーバー マニュアルの「CSFLE」を参照してください。

集計パイプラインのサポート

MongoDB Server 8.1 以降では、 使用中の暗号化用に構成されたクライアントで $lookup集計ステージを使用できます。この機能には、mongodb-client-encryptionパッケージバージョン 6.3.0 以降が必要です。

$lookup ステージでは、アプリケーションコードでドキュメントを手動で取得して結合する必要なく、暗号化されたコレクション全体の関連データを結合できます。使用中の暗号化には、ソースコレクションと fromコレクションの両方を構成する必要があります。localField と foreignField で指定されるフィールドは暗号化されたフィールドであってはなりません。

次の例では、暗号化されたコレクションに対する $lookup操作を示しています。

const pipeline = [
  {
    $lookup: {
      from: "encryptedCollection",
      localField: "userId",
      foreignField: "_id",
      as: "userDetails"
    }
  }
];
const results = await collection.aggregate(pipeline).toArray();

HTTPプロキシを介して KMS リクエストをルーティング

Starting in Node.js driver version 7.6, you can route the requests that the Node.js driver makes to your key management system (KMS) through an HTTP proxy. Use this feature when your environment requires outbound KMS traffic to pass through an HTTP forward proxy. The proxyOptions setting supports only the SOCKS5 protocol and doesn't cover this case.

ドライバーが KMS ホストに接続する方法を制御するには、 ClientEncryptionOptionsオブジェクトまたは AutoEncryptionOptionsオブジェクトに kmsConnectCallback オプションを設定します。このオプションを設定すると、ドライバーは KMS ホスト自体に接続する代わりにコールバックを呼び出します。コールバックは、次のプロパティを受け取ります。

次の例では、プロキシにHTTP CONNECTリクエストを送信して KMS ホストへのトンネルを開き、そのコールバックを ClientEncryptionインスタンスに渡すコールバックを定義します。

import * as net from "net";
const kmsConnectCallback = ({ host, port, timeoutMS, signal }) =>
  new Promise((resolve, reject) => {
    // Opens a plain connection to the proxy, not to the KMS host.
    // Passing signal lets Node abort the connection attempt when the
    // driver's timeout budget expires.
    const socket = net.connect({
      host: "proxy.example.com",
      port: 8080,
      signal
    });
    // Applies the remaining CSOT budget to the proxy handshake, so that
    // a proxy that accepts the connection but never answers CONNECT
    // can't stall the operation.
    if (timeoutMS !== undefined) {
      socket.setTimeout(timeoutMS, () => {
        socket.destroy();
        reject(new Error("Timed out waiting for the proxy"));
      });
    }
    socket.once("error", reject);
    socket.once("connect", () => {
      // Asks the proxy to tunnel to the KMS host
      socket.write(
        `CONNECT ${host}:${port} HTTP/1.1\r\n` +
          `Host: ${host}:${port}\r\n\r\n`
      );
      socket.once("data", chunk => {
        if (chunk.toString("utf8").startsWith("HTTP/1.1 200")) {
          // Clears the handshake timeout and returns the socket so that
          // the driver can perform the TLS handshake
          socket.setTimeout(0);
          resolve(socket);
        } else {
          socket.destroy();
          reject(new Error("Proxy refused the CONNECT request"));
        }
      });
    });
  });
const clientEncryption = new ClientEncryption(keyVaultClient, {
  keyVaultNamespace,
  kmsProviders,
  kmsConnectCallback
});

signalプロパティはプロキシへの接続に適用され、timeoutMSプロパティはCONNECT 交換に適用されます。 CONNECT の交換が終了した後もソケット タイムアウトはアクティブのままになるため、Promise を解決する前にタイムアウトをクリアしてください。そうしないと、ドライバーが TLS ハンドシェイクを実行しているときにタイムアウトによってソケットが破棄される可能性があります。

上記の例は、呼び出しのシーケンスを示すために圧縮されています。実稼働コードでは、応答が複数のチャンクにまたがって到達する可能性があるため、 ヘッダー ブロックの末尾を受信するまでプロキシの応答をバッファします。