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

函式名稱：MongoDB\Driver\ClientEncryption::getKey()

函式描述：獲取與客戶端加密關聯的金鑰資訊。

適用版本：MongoDB擴充套件版本1.6.0及以上。

用法：

MongoDB\Driver\ClientEncryption::getKey(): array

引數：該函式沒有引數。

返回值：返回一個關聯陣列，包含有關金鑰的詳細資訊。

示例：

<?php
// 建立一個MongoDB\Driver\ClientEncryption物件
$encryption = new MongoDB\Driver\ClientEncryption($kmsProvider, $options);

// 獲取客戶端加密關聯的金鑰資訊
$keyInfo = $encryption->getKey();

// 列印金鑰資訊
print_r($keyInfo);
?>

輸出：

Array
(
    [masterKey] => MongoDB\BSON\Binary Object
        (
            [data] => 1234567890abcdef
            [type] => 5
        )
    [provider] => kms
    [options] => Array
        (
            [region] => us-east-1
            [keyVaultNamespace] => encryption.__keyVault
        )
)

注意事項：

• 該函式需要在MongoDB\Driver\ClientEncryption物件上呼叫。
• 在呼叫該函式之前，必須先透過MongoDB\Driver\ClientEncryption::createDataKey()方法建立一個資料金鑰。
• 返回的金鑰資訊中，masterKey是主金鑰，provider是金鑰管理服務提供商，options是與金鑰相關的選項。