MongoDB\Driver\ClientEncryption::createDataKey()函式—用法及示例

函式名：MongoDB\Driver\ClientEncryption::createDataKey()

適用版本：MongoDB PHP擴充套件版本 1.9.0+

用法：

public function MongoDB\Driver\ClientEncryption::createDataKey(
   string $kmsProvider,
   array $options = []
): string

該函式用於在客戶端加密環境中建立一個新的資料金鑰。資料金鑰將用於加密和解密敏感資料。

引數：

1. $kmsProvider (string)：指定加密金鑰管理服務（KMS）提供者的名稱。常見的提供者有"aws"和"local"。
2. $options (array, optional)：可選引數陣列，用於指定進一步的選項設定。常見的選項包括"masterKey"和"keyAltNames"。

返回值：

• 若成功建立資料金鑰，則返回一個字串，表示生成的資料金鑰的唯一識別符號（UUID）。

示例：

$encryption = new MongoDB\Driver\ClientEncryption($keyVaultNamespace, $keyVaultCollection, $kmsProviderOptions);

// 建立一個資料金鑰
$dataKey = $encryption->createDataKey('aws', [
    'masterKey' => 'arn:aws:kms:us-west-2:123456789012:key/abcd1234-5678-90ab-cdef-1234567890ab',
    'keyAltNames' => ['myDataKey']
]);

echo $dataKey;

上述示例中，我們首先建立了一個MongoDB\Driver\ClientEncryption物件，並傳入了相關的引數。然後，我們呼叫createDataKey()函式來建立一個資料金鑰。在這個示例中，我們選擇了AWS KMS作為金鑰管理服務提供者，並指定了一個主金鑰和一個金鑰備用名稱。最後，我們列印出生成的資料金鑰的唯一識別符號。