MongoDB\Driver\ClientEncryption::rewrapManyDataKey
(mongodb >=1.15.0)
MongoDB\Driver\ClientEncryption::rewrapManyDataKey — Rewraps data keys
Beschreibung
$filter, ?array $options = null): object
Rewraps (i.e. decrypts and re-encrypts) zero or more data keys in the key
vault collection that match the given filter.
If the "provider" option is not specified, matching data
keys will be rewrapped with their current KMS provider. Otherwise, matching
data keys will be re-encrypted according to the specified
"provider" and "masterKey" options.
Parameter-Liste
-
filter(array|object) -
Das » Abfrage-Prädikat. Ein leeres Prädikat passt auf alle Dokumente in der Sammlung.
Hinweis: Bei der Auswertung von Abfragekriterien vergleicht MongoDB Typen und Werte gemäß seiner eigenen » Vergleichsregeln für BSON-Typen, die sich von PHPs Regeln für Typenvergleich und Typen-Jonglage unterscheidet. Wenn es eine Übereinstimmung mit einem speziellen BSON-Typ gibt, sollten die Abfragekriterien die entsprechende BSON-Klasse verwenden (z. B. MongoDB\BSON\ObjectId, um auf eine » ObjectId zu passen).
-
options -
RewrapManyDataKey options Option Type Description provider string The KMS provider (e.g.
"local","aws") that will be used to re-encrypt the matched data keys.If a KMS provider is not specified, matched data keys will be re-encrypted with their current KMS provider.
masterKey array The masterKey identifies a KMS-specific key used to encrypt the new data key. This option should not be specified without the
"provider"option. This option is required if"provider"is specified and not"local"."aws"provider optionsOption Typ Beschreibung region string Required. key string Required. The Amazon Resource Name (ARN) to the AWS customer master key (CMK). endpoint string Optional. An alternate host identifier to send KMS requests to. May include port number. "azure"provider optionsOption Typ Beschreibung keyVaultEndpoint string Required. Host with optional port (e.g. "example.vault.azure.net"). keyName string Required. keyVersion string Optional. A specific version of the named key. Defaults to using the key's primary version. "gcp"provider optionsOption Typ Beschreibung projectId string Required. location string Required. keyRing string Required. keyName string Required. keyVersion string Optional. A specific version of the named key. Defaults to using the key's primary version. endpoint string Optional. Host with optional port. Defaults to "cloudkms.googleapis.com". "kmip"provider optionsOption Typ Beschreibung keyId string Optional. Unique identifier to a 96-byte KMIP secret data managed object. If unspecified, the driver creates a random 96-byte KMIP secret data managed object. endpoint string Optional. Host with optional port.
Rückgabewerte
Returns an object, which will have an optional
bulkWriteResult property containing the result of the
internal bulkWrite operation as an object. If no data keys
matched the filter or the write was unacknowledged, the
bulkWriteResult property will be null.
Fehler/Exceptions
- Wirft eine MongoDB\Driver\Exception\InvalidArgumentException, wenn beim Analysieren von Argumenten ein Fehler auftritt.
- Wirft eine MongoDB\Driver\Exception\ConnectionException, wenn der Aufbau einer Verbindung zum Server fehlschlägt (aus einem anderen Grund als der Authentifizierung).
- Wirft eine MongoDB\Driver\Exception\AuthenticationException, wenn eine Authentifizierung erforderlich ist und fehlschlägt.
- Throws MongoDB\Driver\Exception\EncryptionException if an error occurs while decrypting or re-encrypting a data key.
- Throws MongoDB\Driver\Exception\RuntimeException on other errors.
add a note
