KeyVault.createKey() (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.createKey(keyManagementService, customerMasterKey, ["keyAltName"])

Agrega una llave de cifrado de datos al almacén de claves asociado a la conexión de la base de datos. Cifrado a nivel de campo del lado del cliente utiliza claves de cifrado de datos para admitir el cifrado y descifrado de valores de campo.

Devuelve:	El identificador único `UUID` de la llave de cifrado de datos creada.

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

createKey() tiene la siguiente sintaxis:

keyVault = db.getMongo().getKeyVault()
keyVault.createKey(
  keyManagementService,
  customerMasterKey,
  [ "keyAltName" ]
)

Parameter	Tipo	Descripción
`keyManagementService`	string	Requerido The Key Management Service (KMS) to use for retrieving the clave maestra del cliente (CMK). Acepta los siguientes parámetros: `aws` para Amazon Web Services KMS. Requiere especificar una string de llave maestra de cliente (llave maestra de cliente) para `customerMasterKey`. `azure` for Azure Key Vault. Requiere especificar un documento de clave maestra del cliente (CMK) para `customerMasterKey`. Nuevo en la versión 5.0. `gcp` para Google Cloud Platform KMS. Requiere especificar un documento de clave maestra del cliente (CMK) para `customerMasterKey`. Nuevo en la versión 5.0. `local` para una clave administrada localmente. Si el `database connection` no se configuró con el KMS especificado, la creación de la llave de cifrado de datos fallará.
`customerMasterKey`	string o documento	La llave maestra de cliente (CMK) que se debe utilizar para cifrar la llave de cifrado de datos. Obligatorio si `keyManagementService` es `aws`, `azure` o `gcp`. Proporcione la llave maestra de cliente de la siguiente manera dependiendo de su proveedor de KMS: Para el AWS KMS, especifica el Amazon Resource Name (ARN)completo de la clave maestra como una sola string. Para el Azure Key Vault KMS, especifica un documento que contenga los siguientes pares clave-valor: `keyName` - El nombre de Azure Key Vault `keyVaultEndpoint` - El nombre DNS del Azure Key Vault que se va a utilizar `keyVersion` - opcional. La versión de la clave especificada en `keyName`, si aplica Nuevo en la versión 5.0. Para la Google Cloud Platform KMS, especifica un documento que contenga los siguientes pares clave-valor: `projectId` - El nombre del proyecto de GCP `location` - La ubicación del llavero de KMS `keyRing` - El nombre del almacén de claves KMS (a menudo "global") `keyName` - El nombre de la clave a utilizar `keyVersion` - opcional. La versión de la clave especificada en `keyName`, si aplica Nuevo en la versión 5.0. `createKey()` solicita que el KMS cifre el material de llave de cifrado de datos utilizando la llave maestra de cliente especificada. Si la llave maestra de cliente no existe o si la configuración de `AutoEncryptionOpts` no tiene privilegios suficientes para usar la llave maestra de cliente, `createKey()` devuelve un error. Este parámetro no tiene efecto si `keyManagementService` es `local` y se puede omitir de forma segura.
`keyAltName`	Arreglo de cadenas	Opcional El nombre alternativo de la clave de cifrado de datos. Usa `keyAltName` para mejorar la capacidad de búsqueda de una llave de cifrado de datos o como un análogo a un comentario. El método `getKeyVault()` crea automáticamente un índice único en el campo `keyAltNames` con un filtro de índice parcial solo para documentos donde `keyAltNames` existe.
`options`	Documento	Opcional Un documento que especifica opciones para la nueva clave. `options` tiene los siguientes campos: `masterKey`: la nueva clave maestra para cifrar datos. `keyAltNames`: un arreglo de nombres alternativos, uno por clave principal. `keyMaterial`bindata utilizada para crear la contraseña.

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 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 Mongo() constructor de mongosh para establecer una conexión con las opciones necesarias de cifrado de nivel de campo del lado del cliente. El método Mongo() es compatible con los siguientes proveedores de Key Management Service (KMS) para la gestión de la llave maestra de 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

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.createKey() con cada uno de los soportados El KMS proveedor, consulta Crear una clave de datos.

Para configurar el cifrado a nivel de campo en el lado del cliente con una clave gestionada 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"])
     }
   }
 }

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
)

Recupera el objeto keyVault y utiliza el método KeyVault.createKey() para crear una nueva llave de cifrado de datos utilizando la clave gestionada localmente:

keyVault = encryptedClient.getKeyVault()
keyVault.createKey("local", ["data-encryption-key"])

Si tiene éxito, createKey() devuelve el UUID de la nueva llave de cifrado de datos. Para recuperar el nuevo documento de llave de cifrado de datos del almacén de claves, puedes:

Use getKey() para recuperar la clave creada por UUID.
-o-
Utiliza getKeyByAltName() para recuperar la clave por su nombre alternativo.

Volver

KeyVault.createDataKey

KeyVault.deleteKey