Keycloak::decryptResponse() - Code Metrics - Inspection of "Update code organization" - stevenmaguire/oauth2-keycloak - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ca77bc...f69534 )

by Steven

created 2018-03-12 21:33 UTC

Keycloak::decryptResponse() A

↳ Parent: Keycloak

Complexity

Conditions	3
Paths	3

Size

Total Lines	21
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	3

Importance

Changes

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

<?php

namespace Stevenmaguire\OAuth2\Client\Provider;

use Exception;
use Firebase\JWT\JWT;
use League\OAuth2\Client\Provider\AbstractProvider;
use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
use League\OAuth2\Client\Token\AccessToken;
use League\OAuth2\Client\Tool\BearerAuthorizationTrait;
use Psr\Http\Message\ResponseInterface;
use Stevenmaguire\OAuth2\Client\Provider\Exception\EncryptionConfigurationException;

class Keycloak extends AbstractProvider
{
    use BearerAuthorizationTrait;

    /**
     * Keycloak URL, eg. http://localhost:8080/auth.
     *
     * @var string
     */
    public $authServerUrl = null;

    /**
     * Realm name, eg. demo.
     *
     * @var string
     */
    public $realm = null;

    /**
     * Encryption algorithm.
     *
     * You must specify supported algorithms for your application. See
     * https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40
     * for a list of spec-compliant algorithms.
     *
     * @var string
     */
    public $encryptionAlgorithm = null;

    /**
     * Encryption key.
     *
     * @var string
     */
    public $encryptionKey = null;

    /**
     * Constructs an OAuth 2.0 service provider.
     *
     * @param array $options An array of options to set on this provider.
     *     Options include `clientId`, `clientSecret`, `redirectUri`, and `state`.
     *     Individual providers may introduce more options, as needed.
     * @param array $collaborators An array of collaborators that may be used to
     *     override this provider's default behavior. Collaborators include
     *     `grantFactory`, `requestFactory`, `httpClient`, and `randomFactory`.
     *     Individual providers may introduce more collaborators, as needed.
     */
    public function __construct(array $options = [], array $collaborators = [])
    {
        if (isset($options['encryptionKeyPath'])) {
            $this->setEncryptionKeyPath($options['encryptionKeyPath']);
            unset($options['encryptionKeyPath']);
        }
        parent::__construct($options, $collaborators);
    }

    /**
     * Attempts to decrypt the given response.
     *
     * @param  string|array|null $response
     *
     * @return string|array|null
     */
    public function decryptResponse($response)
    {
        if (!is_string($response)) {
            return $response;
        }

        if ($this->usesEncryption()) {
            return json_decode(
                json_encode(
                    JWT::decode(
                        $response,
                        $this->encryptionKey,
                        array($this->encryptionAlgorithm)
                    )
                ),
                true
            );
        }

        throw EncryptionConfigurationException::undeterminedEncryption();
    }

    /**
     * Get authorization url to begin OAuth flow
     *
     * @return string
     */
    public function getBaseAuthorizationUrl()
    {
        return $this->getBaseUrlWithRealm().'/protocol/openid-connect/auth';
    }

    /**
     * Get access token url to retrieve token
     *
     * @param  array $params
     *
     * @return string
     */
    public function getBaseAccessTokenUrl(array $params)
    {
        return $this->getBaseUrlWithRealm().'/protocol/openid-connect/token';
    }

    /**
     * Get provider url to fetch user details
     *
     * @param  AccessToken $token
     *
     * @return string
     */
    public function getResourceOwnerDetailsUrl(AccessToken $token)
    {
        return $this->getBaseUrlWithRealm().'/protocol/openid-connect/userinfo';
    }

    /**
     * Builds the logout URL.
     *
     * @param array $options
     * @return string Authorization URL
     */
    public function getLogoutUrl(array $options = [])
    {
        $base = $this->getBaseLogoutUrl();
        $params = $this->getAuthorizationParameters($options);
        $query = $this->getAuthorizationQuery($params);
        return $this->appendQuery($base, $query);
    }

    /**
     * Get logout url to logout of session token
     *
     * @return string
     */
    private function getBaseLogoutUrl()
    {
        return $this->getBaseUrlWithRealm() . '/protocol/openid-connect/logout';
    }

    /**
     * Creates base url from provider configuration.
     *
     * @return string
     */
    protected function getBaseUrlWithRealm()
    {
        return $this->authServerUrl.'/realms/'.$this->realm;
    }

    /**
     * Get the default scopes used by this provider.
     *
     * This should not be a complete list of all scopes, but the minimum
     * required for the provider user interface!
     *
     * @return string[]
     */
    protected function getDefaultScopes()
    {
        return ['name', 'email'];
    }

    /**
     * Check a provider response for errors.
     *
     * @throws IdentityProviderException
     * @param  ResponseInterface $response
     * @param  string $data Parsed response data
     * @return void
     */
    protected function checkResponse(ResponseInterface $response, $data)
    {
        if (!empty($data['error'])) {
            $error = $data['error'].': '.$data['error_description'];
            throw new IdentityProviderException($error, 0, $data);
        }
    }

