« MongoDB\\Driver\\Session::startTransactionMongoDB\\Driver\\ClientEncryption::addKeyAltName »PHP ManualMongoDB\\Driver

Клас 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 getKeys(): MongoDB\Driver\Cursor
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_INDEXEDMongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED і MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY

Дивіться також

Зміст