Add new DefinedBy property to authenticator config.

components/application-mgt/org.wso2.carbon.identity.application.common/src/main/java/org/wso2/carbon/identity/application/common/model/FederatedAuthenticatorConfig.java

@@ -22,6 +22,10 @@
 import org.apache.axiom.om.OMElement;
 import org.apache.commons.collections.CollectionUtils;
 import org.apache.commons.lang.StringUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.wso2.carbon.identity.base.AuthenticatorPropertiesConstant.AuthenticationType;
+import org.wso2.carbon.identity.base.AuthenticatorPropertiesConstant.DefinedByType;
 
 import java.io.Serializable;
 import java.util.ArrayList;
@@ -46,6 +50,7 @@
 public class FederatedAuthenticatorConfig implements Serializable {
 
     private static final long serialVersionUID = -2361107623257323257L;
+    private static final Logger LOG = LoggerFactory.getLogger(LocalAuthenticatorConfig.class);
 
     @XmlElement(name = "Name")
     protected String name;
@@ -63,6 +68,12 @@
     @XmlElement(name = "Tags")
     protected String[] tags;
 
+    @XmlElement(name = "DefinedBy")
+    protected DefinedByType definedByType;
+
+    @XmlElement(name = "AuthenticationType")
+    protected AuthenticationType authenticationType;
+
     public static FederatedAuthenticatorConfig build(OMElement federatedAuthenticatorConfigOM) {
 
         if (federatedAuthenticatorConfigOM == null) {
@@ -101,9 +112,17 @@
                     Property[] propertiesArr = propertiesArrList.toArray(new Property[propertiesArrList.size()]);
                     federatedAuthenticatorConfig.setProperties(propertiesArr);
                 }
+            } else if ("DefinedBy".equals(elementName)) {
+                federatedAuthenticatorConfig.setDefinedByType(
+                        DefinedByType.valueOf(element.getText()));
             }
         }
 
+        if (federatedAuthenticatorConfig.getDefinedByType() == null) {
+            federatedAuthenticatorConfig.setDefinedByType(DefinedByType.SYSTEM);
+        }
+        federatedAuthenticatorConfig.setAuthenticationType(AuthenticationType.IDENTIFICATION);
+
         return federatedAuthenticatorConfig;
     }
 
@@ -230,4 +249,44 @@
 
         tags = tagList;
     }
+
+    /**
+     * Get the defined by type of the federated authenticator config.
+     *
+     * @return DefinedByType
+     */
+    public DefinedByType getDefinedByType() {
+
+        return definedByType;
+    }
+
+    /**
+     * Set the defined by type of the federated authenticator config.
+     *
+     * @param type The defined by type of the authenticator config.
+     */
+    public void setDefinedByType(DefinedByType type) {
+
+        definedByType = type;
+    }
+
+    /**
+     * Get the authentication type of the federated authenticator config.
+     *
+     * @return AuthenticationType
+     */
+    public AuthenticationType getAuthenticationType() {
+
+        return authenticationType;
+    }
+
+    /**
+     * Set the authentication type of the federated authenticator config.
+     *
+     * @param type  The authentication type.
+     */
+    public void setAuthenticationType(AuthenticationType type) {
+
+        authenticationType = type;
+    }
 }

components/application-mgt/org.wso2.carbon.identity.application.common/src/main/java/org/wso2/carbon/identity/application/common/model/LocalAuthenticatorConfig.java

@@ -22,6 +22,10 @@
 import org.apache.axiom.om.OMElement;
 import org.apache.commons.collections.CollectionUtils;
 import org.apache.commons.lang.StringUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.wso2.carbon.identity.base.AuthenticatorPropertiesConstant.AuthenticationType;
+import org.wso2.carbon.identity.base.AuthenticatorPropertiesConstant.DefinedByType;
 import org.wso2.carbon.identity.base.IdentityConstants;
 
 import java.io.Serializable;
@@ -37,6 +41,8 @@
 import javax.xml.bind.annotation.XmlElementWrapper;
 import javax.xml.bind.annotation.XmlRootElement;
 
+import static org.wso2.carbon.identity.base.IdentityConstants.TAG_2FA;
+
 /**
  * Local authenticator configuration of an application.
  */
