Skip to content

feat(pkce): Default clientId to the client's configured client ID #423

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
gjtorikian merged 1 commit into from
Jul 27, 2026
+60 −8
Merged

feat(pkce): Default clientId to the client's configured client ID #423

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
22 changes: 14 additions & 8 deletions lib/PKCEHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ public static function generate(): array
* Generate an AuthKit authorization URL with auto-generated PKCE parameters and state.
*
* @param string $redirectUri The redirect URI.
* @param string $clientId The WorkOS client ID.
* @param string|null $clientId The WorkOS client ID. Defaults to the client's configured client ID.
* @param string|null $state Optional state parameter. Auto-generated if null.
* @param string|null $provider Optional auth provider.
* @param string|null $connectionId Optional connection ID.
Expand All @@ -87,7 +87,7 @@ public static function generate(): array
*/
public function getAuthKitAuthorizationUrl(
string $redirectUri,
string $clientId,
?string $clientId = null,
?string $state = null,
?string $provider = null,
?string $connectionId = null,
Expand All @@ -96,6 +96,7 @@ public function getAuthKitAuthorizationUrl(
?string $loginHint = null,
?string $screenHint = null,
): array {
$clientId ??= $this->client->requireClientId();
$pkce = self::generate();
$state ??= bin2hex(random_bytes(16));

Expand Down Expand Up @@ -134,14 +135,16 @@ public function getAuthKitAuthorizationUrl(
*
* @param string $code The authorization code.
* @param string $codeVerifier The PKCE code verifier.
* @param string $clientId The WorkOS client ID.
* @param string|null $clientId The WorkOS client ID. Defaults to the client's configured client ID.
* @return array The authentication response.
*/
public function authKitCodeExchange(
string $code,
string $codeVerifier,
string $clientId,
?string $clientId = null,
): array {
$clientId ??= $this->client->requireClientId();

return $this->client->request(
method: 'POST',
path: 'user_management/authenticate',
Expand All @@ -160,7 +163,7 @@ public function authKitCodeExchange(
* Generate an SSO authorization URL with auto-generated PKCE parameters and state.
*
* @param string $redirectUri The redirect URI.
* @param string $clientId The WorkOS client ID.
* @param string|null $clientId The WorkOS client ID. Defaults to the client's configured client ID.
* @param string|null $state Optional state parameter. Auto-generated if null.
* @param string|null $domain Optional SSO domain.
* @param string|null $provider Optional SSO provider.
Expand All @@ -172,7 +175,7 @@ public function authKitCodeExchange(
*/
public function getSsoAuthorizationUrl(
string $redirectUri,
string $clientId,
?string $clientId = null,
?string $state = null,
?string $domain = null,
?string $provider = null,
Expand All @@ -181,6 +184,7 @@ public function getSsoAuthorizationUrl(
?string $domainHint = null,
?string $loginHint = null,
): array {
$clientId ??= $this->client->requireClientId();
$pkce = self::generate();
$state ??= bin2hex(random_bytes(16));

Expand Down Expand Up @@ -219,14 +223,16 @@ public function getSsoAuthorizationUrl(
*
* @param string $code The authorization code.
* @param string $codeVerifier The PKCE code verifier.
* @param string $clientId The WorkOS client ID.
* @param string|null $clientId The WorkOS client ID. Defaults to the client's configured client ID.
* @return array The SSO token response.
*/
public function ssoCodeExchange(
string $code,
string $codeVerifier,
string $clientId,
?string $clientId = null,
): array {
$clientId ??= $this->client->requireClientId();

return $this->client->request(
method: 'POST',
path: 'sso/token',
Expand Down
46 changes: 46 additions & 0 deletions tests/PKCEHelperTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,41 @@ public function testGetAuthKitAuthorizationUrl(): void
$this->assertSame('S256', $query['code_challenge_method']);
}

public function testGetAuthKitAuthorizationUrlFallsBackToConfiguredClientId(): void
{
$client = $this->createMockClient([['status' => 200, 'body' => ['url' => 'https://auth.workos.com/...']]]);
$client->pkce()->getAuthKitAuthorizationUrl(
redirectUri: 'https://example.com/callback',
);
$query = [];
parse_str($this->getLastRequest()->getUri()->getQuery(), $query);
$this->assertSame('test_client_id', $query['client_id']);
}

public function testGetAuthKitAuthorizationUrlExplicitClientIdWins(): void
{
$client = $this->createMockClient([['status' => 200, 'body' => ['url' => 'https://auth.workos.com/...']]]);
$client->pkce()->getAuthKitAuthorizationUrl(
redirectUri: 'https://example.com/callback',
clientId: 'client_override',
);
$query = [];
parse_str($this->getLastRequest()->getUri()->getQuery(), $query);
$this->assertSame('client_override', $query['client_id']);
}

public function testGetAuthKitAuthorizationUrlThrowsWithoutAnyClientId(): void
{
$client = $this->createMockClient(
[['status' => 200, 'body' => []]],
clientId: null,
);
$this->expectException(\WorkOS\Exception\ConfigurationException::class);
$client->pkce()->getAuthKitAuthorizationUrl(
redirectUri: 'https://example.com/callback',
);
}

// -- H11: AuthKit PKCE code exchange --

public function testAuthKitCodeExchange(): void
Expand All @@ -105,6 +140,17 @@ public function testAuthKitCodeExchange(): void
$this->assertSame('verifier_123', $body['code_verifier']);
}

public function testAuthKitCodeExchangeFallsBackToConfiguredClientId(): void
{
$client = $this->createMockClient([['status' => 200, 'body' => ['access_token' => 'at_123']]]);
$client->pkce()->authKitCodeExchange(
code: 'auth_code_123',
codeVerifier: 'verifier_123',
);
$body = json_decode((string) $this->getLastRequest()->getBody(), true);
$this->assertSame('test_client_id', $body['client_id']);
}

// -- H15: SSO PKCE authorization URL --

public function testGetSsoAuthorizationUrl(): void
Expand Down
Loading