KeyVault.createKey() (método mongosh)

Esta versión de la documentación está archivada y ya no recibe soporte. Para actualizar su implementación 6.0, consulte 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. El cifrado a nivel de campo del lado del cliente utiliza claves de cifrado de datos para respaldar el cifrado y descifrado de valores de campo.

Devuelve:	El identificador único `UUID` de la clave 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 El Servicio de Gestión de Claves (KMS) que se utiliza para recuperar la Clave Maestra del Cliente (CMK) acepta los siguientes parámetros: `aws` Para Amazon Web Services KMS. Requiere especificar una clave maestra del cliente (CMK) `customerMasterKey` para. `azure` Para Azure Key Vault. Requiere especificar un documento de clave maestra de cliente (CMK) `customerMasterKey` para. Nuevo en la versión 5.0. `gcp` Para Google Cloud Platform KMS. Requiere especificar un documento de clave maestra del cliente (CMK) `customerMasterKey` para. Nuevo en la versión 5.0. `local` para una clave administrada localmente. Si el no se configuró con el KMS especificado, la creación de la clave de cifrado de datos `database connection` falla.
`customerMasterKey`	string o documento	La clave maestra del cliente (CMK) que se usará para cifrar la clave de cifrado de datos. Obligatorio si `keyManagementService` es `aws`, `azure` o `gcp`. Proporcione la CMK de la siguiente manera según su proveedor de KMS: Para Amazon Web Services KMS, especifique el nombre de recurso de Amazon (ARN) completo de la llave maestra como una sola cadena. 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 de Azure Key Vault que se utilizará `keyVersion` - Opcional. La versión de la clave especificada en `keyName`, si corresponde. Nuevo en la versión 5.0. Para Google Cloud Platform KMS, especifique un documento que contenga los siguientes pares clave-valor: `projectId` - El nombre del proyecto GCP `location` - La ubicación del llavero KMS `keyRing` - El nombre del llavero KMS (a menudo "global") `keyName` - El nombre de la clave a utilizar `keyVersion` - Opcional. La versión de la clave especificada en `keyName`, si corresponde. 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`	matriz de cadenas	Opcional El nombre alternativo de la clave de cifrado de datos. Use `keyAltName` para facilitar la búsqueda de una clave de cifrado de datos específica o como equivalente a un comentario. El método `getKeyVault()` crea automáticamente un índice único en el `keyAltNames` campo con un filtro de índice parcial solo para los 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 utilizado para crear la clave.

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 mongosh siguiente:

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

El siguiente ejemplo está diseñado para la evaluación rápida del cifrado a nivel de campo del lado del cliente. Para obtener ejemplos específicos del uso de con cada campo KeyVault.createKey() compatible Proveedor deKMS, consulte Crear una clave de datos.

Para configurar el cifrado a nivel de campo del lado del cliente para una clave administrada localmente:

generar una cadena de 96bytes codificada en base64sin saltos de línea
use para cargar la mongosh 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
)

Recupere el objeto keyVault KeyVault.createKey() y utilice el método para crear una nueva clave de cifrado de datos utilizando la clave administrada localmente:

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

Si la operación es correcta, devuelvecreateKey() el UUID de la nueva clave de cifrado de datos. Para recuperar el nuevo documento de clave de cifrado de datos del almacén de claves, realice una de las siguientes acciones:

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

Volver

KeyVault.createDataKey

KeyVault.eliminarClave