KeyVault.createKey() (original) (raw)

KeyVault.createKey(keyManagementService, customerMasterKey, ["keyAltName"])

Adds a data encryption key to the key vault associated to the database connection. Client-Side Field Level Encryption uses data encryption keys for supporting encryption and decryption of field values.

Returns: The UUID unique identifier of the created data encryption key.

This command is available in deployments hosted in the following environments:

createKey() has the following syntax:


keyVault = db.getMongo().getKeyVault()

keyVault.createKey(

  keyManagementService,

  customerMasterKey,

  [ "keyAltName" ]

)
Parameter Type Description
keyManagementService string _Required_The Key Management Service (KMS) to use for retrieving the Customer Master Key (CMK). Accepts the following parameters:aws for Amazon Web Services KMS. Requires specifying a Customer Master Key (CMK) string for customerMasterKey.azure for Azure Key Vault. Requires specifying a Customer Master Key (CMK) document forcustomerMasterKey.New in version 5.0.gcp for Google Cloud Platform KMS. Requires specifying a Customer Master Key (CMK) document forcustomerMasterKey.New in version 5.0.local for a locally managed key.If the database connection was not configured with the specified KMS, data encryption key creation fails.
customerMasterKey string or document The Customer Master Key (CMK) to use for encrypting the data encryption key. Required if keyManagementService isaws, azure, or gcp.Provide the CMK as follows depending on your KMS provider:For the Amazon Web Services KMS, specify the fullAmazon Resource Name (ARN)of the master key as a single string.For the Azure Key Vault KMS, specify a document containing the following key value pairs:keyName - The Azure Key Vault NamekeyVaultEndpoint - The DNS name of the Azure Key Vault to usekeyVersion - Optional. The version of the key specified in keyName, if applicable_New in version 5.0_.For the Google Cloud Platform KMS, specify a document containing the following key value pairs:projectId - The GCP project namelocation - The location of the KMS keyringkeyRing - The name of the KMS keyring (often 'global')keyName - The name of the key to usekeyVersion - Optional. The version of the key specified in keyName, if applicable_New in version 5.0_.createKey() requests that the KMS encrypt the data encryption key material using the specified CMK. If the CMK does not exist or if theAutoEncryptionOpts configuration does not have sufficient privileges to use the CMK,createKey() returns an error.This parameter has no effect if keyManagementService is localand can be safely omitted.
keyAltName array of strings _Optional_The alternative name for the data encryption key. UsekeyAltName to improve findability of a specific data encryption key, or as an analog to a comment.The getKeyVault() method automatically creates aunique index on thekeyAltNames field with a partial index filter for only documents wherekeyAltNames exists.
options document _Optional_A document that specifies options for the new key.options has the following fields:masterKey: the new master key to encrypt data.keyAltNames: an array of alternate names, one per master key.keyMaterial: bindata used to create the key.

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:

The following example is intended for rapid evaluation of client-side field level encryption. For specific examples of usingKeyVault.createKey() with each supportedKMS provider, seeCreate a Data Key.

Start the mongosh client.

To configure client-side field level encryption for a locally managed key, generate a base64-encoded 96-byte string with no line breaks.


const TEST_LOCAL_KEY = require("crypto").randomBytes(96).toString("base64")

Create the client-side field level encryption options using the generated local key string:


 var autoEncryptionOpts = {

   "keyVaultNamespace" : "encryption.__dataKeys",

   "kmsProviders" : {

     "local" : {

       "key" : BinData(0, TEST_LOCAL_KEY)

     }

   }

 }

Use the Mongo() constructor with the client-side field level encryption options configured to create a database connection. Replace the mongodb://myMongo.example.net URI with the connection string URI of the target cluster.


encryptedClient = Mongo(

  "mongodb://myMongo.example.net:27017/?replSetName=myMongo",

   autoEncryptionOpts

)

Retrieve the keyVault object and use the KeyVault.createKey() method to create a new data encryption key using the locally managed key:


keyVault = encryptedClient.getKeyVault()

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

If successful, createKey() returns the UUID of the new data encryption key. To retrieve the new data encryption key document from the key vault, either: