PHP: полный мануал с примерами, функциями и ООП

<?php
declare(strict_types=1);
use MongoDB\BSON\Binary;
use MongoDB\Driver\ClientEncryption as Encryption;

require __DIR__.'/qec133-helper.php';
set_exception_handler(static function(Throwable $error): void {
    // Print only the class: a message or trace may contain protected data.
    fwrite(STDERR,'QE example failed: '.$error::class.PHP_EOL);
    exit(1);
});
[$rows,$checks,$runtime,$counts] = qecFixture(static function(array $lab): array {
    $plainMap = $lab['plain']->getManager()->getEncryptedFieldsMap();
    $qeMap = $lab['client']->getManager()->getEncryptedFieldsMap();
    $rule = qecField($qeMap,$lab['ns']);
    $fields = qecField($rule,'fields');
    $field = qecField($fields,0);
    qecWriteBox($lab,'A-12',42,'осмотрена');
    $card = $lab['collection']->findOne(['_id'=>'A-12'],['projection'=>['_id'=>0,'weight'=>1]]);
    $checks = ['plain_unconfigured'=>$plainMap === null,'local_map_exists'=>$qeMap !== null,'namespace_found'=>$rule !== null,
        'weight_mapped'=>qecField($field,'path') === 'weight','correct_type'=>qecField($field,'bsonType') === 'int','read_back'=>$card->weight === 42];
    $rows = [['Карта обычного клиента',$plainMap],['Для этой коллекции карта есть',$rule !== null],
        ['Поле в карте',qecField($field,'path')],['Масса из карточки',$card->weight]];
    return [$rows,$checks];
}, false);
qecReport('mongodb133-qec-client-map', ['Что проверили', 'Результат'], $rows,$checks,$runtime,$counts);
echo 'mongodb133-qec-client-map: OK', PHP_EOL;

mongodb133-qec-client-map: OK

Запуск создаёт собственную QE-коллекцию, её служебные пространства и vault, выполняет наблюдение и проверяет очистку. Секретные байты отделены от публичного результата.

<?php
declare(strict_types=1);
use MongoDB\BSON\Binary;
use MongoDB\Driver\ClientEncryption as Encryption;

require __DIR__.'/qec133-helper.php';
set_exception_handler(static function(Throwable $error): void {
    // Print only the class: a message or trace may contain protected data.
    fwrite(STDERR,'QE example failed: '.$error::class.PHP_EOL);
    exit(1);
});
[$rows,$checks,$runtime,$counts] = qecFixture(static function(array $lab): array {
    $map = $lab['client']->getManager()->getEncryptedFieldsMap();
    $byFull = qecField($map,$lab['ns']);
    $byShort = qecField($map,$lab['name']);
    $otherDatabase = qecField($map,'other_lab.'.$lab['name']);
    $field = qecField(qecField($byFull,'fields'),0);
    $queries = qecQueryRule($field);
    qecWriteBox($lab,'NS-1',35,'взвешена');
    $tag = $lab['collection']->findOne(['_id'=>'NS-1'],['projection'=>['_id'=>0,'label'=>1]]);
    $checks = ['full_namespace_found'=>$byFull !== null,'short_name_absent'=>$byShort === null,
        'wrong_database_absent'=>$otherDatabase === null,'key_matches'=>qecField($field,'keyId') == $lab['weightId'],
        'range_rule'=>qecField($queries,'queryType') === 'range', 'box_found'=>$tag->label === 'взвешена'];
    $rows = [['Полное имя подошло',$byFull !== null],['Только имя коллекции подошло',$byShort !== null],
        ['Имя в другой базе подошло',$otherDatabase !== null],['Вид поиска',qecField($queries,'queryType')],['Открытая метка',$tag->label]];
    return [$rows,$checks];
}, false);
qecReport('mongodb133-qec-namespace', ['Что проверили', 'Результат'], $rows,$checks,$runtime,$counts);
echo 'mongodb133-qec-namespace: OK', PHP_EOL;

mongodb133-qec-namespace: OK

Запуск создаёт собственную QE-коллекцию, её служебные пространства и vault, выполняет наблюдение и проверяет очистку. Секретные байты отделены от публичного результата.

<?php
declare(strict_types=1);
use MongoDB\BSON\Binary;
use MongoDB\Driver\ClientEncryption as Encryption;

