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

Опции шифрования
Опция Тип Описание
algorithm string

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

  • MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC
  • MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM
  • MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED
  • MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED
contentionFactor int

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

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

Замечание: Queryable Encryption находится в стадии публичного предварительного просмотра и доступен для ознакомительных целей. Его пока не рекомендуется использовать для развёртываний в продакшене, так как могут быть внесены изменения. Дополнительную информацию смотрите в блоге » Queryable Encryption Preview.

keyAltName string

Задаёт документ коллекции хранилища ключей по keyAltName. Взаимоисключающая с опцией keyId, требуется только одна из них.

keyId MongoDB\BSON\Binary

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

queryType int

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

  • MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY

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

Замечание: Queryable Encryption находится в стадии публичного предварительного просмотра и доступен для ознакомительных целей. Его пока не рекомендуется использовать для развёртываний в продакшене, так как могут быть внесены изменения. Дополнительную информацию смотрите в блоге » Queryable Encryption Preview.

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

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

Ошибки

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

Версия Описание
PECL mongodb 1.14.0 Добавлены опции "contentionFactor" и "queryType".

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

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top