Username recovery sms support

components/identity-mgt/org.wso2.carbon.identity.mgt.endpoint.util/src/main/java/org/wso2/carbon/identity/mgt/endpoint/util/IdentityManagementEndpointConstants.java

@@ -59,6 +59,7 @@ public static final class ClaimURIs {
         public static final String FIRST_NAME_CLAIM = "http://wso2.org/claims/givenname";
         public static final String LAST_NAME_CLAIM = "http://wso2.org/claims/lastname";
         public static final String EMAIL_CLAIM = "http://wso2.org/claims/emailaddress";
+        public static final String MOBILE_CLAIM = "http://wso2.org/claims/mobile";
         public static final String CHALLENGE_QUESTION_URI_CLAIM = "http://wso2.org/claims/challengeQuestionUris";
         public static final String CHALLENGE_QUESTION_1_CLAIM = "http://wso2.org/claims/challengeQuestion1";
         public static final String CHALLENGE_QUESTION_2_CLAIM = "http://wso2.org/claims/challengeQuestion2";
@@ -74,6 +75,8 @@ public static final class UserInfoRecovery {
         public static final String RECOVERY_API_V2_RELATIVE_PATH = "/api/users/v2/recovery";
         public static final String USER_API_RELATIVE_PATH = "/api/identity/user/v1.0";
         public static final String RECOVERY_CALLBACK_REGEX = "Recovery.CallbackRegex";
+        public static final String MOBILE_CLAIM_REGEX =  "^\\s*(?:\\+?(\\d{1,3}))?[\\-. (]*(\\d{2,3})[\\-. )]*" +
+                "(\\d{3})[\\-. ]*(\\d{4,6})(?: *x(\\d+))?\\s*$";
     }
 
     public static final class UserInfoRecoveryErrorDesc {

components/identity-mgt/org.wso2.carbon.identity.mgt.endpoint.util/src/main/java/org/wso2/carbon/identity/mgt/endpoint/util/client/PreferenceRetrievalClient.java

@@ -58,7 +58,6 @@ public class PreferenceRetrievalClient {
     private static final String PREFERENCE_API_RELATIVE_PATH = "/api/server/v1/identity-governance/preferences";
     private static final String GOVERNANCE_API_RELATIVE_PATH = "/api/server/v1/identity-governance";
     private static final String SELF_REGISTRATION_PROPERTY = "SelfRegistration.Enable";
-    private static final String USERNAME_RECOVERY_PROPERTY = "Recovery.Notification.Username.Enable";
     private static final String QUESTION_PASSWORD_RECOVERY_PROPERTY = "Recovery.Question.Password.Enable";
     private static final String SELF_SIGN_UP_LOCK_ON_CREATION_PROPERTY = "SelfRegistration.LockOnCreation";
     private static final String MULTI_ATTRIBUTE_LOGIN_PROPERTY = "account.multiattributelogin.handler.enable";
@@ -137,13 +136,37 @@ public boolean checkSelfRegistrationShowUsernameUnavailability(String tenant)
     /**
      * Check username recovery is enabled or not.
      *
-     * @param tenant tenant domain name.
+     * @param tenantDomain tenant domain name.
      * @return returns true if  username recovery enabled.
-     * @throws PreferenceRetrievalClientException
+     * @throws PreferenceRetrievalClientException If any PreferenceRetrievalClientException occurs.
+     */
+    public boolean checkUsernameRecovery(String tenantDomain) throws PreferenceRetrievalClientException {
+
+        return checkPreference(tenantDomain, RECOVERY_CONNECTOR, IdPManagementConstants.USERNAME_RECOVERY_PROPERTY);
+    }
+
+    /**
+     * Check email based username recovery is enabled or not.
+     *
+     * @param tenantDomain tenant domain name.
+     * @return returns true if email based username recovery enabled.
+     * @throws PreferenceRetrievalClientException If any PreferenceRetrievalClientException occurs.
+     */
+    public boolean checkEmailBasedUsernameRecovery(String tenantDomain) throws PreferenceRetrievalClientException {
+
+        return checkPreference(tenantDomain, RECOVERY_CONNECTOR, IdPManagementConstants.EMAIL_USERNAME_RECOVERY_PROPERTY);
+    }
+
+    /**
+     * Check SMS based username recovery is enabled or not.
+     *
+     * @param tenantDomain tenant domain name.
+     * @return returns true if SMS based username recovery enabled.
+     * @throws PreferenceRetrievalClientException If any PreferenceRetrievalClientException occurs.
      */
-    public boolean checkUsernameRecovery(String tenant) throws PreferenceRetrievalClientException {
+    public boolean checkSMSBasedUsernameRecovery(String tenantDomain) throws PreferenceRetrievalClientException {
 
-        return checkPreference(tenant, RECOVERY_CONNECTOR, USERNAME_RECOVERY_PROPERTY);
+        return checkPreference(tenantDomain, RECOVERY_CONNECTOR, IdPManagementConstants.SMS_USERNAME_RECOVERY_PROPERTY);
     }
 
     /**

components/identity-mgt/org.wso2.carbon.identity.mgt.endpoint.util/src/main/java/org/wso2/carbon/identity/mgt/endpoint/util/client/api/RecoveryApiV2.java

@@ -56,6 +56,9 @@ public class RecoveryApiV2 {
     private static final String PATH_PASSWORD_RECOVERY_RESEND = "/password/resend";
     private static final String PATH_PASSWORD_RECOVERY_CONFIRM = "/password/confirm";
     private static final String PATH_PASSWORD_RECOVERY_RESET = "/password/reset";
+    private static final String PATH_USERNAME_RECOVERY_INIT = "/username/init";
+    private static final String PATH_USERNAME_RECOVERY_RECOVER = "/username/recover";
+
     String basePath = IdentityManagementEndpointUtil.buildEndpointUrl(IdentityManagementEndpointConstants
             .UserInfoRecovery.RECOVERY_API_V2_RELATIVE_PATH);
     private ApiClient apiClient;
@@ -80,6 +83,35 @@ public void setApiClient(ApiClient apiClient) {
         this.apiClient = apiClient;
     }
 
+    /**
+     * Initiate recovering the forgotten username.
+     *
+     * @param recoveryInitRequest Username recovery initiating request. (required)
+     * @param tenantDomain        Tenant Domain which user belongs. Default "carbon.super" (optional)
+     * @param headers             If reCaptcha respond is found, embedded in request header. (optional)
+     * @return Account recovery options response object.
+     * @throws ApiException If fails to make API call.
+     */
+    public List<AccountRecoveryType> initiateUsernameRecovery(RecoveryInitRequest recoveryInitRequest,
+                                                              String tenantDomain, Map<String, String> headers)
+            throws ApiException {
+
+        return initiateRecovery(recoveryInitRequest, tenantDomain, headers, PATH_USERNAME_RECOVERY_INIT);
+    }
+
+    /**
+     * @param recoveryRequest Recovery request. (required)
+     * @param tenantDomain    Tenant Domain which user belongs. Default "carbon.super" (optional)
+     * @param headers         Any additional headers to be embedded. (optional)
+     * @return Recovery response.
+     * @throws ApiException If fails to make API call.
+     */
+    public RecoveryResponse recoverUsername(RecoveryRequest recoveryRequest, String tenantDomain,
+                                            Map<String, String> headers) throws ApiException {
+
+        return recover(recoveryRequest, tenantDomain, headers, PATH_USERNAME_RECOVERY_RECOVER);
+    }
+
     /**
      * Initiate recovering the forgotten password.
      *

components/identity-mgt/org.wso2.carbon.identity.mgt.endpoint.util/src/test/java/org/wso2/carbon/identity/mgt/endpoint/util/PreferenceRetrievalClientTest.java

@@ -46,6 +46,8 @@ public class PreferenceRetrievalClientTest {
     private static final String SELF_REG_CALLBACK_REGEX_PROP = "SelfRegistration.CallbackRegex";
     public static final String SHOW_USERNAME_UNAVAILABILITY = "SelfRegistration.ShowUsernameUnavailability";
     private static final String USERNAME_RECOVERY_PROPERTY = "Recovery.Notification.Username.Enable";
+    private static final String EMAIL_USERNAME_RECOVERY_PROPERTY = "Recovery.Notification.Username.Email.Enable";
+    public static final String SMS_USERNAME_RECOVERY_PROPERTY = "Recovery.Notification.Username.SMS.Enable";
     private static final String QUESTION_PASSWORD_RECOVERY_PROPERTY = "Recovery.Question.Password.Enable";
     public static final String NOTIFICATION_PASSWORD_ENABLE_PROPERTY = "Recovery.Notification.Password.Enable";
     public static final String EMAIL_LINK_PASSWORD_RECOVERY_PROPERTY =
@@ -130,6 +132,28 @@ public void testCheckUsernameRecovery() throws PreferenceRetrievalClientExceptio
                 USERNAME_RECOVERY_PROPERTY);
     }
 
+    @Test
+    public void testCheckEmailBasedUsernameRecovery() throws PreferenceRetrievalClientException {
+
+        doReturn(true).when(preferenceRetrievalClient).
+                checkPreference(tenantDomain, RECOVERY_CONNECTOR, EMAIL_USERNAME_RECOVERY_PROPERTY);
+        boolean result = preferenceRetrievalClient.checkEmailBasedUsernameRecovery(tenantDomain);
+        assertTrue(result);
+        verify(preferenceRetrievalClient, times(1)).
+                checkPreference(tenantDomain, RECOVERY_CONNECTOR, EMAIL_USERNAME_RECOVERY_PROPERTY);
+    }
+
+    @Test
+    public void testCheckSMSBasedUsernameRecovery() throws PreferenceRetrievalClientException {
+
+        doReturn(true).when(preferenceRetrievalClient).
+                checkPreference(tenantDomain, RECOVERY_CONNECTOR, SMS_USERNAME_RECOVERY_PROPERTY);
+        boolean result = preferenceRetrievalClient.checkSMSBasedUsernameRecovery(tenantDomain);
+        assertTrue(result);
+        verify(preferenceRetrievalClient, times(1)).
+                checkPreference(tenantDomain, RECOVERY_CONNECTOR, SMS_USERNAME_RECOVERY_PROPERTY);
+    }
+
     @Test
     public void testCheckNotificationBasedPasswordRecovery() throws PreferenceRetrievalClientException {