RevokeTokenHandler::setRefreshTokenRepository() - Code Metrics - Inspection of "Add token revocation support" - thephpleague/oauth2-server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#995)

unknown

created 2019-02-08 20:40 UTC

RevokeTokenHandler::setRefreshTokenRepository() A

↳ Parent: RevokeTokenHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
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;

use Exception;
use Lcobucci\JWT\Parser;
use Lcobucci\JWT\Signer\Rsa\Sha256;
use Lcobucci\JWT\Token;
use League\Event\EmitterAwareInterface;
use League\Event\EmitterAwareTrait;
use League\OAuth2\Server\Exception\OAuthServerException;
use League\OAuth2\Server\Repositories\AccessTokenRepositoryInterface;
use League\OAuth2\Server\Repositories\ClientRepositoryInterface;
use League\OAuth2\Server\Repositories\RefreshTokenRepositoryInterface;
use League\OAuth2\Server\ResponseTypes\ResponseTypeInterface;
use Psr\Http\Message\ServerRequestInterface;

class RevokeTokenHandler implements EmitterAwareInterface

{
    use EmitterAwareTrait, CryptTrait, RequestValidatorTrait;

    /**
     * @var ClientRepositoryInterface
     */
    protected $clientRepository;

    /**
     * @var AccessTokenRepositoryInterface
     */
    private $accessTokenRepository;

    /**
     * @var RefreshTokenRepositoryInterface
     */
    private $refreshTokenRepository;

    /**
     * @var bool
     */
    private $canRevokeAccessTokens;

    /**
     * @var CryptKey
     */
    protected $publicKey;

    /**
     * New handler instance.
     *
     * @param RefreshTokenRepositoryInterface $refreshTokenRepository
     * @param CryptKey|string                 $publicKey
     * @param bool                            $canRevokeAccessTokens
     */
    public function __construct(
        RefreshTokenRepositoryInterface $refreshTokenRepository,
        $publicKey,
        $canRevokeAccessTokens = true
    ) {
        $this->setRefreshTokenRepository($refreshTokenRepository);

        if ($publicKey instanceof CryptKey === false) {
            $publicKey = new CryptKey($publicKey);
        }
        $this->publicKey = $publicKey;

        $this->canRevokeAccessTokens = $canRevokeAccessTokens;
    }

    /**
     * @return ClientRepositoryInterface
     */
    public function getClientRepository()
    {
        return $this->clientRepository;
    }

    /**
     * @param ClientRepositoryInterface $clientRepository
     */
    public function setClientRepository(ClientRepositoryInterface $clientRepository)
    {
        $this->clientRepository = $clientRepository;
    }

    /**
     * @param AccessTokenRepositoryInterface $accessTokenRepository
     */
    public function setAccessTokenRepository(AccessTokenRepositoryInterface $accessTokenRepository)
    {
        $this->accessTokenRepository = $accessTokenRepository;
    }

    /**
     * @param RefreshTokenRepositoryInterface $refreshTokenRepository
     */
    public function setRefreshTokenRepository(RefreshTokenRepositoryInterface $refreshTokenRepository)
    {
        $this->refreshTokenRepository = $refreshTokenRepository;
    }

    /**
     * Set the public key
     *
     * @param CryptKey $key
     */
    public function setPublicKey(CryptKey $key)
    {
        $this->publicKey = $key;
    }

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

    /**
     * Return a revoke token response.
     * https://tools.ietf.org/html/rfc7009
     *
     * @param ServerRequestInterface $request
     * @param ResponseTypeInterface  $response
     *
     * @throws OAuthServerException
     *
     * @return ResponseTypeInterface
     */
    public function respondToRevokeTokenRequest(ServerRequestInterface $request, ResponseTypeInterface $response)
    {
        if ($request->getMethod() !== 'POST') {
            $errorMessage = 'POST method required.';
            throw new OAuthServerException($errorMessage, 3, 'invalid_request', 400);
        }

        $token = $this->getRequestParameter('token', $request);
        $hint = $this->getRequestParameter('token_type_hint', $request);

        // Validate request
        $client = $this->validateClient($request);
        $clientId = $client->getIdentifier();

        if (is_null($token)) {
            return $response;
        }

        // Attempt to read token
        $accessToken = null;
        $refreshToken = null;
        if ($hint === 'refresh_token') {
            $refreshToken = $this->readAsRefreshToken($token, $clientId);
            if ($refreshToken === null) {
                $accessToken = $this->readAsAccessToken($token, $clientId);
            }
        } else {
            $accessToken = $this->readAsAccessToken($token, $clientId);
            if ($accessToken === null) {
                $refreshToken = $this->readAsRefreshToken($token, $clientId);
            }
        }

        // Revoke tokens
        if ($accessToken !== null) {
            if (!$this->canRevokeAccessTokens) {
                $errorMessage = 'The authorization server does not support the revocation of the presented token type';
                throw new OAuthServerException($errorMessage, 2, 'unsupported_token_type', 400);
            }
            $this->accessTokenRepository->revokeAccessToken($accessToken->getClaim('jti'));
        } elseif ($refreshToken !== null) {
            $this->refreshTokenRepository->revokeRefreshToken($refreshToken['refresh_token_id']);
            if ($this->canRevokeAccessTokens) {
                $this->accessTokenRepository->revokeAccessToken($refreshToken['access_token_id']);
            }
        }

        return $response;
    }

