KeyVault.createKey() (método mongosh)

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 campos.

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`. Novedad 5.0 en la versión.: `gcp` para Google Cloud Platform KMS. Requiere especificar un documento de clave maestra del cliente (CMK) para `customerMasterKey`. Novedad 5.0 en la versión.: `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 Amazon Web Services KMS, especifica el nombre de recurso de Amazon completo (ARN) de la clave primaria como una sola string: Nombre de recurso de Amazon (ARN). 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 Novedad 5.0 en la versión.: 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 Novedad 5.0 en la versión.: `createKey()` solicita que el KMS cifre el material de la llave de cifrado de datos usando la llave maestra de cliente especificada. 如果llave maestra de cliente不存在或者 `AutoEncryptionOpts` 配置没有足够的privilegios使用llave maestra de cliente，`createKey()` 会返回错误。 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 mongosh ClientEncryption requieren una conexión a la base de datos con la encriptación en uso activada. Si la conexión actual a la base de datos no se inició con la encriptación en uso activada, entonces:

Utilice el constructor Mongo() de mongosh para establecer una conexión con las opciones de encriptación en uso requeridas. El método Mongo() es compatible con los siguientes proveedores de Key Management Service (KMS) para la gestión de llaves maestras de cliente:
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á pensado para una evaluación rápida del cifrado a nivel de campo del lado del cliente. Para obtener ejemplos específicos de cómo usar KeyVault.createKey() con cada proveedor compatible de KMS, consulta Crear una Clave de Datos.

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
)

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