KeyVault.deleteKey()

Esta versión de la documentación se archivó y ya no se admite. Para actualizar tu implementación de 5.0, consulta el Procedimientos de actualización de MongoDB 6.0 .

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.

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.

Sintaxis

deleteKey() tiene la siguiente sintaxis:

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

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

Comportamiento

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

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

Utilice el constructor Mongo() desde la mongo shell para establecer una conexión con las opciones de cifrado a nivel de campo del lado del cliente requeridas. El método Mongo() admite los siguientes proveedores de Key Management Service (KMS) para la gestión de la llave maestra de cliente (llave maestra de cliente):
or
Utiliza las mongo opciones de línea de comandos del shell para establecer una conexión con las opciones requeridas. Las opciones de línea de comandos solo son compatibles con el proveedor de Amazon Web Services KMS para la gestión de llave maestra de cliente.

Ejemplo

El siguiente ejemplo está destinado a una evaluación rápida del cifrado a nivel de campo del lado del cliente. Para ejemplos específicos de cómo usar KeyVault.deleteKey() con cada proveedor KMS compatible, consulta Remover una llave de cifrado de datos.

Configurar el cifrado a nivel de campo del lado del cliente para una clave gestionada localmente requiere especificar una string de 96 bytes codificada en base64, sin saltos de línea. La siguiente operación genera una clave que cumple los requisitos establecidos y la carga en la shell mongo :

TEST_LOCAL_KEY=$(echo "$(head -c 96 /dev/urandom | base64 | tr -d '\n')")
mongosh --nodb --shell --eval "var TEST_LOCAL_KEY='$TEST_LOCAL_KEY'"

Cree el objeto de cifrado a nivel de campo lado del cliente mediante el string de clave local generado:

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

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

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

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

Remover una llave de cifrado de datos

Volver

KeyVault.createKey

KeyVault.getKey