客户端字段级加密方法

注意

有关特定方法的详细信息，包括语法和示例，请单击特定方法以转到其参考页。

该mongo客户端的字段级的加密方法需要与客户端的字段级加密的数据库连接启用。如果当前数据库连接不是在启用客户端字段级加密的情况下启动的，则可以：

使用外壳程序中的Mongo()构造函数mongo与所需的客户端字段级加密选项建立连接。该Mongo()方法同时支持Amazon Web Services和本地密钥管理服务（KMS）提供程序，用于客户主密钥（CMK）管理。

要么
使用mongoshell 命令行选项与所需选项建立连接。命令行选项仅支持AWS KMS提供程序进行CMK管理。

下面的方法是对MongoDB的mongo外壳只。有关使用兼容MongoDB 4.2的驱动程序实施客户端字段级加密的说明，请参阅驱动程序文档。有关支持客户端字段级加密的4.2兼容驱动程序的完整列表，请参见驱动程序兼容性表。

名称	描述
`getKeyVault()`	返回当前MongoDB连接的密钥保险库对象。
`KeyVault.createKey()`	创建用于客户端字段级加密的数据加密密钥。
`KeyVault.deleteKey()`	从密钥库中删除指定的数据加密密钥。
`KeyVault.getKey()`	从密钥库中检索指定的数据加密密钥。
`KeyVault.getKeys()`	检索密钥库中的所有密钥。
`KeyVault.addKeyAlternateName()`	将密钥替代名称与指定的数据加密密钥相关联。
`KeyVault.removeKeyAlternateName()`	从指定的数据加密密钥中删除密钥替代名称。
`KeyVault.getKeyByAltName()`	检索具有指定键替代名称的键。
`getClientEncryption()`	返回用于支持字段的显式加密/解密的客户端加密对象。
`ClientEncryption.encrypt()`	使用指定的数据加密密钥和加密算法对字段进行加密。
`ClientEncryption.decrypt()`	使用关联的数据加密密钥和加密算法解密字段。