0 follower

Final Class Yiisoft\Auth\Jwt\JwtMethod

All Classes | Methods
InheritanceYiisoft\Auth\Jwt\JwtMethod
ImplementsYiisoft\Auth\AuthenticationMethodInterface

Authentication method based on JWT token.

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\Auth\Jwt\JwtMethod
authenticate() Yiisoft\Auth\Jwt\JwtMethod
challenge() Yiisoft\Auth\Jwt\JwtMethod
withHeaderName() Yiisoft\Auth\Jwt\JwtMethod
withHeaderTokenPattern() Yiisoft\Auth\Jwt\JwtMethod
withIdentifier() Yiisoft\Auth\Jwt\JwtMethod
withQueryParameterName() Yiisoft\Auth\Jwt\JwtMethod
withRealm() Yiisoft\Auth\Jwt\JwtMethod

Method Details

Hide inherited methods

__construct() public method

public __construct( \Yiisoft\Auth\IdentityRepositoryInterface $identityRepository, Yiisoft\Auth\Jwt\TokenRepositoryInterface $tokenRepository, \Jose\Component\Checker\ClaimChecker[]|null $claimCheckers = null ): mixed
$identityRepository \Yiisoft\Auth\IdentityRepositoryInterface

Repository to get identity from.
$tokenRepository Yiisoft\Auth\Jwt\TokenRepositoryInterface

Token manager to obtain claims from.
$claimCheckers \Jose\Component\Checker\ClaimChecker[]|null

Claim checkers. If not specified, \Jose\Component\Checker\ExpirationTimeChecker is used.

 

                public function __construct(
    private IdentityRepositoryInterface $identityRepository,
    private TokenRepositoryInterface $tokenRepository,
    ?array $claimCheckers = null,
) {
    $this->claimCheckers = $claimCheckers ?? [new ExpirationTimeChecker()];
}
authenticate() public method

public authenticate( \Psr\Http\Message\ServerRequestInterface $request ): \Yiisoft\Auth\IdentityInterface|null
$request \Psr\Http\Message\ServerRequestInterface 

                public function authenticate(ServerRequestInterface $request): ?IdentityInterface
{
    $token = $this->getAuthenticationToken($request);
    if ($token === null) {
        return null;
    }
    $claims = $this->tokenRepository->getClaims($token, $name);
    if ($claims === null || !isset($claims[$this->identifier])) {
        return null;
    }
    $this
        ->getClaimCheckerManager()
        ->check($claims);
    return $this->identityRepository->findIdentity((string) $claims[$this->identifier]);
}
challenge() public method

public challenge( \Psr\Http\Message\ResponseInterface $response ): \Psr\Http\Message\ResponseInterface
$response \Psr\Http\Message\ResponseInterface 

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

public withHeaderName( string $headerName ): self
$headerName string

Authorization header name.

 

                public function withHeaderName(string $headerName): self
{
    $new = clone $this;
    $new->headerName = $headerName;
    return $new;
}
withHeaderTokenPattern() public method

public withHeaderTokenPattern( string $headerTokenPattern ): self
$headerTokenPattern string

Regular expression to use for getting a token from authorization header. Token value should match first capturing group.

 

                public function withHeaderTokenPattern(string $headerTokenPattern): self
{
    $new = clone $this;
    $new->headerTokenPattern = $headerTokenPattern;
    return $new;
}
withIdentifier() public method

public withIdentifier( string $identifier ): self
$identifier string

Identifier to check claims for.

 

                public function withIdentifier(string $identifier): self
{
    $new = clone $this;
    $new->identifier = $identifier;
    return $new;
}
withQueryParameterName() public method

public withQueryParameterName( string $queryParameterName ): self
$queryParameterName string

Request parameter name to check for a token.

 

                public function withQueryParameterName(string $queryParameterName): self
{
    $new = clone $this;
    $new->queryParameterName = $queryParameterName;
    return $new;
}
withRealm() public method

public withRealm( string $realm ): self
$realm string

The HTTP authentication realm.

 

                public function withRealm(string $realm): self
{
    $new = clone $this;
    $new->realm = $realm;
    return $new;
}