OAuthServerController::sendResponse() - Code Metrics - Inspection of "setup resource server controller" - delboy1978uk/oauth2-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 21cdfe...febb5f )

by Derek Stephen

created 2018-11-21 18:09 UTC

OAuthServerController::sendResponse() A

↳ Parent: OAuthServerController::getForm()

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

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

<?php

namespace App\Controller;

use DateInterval;
use Del\Common\ContainerService;
use Del\Form\Field\Radio;
use Del\Form\Field\Submit;
use Del\Form\Form;
use Exception;
use League\OAuth2\Server\AuthorizationServer;
use League\OAuth2\Server\Exception\OAuthServerException;
use League\OAuth2\Server\Grant\AuthCodeGrant;
use League\OAuth2\Server\Grant\ClientCredentialsGrant;
use League\OAuth2\Server\Grant\RefreshTokenGrant;
use OAuth\OAuthUser;
use Zend\Diactoros\Response;
use Zend\Diactoros\Stream;

class OAuthServerController extends BaseController
{
    /** @var AuthorizationServer $oauth2Server */
    protected $oauth2Server;

    /**
     * @throws \Exception
     */
    public function init()
    {
        $container = ContainerService::getInstance()->getContainer();
        $clientRepository = $container['repository.Client'];
        $accessTokenRepository = $container['repository.AccessToken'];
        $scopeRepository = $container['repository.Scope'];
        $authCodeRepository = $container['repository.AuthCode'];
        $refreshTokenRepository = $container['repository.RefreshToken'];

        // Setup the authorization server
        $server = new AuthorizationServer($clientRepository, $accessTokenRepository, $scopeRepository,
            'file://'.APPLICATION_PATH.'/data/keys/private.key',    // path to private key
            'file://'.APPLICATION_PATH.'/data/keys/public.key'      // path to public key
        );

        $this->oauth2Server = $server;

        $this->oauth2Server->enableGrantType(
            new ClientCredentialsGrant(),
            new DateInterval('PT1H')
        );

        $this->oauth2Server->enableGrantType(
            new AuthCodeGrant(
                $authCodeRepository,
                $refreshTokenRepository,
                new DateInterval('PT10M')
            ),
            new DateInterval('PT1H')
        );

        $refreshGrant = new RefreshTokenGrant($refreshTokenRepository);
        $refreshGrant->setRefreshTokenTTL(new DateInterval('PT1M'));
        $this->oauth2Server->enableGrantType(
            $refreshGrant,
            new DateInterval('PT1H')
        );
    }

    /**
     *
     * @SWG\Get(
     *     path="/oauth2/authorize",
     *     @SWG\Response(response="200", description="An access token"),
     *     tags={"auth"},
     *     @SWG\Parameter(
     *         name="response_type",
     *         in="query",
     *         type="string",
     *         description="the type of response",
     *         required=true,
     *         default="code"
     *     ),
     *     @SWG\Parameter(
     *         name="client_id",
     *         in="query",
     *         type="string",
     *         description="the client identifier",
     *         required=true,
     *         default="testclient"
     *     ),
     *     @SWG\Parameter(
     *         name="client_secret",
     *         in="query",
     *         type="string",
     *         description="the client identifier",
     *         required=false,
     *         default="testclient"
     *     ),
     *     @SWG\Parameter(
     *         name="redirect_uri",
     *         in="query",
     *         type="string",
     *         description="where to send the response",
     *         required=false
     *     ),
     *     @SWG\Parameter(
     *         name="state",
     *         in="query",
     *         type="string",
     *         description="with a CSRF token. This parameter is optional but highly recommended.",
     *         required=false,
     *     ),
     *     @SWG\Parameter(
     *         name="scope",
     *         in="query",
     *         type="string",
     *         description="allowed scopes, space separated",
     *         required=false,
     *     )
     * )
     */
    public function authorizeAction()
    {
        /* @var AuthorizationServer $server */
        $server = $this->oauth2Server;

        $request = $this->getRequest();
        $response = new Response();

        try {
            // Validate the HTTP request and return an AuthorizationRequest object.
            // The auth request object can be serialized into a user's session
            $authRequest = $server->validateAuthorizationRequest($request);
            // Once the user has logged in set the user on the AuthorizationRequest
            $authRequest->setUser(new OAuthUser());
            // Once the user has approved or denied the client update the status
            // (true = approved, false = denied)
            $authRequest->setAuthorizationApproved(true);
            // Return the HTTP redirect response
            $response = $server->completeAuthorizationRequest($authRequest, $response);

        } catch (OAuthServerException $e) {
            $response = $e->generateHttpResponse($response);

        } catch (Exception $e) {
            $body = new Stream('php://temp', 'r+');
            $body->write($e->getMessage());
            $response = $response->withStatus(500)->withBody($body);
        }

        $redirectUri = $response->getHeader('Location');
        if (!empty($redirectUri)) {
            if (\substr($redirectUri[0], 0, 1) == '?') {
                $uri = \str_replace('?', '', $redirectUri[0]);
                \parse_str($uri, $vars);
                $this->sendJsonResponse($vars);
            }
        } else {
            $this->sendResponse($response);
        }

        return $response;
    }

