Skip to content

Commit

Permalink
Add tags in the idp authenticator responses.
Browse files Browse the repository at this point in the history
  • Loading branch information
@Thisara-Welmilla
Thisara-Welmilla committed Dec 11, 2024
1 parent a25fe0f commit 97fc457
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 34 deletions.
26 changes: 2 additions & 24 deletions ...main/java/org/wso2/carbon/identity/api/server/idp/v1/core/ServerIdpManagementService.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2428,30 +2428,8 @@ private FederatedAuthenticatorListResponse createFederatedAuthenticatorResponse(

FederatedAuthenticatorConfig[] fedAuthConfigs = idp.getFederatedAuthenticatorConfigs();
FederatedAuthenticatorListResponse fedAuthIDPResponse = new FederatedAuthenticatorListResponse();
List<FederatedAuthenticatorListItem> authenticators = new ArrayList<>();
for (FederatedAuthenticatorConfig fedAuthConfig : fedAuthConfigs) {
FederatedAuthenticatorListItem fedAuthListItem = new FederatedAuthenticatorListItem();
fedAuthListItem.setAuthenticatorId(base64URLEncode(fedAuthConfig.getName()));
fedAuthListItem.setName(fedAuthConfig.getName());
fedAuthListItem.setIsEnabled(fedAuthConfig.isEnabled());
fedAuthListItem.setDefinedBy(FederatedAuthenticatorListItem.DefinedByEnum.valueOf(
fedAuthConfig.getDefinedByType().toString()));
FederatedAuthenticatorConfig federatedAuthenticatorConfig =
ApplicationAuthenticatorService.getInstance().getFederatedAuthenticatorByName(
fedAuthConfig.getName());
if (federatedAuthenticatorConfig != null) {
String[] tags = federatedAuthenticatorConfig.getTags();
if (ArrayUtils.isNotEmpty(tags)) {
fedAuthListItem.setTags(Arrays.asList(tags));
}
}
fedAuthListItem.setSelf(
ContextLoader.buildURIForBody(String.format(V1_API_PATH_COMPONENT + IDP_PATH_COMPONENT +
"/%s/federated-authenticators/%s", idp.getResourceId(),
base64URLEncode(fedAuthConfig.getName())))
.toString());
authenticators.add(fedAuthListItem);
}
List<FederatedAuthenticatorListItem> authenticators =
FederatedAuthenticatorConfigBuilderFactory.build(fedAuthConfigs, idp.getResourceId());
fedAuthIDPResponse.setDefaultAuthenticatorId(idp.getDefaultAuthenticatorConfig() != null ? base64URLEncode(idp
.getDefaultAuthenticatorConfig().getName()) : null);
fedAuthIDPResponse.setAuthenticators(authenticators);
Expand Down
67 changes: 57 additions & 10 deletions ...o2/carbon/identity/api/server/idp/v1/impl/FederatedAuthenticatorConfigBuilderFactory.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,13 @@

import org.apache.commons.lang.ArrayUtils;
import org.apache.commons.lang.StringUtils;
import org.wso2.carbon.identity.api.server.common.ContextLoader;
import org.wso2.carbon.identity.api.server.idp.common.Constants;
import org.wso2.carbon.identity.api.server.idp.common.IdentityProviderServiceHolder;
import org.wso2.carbon.identity.api.server.idp.v1.model.AuthenticationType;
import org.wso2.carbon.identity.api.server.idp.v1.model.Endpoint;
import org.wso2.carbon.identity.api.server.idp.v1.model.FederatedAuthenticator;
import org.wso2.carbon.identity.api.server.idp.v1.model.FederatedAuthenticatorListItem;
import org.wso2.carbon.identity.api.server.idp.v1.model.FederatedAuthenticatorPUTRequest;
import org.wso2.carbon.identity.application.common.ApplicationAuthenticatorService;
import org.wso2.carbon.identity.application.common.model.FederatedAuthenticatorConfig;
Expand All @@ -38,6 +40,7 @@
import org.wso2.carbon.idp.mgt.IdentityProviderManagementServerException;

import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Base64;
import java.util.List;
Expand All @@ -47,7 +50,10 @@
import java.util.function.Function;
import java.util.stream.Collectors;

import static org.wso2.carbon.identity.api.server.common.Constants.V1_API_PATH_COMPONENT;
import static org.wso2.carbon.identity.api.server.common.Util.base64URLEncode;
import static org.wso2.carbon.identity.api.server.idp.common.Constants.GOOGLE_PRIVATE_KEY;
import static org.wso2.carbon.identity.api.server.idp.common.Constants.IDP_PATH_COMPONENT;

/**
* The factory class for building federated authenticator configuration related models.
Expand Down Expand Up @@ -118,17 +124,10 @@ public static FederatedAuthenticator build(FederatedAuthenticatorConfig config)

federatedAuthenticator.setName(config.getName());
federatedAuthenticator.setIsEnabled(config.isEnabled());

FederatedAuthenticatorConfig federatedAuthenticatorConfig =
ApplicationAuthenticatorService.getInstance().getFederatedAuthenticatorByName(
config.getName());
if (federatedAuthenticatorConfig != null) {
String[] tags = federatedAuthenticatorConfig.getTags();
if (ArrayUtils.isNotEmpty(tags)) {
federatedAuthenticator.setTags(Arrays.asList(tags));
}
String[] tags = resolveAuthenticatorTags(config);
if (ArrayUtils.isNotEmpty(tags)) {
federatedAuthenticator.setTags(Arrays.asList(tags));
}

if (DefinedByType.SYSTEM == config.getDefinedByType()) {
federatedAuthenticator.setDefinedBy(FederatedAuthenticator.DefinedByEnum.SYSTEM);
List<org.wso2.carbon.identity.api.server.idp.v1.model.Property> properties =
Expand All @@ -141,6 +140,37 @@ public static FederatedAuthenticator build(FederatedAuthenticatorConfig config)

return federatedAuthenticator;
}

/**
* Builds a list of FederatedAuthenticatorListItem instances based on the given array of
* FederatedAuthenticatorConfig.
*
* @param fedAuthConfigs Array of FederatedAuthenticatorConfig instances.
* @return List of FederatedAuthenticatorListItem instances.
*/
public static List<FederatedAuthenticatorListItem> build(FederatedAuthenticatorConfig[] fedAuthConfigs,
String idpResourceId) {

List<FederatedAuthenticatorListItem> authenticators = new ArrayList<>();
for (FederatedAuthenticatorConfig config : fedAuthConfigs) {
FederatedAuthenticatorListItem authenticatorListItem = new FederatedAuthenticatorListItem();
authenticatorListItem.setAuthenticatorId(base64URLEncode(config.getName()));
authenticatorListItem.setName(config.getName());
authenticatorListItem.setIsEnabled(config.isEnabled());
authenticatorListItem.definedBy(FederatedAuthenticatorListItem.DefinedByEnum.valueOf(
config.getDefinedByType().toString()));
String[] tags = resolveAuthenticatorTags(config);
if (ArrayUtils.isNotEmpty(tags)) {
authenticatorListItem.setTags(Arrays.asList(tags));
}
authenticatorListItem.setSelf(ContextLoader.buildURIForBody(String.format(V1_API_PATH_COMPONENT +
IDP_PATH_COMPONENT + "/%s/federated-authenticators/%s", idpResourceId,
base64URLEncode(config.getName()))).toString());
authenticators.add(authenticatorListItem);
}

return authenticators;
}

private static FederatedAuthenticatorConfig createFederatedAuthenticatorConfig(Config config)
throws IdentityProviderManagementClientException {
Expand Down Expand Up @@ -435,6 +465,23 @@ private static void resolveEndpointConfiguration(FederatedAuthenticator authenti
}
}

private static String[] resolveAuthenticatorTags(FederatedAuthenticatorConfig config) {

/* If the authenticator is defined by the user, return the tags of the authenticator config. Otherwise, return
the tags of the system registered federated template.
*/
if (DefinedByType.USER == config.getDefinedByType()) {
return config.getTags();

}
FederatedAuthenticatorConfig federatedAuthenticatorConfig =
ApplicationAuthenticatorService.getInstance().getFederatedAuthenticatorByName(config.getName());
if (federatedAuthenticatorConfig != null) {
return federatedAuthenticatorConfig.getTags();
}
return new String[0];
}

/**
* Config class to build FederatedAuthenticatorConfig.
*/
Expand Down

0 comments on commit 97fc457

Please sign in to comment.