KeyVault.rewrapManyDataKey() (método mongosh)

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, consulte llaves de cifrado de datos y la llave Maestra del Cliente.

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, consulta Realizar copia de seguridad y restauración con las herramientas de 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 KMS (AWS KMS, Azure Key Vault, GCP KMS, 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.

The mongosh client-side field level encryption methods require a database connection with client-side field level encryption enabled. If the current database connection was not initiated with client-side field level encryption enabled, either:

Use the Mongo() constructor from the mongosh to establish a connection with the required client-side field level encryption options. The Mongo() method supports the following Key Management Service (KMS) providers for Customer Master Key (CMK) management:
or
Use the mongosh command line options to establish a connection with the required options. The command line options only support the Amazon Web Services KMS provider for CMK management.

Ejemplo

Estos ejemplos permiten evaluar rápidamente el cifrado a nivel de campo en el lado del cliente. Para obtener ejemplos específicos de cómo utilizar cada proveedor de KMS admitido, consulta Gestión de claves 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
)

Retrieve the KeyVault object and use the KeyVault.rewrapManyDataKey() method to rewrap the existing keys in a new masterKey. If no new masterKey is given, each data key retains its respective current masterKey.

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() returns a BulkWriteResult object detailing how many data keys were affected:

{
  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

languaje del query