PasswordGrant::respondToAccessTokenRequest() - Code Metrics - Inspection of "Merge pull request #860 from Zaszczyk/new-events-t..." - thephpleague/oauth2-server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 62e06b...6fd302 )

by Andrew

created 2018-02-26 20:01 UTC

PasswordGrant::respondToAccessTokenRequest() B

↳ Parent: PasswordGrant

Complexity

Conditions	1
Paths	1

Size

Total Lines	27
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	1

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	27
ccs	12
cts	12
cp	1
rs	8.8571
cc	1
eloc	15
nc	1
nop	3
crap	1

<?php
/**
 * OAuth 2.0 Password grant.
 *
 * @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\Repositories\UserRepositoryInterface;
use League\OAuth2\Server\RequestEvent;
use League\OAuth2\Server\ResponseTypes\ResponseTypeInterface;
use Psr\Http\Message\ServerRequestInterface;

/**
 * Password grant class.
 */
class PasswordGrant extends AbstractGrant
{
    /**
     * @param UserRepositoryInterface         $userRepository
     * @param RefreshTokenRepositoryInterface $refreshTokenRepository
     */
    public function __construct(
        UserRepositoryInterface $userRepository,
        RefreshTokenRepositoryInterface $refreshTokenRepository
    ) {
        $this->setUserRepository($userRepository);
        $this->setRefreshTokenRepository($refreshTokenRepository);

        $this->refreshTokenTTL = new \DateInterval('P1M');
    }

    /**
     * {@inheritdoc}
     */
    public function respondToAccessTokenRequest(
        ServerRequestInterface $request,
        ResponseTypeInterface $responseType,
        \DateInterval $accessTokenTTL
    ) {
        // Validate request
        $client = $this->validateClient($request);
        $scopes = $this->validateScopes($this->getRequestParameter('scope', $request, $this->defaultScope));
        $user = $this->validateUser($request, $client);

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

        // Issue and persist new tokens
        $accessToken = $this->issueAccessToken($accessTokenTTL, $client, $user->getIdentifier(), $finalizedScopes);
        $refreshToken = $this->issueRefreshToken($accessToken);

        // Send events to emitter
        $this->getEmitter()->emit(new RequestEvent(RequestEvent::ACCESS_TOKEN_ISSUED, $request));
        $this->getEmitter()->emit(new RequestEvent(RequestEvent::REFRESH_TOKEN_ISSUED, $request));

        // Inject tokens into response
        $responseType->setAccessToken($accessToken);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        $responseType->setRefreshToken($refreshToken);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

        return $responseType;
    }

    /**
     * @param ServerRequestInterface $request
     * @param ClientEntityInterface  $client
     *
     * @throws OAuthServerException
     *
     * @return UserEntityInterface
     */
    protected function validateUser(ServerRequestInterface $request, ClientEntityInterface $client)
    {
        $username = $this->getRequestParameter('username', $request);
        if (is_null($username)) {
            throw OAuthServerException::invalidRequest('username');
        }

        $password = $this->getRequestParameter('password', $request);
        if (is_null($password)) {
            throw OAuthServerException::invalidRequest('password');
        }

        $user = $this->userRepository->getUserEntityByUserCredentials(
            $username,
            $password,
            $this->getIdentifier(),
            $client
        );
        if ($user instanceof UserEntityInterface === false) {
            $this->getEmitter()->emit(new RequestEvent(RequestEvent::USER_AUTHENTICATION_FAILED, $request));

            throw OAuthServerException::invalidCredentials();
        }

        return $user;
    }

    /**
     * {@inheritdoc}
     */
    public function getIdentifier()
    {
        return 'password';
    }
}


