AuthCodeGrant::enableCodeExchangeProof() - Code Metrics - Inspection of "Revert fix for client ID exception" - thephpleague/oauth2-server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#892)

by Andrew

created 2018-04-20 17:26 UTC

AuthCodeGrant::enableCodeExchangeProof() A

↳ Parent: AuthCodeGrant

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
ccs	3
cts	3
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\ScopeEntityInterface;
use League\OAuth2\Server\Entities\UserEntityInterface;
use League\OAuth2\Server\Exception\OAuthServerException;
use League\OAuth2\Server\Repositories\AuthCodeRepositoryInterface;
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 AuthCodeGrant extends AbstractAuthorizeGrant
{
    /**
     * @var \DateInterval
     */
    private $authCodeTTL;

    /**
     * @var bool
     */
    private $enableCodeExchangeProof = false;

    /**
     * @param AuthCodeRepositoryInterface     $authCodeRepository
     * @param RefreshTokenRepositoryInterface $refreshTokenRepository
     * @param \DateInterval                   $authCodeTTL
     */
    public function __construct(
        AuthCodeRepositoryInterface $authCodeRepository,
        RefreshTokenRepositoryInterface $refreshTokenRepository,
        \DateInterval $authCodeTTL
    ) {
        $this->setAuthCodeRepository($authCodeRepository);
        $this->setRefreshTokenRepository($refreshTokenRepository);
        $this->authCodeTTL = $authCodeTTL;
        $this->refreshTokenTTL = new \DateInterval('P1M');
    }

    public function enableCodeExchangeProof()
    {
        $this->enableCodeExchangeProof = true;
    }

    /**
     * Respond to an access token request.
     *
     * @param ServerRequestInterface $request
     * @param ResponseTypeInterface  $responseType
     * @param \DateInterval          $accessTokenTTL
     *
     * @throws OAuthServerException
     *
     * @return ResponseTypeInterface
     */
    public function respondToAccessTokenRequest(
        ServerRequestInterface $request,
        ResponseTypeInterface $responseType,
        \DateInterval $accessTokenTTL
    ) {
        // Validate request
        $client = $this->validateClient($request);
        $encryptedAuthCode = $this->getRequestParameter('code', $request, null);

        if ($encryptedAuthCode === null) {
            throw OAuthServerException::invalidRequest('code');
        }

        // Validate the authorization code
        try {
            $authCodePayload = json_decode($this->decrypt($encryptedAuthCode));
            if (time() > $authCodePayload->expire_time) {
                throw OAuthServerException::invalidRequest('code', 'Authorization code has expired');
            }

            if ($this->authCodeRepository->isAuthCodeRevoked($authCodePayload->auth_code_id) === true) {
                throw OAuthServerException::invalidRequest('code', 'Authorization code has been revoked');
            }

            if ($authCodePayload->client_id !== $client->getIdentifier()) {
                throw OAuthServerException::invalidRequest('code', 'Authorization code was not issued to this client');
            }

            // The redirect URI is required in this request
            $redirectUri = $this->getRequestParameter('redirect_uri', $request, null);
            if (empty($authCodePayload->redirect_uri) === false && $redirectUri === null) {
                throw OAuthServerException::invalidRequest('redirect_uri');
            }

            if ($authCodePayload->redirect_uri !== $redirectUri) {
                throw OAuthServerException::invalidRequest('redirect_uri', 'Invalid redirect URI');
            }

            $scopes = [];
            foreach ($authCodePayload->scopes as $scopeId) {
                $scope = $this->scopeRepository->getScopeEntityByIdentifier($scopeId);

                if ($scope instanceof ScopeEntityInterface === false) {
                    // @codeCoverageIgnoreStart
                    throw OAuthServerException::invalidScope($scopeId);
                    // @codeCoverageIgnoreEnd
                }

                $scopes[] = $scope;
            }

            // Finalize the requested scopes
            $scopes = $this->scopeRepository->finalizeScopes(
                $scopes,
                $this->getIdentifier(),
                $client,
                $authCodePayload->user_id
            );
        } catch (\LogicException  $e) {
            throw OAuthServerException::invalidRequest('code', 'Cannot decrypt the authorization code');
        }

        // Validate code challenge
        if ($this->enableCodeExchangeProof === true) {
            $codeVerifier = $this->getRequestParameter('code_verifier', $request, null);
            if ($codeVerifier === null) {
                throw OAuthServerException::invalidRequest('code_verifier');
            }

            // Validate code_verifier according to RFC-7636
            // @see: https://tools.ietf.org/html/rfc7636#section-4.1
            if (preg_match('/^[A-Za-z0-9-._~]{43,128}$/', $codeVerifier) !== 1) {
                throw OAuthServerException::invalidRequest(
                    'code_verifier',
                    'Code Verifier must follow the specifications of RFC-7636.'
                );
            }

            switch ($authCodePayload->code_challenge_method) {
                case 'plain':
                    if (hash_equals($codeVerifier, $authCodePayload->code_challenge) === false) {
                        throw OAuthServerException::invalidGrant('Failed to verify `code_verifier`.');
                    }

                    break;
                case 'S256':
                    if (
                        hash_equals(
                            strtr(rtrim(base64_encode(hash('sha256', $codeVerifier, true)), '='), '+/', '-_'),
                            $authCodePayload->code_challenge
                        ) === false
                    ) {
                        throw OAuthServerException::invalidGrant('Failed to verify `code_verifier`.');
                    }
                    // @codeCoverageIgnoreStart
                    break;
                default:
                    throw OAuthServerException::serverError(
                        sprintf(
                            'Unsupported code challenge method `%s`',
                            $authCodePayload->code_challenge_method
                        )
                    );
                // @codeCoverageIgnoreEnd
            }
        }

        // Issue and persist access + refresh tokens
        $accessToken = $this->issueAccessToken($accessTokenTTL, $client, $authCodePayload->user_id, $scopes);
        $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 type
        $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);
    }
}

        // Revoke used auth code
        $this->authCodeRepository->revokeAuthCode($authCodePayload->auth_code_id);

        return $responseType;
    }

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

    /**
     * {@inheritdoc}
     */
    public function canRespondToAuthorizationRequest(ServerRequestInterface $request)
    {
        return (
            array_key_exists('response_type', $request->getQueryParams())
            && $request->getQueryParams()['response_type'] === 'code'
            && 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(
            $this->getQueryStringParameter('scope', $request, $this->defaultScope),
            $redirectUri
        );

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

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

        if ($this->enableCodeExchangeProof === true) {
            $codeChallenge = $this->getQueryStringParameter('code_challenge', $request);
            if ($codeChallenge === null) {
                throw OAuthServerException::invalidRequest('code_challenge');
            }

            $codeChallengeMethod = $this->getQueryStringParameter('code_challenge_method', $request, 'plain');
            if (in_array($codeChallengeMethod, ['plain', 'S256'], true) === false) {
                throw OAuthServerException::invalidRequest(
                    'code_challenge_method',
                    'Code challenge method must be `plain` or `S256`'
                );
            }

            // Validate code_challenge according to RFC-7636
            // @see: https://tools.ietf.org/html/rfc7636#section-4.2
            if (preg_match('/^[A-Za-z0-9-._~]{43,128}$/', $codeChallenge) !== 1) {
                throw OAuthServerException::invalidRequest(
                    'code_challenged',
                    'Code challenge must follow the specifications of RFC-7636.'
                );
            }

            $authorizationRequest->setCodeChallenge($codeChallenge);
            $authorizationRequest->setCodeChallengeMethod($codeChallengeMethod);
        }

        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 auth code
        if ($authorizationRequest->isAuthorizationApproved() === true) {
            $authCode = $this->issueAuthCode(
                $this->authCodeTTL,
                $authorizationRequest->getClient(),
                $authorizationRequest->getUser()->getIdentifier(),
                $authorizationRequest->getRedirectUri(),
                $authorizationRequest->getScopes()
            );

            $payload = [
                'client_id'             => $authCode->getClient()->getIdentifier(),
                'redirect_uri'          => $authCode->getRedirectUri(),
                'auth_code_id'          => $authCode->getIdentifier(),
                'scopes'                => $authCode->getScopes(),
                'user_id'               => $authCode->getUserIdentifier(),
                'expire_time'           => (new \DateTime())->add($this->authCodeTTL)->format('U'),
                'code_challenge'        => $authorizationRequest->getCodeChallenge(),
                'code_challenge_method' => $authorizationRequest->getCodeChallengeMethod(),
            ];

            $response = new RedirectResponse();
            $response->setRedirectUri(
                $this->makeRedirectUri(
                    $finalRedirectUri,
                    [
                        'code'  => $this->encrypt(
                            json_encode(
                                $payload
                            )
                        ),
                        'state' => $authorizationRequest->getState(),
                    ]
                )
            );

            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\ScopeEntityInterface;
14		use League\OAuth2\Server\Entities\UserEntityInterface;
15		use League\OAuth2\Server\Exception\OAuthServerException;
16		use League\OAuth2\Server\Repositories\AuthCodeRepositoryInterface;
17		use League\OAuth2\Server\Repositories\RefreshTokenRepositoryInterface;
18		use League\OAuth2\Server\RequestEvent;
19		use League\OAuth2\Server\RequestTypes\AuthorizationRequest;
20		use League\OAuth2\Server\ResponseTypes\RedirectResponse;
21		use League\OAuth2\Server\ResponseTypes\ResponseTypeInterface;
22		use Psr\Http\Message\ServerRequestInterface;
23
24		class AuthCodeGrant extends AbstractAuthorizeGrant
25		{
26		/**
27		* @var \DateInterval
28		*/
29		private $authCodeTTL;
30
31		/**
32		* @var bool
33		*/
34		private $enableCodeExchangeProof = false;
35
36		/**
37		* @param AuthCodeRepositoryInterface $authCodeRepository
38		* @param RefreshTokenRepositoryInterface $refreshTokenRepository
39		* @param \DateInterval $authCodeTTL
40		*/
41	41	public function __construct(
42		AuthCodeRepositoryInterface $authCodeRepository,
43		RefreshTokenRepositoryInterface $refreshTokenRepository,
44		\DateInterval $authCodeTTL
45		) {
46	41	$this->setAuthCodeRepository($authCodeRepository);
47	41	$this->setRefreshTokenRepository($refreshTokenRepository);
48	41	$this->authCodeTTL = $authCodeTTL;
49	41	$this->refreshTokenTTL = new \DateInterval('P1M');
50	41	}
51
52	13	public function enableCodeExchangeProof()
53		{
54	13	$this->enableCodeExchangeProof = true;
55	13	}
56
57		/**
58		* Respond to an access token request.
59		*
60		* @param ServerRequestInterface $request
61		* @param ResponseTypeInterface $responseType
62		* @param \DateInterval $accessTokenTTL
63		*
64		* @throws OAuthServerException
65		*
66		* @return ResponseTypeInterface
67		*/
68	18	public function respondToAccessTokenRequest(
69		ServerRequestInterface $request,
70		ResponseTypeInterface $responseType,
71		\DateInterval $accessTokenTTL
72		) {
73		// Validate request
74	18	$client = $this->validateClient($request);
75	18	$encryptedAuthCode = $this->getRequestParameter('code', $request, null);
76
77	18	if ($encryptedAuthCode === null) {
78	1	throw OAuthServerException::invalidRequest('code');
79		}
80
81		// Validate the authorization code
82		try {
83	17	$authCodePayload = json_decode($this->decrypt($encryptedAuthCode));
84	16	if (time() > $authCodePayload->expire_time) {
85	1	throw OAuthServerException::invalidRequest('code', 'Authorization code has expired');
86		}
87
88	15	if ($this->authCodeRepository->isAuthCodeRevoked($authCodePayload->auth_code_id) === true) {
89	1	throw OAuthServerException::invalidRequest('code', 'Authorization code has been revoked');
90		}
91
92	14	if ($authCodePayload->client_id !== $client->getIdentifier()) {
93	1	throw OAuthServerException::invalidRequest('code', 'Authorization code was not issued to this client');
94		}
95
96		// The redirect URI is required in this request
97	13	$redirectUri = $this->getRequestParameter('redirect_uri', $request, null);
98	13	if (empty($authCodePayload->redirect_uri) === false && $redirectUri === null) {
99	1	throw OAuthServerException::invalidRequest('redirect_uri');
100		}
101
102	12	if ($authCodePayload->redirect_uri !== $redirectUri) {
103	1	throw OAuthServerException::invalidRequest('redirect_uri', 'Invalid redirect URI');
104		}
105
106	11	$scopes = [];
107	11	foreach ($authCodePayload->scopes as $scopeId) {
108	11	$scope = $this->scopeRepository->getScopeEntityByIdentifier($scopeId);
109
110	11	if ($scope instanceof ScopeEntityInterface === false) {
111		// @codeCoverageIgnoreStart
112		throw OAuthServerException::invalidScope($scopeId);
113		// @codeCoverageIgnoreEnd
114		}
115
116	11	$scopes[] = $scope;
117		}
118
119		// Finalize the requested scopes
120	11	$scopes = $this->scopeRepository->finalizeScopes(
121	11	$scopes,
122	11	$this->getIdentifier(),
123	11	$client,
124	11	$authCodePayload->user_id
125		);
126	6	} catch (\LogicException $e) {
127	1	throw OAuthServerException::invalidRequest('code', 'Cannot decrypt the authorization code');
128		}
129
130		// Validate code challenge
131	11	if ($this->enableCodeExchangeProof === true) {
132	7	$codeVerifier = $this->getRequestParameter('code_verifier', $request, null);
133	7	if ($codeVerifier === null) {
134	1	throw OAuthServerException::invalidRequest('code_verifier');
135		}
136
137		// Validate code_verifier according to RFC-7636
138		// @see: https://tools.ietf.org/html/rfc7636#section-4.1
139	6	if (preg_match('/^[A-Za-z0-9-._~]{43,128}$/', $codeVerifier) !== 1) {
140	3	throw OAuthServerException::invalidRequest(
141	3	'code_verifier',
142	3	'Code Verifier must follow the specifications of RFC-7636.'
143		);
144		}
145
146	3	switch ($authCodePayload->code_challenge_method) {
147	3	case 'plain':
148	2	if (hash_equals($codeVerifier, $authCodePayload->code_challenge) === false) {
149	1	throw OAuthServerException::invalidGrant('Failed to verify `code_verifier`.');
150		}
151
152	1	break;
153	1	case 'S256':
154		if (
155	1	hash_equals(
156	1	strtr(rtrim(base64_encode(hash('sha256', $codeVerifier, true)), '='), '+/', '-_'),
157	1	$authCodePayload->code_challenge
158	1	) === false
159		) {
160		throw OAuthServerException::invalidGrant('Failed to verify `code_verifier`.');
161		}
162		// @codeCoverageIgnoreStart
163		break;
164		default:
165		throw OAuthServerException::serverError(
166		sprintf(
167		'Unsupported code challenge method `%s`',
168		$authCodePayload->code_challenge_method
169		)
170		);
171		// @codeCoverageIgnoreEnd
172		}
173		}
174
175		// Issue and persist access + refresh tokens
176	6	$accessToken = $this->issueAccessToken($accessTokenTTL, $client, $authCodePayload->user_id, $scopes);
177	6	$refreshToken = $this->issueRefreshToken($accessToken);
178
179		// Send events to emitter
180	4	$this->getEmitter()->emit(new RequestEvent(RequestEvent::ACCESS_TOKEN_ISSUED, $request));
181	4	$this->getEmitter()->emit(new RequestEvent(RequestEvent::REFRESH_TOKEN_ISSUED, $request));
182
183		// Inject tokens into response type
184	4	$responseType->setAccessToken($accessToken);
		0 ignored issues – show Bug introduced 2016-06-17 09:35 UTC by Report Bug Copy Issue Report It seems like `$accessToken` defined by `$this->issueAccessToken(...load->user_id, $scopes)` on line `176` 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...
185	4	$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 `177` 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...
186
187		// Revoke used auth code
188	4	$this->authCodeRepository->revokeAuthCode($authCodePayload->auth_code_id);
189
190	4	return $responseType;
191		}
192
193		/**
194		* Return the grant identifier that can be used in matching up requests.
195		*
196		* @return string
197		*/
198	33	public function getIdentifier()
199		{
200	33	return 'authorization_code';
201		}
202
203		/**
204		* {@inheritdoc}
205		*/
206	3	public function canRespondToAuthorizationRequest(ServerRequestInterface $request)
207		{
208		return (
209	3	array_key_exists('response_type', $request->getQueryParams())
210	3	&& $request->getQueryParams()['response_type'] === 'code'
211	3	&& isset($request->getQueryParams()['client_id'])
212		);
213		}
214
215		/**
216		* {@inheritdoc}
217		*/
218	14	public function validateAuthorizationRequest(ServerRequestInterface $request)
219		{
220	14	$clientId = $this->getQueryStringParameter(
221	14	'client_id',
222	14	$request,
223	14	$this->getServerParameter('PHP_AUTH_USER', $request)
224		);
225	14	if (is_null($clientId)) {
226	1	throw OAuthServerException::invalidRequest('client_id');
227		}
228
229	13	$client = $this->clientRepository->getClientEntity(
230	13	$clientId,
231	13	$this->getIdentifier(),
232	13	null,
233	13	false
234		);
235
236	13	if ($client instanceof ClientEntityInterface === false) {
237	1	$this->getEmitter()->emit(new RequestEvent(RequestEvent::CLIENT_AUTHENTICATION_FAILED, $request));
238	1	throw OAuthServerException::invalidClient();
239		}
240
241	12	$redirectUri = $this->getQueryStringParameter('redirect_uri', $request);
242	12	if ($redirectUri !== null) {
243		if (
244	10	is_string($client->getRedirectUri())
245	10	&& (strcmp($client->getRedirectUri(), $redirectUri) !== 0)
246		) {
247	1	$this->getEmitter()->emit(new RequestEvent(RequestEvent::CLIENT_AUTHENTICATION_FAILED, $request));
248	1	throw OAuthServerException::invalidClient();
249		} elseif (
250	9	is_array($client->getRedirectUri())
251	9	&& in_array($redirectUri, $client->getRedirectUri(), true) === false
252		) {
253	1	$this->getEmitter()->emit(new RequestEvent(RequestEvent::CLIENT_AUTHENTICATION_FAILED, $request));
254	9	throw OAuthServerException::invalidClient();
255		}
256	2	} elseif (is_array($client->getRedirectUri()) && count($client->getRedirectUri()) !== 1
257	2	\|\| empty($client->getRedirectUri())) {
258	1	$this->getEmitter()->emit(new RequestEvent(RequestEvent::CLIENT_AUTHENTICATION_FAILED, $request));
259	1	throw OAuthServerException::invalidClient();
260		} else {
261	1	$redirectUri = is_array($client->getRedirectUri())
262		? $client->getRedirectUri()[0]
263	1	: $client->getRedirectUri();
264		}
265
266	9	$scopes = $this->validateScopes(
267	9	$this->getQueryStringParameter('scope', $request, $this->defaultScope),
268	9	$redirectUri
269		);
270
271	9	$stateParameter = $this->getQueryStringParameter('state', $request);
272
273	9	$authorizationRequest = new AuthorizationRequest();
274	9	$authorizationRequest->setGrantTypeId($this->getIdentifier());
275	9	$authorizationRequest->setClient($client);
276	9	$authorizationRequest->setRedirectUri($redirectUri);
277	9	$authorizationRequest->setState($stateParameter);
278	9	$authorizationRequest->setScopes($scopes);
279
280	9	if ($this->enableCodeExchangeProof === true) {
281	6	$codeChallenge = $this->getQueryStringParameter('code_challenge', $request);
282	6	if ($codeChallenge === null) {
283	1	throw OAuthServerException::invalidRequest('code_challenge');
284		}
285
286	5	$codeChallengeMethod = $this->getQueryStringParameter('code_challenge_method', $request, 'plain');
287	5	if (in_array($codeChallengeMethod, ['plain', 'S256'], true) === false) {
288	1	throw OAuthServerException::invalidRequest(
289	1	'code_challenge_method',
290	1	'Code challenge method must be `plain` or `S256`'
291		);
292		}
293
294		// Validate code_challenge according to RFC-7636
295		// @see: https://tools.ietf.org/html/rfc7636#section-4.2
296	4	if (preg_match('/^[A-Za-z0-9-._~]{43,128}$/', $codeChallenge) !== 1) {
297	3	throw OAuthServerException::invalidRequest(
298	3	'code_challenged',
299	3	'Code challenge must follow the specifications of RFC-7636.'
300		);
301		}
302
303	1	$authorizationRequest->setCodeChallenge($codeChallenge);
304	1	$authorizationRequest->setCodeChallengeMethod($codeChallengeMethod);
305		}
306
307	4	return $authorizationRequest;
308		}
309
310		/**
311		* {@inheritdoc}
312		*/
313	7	public function completeAuthorizationRequest(AuthorizationRequest $authorizationRequest)
314		{
315	7	if ($authorizationRequest->getUser() instanceof UserEntityInterface === false) {
316	1	throw new \LogicException('An instance of UserEntityInterface should be set on the AuthorizationRequest');
317		}
318
319	6	$finalRedirectUri = ($authorizationRequest->getRedirectUri() === null)
320	6	? is_array($authorizationRequest->getClient()->getRedirectUri())
321		? $authorizationRequest->getClient()->getRedirectUri()[0]
322	6	: $authorizationRequest->getClient()->getRedirectUri()
323	6	: $authorizationRequest->getRedirectUri();
324
325		// The user approved the client, redirect them back with an auth code
326	6	if ($authorizationRequest->isAuthorizationApproved() === true) {
327	5	$authCode = $this->issueAuthCode(
328	5	$this->authCodeTTL,
329	5	$authorizationRequest->getClient(),
330	5	$authorizationRequest->getUser()->getIdentifier(),
331	5	$authorizationRequest->getRedirectUri(),
332	5	$authorizationRequest->getScopes()
333		);
334
335		$payload = [
336	3	'client_id' => $authCode->getClient()->getIdentifier(),
337	3	'redirect_uri' => $authCode->getRedirectUri(),
338	3	'auth_code_id' => $authCode->getIdentifier(),
339	3	'scopes' => $authCode->getScopes(),
340	3	'user_id' => $authCode->getUserIdentifier(),
341	3	'expire_time' => (new \DateTime())->add($this->authCodeTTL)->format('U'),
342	3	'code_challenge' => $authorizationRequest->getCodeChallenge(),
343	3	'code_challenge_method' => $authorizationRequest->getCodeChallengeMethod(),
344		];
345
346	3	$response = new RedirectResponse();
347	3	$response->setRedirectUri(
348	3	$this->makeRedirectUri(
349	3	$finalRedirectUri,
350		[
351	3	'code' => $this->encrypt(
352	3	json_encode(
353	3	$payload
354		)
355		),
356	3	'state' => $authorizationRequest->getState(),
357		]
358		)
359		);
360
361	3	return $response;
362		}
363
364		// The user denied the client, redirect them back with an error
365	1	throw OAuthServerException::accessDenied(
366	1	'The user denied the request',
367	1	$this->makeRedirectUri(
368	1	$finalRedirectUri,
369		[
370	1	'state' => $authorizationRequest->getState(),
371		]
372		)
373		);
374		}
375		}
376

thephpleague / oauth2-server

Pull Request — master (#892)

AuthCodeGrant::enableCodeExchangeProof() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like