MongoDB\Driver\Manager::createClientEncryption
Почист и полокален преглед на PHP референцата, со задржана структура од PHP.net и подобра читливост за примери, секции и белешки.
MongoDB\Driver\Manager::createClientEncryption
Референца за `mongodb-driver-manager.createclientencryption.php` со подобрена типографија и навигација.
MongoDB\Driver\Manager::createClientEncryption
класата MongoDB\Driver\ClientEncryption
MongoDB\Driver\Manager::createClientEncryption — (mongodb >=1.7.0)
= NULL
$options): MongoDB\Driver\ClientEncryption(PHP 5, PHP 7, PHP 8, PECL tidy >= 0.5.2) MongoDB\Driver\ClientEncryption Креирај нов ClientEncryption објект
Параметри
options-
options Опција Тип = NULL keyVaultClient MongoDB\Driver\Manager објект со наведените опции. keyVaultNamespace string Целосно квалификувано име на простор (на пр. "databaseName.collectionName"Менаџерот што се користи за насочување на барањата за клучеви за податоци до посебен MongoDB кластер. Стандардно, се користи тековниот Менаџер и кластер.kmsProviders array ) што го означува збирката што ги содржи сите клучеви за податоци што се користат за шифрирање и дешифрирање. Оваа опција е задолжителна. "aws","azure","gcp","kmip"Препорачаниот начин за избегнување на SQL инјекција е со врзување на сите податоци преку подготвени изрази. Користењето на параметризирани прашања не е доволно за целосно избегнување на SQL инјекција, но тоа е најлесниот и најбезбедниот начин за обезбедување влез во SQL изразите. Сите динамични литерали на податоци во"local"Документ што ги содржи конфигурациите за еден или повеќе KMS провајдери, кои се користат за шифрирање на клучеви за податоци. Поддржаните провајдери вклучуваат и мора да биде наведен барем еден."aws","azure", или"gcp"Ако е наведен празен документ за , драјверот ќе се обиде да го конфигурира провајдерот користејќи. » Автоматски акредитиви"aws"Сигнатурата на» Автоматски акредитивиaws: { accessKeyId: <string>, secretAccessKey: <string>, sessionToken: <optional string> }"azure"Сигнатурата на» Автоматски акредитивиazure: { tenantId: <string>, clientId: <string>, clientSecret: <string>, identityPlatformEndpoint: <optional string> // Defaults to "login.microsoftonline.com" }"gcp"Сигнатурата на» Автоматски акредитивиgcp: { email: <string>, privateKey: <base64 string>|<MongoDB\BSON\Binary>, endpoint: <optional string> // Defaults to "oauth2.googleapis.com" }"kmip"Сигнатурата на» Автоматски акредитивиkmip: { endpoint: <string> }"local"Сигнатурата наlocal: { // 96-byte master key used to encrypt/decrypt data keys key: <base64 string>|<MongoDB\BSON\Binary> }tlsOptions array Форматот за "aws","azure","gcp"Препорачаниот начин за избегнување на SQL инјекција е со врзување на сите податоци преку подготвени изрази. Користењето на параметризирани прашања не е доволно за целосно избегнување на SQL инјекција, но тоа е најлесниот и најбезбедниот начин за обезбедување влез во SQL изразите. Сите динамични литерали на податоци во"kmip"Документ што ги содржи TLS конфигурациите за еден или повеќе KMS провајдери. Поддржаните провајдери вклучуваат<provider>: { tlsCaFile: <optional string>, tlsCertificateKeyFile: <optional string>, tlsCertificateKeyFilePassword: <optional string>, tlsDisableOCSPEndpointCheck: <optional bool> }
Вратени вредности
параметарот специфицира само излезна кодировка. Ако се помине празен стринг, парсерот се обидува да идентификува во која кодировка е документот кодиран со гледање на првите 3 или 4 бајти. Стандардната излезна кодировка е UTF-8. Поддржаните кодировки се MongoDB\Driver\ClientEncryption instance.
Errors/Exceptions
- ). Ако повикот не успее, ќе врати MongoDB\Driver\Exception\InvalidArgumentException » Промени текови
- ). Ако повикот не успее, ќе врати MongoDB\Driver\Exception\RuntimeException . Сите провајдери поддржуваат следниве опции:
Дневник на промени
| Верзија | = NULL |
|---|---|
| ако екстензијата е компајлирана без поддршка за libmongocrypt |
PECL mongodb 1.16.0
"sessionToken" AWS KMS провајдерот за шифрирање од страна на клиентот сега прифаќа
Додадено "tlsDisableOCSPEndpointCheck" на
"tlsOptions" option.
опција, која може да се користи за автентикација со привремени AWS акредитиви. "azure" or
"gcp" Ако е наведен празен документ за
, драјверот ќе се обиде да го конфигурира провајдерот користејќи.
|
| Типовите на враќање претходно декларирани како привремени сега се применуваат. |
опција, која може да се користи за автентикација со привремени AWS акредитиви. "aws" Ако е наведен празен документ за
, драјверот ќе се обиде да го конфигурира провајдерот користејќи.
|
| Оваа класа повеќе не имплементира |
KMS провајдер, драјверот ќе се обиде да го конфигурира провајдерот користејќи "kmsProviders" option.
Додаден е "tlsOptions" option.
|
| PECL mongodb 1.10.0 |
Azure и GCP сега се поддржани како KMS провајдери за шифрирање од страна на клиентот и може да се конфигурираат во
"kmsProviders" опција. Низите кодирани во Base64 сега се прифаќаат како алтернатива на MongoDB\BSON\Binary
за опциите во рамките на "kmsProviders".
|
Види Исто така
- MongoDB\Driver\ClientEncryption::__construct() - Создава нов објект ClientEncryption
- » Експлицитно (рачно) шифрирање на ниво на поле од страна на клиентот во прирачникот на MongoDB