Adding username input validation userInfohandler

components/input-validation-mgt/org.wso2.carbon.identity.input.validation.mgt/findbugs-exclude.xml

@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Copyright (c) 2020, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~      http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+<FindBugsFilter>
+    <!--
+      There seems to be a bug in findbug, unable to read some bytecodes generated by java 11
+       properly, when try-with-resource pattern is used. This fails the following classes.
+       Please remove this exclusion when findbug plugin us updated from
+       org.codehaus.mojo:findbugs-maven-plugin-3.0.5 to a newer one which has the fix for the issue.
+       references,
+       https://github.com/spotbugs/spotbugs/issues/756
+    -->
+    <Match>
+        <Class name="org.wso2.carbon.identity.role.mgt.core.dao.GroupDAOImpl" />
+        <Bug pattern="RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE"/>
+    </Match>
+    <Match>
+        <Class name="org.wso2.carbon.identity.role.mgt.core.dao.RoleDAOImpl" />
+        <Bug pattern="RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE"/>
+    </Match>
+</FindBugsFilter>

components/input-validation-mgt/org.wso2.carbon.identity.input.validation.mgt/pom.xml

@@ -110,6 +110,7 @@
                             org.wso2.carbon.context; version="${carbon.kernel.package.import.version.range}",
                             org.wso2.carbon.user.api; version="${carbon.user.api.imp.pkg.version.range}",
                             org.wso2.carbon.utils.multitenancy;version="${carbon.kernel.package.import.version.range}",
+                            org.wso2.carbon.utils.multitenancy.userinfo;version="${carbon.kernel.package.import.version.range}",
                             org.wso2.carbon.stratos.common.*;version="${carbon.commons.imp.pkg.version}",
                             org.apache.commons.logging; version="${import.package.version.commons.logging}",
                             org.osgi.framework; version="${osgi.framework.imp.pkg.version.range}",

components/input-validation-mgt/org.wso2.carbon.identity.input.validation.mgt/src/main/java/org/wso2/carbon/identity/input/validation/mgt/internal/InputValidationServiceComponent.java

@@ -46,7 +46,9 @@
 import org.wso2.carbon.identity.input.validation.mgt.model.validators.UpperCaseValidator;
 import org.wso2.carbon.identity.input.validation.mgt.services.InputValidationManagementService;
 import org.wso2.carbon.identity.input.validation.mgt.services.InputValidationManagementServiceImpl;
+import org.wso2.carbon.identity.input.validation.mgt.userinfo.UserInfoHandlerImpl;
 import org.wso2.carbon.user.core.listener.UserOperationEventListener;
