MongoDB\Driver\ClientEncryption::rewrapManyDataKey

(mongodb >=1.15.0)

MongoDB\Driver\ClientEncryption::rewrapManyDataKey重新包装数据密钥

说明

final public MongoDB\Driver\ClientEncryption::rewrapManyDataKey(array|object $filter, ?array $options = null): object

重新包装(即解密和重新加密)密钥库集合中与给定 filter 匹配的零个或多个数据密钥。

如果未指定 "provider" 选项,则匹配的数据密钥将使用其当前 KMS 提供程序重新包装。否则,匹配的数据密钥将根据指定的 "provider""masterKey" 选项重新加密。

参数

filter (array|object)

The » 查询谓词。空谓词将匹配集合中的所有文档。

注意: 在评估查询条件时,MongoDB 根据其自己的 » BSON 类型比较规则 比较类型和值,这与 PHP 的 比较类型强制转换 规则不同。当匹配特殊 BSON 类型时,查询条件应使用相应的 BSON 类(例如,使用 MongoDB\BSON\ObjectId 来匹配 » ObjectId)。

options

RewrapManyDataKey 选项
选项 类型 说明
provider string

将用于重新加密匹配数据密钥的 KMS 提供程序(例如 "local""aws")。

如果没有指定 KMS 提供程序,则匹配的数据密钥将使用其当前 KMS 提供程序重新加密。

masterKey array

masterKey 标识用于加密新数据密钥的特定于 KMS 的密钥。此选项不应在没有 "provider" 选项的情况下指定。如果指定了 "provider" 但未指定 "local",则此选项是必需的。

"aws" 提供程序选项
选项 类型 说明
region string 必需的。
key string 必需的。指向 AWS 客户主密钥 (CMK) 的 Amazon 资源名称 (ARN)。
endpoint string 可选的。用于发送 KMS 请求的备用主机标识符。可能包含端口号。

"azure" 提供程序选项
选项 类型 说明
keyVaultEndpoint string 必需的。主机,可选端口(例如“example.vault.azure.net”)。
keyName string 必需的。
keyVersion string 可选的。命名密钥的特定版本。默认为使用密钥的主版本。

"gcp" 提供程序选项
选项 类型 说明
projectId string 必需的。
location string 必需的。
keyRing string 必需的。
keyName string 必需的。
keyVersion string 可选的。命名密钥的特定版本。默认为使用密钥的主版本。
endpoint string 可选的。主机,可选端口。默认为“cloudkms.googleapis.com”。

"kmip" 提供程序选项
选项 类型 说明
keyId string 可选的。指向 96 字节 KMIP 密钥数据管理对象的唯一标识符。如果未指定,则驱动程序将创建一个随机的 96 字节 KMIP 密钥数据管理对象。
endpoint string 可选的。主机,可选端口。

返回值

返回一个对象,该对象将具有一个可选的 bulkWriteResult 属性,其中包含内部 bulkWrite 操作的结果作为对象。如果没有任何数据密钥匹配筛选器或写入未确认,则 bulkWriteResult 属性将为 null

错误/异常

添加注释

用户贡献的注释

此页面没有用户贡献的注释。
To Top