require __DIR__.'/qec133-helper.php';
set_exception_handler(static function(Throwable $error): void {
    // Print only the class: a message or trace may contain protected data.
    fwrite(STDERR,'QE example failed: '.$error::class.PHP_EOL);
    exit(1);
});
[$rows,$checks,$runtime,$counts] = qecFixture(static function(array $lab): array {
    $map = $lab['client']->getManager()->getEncryptedFieldsMap();
    $local = qecField(qecField(qecField($map,$lab['ns']),'fields'),0);
    $catalog = iterator_to_array($lab['db']->listCollections(['filter'=>['name'=>$lab['name']]]),false);
    $serverFields = $catalog[0]->getOptions()['encryptedFields'];
    $remote = qecField(qecField($serverFields,'fields'),0);
    $rule = qecQueryRule($remote);
    $localRule = qecQueryRule($local);
    $sameKey = qecField($local,'keyId') == qecField($remote,'keyId');
    $sameBounds = qecField($rule,'min') === qecField($localRule,'min') && qecField($rule,'max') === qecField($localRule,'max');
    $checks = ['server_collection'=>count($catalog) === 1 && $catalog[0]->getName() === $lab['name'],
        'path_on_server'=>qecField($remote,'path') === 'weight','int_on_server'=>qecField($remote,'bsonType') === 'int',
        'rule_on_server'=>qecField($rule,'queryType') === 'range','range_matches'=>$sameBounds && qecField($rule,'min') === 0 && qecField($rule,'max') === 200,
        'same_field_key'=>$sameKey,'local_and_remote_path'=>qecField($local,'path') === qecField($remote,'path')];
    $rows = [['Путь на сервере',qecField($remote,'path')],['Тип BSON',qecField($remote,'bsonType')],
        ['Минимальная масса',qecField($rule,'min')],['Максимальная масса',qecField($rule,'max')],['Ключ для поля совпал',$sameKey]];
    return [$rows,$checks];
}, false);
qecReport('mongodb133-qec-server-schema', ['Что проверили', 'Результат'], $rows,$checks,$runtime,$counts);
echo 'mongodb133-qec-server-schema: OK', PHP_EOL;

mongodb133-qec-server-schema: OK

Запуск создаёт собственную QE-коллекцию, её служебные пространства и vault, выполняет наблюдение и проверяет очистку. Секретные байты отделены от публичного результата.

<?php
declare(strict_types=1);
use MongoDB\BSON\Binary;
use MongoDB\Driver\ClientEncryption as Encryption;

require __DIR__.'/qec133-helper.php';
set_exception_handler(static function(Throwable $error): void {
    // Print only the class: a message or trace may contain protected data.
    fwrite(STDERR,'QE example failed: '.$error::class.PHP_EOL);
    exit(1);
});
[$rows,$checks,$runtime,$counts] = qecFixture(static function(array $lab): array {
    qecWriteBox($lab,'STORE-1',60,'на полке');
    $raw = $lab['raw']->findOne(['_id'=>'STORE-1']);
    $hasSafeContent = isset($raw->__safeContent__);
    $hasQueryIndex = false;
    foreach ($lab['raw']->listIndexes() as $description) {
        if (($description->getKey()['__safeContent__'] ?? null) === 1) {$hasQueryIndex = true;}
    }
    $checks = ['business_exists'=>in_array($lab['name'],$lab['seen'],true),'vault_exists'=>in_array($lab['vault'],$lab['seen'],true),
        'esc_exists'=>in_array($lab['esc'],$lab['seen'],true),'ecoc_exists'=>in_array($lab['ecoc'],$lab['seen'],true),
        'metadata_field'=>$hasSafeContent,'metadata_index'=>$hasQueryIndex,'protected_subtype'=>$raw->weight->getType() === 6];
    $rows = [['Создано пространств имён',count($lab['seen'])],['Есть ESC',$checks['esc_exists']],['Есть ECOC',$checks['ecoc_exists']],
        ['Документ содержит служебное поле',$hasSafeContent],['Есть индекс по __safeContent__',$hasQueryIndex]];
    return [$rows,$checks];
}, false);
qecReport('mongodb133-qec-storage-parts', ['Что проверили', 'Результат'], $rows,$checks,$runtime,$counts);
echo 'mongodb133-qec-storage-parts: OK', PHP_EOL;

mongodb133-qec-storage-parts: OK

Запуск создаёт собственную QE-коллекцию, её служебные пространства и vault, выполняет наблюдение и проверяет очистку. Секретные байты отделены от публичного результата.

<?php
declare(strict_types=1);
use MongoDB\BSON\Binary;
use MongoDB\Driver\ClientEncryption as Encryption;