    /**
     * @SWG\Post(
     *     path="/oauth2/access-token",
     *     operationId="accessToken",
     *     @SWG\Response(response="200", description="An access token"),
     *     tags={"auth"},
     *     @SWG\Parameter(
     *         name="grant_type",
     *         in="formData",
     *         type="string",
     *         description="the type of grant",
     *         required=true,
     *         default="client_credentials",
     *     ),
     *     @SWG\Parameter(
     *         name="client_id",
     *         in="formData",
     *         type="string",
     *         description="the client id",
     *         required=true,
     *         default="ceac682a9a4808bf910ad49134230e0e"
     *     ),
     *     @SWG\Parameter(
     *         name="client_secret",
     *         in="formData",
     *         type="string",
     *         description="the client secret",
     *         required=false,
     *         default="JDJ5JDEwJGNEd1J1VEdOY0YxS3QvL0pWQzMxay52"
     *     ),
     *     @SWG\Parameter(
     *         name="scope",
     *         in="formData",
     *         type="string",
     *         description="the scopes you wish to use",
     *         required=false,
     *         default="admin"
     *     ),
     *     @SWG\Parameter(
     *         name="redirect_uri",
     *         in="formData",
     *         type="string",
     *         description="with the same redirect URI the user was redirect back to",
     *         required=false,
     *     ),
     *     @SWG\Parameter(
     *         name="code",
     *         in="formData",
     *         type="string",
     *         description="with the authorization code from the query string",
     *         required=false,
     *     ),
     * )
     */
    public function accessTokenAction()
    {
        /* @var AuthorizationServer $server */
        $server = $this->oauth2Server;

        $request = $this->getRequest();
        $response = new Response();

        try {
            // Try to respond to the access token request
            $response = $server->respondToAccessTokenRequest($request, $response);
        } catch (OAuthServerException $e) {
            $response = $e->generateHttpResponse($response);
        } catch (Exception $e) {
            $code = $e->getCode() ?: 500;
            $response = $response
                ->withStatus($code)
                ->withHeader('content-type', 'application/json; charset=UTF-8');
            $response->getBody()->write(\json_encode([
                'error' => $code,
                'message' => $e->getMessage(),
            ]));
        }
        $this->sendResponse($response);
    }

    /**
     * @return Form
     */
    private function getForm()
    {
        $form = new Form('auth');
        $radio = new Radio('auth');
        $radio->setOptions([
            'yes' => 'Yes',
            'no' => 'No',
        ]);
        $radio->setLabel('Do you authorise TestClient?');
        $radio->setRenderInline(true);
        $radio->setRequired(true);
        $submit = new Submit('submit');

        $form->addField($radio)
            ->addField($submit);

        return $form;
    }
}


