Valkyrja\Auth\TokenAuthenticator

Complexity

Total Complexity

6

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getAuthenticatedUsersFromRequest()	0	15	3
A	__construct()	0	13	1
A	getAuthenticatedUsersFromToken()	0	12	2

<?php

declare(strict_types=1);

/*
 * This file is part of the Valkyrja Framework package.
 *
 * (c) Melech Mizrachi <melechmizrachi@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Valkyrja\Auth;

use Valkyrja\Auth\Constant\HeaderValue;

The type Valkyrja\Auth\Constant\HeaderValue was not found. Maybe you did not declare it correctly or list all dependencies?

use Valkyrja\Auth\Data\Contract\AuthenticatedUsers;
use Valkyrja\Auth\Entity\Contract\User;
use Valkyrja\Auth\Exception\InvalidAuthenticationException;
use Valkyrja\Auth\Hasher\Contract\PasswordHasher;
use Valkyrja\Auth\Store\Contract\Store;
use Valkyrja\Http\Message\Constant\HeaderName;

The type Valkyrja\Http\Message\Constant\HeaderName was not found. Maybe you did not declare it correctly or list all dependencies?

use Valkyrja\Http\Message\Request\Contract\ServerRequest;

/**
 * Class TokenAuthenticator.
 *
 * @author Melech Mizrachi
 *
 * @template U of User
 *
 * @extends AbstractAuthenticator<U>
 */
class TokenAuthenticator extends AbstractAuthenticator
{
    /**
     * @param Store<U>        $store  The store
     * @param class-string<U> $entity The user entity

The doc comment class-string<U> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<U>.

     */
    public function __construct(
        protected ServerRequest $request,
        Store $store,
        PasswordHasher $hasher,
        string $entity,
        AuthenticatedUsers|null $authenticatedUsers = null,
        protected string $headerName = HeaderName::AUTHORIZATION,
    ) {
        parent::__construct(
            store: $store,
            hasher: $hasher,
            entity: $entity,
            authenticatedUsers: $authenticatedUsers ?? $this->getAuthenticatedUsersFromRequest() ?? new Data\AuthenticatedUsers(),
        );
    }

    /**
     * Attempt to get the authenticated users from the request.
     *
     * @return AuthenticatedUsers|null
     */
    protected function getAuthenticatedUsersFromRequest(): AuthenticatedUsers|null
    {
        $headerLine = $this->request->getHeaderLine(HeaderName::AUTHORIZATION);

        if ($headerLine === '') {
            return null;
        }

        [$bearer, $token] = explode(' ', $headerLine);

        if ($bearer !== HeaderValue::BEARER) {
            throw new InvalidAuthenticationException('Invalid authorization header');
        }

        return $this->getAuthenticatedUsersFromToken($token);
    }

    /**
     * Attempt to get the authenticated users from the token.
     *
     * @param string $token The token
     *
     * @return AuthenticatedUsers|null
     */
    protected function getAuthenticatedUsersFromToken(string $token): AuthenticatedUsers|null
    {
        $unserializedUsers = unserialize(
            $token,
            ['allowed_classes' => true]
        );

        if (! $unserializedUsers instanceof AuthenticatedUsers) {
            throw new InvalidAuthenticationException('Invalid token structure. Expecting ' . AuthenticatedUsers::class);
        }

        return $unserializedUsers;
    }
}