soot.jimple.infoflow.android.data.AndroidMethod Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright (c) 2012 Secure Software Engineering Group at EC SPRIDE.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the GNU Lesser Public License v2.1
 * which accompanies this distribution, and is available at
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 * 
 * Contributors: Christian Fritz, Steven Arzt, Siegfried Rasthofer, Eric
 * Bodden, and others.
 ******************************************************************************/
package soot.jimple.infoflow.android.data;

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

import soot.SootMethod;
import soot.jimple.infoflow.data.SootMethodAndClass;
import soot.jimple.infoflow.sourcesSinks.definitions.SourceSinkType;
import soot.jimple.infoflow.util.SootMethodRepresentationParser;

/**
 * Class representing a single method in the Android SDK
 *
 * @author Steven Arzt, Siegfried Rasthofer, Daniel Magin, Joern Tillmanns
 *
 */
public class AndroidMethod extends SootMethodAndClass {

	private Set permissions;
	private SourceSinkType sourceSinkType = SourceSinkType.Undefined;

	public AndroidMethod(String methodName, String returnType, String className) {
		super(methodName, className, returnType, new ArrayList());
		this.permissions = null;
	}

	public AndroidMethod(String methodName, List parameters, String returnType, String className) {
		super(methodName, className, returnType, parameters);
		this.permissions = null;
	}

	public AndroidMethod(String methodName, List parameters, String returnType, String className,
			Set permissions) {
		super(methodName, className, returnType, parameters);
		this.permissions = permissions;
	}

	public AndroidMethod(SootMethod sm) {
		super(sm);
		this.permissions = null;
	}

	public AndroidMethod(SootMethodAndClass methodAndClass) {
		super(methodAndClass);
		this.permissions = null;
	}

	public Set getPermissions() {
		return this.permissions == null ? Collections.emptySet() : this.permissions;
	}

	public void setSourceSinkType(SourceSinkType sourceSinkType) {
		this.sourceSinkType = sourceSinkType;
	}

	public void addPermission(String permission) {
		if (this.permissions == null)
			this.permissions = new HashSet<>();
		this.permissions.add(permission);
	}

	@Override
	public String toString() {
		StringBuilder sb = new StringBuilder();
		sb.append(getSignature());
		if (permissions != null)
			for (String perm : permissions) {
				sb.append(" ");
				sb.append(perm);
			}

		if (this.sourceSinkType != SourceSinkType.Undefined)
			sb.append(" ->");
		if (this.sourceSinkType == SourceSinkType.Source)
			sb.append(" _SOURCE_");
		else if (this.sourceSinkType == SourceSinkType.Sink)
			sb.append(" _SINK_ ");
		else if (this.sourceSinkType == SourceSinkType.Neither)
			sb.append(" _NONE_");
		else if (this.sourceSinkType == SourceSinkType.Both)
			sb.append(" _BOTH_");
		return sb.toString();
	}

	public String getSignatureAndPermissions() {
		String s = getSignature();
		if (permissions != null)
			for (String perm : permissions)
				s += " " + perm;
		return s;
	}

	/**
	 * Gets whether this method has been annotated as a source, sink or neither nor.
	 * 
	 * @return True if there is an annotations for this method, otherwise false.
	 */
	public boolean isAnnotated() {
		return sourceSinkType != SourceSinkType.Undefined;
	}

	/**
	 * Gets whether this method is configured as a source or sink
	 * 
	 * @return The source/sink definition for this method
	 */
	public SourceSinkType getSourceSinkType() {
		return this.sourceSinkType;
	}

	/***
	 * Static method to create AndroidMethod from Soot method signature
	 * 
	 * @param signature The Soot method signature
	 * @return The new AndroidMethod object
	 */
	public static AndroidMethod createFromSignature(String signature) {
		if (!signature.startsWith("<"))
			signature = "<" + signature;
		if (!signature.endsWith(">"))
			signature = signature + ">";

		SootMethodAndClass smac = SootMethodRepresentationParser.v().parseSootMethodString(signature);
		if (smac == null)
			return null;
		return new AndroidMethod(smac.getMethodName(), smac.getParameters(), smac.getReturnType(), smac.getClassName());
	}

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = super.hashCode();
		result = prime * result + ((permissions == null) ? 0 : permissions.hashCode());
		result = prime * result + ((sourceSinkType == null) ? 0 : sourceSinkType.hashCode());
		return result;
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (!super.equals(obj))
			return false;
		if (getClass() != obj.getClass())
			return false;
		AndroidMethod other = (AndroidMethod) obj;
		if (permissions == null) {
			if (other.permissions != null)
				return false;
		} else if (!permissions.equals(other.permissions))
			return false;
		if (sourceSinkType != other.sourceSinkType)
			return false;
		return true;
	}

}