函数名:MongoDB\Driver\ClientEncryption::addKeyAltName()
函数描述:此函数用于向客户端加密对象添加密钥的备用名称。备用名称是一个字符串,用于标识密钥的其他别名。
参数:
- keyId (string):密钥的唯一标识符。
- altName (string):密钥的备用名称。
返回值:无返回值。
适用版本:MongoDB PHP Library 1.7.0 及以上版本。
示例:
<?php
// 创建加密客户端对象
$encryption = new MongoDB\Driver\ClientEncryption($kmsProvider, $keyVaultNamespace, $options);
// 添加密钥的备用名称
$keyId = "5f6d0e7d4d9e7e0012345678";
$altName = "my_key_alias";
$encryption->addKeyAltName($keyId, $altName);
?>
以上示例演示了如何使用addKeyAltName()
函数向客户端加密对象添加密钥的备用名称。首先,我们创建了一个加密客户端对象$encryption
,然后通过调用addKeyAltName()
函数,传递密钥的唯一标识符$keyId
和备用名称$altName
,将备用名称添加到密钥中。