Mongo（）_MonogDB 中文网

MongoDB 中文手册

参考 > 参考 > mongo Shell方法 > 连接方式 > Mongo（）

在本页面

描述
ClientSideFieldLevelEncryptionOptions
例

描述¶

在版本4.2中进行了更改。

Mongo（host，ClientSideFieldLevelEncryptionOptions ）¶

JavaScript构造函数，用于从mongo外壳或JavaScript文件实例化数据库连接。

该Mongo()方法具有以下参数：

参数	类型	描述
`host`	串	可选的。主机，形式为`<host>`或 `<host><:port>`。如果省略，则`Mongo`在默认端口上实例化到localhost接口的连接`27017`。
`ClientSideFieldLevelEncryptionOptions`	文献	可选的 4.2版中的新功能。用于启用客户端字段级加密的配置参数。 `ClientSideFieldLevelEncryptionOptions`覆盖数据库连接的现有客户端字段级加密配置。如果省略，则`Mongo()` 继承当前数据库连接的客户端字段级加密配置。有关用法和语法的文档，请参见 ClientSideFieldLevelEncryptionOptions。

也可以看看

Mongo.getDB()和db.getMongo()。

`ClientSideFieldLevelEncryptionOptions`¶

4.2版中的新功能。

该ClientSideFieldLevelEncryptionOptions文档指定了客户端字段级加密的配置选项。如果数据库连接具有现有的客户端字段级加密配置，则指定将 ClientSideFieldLevelEncryptionOptions覆盖该配置。

例如，mongo使用客户端字段级加密命令行选项启动外壳程序将为该连接启用客户端加密。除非包含，否则使用创建的新数据库连接将Mongo()继承加密设置。 Mongo()ClientSideFieldLevelEncryptionOptions

该ClientSideFieldLevelEncryptionOptions文档具有以下语法：

复制

{
  "keyVaultClient" : <object>,
  "keyVaultNamespace" : "<string>",
  "kmsProvider" : <object>,
  "schemaMap" : <object>,
  "bypassAutoEncryption" : <boolean>
}

该ClientSideFieldLevelEncryptionOptions文档采用以下参数：

参数	类型	描述
`keyVaultClient`	`Mongo()` 连接对象。	（可选）托管密钥库集合的MongoDB集群。忽略将当前数据库连接用作密钥库主机。指定`Mongo()`指向集群的连接对象：复制 var keyVaultClient = Mongo(<MongoDB URI>); var ClientSideFieldLevelEncryptionOptions = { "keyVaultClient" : keyVaultClient, "keyVaultNamespace" : "<database>.<collection>", "kmsProvider" : { ... } }
`keyVaultNamespace`	串	（必需）密钥库集合的完整名称空间。
`kmsProvider`	文献	（必需）客户端领域级加密使用的密钥管理服务（KMS），用于管理客户主密钥（CMK）。客户端字段级加密使用CMK加密和解密数据加密密钥。客户端字段级加密（Amazon Web Services KMS 或本地托管密钥）：亚马逊网络服务KMS 重要要获得AWS KMS支持，请使用4.2.2 `mongo`Shell。`mongo`由于KMS响应对象发生意外更改，因此4.2.0和4.2.1 Shell不支持AWS KMS服务。有关此问题的更多信息，请参见SERVER-44721。使用以下字段指定`aws`文档到`kmsProvider`：复制 "kmsProvider" : { "aws" : { "accessKeyId" : "AWSAccessKeyId", "secretAccessKey" : "AWSSecretAccessKey" } } 指定的`accessKeyId`必须与具有KMS服务的全部`List`和`Read`许可权的IAM用户相对应。本地管理密钥使用以下字段指定`local`文档到`kmsProvider`：复制 "kmsProvider" : { "local" : { "key" : BinData(0, "<96 byte base-64 encoded key>") } } 指定的字符串`key` 必须是base64编码的96字节字符串，且没有换行符。
`schemaMap`	文献	（可选）使用JSON模式草稿4标准语法和特定于加密的关键字指定的自动客户端字段级加密规则。有关完整的文档，请参阅《自动加密规则》。
`bypassAutoEncryption`	布尔值	（可选）指定`true`绕过自动客户端字段级加密规则，并执行显式（手动）每字段加密。

例子¶

连接到MongoDB集群¶

