PHP 8.4.0 RC4 available for testing

Класс 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 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

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

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

Замечание:

Модуль пока не поддерживает запросы диапазона для BSON-полей с типом Decimal128.

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

Эту константу объявили устаревшей и удалят в будущей основной версии.

Содержание

Добавить

Примечания пользователей

Пользователи ещё не добавляли примечания для страницы
To Top