MongoDB\Driver\ClientEncryption::rewrapManyDataKey

    (mongodb >=1.15.0)

    MongoDB\Driver\ClientEncryption::rewrapManyDataKey — Re-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 » atributo de la consulta. Un atributo vacío hará coincidir todos los documentos de la colección.

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

    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. Por omisión, 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. Por omisión, se utiliza la versión primaria de la clave.
    endpoint string Opcional. Host con puerto opcional. El valor por omisión 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 verdadero, esta clave debe ser descifrada por el servidor KMIP.

    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

    • Lanza una excepción MongoDB\Driver\AuthenticationException si se requiere una identificación pero falla
    • Lanza una excepción MongoDB\Driver\ConnectionException si la conexión al servidor falla por una razón distinta a un problema de identificación
    • Lanza una MongoDB\Driver\Exception\EncryptionException si ocurre un error durante el descifrado o recifrado de una clave de datos.
    • Lanza una MongoDB\Driver\Exception\RuntimeException en otros errores.

    Historial de cambios

    Versión Descripción
    PECL mongodb 1.20.0 Adición de "delegated" a las opciones masterKey del proveedor 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.
    To Top