Add support for managing custom federated authenticators.

wso2 · Nov 5, 2024 · 855a182 · 855a182
1 parent 377dc85
commit 855a182
Show file tree

Hide file tree

Showing 8 changed files with 66 additions and 133 deletions.
diff --git a/components/application-mgt/org.wso2.carbon.identity.application.common/pom.xml b/components/application-mgt/org.wso2.carbon.identity.application.common/pom.xml
@@ -61,10 +61,6 @@
             <groupId>org.wso2.carbon.identity.framework</groupId>
             <artifactId>org.wso2.carbon.identity.central.log.mgt</artifactId>
         </dependency>
-        <dependency>
-            <groupId>org.wso2.carbon.identity.framework</groupId>
-            <artifactId>org.wso2.carbon.identity.action.management</artifactId>
-        </dependency>
     </dependencies>
 
     <build>

diff --git a/components/application-mgt/org.wso2.carbon.identity.application.common/spotbugs-exclude.xml b/components/application-mgt/org.wso2.carbon.identity.application.common/spotbugs-exclude.xml
diff --git a/...so2/carbon/identity/application/common/model/UserDefinedFederatedAuthenticatorConfig.java b/...so2/carbon/identity/application/common/model/UserDefinedFederatedAuthenticatorConfig.java
@@ -23,7 +23,7 @@
 import org.wso2.carbon.identity.base.AuthenticatorPropertyConstants.DefinedByType;
 
 /**
- * Verification authenticator configuration.
+ * The user defined federated authenticator configuration model.
  */
 public class UserDefinedFederatedAuthenticatorConfig extends FederatedAuthenticatorConfig {
 
@@ -43,7 +43,7 @@ public UserDefinedFederatedAuthenticatorConfig(AuthenticationType type) {
     }
 
     /**
-     * Get the endpoint config of the Local authenticator config.
+     * Get the endpoint config of the User defined federated authenticator config.
      *
      * @return DefinedByType
      */
@@ -53,9 +53,9 @@ public EndpointConfig getEndpointConfig() {
     }
 
     /**
-     * Set the defined by type of the Local authenticator config.
+     * Set the defined by type of the User defined federated authenticator config.
      *
-     * @param endpointConfig    The endpoint config of the local authenticator config.
+     * @param endpointConfig    The endpoint config of the User defined federated authenticator config.
      */
     public void setEndpointConfig(EndpointConfig endpointConfig) {
 

diff --git a/components/application-mgt/spotbugs-exclude.xml b/components/application-mgt/spotbugs-exclude.xml
diff --git a/...t/org.wso2.carbon.idp.mgt/src/main/java/org/wso2/carbon/idp/mgt/dao/IdPManagementDAO.java b/...t/org.wso2.carbon.idp.mgt/src/main/java/org/wso2/carbon/idp/mgt/dao/IdPManagementDAO.java
@@ -126,7 +126,7 @@
 public class IdPManagementDAO {
 
     private static final Log log = LogFactory.getLog(IdPManagementDAO.class);
-    private final IdPSecretsProcessor idpSecretsProcessorService = new IdPSecretsProcessor();;
+    private final IdPSecretsProcessor idpSecretsProcessorService = new IdPSecretsProcessor();
 
     private static final String OPENID_IDP_ENTITY_ID = "IdPEntityId";
     private static final String ENABLE_SMS_OTP_IF_RECOVERY_NOTIFICATION_ENABLED
@@ -3985,13 +3985,15 @@ public String addIdPWithResourceId(IdentityProvider identityProvider, int tenant
             throw new IdentityProviderManagementException("An error occurred while processing content stream.", e);
         } catch (SQLException e) {
             IdentityDatabaseUtil.rollbackTransaction(dbConnection);
-            endpointConfigurationManager.deleteEndpointConfigurations(identityProvider.getDefaultAuthenticatorConfig(),
-                    tenantId);
+            if (identityProvider.getFederatedAuthenticatorConfigs().length == 1) {
+                endpointConfigurationManager.deleteEndpointConfigurations(
+                        identityProvider.getFederatedAuthenticatorConfigs()[0], tenantId);
+            }
             throw new IdentityProviderManagementException("Error occurred while adding Identity Provider for tenant "
                     + tenantId, e);
         } catch (IdentityProviderManagementException e) {
             if (ERROR_CODE_ASSOCIATED_ACTION_MGT.getCode().equals(e.getErrorCode())) {
-                IdentityDatabaseUtil.rollbackTransaction(dbConnection);;
+                IdentityDatabaseUtil.rollbackTransaction(dbConnection);
             }
             throw e;
         }
@@ -4315,13 +4317,17 @@ public void updateIdPWithResourceId(String resourceId, IdentityProvider
             throw new IdentityProviderManagementException("An error occurred while processing content stream.", e);
         } catch (SQLException e) {
             IdentityDatabaseUtil.rollbackTransaction(dbConnection);
-            endpointConfigurationManager.updateEndpointConfigurations(currentIdentityProvider
-                    .getDefaultAuthenticatorConfig(), newIdentityProvider.getDefaultAuthenticatorConfig(), tenantId);
+            //
+            if (currentIdentityProvider.getFederatedAuthenticatorConfigs().length == 1) {
+                endpointConfigurationManager.updateEndpointConfigurations(currentIdentityProvider
+                                .getFederatedAuthenticatorConfigs()[0], newIdentityProvider.getFederatedAuthenticatorConfigs()[0],
+                        tenantId);
+            }
             throw new IdentityProviderManagementException("Error occurred while updating Identity Provider " +
                     "information  for tenant " + tenantId, e);
         } catch (IdentityProviderManagementException e) {
             if (ERROR_CODE_ASSOCIATED_ACTION_MGT.getCode().equals(e.getErrorCode())) {
-                IdentityDatabaseUtil.rollbackTransaction(dbConnection);;
+                IdentityDatabaseUtil.rollbackTransaction(dbConnection);
             }
             throw e;
         } catch (ConnectorException e) {
@@ -4394,19 +4400,23 @@ public void deleteIdP(String idPName, int tenantId, String tenantDomain)
                 String msg = "Trying to delete non-existent Identity Provider: %s in tenantDomain: %s";
                 throw new IdentityProviderManagementException(String.format(msg, idPName, tenantDomain));
             }
-            endpointConfigurationManager.deleteEndpointConfigurations(identityProvider.getDefaultAuthenticatorConfig(),
-                    tenantId);
+            if (identityProvider.getFederatedAuthenticatorConfigs().length == 1) {
+                endpointConfigurationManager.deleteEndpointConfigurations(
+                        identityProvider.getFederatedAuthenticatorConfigs()[0], tenantId);
+            }
             deleteIdP(dbConnection, tenantId, idPName, null);
             IdentityDatabaseUtil.commitTransaction(dbConnection);
         } catch (SQLException e) {
             IdentityDatabaseUtil.rollbackTransaction(dbConnection);
-            endpointConfigurationManager.addEndpointConfigurations(identityProvider.getDefaultAuthenticatorConfig(),
-                    tenantId);
+            if (identityProvider.getFederatedAuthenticatorConfigs().length == 1) {
+                endpointConfigurationManager.addEndpointConfigurations(
+                        identityProvider.getFederatedAuthenticatorConfigs()[0], tenantId);
+            }
             throw new IdentityProviderManagementException("Error occurred while deleting Identity Provider of tenant "
                     + tenantDomain, e);
         } catch (IdentityProviderManagementException e) {
             if (ERROR_CODE_ASSOCIATED_ACTION_MGT.getCode().equals(e.getErrorCode())) {
-                IdentityDatabaseUtil.rollbackTransaction(dbConnection);;
+                IdentityDatabaseUtil.rollbackTransaction(dbConnection);
             }
             throw e;
         } finally {
@@ -4454,21 +4464,25 @@ public void deleteIdPByResourceId(String resourceId, int tenantId, String tenant
                 throw new IdentityProviderManagementException(String.format(msg, resourceId, tenantDomain));
             }
             idPName = identityProvider.getIdentityProviderName();
-            endpointConfigurationManager.deleteEndpointConfigurations(identityProvider.getDefaultAuthenticatorConfig(),
-                    tenantId);
+            if (identityProvider.getFederatedAuthenticatorConfigs().length == 1) {
+                endpointConfigurationManager.deleteEndpointConfigurations(
+                        identityProvider.getFederatedAuthenticatorConfigs()[0], tenantId);
+            }
             deleteIdP(dbConnection, tenantId, null, resourceId);
             // Delete IdP related secrets from the IDN_SECRET table.
             idpSecretsProcessorService.deleteAssociatedSecrets(identityProvider);
             IdentityDatabaseUtil.commitTransaction(dbConnection);
         } catch (SQLException e) {
             IdentityDatabaseUtil.rollbackTransaction(dbConnection);
-            endpointConfigurationManager.addEndpointConfigurations(identityProvider.getDefaultAuthenticatorConfig(),
-                    tenantId);
+            if (identityProvider.getFederatedAuthenticatorConfigs().length == 1) {
+                endpointConfigurationManager.addEndpointConfigurations(
+                        identityProvider.getFederatedAuthenticatorConfigs()[0], tenantId);
+            }
             throw new IdentityProviderManagementException("Error occurred while deleting Identity Provider of tenant "
                     + tenantDomain, e);
         } catch (IdentityProviderManagementException e) {
             if (ERROR_CODE_ASSOCIATED_ACTION_MGT.getCode().equals(e.getErrorCode())) {
-                IdentityDatabaseUtil.rollbackTransaction(dbConnection);;
+                IdentityDatabaseUtil.rollbackTransaction(dbConnection);
             }
             throw e;
         } catch (SecretManagementException e) {
@@ -4502,21 +4516,25 @@ public void forceDeleteIdP(String idPName,
                 log.debug(String.format("Deleting SP Provisioning Associations for IDP:%s of tenantDomain:%s",
                         idPName, tenantDomain));
             }
-            endpointConfigurationManager.deleteEndpointConfigurations(identityProvider.getDefaultAuthenticatorConfig(),
-                    tenantId);
+            if (identityProvider.getFederatedAuthenticatorConfigs().length == 1) {
+                endpointConfigurationManager.deleteEndpointConfigurations(
+                        identityProvider.getFederatedAuthenticatorConfigs()[0], tenantId);
+            }
             deleteIdpSpProvisioningAssociations(dbConnection, tenantId, idPName);
             deleteIdP(dbConnection, tenantId, idPName, null);
             IdentityDatabaseUtil.commitTransaction(dbConnection);
         } catch (SQLException e) {
             IdentityDatabaseUtil.rollbackTransaction(dbConnection);
-            endpointConfigurationManager.addEndpointConfigurations(identityProvider.getDefaultAuthenticatorConfig(),
-                    tenantId);
+            if (identityProvider.getFederatedAuthenticatorConfigs().length == 1) {
+                endpointConfigurationManager.addEndpointConfigurations(
+                        identityProvider.getFederatedAuthenticatorConfigs()[0], tenantId);
+            }
             throw new IdentityProviderManagementException(
                     String.format("Error occurred while deleting Identity Provider:%s of tenant:%s ",
                             idPName, tenantDomain), e);
         } catch (IdentityProviderManagementException e) {
             if (ERROR_CODE_ASSOCIATED_ACTION_MGT.getCode().equals(e.getErrorCode())) {
-                IdentityDatabaseUtil.rollbackTransaction(dbConnection);;
+                IdentityDatabaseUtil.rollbackTransaction(dbConnection);
             }
             throw e;
         } finally {
@@ -4549,20 +4567,24 @@ public void forceDeleteIdPByResourceId(String resourceId, int tenantId, String t
                         identityProvider.getIdentityProviderName(), tenantDomain));
             }
             deleteIdpSpProvisioningAssociations(dbConnection, tenantId, identityProvider.getIdentityProviderName());
-            endpointConfigurationManager.deleteEndpointConfigurations(identityProvider.getDefaultAuthenticatorConfig(),
-                    tenantId);
+            if (identityProvider.getFederatedAuthenticatorConfigs().length == 1) {
+                endpointConfigurationManager.deleteEndpointConfigurations(
+                        identityProvider.getFederatedAuthenticatorConfigs()[0], tenantId);
+            }
             deleteIdP(dbConnection, tenantId, null, resourceId);
             IdentityDatabaseUtil.commitTransaction(dbConnection);
         } catch (SQLException e) {
             IdentityDatabaseUtil.rollbackTransaction(dbConnection);
-            endpointConfigurationManager.addEndpointConfigurations(identityProvider.getDefaultAuthenticatorConfig(),
-                    tenantId);
+            if (identityProvider.getFederatedAuthenticatorConfigs().length == 1) {
+                endpointConfigurationManager.addEndpointConfigurations(
+                        identityProvider.getFederatedAuthenticatorConfigs()[0], tenantId);
+            }
             throw new IdentityProviderManagementException(
                     String.format("Error occurred while deleting Identity Provider with resource ID:%s of tenant:%s ",
                             resourceId, tenantDomain), e);
         } catch (IdentityProviderManagementException e) {
             if (ERROR_CODE_ASSOCIATED_ACTION_MGT.getCode().equals(e.getErrorCode())) {
-                IdentityDatabaseUtil.rollbackTransaction(dbConnection);;
+                IdentityDatabaseUtil.rollbackTransaction(dbConnection);
             }
             throw e;
         } finally {

diff --git a/....idp.mgt/src/main/java/org/wso2/carbon/idp/mgt/internal/IdpMgtServiceComponentHolder.java b/....idp.mgt/src/main/java/org/wso2/carbon/idp/mgt/internal/IdpMgtServiceComponentHolder.java
@@ -58,6 +58,7 @@ public static IdpMgtServiceComponentHolder getInstance() {
     private ClaimMetadataManagementService claimMetadataManagementService;
     private SecretManager secretManager;
     private SecretResolveManager  secretResolveManager;
+    private ActionManagementService actionManagementService;
 
     private List<MetadataConverter> metadataConverters = new ArrayList<>();
 
@@ -190,11 +191,21 @@ public void setClaimMetadataManagementService(ClaimMetadataManagementService cla
         this.claimMetadataManagementService = claimMetadataManagementService;
     }
 
+    /**
+     * Get the Action Management Service.
+     *
+     * @return ActionManagementService instance.
+     */
     public ActionManagementService getActionManagementService() {
 
         return actionManagementService;
     }
 
+    /**
+     * Set the Action Management Service.
+     *
+     * @param actionManagementService ActionManagementService instance.
+     */
     public void setActionManagementService(ActionManagementService actionManagementService) {
 
         this.actionManagementService = actionManagementService;

diff --git a/...src/main/java/org/wso2/carbon/idp/mgt/util/AuthenticatorEndpointConfigurationManager.java b/...src/main/java/org/wso2/carbon/idp/mgt/util/AuthenticatorEndpointConfigurationManager.java
@@ -163,7 +163,7 @@ public FederatedAuthenticatorConfig createFederatedAuthenticatorConfig(Authentic
         }
 
         return new UserDefinedFederatedAuthenticatorConfig(
-                AuthenticatorPropertyConstants.AuthenticationType.Identification);
+                AuthenticatorPropertyConstants.AuthenticationType.IDENTIFICATION);
     }
 
     private Action buildActionToCreate(String authenticatorName, EndpointConfig endpointConfig) {

diff --git a/...so2.carbon.idp.mgt/src/main/java/org/wso2/carbon/idp/mgt/util/IdPManagementConstants.java b/...so2.carbon.idp.mgt/src/main/java/org/wso2/carbon/idp/mgt/util/IdPManagementConstants.java
@@ -620,7 +620,7 @@ public enum ErrorMessage {
         ERROR_CODE_VALIDATING_OUTBOUND_PROVISIONING_ROLES("IDP-65008", "Error while validating " +
                 "the outbound provisioning roles"),
         ERROR_CODE_RETRIEVING_IDP_GROUPS("IDP-65009", "Error while retrieving IDP groups"),
-        ERROR_CODE_ASSOCIATED_ACTION_MGT("IDP-65010", "Error occurred with associated action management."),;
+        ERROR_CODE_ASSOCIATED_ACTION_MGT("IDP-65010", "Error occurred with managing associated action."),;
 
         private final String code;
         private final String message;