RemoteUserAuthenticationProvider::supports() - Code Metrics - kaliop-uk/ezidentitymanagementbundle - Measure and Improve Code Quality continuously with Scrutinizer

RemoteUserAuthenticationProvider::supports() A
last analyzed 2018-06-24 12:46 UTC

↳ Parent: RemoteUserAuthenticationProvider

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
c	0
b	0
f	0
rs	10
cc	2
nc	2
nop	1

<?php

namespace Kaliop\IdentityManagementBundle\Security\Authentication\Provider;

use Symfony\Component\Security\Core\Authentication\Provider\AuthenticationProviderInterface;
use Symfony\Component\Security\Core\User\UserProviderInterface;
use Symfony\Component\Security\Core\User\UserInterface;
use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;
use Symfony\Component\Security\Core\Exception\BadCredentialsException;
use Symfony\Component\Security\Core\Exception\AuthenticationException;
use Symfony\Component\Security\Core\Exception\AuthenticationServiceException;
use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Kaliop\IdentityManagementBundle\Adapter\ClientInterface;
use Psr\Log\LoggerInterface;
use Symfony\Component\Security\Core\Role\SwitchUserRole;

/**
 * @todo:
 *        4. save locally the wsdl for perfs, as it is downloaded when building the container!
 *        5. it seems that this authenticator gets called AFTER the eZ one... try to revert the config in security.yml?
 */
class RemoteUserAuthenticationProvider implements AuthenticationProviderInterface
{
    /**
     * @var bool $hideUserNotFoundExceptions when true, auth exceptions of type UsernameNotFoundException,
     * BadCredentialsException and unkown (non-AuthenticationException) will be masked with a standard error message
     */
    protected $hideUserNotFoundExceptions;
    //protected $userChecker;
    protected $providerKey;
    /** @var ClientInterface $client */
    protected $client;
    /** @var UserProviderInterface $userProvider */
    protected $userProvider;
    /** @var LoggerInterface|null $logger */
    protected $logger;

    public function __construct(ClientInterface $client, UserProviderInterface $userProvider, $providerKey, $hideUserNotFoundExceptions = true)
    {
        $this->client = $client;
        $this->providerKey = $providerKey;
        $this->hideUserNotFoundExceptions = $hideUserNotFoundExceptions;
        $this->userProvider = $userProvider;
    }

    /**
     * @param LoggerInterface $logger
     */
    public function setLogger(LoggerInterface $logger)
    {
        $this->logger = $logger;
    }

    public function supports(TokenInterface $token)
    {
        return $token instanceof UsernamePasswordToken && $this->providerKey === $token->getProviderKey();
if ($x instanceof DoesNotExist) {
    // Do something.
}
    }

    /**
     * Reimplemented differently from what UserAuthenticationProvider does because we do not have its logic - instead of
     * fetch 1st, then check pwd, we do fetch-while-checking-pwd
     *
     * @param TokenInterface $token
     * @return UsernamePasswordToken
     * @throws AuthenticationException
     *
     * @see DaoAuthenticationProvider
     */
    public function authenticate(TokenInterface $token)
    {
        if (!$this->supports($token)) {
            return;
        }

        /* we can not fetch the user 1st based on his login

        /// @todo throw a BadCredentialsException instead ?
        $username = $token->getUsername();
        if ('' === $username || null === $username) {
            $username = 'NONE_PROVIDED';
        }

        try {
            $user = $this->retrieveUser($username, $token);
        } catch (UsernameNotFoundException $e) {
            if ($this->hideUserNotFoundExceptions) {
                throw new BadCredentialsException('Bad credentials.', 0, $e);
            }
            $e->setUsername($username);

            throw $e;
        }

        if (!$user instanceof UserInterface) {
            throw new AuthenticationServiceException('retrieveUser() must return a UserInterface.');
        }*/

        try {
            //$this->userChecker->checkPreAuth($user);

            $user = $this->retrieveUserAndCheckAuthentication($token);
            /// @todo !important reintroduce this check?
            //$this->userChecker->checkPostAuth($user);

        } catch (UsernameNotFoundException $e) {

            if ($this->hideUserNotFoundExceptions) {
                throw new BadCredentialsException('Bad credentials.', 0, $e);
            }

            throw $e;
        } catch (BadCredentialsException $e) {

            if ($this->hideUserNotFoundExceptions) {
                throw new BadCredentialsException('Bad credentials.', 0, $e);
            }

            throw $e;
        }

        $authenticatedToken = new UsernamePasswordToken($user, $token->getCredentials(), $this->providerKey, $this->getRoles($user, $token));
        $authenticatedToken->setAttributes($token->getAttributes());

        return $authenticatedToken;
    }

