MongoDB\Driver\ClientEncryption::createDataKey

Параметри

kmsProvider

The KMS provider (e.g. "local", "aws") that will be used to encrypt the new data key.

options

Data key options

Option	Type	Description
masterKey	array	The masterKey document identifies a KMS-specific key used to encrypt the new data key. This option is required unless kmsProvider is "local". Налаштування провейдера "aws" Назва Тип Опис region string Обов'язковий. key string Обов'язковий. Amazon Resource Name (ARN) для AWS customer master key (CMK). endpoint string Необов'язковий. Додатковий ідентифікатор хоста для надсилання запитів KMS. Може містити номер порту. Налаштування провейдера "azure" Назва Тип Опис keyVaultEndpoint string Обов'язковий. Хост (може бути з портом) (напр. "example.vault.azure.net"). keyName string Обов'язковий. keyVersion string Необов'язковий. Певна версія названого ключа. Стандартно вказується версія головного ключа. Налаштування провейдера "gcp" Назва Тип Опис projectId string Обов'язковий. location string Обов'язковий. keyRing string Обов'язковий. keyName string Обов'язковий. keyVersion string Необов'язковий. Певна версія названого ключа. Стандартно вказується версія головного ключа. endpoint string Необов'язковий. Хост (може бути з портом) (напр. "cloudkms.googleapis.com"). Налаштування провейдера "kmip" Назва Тип Опис keyId string Необов'язковий. Унікальний ідентифікатор для 96-байтного об'єкта керування секретними даними KMIP. Якщо не вказано, об'єкт генерується випадковим чином. endpoint string Необов'язковий. Хост (може бути з портом).
keyAltNames	array	An optional list of string alternate names used to reference a key. If a key is created with alternate names, then encryption may refer to the key by the unique alternate name instead of by _id.
keyMaterial	MongoDB\BSON\Binary	An optional 96-byte value to use as custom key material for the data key being created. If keyMaterial is given, the custom key material is used for encrypting and decrypting data. Otherwise, the key material for the new data key is generated from a cryptographically secure random device.