KeyVault.deleteKey() (método mongosh)

KeyVault.deleteKey(UUID)

Exclui uma chave de encriptação de dados com o UUID especificado do cofre de chave associado à conexão do banco de dados.

deleteKey() tem a seguinte sintaxe:

keyVault = db.getMongo().getKeyVault()
keyVault.deleteKey(UUID("<UUID String>"))

O UUID é um objeto BSON binary data com subtipo 4.

Retorna:	Um documento que indica o número de chaves excluídas.

Compatibilidade

Esse comando está disponível em implantações hospedadas nos seguintes ambientes:

MongoDB Atlas: o serviço totalmente gerenciado para implantações do MongoDB na nuvem

MongoDB Enterprise: a versão autogerenciada e baseada em assinatura do MongoDB
MongoDB Community: uma versão com código disponível, de uso gratuito e autogerenciada do MongoDB

Comportamento

Requer a configuração da criptografia no nível do campo do lado do cliente na conexão do reconhecimento de data center

Os mongosh ClientEncryption métodos 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 Mongo() construtor do mongosh para estabelecer uma conexão com as opções de criptografia em uso necessárias. O método Mongo() suporta os seguintes fornecedores de KMS (KMS) para 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.

Exemplo

O exemplo a seguir destina-se à avaliação rápida da criptografia no nível do campo do lado do cliente. Para obter exemplos específicos de uso de KeyVault.deleteKey() com cada provedor de KMS compatível, consulte Excluir uma chave de criptografia de dados.

Inicie o mongosh

Inicie o cliente mongosh .

mongosh --nodb

Gere sua chave

Para configurar a criptografia no nível do campo do lado do cliente para uma chave managed localmente, gere uma cadeia de 96 bytes codificada em base64 sem quebras de linha.

const TEST_LOCAL_KEY = require("crypto").randomBytes(96).toString("base64")

Criar as opções de criptografia em nível de campo do lado do cliente

Crie as opções de criptografia no nível do campo do lado do cliente usando a string de chave local gerada:

 let autoEncryptionOpts = {   "keyVaultNamespace" : "encryption.__dataKeys",   "kmsProviders" : {     "local" : {       "key" : BinData(0, TEST_LOCAL_KEY)     }   } }

Crie seu cliente criptografado

Use o construtor Mongo() com as opções de criptografia de nível de campo do lado do cliente configuradas para criar uma conexão com o reconhecimento de data center. Substitua o URI mongodb://myMongo.example.net pelo URI da string de conexão do cluster de destino.

encryptedClient = Mongo(  "mongodb://myMongo.example.net:27017/?replSetName=myMongo",   autoEncryptionOpts)

Recupere o objeto KeyVault e use o método KeyVault.deleteKey() para excluir a chave de criptografia de dados com UUID correspondente:

keyVault = encryptedClient.getKeyVault()keyVault.deleteKey(UUID("b4b41b33-5c97-412e-a02b-743498346079"))

Se for bem-sucedido, deleteKey() retornará uma saída semelhante a esta:

{ "acknowledged" : true, "deletedCount" : 1 }

Dica

Excluir uma Data Encryption Key (DEK)

Voltar

KeyVault.createKey

KeyVault.getKey