@@ -46,6 +52,7 @@
 public class LocalAuthenticatorConfig implements Serializable {
 
     private static final long serialVersionUID = 3363298518257599291L;
+    private static final Logger LOG = LoggerFactory.getLogger(LocalAuthenticatorConfig.class);
 
     @XmlElement(name = "Name")
     protected String name;
@@ -63,6 +70,12 @@
     @XmlElement(name = "Tags")
     protected String[] tags;
 
+    @XmlElement(name = "DefinedBy")
+    protected DefinedByType definedByType;
+
+    @XmlElement(name = "AuthenticationType")
+    protected AuthenticationType authenticationType;
+
     /*
      * <LocalAuthenticatorConfig> <Name></Name> <DisplayName></DisplayName> <IsEnabled></IsEnabled>
      * <Properties></Properties> </LocalAuthenticatorConfig>
@@ -111,8 +124,31 @@
                     Property[] propertiesArr = propertiesArrList.toArray(new Property[0]);
                     localAuthenticatorConfig.setProperties(propertiesArr);
                 }
+            } else if ("DefinedBy".equals(member.getLocalName())) {
+                localAuthenticatorConfig.setDefinedByType(DefinedByType.valueOf(member.getText()));
+            } else if ("AuthenticationType".equals(member.getLocalName())) {
+                localAuthenticatorConfig.setAuthenticationType(
+                        AuthenticationType.valueOf(member.getText()));
+            }
+        }
+
+        if (localAuthenticatorConfig.getDefinedByType() == null) {
+            localAuthenticatorConfig.setDefinedByType(DefinedByType.SYSTEM);
+            LOG.debug("The defined by type is not set for the {}. Hence setting default SYSTEM value.",
+                    localAuthenticatorConfig.getName());
+        }
+        if (localAuthenticatorConfig.getAuthenticationType() == null && localAuthenticatorConfig.getTags() != null) {
+            if (localAuthenticatorConfig.getTags() != null &&
+                    Arrays.stream(localAuthenticatorConfig.getTags()).anyMatch(s -> s.equalsIgnoreCase(TAG_2FA))) {
+                localAuthenticatorConfig.setAuthenticationType(
+                        AuthenticationType.VERIFICATION_ONLY);
+            } else {
+                localAuthenticatorConfig.setAuthenticationType(AuthenticationType.IDENTIFICATION);
             }
+            LOG.debug("The defined by type is not set for the: {}. Hence setting value based on the factor for the: {}",
+                    localAuthenticatorConfig.getName(), localAuthenticatorConfig.getAuthenticationType().toString());
         }
+
         return localAuthenticatorConfig;
     }
 
@@ -224,4 +260,44 @@
 
         tags = tagList;
     }
+
+    /**
+     * Get the defined by type of the Local authenticator config.
+     *
+     * @return DefinedByType
+     */
+    public DefinedByType getDefinedByType() {
+
+        return definedByType;
+    }
+
+    /**
+     * Set the defined by type of the Local authenticator config.
+     *
+     * @param type The defined by type of the authenticator config.
+     */
+    public void setDefinedByType(DefinedByType type) {
+
+        definedByType = type;
+    }
+
+    /**
+     * Get the authentication type of the Local authenticator config .
+     *
+     * @return AuthenticationType
+     */
+    public AuthenticationType getAuthenticationType() {
+
+        return authenticationType;
+    }
+
+    /**
+     * Set the authentication type of the Local authenticator config.
+     *
+     * @param type  The authentication type.
+     */
+    public void setAuthenticationType(AuthenticationType type) {
+
+        authenticationType = type;
+    }
 }

components/application-mgt/org.wso2.carbon.identity.application.common/src/main/java/org/wso2/carbon/identity/application/common/model/RequestPathAuthenticatorConfig.java

@@ -20,6 +20,8 @@
 
 import org.apache.axiom.om.OMElement;
 import org.apache.commons.collections.CollectionUtils;
+import org.wso2.carbon.identity.base.AuthenticatorPropertiesConstant.AuthenticationType;
+import org.wso2.carbon.identity.base.AuthenticatorPropertiesConstant.DefinedByType;
 
 import java.util.ArrayList;
 import java.util.Iterator;
@@ -74,6 +76,10 @@
                 }
             }
         }
+
+        requestPathAuthenticatorConfig.setAuthenticationType(AuthenticationType.REQUEST_PATH);
+        requestPathAuthenticatorConfig.setDefinedByType(DefinedByType.SYSTEM);
+
         return requestPathAuthenticatorConfig;
     }
 

components/application-mgt/org.wso2.carbon.identity.application.mgt/src/main/java/org/wso2/carbon/identity/application/mgt/ApplicationConstants.java

