Model::getClientEntity() - Code Metrics - Codexshaper/php-oauth2 - Measure and Improve Code Quality continuously with Scrutinizer

Model::getClientEntity() A
last analyzed 2020-06-07 08:04 UTC

↳ Parent: Model

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	17
rs	9.7
c	0
b	0
f	0
ccs	0
cts	10
cp	0
cc	2
nc	2
nop	1
crap	6

<?php

namespace CodexShaper\OAuth2\Server;

use Carbon\Carbon;
use CodexShaper\OAuth2\Server\Entities\Client as ClientEntity;
use DateTime;

class Model
{
    /**
     * @var string
     */
    protected static $authCodeModel = '\CodexShaper\OAuth2\Server\Models\AuthCode';

    /**
     * @var string
     */
    protected static $clientModel = '\CodexShaper\OAuth2\Server\Models\Client';

    /**
     * @var string
     */
    protected static $refreshTokenModel = '\CodexShaper\OAuth2\Server\Models\RefreshToken';

    /**
     * @var string
     */
    protected static $tokenModel = '\CodexShaper\OAuth2\Server\Models\Token';

    /**
     * @var string
     */
    protected static $userModel = '\CodexShaper\OAuth2\Server\Models\User';

    /**
     * Create a new model instance.
     *
     * @param string $model The model name
     *
     * @return \CodexShaper\OAuth2\Server\Models\AuthCode|\CodexShaper\OAuth2\Server\Models\Client|\CodexShaper\OAuth2\Server\Models\RefreshToken|\CodexShaper\OAuth2\Server\Models\Token|\CodexShaper\OAuth2\Server\Models\User|null
     */
    public static function instance($model)
    {
        if (!static::${$model}) {
            return null;
        }

        return new static::${$model}();
    }

    /**
     * Get a client.
     *
     * @param string $clientIdentifier The client's identifier
     *
     * @return \League\OAuth2\Server\Entities\ClientEntityInterface|null
     */
    public static function getClientEntity($clientIdentifier)
    {
        $client = static::instance('clientModel');

        $record = $client->where($client->getKeyName(), $clientIdentifier)->first();

        if (!$record) {
            return;
        }

        return new ClientEntity(
            $clientIdentifier,
            $record->name,
            $record->redirect,
            $record->isConfidential()
        );
    }

    /**
     * store a new auth code to permanent storage.
     *
     * @param \League\OAuth2\Server\Entities\AuthCodeEntityInterface $accessTokenEntity
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return void
     */
    public static function storeAuthCode($authCodeEntity)
    {
        static::instance('authCodeModel')->create([
            'id'         => $authCodeEntity->getIdentifier(),
            'user_id'    => $authCodeEntity->getUserIdentifier(),
            'client_id'  => $authCodeEntity->getClient()->getIdentifier(),
            'scopes'     => $authCodeEntity->getScopes(),
            'revoked'    => 0,
            'expires_at' => $authCodeEntity->getExpiryDateTime(),
        ]);
    }

    /**
     * store a new access token to permanent storage.
     *
     * @param \League\OAuth2\Server\Entities\AccessTokenEntityInterface $accessTokenEntity
     *
     * @return void
     */
    public static function storeAccessToken($accessTokenEntity)
    {
        static::instance('tokenModel')->create([
            'id'         => $accessTokenEntity->getIdentifier(),
            'user_id'    => $accessTokenEntity->getUserIdentifier(),
            'client_id'  => $accessTokenEntity->getClient()->getIdentifier(),
            'scopes'     => $accessTokenEntity->getScopes(),
            'revoked'    => false,
            'created_at' => new DateTime(),
            'updated_at' => new DateTime(),
            'expires_at' => $accessTokenEntity->getExpiryDateTime(),
        ]);
    }

    /**
     * store a new access refresh token to permanent storage.
     *
     * @param \League\OAuth2\Server\Entities\RefreshTokenEntityInterface $refreshTokenEntity
     *
     * @return void
     */
    public static function storeRefreshToken($refreshTokenEntity)
    {
        static::instance('refreshTokenModel')->create([
            'id'              => $refreshTokenEntity->getIdentifier(),
            'access_token_id' => $refreshTokenEntity->getAccessToken()->getIdentifier(),
            'revoked'         => false,
            'expires_at'      => $refreshTokenEntity->getExpiryDateTime(),
        ]);
    }

