MongoDB\Driver\ClientEncryption 类

(mongodb >=1.7.0)

介绍

该MongoDB\Driver\ClientEncryption类处理客户端加密的数据密钥的创建，以及手动加密和解密值。

类概要

final class MongoDB\Driver\ClientEncryption {

/* 常量 */

const string AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC = AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic;

const string AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM = AEAD_AES_256_CBC_HMAC_SHA_512-Random;

const string ALGORITHM_INDEXED = Indexed;

const string ALGORITHM_UNINDEXED = Unindexed;

const string ALGORITHM_RANGE = Range;

const string ALGORITHM_RANGE_PREVIEW = RangePreview;

const string QUERY_TYPE_EQUALITY = equality;

const string QUERY_TYPE_RANGE = range;

const string QUERY_TYPE_RANGE_PREVIEW = rangePreview;

/* 方法 */

final public addKeyAltName(MongoDB\BSON\Binary $keyId, string $keyAltName): ?object

final public __construct(array $options)

final public createDataKey(string $kmsProvider, ?array $options = null): MongoDB\BSON\Binary

final public decrypt(MongoDB\BSON\Binary $value): mixed

final public deleteKey(MongoDB\BSON\Binary $keyId): object

final public encrypt(mixed $value, ?array $options = null): MongoDB\BSON\Binary

final public encryptExpression(array|object $expr, ?array $options = null): object

final public getKey(MongoDB\BSON\Binary $keyId): ?object

final public getKeyByAltName(string $keyAltName): ?object

final public getKeys(): MongoDB\Driver\Cursor

final public removeKeyAltName(MongoDB\BSON\Binary $keyId, string $keyAltName): ?object

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

}

预定义常量

MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC

指定用于» 确定性加密的算法，适用于查询。

MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM

指定用于» 随机加密的算法

MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED

指定用于已索引加密有效负载的算法，可用于可查询加密。

要插入或查询已索引加密有效负载，必须使用"autoEncryption"驱动程序选项配置MongoDB\Driver\Manager。"bypassQueryAnalysis"自动加密选项可以为true。"bypassAutoEncryption"自动加密选项必须为false。

MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED

指定用于未索引加密有效负载的算法。

MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE

指定用于范围加密有效负载的算法，可用于可查询加密。

要查询范围加密有效负载，必须使用"autoEncryption"驱动程序选项配置MongoDB\Driver\Manager。"bypassQueryAnalysis"自动加密选项可以为true。"bypassAutoEncryption"自动加密选项必须为false。

注意:
此扩展目前尚不支持 Decimal128 BSON 字段类型的范围查询。

MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW

此常量已弃用，将在未来的主要版本中删除。

MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY

指定相等查询类型，与MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED结合使用。

MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE

指定范围查询类型，与MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE结合使用。

MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW

此常量已弃用，将在未来的主要版本中删除。

变更日志

版本描述

PECL mongodb 1.20.0

版本	描述
PECL mongodb 1.20.0	添加了`MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE` 和 `MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE`。弃用了`MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW` 和 `MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW`。
PECL mongodb 1.16.0	添加了`MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW` 和 `MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW`。
PECL mongodb 1.14.0	添加了`MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED`、`MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED` 和 `MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY`。

添加了MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE 和 MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE。

弃用了MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW 和 MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW。

PECL mongodb 1.16.0 添加了MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW 和 MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW。

PECL mongodb 1.14.0 添加了MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED、MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED 和 MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY。