TokenManager::generateAccessToken() - Code Metrics - Inspection of "Update project" - garbuzivan/laraveltokens - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 69451c...874877 )

by Garbuz

created 2021-10-23 10:19 UTC

TokenManager::generateAccessToken() A

↳ Parent: TokenManager

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Garbuzivan\Laraveltokens;

use DateTime;
use Garbuzivan\Laraveltokens\Exceptions\TokenIsNotNalidException;
use Garbuzivan\Laraveltokens\Interfaces\AccessTokenRepositoryInterface;
use Garbuzivan\Laraveltokens\Models\AccessToken;
use Illuminate\Support\Str;

class TokenManager
{
    /**
     * @var Config $config
     */
    protected Config $config;

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

    /**
     * Configuration constructor.
     * @param Config $config
     * @param AccessTokenRepositoryInterface $TokenRepository
     */
    public function __construct(Config $config, AccessTokenRepositoryInterface $TokenRepository)
    {
        $this->config = $config;
        $this->accessTokenRepository = $TokenRepository;
    }

    /**
     * Авторизация по токену
     * @param string $token
     * @return AccessToken
     * @throws TokenIsNotNalidException
     */
    public function auth(string $token): AccessToken
    {
        $token = $this->config->isEncryption() ? $this->getHash($token) : $token;
        $tokenDb = $this->accessTokenRepository->getAccessToken($token);
        if (is_null($tokenDb) || !$tokenDb->isValid()) {
            throw new TokenIsNotNalidException;
        }
        if ($this->config->isLastUse()) {
            $this->accessTokenRepository->setLastUseAccessToken($token);
        }
        return $tokenDb;
    }

    /**
     * Проверить актуальность токена (наличие токена и дата активности)
     * @param string $token
     * @return bool
     */
    public function isValid(string $token): bool
    {
        $token = $this->config->isEncryption() ? $this->getHash($token) : $token;
        $tokenInfo = $this->accessTokenRepository->getAccessToken($token);
        if (is_null($tokenInfo) || !$tokenInfo->isValid()) {
            return false;
        }
        return true;
    }

    /**
     * Создать токен
     * @param string $title - заголовок токена
     * @param int $user_id - ID клиента
     * @param DateTime|null $expiration - до когда действует токен, null - бессрочно
     * @param string|null $user_type - класс полиморфной связи, null == App\Models\User
     * @param string|null $token - токен, null == автоматическая генерация токена
     * @return AccessToken
     * @throws Exceptions\UserNotExistsException
     */
    public function createAccessToken(
        string    $title,
        ?DateTime $expiration = null,
        int       $user_id,
        ?string   $user_type = null,
        ?string   $token = null
    ): AccessToken {
        $token = is_null($token) || mb_strlen($token) < 32 ? $this->generateAccessToken() : $token;
        $user_type = is_null($user_type) ? $this->getDefaultMorph() : $user_type;
        $this->accessTokenRepository->isMorph($user_id, $user_type);
        $tokenDB = $this->accessTokenRepository->createAccessToken(
            $title,
            $expiration,
            $user_id,
            $user_type,
            $this->getAccessTokenDb($token)
        );
        $tokenDB->token = $token;
        return $tokenDB;
    }

    /**
     * Удалить токен по ID токена
     * @param int $token_id - ID токена
     * @return bool
     */
    public function deleteAccessTokenById(int $token_id): bool
    {
        return $this->accessTokenRepository->deleteAccessTokenById($token_id);
    }

    /**
     * Удалить токен
     * @param string $token
     * @return bool
     */
    public function deleteAccessToken(string $token): bool
    {
        return $this->accessTokenRepository->deleteAccessToken($token);
    }

    /**
     * Удалить все токены пользователя по id пользователя
     *
     * @param int    $user_id
     * @param string $user_type
     *
     * @return bool
     */
    public function deleteAccessTokenByUser(int $user_id, string $user_type): bool
    {
        return $this->accessTokenRepository->deleteAccessTokenByUser($user_id, $user_type);
    }

    /**
     * Очистить таблицу токенов
     * @return bool
     */
    public function deleteAllTokens(): bool
    {
        return $this->accessTokenRepository->deleteAllAccessToken();
    }

    /**
     * Деактивировать токен (прекратить срок действия токена) по ID токена
     * @param int $token_id - ID токена
     * @return bool
     */
    public function deactivationAccessTokenById(int $token_id): bool
    {
        return $this->accessTokenRepository->deactivationAccessTokenById($token_id);
    }

    /**
     * Деактивировать токен (прекратить срок действия токена) по токену
     * @param string $token
     * @return bool
     */
    public function deactivationAccessToken(string $token): bool
    {
        return $this->accessTokenRepository->deactivationAccessToken($token);
    }

    /**
     * Деактивировать токен (прекратить срок действия токена) по id пользователя
     *
     * @param int    $user_id
     * @param string $user_type
     *
     * @return bool
     */
    public function deactivationAccessTokenByUser(int $user_id, string $user_type): bool
    {
        return $this->accessTokenRepository->deactivationAccessTokenByUser($user_id, $user_type);
    }

