Métodos de criptografia no nível de campo do lado do cliente

O MongoDB 5.0 é o fim da vida útil a partir de de 2024 outubro. Esta versão da documentação não é mais suportada. Para atualizar sua 5.0 implantação do, consulte o MongoDB 6.0 procedimentos de atualizaçã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 de criptografia de nível de campo do lado do cliente mongo exigem uma conexão de banco de dados de dados com a criptografia de nível de campo do lado do cliente ativada. Se a conexão atual do banco de dados de dados não tiver sido iniciada com a criptografia em nível de campo do lado do cliente ativada, faça o seguinte:

Use o construtor Mongo() do shell mongo para estabelecer uma conexão com as opções de criptografia de nível de campo do lado do cliente necessárias. O método Mongo() suporta os seguintes fornecedores de serviço de gerenciamento de chaves (KMS) para gerenciamento da chave mestra do cliente (CMK):
ou
Use as opções da linha mongo de comando do shell para estabelecer uma conexão com as opções exigidas. As opções de linha de comando são compatíveis apenas com o fornecedor KMS do Amazon Web Services 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 em nível de campo do lado do cliente usando um driver MongoDB , consulte a documentação do driver. Consulte a Tabela de compatibilidade de drivers para obter uma lista completa de drivers compatíveis com criptografia em nível de campo no lado do cliente .

Nome	Descrição
`getKeyVault()`	Retorna o objeto cofre de chaves da conexão do MongoDB atual.
`KeyVault.createKey()`	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 o diretório de dados especificado do cofre de chaves.
`KeyVault.getKeys()`	Recupera todas as chaves no cofre de chaves.
`KeyVault.addKeyAlternateName()`	Associa um nome alternativo de chave ao diretório de dados especificado.
`KeyVault.removeKeyAlternateName()`	Remove um nome alternativo de chave do diretório de dados especificado.
`KeyVault.getKeyByAltName()`	Recupera chaves com o nome alternativo de chave especificado.
`getClientEncryption()`	Retorna o objeto de criptografia do cliente para oferecer suporte à criptografia/descriptografia explícita de campos.
`ClientEncryption.encrypt()`	Criptografa um campo usando uma chave de criptografia de dados especificada e o algoritmo de criptografia.
`ClientEncryption.decrypt()`	Descriptografa um campo usando a chave de criptografia de dados associada e o algoritmo de criptografia.

Voltar

Métodos nativos no mongosh

ClientEncryption.encrypt