Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature remove registry SAML #6197

Closed
wants to merge 16 commits into from
Closed

Feature remove registry SAML #6197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
bd8feb5
Create interface SAMLSSOServiceProviderDAORegistryImpl
hwupathum Jun 15, 2023
a918b3f
Create database implementation of SAML configs
hwupathum Jun 15, 2023
da638f4
Update SAMLSSOServiceProviderDAOImpl and SAMLSSOServiceProviderConsta…
Osara-B Aug 26, 2024
2520be6
Add ability to switch SAML storage type via config
Osara-B Sep 18, 2024
81cbc56
Update code to use new database schema
Osara-B Oct 3, 2024
319fff6
Refactor Code
Osara-B Oct 23, 2024
49e0179
Update code to use Named JDBC Templates
Osara-B Oct 30, 2024
1b24d81
Add SIGN_ASSERTIONS property to IDN_SAML2_SERVICE_PROVIDER table
Osara-B Nov 7, 2024
c67895f
Add unit tests for SAMLSSOServiceProviderManager JDBC Implementation
Osara-B Nov 27, 2024
dc1635e
Update uploadServiceProvider in SAMLSSOServiceProviderDAOImpl.java
Osara-B Dec 10, 2024
60ee2d3
Add IDN_SAML2_SERVICE_PROVIDER and IDN_SAML2_SP_PROPERTIES
Osara-B Dec 17, 2024
59aab15
Address review comments
Osara-B Dec 17, 2024
95929a8
Add SAMLSSOPersistenceManagerFactory class and refactor code
Osara-B Dec 18, 2024
b2e7bdf
Add tests for SAMLSSOPersistenceManagerFactory
Osara-B Dec 19, 2024
c3c0587
Add VERSION, CREATED_AT, UPDATED_AT columns for IDN_SAML2_SERVICE_PRO…
Osara-B Dec 19, 2024
4b9f7e5
Address review comments
Osara-B Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions components/identity-core/org.wso2.carbon.identity.core/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,11 @@
<groupId>xml-apis</groupId>
<artifactId>xml-apis</artifactId>
</dependency>
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<scope>test</scope>
</dependency>
</dependencies>

<build>
Expand Down
109 changes: 26 additions & 83 deletions ...ntity.core/src/main/java/org/wso2/carbon/identity/core/SAMLSSOServiceProviderManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,173 +18,116 @@

package org.wso2.carbon.identity.core;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.wso2.carbon.identity.base.IdentityException;
import org.wso2.carbon.identity.core.dao.SAMLSSOPersistenceManagerFactory;
import org.wso2.carbon.identity.core.dao.SAMLSSOServiceProviderDAO;
import org.wso2.carbon.identity.core.model.SAMLSSOServiceProviderDO;
import org.wso2.carbon.identity.core.util.IdentityTenantUtil;
import org.wso2.carbon.registry.api.RegistryException;
import org.wso2.carbon.registry.core.Registry;

