Skip to content

Extended claims in JWT access token #653

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
H2CK merged 1 commit into from
May 29, 2026
Merged

Extended claims in JWT access token #653

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
114 changes: 106 additions & 8 deletions lib/Util/JwtGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,6 @@ public function generateIdToken(AccessToken $accessToken, Client $client, string
* @param Client $client
* @param string $issuerProtocol
* @param string $issuerHost
* @param bool $atHash
* @return string
* @throws PropertyDoesNotExistException
* @throws JwtCreationErrorException
Expand All @@ -342,6 +341,7 @@ public function generateAccessToken(AccessToken $accessToken, Client $client, st
$uid = $accessToken->getUserId();
$user = $this->userManager->get($uid);
$groups = $this->groupManager->getUserGroups($user);
$account = $this->accountManager->getAccount($user);
$aud = $accessToken->getResource();
if (!isset($aud) || trim($aud)==='') {
$aud = $client->getClientIdentifier();
Expand All @@ -356,31 +356,129 @@ public function generateAccessToken(AccessToken $accessToken, Client $client, st
'iat' => $this->time->getTime(),
'acr' => '0',
'client_id' => $client->getClientIdentifier(),
'azp' => $client->getClientIdentifier(),
'preferred_username' => $uid,
'scope' => $accessToken->getScope(),
'jti' => strval($accessToken->getId()),
];

$roles = [];
// Fetch roles
$rolesDisplayName = [];
foreach ($groups as $group) {
array_push($roles, $group->getGID());
$displayName = $group->getDisplayName();
if ($displayName !== null && $displayName !== '') {
array_push($rolesDisplayName, $displayName);
} else {
array_push($rolesDisplayName, $group->getGID());
}
}

$groupClaimType = $this->appConfig->getAppValueString(Application::APP_CONFIG_GROUP_CLAIM_TYPE, Application::GROUP_CLAIM_TYPE_GID);
$rolesClaimType = $this->appConfig->getAppValueString(Application::APP_CONFIG_ROLES_CLAIM_TYPE, 'null');
if ($rolesClaimType !== null && $rolesClaimType === 'null') {
$rolesClaimType = $groupClaimType;
}

// Check for scopes roles, groups and entitlements (not supported)
$scopeArray = preg_split('/ +/', $accessToken->getScope());
if (in_array("roles", $scopeArray)) {
$roles_payload = [
'roles' => $roles
];
if ($rolesClaimType === Application::GROUP_CLAIM_TYPE_DISPLAYNAME) {
$roles_payload = [
'roles' => $rolesDisplayName
];
} else {
$roles_payload = [
'roles' => $roles
];
}
$jwt_payload = array_merge($jwt_payload, $roles_payload);
}
if (in_array("groups", $scopeArray)) {
$roles_payload = [
'groups' => $roles
];
if ($groupClaimType === Application::GROUP_CLAIM_TYPE_DISPLAYNAME) {
$roles_payload = [
'groups' => $rolesDisplayName
];
} else {
$roles_payload = [
'groups' => $roles
];
}
$jwt_payload = array_merge($jwt_payload, $roles_payload);
}

$restrictUserInformationArr = explode(' ', strtolower(trim($this->appConfig->getAppValueString(Application::APP_CONFIG_RESTRICT_USER_INFORMATION, Application::DEFAULT_RESTRICT_USER_INFORMATION))));
$restrictUserInformationPersonalArr = [ Application::DEFAULT_ALLOW_USER_SETTINGS ];
if ($this->appConfig->getAppValueString(Application::APP_CONFIG_ALLOW_USER_SETTINGS, Application::DEFAULT_ALLOW_USER_SETTINGS) != Application::DEFAULT_ALLOW_USER_SETTINGS) {
$restrictUserInformationPersonalArr = explode(' ', strtolower(trim($this->config->getUserValue($uid, Application::APP_ID, Application::APP_CONFIG_RESTRICT_USER_INFORMATION, Application::DEFAULT_RESTRICT_USER_INFORMATION))));
}

if (in_array("profile", $scopeArray)) {
$profile = [
'updated_at' => $user->getLastLogin(),
];
if ($account->getProperty(\OCP\Accounts\IAccountManager::PROPERTY_DISPLAYNAME)->getValue() != '') {
$displayName = $account->getProperty(\OCP\Accounts\IAccountManager::PROPERTY_DISPLAYNAME)->getValue();
$names = $this->converter->splitFullName($displayName);
$profile = array_merge($profile, [
'name' => $displayName,
'family_name' => $names[0],
'given_name' => $names[1],
'middle_name' => $names[2]
]);
} else {
$profile = array_merge($profile, ['name' => $user->getDisplayName()]);
}
if ($account->getProperty(\OCP\Accounts\IAccountManager::PROPERTY_WEBSITE)->getValue() != '' && !in_array('website', $restrictUserInformationArr) && !in_array('website', $restrictUserInformationPersonalArr)) {
$profile = array_merge($profile,
['website' => $account->getProperty(\OCP\Accounts\IAccountManager::PROPERTY_WEBSITE)->getValue()]);
}
if ($account->getProperty(\OCP\Accounts\IAccountManager::PROPERTY_PHONE)->getValue() != '' && !in_array('phone', $restrictUserInformationArr) && !in_array('phone', $restrictUserInformationPersonalArr)) {
$profile = array_merge($profile,
['phone_number' => $account->getProperty(\OCP\Accounts\IAccountManager::PROPERTY_PHONE)->getValue()]);
}
if ($account->getProperty(\OCP\Accounts\IAccountManager::PROPERTY_ADDRESS)->getValue() != '' && !in_array('address', $restrictUserInformationArr) && !in_array('address', $restrictUserInformationPersonalArr)) {
$profile = array_merge($profile,
['address' =>
[ 'formatted' => $account->getProperty(\OCP\Accounts\IAccountManager::PROPERTY_ADDRESS)->getValue()]]);
}
if (!in_array('avatar', $restrictUserInformationArr) && !in_array('avatar', $restrictUserInformationPersonalArr)) {
$profile = array_merge($profile,
['picture' => $issuer . '/avatar/' . rawurlencode($uid) . '/64']);
}
$jwt_payload = array_merge($jwt_payload, $profile);
}

if (in_array("email", $scopeArray) && $user->getEMailAddress() !== null) {
$emailProperty = $account->getProperty(\OCP\Accounts\IAccountManager::PROPERTY_EMAIL);
$clientEmailRegex = $client->getEmailRegex();
if ($clientEmailRegex !== '') {
$this->logger->debug('Found regex for email: ' . $clientEmailRegex);
$emailCollection = $account->getPropertyCollection(\OCP\Accounts\IAccountManager::COLLECTION_EMAIL);
foreach ($emailCollection->getProperties() as $emailPropertyEntry) {
$this->logger->debug('Performing check for mail ' . $emailPropertyEntry->getValue());
if (preg_match('/'.$clientEmailRegex.'/', $emailPropertyEntry->getValue())) {
$this->logger->debug('Regex matches');
$emailProperty = $emailPropertyEntry;
}
}
}

$email = [
'email' => $emailProperty->getValue(),
];
if ($this->appConfig->getAppValueString(Application::APP_CONFIG_OVERWRITE_EMAIL_VERIFIED) == 'true') {
$email = array_merge($email, ['email_verified' => true]);
} else {
if ($emailProperty->getVerified() === \OCP\Accounts\IAccountManager::VERIFIED) {
$email = array_merge($email, ['email_verified' => true]);
} else {
$email = array_merge($email, ['email_verified' => false]);
}
}
$jwt_payload = array_merge($jwt_payload, $email);
}

$payload = json_encode($jwt_payload);
$base64UrlPayload = str_replace(['+', '/', '='], ['-', '_', ''], base64_encode($payload));

Expand Down
72 changes: 19 additions & 53 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading