KeyVault.createKey()

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

将数据加密密钥添加到与数据库连接关联的密钥保管库。 客户端字段级加密使用数据加密密钥来支持字段值的加密和解密。

createKey() 通过以下语法实现：

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

Parameter	类型	说明
keyManagementService	字符串	必需 用于检索客户主密钥 (CMK) 的密钥管理服务 (KMS )。 接受以下参数： aws 用于Amazon Web Services KMS 。 需要为customerMasterKey指定客户主密钥 (CMK) 字符串。 azure 用于Azure Key Vault 。 需要为customerMasterKey指定客户主密钥 (CMK) 文档。 版本 5.0 中的新增功能。 gcp 用于Google Cloud Platform KMS 。 需要为customerMasterKey指定客户主密钥 (CMK) 文档。 版本 5.0 中的新增功能。 local 用于本地托管的密钥。 如果未为database connection配置指定的 KMS，则数据加密密钥创建将失败。
customerMasterKey	字符串或文档	用于加密数据加密密钥的客户主密钥 (CMK)。 如果keyManagementService为aws 、 azure或gcp ，则为必填项。 根据您的 KMS 提供商，按如下方式提供客户主密钥： 对于Amazon Web ServicesKMS ，请指定完整的 资源名称Amazon (ARN) 作为单个string 的主密钥。 对于Azure Key Vault KMS，请指定包含以下键值对的文档： keyName - Azure Key Vault 名称 keyVaultEndpoint - 要使用的 Azure Key Vault 的 DNS 名称 keyVersion — 可选。 keyName中指定的密钥版本（如果适用） 版本 5.0 中的新增功能。 对于Google Cloud Platform KMS ，请指定包含以下键值对的文档： projectId - GCP 项目名称 location - KMS 密钥环的位置 keyRing - KMS 密钥环的名称（通常为“全局”） keyName - 要使用的密钥的名称 keyVersion — 可选。 keyName中指定的密钥版本（如果适用） 版本 5.0 中的新增功能。 createKey()请求KMS使用指定的集合扫描加密数据加密密钥材料。 如果集合扫描不存在，或者AutoEncryptionOpts配置没有足够的特权来使用集合扫描，则createKey()会返回错误。 如果keyManagementService为local ，则此参数无效，可以安全地省略。
keyAltName	字符串数组	Optional 数据加密密钥的替代名称。 使用keyAltName提高特定数据加密密钥的可查找性，或作为注释的模拟。 getKeyVault()方法自动在keyAltNames字段上创建唯一索引，并使用仅针对存在keyAltNames的文档的部分索引筛选器。
options	文档	Optional 指定新密钥选项的文档。 options具有以下字段： masterKey：用于加密数据的新主密钥。 keyAltNames：备用名称数组，每个主密钥一个。 keyMaterial：用于创建密钥的 bindata。

返回：	创建的数据加密密钥的UUID唯一标识符。

mongosh --nodb

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

 var autoEncryptionOpts = {
   "keyVaultNamespace" : "encryption.__dataKeys",
   "kmsProviders" : {
     "local" : {
       "key" : BinData(0, TEST_LOCAL_KEY)
     }
   }
 }

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

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