Skip to content
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

Jump to bottom

Use TokenInterface::getAttribute() instead of deprecated getCredentials() #1251

Open
wants to merge 1 commit into
base: 2.x
Choose a base branch
from
Open

Use TokenInterface::getAttribute() instead of deprecated getCredentials() #1251

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
4 changes: 3 additions & 1 deletion Security/Authenticator/JWTAuthenticator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,9 @@ public function createAuthenticatedToken(PassportInterface $passport, string $fi

public function createToken(Passport $passport, string $firewallName): TokenInterface
{
$token = new JWTPostAuthenticationToken($passport->getUser(), $firewallName, $passport->getUser()->getRoles(), $passport->getAttribute('token'));
$jwt = $passport->getAttribute('token');
$token = new JWTPostAuthenticationToken($passport->getUser(), $firewallName, $passport->getUser()->getRoles(), $jwt);
$token->setAttribute('token', $jwt);

$this->eventDispatcher->dispatch(new JWTAuthenticatedEvent($passport->getAttribute('payload'), $token), Events::JWT_AUTHENTICATED);

Expand Down
2 changes: 1 addition & 1 deletion Services/JWTManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ private function generateJwtStringAndDispatchEvents(UserInterface $user, array $
*/
public function decode(TokenInterface $token)
{
if (!($payload = $this->jwtEncoder->decode($token->getCredentials()))) {
if (!($payload = $this->jwtEncoder->decode($token->getAttribute('token') ?? $token->getCredentials()))) {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line doesn't fix issue #1040.

Both getCredentials() and the "token" attribute only exists on JWTPostAuthenticationToken. Other TokenInterface have neither. It means the code still crashes badly when the received token is not a
JWTPostAuthenticationToken.

Beside, other classes implementing a valid TokenInterface might have an attribute named token for their own purpose. That token will certainly not be a JWT token.

In other words, you can't assume any TokenInterface will work. You must either reject tokens based on their instance type (JWTPostAuthenticationToken or some, yet to be created, JWTAuthenticationTokenInterface) or strongly type the $token argument of the decode method with one of these two types. That's what #1244 does.

return false;
}

Expand Down
6 changes: 5 additions & 1 deletion Tests/Security/Authenticator/JWTAuthenticatorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
use Lexik\Bundle\JWTAuthenticationBundle\TokenExtractor\TokenExtractorInterface;
use PHPUnit\Framework\TestCase;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\Exception\UserNotFoundException;
use Symfony\Component\Security\Core\User\UserInterface;
use Symfony\Component\Security\Core\User\UserProviderInterface;
Expand Down Expand Up @@ -281,8 +282,10 @@ public function testCreateAuthenticatedToken()
$user = $this->createMock(UserInterface::class);
$user->method('getRoles')->willReturn(['ROLE_USER']);

$expectedToken = new JWTPostAuthenticationToken($user, 'dummy', ['ROLE_USER'], 'dummytoken');
$expectedToken->setAttribute('token', 'dummytoken');
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Issue #1040 is not about how the JWT payload is stored in the token but about what other authentication systems are used by the project.

For instance, we authenticate users with jwt when they interact with our api but users can also login on a web interface using their username/password/2FA. That authentication creates a UsernamePasswordToken. Unit tests create a TestBrowserToken.

See https://github.com/lexik/LexikJWTAuthenticationBundle/pull/1244/files#diff-89a63cacb64b31d43879018f8ede57c4f464869da9cc0115a00407187058f3e0 about how to properly cover issue #1040.

$dispatcher = $this->getEventDispatcherMock();
$dispatcher->expects($this->once())->method('dispatch')->with($this->equalTo(new JWTAuthenticatedEvent(['claim' => 'val'], new JWTPostAuthenticationToken($user, 'dummy', ['ROLE_USER'], 'dummytoken'))), Events::JWT_AUTHENTICATED);
$dispatcher->expects($this->once())->method('dispatch')->with($this->equalTo(new JWTAuthenticatedEvent(['claim' => 'val'], $expectedToken)), Events::JWT_AUTHENTICATED);

$authenticator = new JWTAuthenticator(
$this->getJWTManagerMock(),
Expand All @@ -305,6 +308,7 @@ public function testCreateAuthenticatedToken()

$this->assertInstanceOf(JWTPostAuthenticationToken::class, $token);
$this->assertSame('dummytoken', $token->getCredentials());
$this->assertSame('dummytoken', $token->getAttribute('token'));
}

public function testParsingAnInvalidTokenThrowsException()
Expand Down
Loading