Skip to content

Improve support for custom token prefixes. #704

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 18, 2025
Merged

Improve support for custom token prefixes. #704

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions src/Authenticator/TokenAuthenticator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,11 @@ class TokenAuthenticator extends AbstractAuthenticator implements StatelessInter
*/
protected function getToken(ServerRequestInterface $request): ?string
{
$token = $this->getTokenFromHeader($request, $this->getConfig('header'));
if ($token === null) {
$token = $this->getTokenFromQuery($request, $this->getConfig('queryParam'));
}
$token = $this->getTokenFromHeader($request, $this->getConfig('header'))
?? $this->getTokenFromQuery($request, $this->getConfig('queryParam'));

$prefix = $this->getConfig('tokenPrefix');
if ($prefix !== null && is_string($token)) {
if ($prefix !== null && $token !== null) {
return $this->stripTokenPrefix($token, $prefix);
}

Expand All @@ -65,7 +63,7 @@ protected function getToken(ServerRequestInterface $request): ?string
*/
protected function stripTokenPrefix(string $token, string $prefix): string
{
return str_ireplace($prefix . ' ', '', $token);
return trim(str_ireplace($prefix, '', $token));
}

/**
Expand Down
9 changes: 9 additions & 0 deletions tests/TestCase/Authenticator/TokenAuthenticatorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,15 @@ public function testTokenPrefix()
$this->assertInstanceOf(Result::class, $result);
$this->assertSame(Result::SUCCESS, $result->getStatus());

$requestWithHeaders = $this->request->withAddedHeader('X-Dipper-Auth', 'dipper_mariano');
$tokenAuth = new TokenAuthenticator($this->identifiers, [
'header' => 'X-Dipper-Auth',
'tokenPrefix' => 'dipper_',
]);
$result = $tokenAuth->authenticate($requestWithHeaders);
$this->assertInstanceOf(Result::class, $result);
$this->assertSame(Result::SUCCESS, $result->getStatus());

//invalid prefix
$requestWithHeaders = $this->request->withAddedHeader('Token', 'bearer mariano');
$tokenAuth = new TokenAuthenticator($this->identifiers, [
Expand Down