Skip to content

NOW MANAGED ON CODEBERG

OIDC Userinfo: Started writing tests to cover userinfo calling

Dan Brownfa543bbd4d4a
diff --git a/app/Access/Oidc/OidcProviderSettings.php b/app/Access/Oidc/OidcProviderSettings.php
index 616bf1012..71c3b5734 100644
--- a/app/Access/Oidc/OidcProviderSettings.php
+++ b/app/Access/Oidc/OidcProviderSettings.php
@@ -53,7 +53,7 @@ class OidcProviderSettings
*/
protected function validateInitial(): void
{
- $required = ['clientId', 'clientSecret', 'redirectUri', 'issuer'];
+ $required = ['clientId', 'clientSecret', 'issuer'];
foreach ($required as $prop) {
if (empty($this->$prop)) {
throw new InvalidArgumentException("Missing required configuration \"{$prop}\" value");
diff --git a/app/Access/Oidc/OidcService.php b/app/Access/Oidc/OidcService.php
index fba6dc9a8..6d024ae32 100644
--- a/app/Access/Oidc/OidcService.php
+++ b/app/Access/Oidc/OidcService.php
@@ -201,6 +201,9 @@ class OidcService
if (empty($userDetails->email)) {
throw new OidcException(trans('errors.oidc_no_email_address'));
}
+ if (empty($userDetails->name)) {
+ $userDetails->name = $userDetails->externalId;
+ }
$isLoggedIn = auth()->check();
if ($isLoggedIn) {
diff --git a/app/Access/Oidc/OidcUserDetails.php b/app/Access/Oidc/OidcUserDetails.php
index 172bc9ceb..bccc49ee4 100644
--- a/app/Access/Oidc/OidcUserDetails.php
+++ b/app/Access/Oidc/OidcUserDetails.php
@@ -28,7 +28,7 @@ class OidcUserDetails
}
/**
- * Populate user details from OidcIdToken data.
+ * Populate user details from the given claim data.
*/
public function populate(
ProvidesClaims $claims,
@@ -38,11 +38,11 @@ class OidcUserDetails
): void {
$this->externalId = $claims->getClaim($idClaim) ?? $this->externalId;
$this->email = $claims->getClaim('email') ?? $this->email;
- $this->name = static::getUserDisplayName($displayNameClaims, $claims, $this->externalId) ?? $this->name;
+ $this->name = static::getUserDisplayName($displayNameClaims, $claims) ?? $this->name;
$this->groups = static::getUserGroups($groupsClaim, $claims) ?? $this->groups;
}
- protected static function getUserDisplayName(string $displayNameClaims, ProvidesClaims $token, string $defaultValue): string
+ protected static function getUserDisplayName(string $displayNameClaims, ProvidesClaims $token): string
{
$displayNameClaimParts = explode('|', $displayNameClaims);
@@ -54,10 +54,6 @@ class OidcUserDetails
}
}
- if (count($displayName) === 0) {
- $displayName[] = $defaultValue;
- }
-
return implode(' ', $displayName);
}
diff --git a/tests/Auth/OidcTest.php b/tests/Auth/OidcTest.php
index 661722983..9ed3fa7b9 100644
--- a/tests/Auth/OidcTest.php
+++ b/tests/Auth/OidcTest.php
@@ -37,6 +37,7 @@ class OidcTest extends TestCase
'oidc.issuer' => OidcJwtHelper::defaultIssuer(),
'oidc.authorization_endpoint' => 'https://oidc.local/auth',
'oidc.token_endpoint' => 'https://oidc.local/token',
+ 'oidc.userinfo_endpoint' => 'https://oidc.local/userinfo',
'oidc.discover' => false,
'oidc.dump_user_details' => false,
'oidc.additional_scopes' => '',
@@ -208,6 +209,8 @@ class OidcTest extends TestCase
public function test_auth_fails_if_no_email_exists_in_user_data()
{
+ config()->set('oidc.userinfo_endpoint', null);
+
$this->runLogin([
'email' => '',
'sub' => 'benny505',
@@ -270,10 +273,38 @@ class OidcTest extends TestCase
]);
$resp = $this->followRedirects($resp);
- $resp->assertSeeText('ID token validate failed with error: Missing token subject value');
+ $resp->assertSeeText('ID token validation failed with error: Missing token subject value');
$this->assertFalse(auth()->check());
}
+ public function test_auth_fails_if_endpoints_start_with_https()
+ {
+ $endpointConfigKeys = [
+ 'oidc.token_endpoint' => 'tokenEndpoint',
+ 'oidc.authorization_endpoint' => 'authorizationEndpoint',
+ 'oidc.userinfo_endpoint' => 'userinfoEndpoint',
+ ];
+
+ foreach ($endpointConfigKeys as $endpointConfigKey => $endpointName) {
+ $logger = $this->withTestLogger();
+ $original = config()->get($endpointConfigKey);
+ $new = str_replace('https://', 'http://', $original);
+ config()->set($endpointConfigKey, $new);
+
+ $this->withoutExceptionHandling();
+ $err = null;
+ try {
+ $resp = $this->runLogin();
+ $resp->assertRedirect('/login');
+ } catch (\Exception $exception) {
+ $err = $exception;
+ }
+ $this->assertEquals("Endpoint value for \"{$endpointName}\" must start with https://", $err->getMessage());
+
+ config()->set($endpointConfigKey, $original);
+ }
+ }
+
public function test_auth_login_with_autodiscovery()
{
$this->withAutodiscovery();
@@ -689,57 +720,92 @@ class OidcTest extends TestCase
$this->assertEquals($pkceCode, $bodyParams['code_verifier']);
}
- protected function withAutodiscovery()
+ public function test_userinfo_endpoint_used_if_missing_claims_in_id_token()
+ {
+ config()->set('oidc.display_name_claims', 'first_name|last_name');
+ $this->post('/oidc/login');
+ $state = session()->get('oidc_state');
+
+ $client = $this->mockHttpClient([
+ $this->getMockAuthorizationResponse(['name' => null]),
+ new Response(200, [
+ 'Content-Type' => 'application/json',
+ ], json_encode([
+ 'sub' => OidcJwtHelper::defaultPayload()['sub'],
+ 'first_name' => 'Barry',
+ 'last_name' => 'Userinfo',
+ ]))
+ ]);
+
+ $resp = $this->get('/oidc/callback?code=SplxlOBeZQQYbYS6WxSbIA&state=' . $state);
+ $resp->assertRedirect('/');
+ $this->assertEquals(2, $client->requestCount());
+
+ $userinfoRequest = $client->requestAt(1);
+ $this->assertEquals('GET', $userinfoRequest->getMethod());
+ $this->assertEquals('https://oidc.local/userinfo', (string) $userinfoRequest->getUri());
+
+ $this->assertEquals('Barry Userinfo', user()->name);
+ }
+
+ public function test_userinfo_endpoint_fetch_with_different_sub_throws_error()
+ {
+ $userinfoResponseData = ['sub' => 'dcba4321'];
+ $userinfoResponse = new Response(200, ['Content-Type' => 'application/json'], json_encode($userinfoResponseData));
+ $resp = $this->runLogin(['name' => null], [$userinfoResponse]);
+ $resp->assertRedirect('/login');
+ $this->assertSessionError('Userinfo endpoint response validation failed with error: Subject value provided in the userinfo endpoint does not match the provided ID token value');
+ }
+
+ public function test_userinfo_endpoint_fetch_returning_no_sub_throws_error()
+ {
+ $userinfoResponseData = ['name' => 'testing'];
+ $userinfoResponse = new Response(200, ['Content-Type' => 'application/json'], json_encode($userinfoResponseData));
+ $resp = $this->runLogin(['name' => null], [$userinfoResponse]);
+ $resp->assertRedirect('/login');
+ $this->assertSessionError('Userinfo endpoint response validation failed with error: No valid subject value found in userinfo data');
+ }
+
+ public function test_userinfo_endpoint_fetch_can_parsed_nested_groups()
+ {
+ config()->set([
+ 'oidc.user_to_groups' => true,
+ 'oidc.groups_claim' => 'my.nested.groups.attr',
+ 'oidc.remove_from_groups' => false,
+ ]);
+
+ $roleA = Role::factory()->create(['display_name' => 'Ducks']);
+ $userinfoResponseData = [
+ 'sub' => OidcJwtHelper::defaultPayload()['sub'],
+ 'my' => ['nested' => ['groups' => ['attr' => ['Ducks', 'Donkeys']]]]
+ ];
+ $userinfoResponse = new Response(200, ['Content-Type' => 'application/json'], json_encode($userinfoResponseData));
+ $resp = $this->runLogin(['groups' => null], [$userinfoResponse]);
+ $resp->assertRedirect('/');
+
+ $user = User::where('email', OidcJwtHelper::defaultPayload()['email'])->first();
+ $this->assertTrue($user->hasRole($roleA->id));
+ }
+
+ protected function withAutodiscovery(): void
{
config()->set([
'oidc.issuer' => OidcJwtHelper::defaultIssuer(),
'oidc.discover' => true,
'oidc.authorization_endpoint' => null,
'oidc.token_endpoint' => null,
+ 'oidc.userinfo_endpoint' => null,
'oidc.jwt_public_key' => null,
]);
}
- protected function runLogin($claimOverrides = []): TestResponse
+ protected function runLogin($claimOverrides = [], $additionalHttpResponses = []): TestResponse
{
- // These two variables should perhaps be arguments instead of
- // assuming that they're tied to whether discovery is enabled,
- // but that's how the tests are written for now.
- $claimsInIdToken = !config('oidc.discover');
- $tokenEndpoint = config('oidc.discover')
- ? OidcJwtHelper::defaultIssuer() . '/oidc/token'
- : 'https://oidc.local/token';
-
$this->post('/oidc/login');
$state = session()->get('oidc_state');
+ $this->mockHttpClient([$this->getMockAuthorizationResponse($claimOverrides), ...$additionalHttpResponses]);
- $providerResponses = [$this->getMockAuthorizationResponse($claimsInIdToken ? $claimOverrides : [])];
- if (!$claimsInIdToken) {
- $providerResponses[] = new Response(200, [
- 'Content-Type' => 'application/json',
- 'Cache-Control' => 'no-cache, no-store',
- 'Pragma' => 'no-cache',
- ], json_encode($claimOverrides));
- }
-
- $transactions = $this->mockHttpClient($providerResponses);
-
- $response = $this->get('/oidc/callback?code=SplxlOBeZQQYbYS6WxSbIA&state=' . $state);
-
- if (auth()->check()) {
- $this->assertEquals($claimsInIdToken ? 1 : 2, $transactions->requestCount());
- $tokenRequest = $transactions->requestAt(0);
- $this->assertEquals($tokenEndpoint, (string) $tokenRequest->getUri());
- $this->assertEquals('POST', $tokenRequest->getMethod());
- if (!$claimsInIdToken) {
- $userinfoRequest = $transactions->requestAt(1);
- $this->assertEquals(OidcJwtHelper::defaultIssuer() . '/oidc/userinfo', (string) $userinfoRequest->getUri());
- $this->assertEquals('GET', $userinfoRequest->getMethod());
- $this->assertEquals('Bearer abc123', $userinfoRequest->getHeader('Authorization')[0]);
- }
- }
-
- return $response;
+ return $this->get('/oidc/callback?code=SplxlOBeZQQYbYS6WxSbIA&state=' . $state);
}
protected function getAutoDiscoveryResponse($responseOverrides = []): Response