PHP workshop for 2 days with Shopware, Sylius, PHPUnit and Codeception in Duisburg

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", "azure", "gcp"), который будет использоваться для шифрования нового ключа.

options

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

masterKey задаёт подходящий для KMS ключ, который будет использоваться для шифрования нового ключа. Эта опция обязательна, если kmsProvider не является "local".

Если в kmsProvider указано значение "aws", этот параметр является обязательным и имеет следующие поля:

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

Если в kmsProvider указано значение "azure", этот параметр является обязательным и имеет следующие поля:

Опции masterKey для Azure
Опция Тип Описание
keyVaultEndpoint string Обязательное. Хост с необязательным портом (например, example.vault.azure.net).
keyName string Обязательное.
keyVersion string Необязательное. Конкретная версия ключа. По умолчанию используется первичная версия ключа.

Если в kmsProvider указано значение "gcp", этот параметр является обязательным и имеет следующие поля:

Опции masterKey для GCP
Опция Тип Описание
projectId string Обязательное.
location string Обязательное.
keyRing string Обязательное.
keyName string Обязательное.
keyVersion string Необязательное. Конкретная версия ключа. По умолчанию используется первичная версия ключа.
endpoint string Необязательное. Хост с необязательным портом. По умолчанию cloudkms.googleapis.com.

keyAltNames array

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

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

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

Ошибки

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

Версия Описание
PECL mongodb 1.10.0 В качестве поставщиков KMS для шифрования на стороне клиента теперь поддерживаются Azure и GCP.

add a note add a note

User Contributed Notes

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