KeyVault.deleteKey() (método mongosh)

KeyVault.deleteKey(UUID)

Borra una llave de cifrado de datos con el UUID especificado del almacén de claves asociado a la conexión de la base de datos.

deleteKey() tiene la siguiente sintaxis:

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

El UUID es un objeto BSON binary data con subtipo 4.

Devuelve:	Un documento que indica el número de claves borradas.

Compatibilidad

Este comando está disponible en implementaciones alojadas en los siguientes entornos:

MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB
MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Comportamiento

Requiere configurar cifrado a nivel de campo del lado del cliente en la conexión a la base de datos.

Los métodos de cifrado a nivel de campo del lado del cliente mongosh requieren una conexión de base de datos con cifrado habilitado a nivel de campo en el lado del cliente. Si la conexión actual de la base de datos no se inició con el cifrado del lado del cliente a nivel de campo habilitado, entonces:

Utilice el Mongo() constructor de mongosh para establecer una conexión con las opciones necesarias de cifrado de nivel de campo del lado del cliente. El método Mongo() es compatible con los siguientes proveedores de Key Management Service (KMS) para la gestión de la llave maestra de cliente (CMK):
or
Utilice las opciones de línea de comandos mongosh para establecer una conexión con las opciones requeridas. Las opciones de la línea de comandos solo admiten el proveedor Amazon Web Services KMS para la gestión de la llave maestra de cliente.

Ejemplo

El siguiente ejemplo está pensado para la evaluación rápida del cifrado de campos del lado del cliente. Para ver ejemplos específicos del uso de KeyVault.deleteKey() con cada proveedor KMS compatible, consulte Eliminar una clave de cifrado de datos.

Inicia mongosh

Inicie el cliente mongosh.

mongosh --nodb

Genere su clave

Para configurar el cifrado a nivel de campo del lado del cliente para una clave gestionada localmente, genera una string de 96 bytes codificada en base64 sin saltos de línea.

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

Crea las opciones de cifrado a nivel de campo del lado del cliente

Cree las opciones de cifrado a nivel de campo del lado del cliente usando la string de clave local generada:

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

Crea tu cliente cifrado

Utiliza el Mongo() constructor con las opciones de cifrado a nivel de campo del lado del cliente configuradas para crear una conexión a la base de datos. Reemplace el URI mongodb://myMongo.example.net por el URI de la cadena de conexión del clúster de destino.

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

Recupera el objeto KeyVault y utiliza el método KeyVault.deleteKey() para eliminar la clave de cifrado de datos que coincida con UUID:

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

Si la respuesta es exitosa, deleteKey() devuelve una salida similar a la siguiente:

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

Tip

Borrar una llave de cifrado de datos

Volver

KeyVault.createKey

KeyVault.getKey