MongoDB\Driver\ClientEncryption::__construct

(mongodb >=1.14.0)

MongoDB\Driver\ClientEncryption::__constructСоздаёт новый объект ClientEncryption

Описание

finalpublicMongoDB\Driver\ClientEncryption::__construct(array$options)

Создаёт новый объект MongoDB\Driver\ClientEncryption с указанными опциями.

Список параметров

options

Опции
ОпцияТипОписание
keyVaultClientMongoDB\Driver\Manager Менеджер, используемый для маршрутизации запросов ключей данных. Опция является обязательной (в отличие от функции MongoDB\Driver\Manager::createClientEncryption()).
keyVaultNamespacestringПолное пространство имён (например, "databaseName.collectionName"), обозначающее коллекцию, которая содержит все ключи данных, используемые для шифрования и дешифрования. Обязательный параметр.
kmsProvidersarray

Документ, содержащий конфигурацию для одного или нескольких провайдеров KMS, которые используются для шифрования ключей данных. Поддерживаются провайдеры "aws", "azure", "gcp" и "local", и, по крайней мере, один из них должен быть указан.

Если для "aws", "azure" или "gcp" указан пустой документ, драйвер попытается сконфигурировать провайдера, используя » Автоматические учётные данные.

Формат для "aws" выглядит следующим образом:

aws: { accessKeyId: <string>, secretAccessKey: <string>, sessionToken: <optional string> }

Формат для "azure" выглядит следующим образом:

azure: { tenantId: <string>, clientId: <string>, clientSecret: <string>, identityPlatformEndpoint: <optional string> }

Формат для "gcp" выглядит следующим образом:

gcp: { email: <string>, privateKey: <base64 string>|<MongoDB\BSON\Binary>, endpoint: <optional string> }

Формат для "kmip" выглядит следующим образом:

kmip: { endpoint: <string> }

Формат для "local" выглядит следующим образом:

local: { key: <base64 string>|<MongoDB\BSON\Binary> }
tlsOptionsarray

Документ, содержащий конфигурацию TLS для одного или нескольких KMS провайдеров. Поддерживаются провайдеры "aws", "azure", "gcp" и "kmip". Все провайдеры поддерживают следующие опции:

<provider>: { tlsCaFile: <optional string>, tlsCertificateKeyFile: <optional string>, tlsCertificateKeyFilePassword: <optional string>, tlsDisableOCSPEndpointCheck: <optional bool> }

Ошибки

Список изменений

ВерсияОписание
PECL mongodb 1.16.0

Провайдер AWS KMS для шифрования на стороне клиента теперь принимает параметр "sessionToken", который можно указывать для аутентификации с временными учётными данными AWS.

Добавлена поддержка поля "tlsDisableOCSPEndpointCheck" в опции "tlsOptions".

Если для KMS-провайдеров "azure" или "gcp" указан пустой документ, драйвер попытается сконфигурировать провайдера, заполнив » Автоматические учётные данные.

PECL mongodb 1.15.0

Если для KMS-провайдера "aws" указан пустой документ, драйвер попытается сконфигурировать провайдера, заполнив » Автоматические учётные данные.

Смотрите также

To Top