MongoDB\Driver\ClientEncryption::createDataKey

(mongodb >=1.7.0)

MongoDB\Driver\ClientEncryption::createDataKey — 建立金鑰文件

final public MongoDB\Driver\ClientEncryption::createDataKey(字串 $kmsProvider, ?陣列 $options = null): MongoDB\BSON\Binary

建立一個新的金鑰文件並將其插入金鑰保管庫集合中。

kmsProvider

將用於加密新資料金鑰的 KMS 提供者（例如 "local"、"aws"）。

options

選項類型說明

masterKey

masterKey 文件標識用於加密新資料金鑰的 KMS 特定金鑰。除非 kmsProvider 為 "local"，否則此選項為必填。

**`"aws"` 提供者選項**
選項	類型	說明
region	字串	必填。
key	字串	必填。AWS 客戶主金鑰 (CMK) 的 Amazon 資源名稱 (ARN)。
endpoint	字串	選填。要將 KMS 請求發送到的替代主機識別碼。可以包含埠號。

**`"azure"` 提供者選項**
選項	類型	說明
keyVaultEndpoint	字串	必填。主機名稱，可選擇包含埠號（例如 "example.vault.azure.net"）。
keyName	字串	必填。
keyVersion	字串	選填。指定金鑰的特定版本。預設使用金鑰的主要版本。

**`"gcp"` 提供者選項**
選項	類型	說明
projectId	字串	必填。
location	字串	必填。
keyRing	字串	必填。
keyName	字串	必填。
keyVersion	字串	選填。指定金鑰的特定版本。預設使用金鑰的主要版本。
endpoint	字串	選填。主機名稱，可選擇包含埠號。預設為 "cloudkms.googleapis.com"。

**`"kmip"` 提供者選項**
選項	類型	說明
keyId	字串	選填。96 位元組 KMIP 秘密資料受管物件的唯一識別碼。如果未指定，驅動程式會建立一個隨機的 96 位元組 KMIP 秘密資料受管物件。
endpoint	字串	選填。主機名稱，可選擇包含埠號。