Skip to content

Filter claims by granted scopes for the IdToken case #3304

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
coheigea merged 1 commit into from
Jul 17, 2026
+124 −18
Merged

Filter claims by granted scopes for the IdToken case #3304

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
60 changes: 42 additions & 18 deletions .../security/sso/oidc/src/main/java/org/apache/cxf/rs/security/oidc/idp/UserInfoService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ public class UserInfoService extends OAuthServerJoseJwtProducer {
@Produces({"application/json", "application/jwt" })
public Response getUserInfo() {
OAuthContext oauth = OAuthContextUtils.getContext(mc);
List<String> scopes = OAuthUtils.convertPermissionsToScopeList(oauth.getPermissions());

// Check the access token has the "openid" scope
if (!oauth.getPermissions().stream()
Expand All @@ -64,12 +65,12 @@ public Response getUserInfo() {
UserInfo userInfo = null;
if (userInfoProvider != null) {
userInfo = userInfoProvider.getUserInfo(oauth.getClientId(), oauth.getSubject(),
OAuthUtils.convertPermissionsToScopeList(oauth.getPermissions()));
scopes);
} else if (oauth.getSubject() instanceof OidcUserSubject) {
OidcUserSubject oidcUserSubject = (OidcUserSubject)oauth.getSubject();
userInfo = oidcUserSubject.getUserInfo();
if (userInfo == null) {
userInfo = createFromIdToken(oidcUserSubject.getIdToken());
userInfo = createFromIdToken(oidcUserSubject.getIdToken(), scopes);
}
}
if (userInfo == null) {
Expand Down Expand Up @@ -98,35 +99,42 @@ protected Object convertUserInfoToResponseEntity(UserInfo userInfo) {
}

protected UserInfo createFromIdToken(IdToken idToken) {
return createFromIdToken(idToken, Collections.emptyList());
}

protected UserInfo createFromIdToken(IdToken idToken, List<String> scopes) {
UserInfo userInfo = new UserInfo();
userInfo.setSubject(idToken.getSubject());

if (super.isJwsRequired()) {
userInfo.setIssuer(idToken.getIssuer());
userInfo.setAudience(idToken.getAudience());
}
if (idToken.getPreferredUserName() != null) {
userInfo.setPreferredUserName(idToken.getPreferredUserName());
}
if (idToken.getName() != null) {
userInfo.setName(idToken.getName());
}
if (idToken.getGivenName() != null) {
userInfo.setGivenName(idToken.getGivenName());
}
if (idToken.getFamilyName() != null) {
userInfo.setFamilyName(idToken.getFamilyName());
if (scopes.contains(OidcUtils.PROFILE_SCOPE)) {
if (idToken.getPreferredUserName() != null) {
userInfo.setPreferredUserName(idToken.getPreferredUserName());
}
if (idToken.getName() != null) {
userInfo.setName(idToken.getName());
}
if (idToken.getGivenName() != null) {
userInfo.setGivenName(idToken.getGivenName());
}
if (idToken.getFamilyName() != null) {
userInfo.setFamilyName(idToken.getFamilyName());
}
if (idToken.getNickName() != null) {
userInfo.setNickName(idToken.getNickName());
}
}
if (idToken.getEmail() != null) {
if (scopes.contains(OidcUtils.EMAIL_SCOPE) && idToken.getEmail() != null) {
userInfo.setEmail(idToken.getEmail());
}
if (idToken.getNickName() != null) {
userInfo.setNickName(idToken.getNickName());
}

if (additionalClaims != null && !additionalClaims.isEmpty()) {
for (String additionalClaim : additionalClaims) {
if (idToken.containsProperty(additionalClaim)) {
if (idToken.containsProperty(additionalClaim)
&& isClaimExposedByScope(additionalClaim, scopes)) {
userInfo.setClaim(additionalClaim, idToken.getClaim(additionalClaim));
}
}
Expand All @@ -136,6 +144,22 @@ protected UserInfo createFromIdToken(IdToken idToken) {
return userInfo;
}

private boolean isClaimExposedByScope(String claimName, List<String> scopes) {
if (OidcUtils.PROFILE_CLAIMS.contains(claimName)) {
return scopes.contains(OidcUtils.PROFILE_SCOPE);
}
if (OidcUtils.EMAIL_CLAIMS.contains(claimName)) {
return scopes.contains(OidcUtils.EMAIL_SCOPE);
}
if (OidcUtils.ADDRESS_CLAIMS.contains(claimName)) {
return scopes.contains(OidcUtils.ADDRESS_SCOPE);
}
if (OidcUtils.PHONE_CLAIMS.contains(claimName)) {
return scopes.contains(OidcUtils.PHONE_SCOPE);
}
return true;
Comment thread
coheigea marked this conversation as resolved.
}

public void setUserInfoProvider(UserInfoProvider userInfoProvider) {
this.userInfoProvider = userInfoProvider;
}
Expand Down
82 changes: 82 additions & 0 deletions ...urity/sso/oidc/src/test/java/org/apache/cxf/rs/security/oidc/idp/UserInfoServiceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.cxf.rs.security.oidc.idp;

import java.util.Arrays;
import java.util.Collections;

import org.apache.cxf.rs.security.oidc.common.IdToken;
import org.apache.cxf.rs.security.oidc.common.UserInfo;
import org.apache.cxf.rs.security.oidc.utils.OidcUtils;

import org.junit.Test;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;

public class UserInfoServiceTest {

@Test
public void testCreateFromIdTokenFiltersClaimsForOpenIdScope() {
UserInfoService service = new UserInfoService();
service.setAdditionalClaims(Collections.singletonList("email_verified"));

IdToken idToken = new IdToken();
idToken.setSubject("alice");
idToken.setName("Alice Example");
idToken.setEmail("alice@example.com");
idToken.setEmailVerified(true);
idToken.setGivenName("Alice");
idToken.setFamilyName("Example");

UserInfo userInfo = service.createFromIdToken(idToken, Collections.singletonList(OidcUtils.OPENID_SCOPE));

assertEquals("alice", userInfo.getSubject());
assertNull(userInfo.getName());
assertNull(userInfo.getEmail());
assertNull(userInfo.getGivenName());
assertNull(userInfo.getFamilyName());
assertNull(userInfo.getEmailVerified());
assertNull(userInfo.getPhoneNumber());
}

@Test
public void testCreateFromIdTokenReturnsProfileAndEmailClaimsForGrantedScopes() {
UserInfoService service = new UserInfoService();
service.setAdditionalClaims(Collections.singletonList("email_verified"));

IdToken idToken = new IdToken();
idToken.setSubject("alice");
idToken.setName("Alice Example");
idToken.setEmail("alice@example.com");
idToken.setEmailVerified(true);
idToken.setGivenName("Alice");
idToken.setFamilyName("Example");

UserInfo userInfo = service.createFromIdToken(idToken,
Arrays.asList(OidcUtils.OPENID_SCOPE, OidcUtils.PROFILE_SCOPE, OidcUtils.EMAIL_SCOPE));

assertEquals("alice", userInfo.getSubject());
assertEquals("Alice Example", userInfo.getName());
assertEquals("alice@example.com", userInfo.getEmail());
assertEquals("Alice", userInfo.getGivenName());
assertEquals("Example", userInfo.getFamilyName());
assertEquals(Boolean.TRUE, userInfo.getEmailVerified());
}
}
Loading