soot.jimple.infoflow.handlers.SequentialTaintPropagationHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of soot-infoflow Show documentation
Soot extending data flow tracking components for Java
The newest version!
package soot.jimple.infoflow.handlers;

import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import soot.Unit;
import soot.jimple.infoflow.InfoflowManager;
import soot.jimple.infoflow.data.Abstraction;

/**
 * Taint propagation handler that processes a sequence of inner handlers. For
 * outputs, all generated abstractions are merged into a final abstraction set.
 * 
 * @author Steven Arzt
 *
 */
public class SequentialTaintPropagationHandler implements TaintPropagationHandler {

	private final List innerHandlers;

	/**
	 * Creates a new, empty sequence of taint propagation handlers
	 */
	public SequentialTaintPropagationHandler() {
		this.innerHandlers = new ArrayList<>();
	}

	/**
	 * Creates a sequence of taint propagation handlers from the given list
	 * 
	 * @param handlers A list of taint propagation handlers to which all calls shall
	 *                 be relayed
	 */
	public SequentialTaintPropagationHandler(List handlers) {
		this.innerHandlers = new ArrayList<>(handlers);
	}

	/**
	 * Adds a new handler to this sequence of handlers
	 * 
	 * @param handler The handler to add to the sequence
	 */
	public void addHandler(TaintPropagationHandler handler) {
		if (handler != null)
			this.innerHandlers.add(handler);
	}

	/**
	 * Gets the inner handlers registered with this object
	 * 
	 * @return The inner handlers registered with this object
	 */
	public List getHandlers() {
		return innerHandlers;
	}

	@Override
	public void notifyFlowIn(Unit stmt, Abstraction taint, InfoflowManager manager, FlowFunctionType type) {
		for (TaintPropagationHandler handler : innerHandlers)
			handler.notifyFlowIn(stmt, taint, manager, type);
	}

	@Override
	public Set notifyFlowOut(Unit stmt, Abstraction d1, Abstraction incoming, Set outgoing,
			InfoflowManager manager, FlowFunctionType type) {
		if (innerHandlers.isEmpty())
			return outgoing;

		Set resultSet = new HashSet<>();
		for (TaintPropagationHandler handler : innerHandlers) {
			Set handlerResults = handler.notifyFlowOut(stmt, d1, incoming, outgoing, manager, type);
			if (handlerResults != null && !handlerResults.isEmpty())
				resultSet.addAll(handlerResults);
		}
		return resultSet;
	}

	/**
	 * Adds all of the given taint propagation handlers
	 * 
	 * @param handlers The taint propagation handlers to add
	 */
	public void addAllHandlers(TaintPropagationHandler[] handlers) {
		if (handlers != null && handlers.length > 0) {
			for (TaintPropagationHandler handler : handlers)
				addHandler(handler);
		}
	}

}