MongoDB\Driver\Manager::createClientEncryption

(mongodb >=1.7.0)

MongoDB\Driver\Manager::createClientEncryptionCreate a new ClientEncryption object

Beschreibung

final public MongoDB\Driver\Manager::createClientEncryption ( array $options ) : MongoDB\Driver\ClientEncryption

Constructs a new MongoDB\Driver\ClientEncryption object with the specified options.

Parameter-Liste

options

options
Option Type Description
keyVaultClient MongoDB\Driver\Manager Der Manager, der verwendet wird, um Datenschlüssel-Abfragen auf einen anderen MongoDB-Cluster zu routen. Standardmäßig werden der aktuelle Manager und Cluster verwendet.
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 wird, um Datenschlüssel zu verschlüsseln. Zurzeit werden aws und local unterstützt, und wenigstens eines muss angegeben werden.

Das Format für aws ist wie folgt:

aws: {
    accessKeyId: <string>,
    secretAccessKey: <string>
}

Das Format für local ist wie folgt:

local: {
    // Der Hauptschlüssel, der zur Ver- und Entschlüsselung von Datenschlüsseln verwendet wird
    key: <96 Byte MongoDB\BSON\Binary mit Untertyp 0>
}

Rückgabewerte

Returns a new MongoDB\Driver\ClientEncryption instance.

Fehler/Exceptions