KeyVault.removeKeyAlternateName() (método mongosh)

KeyVault.removeKeyAlternateName(UUID, keyAltName)

Remueve el keyAltName especificado de la llave de cifrado de datos con el UUID especificado. La llave de cifrado de datos debe existir en el almacén de claves asociado a la conexión de la base de datos.

Devuelve:

La llave de cifrado de datos antes de actualizar el keyAltName.

Devuelve null si ninguna llave de cifrado de datos tiene el UUID() especificado.

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

removeKeyAlternateName() tiene la siguiente sintaxis:

keyVault = db.getMongo().getKeyVault()
keyVault.removeKeyAlternateName(
   UUID("<UUID string>"),
   "keyAltName"
)

Comportamiento

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

Los métodos mongosh ClientEncryption requieren una conexión a la base de datos con la encriptación en uso activada. Si la conexión actual a la base de datos no se inició con la encriptación en uso activada, entonces:

Utilice el constructor Mongo() de mongosh para establecer una conexión con las opciones de encriptación en uso requeridas. El método Mongo() es compatible con los siguientes proveedores de Key Management Service (KMS) para la gestión de llave maestra de cliente (llave maestra de cliente):
or
Utilice las mongosh opciones de línea de comandos 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 llave maestra de cliente.

Ejemplo

El siguiente ejemplo está destinado a la evaluación rápida del cifrado a nivel de campo del lado del cliente. Para conocer ejemplos específicos de uso de KeyVault.removeKeyAlternateName() con cada proveedor de KMS compatible, consulta Gestión de llaves de cifrado.

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
)

Recupere el objeto keyVault y utilice el método KeyVault.removeKeyAlternateName() para remover el nombre alternativo de clave especificado de la llave de cifrado de datos con UUID coincidente:

keyVault = encryptedClient.getKeyVault()
keyVault.removeKeyAlternateName(UUID("b4b41b33-5c97-412e-a02b-743498346079"),"Other-Data-Encryption-Key")

Si es exitoso, removeKeyAlternateName() devuelve la llave de cifrado de datos antes de actualizar el keyAltName.

{
    "_id" : UUID("b4b41b33-5c97-412e-a02b-743498346079"),
    "keyMaterial" : BinData(0,"PXRsLOAYxhzTS/mFQAI8486da7BwZgqA91UI7NKz/T/AjB0uJZxTvhvmQQsKbCJYsWVS/cp5Rqy/FUX2zZwxJOJmI3rosPhzV0OI5y1cuXhAlLWlj03CnTcOSRzE/YIrsCjMB0/NyiZ7MRWUYzLAEQnE30d947XCiiHIb8a0kt2SD0so8vZvSuP2n0Vtz4NYqnzF0CkhZSWFa2e2yA=="),
    "creationDate" : ISODate("2019-08-12T21:21:30.569Z"),
    "updateDate" : ISODate("2019-08-12T21:21:30.569Z"),
    "status" : 0,
    "version" : Long(0),
    "masterKey" : {
        "provider" : "local"
    },
    "keyAltNames" : [
        "ssn-encryption-key"
    ]
}

Volver

KeyVault.getKeyByAltName

KeyVault.removeKeyAltName