Skip to content

Always use single value for standard claims #310

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
cicnavi merged 1 commit into from
Jun 10, 2025
Merged

Always use single value for standard claims #310

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
18 changes: 18 additions & 0 deletions UPGRADE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,22 @@

# Version 6 to 7

## New features

## New configuration options

## Major impact changes
- In v6 of the module, when defining custom scopes, there was a possibility to use standard claims with the
'are_multiple_claim_values_allowed' option. This would allow multiple values (array of values) for standard
claims which have a single value by specification. All
[standard claims](https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims)
are now hardcoded to have single value, even when 'are_multiple_claim_values_allowed' option is enabled.

## Medium impact changes

## Low impact changes


# Version 5 to 6

## New features
Expand Down
39 changes: 19 additions & 20 deletions src/Utils/ClaimTranslatorExtractor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,26 +130,25 @@ class ClaimTranslatorExtractor
*/
final public const MANDATORY_SINGLE_VALUE_CLAIMS = [
'sub',
// TODO mivanci v7 Uncomment the rest of the claims, as this was a potential breaking change in v6.
// 'name',
// 'given_name',
// 'family_name',
// 'middle_name',
// 'nickname',
// 'preferred_username',
// 'profile',
// 'picture',
// 'website',
// 'email',
// 'email_verified',
// 'gender',
// 'birthdate',
// 'zoneinfo',
// 'locale',
// 'phone_number',
// 'phone_number_verified',
// 'address',
// 'updated_at',
'name',
'given_name',
'family_name',
'middle_name',
'nickname',
'preferred_username',
'profile',
'picture',
'website',
'email',
'email_verified',
'gender',
'birthdate',
'zoneinfo',
'locale',
'phone_number',
'phone_number_verified',
'address',
'updated_at',
];

/**
Expand Down
129 changes: 117 additions & 12 deletions tests/unit/src/Utils/ClaimTranslatorExtractorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,33 +357,138 @@ public function testWillReleaseSingleValueClaimsIfMultiValueNotAllowed(): void

public function testWillReleaseSingleValueClaimsForMandatorySingleValueClaims(): void
{

// TODO mivanci v7 Test for mandatory single value claims in other scopes, as per
// \SimpleSAML\Module\oidc\Utils\ClaimTranslatorExtractor::MANDATORY_SINGLE_VALUE_CLAIMS
$claimSet = new ClaimSetEntity(
'customScopeWithSubClaim',
['sub'],
'customScope',
[
'sub',
'name',
'given_name',
'family_name',
'middle_name',
'nickname',
'preferred_username',
'profile',
'picture',
'website',
'email',
'email_verified',
'gender',
'birthdate',
'zoneinfo',
'locale',
'phone_number',
'phone_number_verified',
'address',
'updated_at',
],
);

$translate = [
'sub' => [
'subAttribute',
'sub' => ['subAttribute'],
'name' => ['nameAttribute'],
'given_name' => ['givenNameAttribute'],
'family_name' => ['familyNameAttribute'],
'middle_name' => ['middleNameAttribute'],
'nickname' => ['nicknameAttribute'],
'preferred_username' => ['preferredUsernameAttribute'],
'profile' => ['profileAttribute'],
'picture' => ['pictureAttribute'],
'website' => ['websiteAttribute'],
'email' => ['emailAttribute'],
'email_verified' => ['emailVerifiedAttribute'],
'gender' => ['genderAttribute'],
'birthdate' => ['birthdateAttribute'],
'zoneinfo' => ['zoneinfoAttribute'],
'locale' => ['localeAttribute'],
'phone_number' => ['phoneNumberAttribute'],
'phone_number_verified' => ['phoneNumberVerifiedAttribute'],
'address' => [
'type' => 'json',
'claims' => [
'formatted' => ['addressAttribute'],
],
],
'updated_at' => ['updatedAtAttribute'],
];

$userAttributes = [
'subAttribute' => ['1', '2', '3'],
'subAttribute' => ['id1', 'id2', 'id3'],
'nameAttribute' => ['name1', 'name2', 'name3'],
'givenNameAttribute' => ['givenName1', 'givenName2', 'givenName3'],
'familyNameAttribute' => ['familyName1', 'familyName2', 'familyName3'],
'middleNameAttribute' => ['middleName1', 'middleName2', 'middleName3'],
'nicknameAttribute' => ['nickname1', 'nickname2', 'nickname3'],
'preferredUsernameAttribute' => ['preferredUsername1', 'preferredUsername2', 'preferredUsername3'],
'profileAttribute' => ['profileUrl1', 'profileUrl2', 'profileUrl3'],
'pictureAttribute' => ['pictureUrl1', 'pictureUrl2', 'pictureUrl3'],
'websiteAttribute' => ['websiteUrl1', 'websiteUrl2', 'websiteUrl3'],
'emailAttribute' => ['email1', 'email2', 'email3'],
'emailVerifiedAttribute' => [true, false],
'genderAttribute' => ['gender1', 'gender2', 'gender3'],
'birthdateAttribute' => ['birthdate1', 'birthdate2', 'birthdate3'],
'zoneinfoAttribute' => ['zoneinfo1', 'zoneinfo2', 'zoneinfo3'],
'localeAttribute' => ['locale1', 'locale2', 'locale3'],
'phoneNumberAttribute' => ['phoneNumber1', 'phoneNumber2', 'phoneNumber3'],
'phoneNumberVerifiedAttribute' => [true, false],
'addressAttribute' => ['address1', 'address2', 'address3'],
'updatedAtAttribute' => [123, 456],
];

$claimTranslator = $this->mock([$claimSet], $translate, ['sub']);
$claimTranslator = $this->mock(
[$claimSet],
$translate,
[
'sub',
'name',
'given_name',
'family_name',
'middle_name',
'nickname',
'preferred_username',
'profile',
'picture',
'website',
'email',
'email_verified',
'gender',
'birthdate',
'zoneinfo',
'locale',
'phone_number',
'phone_number_verified',
'address',
'updated_at',
],
);

$releasedClaims = $claimTranslator->extract(
['openid'],
['customScope'],
$userAttributes,
);

$expectedClaims = ['sub' => '1'];
$expectedClaims = [
'sub' => 'id1',
'name' => 'name1',
'given_name' => 'givenName1',
'family_name' => 'familyName1',
'middle_name' => 'middleName1',
'nickname' => 'nickname1',
'preferred_username' => 'preferredUsername1',
'profile' => 'profileUrl1',
'picture' => 'pictureUrl1',
'website' => 'websiteUrl1',
'email' => 'email1',
'email_verified' => true,
'gender' => 'gender1',
'birthdate' => 'birthdate1',
'zoneinfo' => 'zoneinfo1',
'locale' => 'locale1',
'phone_number' => 'phoneNumber1',
'phone_number_verified' => true,
'address' => ['formatted' => 'address1'],
'updated_at' => 123,
];

$this->assertSame($expectedClaims, $releasedClaims);
$this->assertEquals($expectedClaims, $releasedClaims);
}
}