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 字串 ALGORITHM_INDEXED = Indexed;

const 字串 ALGORITHM_UNINDEXED = Unindexed;

const 字串 ALGORITHM_RANGE = Range;

const 字串 ALGORITHM_RANGE_PREVIEW = RangePreview;

const 字串 QUERY_TYPE_EQUALITY = equality;

const 字串 QUERY_TYPE_RANGE = range;

const 字串 QUERY_TYPE_RANGE_PREVIEW = rangePreview;

/* 方法 */

final public addKeyAltName(MongoDB\BSON\Binary $keyId, 字串 $keyAltName): ?final public __construct(陣列 $options)

final public createDataKey(字串 $kmsProvider, ?陣列 $options = null): MongoDB\BSON\Binary

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

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

final public encrypt(混合類型 $value, ?陣列 $options = null): MongoDB\BSON\Binary

final public encryptExpression(陣列|物件 $expr, ?陣列 $options = null): 物件

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

final public getKeyByAltName(字串 $keyAltName): ?物件

final public getKeys(): MongoDB\Driver\Cursor

final public removeKeyAltName(MongoDB\BSON\Binary $keyId, 字串 $keyAltName): ?物件

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

指定用於已建立索引的加密有效負載的演算法，可用於可查詢加密。

要使用已建立索引的加密有效負載進行插入或查詢，MongoDB\Driver\Manager 必須使用 "autoEncryption" 驅動程式選項進行配置。"bypassQueryAnalysis" 自動加密選項可以是 true。"bypassAutoEncryption" 自動加密選項必須是 false。

MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED

指定用於未建立索引的加密有效負載的演算法。

MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE

指定用於範圍加密有效負載的演算法，可用於可查詢加密。

要使用範圍加密有效負載進行查詢，MongoDB\Driver\Manager 必須使用 "autoEncryption" 驅動程式選項進行配置。"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。