ImplicitGrant::getIdentifier() - Code Metrics - Inspection of "Made the Client be aware of scopes #886" - thephpleague/oauth2-server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#887)

unknown

created 2018-04-10 15:39 UTC

ImplicitGrant::getIdentifier() A

↳ Parent: ImplicitGrant

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php
/**
 * @author      Alex Bilbie <[email protected]>
 * @copyright   Copyright (c) Alex Bilbie
 * @license     http://mit-license.org/
 *
 * @link        https://github.com/thephpleague/oauth2-server
 */

namespace League\OAuth2\Server\Grant;

use League\OAuth2\Server\Entities\ClientEntityInterface;
use League\OAuth2\Server\Entities\UserEntityInterface;
use League\OAuth2\Server\Exception\OAuthServerException;
use League\OAuth2\Server\Repositories\RefreshTokenRepositoryInterface;
use League\OAuth2\Server\RequestEvent;
use League\OAuth2\Server\RequestTypes\AuthorizationRequest;
use League\OAuth2\Server\ResponseTypes\RedirectResponse;
use League\OAuth2\Server\ResponseTypes\ResponseTypeInterface;
use Psr\Http\Message\ServerRequestInterface;

class ImplicitGrant extends AbstractAuthorizeGrant
{
    /**
     * @var \DateInterval
     */
    private $accessTokenTTL;

    /**
     * @var string
     */
    private $queryDelimiter;

    /**
     * @param \DateInterval $accessTokenTTL
     * @param string        $queryDelimiter
     */
    public function __construct(\DateInterval $accessTokenTTL, $queryDelimiter = '#')
    {
        $this->accessTokenTTL = $accessTokenTTL;
        $this->queryDelimiter = $queryDelimiter;
    }

    /**
     * @param \DateInterval $refreshTokenTTL
     *
     * @throw \LogicException
     */
    public function setRefreshTokenTTL(\DateInterval $refreshTokenTTL)
    {
        throw new \LogicException('The Implicit Grant does not return refresh tokens');
    }

    /**
     * @param RefreshTokenRepositoryInterface $refreshTokenRepository
     *
     * @throw \LogicException
     */
    public function setRefreshTokenRepository(RefreshTokenRepositoryInterface $refreshTokenRepository)
    {
        throw new \LogicException('The Implicit Grant does not return refresh tokens');
    }

    /**
     * {@inheritdoc}
     */
    public function canRespondToAccessTokenRequest(ServerRequestInterface $request)
    {
        return false;
    }

    /**
     * Return the grant identifier that can be used in matching up requests.
     *
     * @return string
     */
    public function getIdentifier()
    {
        return 'implicit';
    }

    /**
     * Respond to an incoming request.
     *
     * @param ServerRequestInterface $request
     * @param ResponseTypeInterface  $responseType
     * @param \DateInterval          $accessTokenTTL
     *
     * @return ResponseTypeInterface
     */
    public function respondToAccessTokenRequest(
        ServerRequestInterface $request,
        ResponseTypeInterface $responseType,
        \DateInterval $accessTokenTTL
    ) {
        throw new \LogicException('This grant does not used this method');
    }

    /**
     * {@inheritdoc}
     */
    public function canRespondToAuthorizationRequest(ServerRequestInterface $request)
    {
        return (
            isset($request->getQueryParams()['response_type'])
            && $request->getQueryParams()['response_type'] === 'token'
            && isset($request->getQueryParams()['client_id'])
        );
    }

