AuthorizationServer::setDefaultScope() - Code Metrics - Inspection of "Add introspection implementation" - thephpleague/oauth2-server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#869)

unknown

created 2018-03-02 21:55 UTC

AuthorizationServer::setDefaultScope() A

↳ Parent: AuthorizationServer

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	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 Defuse\Crypto\Key;
use League\Event\EmitterAwareInterface;
use League\Event\EmitterAwareTrait;
use League\OAuth2\Server\Exception\OAuthServerException;
use League\OAuth2\Server\Grant\GrantTypeInterface;
use League\OAuth2\Server\Repositories\AccessTokenRepositoryInterface;
use League\OAuth2\Server\Repositories\ClientRepositoryInterface;
use League\OAuth2\Server\Repositories\ScopeRepositoryInterface;
use League\OAuth2\Server\RequestTypes\AuthorizationRequest;
use League\OAuth2\Server\ResponseTypes\AbstractResponseType;
use League\OAuth2\Server\ResponseTypes\BearerTokenResponse;
use League\OAuth2\Server\ResponseTypes\ResponseTypeInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;

class AuthorizationServer implements EmitterAwareInterface
{
    use EmitterAwareTrait;

    /**
     * @var GrantTypeInterface[]
     */
    protected $enabledGrantTypes = [];

    /**
     * @var \DateInterval[]
     */
    protected $grantTypeAccessTokenTTL = [];

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

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

    /**
     * @var null|ResponseTypeInterface
     */
    protected $responseType;

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

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

    /**
     * @var ScopeRepositoryInterface
     */
    private $scopeRepository;

    /**
     * @var string|Key
     */
    private $encryptionKey;

    /**
     * @var string
     */
    private $defaultScope = '';

    /**
     * New server instance.
     *
     * @param ClientRepositoryInterface      $clientRepository
     * @param AccessTokenRepositoryInterface $accessTokenRepository
     * @param ScopeRepositoryInterface       $scopeRepository
     * @param CryptKey|string                $privateKey
     * @param string|Key                     $encryptionKey
     * @param null|ResponseTypeInterface     $responseType
     */
    public function __construct(
        ClientRepositoryInterface $clientRepository,
        AccessTokenRepositoryInterface $accessTokenRepository,
        ScopeRepositoryInterface $scopeRepository,
        $privateKey,
        $encryptionKey,
        ResponseTypeInterface $responseType = null
    ) {
        $this->clientRepository = $clientRepository;
        $this->accessTokenRepository = $accessTokenRepository;
        $this->scopeRepository = $scopeRepository;

        if ($privateKey instanceof CryptKey === false) {
            $privateKey = new CryptKey($privateKey);
        }
        $this->privateKey = $privateKey;
        $this->encryptionKey = $encryptionKey;
        $this->responseType = $responseType;
    }

    /**
     * Enable a grant type on the server.
     *
     * @param GrantTypeInterface $grantType
     * @param null|\DateInterval $accessTokenTTL
     */
    public function enableGrantType(GrantTypeInterface $grantType, \DateInterval $accessTokenTTL = null)
    {
        if ($accessTokenTTL instanceof \DateInterval === false) {
            $accessTokenTTL = new \DateInterval('PT1H');
        }

        $grantType->setAccessTokenRepository($this->accessTokenRepository);
        $grantType->setClientRepository($this->clientRepository);
        $grantType->setScopeRepository($this->scopeRepository);
        $grantType->setDefaultScope($this->defaultScope);
        $grantType->setPrivateKey($this->privateKey);
        $grantType->setEmitter($this->getEmitter());
        $grantType->setEncryptionKey($this->encryptionKey);

        $this->enabledGrantTypes[$grantType->getIdentifier()] = $grantType;
        $this->grantTypeAccessTokenTTL[$grantType->getIdentifier()] = $accessTokenTTL;
    }

    /**
     * Validate an authorization request
     *
     * @param ServerRequestInterface $request
     *
     * @throws OAuthServerException
     *
     * @return AuthorizationRequest
     */
    public function validateAuthorizationRequest(ServerRequestInterface $request)
    {
        foreach ($this->enabledGrantTypes as $grantType) {
            if ($grantType->canRespondToAuthorizationRequest($request)) {
                return $grantType->validateAuthorizationRequest($request);
            }
        }

        throw OAuthServerException::unsupportedGrantType();
    }

    /**
     * Complete an authorization request
     *
     * @param AuthorizationRequest $authRequest
     * @param ResponseInterface    $response
     *
     * @return ResponseInterface
     */
    public function completeAuthorizationRequest(AuthorizationRequest $authRequest, ResponseInterface $response)
    {
        return $this->enabledGrantTypes[$authRequest->getGrantTypeId()]
            ->completeAuthorizationRequest($authRequest)
            ->generateHttpResponse($response);
    }

