MediaMonks\SonataMediaBundle\Handler\SignatureParameterHandler

Complexity

Total Complexity

9

Size/Duplication

Total Lines	96
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getRouteParameters()	0	7	1
A	validateParameterBag()	0	17	3
A	isValid()	0	4	1
A	calculateSignature()	0	4	1
A	normalize()	0	9	2

<?php

namespace MediaMonks\SonataMediaBundle\Handler;

use MediaMonks\SonataMediaBundle\Exception\SignatureInvalidException;
use MediaMonks\SonataMediaBundle\Model\MediaInterface;
use MediaMonks\SonataMediaBundle\ParameterBag\ParameterBagInterface;

class SignatureParameterHandler implements ParameterHandlerInterface
{
    const PARAMETER_SIGNATURE = 's';
    const PARAMETER_BUST_CACHE = 'bc';

    /**
     * @var string
     */
    private $key;

    /**
     * @var string
     */
    private $hashAlgorithm;

    /**
     * @param string $key
     * @param string $hashAlgorithm
     */
    public function __construct($key, $hashAlgorithm = 'sha256')
    {
        $this->key = $key;
        $this->hashAlgorithm = $hashAlgorithm;
    }

    /**
     * @param MediaInterface $media
     * @param ParameterBagInterface $parameterBag
     * @return array
     */
    public function getRouteParameters(MediaInterface $media, ParameterBagInterface $parameterBag): array
    {
        $parameters = $parameterBag->toArray($media);
        $parameters[self::PARAMETER_SIGNATURE] = $this->calculateSignature($parameters);

        return $parameters;
    }

    /**
     * @param MediaInterface $media
     * @param ParameterBagInterface $parameterBag
     * @return ParameterBagInterface
     * @throws SignatureInvalidException
     */
    public function validateParameterBag(MediaInterface $media, ParameterBagInterface $parameterBag): ParameterBagInterface
    {
        $data = $parameterBag->toArray($media);

        if (!isset($data[self::PARAMETER_SIGNATURE])) {
            throw new SignatureInvalidException();
        }

        $signature = $data[self::PARAMETER_SIGNATURE];
        $parameterBag->removeExtra(self::PARAMETER_SIGNATURE);

        if (!$this->isValid($media, $parameterBag, $signature)) {
            throw new SignatureInvalidException();
        }

        return $parameterBag;
    }

    /**
     * @param MediaInterface $media
     * @param ParameterBagInterface $parameterBag
     * @param $expectedSignature
     * @return bool
     */
    private function isValid(MediaInterface $media, ParameterBagInterface $parameterBag, $expectedSignature): bool
    {
        return hash_equals($this->calculateSignature($parameterBag->toArray($media)), $expectedSignature);
    }

    /**
     * @param array $parameters
     * @return string
     */
    private function calculateSignature(array $parameters): string
    {
        return hash_hmac($this->hashAlgorithm, $this->key, json_encode($this->normalize($parameters)));
    }

    /**
     * @param array $parameters
     * @return array
     */
    private function normalize(array $parameters): array
    {
        if (isset($parameters[self::PARAMETER_BUST_CACHE])) {
            unset($parameters[self::PARAMETER_BUST_CACHE]);
        }
        ksort($parameters);

        return array_map('strval', $parameters);
    }
}