VerifiableController::renderJSON() - Code Metrics - Inspection of "FIX: CMS UI now works." - phptek/silverstripe-verifiable - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( ffc3d5...a2ac04 )

by Russell
created 2018-06-25 08:50 UTC
VerifiableController::renderJSON() A

↳ Parent: VerifiableController
Complexity

Conditions	1
Paths	1
Size

Total Lines
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
nc	1
nop	1
dl	0
loc	5
rs	10
c	0
b	0
f	0
<?php

/**
 * @author  Russell Michell 2018 <[email protected]>
 * @package silverstripe-verifiable
 */

namespace PhpTek\Verifiable\Controller;

use SilverStripe\Control\Controller;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Versioned\Versioned;
use PhpTek\Verifiable\ORM\FieldType\ChainpointProof;
use SilverStripe\ORM\ValidationException;

/**
 * Accepts incoming requests for data verification e.g. from within the CMS
 * or framework's admin area, proxies them through {@link VerifiableService} and
 * sends them on their way.
 *
 * Will proxy validation requests to the currently configured backend for both
 * {@link SiteTree} and {@link DataObject} subclasses.
 *
 * @todo Take into account LastEdited and Created dates, outside of userland control
 * of verifiable_fields
 * @todo Rename to "VerifiableController"
 */
class VerifiableController extends Controller
{
    /**
     * No local proof found. Evidence that the record has been tampered-with.
     *
     * @var string
     */
    const STATUS_LOCAL_PROOF_NONE = 'Local Proof Not Found';

    /**
     * Invalid local proof found. Evidence that the record has been tampered-with.
     *
     * @var string
     */
    const STATUS_LOCAL_PROOF_INVALID = 'Local Proof Invalid';

    /**
     * Invalid local hash found. Evidence that the record has been tampered-with.
     *
     * @var string
     */
    const STATUS_LOCAL_HASH_INVALID = 'Local Hash Invalid';

    /**
     * Invalid or no matching remote proof found. Evidence that the record has been tampered-with.
     *
     * @var string
     */
    const STATUS_REMOTE_HASH_INVALID_NO_DATA = 'Remote Hash Not Found';

    /**
     * Invalid remote hash found. Evidence that the record has been tampered-with.
     *
     * @var string
     */
    const STATUS_REMOTE_HASH_INVALID_NO_HASH = 'Remote Hash Not Found';

    /**
     * Invalid UUID. Evidence that the record has been tampered-with.
     *
     * @var string
     */
    const STATUS_UUID_INVALID = 'Invalid UUID';

    /**
     * All checks passed. Submitted hash is verified.
     *
     * @var string
     */
    const STATUS_VERIFIED = 'Verified';

    /**
     * All checks passed. But submitted hash is not yet verified.
     *
     * @var string
     */
    const STATUS_UNVERIFIED = 'Unverified';

    /**
     * Some kind of upstream error.
     *
     * @var string
     */
    const STATUS_UPSTREAM_ERROR = 'Upstream Error';

    /**
     * @var array
     */
    private static $allowed_actions = [

        'verifyhash',
    ];