以下操作从mongo外壳创建一个新的连接对象：

复制

cluster = Mongo("mongodb://mymongo.example.net:27017/?replicaSet=myMongoCluster")

针对cluster对象发出操作以与mymongo.example.net:27017集群交互：

复制

myDB = cluster.getDB("myDB"); //returns the database object
myColl = myDB.getCollection("myColl"); // returns the collection object

连接到启用了客户端加密的MongoDB集群¶

为本地管理的密钥配置客户端字段级加密需要指定没有换行符的base64编码的96字节字符串。以下操作将生成满足所述要求的密钥并将其加载到mongo外壳中：

复制

TEST_LOCAL_KEY=$(echo "$(head -c 96 /dev/urandom | base64 | tr -d '\n')")

mongo --nodb --shell --eval "var TEST_LOCAL_KEY='$TEST_LOCAL_KEY'"

以下操作从mongo外壳创建一个新的连接对象。该 ClientSideFieldLevelEncryptionOptions选项指定用于启用使用本地管理关键客户端字段级加密所需的选项：

复制

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

cluster = Mongo(
  "mongodb://mymongo.example.net:27017/?replicaSet=myMongoCluster",
  ClientSideFieldLevelEncryptionOptions
)

针对cluster对象发出操作以与mymongo.example.net:27017集群交互并执行显式加密：

复制

// returns the database object
myDB = cluster.getDB("myDB");

// returns the collection object
myColl = myDB.getCollection("myColl");

// returns object for managing data encryption keys
keyVault = cluster.getKeyVault();

// returns object for explicit encryption/decryption
clientEncryption = cluster.getClientEncryption();

有关客户端字段级加密方法的完整列表，请参见客户端字段级加密方法。

连接到启用了自动客户端加密的MongoDB集群¶

复制

TEST_LOCAL_KEY=$(echo "$(head -c 96 /dev/urandom | base64 | tr -d '\n')")

mongo --nodb --shell --eval "var TEST_LOCAL_KEY='$TEST_LOCAL_KEY'"

以下操作从mongo外壳创建一个新的连接对象。该 ClientSideFieldLevelEncryptionOptions选项指定启用所需的选项自动客户端加密的hr.employees集合：

复制

var ClientSideFieldLevelEncryptionOptions = {
  "keyVaultNamespace" : "encryption.dataKeys",
  "kmsProviders" : {
    "local" : {
      "key" : BinData(0,"BASE64-ENCODED-96-BYTE-LOCAL-KEY")
    }
  },
  schemaMap : {
    "hr.employees" : {
      "bsonType": "object",
      "properties" : {
        "taxid" : {
          "encrypt" : {
            "keyId" : [UUID("bffb361b-30d3-42c0-b7a4-d24a272b72e3")],
            "bsonType" : "string",
            "algorithm" : "AEAD_AES_256_CBC_HMAC_SHA_512-Random"
          }
        },
        "taxid-short": {
          "encrypt": {
            "keyId": [UUID("33408ee9-e499-43f9-89fe-5f8533870617")],
            "algorithm": "AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic",
            "bsonType": "string"
          }
        }
      }
    }
  }
}

cluster = Mongo(
  "mongodb://mymongo.example.net:27017/?replicaSet=myMongoCluster",
  ClientSideFieldLevelEncryptionOptions
)

对cluster对象发出操作以与mymongo.example.net:27017集群交互并利用自动加密：

复制

// returns the database object
myDB = cluster.getDB("myDB");

// returns the collection object
myColl = myDB.getCollection("myColl");

myColl.insertOne(
  {
    "name" : "J Doe",
    "taxid" : "123-45-6789",
    "taxid-short" : "6789"
  }
)

指定的自动加密规则使用指定的数据加密密钥和算法对taxid和 taxid-short字段进行加密。只有配置了正确KMS 并访问指定数据加密密钥的客户端才能解密该字段。

有关客户端字段级加密方法的完整列表，请参见客户端字段级加密方法。

MongoDB 中文手册

Mongo（）

描述¶

ClientSideFieldLevelEncryptionOptions¶

例子¶

连接到MongoDB集群¶

连接到启用了客户端加密的MongoDB集群¶

连接到启用了自动客户端加密的MongoDB集群¶

`ClientSideFieldLevelEncryptionOptions`¶