require __DIR__.'/qec133-helper.php';
set_exception_handler(static function(Throwable $error): void {
    // Print only the class: a message or trace may contain protected data.
    fwrite(STDERR,'QE example failed: '.$error::class.PHP_EOL);
    exit(1);
});
[$rows,$checks,$runtime,$counts] = qecFixture(static function(array $lab): array {
    qecWriteBox($lab,'BOX-50',50,'упакована');
    $raw = $lab['raw']->findOne(['_id'=>'BOX-50'],['projection'=>['_id'=>1,'weight'=>1,'label'=>1]]);
    $opened = $lab['collection']->findOne(['_id'=>'BOX-50'],['projection'=>['_id'=>1,'weight'=>1,'label'=>1]]);
    $checks = ['same_box'=>$raw->_id === $opened->_id && $raw->_id === 'BOX-50',
        'raw_is_binary'=>$raw->weight instanceof Binary,'raw_subtype'=>$raw->weight->getType() === 6,
        'application_integer'=>is_int($opened->weight),'application_weight'=>$opened->weight === 50,
        'label_unchanged'=>$raw->label === $opened->label && $raw->label === 'упакована'];
    $rows = [['Коробка',$opened->_id],['Подтип weight у обычного клиента',$raw->weight->getType()],
        ['Масса на экране приложения',$opened->weight],['Открытая подпись',$opened->label]];
    return [$rows,$checks];
}, false);
qecReport('mongodb133-qec-raw-and-application', ['Что проверили', 'Результат'], $rows,$checks,$runtime,$counts);
echo 'mongodb133-qec-raw-and-application: OK', PHP_EOL;

mongodb133-qec-raw-and-application: OK

Запуск создаёт собственную QE-коллекцию, её служебные пространства и vault, выполняет наблюдение и проверяет очистку. Секретные байты отделены от публичного результата.

<?php
declare(strict_types=1);
use MongoDB\BSON\Binary;
use MongoDB\Driver\ClientEncryption as Encryption;

require __DIR__.'/qec133-helper.php';
set_exception_handler(static function(Throwable $error): void {
    // Print only the class: a message or trace may contain protected data.
    fwrite(STDERR,'QE example failed: '.$error::class.PHP_EOL);
    exit(1);
});
[$rows,$checks,$runtime,$counts] = qecFixture(static function(array $lab): array {
    qecWriteBox($lab,'P-2',75,'полка B');
    qecWriteBox($lab,'P-1',25,'полка A');
    $labels = [];
    foreach ($lab['raw']->find([],['sort'=>['_id'=>1],'projection'=>['_id'=>1,'label'=>1],'limit'=>2]) as $doc) {
        if (isset($doc->weight) || isset($doc->__safeContent__)) {throw new RuntimeException('Projection mismatch');}
        $labels[] = $doc->_id.' — '.$doc->label;
    }
    $detail = $lab['collection']->findOne(['_id'=>'P-2'],['projection'=>['_id'=>0,'weight'=>1]]);
    $checks = ['two_labels'=>count($labels) === 2,'first_label'=>$labels[0] === 'P-1 — полка A','second_label'=>$labels[1] === 'P-2 — полка B',
        'selected_weight'=>$detail->weight === 75,'detail_excludes_label'=>!isset($detail->label),'detail_excludes_id'=>!isset($detail->_id)];
    $rows = [['Первая строка списка',$labels[0]],['Вторая строка списка',$labels[1]],['Масса выбранной P-2',$detail->weight]];
    return [$rows,$checks];
}, false);
qecReport('mongodb133-qec-public-projection', ['Что проверили', 'Результат'], $rows,$checks,$runtime,$counts);
echo 'mongodb133-qec-public-projection: OK', PHP_EOL;

mongodb133-qec-public-projection: OK

Запуск создаёт собственную QE-коллекцию, её служебные пространства и vault, выполняет наблюдение и проверяет очистку. Секретные байты отделены от публичного результата.

<?php
declare(strict_types=1);
use MongoDB\BSON\Binary;
use MongoDB\Driver\ClientEncryption as Encryption;