    /**
     * Validate a client's secret.
     *
     * @param string      $clientIdentifier The client's identifier
     * @param null|string $clientSecret     The client's secret (if sent)
     * @param null|string $grantType        The type of grant the client is using (if sent)
     *
     * @return bool
     */
    public static function validateClientCredentials($clientIdentifier, $clientSecret, $grantType)
    {
        $client = static::instance('clientModel');

        $record = $client->where($client->getKeyName(), $clientIdentifier)->first();

        if (!$record || !static::handlesGrant($record, $grantType)) {
            return false;
        }

        return !$record->isConfidential() || hash_equals($record->secret, (string) $clientSecret);
    }

    /**
     * Determine if the given client can handle the given grant type.
     *
     * @param \CodexShaper\OAuth2\Server\Models\Client $record
     * @param string                                   $grantType
     *
     * @return bool
     */
    protected static function handlesGrant($record, $grantType)
    {
        if (is_array($record->grant_types) && !in_array($grantType, $record->grant_types)) {
            return false;
        }

        switch ($grantType) {
            case 'authorization_code':
                return $record->authorization_code_client;
            case 'password':
                return $record->password_client;
            case 'client_credentials':
                return $record->isConfidential();
            default:
                return true;
        }
    }

    /**
     * Veryfy user credentials for current grant.
     *
     * @param string                                               $username
     * @param string                                               $password
     * @param string                                               $grantType
     * @param \League\OAuth2\Server\Entities\ClientEntityInterface $clientEntity
     *
     * @return \CodexShaper\OAuth2\Server\Models\User|null
     */
    public static function verifyUserForGrant($username, $password, $grantType, $clientEntity)

    {
        if ($grantType == 'password') {
            $model = static::instance('userModel');

            $user = $model->where($model->getUserIndentifier(), $username)->first();

            if (!$user) {
                return null;
            }

            if (!md5($password) === $user->password) {
                return null;
            }

            return $user->{$user->getKeyName()};
        }

        return null;
    }

    /**
     * Revoke provided token id.
     *
     * @param string $model
     * @param string $grantType
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return void
     */
    public static function revoke($model, $tokenId)
    {
        static::instance($model)->whereId($tokenId)->update(['revoked' => true]);
    }

    /**
     * Determine if the given token id is revoked or not.
     *
     * @param string $model
     * @param string $grantType
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return bool
     */
    public static function isRevoked($model, $tokenId)
    {
        return static::instance($model)->whereId($tokenId)->whereRevoked(1)->exists();
    }

    /**
     * Authorization token.
     *
     * @param string $model
     * @param array  $data
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return \CodexShaper\OAuth2\Server\Models\AuthCode|\CodexShaper\OAuth2\Server\Models\Client|\CodexShaper\OAuth2\Server\Models\RefreshToken|\CodexShaper\OAuth2\Server\Models\Token|\CodexShaper\OAuth2\Server\Models\User|null
     */
    public static function findToken($model, $authRequest, $user)
    {
        return static::instance($model)
                ->find($authRequest->getClient()->getIdentifier())
                ->tokens()
                ->whereUserId($user->getKey())
                ->whereRevoked(0)
                ->where('expires_at', '>', Carbon::now())
                ->latest('expires_at')
                ->first();
    }
}


