pl.edu.icm.unity.engine.identity.IdentityHelper Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2016 ICM Uniwersytet Warszawski All rights reserved.
 * See LICENCE.txt file for licensing information.
 */
package pl.edu.icm.unity.engine.identity;

import static java.lang.String.join;
import static pl.edu.icm.unity.base.audit.AuditEventTag.USERS;

import java.util.ArrayList;
import java.util.Date;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import com.google.common.collect.Sets;

import pl.edu.icm.unity.base.attribute.Attribute;
import pl.edu.icm.unity.base.attribute.AttributeExt;
import pl.edu.icm.unity.base.audit.AuditEventAction;
import pl.edu.icm.unity.base.audit.AuditEventType;
import pl.edu.icm.unity.base.entity.EntityInformation;
import pl.edu.icm.unity.base.entity.EntityParam;
import pl.edu.icm.unity.base.entity.EntityState;
import pl.edu.icm.unity.base.exceptions.EngineException;
import pl.edu.icm.unity.base.identity.Identity;
import pl.edu.icm.unity.base.identity.IdentityParam;
import pl.edu.icm.unity.base.identity.IllegalIdentityValueException;
import pl.edu.icm.unity.engine.api.authn.InvocationContext;
import pl.edu.icm.unity.engine.api.exceptions.IllegalTypeException;
import pl.edu.icm.unity.engine.api.group.IllegalGroupValueException;
import pl.edu.icm.unity.engine.api.identity.IdentityTypeDefinition;
import pl.edu.icm.unity.engine.api.identity.IdentityTypesRegistry;
import pl.edu.icm.unity.engine.attribute.AttributesHelper;
import pl.edu.icm.unity.engine.audit.AuditEventTrigger;
import pl.edu.icm.unity.engine.audit.AuditPublisher;
import pl.edu.icm.unity.engine.credential.EntityCredentialsHelper;
import pl.edu.icm.unity.engine.credential.SystemAllCredentialRequirements;
import pl.edu.icm.unity.engine.group.GroupHelper;
import pl.edu.icm.unity.store.api.AttributeDAO;
import pl.edu.icm.unity.store.api.EntityDAO;
import pl.edu.icm.unity.store.api.IdentityDAO;
import pl.edu.icm.unity.store.types.StoredAttribute;
import pl.edu.icm.unity.store.types.StoredIdentity;

/**
 * Shared code related to handling entities and identities
 * @author K. Benedyczak
 */
@Component
public class IdentityHelper
{
	private IdentityTypesRegistry idTypesRegistry;
	private EntityDAO entityDAO;
	private IdentityDAO identityDAO;
	private AttributeDAO attributeDAO;
	private IdentityTypeHelper idTypeHelper;
	private AttributesHelper attributeHelper;
	private GroupHelper groupHelper;
	private EntityCredentialsHelper credentialHelper;
	private AuditPublisher audit;

	
	@Autowired
	public IdentityHelper(IdentityTypesRegistry idTypesRegistry, EntityDAO entityDAO,
			IdentityDAO identityDAO, AttributeDAO attributeDAO, IdentityTypeHelper idTypeHelper,
			AttributesHelper attributeHelper, GroupHelper groupHelper,
			EntityCredentialsHelper credentialHelper, AuditPublisher audit)
	{
		this.idTypesRegistry = idTypesRegistry;
		this.entityDAO = entityDAO;
		this.identityDAO = identityDAO;
		this.attributeDAO = attributeDAO;
		this.idTypeHelper = idTypeHelper;
		this.attributeHelper = attributeHelper;
		this.groupHelper = groupHelper;
		this.credentialHelper = credentialHelper;
		this.audit = audit;
	}

	/**
	 * As {@link #getEntitiesBySimpleAttribute(String, String, Set)} with in the '/' group.
	 */
	public Set getEntitiesByRootAttribute(String attribute, Set values) 
			throws IllegalTypeException, IllegalGroupValueException
	{
		return getEntitiesBySimpleAttribute("/", attribute, values);
	}
	
	/**
	 * Returns all entities that have a given attribute defined in the given group, and that the attribute
	 * value is in the given set of values. This method considers only the first value
	 * of checked attribute. Also this method will work only for simple attributes, which has unencoded String
	 * values. 
	 */
	public Set getEntitiesBySimpleAttribute(String groupPath, String attributeTypeName, 
			Set values) 
			throws IllegalTypeException, IllegalGroupValueException
	{
		List attributes = attributeDAO.getAttributes(attributeTypeName, null, groupPath);
		Set ret = new HashSet();
		for (StoredAttribute sa: attributes)
		{
			AttributeExt attribute = sa.getAttribute();
			if (attribute.getValues().isEmpty())
				continue;
			if (values.contains(attribute.getValues().get(0)))
				ret.add(sa.getEntityId());
		}
		return ret;
	}
	
	/**
	 * It is assumed that the attribute is mapped to string.
	 * Returned are all entities which have value of the attribute among values of the given attribute
	 * in any group.
	 */
	public Set getEntitiesWithStringAttribute(String attributeTypeName, String value) 
			throws IllegalTypeException, IllegalGroupValueException
	{
		List attributes = attributeDAO.getAttributes(attributeTypeName, null, null);
		Set ret = new HashSet();
		for (StoredAttribute sa: attributes)
		{
			AttributeExt attribute = sa.getAttribute();
			if (attribute.getValues().isEmpty())
				continue;
			if (attribute.getValues().contains(value))
				ret.add(sa.getEntityId());
		}
		return ret;
	}

