Skip to content

Commit

Permalink
Add logic to handle non-unique users for username recovery.
Browse files Browse the repository at this point in the history
  • Loading branch information
@Malith-19
Malith-19 committed Nov 6, 2024
1 parent a7a13d5 commit 32af364
Show file tree
Hide file tree
Showing 2 changed files with 137 additions and 22 deletions.
102 changes: 102 additions & 0 deletions ...a/org/wso2/carbon/identity/recovery/internal/service/impl/UserAccountRecoveryManager.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import org.apache.commons.logging.LogFactory;

import org.wso2.carbon.identity.application.common.model.User;
import org.wso2.carbon.identity.base.IdentityException;
import org.wso2.carbon.identity.claim.metadata.mgt.exception.ClaimMetadataException;
import org.wso2.carbon.identity.core.util.IdentityTenantUtil;
import org.wso2.carbon.identity.core.util.IdentityUtil;
Expand Down Expand Up @@ -108,6 +109,107 @@ public static UserAccountRecoveryManager getInstance() {
return instance;
}

/**
* Initiate the username recovery flow for the user with matching claims when non-unique user config enabled.
*
* @param claims User claims
* @param tenantDomain Tenant domain
* @param properties Meta properties
* @return RecoveryChannelInfoDTO object.
*/
public RecoveryChannelInfoDTO retrieveUsersRecoveryInformationForUsername(Map<String, String> claims,
String tenantDomain,
Map<String, String> properties)
throws IdentityRecoveryException {

RecoveryScenarios recoveryScenario = RecoveryScenarios.USERNAME_RECOVERY;
// Retrieve the user who matches the given set of claims.
ArrayList<org.wso2.carbon.user.core.common.User> resultedUserList = getUserListByClaims(claims, tenantDomain);

if (!resultedUserList.isEmpty()) {
StringBuilder usernameCombined = new StringBuilder();
// Get the notification management mechanism.
List<NotificationChannel> notificationChannels;
boolean isNotificationsInternallyManaged = Utils.isNotificationsInternallyManaged(tenantDomain, properties);
String recoveryFlowId = null;
String recoveryCode = null;
String notificationChannelList = null;
String username = null;
NotificationChannelDTO[] notificationChannelDTOS = null;

for (org.wso2.carbon.user.core.common.User resultedUser : resultedUserList) {
username = resultedUser.getUsername();
User user = Utils.buildUser(username, tenantDomain);

try {
// If the account is locked or disabled, do not let the user, recover the account.
checkAccountLockedStatus(user);

} catch (IdentityException e) {
if (log.isDebugEnabled()) {
log.debug(username + " is locked.");
}
continue;
}

/* If the notification is internally managed, then notification channels available for the user needs to
be retrieved. If external notifications are enabled, external channel list should be returned.*/
if (isNotificationsInternallyManaged) {
notificationChannels = getInternalNotificationChannelList(username, tenantDomain,
recoveryScenario);
} else {
notificationChannels = getExternalNotificationChannelList();
}

// Validate whether the user account is eligible for account recovery.
checkUserValidityForAccountRecovery(user, recoveryScenario, notificationChannels, properties);
// This flow will be initiated only if the user has any verified channels.
notificationChannelDTOS = getNotificationChannelsResponseDTOList(
tenantDomain, notificationChannels);
UserRecoveryDataStore userRecoveryDataStore = JDBCRecoveryDataStore.getInstance();
// Get the existing RESEND_CONFIRMATION_CODE details if there is any.
UserRecoveryData recoveryDataDO = userRecoveryDataStore.loadWithoutCodeExpiryValidation(
user, recoveryScenario, RecoverySteps.RESEND_CONFIRMATION_CODE);

notificationChannelList = getNotificationChannelListForRecovery(notificationChannels);
recoveryCode = UUID.randomUUID().toString();
recoveryFlowId = UUID.randomUUID().toString();

if (Utils.reIssueExistingConfirmationCode(recoveryDataDO,
NotificationChannels.EMAIL_CHANNEL.getChannelType())) {
/* Update the existing RESEND_CONFIRMATION_CODE details with new code details without changing the
time created of the RESEND_CONFIRMATION_CODE. */
userRecoveryDataStore.invalidateWithoutChangeTimeCreated(recoveryDataDO.getSecret(), recoveryCode,
RecoverySteps.SEND_RECOVERY_INFORMATION, notificationChannelList);
} else {
if (usernameCombined.length() > 0) {
usernameCombined.append(",");
}
usernameCombined.append(username);
}
}
if (StringUtils.isBlank(usernameCombined.toString())) {
if (log.isDebugEnabled()) {
log.debug("No valid user found for the given claims");
}
throw Utils.handleClientException(IdentityRecoveryConstants.ErrorMessages.ERROR_CODE_NO_USER_FOUND,
null);
}
addRecoveryDataObject(usernameCombined.toString(), tenantDomain, recoveryFlowId, recoveryCode,
recoveryScenario,
notificationChannelList);

return buildUserRecoveryInformationResponseDTO(username, recoveryFlowId, recoveryCode,
notificationChannelDTOS);

} else {
if (log.isDebugEnabled()) {
log.debug("No valid user found for the given claims");
}
throw Utils.handleClientException(IdentityRecoveryConstants.ErrorMessages.ERROR_CODE_NO_USER_FOUND, null);
}
}