1			<?php
2
3			namespace CodexShaper\OAuth2\Server;
4
5			use Carbon\Carbon;
6			use CodexShaper\OAuth2\Server\Entities\Client as ClientEntity;
7			use DateTime;
8
9			class Model
10			{
11			/**
12			* @var string
13			*/
14			protected static $authCodeModel = '\CodexShaper\OAuth2\Server\Models\AuthCode';
15
16			/**
17			* @var string
18			*/
19			protected static $clientModel = '\CodexShaper\OAuth2\Server\Models\Client';
20
21			/**
22			* @var string
23			*/
24			protected static $refreshTokenModel = '\CodexShaper\OAuth2\Server\Models\RefreshToken';
25
26			/**
27			* @var string
28			*/
29			protected static $tokenModel = '\CodexShaper\OAuth2\Server\Models\Token';
30
31			/**
32			* @var string
33			*/
34			protected static $userModel = '\CodexShaper\OAuth2\Server\Models\User';
35
36			/**
37			* Create a new model instance.
38			*
39			* @param string $model The model name
40			*
41			* @return \CodexShaper\OAuth2\Server\Models\AuthCode\|\CodexShaper\OAuth2\Server\Models\Client\|\CodexShaper\OAuth2\Server\Models\RefreshToken\|\CodexShaper\OAuth2\Server\Models\Token\|\CodexShaper\OAuth2\Server\Models\User\|null
42			*/
43			public static function instance($model)
44			{
45			if (!static::${$model}) {
46			return null;
47			}
48
49			return new static::${$model}();
50			}
51
52			/**
53			* Get a client.
54			*
55			* @param string $clientIdentifier The client's identifier
56			*
57			* @return \League\OAuth2\Server\Entities\ClientEntityInterface\|null
58			*/
59			public static function getClientEntity($clientIdentifier)
60			{
61			$client = static::instance('clientModel');
62
63			$record = $client->where($client->getKeyName(), $clientIdentifier)->first();
64
65			if (!$record) {
66			return;
67			}
68
69			return new ClientEntity(
70			$clientIdentifier,
71			$record->name,
72			$record->redirect,
73			$record->isConfidential()
74			);
75			}
76
77			/**
78			* store a new auth code to permanent storage.
79			*
80			* @param \League\OAuth2\Server\Entities\AuthCodeEntityInterface $accessTokenEntity
			0 ignored issues – show Bug introduced 2020-06-05 08:15 UTC by Report Bug Copy Issue Report There is no parameter named `$accessTokenEntity`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
81			*
82			* @return void
83			*/
84			public static function storeAuthCode($authCodeEntity)
85			{
86			static::instance('authCodeModel')->create([
87			'id' => $authCodeEntity->getIdentifier(),
88			'user_id' => $authCodeEntity->getUserIdentifier(),
89			'client_id' => $authCodeEntity->getClient()->getIdentifier(),
90			'scopes' => $authCodeEntity->getScopes(),
91			'revoked' => 0,
92			'expires_at' => $authCodeEntity->getExpiryDateTime(),
93			]);
94			}
95
96			/**
97			* store a new access token to permanent storage.
98			*
99			* @param \League\OAuth2\Server\Entities\AccessTokenEntityInterface $accessTokenEntity
100			*
101			* @return void
102			*/
103			public static function storeAccessToken($accessTokenEntity)
104			{
105			static::instance('tokenModel')->create([
106			'id' => $accessTokenEntity->getIdentifier(),
107			'user_id' => $accessTokenEntity->getUserIdentifier(),
108			'client_id' => $accessTokenEntity->getClient()->getIdentifier(),
109			'scopes' => $accessTokenEntity->getScopes(),
110			'revoked' => false,
111			'created_at' => new DateTime(),
112			'updated_at' => new DateTime(),
113			'expires_at' => $accessTokenEntity->getExpiryDateTime(),
114			]);
115			}
116
117			/**
118			* store a new access refresh token to permanent storage.
119			*
120			* @param \League\OAuth2\Server\Entities\RefreshTokenEntityInterface $refreshTokenEntity
121			*
122			* @return void
123			*/
124			public static function storeRefreshToken($refreshTokenEntity)
125			{
126			static::instance('refreshTokenModel')->create([
127			'id' => $refreshTokenEntity->getIdentifier(),
128			'access_token_id' => $refreshTokenEntity->getAccessToken()->getIdentifier(),
129			'revoked' => false,
130			'expires_at' => $refreshTokenEntity->getExpiryDateTime(),
131			]);
132			}
133
134			/**
135			* Validate a client's secret.
136			*
137			* @param string $clientIdentifier The client's identifier
138			* @param null\|string $clientSecret The client's secret (if sent)
139			* @param null\|string $grantType The type of grant the client is using (if sent)
140			*
141			* @return bool
142			*/
143			public static function validateClientCredentials($clientIdentifier, $clientSecret, $grantType)
144			{
145			$client = static::instance('clientModel');
146
147			$record = $client->where($client->getKeyName(), $clientIdentifier)->first();
148
149			if (!$record \|\| !static::handlesGrant($record, $grantType)) {
150			return false;
151			}
152
153			return !$record->isConfidential() \|\| hash_equals($record->secret, (string) $clientSecret);
154			}
155
156			/**
157			* Determine if the given client can handle the given grant type.
158			*
159			* @param \CodexShaper\OAuth2\Server\Models\Client $record
160			* @param string $grantType
161			*
162			* @return bool
163			*/
164			protected static function handlesGrant($record, $grantType)
165			{
166			if (is_array($record->grant_types) && !in_array($grantType, $record->grant_types)) {
167			return false;
168			}
169
170			switch ($grantType) {
171			case 'authorization_code':
172			return $record->authorization_code_client;
173			case 'password':
174			return $record->password_client;
175			case 'client_credentials':
176			return $record->isConfidential();
177			default:
178			return true;
179			}
180			}
181
182			/**
183			* Veryfy user credentials for current grant.
184			*
185			* @param string $username
186			* @param string $password
187			* @param string $grantType
188			* @param \League\OAuth2\Server\Entities\ClientEntityInterface $clientEntity
189			*
190			* @return \CodexShaper\OAuth2\Server\Models\User\|null
191			*/
192			public static function verifyUserForGrant($username, $password, $grantType, $clientEntity)
			0 ignored issues – show Unused Code introduced 2020-06-05 08:15 UTC by Report Bug Copy Issue Report The parameter `$clientEntity` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
193			{
194			if ($grantType == 'password') {
195			$model = static::instance('userModel');
196
197			$user = $model->where($model->getUserIndentifier(), $username)->first();
198
199			if (!$user) {
200			return null;
201			}
202
203			if (!md5($password) === $user->password) {
204			return null;
205			}
206
207			return $user->{$user->getKeyName()};
208			}
209
210			return null;
211			}
212
213			/**
214			* Revoke provided token id.
215			*
216			* @param string $model
217			* @param string $grantType
			0 ignored issues – show Bug introduced 2020-06-05 08:15 UTC by Report Bug Copy Issue Report There is no parameter named `$grantType`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
218			*
219			* @return void
220			*/
221			public static function revoke($model, $tokenId)
222			{
223			static::instance($model)->whereId($tokenId)->update(['revoked' => true]);
224			}
225
226			/**
227			* Determine if the given token id is revoked or not.
228			*
229			* @param string $model
230			* @param string $grantType
			0 ignored issues – show Bug introduced 2020-06-05 08:15 UTC by Report Bug Copy Issue Report There is no parameter named `$grantType`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
231			*
232			* @return bool
233			*/
234			public static function isRevoked($model, $tokenId)
235			{
236			return static::instance($model)->whereId($tokenId)->whereRevoked(1)->exists();
237			}
238
239			/**
240			* Authorization token.
241			*
242			* @param string $model
243			* @param array $data
			0 ignored issues – show Bug introduced 2020-06-05 08:15 UTC by Report Bug Copy Issue Report There is no parameter named `$data`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
244			*
245			* @return \CodexShaper\OAuth2\Server\Models\AuthCode\|\CodexShaper\OAuth2\Server\Models\Client\|\CodexShaper\OAuth2\Server\Models\RefreshToken\|\CodexShaper\OAuth2\Server\Models\Token\|\CodexShaper\OAuth2\Server\Models\User\|null
246			*/
247			public static function findToken($model, $authRequest, $user)
248			{
249			return static::instance($model)
250			->find($authRequest->getClient()->getIdentifier())
251			->tokens()
252			->whereUserId($user->getKey())
253			->whereRevoked(0)
254			->where('expires_at', '>', Carbon::now())
255			->latest('expires_at')
256			->first();
257			}
258			}
259

Codexshaper / php-oauth2

Model::getClientEntity() A last analyzed 2020-06-07 08:04 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Model::getClientEntity() A
last analyzed 2020-06-07 08:04 UTC