(mongodb >=1.7.0)
MongoDB\Driver\Manager::createClientEncryption — Create a new ClientEncryption object
$options
): MongoDB\Driver\ClientEncryptionConstructs a new MongoDB\Driver\ClientEncryption object with the specified options.
options
Option | Type | Description |
---|---|---|
keyVaultClient | MongoDB\Driver\Manager | Менеджер, який використовується для маршрутизації запитів ключів даних до окремого кластера MongoDB. Початково використовується поточний менеджер і кластер. |
keyVaultNamespace | string | Повна назва простору імен (напр.
"databaseName.collectionName" ), що позначає
колекцію, яка містить усі ключі даних, що використовуються для
шифрування та дешифрування. Цей параметр є обов'язковим. |
kmsProviders | array |
Документ, що містить налаштування для одного або кількох
KMS-провайдерів, які використовуються для шифрування ключів даних.
Підтримувані провайдери:
Якщо вказано порожній документ для
Формат для aws: { accessKeyId: <string>, secretAccessKey: <string>, sessionToken: <string (необов'язковий)> }
Формат для azure: { tenantId: <string>, clientId: <string>, clientSecret: <string>, identityPlatformEndpoint: <string (необов'язковий)> // Початково: "login.microsoftonline.com" }
Формат для gcp: { email: <string>, privateKey: <base64 string>|<MongoDB\BSON\Binary>, endpoint: <string (необов'язковий)> // Початково: "oauth2.googleapis.com" }
Формат для kmip: { endpoint: <string> }
Формат для local: { // 96-байтний головний ключ, що застосовується для шифрування/дешифрування ключів даних key: <base64 string>|<MongoDB\BSON\Binary> } |
tlsOptions | array |
Документ, який містить налаштування TLS для одного або кількох
KMS-провайдерів. Підтримуються такі провайдери:
<provider>: { tlsCaFile: <string> (необов'язковий), tlsCertificateKeyFile: <string> (необов'язковий), tlsCertificateKeyFilePassword: <string> (необов'язковий), tlsDisableOCSPEndpointCheck: <bool> (необов'язковий) } |
Returns a new MongoDB\Driver\ClientEncryption instance.
Версія | Опис |
---|---|
PECL mongodb 1.16.0 |
The AWS KMS provider for client-side encryption now accepts a
Added
If an empty document is specified for the |
PECL mongodb 1.15.0 |
If an empty document is specified for the |
PECL mongodb 1.12.0 |
KMIP is now supported as a KMS provider for client-side encryption and
may be configured in the
Added the |
PECL mongodb 1.10.0 |
Azure and GCP are now supported as KMS providers for client-side
encryption and may be configured in the
"kmsProviders" option. Base64-encoded strings are now
accepted as an alternative to MongoDB\BSON\Binary
for options within "kmsProviders" .
|