/**
* Initiate the recovery flow for the user with matching claims.
*
Expand Down
57 changes: 35 additions & 22 deletions .../carbon/identity/recovery/internal/service/impl/username/UsernameRecoveryManagerImpl.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -134,9 +134,18 @@ public RecoveryInformationDTO initiate(Map<String, String> claims, String tenant
Map<String, String> metaProperties = new HashMap<>();
metaProperties.put(IdentityRecoveryConstants.MANAGE_NOTIFICATIONS_INTERNALLY_PROPERTY_KEY,
Boolean.toString(manageNotificationsInternally));
recoveryInformationDTO.setRecoveryChannelInfoDTO(userAccountRecoveryManager
.retrieveUserRecoveryInformation(claims, tenantDomain, RecoveryScenarios.USERNAME_RECOVERY,
metaProperties));

boolean nonUniqueUsernameEnabled = Boolean.parseBoolean(IdentityUtil.getProperty(
IdentityRecoveryConstants.ConnectorConfig.USERNAME_RECOVERY_NON_UNIQUE_USERNAME));
if (nonUniqueUsernameEnabled) {
recoveryInformationDTO.setRecoveryChannelInfoDTO(userAccountRecoveryManager
.retrieveUsersRecoveryInformationForUsername(claims, tenantDomain, metaProperties));
} else {
recoveryInformationDTO.setRecoveryChannelInfoDTO(userAccountRecoveryManager
.retrieveUserRecoveryInformation(claims, tenantDomain, RecoveryScenarios.USERNAME_RECOVERY,
metaProperties));
}

return recoveryInformationDTO;
}

Expand Down Expand Up @@ -313,27 +322,31 @@ private void triggerNotification(User user, String notificationChannel, String e
Map<String, String> metaProperties)
throws IdentityRecoveryException {

HashMap<String, Object> properties = new HashMap<>();
properties.put(IdentityEventConstants.EventProperty.USER_NAME, user.getUserName());
properties.put(IdentityEventConstants.EventProperty.TENANT_DOMAIN, user.getTenantDomain());
properties.put(IdentityEventConstants.EventProperty.USER_STORE_DOMAIN, user.getUserStoreDomain());
properties.put(IdentityEventConstants.EventProperty.NOTIFICATION_CHANNEL, notificationChannel);
if (metaProperties != null) {
for (String key : metaProperties.keySet()) {
String value = metaProperties.get(key);
if (StringUtils.isNotBlank(key) && StringUtils.isNotBlank(value)) {
properties.put(key, value);
String combinedUsernames = user.getUserName();
String[] usernames = combinedUsernames.split(",");
for (String username : usernames) {
HashMap<String, Object> properties = new HashMap<>();
properties.put(IdentityEventConstants.EventProperty.USER_NAME, username);
properties.put(IdentityEventConstants.EventProperty.TENANT_DOMAIN, user.getTenantDomain());
properties.put(IdentityEventConstants.EventProperty.USER_STORE_DOMAIN, user.getUserStoreDomain());
properties.put(IdentityEventConstants.EventProperty.NOTIFICATION_CHANNEL, notificationChannel);
if (metaProperties != null) {
for (String key : metaProperties.keySet()) {
String value = metaProperties.get(key);
if (StringUtils.isNotBlank(key) && StringUtils.isNotBlank(value)) {
properties.put(key, value);
}
}
}
}
properties.put(IdentityRecoveryConstants.TEMPLATE_TYPE,
IdentityRecoveryConstants.NOTIFICATION_ACCOUNT_ID_RECOVERY);
Event identityMgtEvent = new Event(eventName, properties);
try {
IdentityRecoveryServiceDataHolder.getInstance().getIdentityEventService().handleEvent(identityMgtEvent);
} catch (IdentityEventException e) {
throw Utils.handleServerException(IdentityRecoveryConstants.ErrorMessages.ERROR_CODE_TRIGGER_NOTIFICATION,
user.getUserName(), e);
properties.put(IdentityRecoveryConstants.TEMPLATE_TYPE,
IdentityRecoveryConstants.NOTIFICATION_ACCOUNT_ID_RECOVERY);
Event identityMgtEvent = new Event(eventName, properties);
try {
IdentityRecoveryServiceDataHolder.getInstance().getIdentityEventService().handleEvent(identityMgtEvent);
} catch (IdentityEventException e) {
throw Utils.handleServerException(IdentityRecoveryConstants.ErrorMessages.ERROR_CODE_TRIGGER_NOTIFICATION,
user.getUserName(), e);
}
}
}

Expand Down

0 comments on commit 32af364

Please sign in to comment.