    /**
     * @param string $tokenParam
     * @param string $clientId
     *
     * @return null|Token
     */
    protected function readAsAccessToken($tokenParam, $clientId)
    {
        $token = null;
        try {
            $token = (new Parser())->parse($tokenParam);

            if ($token->verify(new Sha256(), $this->publicKey->getKeyPath()) === false) {
                return null;
            }
        } catch (Exception $exception) {
            // JWT couldn't be parsed so ignore
            return null;
        }

        $clientId = $token->getClaim('aud');
        if ($clientId !== $clientId) {
            throw OAuthServerException::invalidClient();
        }

        return $token;
    }

    /**
     * @param string $tokenParam
     * @param string $clientId
     *
     * @return null|array
     */
    protected function readAsRefreshToken($tokenParam, $clientId)
    {
        $refreshTokenData = null;
        try {
            $refreshToken = $this->decrypt($tokenParam);
            $refreshTokenData = json_decode($refreshToken, true);
        } catch (Exception $e) {
            // token couldn't be decrypted so ignore
            return null;
        }

        if ($refreshTokenData['client_id'] !== $clientId) {
            throw OAuthServerException::invalidClient();
        }

        return $refreshTokenData;
    }
}


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;
11
12		use Exception;
13		use Lcobucci\JWT\Parser;
14		use Lcobucci\JWT\Signer\Rsa\Sha256;
15		use Lcobucci\JWT\Token;
16		use League\Event\EmitterAwareInterface;
17		use League\Event\EmitterAwareTrait;
18		use League\OAuth2\Server\Exception\OAuthServerException;
19		use League\OAuth2\Server\Repositories\AccessTokenRepositoryInterface;
20		use League\OAuth2\Server\Repositories\ClientRepositoryInterface;
21		use League\OAuth2\Server\Repositories\RefreshTokenRepositoryInterface;
22		use League\OAuth2\Server\ResponseTypes\ResponseTypeInterface;
23		use Psr\Http\Message\ServerRequestInterface;
24
25		class RevokeTokenHandler implements EmitterAwareInterface
		0 ignored issues – show Bug introduced 2019-02-08 20:08 UTC by Report Bug Copy Issue Report There is one abstract method `getEmitter` in this class; you could implement it, or declare this class as abstract. Loading history...