    /**
     * @param UsernamePasswordToken $token
     * @return mixed|UserInterface
     * @throws BadCredentialsException|AuthenticationException
     */
    protected function retrieveUserAndCheckAuthentication(UsernamePasswordToken $token)
    {
        $currentUser = $token->getUser();
        if ($currentUser instanceof UserInterface) {
if ($x instanceof DoesNotExist) {
    // Do something.
}

            /// @todo check if this is a good idea or not: keeping user password in the token ? Maybe encrypt it!
            if ($currentUser->getPassword() !== $token->getCredentials()) {
                throw new BadCredentialsException('The credentials were changed from another session.');
            }

            return $currentUser;

        } else {

            /// @todo !important might want to throw AuthenticationCredentialsNotFoundException instead?
            if ('' === ($presentedUsername = $token->getUsername())) {
                throw new BadCredentialsException('The presented email cannot be empty.');
            }

            if ('' === ($presentedPassword = $token->getCredentials())) {
                throw new BadCredentialsException('The presented password cannot be empty.');
            }

            // communication errors and config errors should be logged/handled by the client
            try {

                $user = $this->client->AuthenticateUser($presentedUsername, $presentedPassword);
                // the client should return a UserInterface, no need for us to use a userProvider
                //$user = $this->userProvider->loadUserByUsername($username);

                return $user;

            } catch(AuthenticationException $e) {

                // let through any exception of the expected authentication type
                throw $e;
            } catch(\Exception $e) {
                // we mask any internal, unexpected error from the Client
                /// @todo we should log a message here: the Client used an unexpected exception type...
                /// @tood we should really be using an AuthenticationServiceException here
                throw new BadCredentialsException('The presented username or password is invalid.', 0, $e);
            }

            // no need to check the password after loading the user: the remote ws does that
            /*if (!$this->encoderFactory->getEncoder($user)->isPasswordValid($user->getPassword(), $presentedPassword, $user->getSalt())) {

                throw new BadCredentialsException('The presented password is invalid.');
            }*/
        }
    }

    /**
     * Copied from UserAuthenticationProvider
     */
    protected function getRoles(UserInterface $user, TokenInterface $token)
    {
        $roles = $user->getRoles();

        foreach ($token->getRoles() as $role) {
            if ($role instanceof SwitchUserRole) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
                $roles[] = $role;

                break;
            }
        }

        return $roles;
    }
}