@@ -50,6 +50,8 @@ private ApplicationConstants() {
     public static final String IDP_NAME = "idpName";
     public static final String IDP_AUTHENTICATOR_NAME = "authenticatorName";
     public static final String IDP_AUTHENTICATOR_DISPLAY_NAME = "authenticatorDisplayName";
+    public static final String IDP_AUTHENTICATOR_DEFINED_BY_TYPE = "definedByType";
+    public static final String IDP_AUTHENTICATOR_AUTHENTICATION_TYPE = "authenticationType";
     public static final String APPLICATION_DOMAIN = "Application";
     // Regex for validating application name.
     public static final String APP_NAME_VALIDATING_REGEX = "^[a-zA-Z0-9 ._-]*$";

components/application-mgt/org.wso2.carbon.identity.application.mgt/src/main/java/org/wso2/carbon/identity/application/mgt/dao/impl/ApplicationDAOImpl.java

@@ -77,6 +77,8 @@
 import org.wso2.carbon.identity.application.mgt.dao.PaginatableFilterableApplicationDAO;
 import org.wso2.carbon.identity.application.mgt.internal.ApplicationManagementServiceComponent;
 import org.wso2.carbon.identity.application.mgt.internal.ApplicationManagementServiceComponentHolder;
+import org.wso2.carbon.identity.base.AuthenticatorPropertiesConstant.AuthenticationType;
+import org.wso2.carbon.identity.base.AuthenticatorPropertiesConstant.DefinedByType;
 import org.wso2.carbon.identity.base.IdentityException;
 import org.wso2.carbon.identity.base.IdentityRuntimeException;
 import org.wso2.carbon.identity.core.CertificateRetrievingException;
@@ -1566,6 +1568,13 @@
                                         ApplicationConstants.LOCAL_IDP_NAME,
                                         lclAuthenticator.getName(),
                                         lclAuthenticator.getDisplayName());
+                            } else {
+                                /* On demand migration for already saved local authenticators to save definedBy and
+                                 authenticationType properties to the database.
+                                 Remove this else block, once on-demand migration is done.*/
+                                log.debug("Authenticator already exists. Updating the authenticator.The defined "
+                                            + "by type is set to: " + lclAuthenticator.getDefinedByType().toString());
+                                //TODO: Update database with defined by properties for local authenticators.
                             }
                             if (authenticatorId > 0) {
                                 // ID, TENANT_ID, AUTHENTICATOR_ID
@@ -3088,6 +3097,10 @@
                             .get(ApplicationConstants.IDP_AUTHENTICATOR_NAME));
                     localAuthenticator.setDisplayName(authenticatorInfo
                             .get(ApplicationConstants.IDP_AUTHENTICATOR_DISPLAY_NAME));
+                    localAuthenticator.setDefinedByType(DefinedByType.valueOf(
+                            authenticatorInfo.get(ApplicationConstants.IDP_AUTHENTICATOR_DEFINED_BY_TYPE)));
+                    localAuthenticator.setAuthenticationType(AuthenticationType.valueOf(
+                            authenticatorInfo.get(ApplicationConstants.IDP_AUTHENTICATOR_AUTHENTICATION_TYPE)));
                     stepLocalAuth.get(step).add(localAuthenticator);
                 } else {
                     Map<String, List<FederatedAuthenticatorConfig>> stepFedIdps = stepFedIdPAuthenticators
@@ -3106,6 +3119,9 @@
                             .get(ApplicationConstants.IDP_AUTHENTICATOR_NAME));
                     fedAuthenticator.setDisplayName(authenticatorInfo
                             .get(ApplicationConstants.IDP_AUTHENTICATOR_DISPLAY_NAME));
+                    fedAuthenticator.setDefinedByType(DefinedByType.valueOf(
+                            authenticatorInfo.get(ApplicationConstants.IDP_AUTHENTICATOR_DEFINED_BY_TYPE)));
+                    fedAuthenticator.setAuthenticationType(AuthenticationType.IDENTIFICATION);
                     idpAuths.add(fedAuthenticator);
                 }
 
@@ -5017,6 +5033,11 @@
                 returnData
                         .put(ApplicationConstants.IDP_AUTHENTICATOR_DISPLAY_NAME, rs.getString(3));
             }
+            // TODO: Read from database and set the DefinedBy and authenticationType properties to the authenticator.
+            returnData.put(ApplicationConstants.IDP_AUTHENTICATOR_DEFINED_BY_TYPE,
+                    DefinedByType.SYSTEM.toString());
+            returnData.put(ApplicationConstants.IDP_AUTHENTICATOR_AUTHENTICATION_TYPE,
+                    AuthenticationType.IDENTIFICATION.toString());
         } finally {
             IdentityApplicationManagementUtil.closeStatement(prepStmt);
         }
@@ -5038,7 +5059,7 @@
         int authenticatorId = -1;
         PreparedStatement prepStmt = null;
         ResultSet rs = null;
-        // TENANT_ID, IDP_ID, NAME,IS_ENABLED, DISPLAY_NAME
+        // TENANT_ID, IDP_ID, NAME,IS_ENABLED, DISPLAY_NAME, DEFINED_BY
         String sqlStmt = ApplicationMgtDBQueries.STORE_LOCAL_AUTHENTICATOR;
         try {
             String dbProductName = conn.getMetaData().getDatabaseProductName();
@@ -5050,6 +5071,8 @@
             prepStmt.setString(4, authenticatorName);
             prepStmt.setString(5, "1");
             prepStmt.setString(6, authenticatorDispalyName);
+            //TODO: prepStmt.setString(7, DefinedByType.SYSTEM.toString());
+            //TODO: prepStmt.setString(8, AuthenticationType.<TYPE>.toString());
             prepStmt.execute();
             rs = prepStmt.getGeneratedKeys();
             if (rs.next()) {