Skip to content
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

[OB3] Fix FAPI 1 advance sub claim inconsistent issue #131

Merged
merged 2 commits into from
Oct 16, 2024
Merged

[OB3] Fix FAPI 1 advance sub claim inconsistent issue #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c223edd
Fix sub claim inconsistent issue for auth flow and token flow.
hasithakn Oct 8, 2024
0f16d4e
Merge branch '3.0.0' into fapi_advance_sub_claim_fix
hasithakn Oct 16, 2024
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
59 changes: 59 additions & 0 deletions .../com/wso2/openbanking/accelerator/identity/claims/OBDefaultOIDCClaimsCallbackHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.wso2.carbon.identity.oauth2.IdentityOAuth2Exception;
import org.wso2.carbon.identity.oauth2.authz.OAuthAuthzReqMessageContext;
import org.wso2.carbon.identity.oauth2.model.HttpRequestHeader;
import org.wso2.carbon.identity.oauth2.token.OAuthTokenReqMessageContext;
import org.wso2.carbon.identity.openidconnect.DefaultOIDCClaimsCallbackHandler;
Expand Down Expand Up @@ -91,6 +92,64 @@ public JWTClaimsSet handleCustomClaims(JWTClaimsSet.Builder jwtClaimsSetBuilder,
return super.handleCustomClaims(jwtClaimsSetBuilder, tokenReqMessageContext);
}

@Override
public JWTClaimsSet handleCustomClaims(JWTClaimsSet.Builder jwtClaimsSet, OAuthAuthzReqMessageContext
authzReqMessageContext) throws IdentityOAuth2Exception {
try {
if (IdentityCommonUtil.getRegulatoryFromSPMetaData(
authzReqMessageContext.getAuthorizationReqDTO().getConsumerKey())) {
Map<String, Object> claims = new HashMap<>();
JWTClaimsSet claimsSet = getJwtClaimsFromSuperClass(jwtClaimsSet, authzReqMessageContext);
if (claimsSet != null) {
for (Map.Entry<String, Object> claimEntry : claimsSet.getClaims().entrySet()) {
claims.put(claimEntry.getKey(), claimEntry.getValue());
}
}
updateSubClaim(authzReqMessageContext, claims);
for (Map.Entry<String, Object> claimEntry : claims.entrySet()) {
jwtClaimsSet.claim(claimEntry.getKey(), claimEntry.getValue());
}
return jwtClaimsSet.build();
}
} catch (OpenBankingException e) {
throw new IdentityOAuth2Exception(e.getMessage(), e);
}
return getJwtClaimsFromSuperClass(jwtClaimsSet, authzReqMessageContext);
}

/**
* Update the subject claim of the JWT claims set base on below configurations.
* 1. open_banking.identity.token.remove_tenant_domain_from_subject
* 2. open_banking.identity.token.remove_user_store_domain_from_subject
*
* @param authzReqMessageContext token request message context
* @param claims user claims in OIDC dialect as a map
*/
private void updateSubClaim(OAuthAuthzReqMessageContext authzReqMessageContext, Map<String, Object> claims) {

Object removeTenantDomainConfig =
identityConfigurations.get(IdentityCommonConstants.REMOVE_TENANT_DOMAIN_FROM_SUBJECT);
boolean removeTenantDomain = removeTenantDomainConfig != null
&& Boolean.parseBoolean(removeTenantDomainConfig.toString());

Object removeUserStoreDomainConfig =
identityConfigurations.get(IdentityCommonConstants.REMOVE_USER_STORE_DOMAIN_FROM_SUBJECT);
boolean removeUserStoreDomain = removeUserStoreDomainConfig != null
&& Boolean.parseBoolean(removeUserStoreDomainConfig.toString());

String subClaim = authzReqMessageContext.getAuthorizationReqDTO().getUser()
.getUsernameAsSubjectIdentifier(removeUserStoreDomain, removeTenantDomain);
claims.put("sub", subClaim);
}

@Generated(message = "Excluding from code coverage since it makes is used to return claims from the super class")
public JWTClaimsSet getJwtClaimsFromSuperClass(JWTClaimsSet.Builder jwtClaimsSetBuilder,
OAuthAuthzReqMessageContext oAuthAuthzReqMessageContext)
throws IdentityOAuth2Exception {

return super.handleCustomClaims(jwtClaimsSetBuilder, oAuthAuthzReqMessageContext);
}