RemoteUserAuthenticationProvider::supports() A
last analyzed 2018-06-24 12:46 UTC

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1			<?php
2
3			namespace Kaliop\IdentityManagementBundle\Security\Authentication\Provider;
4
5			use Symfony\Component\Security\Core\Authentication\Provider\AuthenticationProviderInterface;
6			use Symfony\Component\Security\Core\User\UserProviderInterface;
7			use Symfony\Component\Security\Core\User\UserInterface;
8			use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;
9			use Symfony\Component\Security\Core\Exception\BadCredentialsException;
10			use Symfony\Component\Security\Core\Exception\AuthenticationException;
11			use Symfony\Component\Security\Core\Exception\AuthenticationServiceException;
12			use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
13			use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
14			use Kaliop\IdentityManagementBundle\Adapter\ClientInterface;
15			use Psr\Log\LoggerInterface;
16			use Symfony\Component\Security\Core\Role\SwitchUserRole;
17
18			/**
19			* @todo:
20			* 4. save locally the wsdl for perfs, as it is downloaded when building the container!
21			* 5. it seems that this authenticator gets called AFTER the eZ one... try to revert the config in security.yml?
22			*/
23			class RemoteUserAuthenticationProvider implements AuthenticationProviderInterface
24			{
25			/**
26			* @var bool $hideUserNotFoundExceptions when true, auth exceptions of type UsernameNotFoundException,
27			* BadCredentialsException and unkown (non-AuthenticationException) will be masked with a standard error message
28			*/
29			protected $hideUserNotFoundExceptions;
30			//protected $userChecker;
31			protected $providerKey;
32			/** @var ClientInterface $client */
33			protected $client;
34			/** @var UserProviderInterface $userProvider */
35			protected $userProvider;
36			/** @var LoggerInterface\|null $logger */
37			protected $logger;
38
39			public function __construct(ClientInterface $client, UserProviderInterface $userProvider, $providerKey, $hideUserNotFoundExceptions = true)
40			{
41			$this->client = $client;
42			$this->providerKey = $providerKey;
43			$this->hideUserNotFoundExceptions = $hideUserNotFoundExceptions;
44			$this->userProvider = $userProvider;
45			}
46
47			/**
48			* @param LoggerInterface $logger
49			*/
50			public function setLogger(LoggerInterface $logger)
51			{
52			$this->logger = $logger;
53			}
54
55			public function supports(TokenInterface $token)
56			{
57			return $token instanceof UsernamePasswordToken && $this->providerKey === $token->getProviderKey();
			0 ignored issues – show Bug introduced 2018-06-24 00:13 UTC by Report Bug Copy Issue Report The class `Symfony\Component\Securi...n\UsernamePasswordToken` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
58			}
59
60			/**
61			* Reimplemented differently from what UserAuthenticationProvider does because we do not have its logic - instead of
62			* fetch 1st, then check pwd, we do fetch-while-checking-pwd
63			*
64			* @param TokenInterface $token
65			* @return UsernamePasswordToken
66			* @throws AuthenticationException
67			*
68			* @see DaoAuthenticationProvider
69			*/
70			public function authenticate(TokenInterface $token)
71			{
72			if (!$this->supports($token)) {
73			return;
74			}
75
76			/* we can not fetch the user 1st based on his login
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-06-24 00:13 UTC by Report Bug Copy Issue Report `45%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
77			/// @todo throw a BadCredentialsException instead ?
78			$username = $token->getUsername();
79			if ('' === $username \|\| null === $username) {
80			$username = 'NONE_PROVIDED';
81			}
82
83			try {
84			$user = $this->retrieveUser($username, $token);
85			} catch (UsernameNotFoundException $e) {
86			if ($this->hideUserNotFoundExceptions) {
87			throw new BadCredentialsException('Bad credentials.', 0, $e);
88			}
89			$e->setUsername($username);
90
91			throw $e;
92			}
93
94			if (!$user instanceof UserInterface) {
95			throw new AuthenticationServiceException('retrieveUser() must return a UserInterface.');
96			}*/
97
98			try {
99			//$this->userChecker->checkPreAuth($user);
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-06-24 00:13 UTC by Report Bug Copy Issue Report `78%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
100			$user = $this->retrieveUserAndCheckAuthentication($token);
101			/// @todo !important reintroduce this check?
102			//$this->userChecker->checkPostAuth($user);
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-06-24 00:13 UTC by Report Bug Copy Issue Report `78%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
103			} catch (UsernameNotFoundException $e) {
			0 ignored issues – show Bug introduced 2018-06-24 00:13 UTC by Report Bug Copy Issue Report The class `Symfony\Component\Securi...ernameNotFoundException` does not exist. Did you forget a USE statement, or did you not list all dependencies? Scrutinizer analyzes your `composer.json`/`composer.lock` file if available to determine the classes, and functions that are defined by your dependencies. It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis. Loading history...
104			if ($this->hideUserNotFoundExceptions) {
105			throw new BadCredentialsException('Bad credentials.', 0, $e);
106			}
107
108			throw $e;
109			} catch (BadCredentialsException $e) {
			0 ignored issues – show Bug introduced 2018-06-24 00:13 UTC by Report Bug Copy Issue Report The class `Symfony\Component\Securi...BadCredentialsException` does not exist. Did you forget a USE statement, or did you not list all dependencies? Scrutinizer analyzes your `composer.json`/`composer.lock` file if available to determine the classes, and functions that are defined by your dependencies. It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis. Loading history...
110			if ($this->hideUserNotFoundExceptions) {
111			throw new BadCredentialsException('Bad credentials.', 0, $e);
112			}
113
114			throw $e;
115			}
116
117			$authenticatedToken = new UsernamePasswordToken($user, $token->getCredentials(), $this->providerKey, $this->getRoles($user, $token));
118			$authenticatedToken->setAttributes($token->getAttributes());
119
120			return $authenticatedToken;
121			}
122
123			/**
124			* @param UsernamePasswordToken $token
125			* @return mixed\|UserInterface
126			* @throws BadCredentialsException\|AuthenticationException
127			*/
128			protected function retrieveUserAndCheckAuthentication(UsernamePasswordToken $token)
129			{
130			$currentUser = $token->getUser();
131			if ($currentUser instanceof UserInterface) {
			0 ignored issues – show Bug introduced 2018-06-24 00:13 UTC by Report Bug Copy Issue Report The class `Symfony\Component\Security\Core\User\UserInterface` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
132
133			/// @todo check if this is a good idea or not: keeping user password in the token ? Maybe encrypt it!
134			if ($currentUser->getPassword() !== $token->getCredentials()) {
135			throw new BadCredentialsException('The credentials were changed from another session.');
136			}
137
138			return $currentUser;
139
140			} else {
141
142			/// @todo !important might want to throw AuthenticationCredentialsNotFoundException instead?
143			if ('' === ($presentedUsername = $token->getUsername())) {
144			throw new BadCredentialsException('The presented email cannot be empty.');
145			}
146
147			if ('' === ($presentedPassword = $token->getCredentials())) {
148			throw new BadCredentialsException('The presented password cannot be empty.');
149			}
150
151			// communication errors and config errors should be logged/handled by the client
152			try {
153
154			$user = $this->client->AuthenticateUser($presentedUsername, $presentedPassword);
155			// the client should return a UserInterface, no need for us to use a userProvider
156			//$user = $this->userProvider->loadUserByUsername($username);
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-06-24 00:13 UTC by Report Bug Copy Issue Report `62%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
157			return $user;
158
159			} catch(AuthenticationException $e) {
			0 ignored issues – show Bug introduced 2018-06-24 00:13 UTC by Report Bug Copy Issue Report The class `Symfony\Component\Securi...AuthenticationException` does not exist. Did you forget a USE statement, or did you not list all dependencies? Scrutinizer analyzes your `composer.json`/`composer.lock` file if available to determine the classes, and functions that are defined by your dependencies. It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis. Loading history...
160			// let through any exception of the expected authentication type
161			throw $e;
162			} catch(\Exception $e) {
163			// we mask any internal, unexpected error from the Client
164			/// @todo we should log a message here: the Client used an unexpected exception type...
165			/// @tood we should really be using an AuthenticationServiceException here
166			throw new BadCredentialsException('The presented username or password is invalid.', 0, $e);
167			}
168
169			// no need to check the password after loading the user: the remote ws does that
170			/*if (!$this->encoderFactory->getEncoder($user)->isPasswordValid($user->getPassword(), $presentedPassword, $user->getSalt())) {
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-06-24 00:13 UTC by Report Bug Copy Issue Report `70%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
171			throw new BadCredentialsException('The presented password is invalid.');
172			}*/
173			}
174			}
175
176			/**
177			* Copied from UserAuthenticationProvider
178			*/
179			protected function getRoles(UserInterface $user, TokenInterface $token)
180			{
181			$roles = $user->getRoles();
182
183			foreach ($token->getRoles() as $role) {
184			if ($role instanceof SwitchUserRole) {
			0 ignored issues – show Bug introduced 2018-06-24 00:13 UTC by Report Bug Copy Issue Report The class `Symfony\Component\Securi...ore\Role\SwitchUserRole` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
185			$roles[] = $role;
186
187			break;
188			}
189			}
190
191			return $roles;
192			}
193			}
194

kaliop-uk / ezidentitymanagementbundle

RemoteUserAuthenticationProvider::supports() A last analyzed 2018-06-24 12:46 UTC

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like

RemoteUserAuthenticationProvider::supports() A
last analyzed 2018-06-24 12:46 UTC