26		{
27		use EmitterAwareTrait, CryptTrait, RequestValidatorTrait;
28
29		/**
30		* @var ClientRepositoryInterface
31		*/
32		protected $clientRepository;
33
34		/**
35		* @var AccessTokenRepositoryInterface
36		*/
37		private $accessTokenRepository;
38
39		/**
40		* @var RefreshTokenRepositoryInterface
41		*/
42		private $refreshTokenRepository;
43
44		/**
45		* @var bool
46		*/
47		private $canRevokeAccessTokens;
48
49		/**
50		* @var CryptKey
51		*/
52		protected $publicKey;
53
54		/**
55		* New handler instance.
56		*
57		* @param RefreshTokenRepositoryInterface $refreshTokenRepository
58		* @param CryptKey\|string $publicKey
59		* @param bool $canRevokeAccessTokens
60		*/
61	12	public function __construct(
62		RefreshTokenRepositoryInterface $refreshTokenRepository,
63		$publicKey,
64		$canRevokeAccessTokens = true
65		) {
66	12	$this->setRefreshTokenRepository($refreshTokenRepository);
67
68	12	if ($publicKey instanceof CryptKey === false) {
69	1	$publicKey = new CryptKey($publicKey);
70		}
71	12	$this->publicKey = $publicKey;
72
73	12	$this->canRevokeAccessTokens = $canRevokeAccessTokens;
74	12	}
75
76		/**
77		* @return ClientRepositoryInterface
78		*/
79	12	public function getClientRepository()
80		{
81	12	return $this->clientRepository;
82		}
83
84		/**
85		* @param ClientRepositoryInterface $clientRepository
86		*/
87	12	public function setClientRepository(ClientRepositoryInterface $clientRepository)
88		{
89	12	$this->clientRepository = $clientRepository;
90	12	}
91
92		/**
93		* @param AccessTokenRepositoryInterface $accessTokenRepository
94		*/
95	12	public function setAccessTokenRepository(AccessTokenRepositoryInterface $accessTokenRepository)
96		{
97	12	$this->accessTokenRepository = $accessTokenRepository;
98	12	}
99
100		/**
101		* @param RefreshTokenRepositoryInterface $refreshTokenRepository
102		*/
103	12	public function setRefreshTokenRepository(RefreshTokenRepositoryInterface $refreshTokenRepository)
104		{
105	12	$this->refreshTokenRepository = $refreshTokenRepository;
106	12	}
107
108		/**
109		* Set the public key
110		*
111		* @param CryptKey $key
112		*/
113		public function setPublicKey(CryptKey $key)
114		{
115		$this->publicKey = $key;
116		}
117
118		/**
119		* Return the grant identifier that can be used in matching up requests.
120		*
121		* @return string
122		*/
123	12	public function getIdentifier()
124		{
125	12	return '';
126		}
127
128		/**
129		* Return a revoke token response.
130		* https://tools.ietf.org/html/rfc7009
131		*
132		* @param ServerRequestInterface $request
133		* @param ResponseTypeInterface $response
134		*
135		* @throws OAuthServerException
136		*
137		* @return ResponseTypeInterface
138		*/
139	12	public function respondToRevokeTokenRequest(ServerRequestInterface $request, ResponseTypeInterface $response)
140		{
141	12	if ($request->getMethod() !== 'POST') {
142		$errorMessage = 'POST method required.';
143		throw new OAuthServerException($errorMessage, 3, 'invalid_request', 400);
144		}
145
146	12	$token = $this->getRequestParameter('token', $request);
147	12	$hint = $this->getRequestParameter('token_type_hint', $request);
148
149		// Validate request
150	12	$client = $this->validateClient($request);
151	12	$clientId = $client->getIdentifier();
152
153	12	if (is_null($token)) {
154	1	return $response;
155		}
156
157		// Attempt to read token
158	11	$accessToken = null;
159	11	$refreshToken = null;
160	11	if ($hint === 'refresh_token') {
161	6	$refreshToken = $this->readAsRefreshToken($token, $clientId);
162	5	if ($refreshToken === null) {
163	5	$accessToken = $this->readAsAccessToken($token, $clientId);
164		}
165		} else {
166	5	$accessToken = $this->readAsAccessToken($token, $clientId);
167	5	if ($accessToken === null) {
168	2	$refreshToken = $this->readAsRefreshToken($token, $clientId);
169		}
170		}
171
172		// Revoke tokens
173	10	if ($accessToken !== null) {
174	3	if (!$this->canRevokeAccessTokens) {
175	1	$errorMessage = 'The authorization server does not support the revocation of the presented token type';
176	1	throw new OAuthServerException($errorMessage, 2, 'unsupported_token_type', 400);
177		}
178	2	$this->accessTokenRepository->revokeAccessToken($accessToken->getClaim('jti'));
179	7	} elseif ($refreshToken !== null) {
180	5	$this->refreshTokenRepository->revokeRefreshToken($refreshToken['refresh_token_id']);
181	5	if ($this->canRevokeAccessTokens) {
182	4	$this->accessTokenRepository->revokeAccessToken($refreshToken['access_token_id']);
183		}
184		}
185
186	9	return $response;
187		}
188
189		/**
190		* @param string $tokenParam
191		* @param string $clientId
192		*
193		* @return null\|Token
194		*/
195	6	protected function readAsAccessToken($tokenParam, $clientId)
196		{
197	6	$token = null;
198		try {
199	6	$token = (new Parser())->parse($tokenParam);
200
201	3	if ($token->verify(new Sha256(), $this->publicKey->getKeyPath()) === false) {
202	3	return null;
203		}
204	3	} catch (Exception $exception) {
205		// JWT couldn't be parsed so ignore
206	3	return null;
207		}
208
209	3	$clientId = $token->getClaim('aud');
210	3	if ($clientId !== $clientId) {
211		throw OAuthServerException::invalidClient();
212		}
213
214	3	return $token;
215		}
216
217		/**
218		* @param string $tokenParam
219		* @param string $clientId
220		*
221		* @return null\|array
222		*/
223	8	protected function readAsRefreshToken($tokenParam, $clientId)
224		{
225	8	$refreshTokenData = null;
226		try {
227	8	$refreshToken = $this->decrypt($tokenParam);
228	6	$refreshTokenData = json_decode($refreshToken, true);
229	2	} catch (Exception $e) {
230		// token couldn't be decrypted so ignore
231	2	return null;
232		}
233
234	6	if ($refreshTokenData['client_id'] !== $clientId) {
235	1	throw OAuthServerException::invalidClient();
236		}
237
238	5	return $refreshTokenData;
239		}
240		}
241

thephpleague / oauth2-server

Pull Request — master (#995)

RevokeTokenHandler::setRefreshTokenRepository() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like