KeyVault.addKeyAlternateName() (método mongosh)

KeyVault.addKeyAlternateName(UUID, keyAltName)

Agrega el keyAltName al arreglo keyAltNames de la llave de cifrado de datos con UUID.

keyAltName debe ser único entre todas las claves del almacén de claves. El método getKeyVault() crea automáticamente un índice único en el campo keyAltNames con un filtro de índice parcial solo para documentos donde existe keyAltNames.

Devuelve:

Devuelve la versión anterior del documento de llave de cifrado de datos.

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

addKeyAlternateName() tiene la siguiente sintaxis:

keyVault = db.getMongo().getKeyVault()
keyVault.addKeyAlternateName(
   UUID("<UUID string>"),
   "keyAlternateName"
)

Comportamiento

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

Los mongosh ClientEncryption métodos requieren una conexión a la base de datos con el cifrado en uso habilitado. Si la conexión actual a la base de datos no se inició con el cifrado en uso habilitado, se producirá uno de los siguientes errores:

Utilice el Mongo() constructor del mongosh para establecer una conexión con las opciones de cifrado en uso requeridas. El Mongo() método admite los siguientes proveedores de servicio de administración de claves (KMS) para la administración de la clave maestra del cliente (CMK):
or
Utilice las mongosh opciones de línea de comandos para establecer una conexión con las opciones requeridas. Las opciones de línea de comandos solo admiten el proveedor KMS de Amazon Web Services para la administración de CMK.

Ejemplo

El siguiente ejemplo está destinado a una evaluación rápida del cifrado a nivel de campo del lado del cliente. Para ver ejemplos específicos de cómo utilizar KeyVault.addKeyAlternateName() con cada proveedor de KMS admitido, consulte 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 KeyVault objeto y utilice el método para agregar un nuevo nombre alternativo de clave a la clave de cifrado de datos KeyVault.addKeyAlternateName() con UUID coincidente. El nombre alternativo de clave especificado debe ser único:

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

Si tiene éxito, devuelve la versión anterior del documento de clave de cifrado deaddKeyAlternateName() datos:

{
    "_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" : [
    ]
}

Para ver la versión actual del documento de clave de cifrado de datos, utiliza KeyVault.getKey() especificando el _id del documento devuelto o KeyVault.getKeyByAltName() especificando uno de los keyAltNames.

Tip

Gestión de claves de encriptación

Volver

KeyVault.addKeyName

KeyVault.createDataKey