SecurityAuthenticator::createToken() - Code Metrics - Inspection of "evo-2472 and evo-2476 security authentication" - libgraviton/graviton - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#353)

by Jan

created 2016-01-27 16:16 UTC

SecurityAuthenticator::createToken() A

↳ Parent: SecurityAuthenticator

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	11
rs	9.4285
cc	1
eloc	6
nc	1
nop	2

<?php
/**
 * auth interface for authing against an airlock key of some sorts
 */

namespace Graviton\SecurityBundle\Authentication;

use Graviton\SecurityBundle\Authentication\Strategies\StrategyInterface;
use Graviton\SecurityBundle\Authentication\Provider\AuthenticationProvider;
use Graviton\SecurityBundle\Entities\AnonymousUser;
use Graviton\SecurityBundle\Entities\SecurityUser;
use Psr\Log\LoggerInterface as Logger;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Security\Core\Authentication\SimplePreAuthenticatorInterface as SimplePreAuthInterface;
use Symfony\Component\Security\Core\Authentication\Token\PreAuthenticatedToken;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\Exception\AuthenticationException;
use Symfony\Component\Security\Core\User\UserProviderInterface;
use Symfony\Component\Security\Http\Authentication\AuthenticationFailureHandlerInterface;

/**
 * @author   List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
 * @license  http://opensource.org/licenses/gpl-license.php GNU Public License
 * @link     http://swisscom.ch
 */
final class SecurityAuthenticator implements
    SimplePreAuthInterface,
    AuthenticationFailureHandlerInterface
{

    /**
     * Authentication can be required to use any service
     * @var bool,
     */
    protected $securityRequired;

    /**
     * Authentication can use a test user if no user found
     * @var bool,
     */
    protected $securityTestUsername;

    /**
     * Authentication can allow not identified users to get information
     * @var bool,
     */
    protected $allowAnonymous;

    /**
     * @var AuthenticationProvider
     */
    protected $userProvider;

    /**
     * @var StrategyInterface
     */
    protected $extractionStrategy;

    /**
     * @var Logger
     */
    protected $logger;


    /**
     * @param boolean                $securityRequired     user provider to use
     * @param string                 $securityTestUsername user for testing
     * @param boolean                $allowAnonymous       user provider to use
     * @param AuthenticationProvider $userProvider         user provider to use
     * @param StrategyInterface      $extractionStrategy   auth strategy to use
     * @param Logger                 $logger               logger to user for logging errors
     */
    public function __construct(
        $securityRequired,
        $securityTestUsername,
        $allowAnonymous,
        AuthenticationProvider $userProvider,
        StrategyInterface $extractionStrategy,
        Logger $logger
    ) {

        $this->securityRequired     = $securityRequired;
        $this->securityTestUsername = $securityTestUsername;
        $this->allowAnonymous       = $allowAnonymous;
        $this->userProvider         = $userProvider;
        $this->extractionStrategy   = $extractionStrategy;

        $this->logger = $logger;
    }

    /**
     * @param Request $request     request to authenticate
     * @param string  $providerKey provider key to auth with
     *
     * @return \Symfony\Component\Security\Core\Authentication\Token\PreAuthenticatedToken
     */
    public function createToken(Request $request, $providerKey)
    {
        // look for an apikey query parameter
        $apiKey = $this->extractionStrategy->apply($request);

        return new PreAuthenticatedToken(
            'anon.',
            $apiKey,
            $providerKey
        );
    }

    /**
     * Tries to authenticate the provided token
     *
     * @param TokenInterface        $token        token to authenticate
     * @param UserProviderInterface $userProvider provider to auth against
     * @param string                $providerKey  key to auth with
     *
     * @return \Symfony\Component\Security\Core\Authentication\Token\PreAuthenticatedToken
     */
    public function authenticateToken(
        TokenInterface $token,
        UserProviderInterface $userProvider,
        $providerKey
    ) {
        $username = $token->getCredentials();
        $securityUser = false;

        // If no username in Strategy, check if required.
        if ($this->securityRequired && !$username) {
            $this->logger->warning('Authentication key is required.');
            throw new AuthenticationException(
                sprintf('Authentication key is required.')
            );
        }

        /** @var SecurityUser $securityUser */
        if ($user = $this->userProvider->loadUserByUsername($username)){
            $securityUser = new SecurityUser($user, ['ROLE_GRAVITON_USER']);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        }
        // Check for test user
        elseif ( $this->securityTestUsername) {
            $this->logger->info('Authentication, loading test user: '.$this->securityTestUsername);
            if ($user = $this->userProvider->loadUserByUsername($this->securityTestUsername)){
                $securityUser = new SecurityUser($user, ['ROLE_GRAVITON_USER']);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            }
        }

        // Check if allow Anonymous
        if (!$securityUser){
            if ($this->allowAnonymous) {
                $this->logger->info('Authentication, loading anonymous user.');
                $securityUser = new SecurityUser(new AnonymousUser(), ['ROLE_GRAVITON_ANONYMOUS']);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            } else {
                $this->logger->warning(sprintf('Authentication key "%s" could not be resolved.', $username));
                throw new AuthenticationException(
                    sprintf('Authentication key "%s" could not be resolved.', $username)
                );
            }
        }

        return new PreAuthenticatedToken(
            $securityUser,
            $username,
            $providerKey,
            $securityUser->getRoles()
        );

    }

    /**
     * @param TokenInterface $token       token to check
     * @param string         $providerKey provider to check against
     *
     * @return bool
     */
    public function supportsToken(TokenInterface $token, $providerKey)
    {
        return $token instanceof PreAuthenticatedToken && $token->getProviderKey() === $providerKey;
    }

    /**
     * This is called when an interactive authentication attempt fails. This is
     * called by authentication listeners inheriting from
     * AbstractAuthenticationListener.
     *
     * @param Request                 $request   original request
     * @param AuthenticationException $exception exception from auth attempt
     *
     * @return Response|null
     */
    public function onAuthenticationFailure(Request $request, AuthenticationException $exception)
    {
        return new Response(
            $exception->getMessageKey(),
            Response::HTTP_NETWORK_AUTHENTICATION_REQUIRED
        );
    }
}