+import org.wso2.carbon.utils.multitenancy.userinfo.UserInfoHandler;
 
 /**
  * OSGi declarative services component which handled registration and un-registration of
@@ -68,6 +70,9 @@ protected void activate(ComponentContext context) {
             context.getBundleContext().registerService(InputValidationManagementService.class.getName(),
                     new InputValidationManagementServiceImpl(), null);
 
+            context.getBundleContext().registerService(UserInfoHandler.class.getName(),
+                    new UserInfoHandlerImpl(), null);
+
             // Register Validators.
             context.getBundleContext().registerService(Validator.class.getName(),
                     new LengthValidator(), null);

components/input-validation-mgt/org.wso2.carbon.identity.input.validation.mgt/src/main/java/org/wso2/carbon/identity/input/validation/mgt/userinfo/UserInfoHandlerImpl.java

@@ -0,0 +1,168 @@
+/*
+ * Copyright (c) 2023, WSO2 LLC. (http://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.wso2.carbon.identity.input.validation.mgt.userinfo;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.wso2.carbon.base.MultitenantConstants;
+import org.wso2.carbon.context.CarbonContext;
+import org.wso2.carbon.identity.core.util.IdentityUtil;
+import org.wso2.carbon.identity.input.validation.mgt.exceptions.InputValidationMgtException;
+import org.wso2.carbon.identity.input.validation.mgt.model.RulesConfiguration;
+import org.wso2.carbon.identity.input.validation.mgt.model.ValidationConfiguration;
+import org.wso2.carbon.identity.input.validation.mgt.model.validators.EmailFormatValidator;
+import org.wso2.carbon.identity.input.validation.mgt.services.InputValidationManagementService;
+import org.wso2.carbon.identity.input.validation.mgt.services.InputValidationManagementServiceImpl;
+import org.wso2.carbon.utils.multitenancy.userinfo.UserInfoHandler;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+import static org.wso2.carbon.identity.input.validation.mgt.utils.Constants.Configs.USERNAME;
+import static org.wso2.carbon.identity.input.validation.mgt.utils.Constants.ErrorMessages.ERROR_GETTING_EXISTING_CONFIGURATIONS;
+
+/**
+ * This class implemented to use username input validation.
+ * This method modifies tenant to user mapping.
+ */
+public class UserInfoHandlerImpl implements UserInfoHandler {
+
+    private static final Log LOG = LogFactory.getLog(UserInfoHandlerImpl.class);
+    private static final String TENANT_NAME_FROM_CONTEXT = "TenantNameFromContext";
+
+    private final InputValidationManagementService inputValidationMgtService =
+            new InputValidationManagementServiceImpl();
+
+    @Override
+    public String getTenantAwareUsername(String username) {
+
+        String tenantDomain = CarbonContext.getThreadLocalCarbonContext().getTenantDomain();
+        boolean isEmailAsUsername = isEmailAsUserName(tenantDomain);
+
+        if (username.contains("@") && !isEmailAsUsername) {
+            username = username.substring(0, username.lastIndexOf('@'));
+        } else if (isEmailAsUsername) {
+            if (username.indexOf("@") == username.lastIndexOf("@")) {
+                if (MultitenantConstants.SUPER_TENANT_DOMAIN_NAME.
+                        equalsIgnoreCase(username.substring(username.lastIndexOf('@') + 1))) {
+                    username = username.substring(0, username.lastIndexOf('@'));
+                }
+            } else {
+                username = username.substring(0, username.lastIndexOf('@'));
+            }
+        }
+        return username;
+    }
+
+    @Override
+    public String getTenantDomain(String username) {
+
+        String tenantDomain = MultitenantConstants.SUPER_TENANT_DOMAIN_NAME;
+        if (username.contains("@")) {
+            if (username.indexOf("@") != username.lastIndexOf("@")) {
+                tenantDomain = username.substring(username.lastIndexOf('@') + 1);
+            } else {
+                if (isEmailUserNameForSuperTenant()) {
+                    tenantDomain = MultitenantConstants.SUPER_TENANT_DOMAIN_NAME;
+                } else {
+                    tenantDomain = username.substring(username.lastIndexOf('@') + 1);
+                }
+            }
+        }
+
+        if (tenantDomain == null || tenantDomain.trim().length() == 0) {
+            // if the tenant domain is null, assume super tenant
+            tenantDomain = MultitenantConstants.SUPER_TENANT_DOMAIN_NAME;
+        }
+        return tenantDomain.toLowerCase();
+    }
+
+    public boolean isEmailAsUserName(String tenantDomain) {
+
+        List<ValidationConfiguration> configurations;
+        boolean isEmailAsUsername = false;
+        try {
+            configurations = inputValidationMgtService.getInputValidationConfiguration(tenantDomain);
+            String field = USERNAME;
+            ValidationConfiguration configurationList = configurations.stream().filter(config ->
+                    field.equalsIgnoreCase(config.getField())).collect(Collectors.toList()).get(0);
+
+            /* If configuration for username field is found in Input Validation Mgt service, validate against them,
+             if not validate against the regex from the userStore. */
+            if (configurationList != null && configurationList.getRules() != null &&
+                    !configurationList.getRules().isEmpty()) {
+                for (RulesConfiguration configuration: configurationList.getRules()) {
+                    if (EmailFormatValidator.class.getSimpleName().equals(configuration.getValidatorName())) {
+                        isEmailAsUsername = true;
+                    }
+                }
+            }
+            return isEmailAsUsername;
+
+        } catch (InputValidationMgtException e) {
+            LOG.error(new InputValidationMgtException(ERROR_GETTING_EXISTING_CONFIGURATIONS.getCode(), e.getMessage(),
+                    e.getDescription()), e);
+            return false;
+        }
+    }
+
+    /**
+     * Retrieves loaded tenant domain from carbon context.
+     *
+     * @return tenant domain of the request is being served.
+     */
+    private String getTenantDomainFromContext() {
+
+        String tenantDomain = MultitenantConstants.SUPER_TENANT_DOMAIN_NAME;
+        if (IdentityUtil.threadLocalProperties.get().get(TENANT_NAME_FROM_CONTEXT) != null) {
+            tenantDomain = (String) IdentityUtil.threadLocalProperties.get().get(TENANT_NAME_FROM_CONTEXT);
+        }
+        return tenantDomain;
+    }
+
+    private boolean isEmailUserNameForSuperTenant() {
+
+        List<ValidationConfiguration> configurations;
+        boolean isEmailAsUsername = false;
+        try {
+            configurations = inputValidationMgtService.getInputValidationConfiguration
+                    (MultitenantConstants.SUPER_TENANT_DOMAIN_NAME);
+            String field = USERNAME;
+            ValidationConfiguration configurationList = configurations.stream().filter(config ->
+                    field.equalsIgnoreCase(config.getField())).collect(Collectors.toList()).get(0);
+
+            /* If configuration for username field is found in Input Validation Mgt service, validate against them,
+             if not validate against the regex from the userStore. */
+            if (configurationList != null && configurationList.getRules() != null &&
+                    !configurationList.getRules().isEmpty()) {
+                for (RulesConfiguration configuration: configurationList.getRules()) {
+                    if (EmailFormatValidator.class.getSimpleName().equals(configuration.getValidatorName())) {
+                        isEmailAsUsername = true;
+                    }
+                }
+            }
+            return isEmailAsUsername;
+
+        } catch (InputValidationMgtException e) {
+            LOG.error(new InputValidationMgtException(ERROR_GETTING_EXISTING_CONFIGURATIONS.getCode(), e.getMessage(),
+                    e.getDescription()), e);
+            return false;
+        }
+    }
+}

