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是与密钥相关的选项。