JWTAuthentication::getPermissions() - Code Metrics - platine-php/framework - Measure and Improve Code Quality continuously with Scrutinizer

JWTAuthentication::getPermissions() A
last analyzed 2026-01-12 08:59 UTC

↳ Parent: JWTAuthentication
Complexity

Conditions	5
Paths	7
Size

Total Lines	28
Code Lines	15
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	5
eloc	15
nc	7
nop	0
dl	0
loc	28
rs	9.4555
c	1
b	0
f	0
<?php

/**
 * Platine Framework
 *
 * Platine Framework is a lightweight, high-performance, simple and elegant
 * PHP Web framework
 *
 * This content is released under the MIT License (MIT)
 *
 * Copyright (c) 2020 Platine Framework
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 *  @file JWTAuthentication.php
 *
 *  The Authentication using JWT class
 *
 *  @package    Platine\Framework\Auth\Authentication
 *  @author Platine Developers team
 *  @copyright  Copyright (c) 2020
 *  @license    http://opensource.org/licenses/MIT  MIT License
 *  @link   https://www.platine-php.com
 *  @version 1.0.0
 *  @filesource
 */

declare(strict_types=1);

namespace Platine\Framework\Auth\Authentication;

use DateTime;
use Platine\Config\Config;
use Platine\Container\ContainerInterface;
use Platine\Framework\Auth\AuthenticationInterface;
use Platine\Framework\Auth\Authorization\PermissionCacheInterface;
use Platine\Framework\Auth\Entity\Token;
use Platine\Framework\Auth\Entity\User;
use Platine\Framework\Auth\Enum\UserStatus;
use Platine\Framework\Auth\Exception\AccountLockedException;
use Platine\Framework\Auth\Exception\AccountNotFoundException;
use Platine\Framework\Auth\Exception\InvalidCredentialsException;
use Platine\Framework\Auth\Exception\MissingCredentialsException;
use Platine\Framework\Auth\IdentityInterface;
use Platine\Framework\Auth\Repository\TokenRepository;
use Platine\Framework\Auth\Repository\UserRepository;
use Platine\Framework\Security\JWT\Exception\JWTException;
use Platine\Framework\Security\JWT\JWT;
use Platine\Http\ServerRequestInterface;
use Platine\Logger\LoggerInterface;
use Platine\Security\Hash\HashInterface;
use Platine\Stdlib\Helper\Arr;
use Platine\Stdlib\Helper\Str;

/**
 * @class JWTAuthentication
 * @package Platine\Framework\Auth\Authentication
 * @template T
 */
class JWTAuthentication implements AuthenticationInterface
{
    /**
     * Create new instance
     * @param JWT $jwt
     * @param LoggerInterface $logger
     * @param Config<T> $config
     * @param HashInterface $hash
     * @param UserRepository $userRepository
     * @param TokenRepository $tokenRepository
     * @param ContainerInterface $container
     * @param PermissionCacheInterface $permissionCache
     */
    public function __construct(
        protected JWT $jwt,
        protected LoggerInterface $logger,
        protected Config $config,
        protected HashInterface $hash,
        protected UserRepository $userRepository,
        protected TokenRepository $tokenRepository,
        protected ContainerInterface $container,
        protected PermissionCacheInterface $permissionCache
    ) {
    }

    /**
     * {@inheritdoc}
     */
    public function getUser(): IdentityInterface
    {
        if ($this->isLogged() === false) {
            throw new AccountNotFoundException('User not logged', 401);
        }

        $payload = $this->jwt->getPayload();
        $id = (int) ($payload['sub'] ?? -1);

        $user = $this->userRepository->find($id);
        if ($user === null) {
            throw new AccountNotFoundException(
                'Can not find the logged user information, may be data is corrupted',
                401
            );
        }

        return $user;

    }

    /**
     * {@inheritdoc}
     */
    public function getPermissions(): array
    {
        if ($this->isLogged() === false) {
            return [];
        }

        $payload = $this->jwt->getPayload();
        $roles = $payload['roles'] ?? [];
        $permissions = [];
        foreach ($roles as $id) {
            // TODO: add configuration for prefix
            $roleKey = sprintf('api_role_%d', $id);
            $pers = $this->permissionCache->get($roleKey, []);
            if (is_array($pers)) {
                $permissions = [
                    ...$pers,
                    ...$permissions
                ];
            }
        }

        if (count($permissions) > 0) {
            return array_unique($permissions);
        }

        // May be cache feature not available or expired
        // get user permissions from database
        return $this->getUserPermissions((int) ($payload['sub'] ?? -1));
    }


    /**
     * {@inheritdoc}
     */
    public function getId(): int|string
    {
        if ($this->isLogged() === false) {
            throw new AccountNotFoundException('User not logged', 401);
        }

        $payload = $this->jwt->getPayload();
        $id = (int) ($payload['sub'] ?? -1);

        return $id;
    }

