MongoDB\Driver\ClientEncryption::rewrapManyDataKey

(mongodb >=1.15.0)

MongoDB\Driver\ClientEncryption::rewrapManyDataKeyRewraps data keys

Descrição

final public MongoDB\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.

Parâmetros

filter (array|object)

O filtro de busca.

options

RewrapManyDataKey options
Option Type Description
provider string

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.

masterKey array

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

"aws" opções do provedor
Option Type Description
region string Requerido.
key string Requerido. O nome de recurso da Amazon (ARN) para a chave mestra do cliente (CMK) da AWS.
endpoint string Opcional. Um identificador de host alternativo para o qual enviar solicitações KMS. Pode incluir o número da porta.

"azure" opções do provedor
Option Type Description
keyVaultEndpoint string Requerido. Host com porta opcional (e.g. "example.vault.azure.net").
keyName string Requerido.
keyVersion string Opcional. Uma versão específica da chave nomeada. Padrões para usar a versão da chave primária.

"gcp" opções do provedor
Option Type Description
projectId string Requerido.
location string Requerido.
keyRing string Requerido.
keyName string Requerido.
keyVersion string Opcional. Uma versão específica da chave nomeada. O padrão é usar a versão principal da chave.
endpoint string Opcional. Host com porta opcional. O padrão é "cloudkms.googleapis.com".

"kmip" opções do provedor
Option Type Description
keyId string Opcional. Identificador exclusivo para um objeto gerenciado de dados secretos KMIP de 96 bytes. Se não especificado, o driver cria um objeto gerenciado de dados secretos KMIP aleatório de 96 bytes.
endpoint string Opcional. Host com porta opcional.

Valor Retornado

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.

Erros

add a note

User Contributed Notes

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