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

Jump to bottom

Provide Group UUID support #127

Merged
merged 1 commit into from
Feb 14, 2024
Merged

Provide Group UUID support #127

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
166 changes: 137 additions & 29 deletions ...m.provider/src/main/java/org/wso2/carbon/identity/scim/provider/impl/SCIMUserManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
Expand All @@ -83,14 +84,15 @@ public class SCIMUserManager implements UserManager {
public static final String INTERNAL_DOMAIN = "Internal";
private static final Log log = LogFactory.getLog(SCIMUserManager.class);
private static final String USER_ID_CLAIM_URI = "http://wso2.org/claims/userid";
private UserStoreManager carbonUM = null;
private AbstractUserStoreManager carbonUM = null;
private ClaimManager carbonClaimManager = null;
private String consumerName;
private boolean isBulkUserAdd = false;

public SCIMUserManager(UserStoreManager carbonUserStoreManager, String userName,
ClaimManager claimManager) {
carbonUM = carbonUserStoreManager;

carbonUM = (AbstractUserStoreManager) carbonUserStoreManager;
consumerName = userName;
carbonClaimManager = claimManager;
}
Expand Down Expand Up @@ -747,11 +749,11 @@ public Group createGroup(Group group) throws CharonException, DuplicateResourceE
if (log.isDebugEnabled()) {
log.debug("Creating group: " + group.getDisplayName());
}
String domainName = "";
try {
//modify display name if no domain is specified, in order to support multiple user store feature
String originalName = group.getDisplayName();
String roleNameWithDomain = null;
String domainName = "";
try {
if (getUserStoreDomainFromSP() != null) {
domainName = getUserStoreDomainFromSP();
Expand Down Expand Up @@ -827,29 +829,38 @@ public Group createGroup(Group group) throws CharonException, DuplicateResourceE
}
}

//add other scim attributes in the identity DB since user store doesn't support some attributes.
SCIMGroupHandler scimGroupHandler =
new SCIMGroupHandler(
carbonUM.getTenantId());
scimGroupHandler.createSCIMAttributes(group);
if (!isUniqueGroupIdEnabled(domainName)) {
// Add other scim attributes in the identity DB since user store doesn't support some attributes.
SCIMGroupHandler scimGroupHandler = new SCIMGroupHandler(carbonUM.getTenantId());
scimGroupHandler.createSCIMAttributes(group);
}
carbonUM.addRole(group.getDisplayName(),
members.toArray(new String[members.size()]), null, false);
if (log.isDebugEnabled()) {
log.debug("Group: " + group.getDisplayName() + " is created through SCIM.");
}
} else {
//add other scim attributes in the identity DB since user store doesn't support some attributes.
SCIMGroupHandler scimGroupHandler = new SCIMGroupHandler(carbonUM.getTenantId());
scimGroupHandler.createSCIMAttributes(group);
if (!isUniqueGroupIdEnabled(domainName)) {
// Add other scim attributes in the identity DB since user store doesn't support some attributes.
SCIMGroupHandler scimGroupHandler = new SCIMGroupHandler(carbonUM.getTenantId());
scimGroupHandler.createSCIMAttributes(group);
}
carbonUM.addRole(group.getDisplayName(), null, null, false);
if (log.isDebugEnabled()) {
log.debug("Group: " + group.getDisplayName() + " is created through SCIM.");
}
}
if (isUniqueGroupIdEnabled(domainName)) {
org.wso2.carbon.user.core.common.Group retrievedGroup =
carbonUM.getGroupByGroupName(group.getDisplayName(), null);
return buildGroup(retrievedGroup);
}
} catch (UserStoreException e) {
try {
SCIMGroupHandler scimGroupHandler = new SCIMGroupHandler(carbonUM.getTenantId());
scimGroupHandler.deleteGroupAttributes(group.getDisplayName());
if (!isUniqueGroupIdEnabled(domainName)) {
SCIMGroupHandler scimGroupHandler = new SCIMGroupHandler(carbonUM.getTenantId());
scimGroupHandler.deleteGroupAttributes(group.getDisplayName());
}
} catch (UserStoreException | IdentitySCIMException ex) {
log.error("Error occurred while doing rollback operation of the SCIM table entry for role: " + group.getDisplayName(), ex);
throw new CharonException("Error occurred while doing rollback operation of the SCIM table entry for role: " + group.getDisplayName(), e);
Expand Down Expand Up @@ -879,9 +890,21 @@ public Group getGroup(String id) throws CharonException {
}
Group group = null;
try {
SCIMGroupHandler groupHandler = new SCIMGroupHandler(carbonUM.getTenantId());
//get group name by Id
String groupName = groupHandler.getGroupName(id);
String groupName;
/* Since no userstore domain available at the moment we are using the primary userstore domain for getting
default configs since we are not encouraging to disable group id enable feature. */
if (isUniqueGroupIdEnabled(UserCoreConstants.PRIMARY_DEFAULT_DOMAIN_NAME)) {
org.wso2.carbon.user.core.common.Group retrievedGroup = carbonUM.getGroup(id, null);
if (retrievedGroup != null && StringUtils.isNotBlank(retrievedGroup.getGroupName())) {
groupName = retrievedGroup.getGroupName();
} else {
groupName = null;
}
} else {
SCIMGroupHandler groupHandler = new SCIMGroupHandler(carbonUM.getTenantId());
// Get group name by Id.
groupName = groupHandler.getGroupName(id);
}

if (groupName != null) {
group = getGroupWithName(groupName);
Expand All @@ -900,12 +923,20 @@ public Group getGroup(String id) throws CharonException {
@Override
public List<Group> listGroups() throws CharonException {
List<Group> groupList = new ArrayList<>();
Set<String> roleNames;
try {
SCIMGroupHandler groupHandler = new SCIMGroupHandler(carbonUM.getTenantId());
Set<String> roleNames = groupHandler.listSCIMRoles();
/* Since no userstore domain available at the moment we are using the primary userstore domain for getting
default configs since we are not encouraging to disable group id enable feature. */
if (isUniqueGroupIdEnabled(UserCoreConstants.PRIMARY_DEFAULT_DOMAIN_NAME)) {
roleNames = new HashSet<>(Arrays.asList(carbonUM.getRoleNames()));
} else {
SCIMGroupHandler groupHandler = new SCIMGroupHandler(carbonUM.getTenantId());
roleNames = groupHandler.listSCIMRoles();
}

for (String roleName : roleNames) {
Group group = this.getGroupOnlyWithMetaAttributes(roleName);
if (group.getId() != null) {
if (group != null && group.getId() != null) {
groupList.add(group);
}
}
Expand Down Expand Up @@ -1432,9 +1463,18 @@ public void deleteGroup(String groupId) throws NotFoundException, CharonExceptio
about the provisioning route.*/
SCIMCommonUtils.setThreadLocalIsManagedThroughSCIMEP(true);

//get group name by id
String groupName;
SCIMGroupHandler groupHandler = new SCIMGroupHandler(carbonUM.getTenantId());
String groupName = groupHandler.getGroupName(groupId);
/* Since no userstore domain available at the moment we are using the primary userstore domain for
getting default configs since we are not encouraging to disable group id enable feature. */
if (isUniqueGroupIdEnabled(UserCoreConstants.PRIMARY_DEFAULT_DOMAIN_NAME)) {
// Get group name by id.
org.wso2.carbon.user.core.common.Group retrievedGroup = carbonUM.getGroup(groupId, null);
groupName = retrievedGroup.getGroupName();
} else {
//Get group name by id.
groupName = groupHandler.getGroupName(groupId);
}

if (groupName != null) {
String userStoreDomainFromSP = null;
Expand Down Expand Up @@ -1584,7 +1624,15 @@ private Group getGroupWithName(String groupName)
}

Group group = new Group();
group.setDisplayName(groupName);
if (isUniqueGroupIdEnabled(userStoreDomainName)) {
org.wso2.carbon.user.core.common.Group retrievedGroup = carbonUM.getGroupByGroupName(groupName, null);
group = buildGroup(retrievedGroup);
} else {
group.setDisplayName(groupName);
// Get other group attributes and set.
SCIMGroupHandler groupHandler = new SCIMGroupHandler(carbonUM.getTenantId());
group = groupHandler.getGroupWithAttributes(group, groupName);
}
String[] userNames = carbonUM.getUserListOfRole(groupName);

//get the ids of the users and set them in the group with id + display name
Expand All @@ -1594,12 +1642,49 @@ private Group getGroupWithName(String groupName)
group.setMember(userId, userName);
}
}
//get other group attributes and set.
SCIMGroupHandler groupHandler = new SCIMGroupHandler(carbonUM.getTenantId());
group = groupHandler.getGroupWithAttributes(group, groupName);
return group;
}

/**
* Build group from user core group object.
*
* @param group Group object returned from the user core.
* @return Group object.
* @throws CharonException If an error occurred while building the group object.
*/
private Group buildGroup(org.wso2.carbon.user.core.common.Group group) throws CharonException {

if (group == null) {
return null;
}
String groupName = group.getGroupName();
Group scimGroup = new Group();
scimGroup.setDisplayName(groupName);
scimGroup.setId(group.getGroupID());
if (StringUtils.isBlank(group.getLocation())) {
// Location has not been sent from the user core. Therefore, we need to use the group id to build location.
scimGroup.setLocation(SCIMCommonUtils.getSCIMGroupURL(group.getGroupID()));
} else {
scimGroup.setLocation(group.getLocation());
}
// Validate dates.
if (StringUtils.isNotBlank(group.getCreatedDate())) {
scimGroup.setCreatedDate(AttributeUtil.parseDateTime(group.getCreatedDate()));
} else {
if (log.isDebugEnabled()) {
log.debug("Group created date is not specified for group: " + groupName);
}
}
if (StringUtils.isNotBlank(group.getLastModifiedDate())) {
scimGroup.setLastModified(AttributeUtil.parseDateTime(group.getLastModifiedDate()));
} else {
if (log.isDebugEnabled()) {
log.debug("Group last modified date is not specified for group: " + groupName);
}
}
return scimGroup;
}

/**
* Get group with only meta attributes.
*
Expand All @@ -1612,11 +1697,20 @@ private Group getGroupWithName(String groupName)
private Group getGroupOnlyWithMetaAttributes(String groupName)
throws CharonException, IdentitySCIMException,
org.wso2.carbon.user.core.UserStoreException {

//get other group attributes and set.
Group group = new Group();
group.setDisplayName(groupName);
SCIMGroupHandler groupHandler = new SCIMGroupHandler(carbonUM.getTenantId());
return groupHandler.getGroupWithAttributes(group, groupName);
String userStoreDomainName = IdentityUtil.extractDomainFromName(groupName);
if (isUniqueGroupIdEnabled(userStoreDomainName)) {
org.wso2.carbon.user.core.common.Group retrievedGroup = carbonUM.getGroupByGroupName(groupName, null);
Group group = buildGroup(retrievedGroup);
group.setDisplayName(groupName);
return group;
} else {
Group group = new Group();
group.setDisplayName(groupName);
SCIMGroupHandler groupHandler = new SCIMGroupHandler(carbonUM.getTenantId());
return groupHandler.getGroupWithAttributes(group, groupName);
}
}

/**
Expand Down Expand Up @@ -1842,6 +1936,20 @@ private boolean isSCIMEnabled(String userstoreName) {
return false;
}

/**
* This method will return whether Unique group id is enabled or not for a particular userstore.
* @param userstoreName user store name.
* @return whether Unique group id is enabled or not for the particular user store.
*/
public boolean isUniqueGroupIdEnabled(String userstoreName) {

UserStoreManager userStoreManager = carbonUM.getSecondaryUserStoreManager(userstoreName);
if (userStoreManager != null && userStoreManager instanceof AbstractUserStoreManager) {
return ((AbstractUserStoreManager) userStoreManager).isUniqueGroupIdEnabled();
}
return false;
}

/**
* returns whether particular user store domain is application or internal.
* @param userstoreDomain user store domain
Expand Down
4 changes: 2 additions & 2 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,8 +189,8 @@
<cxf-bundle.version>3.3.7</cxf-bundle.version>
<inbound.auth.oauth.version>6.2.0</inbound.auth.oauth.version>
<commons-collections.version>3.2.2.wso2v1</commons-collections.version>
<carbon.kernel.version>4.9.1</carbon.kernel.version>
<carbon.kernel.feature.version>4.9.1</carbon.kernel.feature.version>
<carbon.kernel.version>4.10.2</carbon.kernel.version>
<carbon.kernel.feature.version>4.10.2</carbon.kernel.feature.version>
<junit.version>4.13.1</junit.version>
<!--Maven Plugin Version-->
<maven.compiler.plugin.version>2.3.1</maven.compiler.plugin.version>
Expand Down
Loading