MongoDB\Driver\ClientEncryption::__construct
(mongodb >=1.14.0)
MongoDB\Driver\ClientEncryption::__construct — Create a new ClientEncryption object
Beschreibung
$options
)Constructs a new MongoDB\Driver\ClientEncryption object with the specified options.
Parameter-Liste
-
options
-
options Option Type Description keyVaultClient MongoDB\Driver\Manager The Manager used to route data key queries. This option is required (unlike with MongoDB\Driver\Manager::createClientEncryption()). keyVaultNamespace string Ein vollständig qualifizierter Namensraum (z.B. "databaseName.collectionName"
), der die Kollektion bezeichnet, die alle Datenschlüssel enthält, die für Ver- und Entschlüsselung verwendet werden.kmsProviders array Ein Dokument, das die Konfiguration für einen oder mehrere KMS-Provider enthält, die verwendet werden, um Datenschlüssel zu verschlüsseln. Zu den unterstützten Providern gehören
"aws"
,"azure"
,"gcp"
,"kmip"
und"local"
und wenigstens einer muss angegeben werden.Das Format für
"aws"
ist wie folgt:aws: { accessKeyId: <string>, secretAccessKey: <string> }
Das Format für
"azure"
ist wie folgt:azure: { tenantId: <string>, clientId: <string>, clientSecret: <string>, identityPlatformEndpoint: <optional string> // Der Standardwert ist "login.microsoftonline.com" }
Das Format für
"gcp"
ist wie folgt:gcp: { email: <string>, privateKey: <base64 string>|<MongoDB\BSON\Binary>, endpoint: <optional string> // Der Standardwert ist "oauth2.googleapis.com" }
Das Format für
"kmip"
ist wie folgt:kmip: { endpoint: <string> }
Das Format für
"local"
ist wie folgt:local: { // Der 96-Byte-Hauptschlüssel, der zur Ver- und Entschlüsselung von // Datenschlüsseln verwendet wird key: <base64 string>|<MongoDB\BSON\Binary> }
tlsOptions Array Ein Dokument, das die TLS-Konfiguration für einen oder mehrere KMS-Provider enthält. Zu den unterstützten Providern gehören
"aws"
,"azure"
,"gcp"
und"kmip"
. Alle Provider unterstützen die folgenden Optionen:<provider>: { tlsCaFile: <optionale Zeichenkette>, tlsCertificateKeyFile: <optionale Zeichenkette>, tlsCertificateKeyFilePassword: <optionale Zeichenkette> }
Fehler/Exceptions
- Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
- Throws MongoDB\Driver\Exception\RuntimeException if the extension was compiled without libmongocrypt support
Siehe auch
- MongoDB\Driver\Manager::createClientEncryption() - Create a new ClientEncryption object
- » Explicit (Manual) Client-Side Field Level Encryption in the MongoDB manual