Yiisoft\Yii\Web\Auth\HttpHeaderAuth

Complexity

Total Complexity

10

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	challenge()	0	3	1
A	authenticate()	0	8	2
A	setPattern()	0	3	1
A	getAuthToken()	0	15	4
A	setHeaderName()	0	3	1

<?php
namespace Yiisoft\Yii\Web\Auth;

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Yiisoft\Yii\Web\User\IdentityInterface;
use Yiisoft\Yii\Web\User\IdentityRepositoryInterface;

/**
 * HttpHeaderAuth supports HTTP authentication through HTTP Headers.
 *
 * The default implementation of HttpHeaderAuth uses the [[Yiisoft\Yii\Web\User\IdentityRepositoryInterface::findIdentityByToken()|findIdentityByToken()]]
 * method of the `user` application component and passes the value of the `X-Api-Key` header. This implementation is used
 * for authenticating API clients.
 */
class HttpHeaderAuth implements AuthInterface
{
    private const HEADER_NAME = 'X-Api-Key';
    /**
     * @var string the HTTP header name
     */
    protected $headerName = self::HEADER_NAME;

    /**
     * @var string a pattern to use to extract the HTTP authentication value
     */
    protected $pattern;

    /**
     * @var IdentityRepositoryInterface
     */
    protected $identityRepository;

    public function __construct(IdentityRepositoryInterface $identityRepository)
    {
        $this->identityRepository = $identityRepository;
    }

    public function authenticate(ServerRequestInterface $request): ?IdentityInterface
    {
        $authToken = $this->getAuthToken($request);
        if ($authToken !== null) {
            return $this->identityRepository->findIdentityByToken($authToken, get_class($this));
        }

        return null;
    }

    public function challenge(ResponseInterface $response): ResponseInterface
    {
        return $response;
    }

    public function setHeaderName(string $name): void
    {
        $this->headerName = $name;
    }

    public function setPattern(string $pattern): void
    {
        $this->pattern = $pattern;
    }

    protected function getAuthToken(ServerRequestInterface $request): ?string
    {
        $authHeaders = $request->getHeader($this->headerName);
        $authHeader = \reset($authHeaders);
        if ($authHeader !== null) {
            if ($this->pattern !== null) {
                if (preg_match($this->pattern, $authHeader, $matches)) {
                    $authHeader = $matches[1];
                } else {
                    return null;
                }
            }
            return $authHeader;
        }
        return null;
    }
}