KeyVault.addKeyAlternateName()

項目一覧

動作

KeyVault.addKeyAlternateName(UUID, keyAltName)

UUIDを使用してデータ暗号化キーのkeyAltNames配列にkeyAltNameを追加します。

keyAltName は、キーヴォールト内のすべてのキー間で一意である必要があります。 getKeyVault()keyAltNamesメソッドは、keyAltNames が存在するドキュメントのみの部分インデックスフィルターを使用して、フィールドに一意のインデックスを自動的に作成します。

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

keyVault = db.getMongo().getKeyVault()
keyVault.addKeyAlternateName(
  UUID("<UUID string>"),
  "keyAlternateName"
)

次の値を返します。	データ暗号化キードキュメントの前のバージョンを返します。データ暗号化キーに`UUID()`が指定されていない場合は、 `null`を返します。

動作

データベース接続にクライアント側のフィールドレベル暗号化を構成する必要があります

mongoクライアント側のフィールドレベル暗号化メソッドでは、クライアント側のフィールドレベル暗号化が有効になっているデータベース接続が必要です。現在のデータベース接続がクライアント側のフィールドレベル暗号化を有効にして開始されなかった場合、次のいずれかが発生します。

必要なクライアント側のフィールドレベル暗号化オプションとの接続を確立するには、 Mongo()mongoshell からコンストラクターを使用します。The Mongo() method supports the following Key Management Service (KMS) providers for Customer Master Key (CMK) management:
or
必要なオプションとの接続を確立するには、 mongo shellコマンドラインオプションを使用します。コマンドラインオプションは、CMK 管理用のAmazon Web Services KMSプロバイダーのみをサポートしています。

例

次の例は、クライアント側のフィールドレベル暗号化の迅速な評価を目的としています。サポートされている各KeyVault.addKeyAlternateName() KMS プロバイダーでを使用する具体的な例については、「データ暗号化キーの別名を管理する」を参照してください。

ローカルで管理されているキーに対してクライアント側のフィールドレベル暗号化を構成するには、改行を含まない base64 でエンコードされた 96 バイトのstringを指定する必要があります。次の操作では、前述の要件を満たすキーを生成し、それをmongo shell にロードします。

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

生成されたローカルキーstringを使用して、クライアント側のフィールドレベル暗号化オブジェクトを作成します。

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

Mongo()コンストラクターを使用して、クライアント側のフィールドレベル暗号化オプションを持つデータベース接続を作成します。 mongodb://myMongo.example.net URI を、ターゲットクラスターの接続string URIに置き換えます。

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

KeyVaultオブジェクトを取得し、 KeyVault.addKeyAlternateName()メソッドを使用して、 UUIDと一致するデータ暗号化キーに新しいキーの代替名を追加します。指定するキーの代替名は一意である必要があります。

keyVault = encryptedClient.getKeyVault()
keyVault.addKeyAlternateName(UUID("b4b41b33-5c97-412e-a02b-743498346079"),"Other-Data-Encryption-Key")

成功した場合、 addKeyAlternateName()は前のバージョンのデータ暗号化キードキュメントを返します。

{
    "_id" : UUID("b4b41b33-5c97-412e-a02b-743498346079"),
    "keyMaterial" : BinData(0,"PXRsLOAYxhzTS/mFQAI8486da7BwZgqA91UI7NKz/T/AjB0uJZxTvhvmQQsKbCJYsWVS/cp5Rqy/FUX2zZwxJOJmI3rosPhzV0OI5y1cuXhAlLWlj03CnTcOSRzE/YIrsCjMB0/NyiZ7MRWUYzLAEQnE30d947XCiiHIb8a0kt2SD0so8vZvSuP2n0Vtz4NYqnzF0CkhZSWFa2e2yA=="),
    "creationDate" : ISODate("2019-08-12T21:21:30.569Z"),
    "updateDate" : ISODate("2019-08-12T21:21:30.569Z"),
    "status" : 0,
    "version" : NumberLong(0),
    "masterKey" : {
        "provider" : "local"
    },
    "keyAltNames" : [
    ]
}

データ暗号化キードキュメントの現在のバージョンを表示するには、返されたドキュメントの_idを指定するKeyVault.getKey()を使用するか、 keyAltNamesの 1 つを指定するKeyVault.getKeyByAltName()を使用します。

Tip

以下も参照してください。

データ暗号化キーの別名を管理する

戻る

getKeyVault

KeyVault.createKey