KeyVault.getKey(UUID)Obtiene una clave de cifrado de datos con el valor
UUIDespecificado. La clave de cifrado de datos debe existir en el almacén de claves asociado a la conexión a la base de datos.Devuelve: Documento que representa una clave de cifrado de datos coincidente. Si no se encuentra ninguna clave de cifrado de datos coincidente,
KeyVault.getKey()devuelve un objeto que contiene una pista de que no se encontró ninguna 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
getKey() tiene la siguiente sintaxis:
keyVault = db.getMongo().getKeyVault() keyVault.getKey(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 delmongoshell 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 deMongo()la Clave Maestra del Cliente (CMK):or
Utilice las opciones de línea
mongode 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 utiliza un KMS gestionado localmente para la configuración de cifrado a nivel de campo del lado del cliente.
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 objeto keyVault KeyVault.getKey() y use UUIDpara recuperar una clave de cifrado de datos usando su:
keyVault = encryptedClient.getKeyVault() keyVault.getKey(UUID("b4b41b33-5c97-412e-a02b-743498346079"))
getKey() devuelve la clave de cifrado de datos, con un resultado similar al siguiente:
{ "_id" : UUID("b4b41b33-5c97-412e-a02b-743498346079"), "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" : NumberLong(0), "masterKey" : { "provider" : "local" }, "keyAltNames" : [ "alpha" ] }