KeyVault.rewrapManyDataKey() (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.rewrapManyDataKey(filter, options)

Descifra múltiples llaves de cifrado de datos (DEK) y las vuelve a cifrar con una nueva llave maestra de cliente (CMK). Utiliza este método para rotar la llave maestra de cliente que cifra tus DEK. Para obtener más información sobre las CMK y las DEK, consulta Claves.

Se especifica una llave maestra de cliente a través del parámetro masterKey. Si no incluyes un argumento masterKey, el método descifra y cifra cada DEK con la llave maestra de cliente referenciada en los metadatos de ese DEK. Para obtener más información sobre los metadatos de las DEK, consulta Metadatos utilizados para el descifrado.

Devuelve:	Un objeto BulkWriteResult que informa cuántas claves de datos se vieron afectadas.

Advertencia

Haz una copia de seguridad de tu Colección de Bóvedas de Llaves

Antes de rotar tus llaves de cifrado de datos, asegúrate de crear una copia de seguridad de tu Colección de Bóvedas de Llaves. Si pierdes acceso a tus llaves de cifrado de datos, perderás todos tus datos cifrados.

Para aprender a crear una copia de seguridad de una colección, consulte Realizar copias de seguridad y restaurar una implementación autoadministrada con herramientas MongoDB.

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

KeyVault.rewrapManyDataKey tiene la siguiente sintaxis:

let keyVault = db.getMongo().getKeyVault()
keyVault.rewrapManyDataKey(
  <filter>,
  <options>
)

Parameter	Tipo	Descripción
`filter`	filtro de query documento	El filtro de query para la colección keyvault
`options`	Documento	Este documento tiene dos campos: `provider`:Un proveedor de KMS (AWS KMS, Azure Key Vault, GCP KMS, el proveedor local o KMIP) `masterKey`clave específica de KMS que se utiliza para cifrar la nueva clave de datos

Importante

Soporte para rotación de claves

Para ver las dependencias del controlador en la API de rotación de claves, consulta Compatibilidad.

Comportamiento

Esta operación no es atómica y no debe ejecutarse en paralelo con otras operaciones de gestión de claves.

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

Estos ejemplos te permiten evaluar rápidamente el cifrado a nivel de campo del lado del cliente. Para ver ejemplos específicos usando cada uno de los compatibles Proveedor KMS, ver Gestión de claves de cifrado.

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.rewrapManyDataKey() para reenvolver las claves existentes en un nuevo masterKey. Si no se proporciona un nuevo masterKey, cada clave de datos mantiene su respectiva masterKey actual.

Reenvolver claves de datos con la actual clave maestra

El siguiente ejemplo muestra cómo puedes volver a envolver cada clave de datos con su respectivo masterKey actual:

let keyVault = mongo.getKeyVault()
keyVault.rewrapManyDataKey()

Reenvolver claves de datos con una nueva clave maestra

El siguiente ejemplo muestra cómo puedes volver a envolver cada clave de datos con un nuevo masterKey:

let keyVault = mongo.getKeyVault()
keyVault.rewrapManyDataKey({}, {
  provider: 'aws',
  masterKey: {
    region: 'us-east-2',
    key: 'arn:aws:kms:us-east-2:...'
  }
})

Reenvolver las claves de datos que no se hayan reenvuelto recientemente

El siguiente ejemplo muestra cómo volver a envolver claves de datos que no se hayan vuelto a envolver en los anteriores treinta días.

let keyVault = mongo.getKeyVault()
const thirtyDaysAgo = new Date(Date.now() - 30 * 24 * 60 * 60 * 1000);
keyVault.rewrapManyDataKey({ updateDate: { $lt: thirtyDaysAgo } });

Salida

KeyVault.rewrapManyDataKey() devuelve un BulkWriteResult objeto que detalla cuántas claves de datos se vieron afectadas:

{
  bulkWriteResult: BulkWriteResult {
    result: {
      ok: 1,
      writeErrors: [],
      writeConcernErrors: [],
      insertedIds: [],
      nInserted: 0,
      nUpserted: 0,
      nMatched: 3,
      nModified: 3,
      nRemoved: 0,
      upserted: [],
      opTime: { ts: Timestamp({ t: 1655840760, i: 3 }), t: 23 }
    }
  }
}

Volver

KeyVault.removeKeyAltName

Operadores