1		<?php
2
3		namespace App\Controller;
4
5		use DateInterval;
6		use Del\Common\ContainerService;
7		use Del\Form\Field\Radio;
8		use Del\Form\Field\Submit;
9		use Del\Form\Form;
10		use Exception;
11		use League\OAuth2\Server\AuthorizationServer;
12		use League\OAuth2\Server\Exception\OAuthServerException;
13		use League\OAuth2\Server\Grant\AuthCodeGrant;
14		use League\OAuth2\Server\Grant\ClientCredentialsGrant;
15		use League\OAuth2\Server\Grant\RefreshTokenGrant;
16		use OAuth\OAuthUser;
17		use Zend\Diactoros\Response;
18		use Zend\Diactoros\Stream;
19
20		class OAuthServerController extends BaseController
21		{
22		/** @var AuthorizationServer $oauth2Server */
23		protected $oauth2Server;
24
25		/**
26		* @throws \Exception
27		*/
28	6	public function init()
29		{
30	6	$container = ContainerService::getInstance()->getContainer();
31	6	$clientRepository = $container['repository.Client'];
32	6	$accessTokenRepository = $container['repository.AccessToken'];
33	6	$scopeRepository = $container['repository.Scope'];
34	6	$authCodeRepository = $container['repository.AuthCode'];
35	6	$refreshTokenRepository = $container['repository.RefreshToken'];
36
37		// Setup the authorization server
38	6	$server = new AuthorizationServer($clientRepository, $accessTokenRepository, $scopeRepository,
39	6	'file://'.APPLICATION_PATH.'/data/keys/private.key', // path to private key
40	6	'file://'.APPLICATION_PATH.'/data/keys/public.key' // path to public key
41		);
42
43	6	$this->oauth2Server = $server;
44
45	6	$this->oauth2Server->enableGrantType(
46	6	new ClientCredentialsGrant(),
47	6	new DateInterval('PT1H')
48		);
49
50	6	$this->oauth2Server->enableGrantType(
51	6	new AuthCodeGrant(
52	6	$authCodeRepository,
53	6	$refreshTokenRepository,
54	6	new DateInterval('PT10M')
55		),
56	6	new DateInterval('PT1H')
57		);
58
59	6	$refreshGrant = new RefreshTokenGrant($refreshTokenRepository);
60	6	$refreshGrant->setRefreshTokenTTL(new DateInterval('PT1M'));
61	6	$this->oauth2Server->enableGrantType(
62	6	$refreshGrant,
63	6	new DateInterval('PT1H')
64		);
65	6	}
66
67		/**
68		*
69		* @SWG\Get(
70		* path="/oauth2/authorize",
71		* @SWG\Response(response="200", description="An access token"),
72		* tags={"auth"},
73		* @SWG\Parameter(
74		* name="response_type",
75		* in="query",
76		* type="string",
77		* description="the type of response",
78		* required=true,
79		* default="code"
80		* ),
81		* @SWG\Parameter(
82		* name="client_id",
83		* in="query",
84		* type="string",
85		* description="the client identifier",
86		* required=true,
87		* default="testclient"
88		* ),
89		* @SWG\Parameter(
90		* name="client_secret",
91		* in="query",
92		* type="string",
93		* description="the client identifier",
94		* required=false,
95		* default="testclient"
96		* ),
97		* @SWG\Parameter(
98		* name="redirect_uri",
99		* in="query",
100		* type="string",
101		* description="where to send the response",
102		* required=false
103		* ),
104		* @SWG\Parameter(
105		* name="state",
106		* in="query",
107		* type="string",
108		* description="with a CSRF token. This parameter is optional but highly recommended.",
109		* required=false,
110		* ),
111		* @SWG\Parameter(
112		* name="scope",
113		* in="query",
114		* type="string",
115		* description="allowed scopes, space separated",
116		* required=false,
117		* )
118		* )
119		*/
120	1	public function authorizeAction()
121		{
122		/* @var AuthorizationServer $server */
123	1	$server = $this->oauth2Server;
124
125	1	$request = $this->getRequest();
126	1	$response = new Response();
127
128		try {
129		// Validate the HTTP request and return an AuthorizationRequest object.
130		// The auth request object can be serialized into a user's session
131	1	$authRequest = $server->validateAuthorizationRequest($request);
132		// Once the user has logged in set the user on the AuthorizationRequest
133	1	$authRequest->setUser(new OAuthUser());
134		// Once the user has approved or denied the client update the status
135		// (true = approved, false = denied)
136	1	$authRequest->setAuthorizationApproved(true);
137		// Return the HTTP redirect response
138	1	$response = $server->completeAuthorizationRequest($authRequest, $response);
139
140		} catch (OAuthServerException $e) {
141		$response = $e->generateHttpResponse($response);
142
143		} catch (Exception $e) {
144		$body = new Stream('php://temp', 'r+');
145		$body->write($e->getMessage());
146		$response = $response->withStatus(500)->withBody($body);
147		}
148
149	1	$redirectUri = $response->getHeader('Location');
150	1	if (!empty($redirectUri)) {
151	1	if (\substr($redirectUri[0], 0, 1) == '?') {
152		$uri = \str_replace('?', '', $redirectUri[0]);
153		\parse_str($uri, $vars);
154		$this->sendJsonResponse($vars);
155		}
156		} else {
157		$this->sendResponse($response);
158		}
159
160	1	return $response;
161		}
162
163		/**
164		* @SWG\Post(
165		* path="/oauth2/access-token",
166		* operationId="accessToken",
167		* @SWG\Response(response="200", description="An access token"),
168		* tags={"auth"},
169		* @SWG\Parameter(
170		* name="grant_type",
171		* in="formData",
172		* type="string",
173		* description="the type of grant",
174		* required=true,
175		* default="client_credentials",
176		* ),
177		* @SWG\Parameter(
178		* name="client_id",
179		* in="formData",
180		* type="string",
181		* description="the client id",
182		* required=true,
183		* default="ceac682a9a4808bf910ad49134230e0e"
184		* ),
185		* @SWG\Parameter(
186		* name="client_secret",
187		* in="formData",
188		* type="string",
189		* description="the client secret",
190		* required=false,
191		* default="JDJ5JDEwJGNEd1J1VEdOY0YxS3QvL0pWQzMxay52"
192		* ),
193		* @SWG\Parameter(
194		* name="scope",
195		* in="formData",
196		* type="string",
197		* description="the scopes you wish to use",
198		* required=false,
199		* default="admin"
200		* ),
201		* @SWG\Parameter(
202		* name="redirect_uri",
203		* in="formData",
204		* type="string",
205		* description="with the same redirect URI the user was redirect back to",
206		* required=false,
207		* ),
208		* @SWG\Parameter(
209		* name="code",
210		* in="formData",
211		* type="string",
212		* description="with the authorization code from the query string",
213		* required=false,
214		* ),
215		* )
216		*/
217	6	public function accessTokenAction()
218		{
219		/* @var AuthorizationServer $server */
220	6	$server = $this->oauth2Server;
221
222	6	$request = $this->getRequest();
223	6	$response = new Response();
224
225		try {
226		// Try to respond to the access token request
227	6	$response = $server->respondToAccessTokenRequest($request, $response);
228	4	} catch (OAuthServerException $e) {
229	3	$response = $e->generateHttpResponse($response);
230	1	} catch (Exception $e) {
231	1	$code = $e->getCode() ?: 500;
232		$response = $response
233	1	->withStatus($code)
234	1	->withHeader('content-type', 'application/json; charset=UTF-8');
235	1	$response->getBody()->write(\json_encode([
236	1	'error' => $code,
237	1	'message' => $e->getMessage(),
238		]));
239		}
240	6	$this->sendResponse($response);
241		}
242
243		/**
244		* @return Form
245		*/
246		private function getForm()
247		{
248		$form = new Form('auth');
249		$radio = new Radio('auth');
250		$radio->setOptions([
251		'yes' => 'Yes',
252		'no' => 'No',
253		]);
254		$radio->setLabel('Do you authorise TestClient?');
255		$radio->setRenderInline(true);
256		$radio->setRequired(true);
257		$submit = new Submit('submit');
258
259		$form->addField($radio)
260		->addField($submit);
261
262		return $form;
263		}
264		}
265

delboy1978uk / oauth2-api

Push — master ( 21cdfe...febb5f )

OAuthServerController::sendResponse() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like