PHP Conference Japan 2024

MongoDB\Driver\ClientEncryption::rewrapManyDataKey

(mongodb >=1.15.0)

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

描述

final public MongoDB\Driver\ClientEncryption::rewrapManyDataKey(数组|对象 $filter, ?数组 $options = null): 对象

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

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

参数

filter (数组|对象)

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

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

选项

RewrapManyDataKey选项
选项 类型 描述
provider 字符串

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

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

masterKey 数组

masterKey标识用于加密新数据密钥的特定于KMS的密钥。如果不指定"provider"选项,则不应指定此选项。如果指定了"provider"且不是"local",则此选项是必需的。

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

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

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

"kmip" 提供程序选项
选项 类型 描述
keyId 字符串 可选。对96字节KMIP秘密数据托管对象的唯一标识符。如果未指定,驱动程序将创建一个随机的96字节KMIP秘密数据托管对象。
endpoint 字符串 可选。主机,可选端口。

返回值

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

错误/异常

添加注释

用户贡献的注释

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