1		<?php
2		/**
3		* OAuth 2.0 Password grant.
4		*
5		* @author Alex Bilbie <[email protected]>
6		* @copyright Copyright (c) Alex Bilbie
7		* @license http://mit-license.org/
8		*
9		* @link https://github.com/thephpleague/oauth2-server
10		*/
11
12		namespace League\OAuth2\Server\Grant;
13
14		use League\OAuth2\Server\Entities\ClientEntityInterface;
15		use League\OAuth2\Server\Entities\UserEntityInterface;
16		use League\OAuth2\Server\Exception\OAuthServerException;
17		use League\OAuth2\Server\Repositories\RefreshTokenRepositoryInterface;
18		use League\OAuth2\Server\Repositories\UserRepositoryInterface;
19		use League\OAuth2\Server\RequestEvent;
20		use League\OAuth2\Server\ResponseTypes\ResponseTypeInterface;
21		use Psr\Http\Message\ServerRequestInterface;
22
23		/**
24		* Password grant class.
25		*/
26		class PasswordGrant extends AbstractGrant
27		{
28		/**
29		* @param UserRepositoryInterface $userRepository
30		* @param RefreshTokenRepositoryInterface $refreshTokenRepository
31		*/
32	5	public function __construct(
33		UserRepositoryInterface $userRepository,
34		RefreshTokenRepositoryInterface $refreshTokenRepository
35		) {
36	5	$this->setUserRepository($userRepository);
37	5	$this->setRefreshTokenRepository($refreshTokenRepository);
38
39	5	$this->refreshTokenTTL = new \DateInterval('P1M');
40	5	}
41
42		/**
43		* {@inheritdoc}
44		*/
45	4	public function respondToAccessTokenRequest(
46		ServerRequestInterface $request,
47		ResponseTypeInterface $responseType,
48		\DateInterval $accessTokenTTL
49		) {
50		// Validate request
51	4	$client = $this->validateClient($request);
52	4	$scopes = $this->validateScopes($this->getRequestParameter('scope', $request, $this->defaultScope));
53	4	$user = $this->validateUser($request, $client);
54
55		// Finalize the requested scopes
56	1	$finalizedScopes = $this->scopeRepository->finalizeScopes($scopes, $this->getIdentifier(), $client, $user->getIdentifier());
57
58		// Issue and persist new tokens
59	1	$accessToken = $this->issueAccessToken($accessTokenTTL, $client, $user->getIdentifier(), $finalizedScopes);
60	1	$refreshToken = $this->issueRefreshToken($accessToken);
61
62		// Send events to emitter
63	1	$this->getEmitter()->emit(new RequestEvent(RequestEvent::ACCESS_TOKEN_ISSUED, $request));
64	1	$this->getEmitter()->emit(new RequestEvent(RequestEvent::REFRESH_TOKEN_ISSUED, $request));
65
66		// Inject tokens into response
67	1	$responseType->setAccessToken($accessToken);
		0 ignored issues – show Bug introduced 2017-11-14 00:51 UTC by Report Bug Copy Issue Report It seems like `$accessToken` defined by `$this->issueAccessToken(...er(), $finalizedScopes)` on line `59` can be `null`; however, `League\OAuth2\Server\Res...rface::setAccessToken()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
68	1	$responseType->setRefreshToken($refreshToken);
		0 ignored issues – show Bug introduced 2016-06-19 22:10 UTC by Report Bug Copy Issue Report It seems like `$refreshToken` defined by `$this->issueRefreshToken($accessToken)` on line `60` can be `null`; however, `League\OAuth2\Server\Res...face::setRefreshToken()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
69
70	1	return $responseType;
71		}
72
73		/**
74		* @param ServerRequestInterface $request
75		* @param ClientEntityInterface $client
76		*
77		* @throws OAuthServerException
78		*
79		* @return UserEntityInterface
80		*/
81	4	protected function validateUser(ServerRequestInterface $request, ClientEntityInterface $client)
82		{
83	4	$username = $this->getRequestParameter('username', $request);
84	4	if (is_null($username)) {
85	1	throw OAuthServerException::invalidRequest('username');
86		}
87
88	3	$password = $this->getRequestParameter('password', $request);
89	3	if (is_null($password)) {
90	1	throw OAuthServerException::invalidRequest('password');
91		}
92
93	2	$user = $this->userRepository->getUserEntityByUserCredentials(
94	2	$username,
95	2	$password,
96	2	$this->getIdentifier(),
97	2	$client
98		);
99	2	if ($user instanceof UserEntityInterface === false) {
100	1	$this->getEmitter()->emit(new RequestEvent(RequestEvent::USER_AUTHENTICATION_FAILED, $request));
101
102	1	throw OAuthServerException::invalidCredentials();
103		}
104
105	1	return $user;
106		}
107
108		/**
109		* {@inheritdoc}
110		*/
111	5	public function getIdentifier()
112		{
113	5	return 'password';
114		}
115		}
116

thephpleague / oauth2-server

Push — master ( 62e06b...6fd302 )

PasswordGrant::respondToAccessTokenRequest() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like