PHP Conference Kansai 2025

MongoDB\Driver\ClientEncryption::rewrapManyDataKey

(mongodb >=1.15.0)

MongoDB\Driver\ClientEncryption::rewrapManyDataKeyRe-embala las claves de datos

Descripción

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

Re-embala (es decir, descifra y vuelve a cifrar) cero o más claves de datos en la colección de caja fuerte de claves que coinciden con el filter dado.

Si la opción "provider" no se especifica, las claves de datos coincidentes serán re-embaladas con su proveedor KMS actual. De lo contrario, las claves de datos coincidentes serán recifradas según las opciones "provider" y "masterKey" especificadas.

Parámetros

filter (array|object)

El » predicado de la consulta. Un predicado vacío coincidirá con todos los documentos de una colección.

Nota: Al evaluar criterios de consulta, MongoDB compara tipos y valores según sus propias » reglas de comparación para tipos BSON, lo cual difiere de las reglas de comparación y manejo de tipos de PHP. Al encontrar un tipo BSON especial, los criterios de consulta deben utilizar la clase BSON respectiva (p.ej. usar MongoDB\BSON\ObjectID al encontrar un » ObjectID).

options

Opciones de RewrapManyDataKey
Option Type Description
provider string

El proveedor KMS (por ejemplo "local", "aws") que será utilizado para recifrar las claves de datos coincidentes.

Si un proveedor KMS no se especifica, las claves de datos coincidentes serán recifradas con su proveedor KMS actual.

masterKey array

La clave masterKey identifica una clave específica a un KMS utilizada para cifrar la nueva clave de datos. Esta opción no debe ser especificada sin la opción "provider". Esta opción es requerida si "provider" es especificado y no es "local".

"aws" provider options
Option Type Description
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 options
Option Type Description
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 options
Option Type Description
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 options
Option Type Description
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.
delegated bool Optional. If true, this key should be decrypted by the KMIP server.

Valores devueltos

Devuelve un objeto, que eventualmente tendrá una propiedad bulkWriteResult conteniendo el resultado de la operación bulkWrite interna en forma de un objeto. Si ninguna clave de datos coincidió con el filtro o si la escritura no fue acusada, la propiedad bulkWriteResult será null.

Errores/Excepciones

Historial de cambios

Versión Descripción
PECL mongodb 1.20.0 Adición de "delegated" a las opciones masterKey del proveedor KMIP.

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top