MongoDB\Driver\ClientEncryption::__construct

    (mongodb >=1.14.0)

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

    Описание

    final public MongoDB\Driver\ClientEncryption::__construct(array $options)

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

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

    options

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

    Документ, содержащий конфигурацию для одного или нескольких провайдеров 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> // По умолчанию "login.microsoftonline.com"

}

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

    gcp: {
    email: <string>,
    privateKey: <base64 string>|<MongoDB\BSON\Binary>,
    endpoint: <optional string> // По умолчанию "oauth2.googleapis.com"

}

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

    kmip: {
    endpoint: <string>
}

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

    local: {
    // 96-байтовый главный ключ, используемый для шифрования/дешифрования ключей данных
    key: <base64 string>|<MongoDB\BSON\Binary>
}
    tlsOptions array

    Документ, содержащий конфигурацию 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