    /**
     * {@inheritdoc}
     */
    public function validateAuthorizationRequest(ServerRequestInterface $request)
    {
        $clientId = $this->getQueryStringParameter(
            'client_id',
            $request,
            $this->getServerParameter('PHP_AUTH_USER', $request)
        );
        if (is_null($clientId)) {
            throw OAuthServerException::invalidRequest('client_id');
        }

        $client = $this->clientRepository->getClientEntity(
            $clientId,
            $this->getIdentifier(),
            null,
            false
        );

        if ($client instanceof ClientEntityInterface === false) {
            $this->getEmitter()->emit(new RequestEvent(RequestEvent::CLIENT_AUTHENTICATION_FAILED, $request));
            throw OAuthServerException::invalidClient();
        }

        $redirectUri = $this->getQueryStringParameter('redirect_uri', $request);
        if ($redirectUri !== null) {
            if (
                is_string($client->getRedirectUri())
                && (strcmp($client->getRedirectUri(), $redirectUri) !== 0)
            ) {
                $this->getEmitter()->emit(new RequestEvent(RequestEvent::CLIENT_AUTHENTICATION_FAILED, $request));
                throw OAuthServerException::invalidClient();
            } elseif (
                is_array($client->getRedirectUri())
                && in_array($redirectUri, $client->getRedirectUri(), true) === false
            ) {
                $this->getEmitter()->emit(new RequestEvent(RequestEvent::CLIENT_AUTHENTICATION_FAILED, $request));
                throw OAuthServerException::invalidClient();
            }
        } elseif (is_array($client->getRedirectUri()) && count($client->getRedirectUri()) !== 1
            || empty($client->getRedirectUri())) {
            $this->getEmitter()->emit(new RequestEvent(RequestEvent::CLIENT_AUTHENTICATION_FAILED, $request));
            throw OAuthServerException::invalidClient();
        } else {
            $redirectUri = is_array($client->getRedirectUri())
                ? $client->getRedirectUri()[0]
                : $client->getRedirectUri();
        }

        $scopes = $this->validateScopes(
            $client,
            $this->getQueryStringParameter('scope', $request, $this->defaultScope),
            $redirectUri
        );

        // Finalize the requested scopes
        $finalizedScopes = $this->scopeRepository->finalizeScopes(
            $scopes,
            $this->getIdentifier(),
            $client
        );

        $stateParameter = $this->getQueryStringParameter('state', $request);

        $authorizationRequest = new AuthorizationRequest();
        $authorizationRequest->setGrantTypeId($this->getIdentifier());
        $authorizationRequest->setClient($client);
        $authorizationRequest->setRedirectUri($redirectUri);
        $authorizationRequest->setState($stateParameter);
        $authorizationRequest->setScopes($finalizedScopes);

        return $authorizationRequest;
    }

    /**
     * {@inheritdoc}
     */
    public function completeAuthorizationRequest(AuthorizationRequest $authorizationRequest)
    {
        if ($authorizationRequest->getUser() instanceof UserEntityInterface === false) {
            throw new \LogicException('An instance of UserEntityInterface should be set on the AuthorizationRequest');
        }

        $finalRedirectUri = ($authorizationRequest->getRedirectUri() === null)
            ? is_array($authorizationRequest->getClient()->getRedirectUri())
                ? $authorizationRequest->getClient()->getRedirectUri()[0]
                : $authorizationRequest->getClient()->getRedirectUri()
            : $authorizationRequest->getRedirectUri();

        // The user approved the client, redirect them back with an access token
        if ($authorizationRequest->isAuthorizationApproved() === true) {
            $accessToken = $this->issueAccessToken(
                $this->accessTokenTTL,
                $authorizationRequest->getClient(),
                $authorizationRequest->getUser()->getIdentifier(),
                $authorizationRequest->getScopes()
            );

            $response = new RedirectResponse();
            $response->setRedirectUri(
                $this->makeRedirectUri(
                    $finalRedirectUri,
                    [
                        'access_token' => (string) $accessToken->convertToJWT($this->privateKey),
                        'token_type'   => 'Bearer',
                        'expires_in'   => $accessToken->getExpiryDateTime()->getTimestamp() - (new \DateTime())->getTimestamp(),
                        'state'        => $authorizationRequest->getState(),
                    ],
                    $this->queryDelimiter
                )
            );

            return $response;
        }

        // The user denied the client, redirect them back with an error
        throw OAuthServerException::accessDenied(
            'The user denied the request',
            $this->makeRedirectUri(
                $finalRedirectUri,
                [
                    'state' => $authorizationRequest->getState(),
                ]
            )
        );
    }
}