components/input-validation-mgt/org.wso2.carbon.identity.input.validation.mgt/src/main/java/org/wso2/carbon/identity/input/validation/mgt/utils/Util.java

@@ -0,0 +1,71 @@
+/*
+ * Copyright (c) 2023, WSO2 LLC. (http://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.wso2.carbon.identity.input.validation.mgt.utils;
+
+import org.wso2.carbon.identity.input.validation.mgt.exceptions.InputValidationMgtException;
+import org.wso2.carbon.identity.input.validation.mgt.model.RulesConfiguration;
+import org.wso2.carbon.identity.input.validation.mgt.model.ValidationConfiguration;
+import org.wso2.carbon.identity.input.validation.mgt.model.validators.EmailFormatValidator;
+import org.wso2.carbon.identity.input.validation.mgt.services.InputValidationManagementService;
+import org.wso2.carbon.identity.input.validation.mgt.services.InputValidationManagementServiceImpl;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+import static org.wso2.carbon.identity.input.validation.mgt.utils.Constants.Configs.USERNAME;
+import static org.wso2.carbon.identity.input.validation.mgt.utils.Constants.ErrorMessages.ERROR_GETTING_EXISTING_CONFIGURATIONS;
+
+/**
+ * Util class for input validation management.
+ */
+public class Util {
+
+    private static final InputValidationManagementService inputValidationMgtService =
+            new InputValidationManagementServiceImpl();
+    private Util() {
+
+    }
+    public static boolean isEmailAsUserName(String tenantDomain) throws InputValidationMgtException {
+
+        List<ValidationConfiguration> configurations;
+        boolean isEmailAsUsername = false;
+        try {
+            configurations = inputValidationMgtService.getInputValidationConfiguration(tenantDomain);
+            String field = USERNAME;
+            ValidationConfiguration configurationList = configurations.stream().filter(config ->
+                    field.equalsIgnoreCase(config.getField())).collect(Collectors.toList()).get(0);
+
+            /* If configuration for username field is found in Input Validation Mgt service, validate against them,
+             if not validate against the regex from the userStore. */
+            if (configurationList != null && !configurationList.getRules().isEmpty()) {
+                for (RulesConfiguration configuration: configurationList.getRules()) {
+                    if (EmailFormatValidator.class.getSimpleName().equals(configuration.getValidatorName())) {
+                        isEmailAsUsername = true;
+                    }
+                }
+            }
+            return isEmailAsUsername;
+
+        } catch (InputValidationMgtException e) {
+
+            throw new InputValidationMgtException(ERROR_GETTING_EXISTING_CONFIGURATIONS.getCode(), e.getMessage(),
+                    e.getDescription());
+        }
+    }
+}