MongoDB\Driver\ClientEncryption::__construct

(mongodb >=1.14.0)

MongoDB\Driver\ClientEncryption::__construct — CrĂ©er un nouvel objet ClientEncryption

Description

final public function MongoDB\Driver\ClientEncryption::__construct(array $options)

Construit un nouvel objet MongoDB\Driver\ClientEncryption avec les options spécifiées.

Liste de paramĂštres

options

options
Option Type Description
keyVaultClient MongoDB\Driver\Manager Le gestionnaire utilisĂ© pour router les requĂȘtes de clĂ© de donnĂ©es. Cette option est requise (contrairement Ă  MongoDB\Driver\Manager::createClientEncryption()).
keyVaultNamespace chaßne de caractÚres Un nom d'espace complÚtement qualifié (par exemple "databaseName.collectionName") dénotant la collection qui contient toutes les clés de données utilisé pour le chiffrement et déchiffrement. Cette option est requise.
kmsProviders tableau Un document contenant la configuration d'un ou plusieurs fournisseurs KMS, qui sont utilisĂ©s pour chiffrer les clĂ©s de donnĂ©es. Les fournisseurs supportĂ© sont "aws", "azure", "gcp" et "local", et au moins un doit ĂȘtre spĂ©cifiĂ©. Si un document vide est spĂ©cifiĂ© pour "aws", "azure", ou "gcp", le pilote tentera de configurer le fournisseur en utilisant » Automatic Credentials. Le format pour "aws" est le suivant :
aws: {
    accessKeyId: <string>,
    secretAccessKey: <string>,
    sessionToken: <optional string>
}
Le format pour "azure" est le suivant :
azure: {
    tenantId: <string>,
    clientId: <string>,
    clientSecret: <string>,
    identityPlatformEndpoint: <optional string> // Defaults to "login.microsoftonline.com"

}
Le format pour "gcp" est le suivant :
gcp: {
    email: <string>,
    privateKey: <base64 string>|<MongoDB\BSON\Binary>,
    endpoint: <optional string> // Defaults to "oauth2.googleapis.com"

}
Le format pour "kmip" est le suivant :
kmip: {
    endpoint: <string>
}
Le format pour "local" est le suivant :
local: {
    // 96-byte master key used to encrypt/decrypt data keys
    key: <base64 string>|<MongoDB\BSON\Binary>
}
tlsOptions array Un document contenant la configuration TLS d'un ou plusieurs fournisseurs KMS. Les fournisseurs supporté sont "aws", "azure", "gcp" et "kmip". Tous les fournisseurs supportent les options suivantes :
<provider>: {
    tlsCaFile: <optional string>,
    tlsCertificateKeyFile: <optional string>,
    tlsCertificateKeyFilePassword: <optional string>,
    tlsDisableOCSPEndpointCheck: <optional bool>
}

Erreurs / Exceptions

  • Lance une exception MongoDB\Driver\InvalidArgumentException lors d'une erreur survenue pendant l'analyse d'un argument.
  • Lance une MongoDB\Driver\Exception\RuntimeException si l'extension n'a pas Ă©tĂ© compilĂ©e avec le support libmongocrypt

Historique

Version Description
PECL mongodb 1.16.0 Le fournisseur AWS KMS pour le chiffrement cĂŽtĂ© client accepte dĂ©sormais une option "sessionToken", qui peut ĂȘtre utilisĂ©e pour s'authentifier avec des informations d'identification AWS temporaires. Ajout de "tlsDisableOCSPEndpointCheck" Ă  l'option "tlsOptions". Si un document vide est spĂ©cifiĂ© pour le fournisseur KMS "azure" ou "gcp", le pilote tentera de configurer le fournisseur en utilisant les » Les informations d'identification automatiques.
PECL mongodb 1.15.0 Si un document vide est spécifié pour le fournisseur KMS "aws", le pilote tentera de configurer le fournisseur en utilisant les » Les informations d'identification automatiques.

Voir aussi

add a note

User Contributed Notes

There are no user contributed notes for this page.