	/**
	 * Adds an entity with all the complicated logic around it. Does not perform authorization and DB 
	 * transaction set up: pure business logic.
	 * Entity is created, initial identity is added to it. Membership in the root group is created,
	 * credential requirement is set as well as initial and extracted attributes.
	 */
	public Identity addEntity(IdentityParam toAdd, String credReqId, EntityState initialState, 
			List attributes, boolean honorInitialConfirmation) 
					throws EngineException
	{
		attributeHelper.checkGroupAttributeClassesConsistency(attributes, "/");

		EntityInformation entity = new EntityInformation();
		entity.setEntityState(initialState);
		long entityId = entityDAO.create(entity);
		audit.log(AuditEventTrigger.builder()
				.type(AuditEventType.ENTITY)
				.action(AuditEventAction.ADD)
				.emptyName()
				.subject(entityId)
				.tags(USERS));

		Identity ret = insertIdentity(toAdd, entityId, false);

		groupHelper.addMemberFromParent("/", new EntityParam(entityId), null, null, new Date());
		
		credentialHelper.setEntityCredentialRequirements(entityId, credReqId);
		
		attributeHelper.addAttributesList(attributes, entityId, honorInitialConfirmation);
		
		addDynamic(entityId, Sets.newHashSet(ret.getTypeId()), new ArrayList<>(), null);
		
		return ret;
	}
	
	/**
	 * As {@link #addEntity(IdentityParam, String, EntityState, boolean, List, boolean)} with default credential requirements.
	 */
	public Identity addEntity(IdentityParam toAdd, EntityState initialState, 
			List attributes, boolean honorInitialConfirmation) 
					throws EngineException
	{
		return addEntity(toAdd, SystemAllCredentialRequirements.NAME, initialState,  
				attributes, honorInitialConfirmation);
	}
	
	/**
	 * Creates a given identity in database. Can create entity if needed. 
	 */
	public Identity insertIdentity(IdentityParam toAdd, long entityId, boolean allowSystem) 
			throws IllegalIdentityValueException
	{
		IdentityTypeDefinition idTypeDef = idTypesRegistry.getByName(toAdd.getTypeId());
		if (idTypeDef == null)
			throw new IllegalIdentityValueException("The identity type is unknown");
		if (idTypeDef.isDynamic() && !allowSystem)
			throw new IllegalIdentityValueException("The identity type " + idTypeDef.getId() + 
					" is created automatically and can not be added manually");
		if ((!idTypeDef.isUserSettable()) && !allowSystem)
			throw new IllegalIdentityValueException("The identity type " + idTypeDef.getId() +
					" cannot be set by user");
		idTypeDef.validate(toAdd.getValue());
		if (idTypeDef.isTargeted())
		{
			if (toAdd.getTarget() == null || toAdd.getRealm() == null)
				throw new IllegalIdentityValueException("The identity target and realm are required "
						+ "for identity type " + idTypeDef.getId());
		} else
		{
			if (toAdd.getTarget() != null || toAdd.getRealm() != null)
				throw new IllegalIdentityValueException("The identity target and realm must not be set "
						+ "for identity type " + idTypeDef.getId());
		}

		Date ts = new Date();
		Identity identity = idTypeHelper.upcastIdentityParam(toAdd, entityId);
		identity.setCreationTs(ts);
		identity.setUpdateTs(ts);
		try
		{
			identityDAO.create(new StoredIdentity(identity));
			audit.log(AuditEventTrigger.builder()
					.type(AuditEventType.IDENTITY)
					.action(AuditEventAction.ADD)
					.name(join(":", identity.getTypeId(), identity.getName()))
					.subject(identity.getEntityId())
					.tags(USERS));
		} catch (Exception e)
		{
			throw new IllegalIdentityValueException(e.getMessage());
		}
		
		return identity;
	}
	
	
	/**
	 * Creates dynamic identities which are currently absent for the entity.
	 */
	void addDynamic(long entityId, Set presentTypes, List ret, String target)
	{
		for (IdentityTypeDefinition idType: idTypesRegistry.getDynamic())
		{
			if (presentTypes.contains(idType.getId()))
				continue;
			if (idType.isTargeted() && target == null)
				continue;
			Identity added = createDynamicIdentity(idType, entityId, target);
			if (added != null)
				ret.add(added);
		}
	}

	List getIdentitiesForEntity(long entityId, String target) throws IllegalIdentityValueException
	{
		return identityDAO.getByEntity(entityId).stream()
				.filter(id -> id.getTarget() == null || id.getTarget().equals(target))
				.collect(Collectors.toList());
	}
	
	private Identity createDynamicIdentity(IdentityTypeDefinition idTypeImpl, long entityId, String target)
	{
		String realm = InvocationContext.safeGetRealm();
		if (idTypeImpl.isTargeted() && (realm == null || target == null))
			return null;
		Identity newId = idTypeImpl.createNewIdentity(realm, target, entityId);
		if (newId != null)
		{
			identityDAO.create(new StoredIdentity(newId));
		}
		return newId;
	}
}