require __DIR__.'/qec133-helper.php';
set_exception_handler(static function(Throwable $error): void {
    // Print only the class: a message or trace may contain protected data.
    fwrite(STDERR,'QE example failed: '.$error::class.PHP_EOL);
    exit(1);
});
[$rows,$checks,$runtime,$counts] = qecFixture(static function(array $lab): array {
    $wrong = new MongoDB\Driver\BulkWrite();
    $wrong->insert(['_id'=>'BAD-50','label'=>'не должна появиться','weight'=>50]);
    $itemCode = null;
    try {
        $lab['plain']->getManager()->executeBulkWrite($lab['ns'],$wrong);
    } catch (MongoDB\Driver\Exception\BulkWriteException $error) {
        $errors = $error->getWriteResult()->getWriteErrors();
        if (count($errors) !== 1 || $errors[0]->getCode() !== 121) {throw $error;}
        $itemCode = $errors[0]->getCode();
    }
    $absent = $lab['raw']->countDocuments(['_id'=>'BAD-50']);
    qecWriteBox($lab,'GOOD-50',50,'прошла проверку');
    $good = $lab['collection']->findOne(['_id'=>'GOOD-50'],['projection'=>['_id'=>1,'weight'=>1]]);
    $physical = $lab['raw']->findOne(['_id'=>'GOOD-50'],['projection'=>['_id'=>0,'weight'=>1]]);
    $checks = ['validation_error'=>$itemCode === 121,'failed_doc_absent'=>$absent === 0,
        'exactly_one_good'=>$lab['raw']->countDocuments(['_id'=>'GOOD-50']) === 1,'correct_id'=>$good->_id === 'GOOD-50',
        'valid_input_round_trip'=>$good->weight === 50,'stored_as_cipher'=>$physical->weight->getType() === 6];
    $rows = [['Код ошибки для открытой записи',$itemCode],['Строк для BAD-50',$absent],
        ['Масса GOOD-50 после корректной записи',$good->weight],['Подтип сохранённого поля',$physical->weight->getType()]];
    return [$rows,$checks];
}, false);
qecReport('mongodb133-qec-reject-plaintext', ['Что проверили', 'Результат'], $rows,$checks,$runtime,$counts);
echo 'mongodb133-qec-reject-plaintext: OK', PHP_EOL;

mongodb133-qec-reject-plaintext: OK

Запуск создаёт собственную QE-коллекцию, её служебные пространства и vault, выполняет наблюдение и проверяет очистку. Секретные байты отделены от публичного результата.

<?php
declare(strict_types=1);
use MongoDB\BSON\Binary;
use MongoDB\Driver\ClientEncryption as Encryption;

require __DIR__.'/qec133-helper.php';
set_exception_handler(static function(Throwable $error): void {
    // Print only the class: a message or trace may contain protected data.
    fwrite(STDERR,'QE example failed: '.$error::class.PHP_EOL);
    exit(1);
});
[$rows,$checks,$runtime,$counts] = qecFixture(static function(array $lab): array {
    $zoneOptions = ['keyId'=>$lab['zoneId'],'algorithm'=>Encryption::ALGORITHM_INDEXED,'contentionFactor'=>0];
    $weightCipher = $lab['crypto']->encrypt(80,$lab['rangeOptions']);
    $zoneCipher = $lab['crypto']->encrypt('east',$zoneOptions);
    $lab['collection']->insertOne(['_id'=>'DUAL-1','weight'=>$weightCipher,'zone'=>$zoneCipher,'label'=>'отгрузка']);
    $opened = $lab['collection']->findOne(['_id'=>'DUAL-1'],['projection'=>['_id'=>0,'weight'=>1,'zone'=>1]]);
    $raw = $lab['raw']->findOne(['_id'=>'DUAL-1'],['projection'=>['_id'=>0,'weight'=>1,'zone'=>1]]);
    $map = $lab['client']->getManager()->getEncryptedFieldsMap();
    $rules = [];
    foreach (qecField(qecField($map,$lab['ns']),'fields') as $field) {
        $rules[qecField($field,'path')] = qecField(qecQueryRule($field),'queryType');
    }
    $checks = ['two_field_rules'=>count($rules) === 2,'range_weight'=>$rules['weight'] === 'range','zone_equality'=>$rules['zone'] === 'equality',
        'independent_keys'=>$lab['weightId'] != $lab['zoneId'],'two_cipher_fields'=>$raw->weight->getType() === 6 && $raw->zone->getType() === 6,
        'opened_weight'=>$opened->weight === 80,'opened_zone'=>$opened->zone === 'east'];
    $rows = [['Поиск поля weight',$rules['weight']],['Поиск поля zone',$rules['zone']],['Для полей разные DEK',$checks['independent_keys']],
        ['Зона в карточке',$opened->zone],['Масса в карточке',$opened->weight]];
    return [$rows,$checks];
}, true);
qecReport('mongodb133-qec-two-fields', ['Что проверили', 'Результат'], $rows,$checks,$runtime,$counts);
echo 'mongodb133-qec-two-fields: OK', PHP_EOL;

mongodb133-qec-two-fields: OK

Запуск создаёт собственную QE-коллекцию, её служебные пространства и vault, выполняет наблюдение и проверяет очистку. Секретные байты отделены от публичного результата.