@Generated(message = "Excluding from code coverage since it makes is used to return claims from the super class")
public JWTClaimsSet getJwtClaimsFromSuperClass(JWTClaimsSet.Builder jwtClaimsSetBuilder,
OAuthTokenReqMessageContext tokenReqMessageContext)
Expand Down
22 changes: 21 additions & 1 deletion .../wso2/openbanking/accelerator/identity/claims/OBDefaultOIDCClaimsCallbackHandlerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@
import org.wso2.carbon.identity.application.authentication.framework.model.AuthenticatedUser;
import org.wso2.carbon.identity.application.authentication.framework.util.FrameworkUtils;
import org.wso2.carbon.identity.oauth2.IdentityOAuth2Exception;
import org.wso2.carbon.identity.oauth2.authz.OAuthAuthzReqMessageContext;
import org.wso2.carbon.identity.oauth2.dto.OAuth2AccessTokenReqDTO;
import org.wso2.carbon.identity.oauth2.dto.OAuth2AuthorizeReqDTO;
import org.wso2.carbon.identity.oauth2.model.HttpRequestHeader;
import org.wso2.carbon.identity.oauth2.token.OAuthTokenReqMessageContext;

Expand All @@ -64,7 +66,7 @@ public class OBDefaultOIDCClaimsCallbackHandlerTest {
private OBDefaultOIDCClaimsCallbackHandler obDefaultOIDCClaimsCallbackHandler;

@BeforeClass
public void beforeClass() {
public void beforeClass() throws OpenBankingException {

Map<String, Object> configMap = new HashMap<>();
configMap.put(IdentityCommonConstants.CONSENT_ID_CLAIM_NAME, "consent_id");
Expand All @@ -74,6 +76,7 @@ public void beforeClass() {

mockStatic(FrameworkUtils.class);
mockStatic(IdentityCommonUtil.class);
PowerMockito.when(IdentityCommonUtil.getRegulatoryFromSPMetaData("123")).thenReturn(true);
when(FrameworkUtils.getMultiAttributeSeparator()).thenReturn(MULTI_ATTRIBUTE_SEPARATOR_DEFAULT);
obDefaultOIDCClaimsCallbackHandler = Mockito.spy(OBDefaultOIDCClaimsCallbackHandler.class);
}
Expand Down Expand Up @@ -142,5 +145,22 @@ public void testHandleCustomClaims() throws OpenBankingException, IdentityOAuth2
assertEquals("{x5t#S256=807-E8KgUMV6dRHTQi1_QYo5eyPvjmjbxCtunbFixV0}", jwtClaimsSet.getClaim(
"cnf").toString());
assertEquals("[email protected]", jwtClaimsSet.getClaim("sub"));

OAuth2AuthorizeReqDTO oAuth2AuthorizeReqDTO = new OAuth2AuthorizeReqDTO();
OAuthAuthzReqMessageContext oAuthAuthzReqMessageContext =
new OAuthAuthzReqMessageContext(oAuth2AuthorizeReqDTO);
oAuthAuthzReqMessageContext.setAuthorizationReqDTO(oAuth2AuthorizeReqDTO);

oAuth2AuthorizeReqDTO.setUser(authenticatedUser);

oAuth2AuthorizeReqDTO.setConsumerKey("123");
PowerMockito.when(jwtClaimsSetInitial.getClaims()).thenReturn(new SingletonMap("scope", "test"));
Mockito.doReturn(jwtClaimsSetInitial).when(obDefaultOIDCClaimsCallbackHandler)
.getJwtClaimsFromSuperClass(jwtClaimsSetBuilder, oAuthAuthzReqMessageContext);
JWTClaimsSet jwtClaimsSet2 = obDefaultOIDCClaimsCallbackHandler.handleCustomClaims(jwtClaimsSetBuilder,
oAuthAuthzReqMessageContext);

assertEquals("[email protected]@carbon.super", jwtClaimsSet2.getClaim("sub"));

}
}
Loading