PHP.mk документација
MongoDB\Driver\ClientEncryption::createDataKey
Почист и полокален преглед на PHP референцата, со задржана структура од PHP.net и подобра читливост за примери, секции и белешки.
Патека
mongodb-driver-clientencryption.createdatakey.php
Локална патека за оваа страница.
Извор
php.net/manual/en
Оригиналниот HTML се реупотребува и локално се стилизира.
Режим
Прокси + превод во позадина
Кодовите, табелите и белешките остануваат читливи во истиот тек.
Референца
mongodb-driver-clientencryption.createdatakey.php
MongoDB\Driver\ClientEncryption::createDataKey
Референца за `mongodb-driver-clientencryption.createdatakey.php` со подобрена типографија и навигација.
MongoDB\Driver\ClientEncryption::createDataKey
класата MongoDB\Driver\ClientEncryption
MongoDB\Driver\ClientEncryption::createDataKey — Создава клучен документ
= NULL
final public function MongoDB\Driver\ClientEncryption::createDataKey(string
$kmsProvider, ?array $options = null): MongoDB\BSON\BinaryСоздава клучен документ
Параметри
kmsProvider-
Создава нов клучен документ и го вметнува во колекцијата на складиштето за клучеви.
"local","aws"KMS-провајдерот (на пр. options-
) што ќе се користи за шифрирање на новиот клучен податок. Опција Тип = NULL masterKey array Опции за клучен податок kmsProvideris"local"."aws"masterKey документот идентификува KMS-специфичен клуч што се користи за шифрирање на новиот клучен податок. Оваа опција е задолжителна освен акоОпција Тип = NULL region string Required. key string provider опции endpoint string Задолжително. Името на ресурсот на Амазон (ARN) до клучот за управување со клиенти на AWS (CMK). "azure"masterKey документот идентификува KMS-специфичен клуч што се користи за шифрирање на новиот клучен податок. Оваа опција е задолжителна освен акоОпција Тип = NULL keyVaultEndpoint string Опционално. Алтернативен идентификатор на домаќин за испраќање KMS барања. Може да вклучува број на порта. keyName string Required. keyVersion string Задолжително. Домаќин со опционална порта (на пр. "example.vault.azure.net"). "gcp"masterKey документот идентификува KMS-специфичен клуч што се користи за шифрирање на новиот клучен податок. Оваа опција е задолжителна освен акоОпција Тип = NULL projectId string Required. location string Required. keyRing string Required. keyName string Required. keyVersion string Задолжително. Домаќин со опционална порта (на пр. "example.vault.azure.net"). endpoint string Опционално. Специфична верзија на именуваниот клуч. Стандардно користи примарна верзија на клучот. "kmip"masterKey документот идентификува KMS-специфичен клуч што се користи за шифрирање на новиот клучен податок. Оваа опција е задолжителна освен акоОпција Тип = NULL keyId string Опционално. Домаќин со опционална порта. Стандардно е "cloudkms.googleapis.com". endpoint string Опционално. Уникатен идентификатор на 96-бајтен KMIP објект со тајни податоци. Ако не е наведен, драјверот создава случаен 96-бајтен KMIP објект со тајни податоци. delegated bool Опционално. Домаќин со опционална порта. keyAltNames array Опционално. Ако е точно, овој клуч треба да биде дешифриран од KMIP серверот. _id.keyMaterial MongoDB\BSON\Binary Опционална листа на алтернативни имиња на низи што се користат за повикување на клуч. Ако клучот е создаден со алтернативни имиња, тогаш шифрирањето може да се повикува на клучот по уникатното алтернативно име наместо по
Вратени вредности
Опционална вредност од 96 бајти што ќе се користи како прилагоден клучен материјал за клучен податок што се создава. Ако е даден клучен материјал, прилагодениот клучен материјал се користи за шифрирање и дешифрирање на податоци. Инаку, клучен материјал за новиот клучен податок се генерира од криптографски сигурен случаен уред. MongoDB\BSON\Binary Враќа идентификатор на новиот клуч како
Errors/Exceptions
- ). Ако повикот не успее, ќе врати MongoDB\Driver\Exception\InvalidArgumentException » Промени текови
- ). Ако повикот не успее, ќе врати MongoDB\Driver\Exception\ConnectionException ако врската со серверот пропадне (од причини различни од автентикација).
- ). Ако повикот не успее, ќе врати MongoDB\Driver\Exception\AuthenticationException ако автентикацијата е потребна и пропадне.
- ). Ако повикот не успее, ќе врати MongoDB\Driver\Exception\RuntimeException при секој неуспех при запишување (на пр. неуспех на командата, грешка при запишување или загриженост за запишување)
Дневник на промени
| Верзија | = NULL |
|---|---|
| = nearest |
Додадено "delegated" објект со подтип 4 (UUID).
|
| Типовите на враќање претходно декларирани како привремени сега се применуваат. |
Додаден е "keyMaterial" option.
|
| PECL mongodb 1.10.0 | Azure и GCP сега се поддржани како KMS провајдери за шифрирање од страна на клиентот. |
Белешки од корисници
Нема белешки од корисници за оваа страница.