/**
* This class is used for managing SAML SSO providers. Adding, retrieving and removing service
* providers are supported here.
*/
public class SAMLSSOServiceProviderManager {

private static final Log LOG = LogFactory.getLog(SAMLSSOServiceProviderManager.class);

/**
* Build the SAML service provider.
*
* @param tenantId Tenant ID.
* @return SAML service provider.
*/
private SAMLSSOServiceProviderDAO buildSAMLSSOProvider(int tenantId) throws RegistryException {

Registry registry = IdentityTenantUtil.getRegistryService().getConfigSystemRegistry(tenantId);
return new SAMLSSOServiceProviderDAO(registry);
}

SAMLSSOPersistenceManagerFactory samlSSOPersistenceManagerFactory = new SAMLSSOPersistenceManagerFactory();
SAMLSSOServiceProviderDAO serviceProviderDAO = samlSSOPersistenceManagerFactory.buildSSOServiceProviderManager();

/**
* Add a saml service provider.
*
* @param serviceProviderDO Service provider information object.
* @param tenantId Tenant ID.
* @param serviceProviderDO Service provider information object.
* @param tenantId Tenant ID.
* @return True if success.
* @throws IdentityException Error when adding the SAML service provider.
*/
public boolean addServiceProvider(SAMLSSOServiceProviderDO serviceProviderDO, int tenantId)
throws IdentityException {

try {
SAMLSSOServiceProviderDAO serviceProviderDAO = buildSAMLSSOProvider(tenantId);
return serviceProviderDAO.addServiceProvider(serviceProviderDO);
} catch (RegistryException e) {
LOG.error("Error while adding service provider", e);
throw new IdentityException("Error while retrieving registry", e);
}
return serviceProviderDAO.addServiceProvider(serviceProviderDO, tenantId);
}

/**
* Update a saml service provider if already exists.
*
* @param serviceProviderDO Service provider information object.
* @param currentIssuer Issuer of the service provider before the update.
* @param tenantId Tenant ID.
* @param serviceProviderDO Service provider information object.
* @param currentIssuer Issuer of the service provider before the update.
* @param tenantId Tenant ID.
* @return True if success.
* @throws IdentityException Error when updating the SAML service provider.
*/
public boolean updateServiceProvider(SAMLSSOServiceProviderDO serviceProviderDO, String currentIssuer, int tenantId)
throws IdentityException {

try {
SAMLSSOServiceProviderDAO serviceProviderDAO = buildSAMLSSOProvider(tenantId);
return serviceProviderDAO.updateServiceProvider(serviceProviderDO, currentIssuer);
} catch (RegistryException e) {
LOG.error("Error while updating service provider", e);
throw new IdentityException("Error while retrieving registry", e);
}
return serviceProviderDAO.updateServiceProvider(serviceProviderDO, currentIssuer, tenantId);
}

/**
* Get all the saml service providers.
*
* @param tenantId Tenant ID.
* @param tenantId Tenant ID.
* @return Array of SAMLSSOServiceProviderDO.
* @throws IdentityException Error when getting the SAML service providers.
*/
public SAMLSSOServiceProviderDO[] getServiceProviders(int tenantId)
throws IdentityException {

try {
SAMLSSOServiceProviderDAO serviceProviderDOA = buildSAMLSSOProvider(tenantId);
return serviceProviderDOA.getServiceProviders();
} catch (RegistryException e) {
LOG.error("Error while getting service providers", e);
throw new IdentityException("Error while retrieving registry", e);
}
return serviceProviderDAO.getServiceProviders(tenantId);
}

/**
* Get SAML issuer properties from service provider by saml issuer name.
*
* @param issuer SAML issuer name.
* @param tenantId Tenant ID.
* @param issuer SAML issuer name.
* @param tenantId Tenant ID.
* @return SAMLSSOServiceProviderDO
* @throws IdentityException Error when getting the SAML service provider.
*/
public SAMLSSOServiceProviderDO getServiceProvider(String issuer, int tenantId)
throws IdentityException {

try {
SAMLSSOServiceProviderDAO serviceProviderDAO = buildSAMLSSOProvider(tenantId);
return serviceProviderDAO.getServiceProvider(issuer);
} catch (RegistryException e) {
LOG.error("Error while getting service provider", e);
throw new IdentityException("Error while retrieving SAML issuer " + e.getMessage());
}
return serviceProviderDAO.getServiceProvider(issuer, tenantId);

}

/**
* Check whether SAML issuer exists by saml issuer name.
*
* @param issuer SAML issuer name.
* @param tenantId Tenant ID.
* @param issuer SAML issuer name.
* @param tenantId Tenant ID.
* @return True if exists
* @throws IdentityException Error when checking the SAML service provider.
*/
public boolean isServiceProviderExists(String issuer, int tenantId)
throws IdentityException {

try {
SAMLSSOServiceProviderDAO serviceProviderDAO = buildSAMLSSOProvider(tenantId);
return serviceProviderDAO.isServiceProviderExists(issuer);
} catch (RegistryException e) {
LOG.error("Error while getting service provider", e);
throw new IdentityException("Error while retrieving SAML issuer " + e.getMessage());
}
return serviceProviderDAO.isServiceProviderExists(issuer, tenantId);
}

/**
* Removes the SAML configuration related to the application, idenfied by the issuer.
*
* @param issuer Issuer of the SAML application.
* @param tenantId Tenant ID.
* @param issuer Issuer of the SAML application.
* @param tenantId Tenant ID.
* @throws IdentityException Error when removing the SAML configuration.
*/
public boolean removeServiceProvider(String issuer, int tenantId)
throws IdentityException {

try {
SAMLSSOServiceProviderDAO serviceProviderDAO = buildSAMLSSOProvider(tenantId);
return serviceProviderDAO.removeServiceProvider(issuer);
} catch (RegistryException e) {
LOG.error("Error while removing service provider", e);
throw new IdentityException("Error while deleting SAML issuer " + e.getMessage());
}
return serviceProviderDAO.removeServiceProvider(issuer, tenantId);
}

/**
* Upload the SAML configuration related to the application, using metadata.
*
* @param samlssoServiceProviderDO SAML service provider information object.
* @param tenantId Tenant ID.
* @param samlssoServiceProviderDO SAML service provider information object.
* @param tenantId Tenant ID.
* @return SAML service provider information object.
* @throws IdentityException Error when uploading the SAML configuration.
*/
public SAMLSSOServiceProviderDO uploadServiceProvider(SAMLSSOServiceProviderDO samlssoServiceProviderDO, int tenantId)
public SAMLSSOServiceProviderDO uploadServiceProvider(SAMLSSOServiceProviderDO samlssoServiceProviderDO,
int tenantId)
throws IdentityException {

try {
SAMLSSOServiceProviderDAO serviceProviderDAO = buildSAMLSSOProvider(tenantId);
return serviceProviderDAO.uploadServiceProvider(samlssoServiceProviderDO);
} catch (RegistryException e) {
LOG.error("Error while uploading service provider", e);
throw new IdentityException("Error while uploading SAML issuer " + e.getMessage());
}
return serviceProviderDAO.uploadServiceProvider(samlssoServiceProviderDO, tenantId);
}
}
Loading
Loading