MongoDB\Driver\ClientEncryption::encrypt
(mongodb >=1.7.0)
MongoDB\Driver\ClientEncryption::encrypt — Зашифровать данные
Описание
$value
, array $options
= ?
) : MongoDB\BSON\BinaryШифрует данные.
Список параметров
-
value
-
Значение для шифрования. Этот метод может зашифровать любые данные, которые могут быть записаны в MongoDB.
-
options
-
Опции шифрования Опция Тип Описание algorithm string Алгоритм шифрования. Используйте константы заданные в MongoDB\Driver\ClientEncryption.
keyAltName string Задаёт документ коллекции хранилища ключей по
keyAltName
.keyId MongoDB\BSON\Binary Задаёт ключ данных по
_id
. Значение типа UUID (бинарный подтип 4).Замечание: Можно указывать только опцию
keyId
илиkeyAltName
, но не обе сразу. Опцияalgorithm
обязательна.
Возвращаемые значения
Возвращает зашифрованные данные в виде объекта MongoDB\BSON\Binary с подтипом 6.
Ошибки
- При ошибке парсинга аргумента бросает исключение MongoDB\Driver\Exception\InvalidArgumentException.
- Бросает исключение MongoDB\Driver\Exception\EncryptionException если при шифровании возникла ошибка
Смотрите также
- MongoDB\Driver\ClientEncryption::decrypt() - Расшифровать данных