MongoDB\Driver\ClientEncryption::rewrapManyDataKey

(mongodb >=1.15.0)

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

Description

final public function 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

Options de RewrapManyDataKey
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.
add a note

User Contributed Notes

There are no user contributed notes for this page.