MongoDB\Driver\ClientEncryption::rewrapManyDataKey

MongoDB\Driver\ClientEncryption::rewrapManyDataKey

Reenvuelve claves de datos

Descripción#

php final public MongoDB\Driver\ClientEncryption::rewrapManyDataKey(array $filter, [array $options]): objectphp

Reenvuelve (es decir, descifra y vuelve a cifrar) cero o más claves de datos en la colección de claves maestras que coincidan con el filter proporcionado.

Si no se especifica la opción "provider", las claves de datos coincidentes se reenvuelven con su proveedor KMS actual. De lo contrario, las claves de datos coincidentes se volverán a cifrar según las opciones "provider" y "masterKey" especificadas.

Parámetros#

filter (arrayobject)
El atributo de la consulta. Un atributo vacío hará coincidir todos los documentos de la colección.

[!NOTE] Al evaluar los criterios de consulta, MongoDB compara los tipos y los valores según sus propias reglas de comparación para los tipos BSON, que difieren de las reglas de comparación y de manipulación de tipos de PHP. Al hacer coincidir un tipo BSON especial, los criterios de consulta deben utilizar la clase BSON (ej.: utilizar MongoDB\BSON\ObjectId para hacer coincidir un ObjectId).

options

Opciones de RewrapManyDataKey

Opción	Tipo	Descripción
provider	string	El proveedor KMS (por ejemplo, "local", "aws") que se utilizará para volver a cifrar las claves de datos coincidentes. Si no se especifica un proveedor KMS, las claves de datos coincidentes se volverán a cifrar con su proveedor KMS actual.
masterKey	array	La clave maestra identifica una clave específica del KMS utilizada para cifrar la nueva clave de datos. Esta opción no debe especificarse sin la opción "provider". Esta opción es obligatoria si se especifica "provider" y no es "local". Opciones del proveedor "aws" Opción Tipo Descripción region string Requis. key string Requis. El nombre de recurso Amazon (ARN) de la clave maestra del cliente AWS (CMK). endpoint string Opcional. Un identificador de host alternativo para enviar las solicitudes KMS. Puede incluir el número de puerto. Opciones del proveedor "azure" Opción Tipo Descripción keyVaultEndpoint string Requis. Host con puerto opcional (por ejemplo, "example.vault.azure.net"). keyName string Requis. keyVersion string Opcional. Una versión específica de la clave nombrada. De forma predeterminada, se utiliza la versión primaria de la clave. Opciones del proveedor "gcp" Opción Tipo Descripción projectId string Requis. location string Requis. keyRing string Requis. keyName string Requis. keyVersion string Opcional. Una versión específica de la clave nombrada. De forma predeterminada, se utiliza la versión primaria de la clave. endpoint string Opcional. Host con puerto opcional. El valor predeterminado es "cloudkms.googleapis.com". Opciones del proveedor "kmip" Opción Tipo Descripción keyId string Opcional. Identificador único de un objeto gestionado de 96 bytes de datos secretos KMIP. Si no se especifica, el controlador crea un objeto gestionado aleatorio de 96 bytes de datos secretos KMIP. endpoint string Opcional. Host con puerto opcional. delegated bool Opcional. Si es true, esta clave debe ser descifrada por el servidor KMIP.

Valores devueltos#

Devuelve un objeto que tendrá una propiedad opcional bulkWriteResult que contiene el resultado de la operación interna bulkWrite como un objeto. Si ninguna clave de datos coincidió con el filtro o la escritura no fue reconocida, la propiedad bulkWriteResult será null.

Errores/Excepciones#

Lanza una excepción

MongoDB\Driver\Exception\InvalidArgumentException

en caso de error durante el análisis de un argumento.

Lanza una excepción

MongoDB\Driver\Exception\ConnectionException

si la conexión al servidor falla por una razón distinta a un problema de identificación

Lanza una excepción

MongoDB\Driver\Exception\AuthenticationException

si se requiere una identificación pero falla

Lanza

MongoDB\Driver\Exception\EncryptionException

si ocurre un error al descifrar o volver a cifrar una clave de datos.

Lanza

MongoDB\Driver\Exception\RuntimeException

en otros errores.

Historial de cambios#

Versión	Descripción
PECL mongodb 1.20.0	Se añadió "delegated" a las opciones de clave maestra del proveedor KMIP.