Skip to content

Check claim storage location before listing users. #4437

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
PasinduYeshan merged 3 commits into from
Dec 2, 2025
Merged

Check claim storage location before listing users. #4437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1d7fefd
Check claim storage location before listing users.
PasinduYeshan Nov 25, 2025
cfb909b
Honour StoreIdentityClaims property when listing users by single clai…
PasinduYeshan Nov 27, 2025
0269133
Skip throwing errors in recursive methods.
PasinduYeshan Nov 30, 2025
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
6 changes: 6 additions & 0 deletions ...o2.carbon.user.core/src/main/java/org/wso2/carbon/user/core/UserStoreConfigConstants.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,4 +214,10 @@ public class UserStoreConfigConstants {
"skip multi-valued attribute separation";
public static final String singleValuedAttributesDisplayName = "Single Valued Attributes";

// Property to force all claims to be stored in user store regardless of other configurations.
public static final String STORE_IDENTITY_CLAIMS = "StoreIdentityClaims";
public static final String STORE_IDENTITY_CLAIMS_DISPLAY_NAME = "Store Identity Claims";
public static final String STORE_IDENTITY_CLAIMS_DESCRIPTION = "When enabled, all identity and user claims will " +
"be stored in the user store manager regardless of other claim configurations";

}
168 changes: 156 additions & 12 deletions ...on.user.core/src/main/java/org/wso2/carbon/user/core/common/AbstractUserStoreManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3172,6 +3172,22 @@ private List<String> doGetUserList(String claim, String claimValue, String profi
"matches");
}

try {
if (isIdentityStoreManagedClaim(claimManager.getClaim(claim), extractedDomain, userManager)) {
if (log.isDebugEnabled()) {
log.debug("The claim: " + claim + " is an identity store managed claim for the domain: "
+ extractedDomain + ". Hence returning empty user list.");
}
return Collections.emptyList();
}
} catch (org.wso2.carbon.user.api.UserStoreException e) {
handleGetUserListFailure(ErrorMessages.ERROR_CODE_ERROR_DURING_PRE_GET_USER_LIST.getCode(),
String.format(ErrorMessages.ERROR_CODE_ERROR_DURING_PRE_GET_USER_LIST.getMessage(),
e.getMessage()), claim, claimValue, profileName);
throw new UserStoreException(
"Error occurred while retrieving claim for claim URI: " + claim, e);
}

