ConFoo 2025

MongoDB\Driver\ClientEncryption::encrypt

(mongodb >=1.7.0)

MongoDB\Driver\ClientEncryption::encryptШифрует данные

Описание

final public MongoDB\Driver\ClientEncryption::encrypt(mixed $value, ?array $options = null): MongoDB\BSON\Binary

Метод шифрует данные.

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

value

Значение для шифрования. Метод шифрует любые значения, которые вставляются в БД MongoDB.

options

Encryption options
Опция Тип Описание
algorithm string

Алгоритм шифрования, который будет использоваться. Опция обязательна. Укажите одну из следующих констант ClientEncryption:

contentionFactor int

Коэффициент конкуренции для оценки запросов с индексированными зашифрованными полезными нагрузками.

Опция применяется и может быть указана только тогда, когда опция algorithm равна MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED или MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE.

keyAltName string

Идентифицирует документ коллекции хранилища ключей по keyAltName. Опция является взаимоисключающей с keyId и требуется ровно один.

keyId MongoDB\BSON\Binary

Идентифицирует ключ данных по _id. Значением является UUID (двоичный подтип 4). Опция является взаимоисключающей с keyAltName и требуется ровно один.

queryType string

Тип запроса для оценки запросов с индексированными, зашифрованными полезными нагрузками. Укажите одну из следующих констант ClientEncryption:

Опция применяется и может быть указана только тогда, когда опция algorithm равна MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED или MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE.

rangeOpts array

Опции индекса для шифруемого поля с поддержкой запросов «range». Параметры, которые приводят следующие абзацы, должны соответствовать значениям, которые установили в параметре encryptedFields целевой коллекции. Для BSON-полей с типом double и decimal128 требуется либо установить все опции min, max и precision, либо все отключить.

Опции индекса диапазона
Опция Тип Описание
min mixed Обязательна, если опцию precision установили. Минимальное BSON-значение в диапазоне.
max mixed Обязательна, если опцию precision установили. Максимальное BSON-значение в диапазоне.
sparsity int Необязательна. Опция принимает положительное 64-битное целое число.
precision int Небязательна. Опция принимает положительное 32-битное целое число, которое указывает точность для явного шифрования. Опцию устанавливают только для BSON-полей с типом double или decimal128.
trimFactor int Необязательна. Положительное 32-битное целое число.

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

Метод возвращает зашифрованные данные в виде объекта MongoDB\BSON\Binary с подтипом 6.

Ошибки

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

Версия Описание
PECL-модуль mongodb 1.20.0 В список опций параметра шифрования rangeOpts добавили опцию индекса диапазона "trimFactor". Опция диапазона "sparsity" теперь необязательна.
PECL-модуль mongodb 1.16.0 В список параметров шифрования добавили параметр "rangeOpts".
PECL-модуль mongodb 1.14.0 В список параметров шифрования добавили параметры "contentionFactor" и "queryType".

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

Добавить

Примечания пользователей

Пользователи ещё не добавляли примечания для страницы
To Top