MongoDB\Driver\ClientEncryption::rewrapManyDataKey

    (mongodb >=1.15.0)

    MongoDB\Driver\ClientEncryption::rewrapManyDataKey — Rewraps data keys

    Description

    finalpublicMongoDB\Driver\ClientEncryption::rewrapManyDataKey(array|object$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.

    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

    RewrapManyDataKey options
    OptionTypeDescription
    providerstring

    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.

    masterKeyarray

    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".

    Options du fournisseur "aws"
    OptionTypeDescription
    regionstringRequis.
    keystringRequis. Le nom de ressource Amazon (ARN) de la clé maîtresse du client AWS (CMK).
    endpointstringOptionnel. Un identifiant d'hôte alternatif pour envoyer les demandes KMS. Peut inclure le numéro de port.

    Options du fournisseur "azure"
    OptionTypeDescription
    keyVaultEndpointstringRequis. Hôte avec port optionnel (par exemple, "example.vault.azure.net").
    keyNamestringRequis.
    keyVersionstringOptionnel. 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"
    OptionTypeDescription
    projectIdstringRequis.
    locationstringRequis.
    keyRingstringRequis.
    keyNamestringRequis.
    keyVersionstringOptionnel. Une version spécifique de la clé nommée. Par défaut, la version primaire de la clé est utilisée.
    endpointstringOptionnel. Hôte avec port optionnel. La valeur par défaut est "cloudkms.googleapis.com".

    Options du fournisseur "kmip"
    OptionTypeDescription
    keyIdstringOptionnel. 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.
    endpointstringOptionnel. Hôte avec port optionnel.

    Valeurs de retour

    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.

    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
    • 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.
    To Top