KeyVault.removeKeyAlternateName()

~~On this page~~本页内容

~~Behavior~~行为
~~Example~~示例

KeyVault.removeKeyAlternateName(UUID, keyAltName)

Removes the specified keyAltName from the data encryption key with the specified UUID. The data encryption key must exist in the key vault associated to the database connection.

removeKeyAlternateName() has the following syntax:

keyVault = db.getMongo().getKeyVault()
keyVault.removeKeyAlternateName(
  UUID("<UUID string>"),
  "keyAltName"
)

~~Returns:~~返回：	The data encryption key prior to updating the `keyAltName`. Returns `null` if no data encryption key has the specified `UUID()`.

Behavior行为

Requires Configuring Client-Side Field Level Encryption on Database Connection需要在数据库连接上配置客户端字段级加密

The mongo 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:

Use the Mongo() constructor from the mongo shell to establish a connection with the required client-side field level encryption options. The Mongo() method supports the following Key Management Service (KMS) providers for Customer Master Key (CMK) management:
or
Use the mongo shell command line options to establish a connection with the required options. The command line options only support the Amazon Web Services KMS provider for CMK management.

Example示例

~~The following example is intended for rapid evaluation of client-side field level encryption.~~ 以下示例旨在快速评估客户端字段级加密。For specific examples of using KeyVault.removeKeyAlternateName() with each supported KMS provider, see Manage a Data Encryption Key's Alternate Name.

Configuring client-side field level encryption for a locally managed key requires specifying a base64-encoded 96-byte string with no line breaks. The following operation generates a key that meets the stated requirements and loads it into the 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'"

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

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

~~Use the Mongo() constructor to create a database connection with the client-side field level encryption options.~~ 使用Mongo()构造函数创建具有客户端字段级加密选项的数据库连接。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",
  ClientSideFieldLevelEncryptionOptions
)

~~Retrieve the keyVault object and use the KeyVault.removeKeyAlternateName() method to remove the specified key alternate name from the data encryption key with matching UUID:~~检索keyVault对象，并使用KeyVault.removeKeyAlternateName()方法从具有匹配UUID的数据加密密钥中删除指定的密钥替代名称：

keyVault = encryptedClient.getKeyVault()
keyVault.removeKeyAlternateName(UUID("b4b41b33-5c97-412e-a02b-743498346079"),"Other-Data-Encryption-Key")

~~If successful, removeKeyAlternateName() returns the data encryption key prior to updating the keyAltName.~~如果成功，removeKeyAlternateName()将在更新keyAltName之前返回数据加密密钥。

{
    "_id" : UUID("b4b41b33-5c97-412e-a02b-743498346079"),
    "keyMaterial" : BinData(0,"PXRsLOAYxhzTS/mFQAI8486da7BwZgqA91UI7NKz/T/AjB0uJZxTvhvmQQsKbCJYsWVS/cp5Rqy/FUX2zZwxJOJmI3rosPhzV0OI5y1cuXhAlLWlj03CnTcOSRzE/YIrsCjMB0/NyiZ7MRWUYzLAEQnE30d947XCiiHIb8a0kt2SD0so8vZvSuP2n0Vtz4NYqnzF0CkhZSWFa2e2yA=="),
    "creationDate" : ISODate("2019-08-12T21:21:30.569Z"),
    "updateDate" : ISODate("2019-08-12T21:21:30.569Z"),
    "status" : 0,
    "version" : NumberLong(0),
    "masterKey" : {
        "provider" : "local"
    },
    "keyAltNames" : [
        "ssn-encryption-key"
    ]
}

← KeyVault.addKeyAlternateName()KeyVault.getKeyByAltName() →