KeyVault.createKey()

KeyVault.createKey(keyManagementService, customerMasterKey, ["keyAltName"])

データベース接続に関連付けられたキーヴォールトにデータ暗号化キーを追加します。 クライアント側のフィールドレベル暗号化では、フィールド値の暗号化と復号化をサポートするためにデータ暗号化キーを使用します。

createKey() の構文は次のとおりです。

keyVault = db.getMongo().getKeyVault()
keyVault.createKey(
  keyManagementService,
  customerMasterKey,
  [ "keyAltName" ]
)

Parameter	タイプ	説明
keyManagementService	string	必須 CMK（Customer Master Key）の取得に使用するKMS （ KMS ）。 次のパラメータを受け入れます。 aws Amazon Web Services KMSの。 customerMasterKey の CMK（Customer Master Key） stringを指定する必要があります。 azure Azure Key Vault用の。 customerMasterKeyの CMK（Customer Master Key）ドキュメントを指定する必要があります。 バージョン 5.0 で追加 gcp Google Cloud Platform KMS用。 customerMasterKeyの CMK（Customer Master Key）ドキュメントを指定する必要があります。 バージョン 5.0 で追加 local ローカルで管理されているキーの場合 database connectionが指定された KMS で構成されていない場合、データ暗号化キーの作成は失敗します。
customerMasterKey	文字列またはドキュメント	データ暗号化キーの暗号化に使用する CMK（Customer Master Key）。 keyManagementServiceがaws 、 azure 、またはgcpの場合に必須です。 KMS プロバイダーに応じて、次のように CMK を指定します。 Amazon Web Services KMS の場合は、完全な Amazon リソース名（ARN） を指定します マスター キーの を単一の string として表示します。 Azure Key Vault KMS の場合は、次のキーと値のペアを含むドキュメントを指定します。 keyName - Azure Key Vault 名 keyVaultEndpoint - 使用する Azure Key Vault の DNS 名 keyVersion - 任意。 keyNameで指定されたキーのバージョン（該当する場合） バージョン 5.0 で追加 Google Cloud Platform KMSの場合は、次のキーと値のペアを含むドキュメントを指定します。 projectId - GCP プロジェクト名 location - KMS キーの場所 keyRing - KMS キーリングの名前（多くの場合「グローバル」） keyName - 使用するキーの名前 keyVersion - 任意。 keyNameで指定されたキーのバージョン（該当する場合） バージョン 5.0 で追加 createKey()は、指定されたKMSを使用してデータ暗号化キーマテリアルを暗号化することを要求します。 CMK が存在しない場合、またはClientSideFieldLevelEncryptionOptions構成に CMK を使用するための十分な特権がない場合、 createKey()はエラーを返します。 このパラメータは、 keyManagementServiceがlocalである場合は効果がなく、省略しても問題ありません。
keyAltName	文字列の配列	任意 データ暗号化キーの別名。 特定のデータ暗号化キーを見つけやすくするには、またはコメントに類似するものとしてkeyAltNameを使用します。 メソッドは、 getKeyVault()が存在するドキュメントのみを対象とする 部分インデックス keyAltNamesフィルターを使用して、 フィールドに 一意のインデックスkeyAltNames を自動的に作成します。

次の値を返します。	作成されたデータ暗号化キーのUUID一意の識別子。

TEST_LOCAL_KEY=$(echo "$(head -c 96 /dev/urandom | base64 | tr -d '\n')")
mongosh --nodb --shell --eval "var TEST_LOCAL_KEY='$TEST_LOCAL_KEY'"

var ClientSideFieldLevelEncryptionOptions = {
  "keyVaultNamespace" : "encryption.__dataKeys",
  "kmsProviders" : {
    "local" : {
      "key" : BinData(0, TEST_LOCAL_KEY)
    }
  }
}

encryptedClient = Mongo(
  "mongodb://myMongo.example.net:27017/?replSetName=myMongo",
  ClientSideFieldLevelEncryptionOptions
)

keyVault = encryptedClient.getKeyVault()
keyVault.createKey("local", ["data-encryption-key"])