soot.jimple.infoflow.android.callbacks.xml.CollectedCallbacksSerializer Maven / Gradle / Ivy

Go to download
package soot.jimple.infoflow.android.callbacks.xml;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.HashMap;
import java.util.HashSet;

import com.esotericsoftware.kryo.Kryo;
import com.esotericsoftware.kryo.KryoException;
import com.esotericsoftware.kryo.Serializer;
import com.esotericsoftware.kryo.io.Input;
import com.esotericsoftware.kryo.io.Output;

import soot.Scene;
import soot.SootClass;
import soot.SootMethod;
import soot.jimple.infoflow.android.InfoflowAndroidConfiguration.CallbackConfiguration;
import soot.jimple.infoflow.android.callbacks.AndroidCallbackDefinition;
import soot.jimple.infoflow.android.callbacks.AndroidCallbackDefinition.CallbackType;
import soot.util.HashMultiMap;

/**
 * Class for serializing collected callbacks to disk for later re-use
 * 
 * @author Steven Arzt
 *
 */
public class CollectedCallbacksSerializer {

	/**
	 * Serializer for {@link SootMethod} instances
	 * 
	 * @author Steven Arzt
	 *
	 */
	private static class SootMethodSerializer extends Serializer {

		@Override
		public void write(Kryo kryo, Output output, SootMethod object) {
			output.writeString(object.getSignature());
		}

		@Override
		public SootMethod read(Kryo kryo, Input input, Class type) {
			String sig = input.readString();
			return Scene.v().grabMethod(sig);
		}

	}

	/**
	 * Serializer for {@link SootClass} instances
	 * 
	 * @author Steven Arzt
	 *
	 */
	private static class SootClassSerializer extends Serializer {

		@Override
		public void write(Kryo kryo, Output output, SootClass object) {
			output.writeString(object.getName());
		}

		@Override
		public SootClass read(Kryo kryo, Input input, Class type) {
			String className = input.readString();
			return Scene.v().getSootClassUnsafe(className);
		}

	}

	/**
	 * Serializer for {@link AndroidCallbackDefinition} instances
	 * 
	 * @author Steven Arzt
	 *
	 */
	private static class AndroidCallbackDefinitionSerializer extends Serializer {

		@Override
		public void write(Kryo kryo, Output output, AndroidCallbackDefinition object) {
			kryo.writeClassAndObject(output, object.getTargetMethod());
			kryo.writeClassAndObject(output, object.getParentMethod());
			kryo.writeClassAndObject(output, object.getCallbackType());
		}

		@Override
		public AndroidCallbackDefinition read(Kryo kryo, Input input, Class type) {
			SootMethod targetMethod = (SootMethod) kryo.readClassAndObject(input);
			SootMethod parentMethod = (SootMethod) kryo.readClassAndObject(input);
			CallbackType callbackType = (CallbackType) kryo.readClassAndObject(input);
			return new AndroidCallbackDefinition(targetMethod, parentMethod, callbackType);
		}

	}

	/**
	 * Serializes the given data object
	 * 
	 * @param callbacks The object to serialize
	 * @param config    The configuration that defines how and where to store the
	 *                  data
	 * @throws IOException
	 */
	public static void serialize(CollectedCallbacks callbacks, CallbackConfiguration config) throws IOException {
		Kryo kryo = initializeKryo();

		try (Output output = new Output(new FileOutputStream(config.getCallbacksFile()))) {
			kryo.writeClassAndObject(output, callbacks);
		}
	}

	/**
	 * Deserializes the callback file for this application
	 * 
	 * @param callbackFile The file with the collected callbacks
	 * @return The deserialized callback object
	 * @throws FileNotFoundException
	 * @throws KryoException
	 */
	public static CollectedCallbacks deserialize(File callbackFile) throws KryoException, FileNotFoundException {
		Kryo kryo = initializeKryo();

		try (Input input = new Input(new FileInputStream(callbackFile))) {
			return (CollectedCallbacks) kryo.readClassAndObject(input);
		}
	}

	/**
	 * Deserializes the callback file for this application
	 * 
	 * @param config The configuration that defines how and where to store the data
	 * @return The deserialized callback object
	 * @throws FileNotFoundException
	 * @throws KryoException
	 */
	public static CollectedCallbacks deserialize(CallbackConfiguration config)
			throws KryoException, FileNotFoundException {
		return deserialize(new File(config.getCallbacksFile()));
	}

	/**
	 * Initializes the Kryo serializer
	 * 
	 * @return The Kryo serializer
	 */
	protected static Kryo initializeKryo() {
		Kryo kryo = new Kryo();

		// FlowDroid classes
		kryo.register(CollectedCallbacks.class);
		kryo.register(AndroidCallbackDefinition.class, new AndroidCallbackDefinitionSerializer());
		kryo.register(CallbackType.class);

		// Java collection classes
		kryo.register(HashMultiMap.class);
		kryo.register(HashMap.class);
		kryo.register(HashSet.class);

		// Soot classes
		kryo.register(SootMethod.class, new SootMethodSerializer());
		kryo.register(SootClass.class, new SootClassSerializer());

		return kryo;
	}

}