    /**
     * Return an access token response.
     *
     * @param ServerRequestInterface $request
     * @param ResponseInterface      $response
     *
     * @throws OAuthServerException
     *
     * @return ResponseInterface
     */
    public function respondToAccessTokenRequest(ServerRequestInterface $request, ResponseInterface $response)
    {
        foreach ($this->enabledGrantTypes as $grantType) {
            if (!$grantType->canRespondToAccessTokenRequest($request)) {
                continue;
            }
            $tokenResponse = $grantType->respondToAccessTokenRequest(
                $request,
                $this->getResponseType(),
                $this->grantTypeAccessTokenTTL[$grantType->getIdentifier()]
            );

            if ($tokenResponse instanceof ResponseTypeInterface) {
                return $tokenResponse->generateHttpResponse($response);
            }
        }

        throw OAuthServerException::unsupportedGrantType();
    }

    /**
     * Return an introspection response.
     *
     * @param ServerRequestInterface $request
     * @param ResponseInterface      $response
     *
     * @return ResponseInterface
     */
    public function respondToIntrospectionRequest(ServerRequestInterface $request, ResponseInterface $response)
    {
        $introspector = new Introspector($this->accessTokenRepository, $this->privateKey);

        $introspectionResponse = $introspector->respondToIntrospectionRequest($request);

        return $introspectionResponse->generateHttpResponse($response);
    }

    /**
     * Get the token type that grants will return in the HTTP response.
     *
     * @return ResponseTypeInterface
     */
    protected function getResponseType()
    {
        if ($this->responseType instanceof ResponseTypeInterface === false) {
            $this->responseType = new BearerTokenResponse();
        }

        if ($this->responseType instanceof AbstractResponseType === true) {
            $this->responseType->setPrivateKey($this->privateKey);
        }
        $this->responseType->setEncryptionKey($this->encryptionKey);

        return $this->responseType;
    }

