KeyVault.getKeyByAltName() (método mongosh)

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

KeyVault.getKeyByAltName(keyAltName)

Obtiene todas las claves de cifrado de datos con el keyAltName especificado.

Devuelve:	Documento que representa una clave de cifrado de datos coincidente. Si no se encuentra una llave de cifrado de datos coincidente, `KeyVault.getKeyByAltName()` devuelve un objeto que contiene una pista de que no se encontró la clave.

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

getKeyByAltName() tiene la siguiente sintaxis:

keyVault = db.getMongo().getKeyVault()
keyVault.getKeyByAltName("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 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 constructor Mongo() mongosh de para establecer una conexión con las opciones de cifrado de campo requeridas del lado del cliente.Mongo() El método admite los siguientes proveedores de Servicios de Gestión de Claves (KMS) para la gestión de la Clave Maestra del 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 utiliza un KMS gestionado localmente para la configuración de cifrado a nivel de campo en el lado del cliente.

Para configurar el cifrado a nivel de campo del lado del cliente para una clave administrada localmente:

genera una cadena de 96bytes codificada en base64sin saltos de línea
utilizar mongosh para cargar la clave

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

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

 var autoEncryptionOpts = {
   "keyVaultNamespace" : "encryption.__dataKeys",
   "kmsProviders" : {
     "local" : {
       "key" : BinData(0, process.env["TEST_LOCAL_KEY"])
     }
   }
 }

Utilice el constructor con las opciones de cifrado de campo del lado del cliente configuradas para crear una conexión a la base de datos. Reemplace Mongo() el mongodb://myMongo.example.net URI 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.getKeyByAltName() para recuperar la llave de cifrado de datos cuyo keyAltNames arreglo incluye el nombre alternativo de clave especificado:

keyVault.getKeyByAltName("data-encryption-key")

getKeyByAltName() devuelve la siguiente clave de cifrado de 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" : [
        "data-encryption-key"
    ]
}

Volver

KeyVault.getKeys

KeyVault.removeKeyAlternateName