MongoDB\Driver\Manager::createClientEncryption
(mongodb >=1.7.0)
MongoDB\Driver\Manager::createClientEncryption — Создание нового объекта ClientEncryption
Описание
$options
) : MongoDB\Driver\ClientEncryptionСоздает новый объект MongoDB\Driver\ClientEncryption с заданными параметрами.
Список параметров
-
options
-
options Параметр Тип Описание keyVaultClient MongoDB\Driver\Manager Менеджер используется для маршрутизации запросов ключей данных в отдельный кластер MongoDB. По умолчанию используется текущий менеджер и кластер. keyVaultNamespace string Полное пространство имен (например, "databaseName.collectionName"
), обозначающее коллекцию, которая содержит все ключи данных, используемые для шифрования и дешифрования.kmsProviders array Документ, содержащий конфигурацию для одного или нескольких провайдеров KMS, которые используются для шифрования ключей данных. В настоящее время поддерживаются
aws
илиlocal
, и, по крайней мере, один из них должен быть указан.Формат для
aws
выглядит следующим образом:aws: { accessKeyId: <string>, secretAccessKey: <string> }
Формат для
local
выглядит следующим образом:local: { // Главный ключ, используемый для шифрования/дешифрования ключей данных key: <96-byte MongoDB\BSON\Binary with subtype 0> }
Возвращаемые значения
Возвращает новый экземпляр MongoDB\Driver\ClientEncryption.
Ошибки
- При ошибке парсинга аргумента бросает исключение MongoDB\Driver\Exception\InvalidArgumentException.
- Выбрасывает исключение MongoDB\Driver\Exception\RuntimeException если модуль был скомпилирован без поддержки libmongocrypt
Смотрите также
- MongoDB\Driver\ClientEncryption
- Страница в в руководстве по MongoDB: » Явное (ручное) шифрование на уровне поля на стороне клиента