    /**
     * {@inheritdoc}
     */
    public function isLogged(): bool
    {
        $request = null;
        if ($this->container->has(ServerRequestInterface::class)) {
            /** @var ServerRequestInterface $request */
            $request = $this->container->get(ServerRequestInterface::class);
        }

        if ($request === null) {
            return false;
        }

        $headerName = $this->config->get('api.auth.headers.name', 'Authorization');
        $tokenHeader = $request->getHeaderLine($headerName);
        if (empty($tokenHeader)) {
            $this->logger->error('API authentication failed missing token header');

            return false;
        }
        $tokenType = $this->config->get('api.auth.headers.token_type', 'Bearer');
        $secret = $this->config->get('api.sign.secret', '');

        $token = Str::replaceFirst($tokenType . ' ', '', $tokenHeader);

        $this->jwt->setSecret($secret);
        try {
            $this->jwt->decode($token);

            return true;
        } catch (JWTException $ex) {
            $this->logger->error('API authentication failed: {message}', [
                'message' => $ex->getMessage(),
            ]);
        }

        return false;
    }

    /**
     * {@inheritdoc}
     */
    public function login(
        array $credentials = [],
        bool $remeberMe = false,
        bool $withPassword = true
    ): array {
        if (isset($credentials['username']) === false) {
            throw new MissingCredentialsException(
                'Missing username information',
                401
            );
        }

        if ($withPassword && isset($credentials['password']) === false) {
            throw new MissingCredentialsException(
                'Missing password information',
                401
            );
        }

        $username = $credentials['username'];
        $password = $credentials['password'] ?? '';
        $user = $this->getUserEntity($username, $password, $withPassword);

        if ($user === null) {
            throw new AccountNotFoundException(
                sprintf(
                    'Can not find the user [%s]',
                    $username
                ),
                401
            );
        } elseif ($user->status === UserStatus::LOCKED) {

            throw new AccountLockedException(
                sprintf('User [%s] is locked', $username),
                401
            );
        }

        if ($withPassword && $this->hash->verify($password, $user->password) === false) {

            throw new InvalidCredentialsException(
                sprintf('Invalid credentials for user [%s]', $username),
                401
            );
        }

        $permissions = $this->getUserPermissions($user);
        $roles = Arr::getColumn($user->roles, 'id');

        $secret = $this->config->get('api.sign.secret');
        $expire = $this->config->get('api.auth.token_expire', 900);
        $refreshExpire = $this->config->get('api.auth.refresh_token_expire', 30 * 86400);
        $tokenExpire = time() + $expire;
        $refreshTokenExpire = time() + $refreshExpire;
        $this->jwt->setSecret($secret)
                  ->setPayload([
                      'sub' => $user->id,

                      'exp' => $tokenExpire,
                      'roles' => $roles,
                  ])
                  ->sign();

        $refreshToken = Str::random(128);
        $jwtToken = $this->jwt->getToken();

        $token = $this->tokenRepository->create([
            'refresh_token' => $refreshToken,
            'expire_at' => (new DateTime())->setTimestamp($refreshTokenExpire),
            'user_id' => $user->id,
        ]);
        $this->tokenRepository->save($token);

        $data = [
          'user' => [
            'id' => $user->id,
            'username' => $user->username,

            'lastname' => $user->lastname,

            'firstname' => $user->firstname,

            'email' => $user->email,

            'status' => $user->status,
          ],
          'permissions' => $permissions,
          'token' => $jwtToken,
          'refresh_token' => $refreshToken,
        ];

        return array_merge($data, $this->getUserData($user, $token));
    }

    /**
     * {@inheritdoc}
     */
    public function logout(bool $destroy = true): void
    {
        // do nothing now
    }

    /**
     * Return the user entity
     * @param string $username
     * @param string $password
     * @param bool $withPassword wether to use password to login
     * @return User|null
     */
    protected function getUserEntity(
        string $username,
        string $password,
        /** @scrutinizer ignore-unused */ string $password,
        bool $withPassword = true
        /** @scrutinizer ignore-unused */ bool $withPassword = true
    ): ?User {
        return $this->userRepository->with('roles.permissions')

                                    ->findBy(['username' => $username]);
    }

    /**
     * Return the user additional data
     * @param User $user
     * @param Token $token
     * @return array<string, mixed>
     */
    protected function getUserData(User $user, Token $token): array
    protected function getUserData(User $user, /** @scrutinizer ignore-unused */ Token $token): array
    {
        return [];
    }

    /**
     * Return the permission list of the given user
     * @param User|int $user
     * @return string[]
     */
    protected function getUserPermissions(User|int $user): array
    {
        $permissions = [];
        if (is_int($user)) {
            $user = $this->userRepository->with('roles.permissions')
                                         ->find($user);
            if ($user === null) {
                return [];
            }
        }

        $roles = $user->roles;

        foreach ($roles as $role) {
            $rolePermissions = $role->permissions;
            foreach ($rolePermissions as $permission) {
                if (in_array($permission->code, $permissions) === false) {
                    $permissions[] = $permission->code;
                }
            }
        }

        return $permissions;
    }
}

platine-php / framework

JWTAuthentication::getPermissions() A last analyzed 2026-01-12 08:59 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

JWTAuthentication::getPermissions() A
last analyzed 2026-01-12 08:59 UTC
