Docs 菜单
Docs 主页
/
MongoDB Manual
/
参考
/
mongosh 方法
/
客户端字段级加密 (Client-Side Field Level Encryption)

KeyVault.getKeys()

在此页面上

  • 行为
  • 例子
KeyVault.getKeys()

getKeys() 返回在与数据库连接关联的密钥保管库中存储的所有数据加密密钥。

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

keyVault = db.getMongo().getKeyVault()
keyVault.getKeys()
返回：返回与密钥保管库关联的所有数据加密密钥。

如果密钥保管库为空，则不返回任何内容。

行为

需要在数据库连接上配置客户端字段级加密

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

例子

以下示例使用本地托管的 KMS进行客户端字段级加密配置。

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

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

使用生成的本地密钥字符串创建客户端字段级加密对象：

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

使用Mongo()构造函数创建具有客户端字段级加密选项的数据库连接。 将mongodb://myMongo.example.net URI 替换为目标集群的连接字符串 URI 。

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

检索KeyVault对象并使用KeyVault.getKeys()方法检索密钥保管库中的所有数据加密密钥：

keyVault.getKeys()

getKeys() 返回密钥保管库中的所有数据加密密钥，输出类似于以下内容：

{
  "_id" : UUID("b4b41b33-5c97-412e-a02b-743498346079"),
  "keyMaterial" : BinData(0,"PXRsLOAYxhzTS/mFQAI8486da7BwZgqA91UI7NKz/T/AjB0uJZxTvhvmQQsKbCJYsWVS/cp5Rqy/FUX2zZwxJOJmI3rosPhzV0OI5y1cuXhAlLWlj03CnTcOSRzE/YIrsCjMB0/NyiZ7MRWUYzLAEQnE30d947XCiiHIb8a0kt2SD0so8vZvSuP2n0Vtz4NYqnzF0CkhZSWFa2e2yA=="),
  "creationDate" : ISODate("2021-03-15T12:21:13.123Z"),
  "updateDate" : ISODate("2021-03-15T12:21:13.123Z"),
  "status" : 0, "version" : NumberLong(0),
  "masterKey" : {
    "provider" : "local"
  },
  "keyAltNames" : [
     "alpha"
  ]
}
{
  "_id" : UUID("f1add015-c7ab-49a2-a071-50b0ca0a8fbc"),
  "keyMaterial" : BinData(0,"E+0jZKzA4YuE1lGmSVIy2mivqH4JxFo0yFATdxYX/s0YtMFsgVXyu7Bbn4IQ2gn7F/9JAPJFOxdQc5lN3AR+oX33ewVZsd63f3DN1zzcukqdR2Y+EeO7ekRxyRjdzMaNNrBNIv9Gn5LEJgWPSYkG8VczF7cNZnc1YmnR0tuDPNYfm0J7dCZuZUNWW3FCGRcdFx6AlXiCtXKNR97hJ216pQ=="),
  "creationDate" : ISODate("2021-03-16T18:22:43.733Z"),
  "updateDate" : ISODate("2021-03-16T18:22:43.733Z"),
  "status" : 0, "version" : NumberLong(0),
  "masterKey" : {
    "provider" : "local"
  },
  "keyAltNames" : [
     "baker"
  ]
}

后退

KeyVault.getKey

来年

KeyVault.getKeyByAltName

在此页面上