Métodos de criptografia em execução

Observação

Para obter detalhes sobre um método específico, incluindo sintaxe e exemplos, clique no link para a página de referência do método.

Os métodos mongosh ClientEncryption exigem uma conexão de banco de dados com a criptografia em uso ativada. Se a conexão atual do banco de dados não tiver sido iniciada com a criptografia em uso ativada, faça o seguinte:

Use o construtor Mongo() do mongosh para estabelecer uma conexão com as opções de criptografia em uso necessárias. O método Mongo() é compatível com os seguintes provedores de KMS (KMS) para o gerenciamento da chave mestra do cliente (CMK):
ou
Utilize as mongosh opções da linha de comando para estabelecer uma conexão com as opções exigidas. As opções de linha de comando são compatíveis apenas com o provedor Amazon Web Services KMS para gerenciamento da chave mestra do cliente.

Os métodos a seguir são mongosh apenas para. Para obter instruções sobre como implementar a criptografia no nível do campo do lado do cliente (CSFLE) ou a Queryable Encryption (QE) usando um driver MongoDB , consulte a documentação do driver. Consulte Compatibilidade de criptografia em nível de campo do lado do cliente ou Compatibilidade de Queryable Encryption para obter os drivers compatíveis.

Os comandos com aliases são agrupados.

Nome	CSFLE	QE	Descrição
`getKeyVault()`	✓	✓	Retorna o objeto cofre de chaves da conexão do MongoDB atual.
`KeyVault.createKey()` `KeyVault.createDataKey()`	✓	✓	Cria uma chave de criptografia de dados para uso na criptografia no nível do campo no lado do cliente.
`KeyVault.deleteKey()`	✓	✓	Exclui a chave de criptografia de dados especificada do cofre de chaves.
`KeyVault.getKey()`	✓	✓	Recupera a chave de criptografia de dados especificada do cofre de chaves.
`KeyVault.getKeys()`	✓	✓	Recupera todas as chaves no cofre de chaves.
`KeyVault.addKeyAlternateName()` `KeyVault.addKeyAltName()`	✓	✓	Associa um nome alternativo de chave ao diretório de dados especificado.
`KeyVault.removeKeyAlternateName()` `KeyVault.removeKeyAltName()`	✓	✓	Remove um nome alternativo de chave do diretório de dados especificado.
`KeyVault.getKeyByAltName()`	✓	✓	Recupera chaves com o nome alternativo de chave especificado.
`KeyVault.rewrapManyDataKey()`	✓	✓	Descriptografa várias chaves de dados e as criptografa novamente com uma nova chave mestre.
`getClientEncryption()`	✓	✓	Retorna o objeto de criptografia do cliente para oferecer suporte à criptografia/descriptografia explícita de campos.
`ClientEncryption.createEncryptedCollection()`	✓	✓	Cria uma coleção com campos criptografados.
`ClientEncryption.encrypt()`	✓	✓	Criptografa um campo usando uma chave de criptografia de dados especificada e o algoritmo de criptografia.
`ClientEncryption.encryptExpression()`		✓	Criptografa uma expressão de query utilizando uma chave de criptografia de dados especificada e opções de criptografia.
`ClientEncryption.decrypt()`	✓	✓	Descriptografa um campo usando a chave de criptografia de dados associada e o algoritmo de criptografia.

Voltar

SessionOptions

ClientEncryption.createEncryptedCollection