Passed
Push — master ( a717b5...dd05c8 )
by Florian
03:07 queued 01:19
created

AuthenticationMiddleware::addAttribute()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 8
Code Lines 4

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 3
CRAP Score 2.2559

Importance

Changes 0
Metric Value
eloc 4
dl 0
loc 8
ccs 3
cts 5
cp 0.6
rs 10
c 0
b 0
f 0
cc 2
nc 2
nop 3
crap 2.2559
1
<?php
2
declare(strict_types=1);
3
/**
4
 * Copyright (c) Phauthentic (https://github.com/Phauthentic)
5
 *
6
 * Licensed under The MIT License
7
 * For full copyright and license information, please see the LICENSE.txt
8
 * Redistributions of files must retain the above copyright notice.
9
 *
10
 * @copyright     Copyright (c) Phauthentic (https://github.com/Phauthentic)
11
 * @link          https://github.com/Phauthentic
12
 * @license       https://opensource.org/licenses/mit-license.php MIT License
13
 */
14
namespace Phauthentic\Authentication\Middleware;
15
16
use Phauthentic\Authentication\AuthenticationServiceProviderInterface;
17
use Phauthentic\Authentication\Authenticator\Exception\UnauthorizedException;
18
use Psr\Http\Message\ResponseFactoryInterface;
19
use Psr\Http\Message\ResponseInterface;
20
use Psr\Http\Message\ServerRequestInterface;
21
use Psr\Http\Message\StreamFactoryInterface;
22
use Psr\Http\Server\MiddlewareInterface;
23
use Psr\Http\Server\RequestHandlerInterface;
24
use RuntimeException;
25
26
/**
27
 * PSR 15 Authenticator Middleware
28
 */
29
class AuthenticationMiddleware implements MiddlewareInterface
30
{
31
    /**
32
     * @var \Phauthentic\Authentication\AuthenticationServiceProviderInterface
33
     */
34
    protected $provider;
35
36
    /**
37
     * @var string
38
     */
39
    protected $serviceAttribute = 'authentication';
40
41
    /**
42
     * Request attribute for the identity
43
     *
44
     * @var string
45
     */
46
    protected $identityAttribute = 'identity';
47
48
    /**
49
     * Constructor.
50
     *
51
     * @param \Phauthentic\Authentication\AuthenticationServiceProviderInterface $provider Provider.
52
     * @param \Psr\Http\Message\ResponseFactoryInterface $responseFactory Factory.
53
     */
54 3
    public function __construct(
55
        AuthenticationServiceProviderInterface $provider
56
    ) {
57 3
        $this->provider = $provider;
58 3
    }
59
60
    /**
61
     * Sets request attribute name for authentication service.
62
     *
63
     * @param string $attribute Attribute name.
64
     * @return $this
65
     */
66
    public function setServiceAttribute(string $attribute): self
67
    {
68
        $this->serviceAttribute = $attribute;
69
70
        return $this;
71
    }
72
73
    /**
74
     * Sets the identity attribute
75
     *
76
     * @param string $attribute Attribute name
77
     * @return $this
78
     */
79
    public function setIdentityAttribute(string $attribute): self
80
    {
81
        $this->identityAttribute = $attribute;
82
83
        return $this;
84
    }
85
86
    /**
87
     * Adds an attribute to the request and returns a modified request.
88
     *
89
     * @param ServerRequestInterface $request Request.
90
     * @param string $name Attribute name.
91
     * @param mixed $value Attribute value.
92
     * @return ServerRequestInterface
93
     * @throws RuntimeException When attribute is present.
94
     */
95 3
    protected function addAttribute(ServerRequestInterface $request, string $name, $value): ServerRequestInterface
96
    {
97 3
        if ($request->getAttribute($name)) {
98
            $message = sprintf('Request attribute `%s` already exists.', $name);
99
            throw new RuntimeException($message);
100
        }
101
102 3
        return $request->withAttribute($name, $value);
103
    }
104
105
    /**
106
     * {@inheritDoc}
107
     *
108
     * @throws RuntimeException When request attribute exists.
109
     */
110 3
    public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface
111
    {
112 3
        $service = $this->provider->getAuthenticationService($request);
113 3
        $request = $this->addAttribute($request, $this->serviceAttribute, $service);
114
115 3
        $service->authenticate($request);
116
117 3
        $identity = $service->getIdentity();
118 3
        $request = $this->addAttribute($request, $this->identityAttribute, $identity);
119
120 3
        $response = $handler->handle($request);
121 3
        if ($response instanceof ResponseInterface) {
0 ignored issues
show
introduced by
$response is always a sub-type of Psr\Http\Message\ResponseInterface.
Loading history...
122 3
            $result = $service->persistIdentity($request, $response);
123
124 3
            return $result->getResponse();
125
        }
126
127
        return $response;
128
    }
129
}
130