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

Resolve users according to userstore preference order if configured. #771

Merged
merged 3 commits into from
Oct 12, 2023
Merged

Resolve users according to userstore preference order if configured. #771

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dab73e1
Resolve users according to userstore preference order if configured.
mpmadhavig Oct 11, 2023
43c2ecb
Update generateUserStoreChain method variable naming.
mpmadhavig Oct 11, 2023
37a448d
Extract domain to get the domainAwareUsername.
mpmadhavig Oct 12, 2023
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
127 changes: 124 additions & 3 deletions ...ain/java/org/wso2/carbon/identity/multi/attribute/login/resolver/regex/RegexResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,20 @@
import org.wso2.carbon.user.api.ClaimManager;
import org.wso2.carbon.user.api.UserStoreException;
import org.wso2.carbon.user.core.UniqueIDUserStoreManager;
import org.wso2.carbon.user.core.UserCoreConstants;
import org.wso2.carbon.user.core.UserRealm;
import org.wso2.carbon.user.core.UserStoreManager;
import org.wso2.carbon.user.core.common.AbstractUserStoreManager;
import org.wso2.carbon.user.core.common.AuthenticationResult;
import org.wso2.carbon.user.core.common.IterativeUserStoreManager;
import org.wso2.carbon.user.core.common.User;
import org.wso2.carbon.user.core.config.UserStorePreferenceOrderSupplier;
import org.wso2.carbon.user.core.constants.UserCoreClaimConstants;
import org.wso2.carbon.user.core.model.UserMgtContext;
import org.wso2.carbon.user.core.util.UserCoreUtil;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
Expand Down Expand Up @@ -79,6 +87,7 @@ private void resolveDistinctUsersForClaims(String loginAttribute, List<String> a

Set<String> uniqueUserIds = new HashSet<>();
Map<String, List<User>> distinctUsers = new HashMap<>();
List<String> userStorePreferenceOrder = getUserStorePreferenceOrder();

// Resolve the user from the regex matching.
for (String claimURI : allowedAttributes) {
Expand All @@ -91,7 +100,8 @@ private void resolveDistinctUsersForClaims(String loginAttribute, List<String> a
String domainSeparateAttribute = UserCoreUtil.removeDomainFromName(loginAttribute);

if (pattern.matcher(domainSeparateAttribute).matches()) {
List<User> userList = userStoreManager.getUserListWithID(claimURI, loginAttribute, null);
List<User> userList = getUserList(claimURI, loginAttribute, userStorePreferenceOrder, userStoreManager);

if (userList.isEmpty()) {
continue;
}
Expand Down Expand Up @@ -132,8 +142,8 @@ private void resolveDistinctUsersForClaims(String loginAttribute, List<String> a
Claim usernameClaim = claimManager.getClaim(UserCoreClaimConstants.USERNAME_CLAIM_URI);
if (allowedAttributes.contains(UserCoreClaimConstants.USERNAME_CLAIM_URI)
&& StringUtils.isBlank(usernameClaim.getRegEx())) {
List<User> userList = userStoreManager.getUserListWithID(UserCoreClaimConstants.USERNAME_CLAIM_URI,
loginAttribute, null);
List<User> userList = getUserList(UserCoreClaimConstants.USERNAME_CLAIM_URI, loginAttribute,
userStorePreferenceOrder, userStoreManager);
if (!userList.isEmpty()) {
List<User> allowedDistinctUsersForClaim = userList.stream()
.filter(user -> uniqueUserIds.add(user.getUserID()))
Expand All @@ -158,6 +168,117 @@ private void resolveDistinctUsersForClaims(String loginAttribute, List<String> a
}
}

/**
* This method is used to get the user list according to the user store preference order if configured.
* If the login attribute contains a domain name, resolve users from the corresponding user store.
*
* @param claimURI Claim URI.
* @param loginAttribute Login attribute.
* @param userStorePreferenceOrder User store preference order.
* @param userStoreManager User store manager.
* @return User list.
* @throws org.wso2.carbon.user.core.UserStoreException If an error occurred while getting the user list.
*/
private List<User> getUserList(String claimURI, String loginAttribute, List<String> userStorePreferenceOrder,
UniqueIDUserStoreManager userStoreManager)
throws org.wso2.carbon.user.core.UserStoreException {

if (!loginAttribute.contains(UserCoreConstants.DOMAIN_SEPARATOR) && userStorePreferenceOrder != null
&& !userStorePreferenceOrder.isEmpty()) {
IterativeUserStoreManager iterativeUserStoreManager = generateUserStoreChain(userStorePreferenceOrder,
(AbstractUserStoreManager) userStoreManager);
if (iterativeUserStoreManager != null) {
return getUserListAccordingToUserStorePreferenceOrder(claimURI, loginAttribute,
iterativeUserStoreManager);
}
}
return userStoreManager.getUserListWithID(claimURI, loginAttribute, null);
}

/**
* This method is used to get the user list according to the user store preference order.
*
* @param claimURI Claim URI.
* @param loginAttribute Login attribute.
* @param userStoreManager User store manager.
* @return User list.
* @throws org.wso2.carbon.user.core.UserStoreException If an error occurred while getting the user list.
*/
private List<User> getUserListAccordingToUserStorePreferenceOrder(String claimURI, String loginAttribute,
IterativeUserStoreManager userStoreManager)
throws org.wso2.carbon.user.core.UserStoreException {

List<org.wso2.carbon.user.core.common.User> userList = new ArrayList<>();
IterativeUserStoreManager currentUserStoreManager = userStoreManager;
while (currentUserStoreManager != null) {
userList.addAll(currentUserStoreManager.getAbstractUserStoreManager().getUserListWithID(claimURI,
loginAttribute, null));
currentUserStoreManager = currentUserStoreManager.nextUserStoreManager();
}

return userList;
}

/**
* This method is used to get the user store preference order.
*
* @return User store preference order.
* @throws org.wso2.carbon.user.core.UserStoreException If an error occurred while getting the user store
*/
private List<String> getUserStorePreferenceOrder() throws org.wso2.carbon.user.core.UserStoreException {

UserMgtContext userMgtContext = UserCoreUtil.getUserMgtContextFromThreadLocal();
if (userMgtContext != null) {
UserStorePreferenceOrderSupplier<List<String>>
userStorePreferenceSupplier = userMgtContext.getUserStorePreferenceOrderSupplier();
if (userStorePreferenceSupplier != null) {
List<String> userStorePreferenceOrder = userStorePreferenceSupplier.get();
if (userStorePreferenceOrder != null) {
return userStorePreferenceOrder;
}
}
}

return Collections.emptyList();
}

/**
* This method is used to generate a user store chain using the user store preference order.
*
* @param userStorePreferenceOrder User store preference order.
* @param abstractUserStoreManager Abstract user store manager.
* @return IterativeUserStoreManager.
* @throws org.wso2.carbon.user.core.UserStoreException If an error occurred while generating the user store chain.
*/
private IterativeUserStoreManager generateUserStoreChain(List<String> userStorePreferenceOrder,
AbstractUserStoreManager abstractUserStoreManager)
throws org.wso2.carbon.user.core.UserStoreException {

IterativeUserStoreManager initialUserStoreManager = null;
IterativeUserStoreManager currentUserStoreManager = null;
for (String domainName : userStorePreferenceOrder) {
UserStoreManager userStoreManager = abstractUserStoreManager.getSecondaryUserStoreManager(domainName);
// If the user store manager is instance of AbstractUserStoreManager then generate a user store chain using
// IterativeUserStoreManager.
if (userStoreManager instanceof AbstractUserStoreManager) {
if (initialUserStoreManager == null) {
currentUserStoreManager =
new IterativeUserStoreManager((AbstractUserStoreManager) userStoreManager);
initialUserStoreManager = currentUserStoreManager;
} else {
IterativeUserStoreManager nextUserStoreManager = new IterativeUserStoreManager(
(AbstractUserStoreManager) userStoreManager);
currentUserStoreManager.setNextUserStoreManager(nextUserStoreManager);
currentUserStoreManager = nextUserStoreManager;
}
} else {
return null;
}
}
// Authenticate using the initial user store from the user store preference list.
return initialUserStoreManager;
}

private void setResolvedUserResult(List<User> userList, String claimURI,
String loginAttribute, ResolvedUserResult resolvedUserResult, Claim claim)
throws org.wso2.carbon.user.core.UserStoreException {
Expand Down
Loading