    /**
     * Generate a user object from a successful user details request.
     *
     * @param array $response
     * @param AccessToken $token
     * @return KeycloakResourceOwner
     */
    protected function createResourceOwner(array $response, AccessToken $token)
    {
        return new KeycloakResourceOwner($response);
    }

    /**
     * Requests and returns the resource owner of given access token.
     *
     * @param  AccessToken $token
     * @return KeycloakResourceOwner
     */
    public function getResourceOwner(AccessToken $token)
    {
        $response = $this->fetchResourceOwnerDetails($token);

        $response = $this->decryptResponse($response);

        return $this->createResourceOwner($response, $token);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * Updates expected encryption algorithm of Keycloak instance.
     *
     * @param string  $encryptionAlgorithm
     *
     * @return Keycloak
     */
    public function setEncryptionAlgorithm($encryptionAlgorithm)
    {
        $this->encryptionAlgorithm = $encryptionAlgorithm;

        return $this;
    }

    /**
     * Updates expected encryption key of Keycloak instance.
     *
     * @param string  $encryptionKey
     *
     * @return Keycloak
     */
    public function setEncryptionKey($encryptionKey)
    {
        $this->encryptionKey = $encryptionKey;

        return $this;
    }

    /**
     * Updates expected encryption key of Keycloak instance to content of given
     * file path.
     *
     * @param string  $encryptionKeyPath
     *
     * @return Keycloak
     */
    public function setEncryptionKeyPath($encryptionKeyPath)
    {
        try {
            $this->encryptionKey = file_get_contents($encryptionKeyPath);
        } catch (Exception $e) {
            // Not sure how to handle this yet.
        }

        return $this;
    }

    /**
     * Checks if provider is configured to use encryption.
     *
     * @return bool
     */
    public function usesEncryption()
    {
        return (bool) $this->encryptionAlgorithm && $this->encryptionKey;
    }
}


1		<?php
2
3		namespace Stevenmaguire\OAuth2\Client\Provider;
4
5		use Exception;
6		use Firebase\JWT\JWT;
7		use League\OAuth2\Client\Provider\AbstractProvider;
8		use League\OAuth2\Client\Provider\Exception\IdentityProviderException;
9		use League\OAuth2\Client\Token\AccessToken;
10		use League\OAuth2\Client\Tool\BearerAuthorizationTrait;
11		use Psr\Http\Message\ResponseInterface;
12		use Stevenmaguire\OAuth2\Client\Provider\Exception\EncryptionConfigurationException;
13
14		class Keycloak extends AbstractProvider
15		{
16		use BearerAuthorizationTrait;
17
18		/**
19		* Keycloak URL, eg. http://localhost:8080/auth.
20		*
21		* @var string
22		*/
23		public $authServerUrl = null;
24
25		/**
26		* Realm name, eg. demo.
27		*
28		* @var string
29		*/
30		public $realm = null;
31
32		/**
33		* Encryption algorithm.
34		*
35		* You must specify supported algorithms for your application. See
36		* https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40
37		* for a list of spec-compliant algorithms.
38		*
39		* @var string
40		*/
41		public $encryptionAlgorithm = null;
42
43		/**
44		* Encryption key.
45		*
46		* @var string
47		*/
48		public $encryptionKey = null;
49
50		/**
51		* Constructs an OAuth 2.0 service provider.
52		*
53		* @param array $options An array of options to set on this provider.
54		* Options include `clientId`, `clientSecret`, `redirectUri`, and `state`.
55		* Individual providers may introduce more options, as needed.
56		* @param array $collaborators An array of collaborators that may be used to
57		* override this provider's default behavior. Collaborators include
58		* `grantFactory`, `requestFactory`, `httpClient`, and `randomFactory`.
59		* Individual providers may introduce more collaborators, as needed.
60		*/
61	28	public function __construct(array $options = [], array $collaborators = [])
62		{
63	28	if (isset($options['encryptionKeyPath'])) {
64	4	$this->setEncryptionKeyPath($options['encryptionKeyPath']);
65	4	unset($options['encryptionKeyPath']);
66		}
67	28	parent::__construct($options, $collaborators);
68	28	}
69
70		/**
71		* Attempts to decrypt the given response.
72		*
73		* @param string\|array\|null $response
74		*
75		* @return string\|array\|null
76		*/
77	6	public function decryptResponse($response)
78		{
79	6	if (!is_string($response)) {
80	2	return $response;
81		}
82
83	4	if ($this->usesEncryption()) {
84	2	return json_decode(
85	2	json_encode(
86	2	JWT::decode(
87	2	$response,
88	2	$this->encryptionKey,
89	2	array($this->encryptionAlgorithm)
90		)
91		),
92	2	true
93		);
94		}
95
96	2	throw EncryptionConfigurationException::undeterminedEncryption();
97		}
98
99		/**
100		* Get authorization url to begin OAuth flow
101		*
102		* @return string
103		*/
104	6	public function getBaseAuthorizationUrl()
105		{
106	6	return $this->getBaseUrlWithRealm().'/protocol/openid-connect/auth';
107		}
108
109		/**
110		* Get access token url to retrieve token
111		*
112		* @param array $params
113		*
114		* @return string
115		*/
116	12	public function getBaseAccessTokenUrl(array $params)
117		{
118	12	return $this->getBaseUrlWithRealm().'/protocol/openid-connect/token';
119		}
120
121		/**
122		* Get provider url to fetch user details
123		*
124		* @param AccessToken $token
125		*
126		* @return string
127		*/
128	6	public function getResourceOwnerDetailsUrl(AccessToken $token)
129		{
130	6	return $this->getBaseUrlWithRealm().'/protocol/openid-connect/userinfo';
131		}
132
133		/**
134		* Builds the logout URL.
135		*
136		* @param array $options
137		* @return string Authorization URL
138		*/
139	2	public function getLogoutUrl(array $options = [])
140		{
141	2	$base = $this->getBaseLogoutUrl();
142	2	$params = $this->getAuthorizationParameters($options);
143	2	$query = $this->getAuthorizationQuery($params);
144	2	return $this->appendQuery($base, $query);
145		}
146
147		/**
148		* Get logout url to logout of session token
149		*
150		* @return string
151		*/
152	2	private function getBaseLogoutUrl()
153		{
154	2	return $this->getBaseUrlWithRealm() . '/protocol/openid-connect/logout';
155		}
156
157		/**
158		* Creates base url from provider configuration.
159		*
160		* @return string
161		*/
162	20	protected function getBaseUrlWithRealm()
163		{
164	20	return $this->authServerUrl.'/realms/'.$this->realm;
165		}
166
167		/**
168		* Get the default scopes used by this provider.
169		*
170		* This should not be a complete list of all scopes, but the minimum
171		* required for the provider user interface!
172		*
173		* @return string[]
174		*/
175	6	protected function getDefaultScopes()
176		{
177	6	return ['name', 'email'];
178		}
179
180		/**
181		* Check a provider response for errors.
182		*
183		* @throws IdentityProviderException
184		* @param ResponseInterface $response
185		* @param string $data Parsed response data
186		* @return void
187		*/
188	10	protected function checkResponse(ResponseInterface $response, $data)
189		{
190	10	if (!empty($data['error'])) {
191	2	$error = $data['error'].': '.$data['error_description'];
192	2	throw new IdentityProviderException($error, 0, $data);
193		}
194	8	}
195
196		/**
197		* Generate a user object from a successful user details request.
198		*
199		* @param array $response
200		* @param AccessToken $token
201		* @return KeycloakResourceOwner
202		*/
203	4	protected function createResourceOwner(array $response, AccessToken $token)
204		{
205	4	return new KeycloakResourceOwner($response);
206		}
207
208		/**
209		* Requests and returns the resource owner of given access token.
210		*
211		* @param AccessToken $token
212		* @return KeycloakResourceOwner
213		*/
214	6	public function getResourceOwner(AccessToken $token)
215		{
216	6	$response = $this->fetchResourceOwnerDetails($token);
217
218	6	$response = $this->decryptResponse($response);
219
220	4	return $this->createResourceOwner($response, $token);
		0 ignored issues – show Bug introduced 2016-12-09 00:42 UTC by Report Bug Copy Issue Report It seems like `$response` defined by `$this->decryptResponse($response)` on line `218` can also be of type `null` or `string`; however, `Stevenmaguire\OAuth2\Cli...::createResourceOwner()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
221		}
222
223		/**
224		* Updates expected encryption algorithm of Keycloak instance.
225		*
226		* @param string $encryptionAlgorithm
227		*
228		* @return Keycloak
229		*/
230	4	public function setEncryptionAlgorithm($encryptionAlgorithm)
231		{
232	4	$this->encryptionAlgorithm = $encryptionAlgorithm;
233
234	4	return $this;
235		}
236
237		/**
238		* Updates expected encryption key of Keycloak instance.
239		*
240		* @param string $encryptionKey
241		*
242		* @return Keycloak
243		*/
244	4	public function setEncryptionKey($encryptionKey)
245		{
246	4	$this->encryptionKey = $encryptionKey;
247
248	4	return $this;
249		}
250
251		/**
252		* Updates expected encryption key of Keycloak instance to content of given
253		* file path.
254		*
255		* @param string $encryptionKeyPath
256		*
257		* @return Keycloak
258		*/
259	4	public function setEncryptionKeyPath($encryptionKeyPath)
260		{
261		try {
262	4	$this->encryptionKey = file_get_contents($encryptionKeyPath);
263	2	} catch (Exception $e) {
264		// Not sure how to handle this yet.
265		}
266
267	4	return $this;
268		}
269
270		/**
271		* Checks if provider is configured to use encryption.
272		*
273		* @return bool
274		*/
275	4	public function usesEncryption()
276		{
277	4	return (bool) $this->encryptionAlgorithm && $this->encryptionKey;
278		}
279		}
280

stevenmaguire / oauth2-keycloak

Push — master ( ca77bc...f69534 )

Keycloak::decryptResponse() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like