PHP 8.3.4 Released!

Класс MongoDB\Driver\ClientEncryption

(mongodb >=1.7.0)

Введение

Класс MongoDB\Driver\ClientEncryption обрабатывает как создание ключей шифрования на стороне клиента, так и ручное шифрование/дешифрование.

Обзор классов

final class MongoDB\Driver\ClientEncryption {
/* Constants */
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_PREVIEW = RangePreview;
const string QUERY_TYPE_EQUALITY = equality;
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 removeKeyAltName(MongoDB\BSON\Binary $keyId, string $keyAltName): ?object
final public rewrapManyDataKey(array|object $filter, ?array $options = null): object
}

Предопределённые константы

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_PREVIEW

Определяет алгоритм для диапазона, зашифрованной полезной нагрузки, которая может быть использована с шифрованием с возможностью запроса.

Для выполнения запроса с зашифрованной полезной нагрузкой диапазона MongoDB\Driver\Manager должен быть настроен с опцией драйвера "autoEncryption". Опция "bypassQueryAnalysis" автоматического шифрования может быть true. Параметр "bypassAutoEncryption" автоматического шифрования должен быть false.

Замечание:

Алгоритм диапазона является экспериментальным. Он не предназначен для публичного использования.

Драйвер PHP пока не поддерживает запросы диапазона для типов полей decimal128 BSON.

MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY

Определяет тип запроса равенства, который используется в сочетании с MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED.

MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW

Задаёт тип запроса диапазона, который используется в сочетании с MongoDB\Driver\ClientEncryption::ALGORITHM_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.

Содержание

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top