KeyVault.deleteKey()

Esta versión de la documentación está archivada y ya no recibe soporte. Para actualizar su implementación 5.0, consulte 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 eliminadas.

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>"))

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

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 de campo del lado del cliente requieren una conexión a la base de datos con el cifrado de campo del lado del cliente habilitado. Si la conexión actual a la base de datos no se inició con el cifrado de campo del lado del cliente habilitado, puede ocurrir lo mongo siguiente:

Utilice el Mongo() constructor del mongo shell para establecer una conexión con las opciones de cifrado de campo requeridas del lado del cliente. El método admite los siguientes proveedores de Servicios de Gestión de Claves (KMS) para la gestión de Mongo() la Clave Maestra del Cliente (CMK):
or
Utilice las opciones de línea mongo de comandos del shell para establecer una conexión con las opciones requeridas. Estas opciones solo son compatibles con el proveedor KMS de Amazon Web Services para la gestión de CMK.

Ejemplo

El siguiente ejemplo está diseñado para una evaluación rápida del cifrado a nivel de campo 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.

Para configurar el cifrado a nivel de campo del lado del64 96cliente para una clave administrada localmente, se requiere mongo especificar una cadena de bytes codificada en base sin saltos de línea. La siguiente operación genera una clave que cumple los requisitos indicados y la carga en el shell:

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)
    }
  }
}

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

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

Recupere el KeyVault objeto y utilice el método para eliminar la clave de cifrado de datos KeyVault.deleteKey() con UUID coincidente:

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

Si tiene éxito, devuelve un resultado similar aldeleteKey() siguiente:

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

Tip

Eliminar una clave de cifrado de datos

Volver

KeyVault.createKey

KeyVault.obtenerclave