org.apereo.cas.syncope.SyncopeUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cas-server-support-syncope-authentication Show documentation
Show all versions of cas-server-support-syncope-authentication Show documentation
cas-server-support-syncope-authentication
package org.apereo.cas.syncope;
import org.apereo.cas.authentication.credential.UsernamePasswordCredential;
import org.apereo.cas.authentication.principal.Principal;
import org.apereo.cas.configuration.model.support.syncope.BaseSyncopeSearchProperties;
import org.apereo.cas.util.CollectionUtils;
import org.apereo.cas.util.EncodingUtils;
import org.apereo.cas.util.function.FunctionUtils;
import org.apereo.cas.util.http.HttpExecutionRequest;
import org.apereo.cas.util.http.HttpUtils;
import org.apereo.cas.util.serialization.JacksonObjectMapperFactory;
import org.apereo.cas.util.spring.SpringExpressionLanguageValueResolver;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.experimental.UtilityClass;
import lombok.extern.slf4j.Slf4j;
import lombok.val;
import org.apache.commons.lang3.StringUtils;
import org.apache.hc.core5.http.HttpEntityContainer;
import org.apache.hc.core5.http.HttpResponse;
import org.apache.hc.core5.http.io.entity.EntityUtils;
import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Spliterator;
import java.util.Spliterators;
import java.util.stream.Collectors;
import java.util.stream.StreamSupport;
/**
* This is {@link SyncopeUtils}.
*
* @author Francesco Chicchiriccò
* @since 6.5.0
*/
@UtilityClass
@Slf4j
public class SyncopeUtils {
private static final ObjectMapper MAPPER =
JacksonObjectMapperFactory.builder().defaultTypingEnabled(false).build().toObjectMapper();
/**
* Convert user as a JSON node into a map of details.
*
* @param user the user
* @param attributeMappings the attribute mappings
* @return the map
*/
public static Map> convertFromUserEntity(final JsonNode user,
final Map attributeMappings) {
val attributes = new HashMap>();
if (user.has("securityQuestion") && !user.get("securityQuestion").isNull()) {
var name = attributeMappings.getOrDefault("securityQuestion", "syncopeUserSecurityQuestion");
attributes.put(name, CollectionUtils.wrapList(user.get("securityQuestion").asText()));
}
var name = attributeMappings.getOrDefault("key", "syncopeUserKey");
attributes.put(name, CollectionUtils.wrapList(user.get("key").asText()));
name = attributeMappings.getOrDefault("username", "username");
attributes.put(name, CollectionUtils.wrapList(user.get("username").asText()));
name = attributeMappings.getOrDefault("status", "syncopeUserStatus");
attributes.put(name, CollectionUtils.wrapList(user.get("status").asText()));
name = attributeMappings.getOrDefault("realm", "syncopeUserRealm");
attributes.put(name, CollectionUtils.wrapList(user.get("realm").asText()));
name = attributeMappings.getOrDefault("creator", "syncopeUserCreator");
attributes.put(name, CollectionUtils.wrapList(user.get("creator").asText()));
name = attributeMappings.getOrDefault("creationDate", "syncopeUserCreationDate");
attributes.put(name, CollectionUtils.wrapList(user.get("creationDate").asText()));
if (user.has("changePwdDate") && !user.get("changePwdDate").isNull()) {
name = attributeMappings.getOrDefault("changePwdDate", "syncopeUserChangePwdDate");
attributes.put(name, CollectionUtils.wrapList(user.get("changePwdDate").asText()));
}
if (user.has("lastLoginDate") && !user.get("lastLoginDate").isNull()) {
name = attributeMappings.getOrDefault("lastLoginDate", "syncopeUserLastLoginDate");
attributes.put(name, CollectionUtils.wrapList(user.get("lastLoginDate").asText()));
}
collectListableAttribute(attributes, user, "roles", "syncopeUserRoles", attributeMappings);
collectListableAttribute(attributes, user, "dynRoles", "syncopeUserDynRoles", attributeMappings);
collectListableAttribute(attributes, user, "dynRealms", "syncopeUserDynRealms", attributeMappings);
if (user.has("memberships")) {
val memberships = new ArrayList<>();
user.get("memberships").forEach(member -> memberships.add(member.get("groupName").asText()));
if (!memberships.isEmpty()) {
name = attributeMappings.getOrDefault("memberships", "syncopeUserMemberships");
attributes.put(name, memberships);
}
}
if (user.has("dynMemberships")) {
val dynMemberships = new ArrayList<>();
user.get("dynMemberships").forEach(m -> dynMemberships.add(m.get("groupName").asText()));
if (!dynMemberships.isEmpty()) {
name = attributeMappings.getOrDefault("dynMemberships", "syncopeUserDynMemberships");
attributes.put(name, dynMemberships);
}
}
if (user.has("relationships")) {
val relationships = new ArrayList<>();
user.get("relationships").forEach(
r -> relationships.add(r.get("type").asText() + ';' + r.get("otherEndName").asText()));
if (!relationships.isEmpty()) {
name = attributeMappings.getOrDefault("relationships", "syncopeUserRelationships");
attributes.put(name, relationships);
}
}
mapSyncopeUserAttributes(user, "plainAttrs", attributeMappings, attributes);
mapSyncopeUserAttributes(user, "derAttrs", attributeMappings, attributes);
mapSyncopeUserAttributes(user, "virAttrs", attributeMappings, attributes);
return attributes;
}
private void mapSyncopeUserAttributes(final JsonNode user, final String attributeName,
final Map attributeMappings,
final Map> attributes) {
if (user.has(attributeName)) {
val prefix = attributeMappings.getOrDefault(attributeName, "syncopeUserAttr_");
user.get(attributeName).forEach(attr -> {
val attrName = prefix + attr.get("schema").asText();
attributes.put(
attributeMappings.getOrDefault(attrName, attrName),
MAPPER.convertValue(attr.get("values"), ArrayList.class));
});
}
}
private void collectListableAttribute(final Map> attributes,
final JsonNode user, final String syncopeAttribute,
final String casAttribute,
final Map attributeMappings) {
val values = user.has(syncopeAttribute)
? MAPPER.convertValue(user.get(syncopeAttribute), ArrayList.class)
: CollectionUtils.wrapList();
if (!values.isEmpty()) {
val name = attributeMappings.getOrDefault(syncopeAttribute, casAttribute);
attributes.put(name, values);
}
}
/**
* Syncope search.
*
* @param properties the properties
* @param user the user
* @return the optional
*/
public static List>> syncopeUserSearch(final BaseSyncopeSearchProperties properties, final String user) {
HttpResponse response = null;
try {
val filter = properties.getSearchFilter().replace("{user}", user).replace("{0}", user);
val fiql = EncodingUtils.urlEncode(filter);
val syncopeRestUrl = StringUtils.appendIfMissing(SpringExpressionLanguageValueResolver.getInstance().resolve(properties.getUrl()), "/")
+ "rest/users/?page=1&size=1&details=true&fiql=" + fiql;
LOGGER.debug("Executing Syncope search via [{}]", syncopeRestUrl);
val requestHeaders = new LinkedHashMap();
requestHeaders.put("X-Syncope-Domain", properties.getDomain());
requestHeaders.putAll(properties.getHeaders());
val exec = HttpExecutionRequest.builder()
.method(HttpMethod.GET)
.url(syncopeRestUrl)
.basicAuthUsername(properties.getBasicAuthUsername())
.basicAuthPassword(properties.getBasicAuthPassword())
.headers(requestHeaders)
.build();
response = Objects.requireNonNull(HttpUtils.execute(exec));
LOGGER.debug("Received http response status as [{}]", response.getReasonPhrase());
if (HttpStatus.resolve(response.getCode()).is2xxSuccessful()) {
val entity = ((HttpEntityContainer) response).getEntity();
return FunctionUtils.doUnchecked(() -> {
val result = EntityUtils.toString(entity);
LOGGER.debug("Received user entity as [{}]", result);
val it = Optional.of(MAPPER.readTree(result))
.filter(sr -> sr.has("result"))
.map(sr -> sr.get("result"))
.map(JsonNode::iterator)
.orElse(Collections.emptyIterator());
return StreamSupport.stream(Spliterators.spliteratorUnknownSize(it, Spliterator.ORDERED), false)
.map(node -> SyncopeUtils.convertFromUserEntity(node, properties.getAttributeMappings()))
.collect(Collectors.toList());
});
}
} finally {
HttpUtils.close(response);
}
return new ArrayList<>();
}
/**
* Convert to user create entity map.
*
* @param principal the principal
* @param realm the realm
* @return the map
*/
public static Map convertToUserCreateEntity(final Principal principal, final String realm) {
val entity = new LinkedHashMap();
entity.put("_class", "org.apache.syncope.common.lib.request.UserCR");
entity.put("realm", StringUtils.prependIfMissing(realm, "/"));
entity.put("username", principal.getId());
val plainAttrs = new ArrayList>();
principal.getAttributes()
.entrySet()
.stream()
.filter(entry -> !"username".equals(entry.getKey()) && !"password".equals(entry.getKey()))
.forEach(entry -> plainAttrs.add(Map.of("schema", entry.getKey(), "values", CollectionUtils.toCollection(entry.getValue()))));
entity.put("plainAttrs", plainAttrs);
return entity;
}
/**
* Convert to user create entity map.
*
* @param userProperties the user properties
* @param credential the credential
* @param realm the realm
* @return the map
*/
public static Map convertToUserCreateEntity(final Map userProperties,
final UsernamePasswordCredential credential,
final String realm) {
val entity = new LinkedHashMap();
entity.put("_class", "org.apache.syncope.common.lib.request.UserCR");
entity.put("realm", StringUtils.prependIfMissing(realm, "/"));
entity.put("username", credential.getUsername());
entity.put("password", credential.getPassword());
val plainAttrs = new ArrayList>();
userProperties
.entrySet()
.stream()
.filter(entry -> !"username".equals(entry.getKey()) && !"password".equals(entry.getKey()))
.forEach(entry -> plainAttrs.add(Map.of("schema", entry.getKey(), "values", CollectionUtils.toCollection(entry.getValue()))));
entity.put("plainAttrs", plainAttrs);
return entity;
}
/**
* Convert to user update entity map.
*
* @param realm the realm
* @return the map
*/
public static Map convertToUserUpdateEntity(final Principal principal,
final String realm) {
val entity = new LinkedHashMap();
entity.put("_class", "org.apache.syncope.common.lib.request.UserUR");
entity.put("key", principal.getId());
entity.put("realm", Map.of("operation", "ADD_REPLACE", "value", realm));
val plainAttrs = new ArrayList>();
principal.getAttributes()
.entrySet()
.stream()
.filter(entry -> !"username".equals(entry.getKey()) && !"password".equals(entry.getKey()))
.forEach(entry -> {
val attribute = Map.of("operation", "ADD_REPLACE",
"attr", Map.of("schema", entry.getKey(), "values", CollectionUtils.toCollection(entry.getValue())));
plainAttrs.add(attribute);
});
entity.put("plainAttrs", plainAttrs);
return entity;
}
}