    /**
     * Продлить срок действия токена по id токена
     * @param int $token_id
     * @param DateTime $expiration
     * @return bool
     */
    public function prolongationAccessTokenById(int $token_id, DateTime $expiration): bool
    {
        return $this->accessTokenRepository->prolongationAccessTokenById($token_id, $expiration);
    }

    /**
     * Продлить срок действия всех токенов по id пользователя
     *
     * @param int      $user_id
     * @param string   $user_type
     * @param DateTime $expiration
     *
     * @return bool
     */
    public function prolongationAccessTokenByUser(int $user_id, string $user_type, DateTime $expiration): bool
    {
        return $this->accessTokenRepository->prolongationAccessTokenByUser($user_id, $user_type, $expiration);
    }

    /**
     * Продлить срок действия токена по токену
     * @param string $token
     * @param DateTime $expiration
     * @return bool
     */
    public function prolongationAccessToken(string $token, DateTime $expiration): bool
    {
        return $this->accessTokenRepository->prolongationAccessToken($token, $expiration);
    }

    /**
     * Генерация случайного токена на основе даты и случайной строки
     * @return string
     */
    public function generateAccessToken(): string
    {
        return sha1(time() . Str::random());
    }

    /**
     * Преобразование токена для БД в зависимости от настройки Encryption
     * @param string $token
     * @return string
     */
    public function getAccessTokenDb(string $token): string
    {
        return $this->config->isEncryption() ? $this->getHash($token) : $token;
    }

    /**
     * Получение хэша
     * @param string $string
     * @return string
     */
    public function getHash(string $string): string
    {
        return hash('sha256', $string);
    }

    /**
     * Сравнение токена
     * @param string $token
     * @param string $hash
     * @return bool
     */
    public function isVerify(string $token, string $hash): bool
    {
        return strcmp($this->getAccessTokenDb($token), $hash) !== 0;
    }

