MongoDB\Driver\ClientEncryption::rewrapManyDataKey

(mongodb >=1.15.0)

MongoDB\Driver\ClientEncryption::rewrapManyDataKey — Reencapsula chaves de dados

Descrição

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

Reencapsula (ou seja, descriptografa e criptografa novamente) zero ou mais chaves de dados na coleção de cofres de chaves que correspondem ao filtro fornecido no parâmetro filter.

Se a opção "provider" não for especificada, as chaves de dados correspondentes serão reencapsuladas com seu provedor KMS atual. Caso contrário, as chaves de dados correspondentes serão criptografadas novamente de acordo com as opções "provider" e "masterKey" especificadas.

Parâmetros

filter (array|object)

O » predicado de consulta. Um predicado vazio corresponderá a todos os documentos da coleção.

Note: Ao avaliar os critérios de consulta, o MongoDB compara os tipos e valores de acordo com suas próprias » regras de comparação para tipos BSON, que diferem das regras de comparação e do malabarismo de tipos do PHP. Ao corresponder a um tipo especial de BSON, os critérios de consulta devem usar a respectiva classe BSON (por exemplo, use MongoDB\BSON\ObjectId para corresponder a um » ObjectId).

options

Opções de RewrapManyDataKey
Opção Tipo Descrição
provider string

O provedor KMS (por exemplo, "local", "aws") que será usado para criptografar novamente as chaves de dados correspondentes.

Se um provedor KMS não for especificado, as chaves de dados correspondentes serão criptografadas novamente com seu provedor KMS atual.

masterKey array

A masterKey identifica uma chave específica do KMS usada para criptografar a nova chave de dados. Esta opção não deve ser especificada sem a opção "provider". Esta opção é necessária se "provider" for especificada e não "local".

Opções do provedor "aws"
Opção Tipo Descrição
region string Obrigatória.
key string Obrigatória. O Nome de Recurso da Amazon (ARN) para a chave mestra do cliente (CMK) da AWS.
endpoint string Opcional. Um identificador de servidor alternativo para o qual enviar requisições KMS. Pode incluir o número da porta.

Opções do provedor "azure"
Opção Tipo Descrição
keyVaultEndpoint string Obrigatória. Servidor com porta opcional (por exemplo, "example.vault.azure.net").
keyName string Obrigatória.
keyVersion string Opcional. Uma versão específica da chave nomeada. O padrão é usar a versão primária da chave.

Opções do provedor "gcp"
Opção Tipo Descrição
projectId string Obrigatória.
location string Obrigatória.
keyRing string Obrigatória.
keyName string Obrigatória.
keyVersion string Opcional. Uma versão específica da chave nomeada. O padrão é usar a versão primária da chave.
endpoint string Opcional. Servidor com porta opcional. O padrão é "cloudkms.googleapis.com".

Opções do provedor "kmip"
Opção Tipo Descrição
keyId string Opcional. Identificador único 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. Servidor com porta opcional.

Valor Retornado

Retorna um objeto, que terá uma propriedade opcional bulkWriteResult contendo o resultado da operação interna bulkWrite como um objeto. Se nenhuma chave de dados corresponder ao filtro ou a gravação não for reconhecida, a propriedade bulkWriteResult será null.

Erros/Exceções