MongoDB\Driver\ClientEncryption::rewrapManyDataKey

(mongodb >=1.15.0)

MongoDB\Driver\ClientEncryption::rewrapManyDataKey — Ré-emballe les clés de données

Description

final public MongoDB\Driver\ClientEncryption::rewrapManyDataKey(array|object $filter, ?array $options = null): object

Ré-emballe (c'est-à-dire déchiffre et rechiffre) zéro ou plusieurs clés de données dans la collection de coffre de clés qui correspondent au filter donné.

Si l'option "provider" n'est pas spécifiée, les clés de données correspondantes seront ré-emballées avec leur fournisseur KMS actuel. Sinon, les clés de données correspondantes seront rechiffrées selon les options "provider" et "masterKey" spécifiées.

Liste de paramètres

filter (array|object)

L'» attribut de la requête. Un attribut vide va faire correspondre tous les documents de la collection.

Note: Lors de l'évaluation des critères de requête, MongoDB compare les type et les valeurs en fonction de leur propre » règles de comparaison pour les types BSON, qui diffère des règles de comparaison et de manipulation des type de PHP. Lors de la correspondance d'un type BSON spcécial, les critères de requête doivent utiliser la classe BSON (ex. : utiliser MongoDB\BSON\ObjectId pour correspondre à un » ObjectId).

options

Option Type Description

provider

string

Le fournisseur KMS (par exemple "local", "aws") qui sera utilisé pour rechiffrer les clés de données correspondantes.

Si un fournisseur KMS n'est pas spécifié, les clés de données correspondantes seront rechiffrées avec leur fournisseur KMS actuel.

masterKey

array

La clé masterKey identifie une clé spécifique à un KMS utilisée pour chiffrer la nouvelle clé de données. Cette option ne doit pas être spécifiée sans l'option "provider". Cette option est requise si "provider" est spécifié et n'est pas "local".

**Options du fournisseur `"aws"`**
Option	Type	Description
region	string	Requis.
key	string	Requis. Le nom de ressource Amazon (ARN) de la clé maîtresse du client AWS (CMK).
endpoint	string	Optionnel. Un identifiant d'hôte alternatif pour envoyer les demandes KMS. Peut inclure le numéro de port.

**Options du fournisseur `"azure"`**
Option	Type	Description
keyVaultEndpoint	string	Requis. Hôte avec port optionnel (par exemple, "example.vault.azure.net").
keyName	string	Requis.
keyVersion	string	Optionnel. Une version spécifique de la clé nommée. Par défaut, la version primaire de la clé est utilisée.

**Options du fournisseur `"gcp"`**
Option	Type	Description
projectId	string	Requis.
location	string	Requis.
keyRing	string	Requis.
keyName	string	Requis.
keyVersion	string	Optionnel. Une version spécifique de la clé nommée. Par défaut, la version primaire de la clé est utilisée.
endpoint	string	Optionnel. Hôte avec port optionnel. La valeur par défaut est "cloudkms.googleapis.com".

**Options du fournisseur `"kmip"`**
Option	Type	Description
keyId	string	Optionnel. Identifiant unique d'un objet géré de 96 octets de données secrètes KMIP. S'il n'est pas spécifié, le pilote crée un objet géré aléatoire de 96 octets de données secrètes KMIP.
endpoint	string	Optionnel. Hôte avec port optionnel.
delegated	bool	Optionnel. Si vrai, cette clé devrait être déchiffrer par le serveur KMIP.

Valeurs de retour

Renvoie un objet, qui aura éventuellement une propriété bulkWriteResult contenant le résultat de l'opération bulkWrite interne sous forme d'un objet. Si aucune clé de données n'a correspondu au filtre ou si l'écriture n'a pas été acquittée, la propriété bulkWriteResult sera null.

Erreurs / Exceptions

Lance une exception MongoDB\Driver\AuthenticationException si une identification est nécessaire mais qu'elle échoue
Lance une exception MongoDB\Driver\ConnectionException si la connexion au serveur échoue pour une autre raison qu'en raison d'un problème d'identification
Lance une MongoDB\Driver\Exception\EncryptionException si une erreur se produit lors du déchiffrement ou du rechiffrement d'une clé de données.
Lance une MongoDB\Driver\Exception\RuntimeException sur d'autres erreurs.

Historique

Version	Description
PECL mongodb 1.20.0	Ajout de `"delegated"` aux options masterKey du fournisseur KMIP.

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes

There are no user contributed notes for this page.