array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'ru', ), 'this' => array ( 0 => 'mongodb-driver-clientencryption.rewrapmanydatakey.php', 1 => 'MongoDB\\Driver\\ClientEncryption::rewrapManyDataKey', 2 => 'Переворачивает ключи данных', ), 'up' => array ( 0 => 'class.mongodb-driver-clientencryption.php', 1 => 'MongoDB\\Driver\\ClientEncryption', ), 'prev' => array ( 0 => 'mongodb-driver-clientencryption.removekeyaltname.php', 1 => 'MongoDB\\Driver\\ClientEncryption::removeKeyAltName', ), 'next' => array ( 0 => 'class.mongodb-driver-serverapi.php', 1 => 'MongoDB\\Driver\\ServerApi', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'ru', 'path' => 'reference/mongodb/mongodb/driver/clientencryption/rewrapmanydatakey.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

MongoDB\Driver\ClientEncryption::rewrapManyDataKey

(mongodb >=1.15.0)

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

Описание

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

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

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

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

filter (array|object)

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

Замечание: СУБД MongoDB при оценке критериев запроса сравнивает типы и значения по внутренним » правилам сравнения BSON-типов, которые не совпадают с правилами сравнения и жонглирования типами в PHP. При сопоставлении специального BSON-типа в запросе требуется передать объект BSON-класса, который соответствует типу BSON-значения, поэтому для сопоставления с BSON-типом » ObjectId указывают объект класса MongoDB\BSON\ObjectId.

options

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

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

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

masterKey array

Параметр 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 Строка Необязательный. Хост с дополнительным портом.
delegated bool Необязательный. Установка значения true передаёт управление расшифровкой ключа KMIP-серверу.

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

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

Ошибки

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

Версия Описание
PECL mongodb 1.20.0 Добавлена опция "delegated" к параметрам masterKey поставщика KMIP.