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

feat: adds audience validation when validating a jwt #87

Merged
merged 3 commits into from
Dec 10, 2024
Merged

feat: adds audience validation when validating a jwt #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
86c7940
feat: adds 24 hour expiry time for jwks cache
ctran88 Dec 5, 2024
6e94fe5
feat: validateJwt now checks the aud claim against app id
ctran88 Dec 10, 2024
f722ca7
test: fix test assertions to match new implementation
ctran88 Dec 10, 2024
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
15 changes: 4 additions & 11 deletions custom/lib/Auth.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ public function __construct(private string $appId, private Configuration $config
$httpClient,
$httpFactory,
$cacheItemPool,
null,
60 * 60 * 24, // expires in 24 hours
true
);
}
Expand All @@ -56,19 +56,12 @@ public function validateJwt(string $jwt): string
throw new InvalidArgumentException('JWT is required');
}

$jwtSegments = explode('.', $jwt);
if (count($jwtSegments) !== 3) {
throw new InvalidArgumentException('Invalid JWT format');
}
Comment on lines -59 to -62
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is already checked by JWT::decode here


$decodedHeader = JWT::urlsafeB64Decode($jwtSegments[0]);
$header = json_decode($decodedHeader);
$decodedToken = JWT::decode($jwt, $this->jwks);

if (!$header->kid) {
throw new InvalidArgumentException('Missing kid in token');
if (!in_array($this->appId, $decodedToken->aud)) {
throw new UnexpectedValueException('JWT audience does not match');
}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this is already checked by JWT::decode here, here, and here


$decodedToken = JWT::decode($jwt, $this->jwks);
$userId = $decodedToken->sub;

if (!$userId) {
Expand Down
6 changes: 3 additions & 3 deletions custom/test/AuthTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
namespace Passage\Test;

use Dotenv\Dotenv;
use InvalidArgumentException;
use UnexpectedValueException;
use PHPUnit\Framework\TestCase;
use Passage\Client\Passage;

Expand Down Expand Up @@ -38,8 +38,8 @@ public function testValidateJwtValidToken()

public function testValidateJwtInvalidTokenStructure()
{
$this->expectException(InvalidArgumentException::class);
$this->expectExceptionMessage('Invalid JWT format');
$this->expectException(UnexpectedValueException::class);
$this->expectExceptionMessage('Wrong number of segments');
$this->passage->auth->validateJwt('incorrect.token');
}
}
4 changes: 2 additions & 2 deletions custom/test/PassageTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,13 @@ public function testPassageVersionHeader()

public function testConstructorWithAppId()
{
$passage = new Passage('123456', '987654');
$passage = new Passage($this->appId, $this->apiKey);

// Assert that the object was created successfully
$this->assertInstanceOf(Passage::class, $passage);

// Assert that app_id and api_key properties are correctly set
$this->assertEquals('123456', $passage->getAppId());
$this->assertEquals($this->appId, $passage->getAppId());
}

public function testGetApp()
Expand Down
Loading