(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 | O Manager usado para rotear consultas de chave de dados para um cluster MongoDB separado. Por padrão, o Manager e o cluster atuais são usados. |
| keyVaultNamespace | string | Um namespace totalmente qualificado (por exemplo, "nomeDoBancoDados.nomeDaColecao") denotando a coleção que contém todas as chaves de dados usadas para criptografia e descriptografia. Esta opção é obrigatória. |
| kmsProviders | array |
Um documento contendo a configuração de um ou mais provedores KMS, que são usados para criptografar chaves de dados. Os provedores compatíveis incluem
O formato para aws: {
accessKeyId: <string>,
secretAccessKey: <string>,
sessionToken: <string opcional>
}
O formato para azure: {
tenantId: <string>,
clientId: <string>,
clientSecret: <string>,
identityPlatformEndpoint: <string opcional> // O padrão é "login.microsoftonline.com"
}
O formato para gcp: {
email: <string>,
privateKey: <string base64>|<MongoDB\BSON\Binary>,
endpoint: <string opcional> // O padrão é "oauth2.googleapis.com"
}
O formato para kmip: {
endpoint: <string>
}
O formato para local: {
// Chave mestra de 96 bytes usada para criptografar/descriptografar chaves de dados
key: <string base64>|<MongoDB\BSON\Binary>
}
|
| tlsOptions | array |
Um documento contendo a configuração TLS para um ou mais provedores KMS. Os provedores suportados incluem <provider>: {
tlsCaFile: <string opcional>,
tlsCertificateKeyFile: <string opcional>,
tlsCertificateKeyFilePassword: <string opcional>,
tlsDisableOCSPEndpointCheck: <booleano opcional>
}
|
Returns a new MongoDB\Driver\ClientEncryption instance.
| Versão | Descrição |
|---|---|
| PECL mongodb 1.16.0 |
The AWS KMS provider for client-side encryption now accepts a
|
| 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".
|