1			<?php
2			/**
3			* auth interface for authing against an airlock key of some sorts
4			*/
5
6			namespace Graviton\SecurityBundle\Authentication;
7
8			use Graviton\SecurityBundle\Authentication\Strategies\StrategyInterface;
9			use Graviton\SecurityBundle\Authentication\Provider\AuthenticationProvider;
10			use Graviton\SecurityBundle\Entities\AnonymousUser;
11			use Graviton\SecurityBundle\Entities\SecurityUser;
12			use Psr\Log\LoggerInterface as Logger;
13			use Symfony\Component\HttpFoundation\Request;
14			use Symfony\Component\HttpFoundation\Response;
15			use Symfony\Component\Security\Core\Authentication\SimplePreAuthenticatorInterface as SimplePreAuthInterface;
16			use Symfony\Component\Security\Core\Authentication\Token\PreAuthenticatedToken;
17			use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
18			use Symfony\Component\Security\Core\Exception\AuthenticationException;
19			use Symfony\Component\Security\Core\User\UserProviderInterface;
20			use Symfony\Component\Security\Http\Authentication\AuthenticationFailureHandlerInterface;
21
22			/**
23			* @author List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
24			* @license http://opensource.org/licenses/gpl-license.php GNU Public License
25			* @link http://swisscom.ch
26			*/
27			final class SecurityAuthenticator implements
28			SimplePreAuthInterface,
29			AuthenticationFailureHandlerInterface
30			{
31
32			/**
33			* Authentication can be required to use any service
34			* @var bool,
35			*/
36			protected $securityRequired;
37
38			/**
39			* Authentication can use a test user if no user found
40			* @var bool,
41			*/
42			protected $securityTestUsername;
43
44			/**
45			* Authentication can allow not identified users to get information
46			* @var bool,
47			*/
48			protected $allowAnonymous;
49
50			/**
51			* @var AuthenticationProvider
52			*/
53			protected $userProvider;
54
55			/**
56			* @var StrategyInterface
57			*/
58			protected $extractionStrategy;
59
60			/**
61			* @var Logger
62			*/
63			protected $logger;
64
65
66			/**
67			* @param boolean $securityRequired user provider to use
68			* @param string $securityTestUsername user for testing
69			* @param boolean $allowAnonymous user provider to use
70			* @param AuthenticationProvider $userProvider user provider to use
71			* @param StrategyInterface $extractionStrategy auth strategy to use
72			* @param Logger $logger logger to user for logging errors
73			*/
74			public function __construct(
75			$securityRequired,
76			$securityTestUsername,
77			$allowAnonymous,
78			AuthenticationProvider $userProvider,
79			StrategyInterface $extractionStrategy,
80			Logger $logger
81			) {
82
83			$this->securityRequired = $securityRequired;
84			$this->securityTestUsername = $securityTestUsername;
85			$this->allowAnonymous = $allowAnonymous;
86			$this->userProvider = $userProvider;
87			$this->extractionStrategy = $extractionStrategy;
88
89			$this->logger = $logger;
90			}
91
92			/**
93			* @param Request $request request to authenticate
94			* @param string $providerKey provider key to auth with
95			*
96			* @return \Symfony\Component\Security\Core\Authentication\Token\PreAuthenticatedToken
97			*/
98			public function createToken(Request $request, $providerKey)
99			{
100			// look for an apikey query parameter
101			$apiKey = $this->extractionStrategy->apply($request);
102
103			return new PreAuthenticatedToken(
104			'anon.',
105			$apiKey,
106			$providerKey
107			);
108			}
109
110			/**
111			* Tries to authenticate the provided token
112			*
113			* @param TokenInterface $token token to authenticate
114			* @param UserProviderInterface $userProvider provider to auth against
115			* @param string $providerKey key to auth with
116			*
117			* @return \Symfony\Component\Security\Core\Authentication\Token\PreAuthenticatedToken
118			*/
119			public function authenticateToken(
120			TokenInterface $token,
121			UserProviderInterface $userProvider,
122			$providerKey
123			) {
124			$username = $token->getCredentials();
125			$securityUser = false;
126
127			// If no username in Strategy, check if required.
128			if ($this->securityRequired && !$username) {
129			$this->logger->warning('Authentication key is required.');
130			throw new AuthenticationException(
131			sprintf('Authentication key is required.')
132			);
133			}
134
135			/** @var SecurityUser $securityUser */
136			if ($user = $this->userProvider->loadUserByUsername($username)){
137			$securityUser = new SecurityUser($user, ['ROLE_GRAVITON_USER']);
			0 ignored issues – show Documentation introduced 2016-01-27 11:04 UTC by Report Bug Copy Issue Report `array('ROLE_GRAVITON_USER')` is of type `array<integer,string,{"0":"string"}>`, but the function expects a `array<integer,object<Sym...curity\Core\Role\Role>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
138			}
139			// Check for test user
140			elseif ( $this->securityTestUsername) {
141			$this->logger->info('Authentication, loading test user: '.$this->securityTestUsername);
142			if ($user = $this->userProvider->loadUserByUsername($this->securityTestUsername)){
143			$securityUser = new SecurityUser($user, ['ROLE_GRAVITON_USER']);
			0 ignored issues – show Documentation introduced 2016-01-27 11:04 UTC by Report Bug Copy Issue Report `array('ROLE_GRAVITON_USER')` is of type `array<integer,string,{"0":"string"}>`, but the function expects a `array<integer,object<Sym...curity\Core\Role\Role>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
144			}
145			}
146
147			// Check if allow Anonymous
148			if (!$securityUser){
149			if ($this->allowAnonymous) {
150			$this->logger->info('Authentication, loading anonymous user.');
151			$securityUser = new SecurityUser(new AnonymousUser(), ['ROLE_GRAVITON_ANONYMOUS']);
			0 ignored issues – show Documentation introduced 2016-01-26 09:25 UTC by Report Bug Copy Issue Report `array('ROLE_GRAVITON_ANONYMOUS')` is of type `array<integer,string,{"0":"string"}>`, but the function expects a `array<integer,object<Sym...curity\Core\Role\Role>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
152			} else {
153			$this->logger->warning(sprintf('Authentication key "%s" could not be resolved.', $username));
154			throw new AuthenticationException(
155			sprintf('Authentication key "%s" could not be resolved.', $username)
156			);
157			}
158			}
159
160			return new PreAuthenticatedToken(
161			$securityUser,
162			$username,
163			$providerKey,
164			$securityUser->getRoles()
165			);
166
167			}
168
169			/**
170			* @param TokenInterface $token token to check
171			* @param string $providerKey provider to check against
172			*
173			* @return bool
174			*/
175			public function supportsToken(TokenInterface $token, $providerKey)
176			{
177			return $token instanceof PreAuthenticatedToken && $token->getProviderKey() === $providerKey;
178			}
179
180			/**
181			* This is called when an interactive authentication attempt fails. This is
182			* called by authentication listeners inheriting from
183			* AbstractAuthenticationListener.
184			*
185			* @param Request $request original request
186			* @param AuthenticationException $exception exception from auth attempt
187			*
188			* @return Response\|null
189			*/
190			public function onAuthenticationFailure(Request $request, AuthenticationException $exception)
191			{
192			return new Response(
193			$exception->getMessageKey(),
194			Response::HTTP_NETWORK_AUTHENTICATION_REQUIRED
195			);
196			}
197			}
198

libgraviton / graviton

Pull Request — develop (#353)

SecurityAuthenticator::createToken() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like