SecurityProfile::acl() - Code Metrics - Inspection of "Merge branch 'release/v2.0.6'" - slickframework/web-stack - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( c858e1...becd64 )

by Filipe

created 2024-11-13 17:57 UTC

SecurityProfile::acl() A

↳ Parent: SecurityProfile

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

/**
 * This file is part of web-stack
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Slick\WebStack\Domain\Security\Http\SecurityProfile;

use Slick\WebStack\Domain\Security\Authentication\Token\TokenStorageInterface;
use Slick\WebStack\Domain\Security\Http\AuthenticationEntryPointInterface;
use Slick\WebStack\Domain\Security\Http\AuthenticatorManagerInterface;
use Slick\WebStack\Domain\Security\Http\SecurityProfileInterface;
use Slick\WebStack\Domain\Security\UserInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Slick\Http\Message\Response;

/**
 * SecurityProfile
 *
 * @package Slick\WebStack\Domain\Security\Http\SecurityProfile
 */
class SecurityProfile implements SecurityProfileInterface
{
    use SecurityProfileTrait;

    public const REQUEST_TOKEN_KEY = '_security_token';

    /**
     * Creates a SecurityProfile
     *
     * @param string $matchExp
     * @param AuthenticatorManagerInterface $authenticatorManager
     * @param TokenStorageInterface<UserInterface> $tokenStorage
     * @param AuthenticationEntryPointInterface|null $entryPoint
     * @param array<string> $acl
     */
    public function __construct(
        string $matchExp,
        protected readonly AuthenticatorManagerInterface $authenticatorManager,
        protected readonly TokenStorageInterface $tokenStorage,
        private readonly ?AuthenticationEntryPointInterface $entryPoint = null,
        private readonly array $acl = []
    ) {
        $this->matchExp = $matchExp;
    }

    /**
     * Processes the given server request by authenticating it or delegating to the entry point.
     *
     * @param ServerRequestInterface $request The server request to process.
     * @return ResponseInterface|null Returns the authenticated response or null if authentication is not supported.
     */
    public function process(ServerRequestInterface $request): ?ResponseInterface
    {
        $supports = $this->authenticatorManager->supports($request);
        if (!$supports) {
$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
              return null;
        }

        $response =  $this->authenticatorManager->authenticateRequest($request);
        if (is_null($response) || $response->getStatusCode() < 400) {
            $this->handleAuthenticationSuccess($request);
        }
        return $response;
    }

    /**
     * Processes the entry point for the given server request.
     *
     * If an entry point is defined, it will start the authentication process
     * using the provided server request. Otherwise, it returns a response with
     * a status code of 401 (Unauthorized).
     *
     * @param ServerRequestInterface $request The server request to process the entry point.
     * @return null|ResponseInterface Returns the response of the entry point or a response with
     *                           a status code of 401 (Unauthorized).
     */
    public function processEntryPoint(ServerRequestInterface $request): ?ResponseInterface
    {
        if ($this->entryPoint) {
            return $this->entryPoint->start($request);
        }

        return new Response(401, 'Unauthorized');
    }

    /**
     * Handles successful authentication by adding the token attribute to the request.
     *
     * @param ServerRequestInterface &$request The incoming request object.
     *
     * @return void
     */
    protected function handleAuthenticationSuccess(ServerRequestInterface &$request): void
    {
        $request = $request->withAttribute(self::REQUEST_TOKEN_KEY, $this->tokenStorage->getToken());
    }

    /**
     * @inheritDoc
     */
    
    public function authenticationErrors(): array
    {
        return $this->authenticatorManager->authenticationErrors();
    }

    /**
     * @inheritDoc
     */
    public function acl(): array
    {
        return $this->acl;
    }
}