    /**
     * Set the default scope for the authorization server.
     *
     * @param string $defaultScope
     */
    public function setDefaultScope($defaultScope)
    {
        $this->defaultScope = $defaultScope;
    }
}


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 Defuse\Crypto\Key;
13		use League\Event\EmitterAwareInterface;
14		use League\Event\EmitterAwareTrait;
15		use League\OAuth2\Server\Exception\OAuthServerException;
16		use League\OAuth2\Server\Grant\GrantTypeInterface;
17		use League\OAuth2\Server\Repositories\AccessTokenRepositoryInterface;
18		use League\OAuth2\Server\Repositories\ClientRepositoryInterface;
19		use League\OAuth2\Server\Repositories\ScopeRepositoryInterface;
20		use League\OAuth2\Server\RequestTypes\AuthorizationRequest;
21		use League\OAuth2\Server\ResponseTypes\AbstractResponseType;
22		use League\OAuth2\Server\ResponseTypes\BearerTokenResponse;
23		use League\OAuth2\Server\ResponseTypes\ResponseTypeInterface;
24		use Psr\Http\Message\ResponseInterface;
25		use Psr\Http\Message\ServerRequestInterface;
26
27		class AuthorizationServer implements EmitterAwareInterface
28		{
29		use EmitterAwareTrait;
30
31		/**
32		* @var GrantTypeInterface[]
33		*/
34		protected $enabledGrantTypes = [];
35
36		/**
37		* @var \DateInterval[]
38		*/
39		protected $grantTypeAccessTokenTTL = [];
40
41		/**
42		* @var CryptKey
43		*/
44		protected $privateKey;
45
46		/**
47		* @var CryptKey
48		*/
49		protected $publicKey;
50
51		/**
52		* @var null\|ResponseTypeInterface
53		*/
54		protected $responseType;
55
56		/**
57		* @var ClientRepositoryInterface
58		*/
59		private $clientRepository;
60
61		/**
62		* @var AccessTokenRepositoryInterface
63		*/
64		private $accessTokenRepository;
65
66		/**
67		* @var ScopeRepositoryInterface
68		*/
69		private $scopeRepository;
70
71		/**
72		* @var string\|Key
73		*/
74		private $encryptionKey;
75
76		/**
77		* @var string
78		*/
79		private $defaultScope = '';
80
81		/**
82		* New server instance.
83		*
84		* @param ClientRepositoryInterface $clientRepository
85		* @param AccessTokenRepositoryInterface $accessTokenRepository
86		* @param ScopeRepositoryInterface $scopeRepository
87		* @param CryptKey\|string $privateKey
88		* @param string\|Key $encryptionKey
89		* @param null\|ResponseTypeInterface $responseType
90		*/
91	9	public function __construct(
92		ClientRepositoryInterface $clientRepository,
93		AccessTokenRepositoryInterface $accessTokenRepository,
94		ScopeRepositoryInterface $scopeRepository,
95		$privateKey,
96		$encryptionKey,
97		ResponseTypeInterface $responseType = null
98		) {
99	9	$this->clientRepository = $clientRepository;
100	9	$this->accessTokenRepository = $accessTokenRepository;
101	9	$this->scopeRepository = $scopeRepository;
102
103	9	if ($privateKey instanceof CryptKey === false) {
104	9	$privateKey = new CryptKey($privateKey);
105		}
106	9	$this->privateKey = $privateKey;
107	9	$this->encryptionKey = $encryptionKey;
108	9	$this->responseType = $responseType;
109	9	}
110
111		/**
112		* Enable a grant type on the server.
113		*
114		* @param GrantTypeInterface $grantType
115		* @param null\|\DateInterval $accessTokenTTL
116		*/
117	7	public function enableGrantType(GrantTypeInterface $grantType, \DateInterval $accessTokenTTL = null)
118		{
119	7	if ($accessTokenTTL instanceof \DateInterval === false) {
120	4	$accessTokenTTL = new \DateInterval('PT1H');
121		}
122
123	7	$grantType->setAccessTokenRepository($this->accessTokenRepository);
124	7	$grantType->setClientRepository($this->clientRepository);
125	7	$grantType->setScopeRepository($this->scopeRepository);
126	7	$grantType->setDefaultScope($this->defaultScope);
127	7	$grantType->setPrivateKey($this->privateKey);
128	7	$grantType->setEmitter($this->getEmitter());
129	7	$grantType->setEncryptionKey($this->encryptionKey);
130
131	7	$this->enabledGrantTypes[$grantType->getIdentifier()] = $grantType;
132	7	$this->grantTypeAccessTokenTTL[$grantType->getIdentifier()] = $accessTokenTTL;
133	7	}
134
135		/**
136		* Validate an authorization request
137		*
138		* @param ServerRequestInterface $request
139		*
140		* @throws OAuthServerException
141		*
142		* @return AuthorizationRequest
143		*/
144	3	public function validateAuthorizationRequest(ServerRequestInterface $request)
145		{
146	3	foreach ($this->enabledGrantTypes as $grantType) {
147	2	if ($grantType->canRespondToAuthorizationRequest($request)) {
148	2	return $grantType->validateAuthorizationRequest($request);
149		}
150		}
151
152	1	throw OAuthServerException::unsupportedGrantType();
153		}
154
155		/**
156		* Complete an authorization request
157		*
158		* @param AuthorizationRequest $authRequest
159		* @param ResponseInterface $response
160		*
161		* @return ResponseInterface
162		*/
163	1	public function completeAuthorizationRequest(AuthorizationRequest $authRequest, ResponseInterface $response)
164		{
165	1	return $this->enabledGrantTypes[$authRequest->getGrantTypeId()]
166	1	->completeAuthorizationRequest($authRequest)
167	1	->generateHttpResponse($response);
168		}
169
170		/**
171		* Return an access token response.
172		*
173		* @param ServerRequestInterface $request
174		* @param ResponseInterface $response
175		*
176		* @throws OAuthServerException
177		*
178		* @return ResponseInterface
179		*/
180	4	public function respondToAccessTokenRequest(ServerRequestInterface $request, ResponseInterface $response)
181		{
182	4	foreach ($this->enabledGrantTypes as $grantType) {
183	4	if (!$grantType->canRespondToAccessTokenRequest($request)) {
184	1	continue;
185		}
186	3	$tokenResponse = $grantType->respondToAccessTokenRequest(
187	3	$request,
188	3	$this->getResponseType(),
189	3	$this->grantTypeAccessTokenTTL[$grantType->getIdentifier()]
190		);
191
192	2	if ($tokenResponse instanceof ResponseTypeInterface) {
193	2	return $tokenResponse->generateHttpResponse($response);
194		}
195		}
196
197	1	throw OAuthServerException::unsupportedGrantType();
198		}
199
200		/**
201		* Return an introspection response.
202		*
203		* @param ServerRequestInterface $request
204		* @param ResponseInterface $response
205		*
206		* @return ResponseInterface
207		*/
208		public function respondToIntrospectionRequest(ServerRequestInterface $request, ResponseInterface $response)
209		{
210		$introspector = new Introspector($this->accessTokenRepository, $this->privateKey);
		0 ignored issues – show Bug introduced 2018-03-02 21:57 UTC by Report Bug Copy Issue Report The call to `Introspector::__construct()` misses a required argument `$parser`. This check looks for function calls that miss required arguments. Loading history...
211		$introspectionResponse = $introspector->respondToIntrospectionRequest($request);
212
213		return $introspectionResponse->generateHttpResponse($response);
214		}
215
216		/**
217		* Get the token type that grants will return in the HTTP response.
218		*
219		* @return ResponseTypeInterface
220		*/
221	4	protected function getResponseType()
222		{
223	4	if ($this->responseType instanceof ResponseTypeInterface === false) {
224	1	$this->responseType = new BearerTokenResponse();
225		}
226
227	4	if ($this->responseType instanceof AbstractResponseType === true) {
228	4	$this->responseType->setPrivateKey($this->privateKey);
229		}
230	4	$this->responseType->setEncryptionKey($this->encryptionKey);
231
232	4	return $this->responseType;
233		}
234
235		/**
236		* Set the default scope for the authorization server.
237		*
238		* @param string $defaultScope
239		*/
240	3	public function setDefaultScope($defaultScope)
241		{
242	3	$this->defaultScope = $defaultScope;
243	3	}
244		}
245

thephpleague / oauth2-server

Pull Request — master (#869)

AuthorizationServer::setDefaultScope() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like