MongoDB\Driver\ClientEncryption::rewrapManyDataKey
(mongodb >=1.15.0)
MongoDB\Driver\ClientEncryption::rewrapManyDataKey — Rewraps data keys
Descrição
$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 » predicado de consulta. Um predicado vazio corresponderá a todos os documentos da coleção.
Nota: 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 -
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".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
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/Exceções
- Lança uma exceção MongoDB\Driver\Exception\InvalidArgumentException em caso de erro ao analisar argumentos.
- Lança uma exceção MongoDB\Driver\Exception\ConnectionException se a conexão com o servidor falhar (por outros motivos além da autenticação).
- Lança uma exceção MongoDB\Driver\Exception\AuthenticationException se a autenticação for necessária e falhar.
- Throws MongoDB\Driver\Exception\EncryptionException if an error occurs while decrypting or re-encrypting a data key.
- Throws MongoDB\Driver\Exception\RuntimeException on other errors.
add a note