1			<?php
2
3			/**
4			* This file is part of web-stack
5			*
6			* For the full copyright and license information, please view the LICENSE
7			* file that was distributed with this source code.
8			*/
9
10			declare(strict_types=1);
11
12			namespace Slick\WebStack\Domain\Security\Http\SecurityProfile;
13
14			use Slick\WebStack\Domain\Security\Authentication\Token\TokenStorageInterface;
15			use Slick\WebStack\Domain\Security\Http\AuthenticationEntryPointInterface;
16			use Slick\WebStack\Domain\Security\Http\AuthenticatorManagerInterface;
17			use Slick\WebStack\Domain\Security\Http\SecurityProfileInterface;
18			use Slick\WebStack\Domain\Security\UserInterface;
19			use Psr\Http\Message\ResponseInterface;
20			use Psr\Http\Message\ServerRequestInterface;
21			use Slick\Http\Message\Response;
22
23			/**
24			* SecurityProfile
25			*
26			* @package Slick\WebStack\Domain\Security\Http\SecurityProfile
27			*/
28			class SecurityProfile implements SecurityProfileInterface
29			{
30			use SecurityProfileTrait;
31
32			public const REQUEST_TOKEN_KEY = '_security_token';
33
34			/**
35			* Creates a SecurityProfile
36			*
37			* @param string $matchExp
38			* @param AuthenticatorManagerInterface $authenticatorManager
39			* @param TokenStorageInterface<UserInterface> $tokenStorage
40			* @param AuthenticationEntryPointInterface\|null $entryPoint
41			* @param array<string> $acl
42			*/
43			public function __construct(
44			string $matchExp,
45			protected readonly AuthenticatorManagerInterface $authenticatorManager,
46			protected readonly TokenStorageInterface $tokenStorage,
47			private readonly ?AuthenticationEntryPointInterface $entryPoint = null,
48			private readonly array $acl = []
49			) {
50			$this->matchExp = $matchExp;
51			}
52
53			/**
54			* Processes the given server request by authenticating it or delegating to the entry point.
55			*
56			* @param ServerRequestInterface $request The server request to process.
57			* @return ResponseInterface\|null Returns the authenticated response or null if authentication is not supported.
58			*/
59			public function process(ServerRequestInterface $request): ?ResponseInterface
60			{
61			$supports = $this->authenticatorManager->supports($request);
62			if (!$supports) {
			0 ignored issues – show Bug Best Practice introduced 2024-09-11 22:18 UTC by Report Bug Copy Issue Report The expression `$supports` of type `boolean\|null` is loosely compared to `false`; this is ambiguous if the boolean can be false. You might want to explicitly use `!== null` instead. If an expression can have both `false`, and `null` as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values. $a = canBeFalseAndNull(); // Instead of if ( ! $a) { } // Better use one of the explicit versions: if ($a !== null) { } if ($a !== false) { } if ($a !== null && $a !== false) { } Loading history...
63			return null;
64			}
65
66			$response = $this->authenticatorManager->authenticateRequest($request);
67			if (is_null($response) \|\| $response->getStatusCode() < 400) {
68			$this->handleAuthenticationSuccess($request);
69			}
70			return $response;
71			}
72
73			/**
74			* Processes the entry point for the given server request.
75			*
76			* If an entry point is defined, it will start the authentication process
77			* using the provided server request. Otherwise, it returns a response with
78			* a status code of 401 (Unauthorized).
79			*
80			* @param ServerRequestInterface $request The server request to process the entry point.
81			* @return null\|ResponseInterface Returns the response of the entry point or a response with
82			* a status code of 401 (Unauthorized).
83			*/
84			public function processEntryPoint(ServerRequestInterface $request): ?ResponseInterface
85			{
86			if ($this->entryPoint) {
87			return $this->entryPoint->start($request);
88			}
89
90			return new Response(401, 'Unauthorized');
91			}
92
93			/**
94			* Handles successful authentication by adding the token attribute to the request.
95			*
96			* @param ServerRequestInterface &$request The incoming request object.
97			*
98			* @return void
99			*/
100			protected function handleAuthenticationSuccess(ServerRequestInterface &$request): void
101			{
102			$request = $request->withAttribute(self::REQUEST_TOKEN_KEY, $this->tokenStorage->getToken());
103			}
104
105			/**
106			* @inheritDoc
107			*/
108
109			public function authenticationErrors(): array
110			{
111			return $this->authenticatorManager->authenticationErrors();
112			}
113
114			/**
115			* @inheritDoc
116			*/
117			public function acl(): array
118			{
119			return $this->acl;
120			}
121			}
122

slickframework / web-stack

Push — master ( c858e1...becd64 )

SecurityProfile::acl() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like