    /**
     * Verify the integrity of arbitrary data by means of a single hash.
     *
     * Responds to URIs of the following prototype: /verifiable/verify/<model>/<ID>/<VID>
     * by echoing a JSON response for consumption by client-side logic.
     *
     * @param  HTTPRequest $request
     * @return void
     */
    public function verifyhash(HTTPRequest $request)
    {
        $class = $request->param('ClassName');
        $id = $request->param('ModelID');
        $version = $request->param('VersionID');

        if (empty($id) || !is_numeric($id) ||
                empty($version) || !is_numeric($version) ||
                empty($class)) {
            return $this->httpError(400, 'Bad request');
        }

        if (!$record = Versioned::get_version($class, $id, $version)) {
        if (!$record = Versioned::get_version($class, /** @scrutinizer ignore-type */ $id, $version)) {
            return $this->httpError(400, 'Bad request');
        }

        try {
            $status = $this->getVerificationStatus($record, $record->getExtraByIndex());
            $status = $this->getVerificationStatus($record, $record->/** @scrutinizer ignore-call */ getExtraByIndex());
        } catch (ValidationException $ex) {
            $status = self::STATUS_UPSTREAM_ERROR;
        }

        $response = json_encode([
            'RecordID' => "$record->RecordID",

            'Version' => "$record->Version",

            'Class' => get_class($record),
            'StatusNice' => $status,
            'StatusCode' => $this->getCodeMeta($status, 'code'),
            'StatusDefn' => $this->getCodeMeta($status, 'defn'),
            'SubmittedAt' => $record->dbObject('Proof')->getSubmittedAt(),
            'SubmittedAt' => $record->dbObject('Proof')->/** @scrutinizer ignore-call */ getSubmittedAt(),
            'SubmittedTo' => $record->dbObject('Extra')->getStoreAsArray(),
            'SubmittedTo' => $record->dbObject('Extra')->/** @scrutinizer ignore-call */ getStoreAsArray(),
        ], JSON_UNESCAPED_UNICODE);

        $this->renderJSON($response);
    }

    /**
     *
     * @param  string $key
     * @return mixed
     */
    private function getCodeMeta($status, $key)
    {
        $refl = new \ReflectionClass(__CLASS__);
        $const = array_search($status, $refl->getConstants());
        $keyJson = file_get_contents(realpath(__DIR__) . '/../../statuses.json');
        $keyMap = json_decode($keyJson, true);
        $defn = '';

        foreach ($keyMap as $map) {
            if (isset($map[$const])) {
                $defn = $map[$const];
            }
        }

        $data = [
            'code' => $const,
            'defn' => $defn,
        ];

        return isset($data[$key]) ? $data[$key] : $data;

    }

    /**
     * Gives us the current verification status of the given record. Takes into
     * account the state of the saved proof as well as by making a backend
     * verification call.
     *
     * For the ChainPoint Backend, the following process occurs:
     *
     * 1. Re-hash verifiable_fields as stored within the "Proof" field
     * 2. Assert that the record's "Proof" field is not empty
     * 3. Assert that the record's "Proof" field contains a valid proof
     * 4. Assert that the new hash exists in the record's "Proof" field
     * 5. Assert that hash_node_id for that proof returns a valid response from ChainPoint
     * 6. Assert that the returned data contains a matching hash for the new hash
     *
     * @param  DataObject $record
filter:
    dependency_paths: ["lib/*"]
     * @param  array      $nodes
     * @return string
     */
    public function getVerificationStatus($record, $nodes)
    {
        // Set some extra data on the service. In this case, the actual chainpoint
        // node addresses, used to submit hashes for the given $record
        $this->verifiableService->setExtra($nodes);
                                  setExtra($nodes);

        // Basic existence of proof (!!) check
        if (!$proof = $record->dbObject('Proof')) {
            return self::STATUS_LOCAL_PROOF_NONE;
        }

        // Basic proof validity check
        // @todo Beef this up to ensure that a basic regex is run over each to ensure it's all
        // not just gobbledygook
        if (!$proof->getHashIdNode() || !$proof->getHash() || !$proof->getSubmittedAt()) {
            return self::STATUS_LOCAL_PROOF_INVALID;
        }

        // Comparison check between locally stored proof, and re-hashed record data
        if ($proof->getHash() !== $reHash = $this->verifiableService->hash($record->normaliseData())) {
            return self::STATUS_LOCAL_HASH_INVALID;
        }

        // Remote verification check that local hash_node_id returns a valid response
        // Responds with a binary format proof
        $responseBinary = $this->verifiableService->read($proof->getHashIdNode());

        if ($responseBinary === '[]') {
            return self::STATUS_UUID_INVALID;
        }

        // Extract the "proof" component of the "binary" response to send for verification
        $responseBinaryProof = ChainpointProof::create()
                ->setValue($responseBinary)
                ->getProof();
        $responseVerify = $this->verifiableService->verify($responseBinaryProof);

        if ($responseVerify === '[]') {
            return self::STATUS_REMOTE_HASH_INVALID_NO_DATA;
        }

        // Compare returned hash matches the re-hash
        $responseProof = ChainpointProof::create()->setValue($responseVerify);

        if (!$responseProof->match($reHash)) {
            return self::STATUS_REMOTE_HASH_NO_HASH;

        }

        if ($responseProof->getStatus() === 'verified') {
            return self::STATUS_VERIFIED;
        }

        return self::STATUS_UNVERIFIED;
    }

    /**
     * Properly return JSON, allowing consumers to render returned JSON correctly.
     *
     * @param  string $json
     * @return void
     */
    private function renderJSON(string $json)
    {
        header('Content-Type: application/json');
        echo $json;
        exit(0);

    }

}

phptek / silverstripe-verifiable

Push — master ( ffc3d5...a2ac04 )

VerifiableController::renderJSON() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
