Yiisoft\Auth\Method\HttpBearer

Complexity

Total Complexity

2

Size/Duplication

Total Lines	20
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	challenge()	0	3	1
A	withRealm()	0	5	1

<?php

declare(strict_types=1);

namespace Yiisoft\Auth\Method;

use Psr\Http\Message\ResponseInterface;
use Yiisoft\Http\Header;

/**
 * Authentication method based on HTTP Bearer token.
 *
 * @see https://tools.ietf.org/html/rfc6750
 */
final class HttpBearer extends HttpHeader
{
    protected string $headerName = Header::AUTHORIZATION;
    protected string $pattern = '/^Bearer\s+(.*?)$/';
    private string $realm = 'api';

    public function challenge(ResponseInterface $response): ResponseInterface
    {
        return $response->withHeader(Header::WWW_AUTHENTICATE, "{$this->headerName} realm=\"{$this->realm}\"");
    }

    /**
     * @param string $realm The HTTP authentication realm.
     * @return self
     */
    public function withRealm(string $realm): self
    {
        $new = clone $this;
        $new->realm = $realm;
        return $new;
    }
}