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

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

適用版本：MongoDB PHP Library 1.9.0 及以上版本

用法：該函式用於透過指定的備用名稱獲取客戶端加密的金鑰。

引數：

• altName（string）：備用名稱，用於查詢相應的金鑰。

返回值：

• 如果找到匹配的金鑰，將返回一個MongoDB\BSON\Binary物件，其中包含金鑰的二進位制資料。
• 如果未找到匹配的金鑰，將返回null。

示例：

<?php
// 建立ClientEncryption物件
$clientEncryption = new MongoDB\Driver\ClientEncryption($keyVaultNamespace, $kmsProviders);

// 獲取指定備用名稱的金鑰
$altName = "my_key";
$key = $clientEncryption->getKeyByAltName($altName);

if ($key) {
    echo "找到了備用名稱為 {$altName} 的金鑰！\n";
    echo "金鑰的二進位制資料為：" . bin2hex($key->getData()) . "\n";
} else {
    echo "未找到備用名稱為 {$altName} 的金鑰。\n";
}
?>

注意事項：

• 在使用該函式之前，必須先建立一個MongoDB\Driver\ClientEncryption物件，並透過建構函式提供金鑰庫名稱空間和金鑰管理服務提供者。
• 該函式需要連線到MongoDB伺服器，並且需要有正確的許可權才能訪問金鑰庫。
• 備用名稱是在建立金鑰時指定的，用於在金鑰庫中標識金鑰。確保提供的備用名稱與實際建立金鑰時使用的備用名稱匹配，否則函式將無法找到對應的金鑰。