MongoDB\Driver\ClientEncryption::rewrapManyDataKey

    (mongodb >=1.15.0)

    MongoDB\Driver\ClientEncryption::rewrapManyDataKey — Переворачивает ключи данных

    Описание

    finalpublicMongoDB\Driver\ClientEncryption::rewrapManyDataKey(array|object$filter, ?array$options = null): object

    Переворачивает (т.е. расшифровывает и заново шифрует) ноль или более ключей данных в коллекции хранилища ключей, которые соответствуют заданному фильтру (filter).

    Если опция "provider" не указана, совпадающие ключи данных будут повторно зашифрованы с помощью текущего поставщика KMS. В противном случае совпадающие ключи данных будут зашифрованы заново в соответствии с указанными опциями "provider" и "masterKey".

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

    filter (array|object)

    » Предикат запроса. Пустой предикат совпадёт со всеми элементами коллекции.

    Замечание: При вычислении критериев запроса MongoDB сравнивает типы и значения в соответствии с собственными » правилами сравнения типов BSON, отличных от правил сравнения и приведения типов PHP. Когда указан специальный тип BSON, критерия запроса должна соответствовать классу BSON (т.е. использовать MongoDB\BSON\ObjectId для выборке по » ObjectId).

    options

    Параметры RewrapManyDataKey
    ПараметрТипОписание
    providerstring

    KMS-провайдер (например, "local", "aws"), который будет использоваться для повторного шифрования совпавших ключей данных.

    Если провайдер KMS не указан, то совпадающие ключи данных будут повторно зашифрованы с помощью текущего провайдера KMS.

    masterKeyarray

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

    Параметры провайдера "aws"
    ПараметрТипОписание
    regionСтрокаОбязательный.
    keyСтрокаОбязательный. Имя ресурса Amazon (ARN) для главного ключа клиента AWS (CMK).
    endpointСтрокаНеобязательный. Альтернативный идентификатор хоста для отправки запросов KMS. Может содержать номер порта.

    Параметры провайдера "azure"
    ПараметрТипОписание
    keyVaultEndpointСтрокаОбязательный. Хост с необязательным портом (например, "example.vault.azure.net").
    keyNameСтрокаОбязательный.
    keyVersionСтрокаНеобязательный. Определённая версия именованного ключа. По умолчанию — первичная версия ключа.

    Параметры провайдера "gcp"
    ПараметрТипОписание
    projectIdСтрокаОбязательный.
    locationСтрокаОбязательный.
    keyRingСтрокаОбязательный.
    keyNameСтрокаОбязательный.
    keyVersionСтрокаНеобязательный. Определённая версия именованного ключа. По умолчанию — первичная версия ключа.
    endpointСтрокаНеобязательный. Хост с дополнительным портом. По умолчанию "cloudkms.googleapis.com"..

    Параметры провайдера "kmip"
    ПараметрТипОписание
    keyIdСтрокаНеобязательный. Уникальный идентификатор 96-байтового управляемого объекта секретных данных KMIP. Если не указан, драйвер создаёт случайный 96-байтовый управляемый объект секретных данных KMIP.
    endpointСтрокаНеобязательный. Хост с дополнительным портом.

    Возвращаемые значения

    Возвращает объект, у которого будет необязательное свойство bulkWriteResult, содержащее результат внутренней операции bulkWrite в виде объекта. Если ни один ключ данных не соответствует фильтру или запись не была признана, свойство bulkWriteResult будет равно null.

    Ошибки

    To Top