KeyVault.addKeyAlternateName()

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

KeyVault.addKeyAlternateName(UUID, keyAltName)

Agrega el keyAltName al arreglo keyAltNames de la llave de cifrado de datos con UUID.

keyAltName debe ser único entre todas las claves en el almacén de claves. La getKeyVault() El método crea automáticamente un índice único en el campo keyAltNames con un filtro de índice parcial solo para documentos donde keyAltNames existe.

Devuelve:	Devuelve la versión anterior del documento de llave de cifrado de datos. Devuelve `null` si ninguna llave de cifrado de datos tiene el `UUID()` especificado.

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

addKeyAlternateName() tiene la siguiente sintaxis:

keyVault = db.getMongo().getKeyVault()
keyVault.addKeyAlternateName(
   UUID("<UUID string>"),
   "keyAlternateName"
)

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 constructor Mongo() desde la mongo shell para establecer una conexión con las opciones de cifrado a nivel de campo del lado del cliente requeridas. El método Mongo() admite los siguientes proveedores de Key Management Service (KMS) para la gestión de la llave maestra de cliente (llave maestra de cliente):
or
Utiliza las mongo opciones de línea de comandos del shell para establecer una conexión con las opciones requeridas. Las opciones de línea de comandos solo son compatibles con el proveedor de Amazon Web Services KMS para la gestión de llave maestra de cliente.

Ejemplo

El siguiente ejemplo está destinado a la evaluación rápida del cifrado a nivel de campo del lado del cliente. Para ejemplos específicos de usar KeyVault.addKeyAlternateName() con cada uno de los soportados KMS proveedor, consulta Administrar un nombre alternativo para una llave de cifrado de datos.

Para configurar el cifrado a nivel de campo del lado del cliente para una clave administrada localmente, se requiere especificar una cadena de 96 bytes codificada en base64 sin saltos de línea. La siguiente operación genera una clave que cumple los requisitos indicados y la carga en el shell:mongo

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)
    }
  }
}

Usa el constructor Mongo() para crear una conexión a la base de datos con las opciones de cifrado de nivel de campo del lado del cliente. Sustituye el URI de mongodb://myMongo.example.net por el URI de cadena de conexión del clúster de destino.

encryptedClient = Mongo(
  "mongodb://myMongo.example.net:27017/?replSetName=myMongo",
  ClientSideFieldLevelEncryptionOptions
)

Recupere el objeto KeyVault y utilice el método KeyVault.addKeyAlternateName() para agregar un nombre alternativo de clave nuevo a la clave de cifrado de datos que coincida con UUID. El nombre alternativo de clave especificado debe ser único:

keyVault = encryptedClient.getKeyVault()
keyVault.addKeyAlternateName(UUID("b4b41b33-5c97-412e-a02b-743498346079"),"Other-Data-Encryption-Key")

Si tiene éxito, addKeyAlternateName() devuelve la versión anterior del documento de llave 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" : NumberLong(0),
    "masterKey" : {
        "provider" : "local"
    },
    "keyAltNames" : [
    ]
}

Para ver la versión actual del documento de clave de cifrado de datos, utiliza KeyVault.getKey() especificando el _id del documento devuelto o KeyVault.getKeyByAltName() especificando uno de los keyAltNames.

Tip

Gestionar el nombre alternativo de una clave de cifrado de datos

Volver

getKeyVault

KeyVault.createKey