try {
property = claimManager.getAttributeName(extractedDomain, claim);
} catch (org.wso2.carbon.user.api.UserStoreException e) {
Expand Down Expand Up @@ -3250,6 +3266,20 @@ private List<String> doGetUserList(String claim, String claimValue, String profi

// For all the user stores append the domain name to the claim and pass it recursively (Including PRIMARY).
String domainName = ((AbstractUserStoreManager) userStoreManager).getMyDomainName();

try {
if (isIdentityStoreManagedClaim(claimManager.getClaim(claim), domainName, userStoreManager)) {
if (log.isDebugEnabled()) {
log.debug("The claim: " + claim + " is an identity store managed claim for the domain: "
+ domainName + ". Hence skipping the user store.");
}
continue;
}
} catch (org.wso2.carbon.user.api.UserStoreException e) {
log.error(String.format("Error occurred while retrieving claim for claim URI: %s for domain: %s.",
claim, domainName), e);
}

String claimValueWithDomain;
if (StringUtils.equalsIgnoreCase(domainName, UserCoreConstants.PRIMARY_DEFAULT_DOMAIN_NAME)) {
claimValueWithDomain = domainName + CarbonConstants.DOMAIN_SEPARATOR + claimValue;
Expand Down Expand Up @@ -3416,6 +3446,22 @@ private List<User> doGetUserListWithID(String claim, String claimValue, String p
+ "matches");
}

try {
if (isIdentityStoreManagedClaim(claimManager.getClaim(claim), extractedDomain, userManager)) {
if (log.isDebugEnabled()) {
log.debug("The claim: " + claim + " is an identity store managed claim for the domain: "
+ extractedDomain + ". Hence returning empty user list.");
}
return Collections.emptyList();
}
} catch (org.wso2.carbon.user.api.UserStoreException e) {
handleGetUserListFailureWithID(ErrorMessages.ERROR_CODE_ERROR_DURING_PRE_GET_USER_LIST.getCode(),
String.format(ErrorMessages.ERROR_CODE_ERROR_DURING_PRE_GET_USER_LIST.getMessage(),
e.getMessage()), claim, claimValue, profileName);
throw new UserStoreException(
"Error occurred while retrieving claim for claim URI: " + claim, e);
}

try {
property = claimManager.getAttributeName(extractedDomain, claim);
} catch (org.wso2.carbon.user.api.UserStoreException e) {
Expand Down Expand Up @@ -3496,6 +3542,20 @@ private List<User> doGetUserListWithID(String claim, String claimValue, String p

// For all the user stores append the domain name to the claim and pass it recursively (Including PRIMARY).
String domainName = ((AbstractUserStoreManager) userStoreManager).getMyDomainName();

try {
if (isIdentityStoreManagedClaim(claimManager.getClaim(claim), domainName, userStoreManager)) {
if (log.isDebugEnabled()) {
log.debug("The claim: " + claim + " is an identity store managed claim for the domain: "
+ domainName + ". Hence skipping the user store.");
}
continue;
}
} catch (org.wso2.carbon.user.api.UserStoreException e) {
log.error(String.format("Error occurred while retrieving claim for claim URI: %s for domain: %s.",
claim, domainName), e);
}

String claimValueWithDomain;
if (StringUtils.equalsIgnoreCase(domainName, UserCoreConstants.PRIMARY_DEFAULT_DOMAIN_NAME)) {
claimValueWithDomain = domainName + CarbonConstants.DOMAIN_SEPARATOR + claimValue;
Expand Down Expand Up @@ -3547,6 +3607,22 @@ private List<String> doGetUserList(String claim, String claimValue, String profi
"matches");
}

try {
if (isIdentityStoreManagedClaim(claimManager.getClaim(claim), extractedDomain, userManager)) {
if (log.isDebugEnabled()) {
log.debug("The claim: " + claim + " is an identity store managed claim for the domain: "
+ extractedDomain + ". Hence returning empty user list.");
}
return Collections.emptyList();
}
} catch (org.wso2.carbon.user.api.UserStoreException e) {
handleGetUserListFailure(ErrorMessages.ERROR_CODE_ERROR_DURING_PRE_GET_USER_LIST.getCode(),
String.format(ErrorMessages.ERROR_CODE_ERROR_DURING_PRE_GET_USER_LIST.getMessage(),
e.getMessage()), claim, claimValue, limit, offset, profileName);
throw new UserStoreException(
"Error occurred while retrieving claim for claim URI: " + claim, e);
}

try {
property = claimManager.getAttributeName(extractedDomain, claim);
} catch (org.wso2.carbon.user.api.UserStoreException e) {
Expand Down Expand Up @@ -3617,6 +3693,22 @@ private List<String> doGetUserList(String claim, String claimValue, String profi
// For all the user stores append the domain name to the claim and pass it recursively (Including PRIMARY).
String domainName = ((AbstractUserStoreManager) userStoreManager).getMyDomainName();

try {
if (isIdentityStoreManagedClaim(claimManager.getClaim(claim), domainName, userStoreManager)) {
if (log.isDebugEnabled()) {
log.debug("The claim: " + claim + " is an identity store managed claim for the domain: "
+ domainName + ". Hence skipping the user store.");
}
continue;
}
} catch (org.wso2.carbon.user.api.UserStoreException e) {
handleGetUserListFailure(ErrorMessages.ERROR_CODE_ERROR_DURING_PRE_GET_USER_LIST.getCode(),
String.format(ErrorMessages.ERROR_CODE_ERROR_DURING_PRE_GET_USER_LIST.getMessage(),
e.getMessage()), claim, claimValue, limit, offset, profileName);
throw new UserStoreException(
"Error occurred while retrieving claim for claim URI: " + claim, e);
}

try {
property = claimManager.getAttributeName(domainName, claim);
} catch (org.wso2.carbon.user.api.UserStoreException e) {
Expand Down Expand Up @@ -17367,7 +17459,7 @@ private void mapAttributesToLocalIdentityClaims(List<ExpressionCondition> expres
}

// Check if the claim is an identity store managed claim and map the attribute name to claim URI.
if (isIdentityStoreManagedClaim(mappedClaim, userStoreDomain)) {
if (isIdentityStoreManagedClaim(mappedClaim.getClaim(), userStoreDomain, null)) {
expressionCondition.setAttributeName(mappedClaim.getClaim().getClaimUri());
if (log.isDebugEnabled()) {
log.debug("Obtained the ClaimURI " + mappedClaim.getClaim().getClaimUri() +
Expand All @@ -17382,37 +17474,57 @@ private void mapAttributesToLocalIdentityClaims(List<ExpressionCondition> expres
* Note: This only checks the `managedInUserStore` property of the claim and `excludedUserStores` property only.
* This doesn't check if the identity store is a user-store based or if the given user store is configured
* to store identity claims.
* @param mappedClaim
* @return
* @param localClaim Claim to be checked.
* @param userStoreDomain User store domain.
* @param userStoreManager User store manager to check the configuration. If null, uses the current user store manager.
* @return True if the claim is an identity store managed claim, false otherwise.
*/
private boolean isIdentityStoreManagedClaim(org.wso2.carbon.user.api.ClaimMapping mappedClaim,
String userStoreDomain) {
private boolean isIdentityStoreManagedClaim(org.wso2.carbon.user.api.Claim localClaim, String userStoreDomain,
UserStoreManager userStoreManager) {

RealmConfiguration realmConfigToCheck = realmConfig;
if (userStoreManager instanceof AbstractUserStoreManager) {
realmConfigToCheck = ((AbstractUserStoreManager) userStoreManager).getRealmConfiguration();
}

if (mappedClaim == null) {
// If StoreIdentityClaims property is enabled, all claims should be stored in user store.
// This overrides all other claim configurations.
if (Boolean.parseBoolean(
realmConfigToCheck.getUserStoreProperty(UserStoreConfigConstants.STORE_IDENTITY_CLAIMS))) {
if (log.isDebugEnabled()) {
log.debug("StoreIdentityClaims property is enabled for domain: " + userStoreDomain +
". All claims will be stored in user store.");
}
return false;
}

if (localClaim == null) {
return false;
}

Boolean managedInUserStoreValue = mappedClaim.getClaim().isManagedInUserStore();
Boolean managedInUserStoreValue = localClaim.isManagedInUserStore();
if (managedInUserStoreValue == null) {
if (log.isDebugEnabled()) {
log.debug("ManagedInUserStore property is not set for the claim: " +
mappedClaim.getClaim().getClaimUri() + ". Hence defaulting to claim type storage.");
localClaim.getClaimUri() + ". Hence defaulting to claim type storage.");
}
return mappedClaim.getClaim().getClaimUri().contains(IDENTITY_CLAIM_URI);
return localClaim.getClaimUri().contains(IDENTITY_CLAIM_URI);
}
if (!managedInUserStoreValue) {
if (log.isDebugEnabled()) {
log.debug("Claim: " + mappedClaim.getClaim().getClaimUri() +
log.debug("Claim: " + localClaim.getClaimUri() +
" is an identity store managed claim as per the ManagedInUserStore property.");
}
return true;
}

Set<String> excludedUserStores = mappedClaim.getClaim().getExcludedUserStores();
Set<String> excludedUserStores = localClaim.getExcludedUserStores();
if (CollectionUtils.isEmpty(excludedUserStores)) {
return false;
}
return excludedUserStores.contains(userStoreDomain);

return excludedUserStores.stream()
.anyMatch(excludedDomain -> excludedDomain.equalsIgnoreCase(userStoreDomain));
}

/**
Expand Down Expand Up @@ -17474,6 +17586,22 @@ private List<User> doGetUserListWithID(String claim, String claimValue, String p
+ "matches");
}

try {
if (isIdentityStoreManagedClaim(claimManager.getClaim(claim), extractedDomain, userManager)) {
if (log.isDebugEnabled()) {
log.debug("The claim: " + claim + " is an identity store managed claim for the domain: "
+ extractedDomain + ". Hence returning empty user list.");
}
return Collections.emptyList();
}
} catch (org.wso2.carbon.user.api.UserStoreException e) {
handleGetUserListFailure(ErrorMessages.ERROR_CODE_ERROR_DURING_PRE_GET_USER_LIST.getCode(),
String.format(ErrorMessages.ERROR_CODE_ERROR_DURING_PRE_GET_USER_LIST.getMessage(),
e.getMessage()), claim, claimValue, limit, offset, profileName);
throw new UserStoreException(
"Error occurred while retrieving claim for claim URI: " + claim, e);
}

try {
property = claimManager.getAttributeName(extractedDomain, claim);
} catch (org.wso2.carbon.user.api.UserStoreException e) {
Expand Down Expand Up @@ -17543,6 +17671,22 @@ private List<User> doGetUserListWithID(String claim, String claimValue, String p
// For all the user stores append the domain name to the claim and pass it recursively (Including PRIMARY).
String domainName = ((AbstractUserStoreManager) userStoreManager).getMyDomainName();

try {
if (isIdentityStoreManagedClaim(claimManager.getClaim(claim), domainName, userStoreManager)) {
if (log.isDebugEnabled()) {
log.debug("The claim: " + claim + " is an identity store managed claim for the domain: "
+ domainName + ". Hence skipping the user store.");
}
continue;
}
} catch (org.wso2.carbon.user.api.UserStoreException e) {
handleGetUserListFailure(ErrorMessages.ERROR_CODE_ERROR_DURING_PRE_GET_USER_LIST.getCode(),
String.format(ErrorMessages.ERROR_CODE_ERROR_DURING_PRE_GET_USER_LIST.getMessage(),
e.getMessage()), claim, claimValue, limit, offset, profileName);
throw new UserStoreException(
"Error occurred while retrieving claim for claim URI: " + claim, e);
}

try {
property = claimManager.getAttributeName(domainName, claim);
} catch (org.wso2.carbon.user.api.UserStoreException e) {
Expand Down