(mongodb >=1.7.0)
MongoDB\Driver\Manager::createClientEncryption — Создание нового объекта ClientEncryption
$options): MongoDB\Driver\ClientEncryptionСоздаёт новый объект MongoDB\Driver\ClientEncryption с заданными параметрами.
options
| Параметр | Тип | Описание |
|---|---|---|
| keyVaultClient | MongoDB\Driver\Manager | Менеджер маршрутизации запросов ключей данных в отдельный кластер MongoDB. По умолчанию метод выбирает текущий менеджер и кластер. |
| keyVaultNamespace | string | Полное пространство имён (например, "databaseName.collectionName"), обозначающее коллекцию, которая содержит все ключи данных, используемые для шифрования и дешифрования. Обязательный параметр. |
| kmsProviders | array |
Документ, содержащий конфигурацию для одного или нескольких провайдеров KMS, которые используются для шифрования ключей данных.
Поддерживаются провайдеры
Если для
Формат для aws: {
accessKeyId: <string>,
secretAccessKey: <string>,
sessionToken: <optional string>
}
Формат для azure: {
tenantId: <string>,
clientId: <string>,
clientSecret: <string>,
identityPlatformEndpoint: <optional string> // По умолчанию "login.microsoftonline.com"
}
Формат для gcp: {
email: <string>,
privateKey: <base64 string>|<MongoDB\BSON\Binary>,
endpoint: <optional string> // По умолчанию "oauth2.googleapis.com"
}
Формат для kmip: {
endpoint: <string>
}
Формат для local: {
// 96-байтовый главный ключ, используемый для шифрования/дешифрования ключей данных
key: <base64 string>|<MongoDB\BSON\Binary>
}
|
| tlsOptions | array |
Документ, содержащий конфигурацию TLS для одного или нескольких KMS провайдеров. Поддерживаются провайдеры <provider>: {
tlsCaFile: <optional string>,
tlsCertificateKeyFile: <optional string>,
tlsCertificateKeyFilePassword: <optional string>,
tlsDisableOCSPEndpointCheck: <optional bool>
}
|
Возвращает новый экземпляр MongoDB\Driver\ClientEncryption.
| Версия | Описание |
|---|---|
| PECL mongodb 1.16.0 |
Провайдер AWS KMS для шифрования на стороне клиента теперь принимает параметр
Для опции
Если для KMS-провайдеров |
| PECL mongodb 1.15.0 |
Если для KMS-провайдера |
| PECL mongodb 1.12.0 |
KMIP теперь поддерживается в качестве KMS провайдера для шифрования на стороне клиента
и может быть настроен с помощью параметра
Добавлен параметр |
| PECL mongodb 1.10.0 |
Azure и GCP теперь поддерживаются в качестве поставщиков KMS
для шифрования на стороне клиента и могут быть настроены в поле "kmsProviders" параметра драйвера "autoEncryption".
Строки в кодировке Base64 теперь принимаются в качестве альтернативы MongoDB\BSON\Binary
для параметров внутри "kmsProviders".
|