MongoDB\Driver\ClientEncryption::createDataKey

(mongodb >=1.7.0)

MongoDB\Driver\ClientEncryption::createDataKey — Создает ключ шифрования

Описание

final public MongoDB\Driver\ClientEncryption::createDataKey ( string $kmsProvider , array $options = ? ) : MongoDB\BSON\Binary

Создает новый документ с ключем шифрования и кладет его в коллекцию хранилища ключей.

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

kmsProvider

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

options

Опция Тип Описание

masterKey

array

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

**Опции masterKey для AWS**
Опция	Тип	Описание
region	string	Обязателен
key	string	Обязателен. Amazon Resource Name (ARN) для мастер ключа пользователя (CMK) AWS
endpoint	string	Необязательный. Альтернативный идентификатор хоста, куда будет отправляться запрос KMS. Может содержать номер порта

keyAltNames

array

Опциональный список альтернативных имен использующихся для ссылки на ключ. Если ключ создан с использованием альтернативных имён, то при шифровании можно ссылаться на уникальное альтернативное имя вместо _id.

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

Возвращает идентификатор нового ключа в виде объекта MongoDB\BSON\Binary с подтипом 4 (UUID).

Ошибки

При ошибке парсинга аргумента бросает исключение MongoDB\Driver\Exception\InvalidArgumentException.
Бросает исключение MongoDB\Driver\Exception\EncryptionException если в процессе создания ключа произошла ошибка