MongoDB\Driver\ClientEncryption::createDataKey
Почист и полокален преглед на PHP референцата, со задржана структура од PHP.net и подобра читливост за примери, секции и белешки.
MongoDB\Driver\ClientEncryption::createDataKey
Референца за `mongodb-driver-clientencryption.createdatakey.php` со подобрена типографија и навигација.
MongoDB\Driver\ClientEncryption::createDataKey
класата MongoDB\Driver\ClientEncryption
MongoDB\Driver\ClientEncryption::createDataKey — Creates a key document
= NULL
$kmsProvider, ?array $options = null): MongoDB\BSON\BinaryCreates a new key document and inserts it into the key vault collection.
Параметри
kmsProvider-
The KMS provider (e.g.
"local","aws") that will be used to encrypt the new data key. options-
Data key options Опција Тип = NULL masterKey array The masterKey document identifies a KMS-specific key used to encrypt the new data key. This option is required unless
kmsProvideris"local"."aws"provider optionsОпција Тип = NULL region string Required. key string Required. The Amazon Resource Name (ARN) to the AWS customer master key (CMK). endpoint string Optional. An alternate host identifier to send KMS requests to. May include port number. "azure"provider optionsОпција Тип = NULL keyVaultEndpoint string Required. Host with optional port (e.g. "example.vault.azure.net"). keyName string Required. keyVersion string Optional. A specific version of the named key. Defaults to using the key's primary version. "gcp"provider optionsОпција Тип = NULL projectId string Required. location string Required. keyRing string Required. keyName string Required. keyVersion string Optional. A specific version of the named key. Defaults to using the key's primary version. endpoint string Optional. Host with optional port. Defaults to "cloudkms.googleapis.com". "kmip"provider optionsОпција Тип = NULL keyId string Optional. Unique identifier to a 96-byte KMIP secret data managed object. If unspecified, the driver creates a random 96-byte KMIP secret data managed object. endpoint string Optional. Host with optional port. delegated bool Optional. If true, this key should be decrypted by the KMIP server. 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.
Вратени вредности
Returns the identifier of the new key as a MongoDB\BSON\Binary object with subtype 4 (UUID).
Errors/Exceptions
- ). Ако повикот не успее, ќе врати MongoDB\Driver\Exception\InvalidArgumentException » Промени текови
- ). Ако повикот не успее, ќе врати MongoDB\Driver\Exception\ConnectionException ако врската со серверот пропадне (од причини различни од автентикација).
- ). Ако повикот не успее, ќе врати MongoDB\Driver\Exception\AuthenticationException ако автентикацијата е потребна и пропадне.
- ). Ако повикот не успее, ќе врати MongoDB\Driver\Exception\RuntimeException при секој неуспех при запишување (на пр. неуспех на командата, грешка при запишување или загриженост за запишување)
Дневник на промени
| Верзија | = NULL |
|---|---|
| = nearest |
Додадено "delegated" to the KMIP provider masterKey options.
|
| Типовите на враќање претходно декларирани како привремени сега се применуваат. |
Додаден е "keyMaterial" option.
|
| PECL mongodb 1.10.0 | Azure and GCP are now supported as KMS providers for client-side encryption. |