KeyVault.getKeys() (método mongosh)

KeyVault.getKeys()

getKeys() Devuelve todas las llaves de cifrado de datos almacenadas en el almacén de claves asociado a la conexión de la base de datos.

Devuelve:

Devuelve todas las llaves de cifrado de datos asociadas a la bóveda de claves.

No devuelve nada si el almacén de claves está vacío.

Compatibilidad

Este comando está disponible en implementaciones alojadas en los siguientes entornos:

MongoDB Atlas: El servicio totalmente administrado 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

getKeys() tiene la siguiente sintaxis:

keyVault = db.getMongo().getKeyVault()
keyVault.getKeys()

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 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 constructor Mongo() del mongosh para establecer una conexión con las opciones de cifrado en uso requeridas. El método Mongo() 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 opciones de línea de comandos mongosh 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 utiliza un KMS gestionado localmente para la configuración de cifrado a nivel de campo del lado del cliente.

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.getKeys() para recuperar todas las claves de cifrado de datos en el almacén de claves:

keyVault.getKeys()

getKeys() devuelve todas las llaves de cifrado de datos en el almacén de claves, con una salida similar a la siguiente:

{
  "_id" : UUID("b4b41b33-5c97-412e-a02b-743498346079"),
  "keyMaterial" : BinData(0,"PXRsLOAYxhzTS/mFQAI8486da7BwZgqA91UI7NKz/T/AjB0uJZxTvhvmQQsKbCJYsWVS/cp5Rqy/FUX2zZwxJOJmI3rosPhzV0OI5y1cuXhAlLWlj03CnTcOSRzE/YIrsCjMB0/NyiZ7MRWUYzLAEQnE30d947XCiiHIb8a0kt2SD0so8vZvSuP2n0Vtz4NYqnzF0CkhZSWFa2e2yA=="),
  "creationDate" : ISODate("2021-03-15T12:21:13.123Z"),
  "updateDate" : ISODate("2021-03-15T12:21:13.123Z"),
  "status" : 0, "version" : Long(0),
  "masterKey" : {
    "provider" : "local"
  },
  "keyAltNames" : [
     "alpha"
  ]
}
{
  "_id" : UUID("f1add015-c7ab-49a2-a071-50b0ca0a8fbc"),
  "keyMaterial" : BinData(0,"E+0jZKzA4YuE1lGmSVIy2mivqH4JxFo0yFATdxYX/s0YtMFsgVXyu7Bbn4IQ2gn7F/9JAPJFOxdQc5lN3AR+oX33ewVZsd63f3DN1zzcukqdR2Y+EeO7ekRxyRjdzMaNNrBNIv9Gn5LEJgWPSYkG8VczF7cNZnc1YmnR0tuDPNYfm0J7dCZuZUNWW3FCGRcdFx6AlXiCtXKNR97hJ216pQ=="),
  "creationDate" : ISODate("2021-03-16T18:22:43.733Z"),
  "updateDate" : ISODate("2021-03-16T18:22:43.733Z"),
  "status" : 0, "version" : Long(0),
  "masterKey" : {
    "provider" : "local"
  },
  "keyAltNames" : [
     "baker"
  ]
}

Volver

KeyVault.getKey

KeyVault.getKeyByAltName