1		<?php
2		/**
3		* @author Alex Bilbie <[email protected]>
4		* @copyright Copyright (c) Alex Bilbie
5		* @license http://mit-license.org/
6		*
7		* @link https://github.com/thephpleague/oauth2-server
8		*/
9
10		namespace League\OAuth2\Server\Grant;
11
12		use League\OAuth2\Server\Entities\ClientEntityInterface;
13		use League\OAuth2\Server\Entities\UserEntityInterface;
14		use League\OAuth2\Server\Exception\OAuthServerException;
15		use League\OAuth2\Server\Repositories\RefreshTokenRepositoryInterface;
16		use League\OAuth2\Server\RequestEvent;
17		use League\OAuth2\Server\RequestTypes\AuthorizationRequest;
18		use League\OAuth2\Server\ResponseTypes\RedirectResponse;
19		use League\OAuth2\Server\ResponseTypes\ResponseTypeInterface;
20		use Psr\Http\Message\ServerRequestInterface;
21
22		class ImplicitGrant extends AbstractAuthorizeGrant
23		{
24		/**
25		* @var \DateInterval
26		*/
27		private $accessTokenTTL;
28
29		/**
30		* @var string
31		*/
32		private $queryDelimiter;
33
34		/**
35		* @param \DateInterval $accessTokenTTL
36		* @param string $queryDelimiter
37		*/
38	18	public function __construct(\DateInterval $accessTokenTTL, $queryDelimiter = '#')
39		{
40	18	$this->accessTokenTTL = $accessTokenTTL;
41	18	$this->queryDelimiter = $queryDelimiter;
42	18	}
43
44		/**
45		* @param \DateInterval $refreshTokenTTL
46		*
47		* @throw \LogicException
48		*/
49	1	public function setRefreshTokenTTL(\DateInterval $refreshTokenTTL)
50		{
51	1	throw new \LogicException('The Implicit Grant does not return refresh tokens');
52		}
53
54		/**
55		* @param RefreshTokenRepositoryInterface $refreshTokenRepository
56		*
57		* @throw \LogicException
58		*/
59	1	public function setRefreshTokenRepository(RefreshTokenRepositoryInterface $refreshTokenRepository)
60		{
61	1	throw new \LogicException('The Implicit Grant does not return refresh tokens');
62		}
63
64		/**
65		* {@inheritdoc}
66		*/
67	1	public function canRespondToAccessTokenRequest(ServerRequestInterface $request)
68		{
69	1	return false;
70		}
71
72		/**
73		* Return the grant identifier that can be used in matching up requests.
74		*
75		* @return string
76		*/
77	6	public function getIdentifier()
78		{
79	6	return 'implicit';
80		}
81
82		/**
83		* Respond to an incoming request.
84		*
85		* @param ServerRequestInterface $request
86		* @param ResponseTypeInterface $responseType
87		* @param \DateInterval $accessTokenTTL
88		*
89		* @return ResponseTypeInterface
90		*/
91	1	public function respondToAccessTokenRequest(
92		ServerRequestInterface $request,
93		ResponseTypeInterface $responseType,
94		\DateInterval $accessTokenTTL
95		) {
96	1	throw new \LogicException('This grant does not used this method');
97		}
98
99		/**
100		* {@inheritdoc}
101		*/
102	1	public function canRespondToAuthorizationRequest(ServerRequestInterface $request)
103		{
104		return (
105	1	isset($request->getQueryParams()['response_type'])
106	1	&& $request->getQueryParams()['response_type'] === 'token'
107	1	&& isset($request->getQueryParams()['client_id'])
108		);
109		}
110
111		/**
112		* {@inheritdoc}
113		*/
114	6	public function validateAuthorizationRequest(ServerRequestInterface $request)
115		{
116	6	$clientId = $this->getQueryStringParameter(
117	6	'client_id',
118	6	$request,
119	6	$this->getServerParameter('PHP_AUTH_USER', $request)
120		);
121	6	if (is_null($clientId)) {
122	1	throw OAuthServerException::invalidRequest('client_id');
123		}
124
125	5	$client = $this->clientRepository->getClientEntity(
126	5	$clientId,
127	5	$this->getIdentifier(),
128	5	null,
129	5	false
130		);
131
132	5	if ($client instanceof ClientEntityInterface === false) {
133	1	$this->getEmitter()->emit(new RequestEvent(RequestEvent::CLIENT_AUTHENTICATION_FAILED, $request));
134	1	throw OAuthServerException::invalidClient();
135		}
136
137	4	$redirectUri = $this->getQueryStringParameter('redirect_uri', $request);
138	4	if ($redirectUri !== null) {
139		if (
140	4	is_string($client->getRedirectUri())
141	4	&& (strcmp($client->getRedirectUri(), $redirectUri) !== 0)
142		) {
143	1	$this->getEmitter()->emit(new RequestEvent(RequestEvent::CLIENT_AUTHENTICATION_FAILED, $request));
144	1	throw OAuthServerException::invalidClient();
145		} elseif (
146	3	is_array($client->getRedirectUri())
147	3	&& in_array($redirectUri, $client->getRedirectUri(), true) === false
148		) {
149	1	$this->getEmitter()->emit(new RequestEvent(RequestEvent::CLIENT_AUTHENTICATION_FAILED, $request));
150	3	throw OAuthServerException::invalidClient();
151		}
152		} elseif (is_array($client->getRedirectUri()) && count($client->getRedirectUri()) !== 1
153		\|\| empty($client->getRedirectUri())) {
154		$this->getEmitter()->emit(new RequestEvent(RequestEvent::CLIENT_AUTHENTICATION_FAILED, $request));
155		throw OAuthServerException::invalidClient();
156		} else {
157		$redirectUri = is_array($client->getRedirectUri())
158		? $client->getRedirectUri()[0]
159		: $client->getRedirectUri();
160		}
161
162	2	$scopes = $this->validateScopes(
163	2	$client,
164	2	$this->getQueryStringParameter('scope', $request, $this->defaultScope),
165	2	$redirectUri
166		);
167
168		// Finalize the requested scopes
169	2	$finalizedScopes = $this->scopeRepository->finalizeScopes(
170	2	$scopes,
171	2	$this->getIdentifier(),
172	2	$client
173		);
174
175	2	$stateParameter = $this->getQueryStringParameter('state', $request);
176
177	2	$authorizationRequest = new AuthorizationRequest();
178	2	$authorizationRequest->setGrantTypeId($this->getIdentifier());
179	2	$authorizationRequest->setClient($client);
180	2	$authorizationRequest->setRedirectUri($redirectUri);
181	2	$authorizationRequest->setState($stateParameter);
182	2	$authorizationRequest->setScopes($finalizedScopes);
183
184	2	return $authorizationRequest;
185		}
186
187		/**
188		* {@inheritdoc}
189		*/
190	6	public function completeAuthorizationRequest(AuthorizationRequest $authorizationRequest)
191		{
192	6	if ($authorizationRequest->getUser() instanceof UserEntityInterface === false) {
193	1	throw new \LogicException('An instance of UserEntityInterface should be set on the AuthorizationRequest');
194		}
195
196	5	$finalRedirectUri = ($authorizationRequest->getRedirectUri() === null)
197	5	? is_array($authorizationRequest->getClient()->getRedirectUri())
198		? $authorizationRequest->getClient()->getRedirectUri()[0]
199	5	: $authorizationRequest->getClient()->getRedirectUri()
200	5	: $authorizationRequest->getRedirectUri();
201
202		// The user approved the client, redirect them back with an access token
203	5	if ($authorizationRequest->isAuthorizationApproved() === true) {
204	4	$accessToken = $this->issueAccessToken(
205	4	$this->accessTokenTTL,
206	4	$authorizationRequest->getClient(),
207	4	$authorizationRequest->getUser()->getIdentifier(),
208	4	$authorizationRequest->getScopes()
209		);
210
211	2	$response = new RedirectResponse();
212	2	$response->setRedirectUri(
213	2	$this->makeRedirectUri(
214	2	$finalRedirectUri,
215		[
216	2	'access_token' => (string) $accessToken->convertToJWT($this->privateKey),
217	2	'token_type' => 'Bearer',
218	2	'expires_in' => $accessToken->getExpiryDateTime()->getTimestamp() - (new \DateTime())->getTimestamp(),
219	2	'state' => $authorizationRequest->getState(),
220		],
221	2	$this->queryDelimiter
222		)
223		);
224
225	2	return $response;
226		}
227
228		// The user denied the client, redirect them back with an error
229	1	throw OAuthServerException::accessDenied(
230	1	'The user denied the request',
231	1	$this->makeRedirectUri(
232	1	$finalRedirectUri,
233		[
234	1	'state' => $authorizationRequest->getState(),
235		]
236		)
237		);
238		}
239		}
240

thephpleague / oauth2-server

Pull Request — master (#887)

ImplicitGrant::getIdentifier() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like