Schnittstabil\Psr7\Csrf\Middleware

Complexity

Total Complexity

14

Size/Duplication

Total Lines	137
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	create()	0	4	1
A	getTokenService()	0	4	1
B	add()	0	15	5
A	withGuard()	0	4	1
A	withAcceptHeaderToken()	0	4	1
A	withAcceptMethods()	0	4	1
A	withAcceptParsedBodyToken()	0	4	1
A	withRespondWithCookieToken()	0	4	1
A	withRespondWithHeaderToken()	0	4	1

<?php

namespace Schnittstabil\Psr7\Csrf;

use Schnittstabil\Csrf\TokenService;
use Schnittstabil\Csrf\TokenServiceInterface;
use Schnittstabil\Psr7\Csrf\Middlewares\AcceptHeaderToken;
use Schnittstabil\Psr7\Csrf\Middlewares\AcceptMethods;
use Schnittstabil\Psr7\Csrf\Middlewares\AcceptParsedBodyToken;
use Schnittstabil\Psr7\Csrf\Middlewares\Guard;
use Schnittstabil\Psr7\Csrf\Middlewares\GuardInterface;
use Schnittstabil\Psr7\Csrf\Middlewares\RespondWithCookieToken;
use Schnittstabil\Psr7\Csrf\Middlewares\RespondWithHeaderToken;
use Schnittstabil\Psr7\Middleware\Stack as MiddlewareStack;

/**
 * CSRF protection middleware.
 */
class Middleware extends MiddlewareStack
{
    protected $isGuarded;
    protected $tokenService;

    /**
     * Create a new Middleware.
     *
     * @param TokenServiceInterface $tokenService A token service.
     */
    public function __construct(TokenServiceInterface $tokenService)
    {
        parent::__construct();
        $this->isGuarded = false;
        $this->tokenService = $tokenService;
    }

    /**
     * Create a new Middleware.
     *
     * @param string $key  Shared secret key used for generating token signatures.
     * @param int    $ttl  Default Time to Live in seconds used for calculating the expiration time of the tokens (1440sec === 24min === default of session.gc_maxlifetime).
     * @param string $algo Name of hashing algorithm. See hash_algos() for a list of supported algorithms.
     *
     * @return static
     */
    public static function create($key, $ttl = 1440, $algo = 'SHA512')
    {
        return new self(new TokenService($key, $ttl, $algo));
    }

    /**
     * Get the token service.
     *
     * @return TokenServiceInterface
     */
    public function getTokenService()
    {
        return $this->tokenService;
    }

    /**
     * Push a middleware onto the top of a new Stack instance.
     *
     * @param callable $newTopMiddleware the middleware to be pushed onto the top.
     *
     * @return static the new instance
     */
    public function add(callable $newTopMiddleware)
    {
        if ($this->isGuarded && $newTopMiddleware instanceof GuardInterface) {
            throw new \RuntimeException('Invalid state: already guarded');
        }

        if (!$this->isGuarded && !($newTopMiddleware instanceof GuardInterface)) {
            throw new \RuntimeException('Invalid state: not guarded');
        }

        $clone = parent::add($newTopMiddleware);
        $clone->isGuarded = true;

        return $clone;
    }

    /**
     * Add new Guard middleware.
     *
     * @param callable $rejectMiddleware Defaults to `new Reject()`.
     *
     * @return static
     */
    public function withGuard(callable $rejectMiddleware = null)
    {
        return $this->add(new Guard($rejectMiddleware));
    }

    /**
     * Add new AcceptHeaderToken middleware.
     *
     * @param string $headerName Header field name.
     *
     * @return static
     */
    public function withAcceptHeaderToken($headerName = 'X-XSRF-TOKEN')
    {
        return $this->add(new AcceptHeaderToken([$this->tokenService, 'getConstraintViolations'], $headerName));
    }

    /**
     * Add new AcceptMethods middleware.
     *
     * @param string[] $methods HTTP methods allowed to bypass CSRF protection.
     *
     * @return static
     */
    public function withAcceptMethods(array $methods = array('GET', 'OPTIONS'))
    {
        return $this->add(new AcceptMethods($methods));
    }

    /**
     * Add new AcceptParsedBodyToken middleware.
     *
     * @param string|int|mixed[] $path <a href="https://github.com/schnittstabil/get" target="_blank">See `Get::value` for details</a>
     *
     * @return static
     */
    public function withAcceptParsedBodyToken($path = 'X-XSRF-TOKEN')
    {
        return $this->add(new AcceptParsedBodyToken([$this->tokenService, 'getConstraintViolations'], $path));
    }

    /**
     * Add new RespondWithCookieToken middleware.
     *
     * @param string   $cookieName Cookie name.
     * @param callable $modify     Allows to modify the cookie; same signature as `$this->modifyCookie`.
     *
     * @return static
     */
    public function withRespondWithCookieToken($cookieName = 'XSRF-TOKEN', callable $modify = null)
    {
        return $this->add(new RespondWithCookieToken([$this->tokenService, 'generate'], $cookieName, $modify));
    }

    /**
     * Add new RespondWithHeaderToken middleware.
     *
     * @param string $headerName Header field name.
     *
     * @return static
     */
    public function withRespondWithHeaderToken($headerName = 'XSRF-TOKEN')
    {
        return $this->add(new RespondWithHeaderToken([$this->tokenService, 'generate'], $headerName));
    }
}