    /**
     * Получить deault Morph
     * @return string
     */
    public function getDefaultMorph(): string
    {
        return 'App\Models\User';
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Garbuzivan\Laraveltokens;
6
7			use DateTime;
8			use Garbuzivan\Laraveltokens\Exceptions\TokenIsNotNalidException;
9			use Garbuzivan\Laraveltokens\Interfaces\AccessTokenRepositoryInterface;
10			use Garbuzivan\Laraveltokens\Models\AccessToken;
11			use Illuminate\Support\Str;
12
13			class TokenManager
14			{
15			/**
16			* @var Config $config
17			*/
18			protected Config $config;
19
20			/**
21			* @var AccessTokenRepositoryInterface
22			*/
23			protected AccessTokenRepositoryInterface $accessTokenRepository;
24
25			/**
26			* Configuration constructor.
27			* @param Config $config
28			* @param AccessTokenRepositoryInterface $TokenRepository
29			*/
30			public function __construct(Config $config, AccessTokenRepositoryInterface $TokenRepository)
31			{
32			$this->config = $config;
33			$this->accessTokenRepository = $TokenRepository;
34			}
35
36			/**
37			* Авторизация по токену
38			* @param string $token
39			* @return AccessToken
40			* @throws TokenIsNotNalidException
41			*/
42			public function auth(string $token): AccessToken
43			{
44			$token = $this->config->isEncryption() ? $this->getHash($token) : $token;
45			$tokenDb = $this->accessTokenRepository->getAccessToken($token);
46			if (is_null($tokenDb) \|\| !$tokenDb->isValid()) {
47			throw new TokenIsNotNalidException;
48			}
49			if ($this->config->isLastUse()) {
50			$this->accessTokenRepository->setLastUseAccessToken($token);
51			}
52			return $tokenDb;
53			}
54
55			/**
56			* Проверить актуальность токена (наличие токена и дата активности)
57			* @param string $token
58			* @return bool
59			*/
60			public function isValid(string $token): bool
61			{
62			$token = $this->config->isEncryption() ? $this->getHash($token) : $token;
63			$tokenInfo = $this->accessTokenRepository->getAccessToken($token);
64			if (is_null($tokenInfo) \|\| !$tokenInfo->isValid()) {
65			return false;
66			}
67			return true;
68			}
69
70			/**
71			* Создать токен
72			* @param string $title - заголовок токена
73			* @param int $user_id - ID клиента
74			* @param DateTime\|null $expiration - до когда действует токен, null - бессрочно
75			* @param string\|null $user_type - класс полиморфной связи, null == App\Models\User
76			* @param string\|null $token - токен, null == автоматическая генерация токена
77			* @return AccessToken
78			* @throws Exceptions\UserNotExistsException
79			*/
80			public function createAccessToken(
81			string $title,
82			?DateTime $expiration = null,
83			int $user_id,
84			?string $user_type = null,
85			?string $token = null
86			): AccessToken {
87			$token = is_null($token) \|\| mb_strlen($token) < 32 ? $this->generateAccessToken() : $token;
88			$user_type = is_null($user_type) ? $this->getDefaultMorph() : $user_type;
89			$this->accessTokenRepository->isMorph($user_id, $user_type);
90			$tokenDB = $this->accessTokenRepository->createAccessToken(
91			$title,
92			$expiration,
93			$user_id,
94			$user_type,
95			$this->getAccessTokenDb($token)
96			);
97			$tokenDB->token = $token;
98			return $tokenDB;
99			}
100
101			/**
102			* Удалить токен по ID токена
103			* @param int $token_id - ID токена
104			* @return bool
105			*/
106			public function deleteAccessTokenById(int $token_id): bool
107			{
108			return $this->accessTokenRepository->deleteAccessTokenById($token_id);
109			}
110
111			/**
112			* Удалить токен
113			* @param string $token
114			* @return bool
115			*/
116			public function deleteAccessToken(string $token): bool
117			{
118			return $this->accessTokenRepository->deleteAccessToken($token);
119			}
120
121			/**
122			* Удалить все токены пользователя по id пользователя
123			*
124			* @param int $user_id
125			* @param string $user_type
126			*
127			* @return bool
128			*/
129			public function deleteAccessTokenByUser(int $user_id, string $user_type): bool
130			{
131			return $this->accessTokenRepository->deleteAccessTokenByUser($user_id, $user_type);
132			}
133
134			/**
135			* Очистить таблицу токенов
136			* @return bool
137			*/
138			public function deleteAllTokens(): bool
139			{
140			return $this->accessTokenRepository->deleteAllAccessToken();
141			}
142
143			/**
144			* Деактивировать токен (прекратить срок действия токена) по ID токена
145			* @param int $token_id - ID токена
146			* @return bool
147			*/
148			public function deactivationAccessTokenById(int $token_id): bool
149			{
150			return $this->accessTokenRepository->deactivationAccessTokenById($token_id);
151			}
152
153			/**
154			* Деактивировать токен (прекратить срок действия токена) по токену
155			* @param string $token
156			* @return bool
157			*/
158			public function deactivationAccessToken(string $token): bool
159			{
160			return $this->accessTokenRepository->deactivationAccessToken($token);
161			}
162
163			/**
164			* Деактивировать токен (прекратить срок действия токена) по id пользователя
165			*
166			* @param int $user_id
167			* @param string $user_type
168			*
169			* @return bool
170			*/
171			public function deactivationAccessTokenByUser(int $user_id, string $user_type): bool
172			{
173			return $this->accessTokenRepository->deactivationAccessTokenByUser($user_id, $user_type);
174			}
175
176			/**
177			* Продлить срок действия токена по id токена
178			* @param int $token_id
179			* @param DateTime $expiration
180			* @return bool
181			*/
182			public function prolongationAccessTokenById(int $token_id, DateTime $expiration): bool
183			{
184			return $this->accessTokenRepository->prolongationAccessTokenById($token_id, $expiration);
185			}
186
187			/**
188			* Продлить срок действия всех токенов по id пользователя
189			*
190			* @param int $user_id
191			* @param string $user_type
192			* @param DateTime $expiration
193			*
194			* @return bool
195			*/
196			public function prolongationAccessTokenByUser(int $user_id, string $user_type, DateTime $expiration): bool
197			{
198			return $this->accessTokenRepository->prolongationAccessTokenByUser($user_id, $user_type, $expiration);
199			}
200
201			/**
202			* Продлить срок действия токена по токену
203			* @param string $token
204			* @param DateTime $expiration
205			* @return bool
206			*/
207			public function prolongationAccessToken(string $token, DateTime $expiration): bool
208			{
209			return $this->accessTokenRepository->prolongationAccessToken($token, $expiration);
210			}
211
212			/**
213			* Генерация случайного токена на основе даты и случайной строки
214			* @return string
215			*/
216			public function generateAccessToken(): string
217			{
218			return sha1(time() . Str::random());
219			}
220
221			/**
222			* Преобразование токена для БД в зависимости от настройки Encryption
223			* @param string $token
224			* @return string
225			*/
226			public function getAccessTokenDb(string $token): string
227			{
228			return $this->config->isEncryption() ? $this->getHash($token) : $token;
229			}
230
231			/**
232			* Получение хэша
233			* @param string $string
234			* @return string
235			*/
236			public function getHash(string $string): string
237			{
238			return hash('sha256', $string);
239			}
240
241			/**
242			* Сравнение токена
243			* @param string $token
244			* @param string $hash
245			* @return bool
246			*/
247			public function isVerify(string $token, string $hash): bool
248			{
249			return strcmp($this->getAccessTokenDb($token), $hash) !== 0;
250			}
251
252			/**
253			* Получить deault Morph
254			* @return string
255			*/
256			public function getDefaultMorph(): string
257			{
258			return 'App\Models\User';
259			}
260			}
261

garbuzivan / laraveltokens

Push — main ( 69451c...874877 )

TokenManager::generateAccessToken() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like