Introduce distinct parameters for loading and analyzing full JAR during summary generation

Author: stefanie-koss

soot-infoflow-summaries/src/soot/jimple/infoflow/methodSummary/Main.java

@@ -39,6 +39,7 @@ class Main {
 
 	private static final String OPTION_FORCE_OVERWRITE = "fo";
 	private static final String OPTION_LOAD_FULL_JAR = "lf";
+	private static final String OPTION_SUMMARIZE_FULL_JAR = "sf";
 	private static final String OPTION_EXCLUDE = "e";
 	private static final String OPTION_REPEAT = "r";
 	private static final String OPTION_FLOW_TIMEOUT = "ft";
@@ -63,7 +64,9 @@ private void initializeCommandLineOptions() {
 
 		options.addOption(OPTION_FORCE_OVERWRITE, "forceoverwrite", false,
 				"Silently overwrite summary files in output directory");
-		options.addOption(OPTION_LOAD_FULL_JAR, "loadfulljar", false, "Summarizes all classes from the given JAR file");
+		options.addOption(OPTION_LOAD_FULL_JAR, "loadfulljar", false, "Loads all classes from the given JAR file");
+		options.addOption(OPTION_SUMMARIZE_FULL_JAR, "summarizefulljar", false,
+				"Summarizes all classes from the given JAR file");
 		options.addOption(OPTION_EXCLUDE, "exclude", true, "Excludes the given class(es)");
 		options.addOption(OPTION_REPEAT, "repeat", true,
 				"Repeats the summary generation multiple times. Useful for performance measurements.");
@@ -85,10 +88,11 @@ public void run(final String[] args) throws FileNotFoundException, XMLStreamExce
 
 			final boolean forceOverwrite = cmd.hasOption(OPTION_FORCE_OVERWRITE);
 			boolean loadFullJAR = cmd.hasOption(OPTION_LOAD_FULL_JAR);
+			boolean summarizeFullJAR = cmd.hasOption(OPTION_SUMMARIZE_FULL_JAR);
 
 			// We need proper parameters
 			String[] extraArgs = cmd.getArgs();
-			if (extraArgs.length < 2 || (extraArgs.length < 3 && !loadFullJAR)) {
+			if (extraArgs.length < 2 || (extraArgs.length < 3 && !summarizeFullJAR)) {
 				printHelpMessage();
 				return;
 			}
@@ -105,7 +109,7 @@ public void run(final String[] args) throws FileNotFoundException, XMLStreamExce
 
 			// Collect the classes to be analyzed from our command line
 			List<String> classesToAnalyze = new ArrayList<>();
-			if (!loadFullJAR) {
+			if (!summarizeFullJAR) {
 				for (int i = 2; i < extraArgs.length; i++) {
 					if (extraArgs[i].startsWith("-")) {
 						printHelpMessage();
@@ -122,6 +126,7 @@ public void run(final String[] args) throws FileNotFoundException, XMLStreamExce
 			}
 
 			generator.getConfig().setLoadFullJAR(loadFullJAR);
+			generator.getConfig().setSummarizeFullJAR(summarizeFullJAR);
 			generator.getConfig().setExcludes(excludes);
 
 			// Set optional settings
@@ -227,7 +232,7 @@ private void printHelpMessage() {
 		System.out.println();
 
 		final HelpFormatter formatter = new HelpFormatter();
-		formatter.printHelp("soot-infoflow-cmd <JAR File> <Output Directory> <Classes...> [OPTIONS]", options);
+		formatter.printHelp("soot-infoflow-summaries <JAR File> <Output Directory> <Classes...> [OPTIONS]", options);
 	}
 
 	private static void createSummaries(SummaryGenerator generator, List<String> classesToAnalyze,

soot-infoflow-summaries/src/soot/jimple/infoflow/methodSummary/generator/SummaryGenerator.java

@@ -268,7 +268,7 @@ public ClassSummaries createMethodSummaries(String classpath, Collection<String>
 		}
 
 		Options.v().set_output_format(Options.output_format_none);
-		if (hasWildcard || config.getLoadFullJAR())
+		if (hasWildcard || config.getLoadFullJAR() || config.getSummarizeFullJAR())
 			Options.v().set_process_dir(Arrays.asList(classpath.split(File.pathSeparator)));
 		else
 			Options.v().set_soot_classpath(classpath);
@@ -289,7 +289,7 @@ public ClassSummaries createMethodSummaries(String classpath, Collection<String>
 		Scene.v().loadNecessaryClasses();
 
 		Set<ClassAnalysisTask> realClasses = new HashSet<>(classNames.size());
-		if (config.getLoadFullJAR()) {
+		if (config.getSummarizeFullJAR()) {
 			for (Iterator<SootClass> scIt = Scene.v().getApplicationClasses().snapshotIterator(); scIt.hasNext();) {
 				SootClass sc = scIt.next();
 				Scene.v().forceResolve(sc.getName(), SootClass.SIGNATURES);

soot-infoflow-summaries/src/soot/jimple/infoflow/methodSummary/generator/SummaryGeneratorConfiguration.java

@@ -14,6 +14,7 @@
 public class SummaryGeneratorConfiguration extends InfoflowConfiguration {
 
 	protected boolean loadFullJAR = false;
+	protected boolean summarizeFullJAR = false;
 	protected String androidPlatformDir = "";
 
 	protected Set<String> excludes = null;
@@ -58,6 +59,7 @@ public void merge(InfoflowConfiguration config) {
 			SummaryGeneratorConfiguration summaryConfig = (SummaryGeneratorConfiguration) config;
 			this.androidPlatformDir = summaryConfig.androidPlatformDir;
 			this.loadFullJAR = summaryConfig.loadFullJAR;
+			this.summarizeFullJAR = summaryConfig.summarizeFullJAR;
 
 			this.excludes = summaryConfig.excludes == null || summaryConfig.excludes.isEmpty() ? null
 					: new HashSet<>(summaryConfig.excludes);
@@ -127,6 +129,26 @@ public boolean getLoadFullJAR() {
 		return this.loadFullJAR;
 	}
 
+	/**
+	 * Sets whether all classes from the target JAR file shall be summarized.
+	 * 
+	 * @param summarizeFullJAR True if all classes from the target JAR file shall be
+	 *                         summarized, otherwise false.
+	 */
+	public void setSummarizeFullJAR(boolean summarizeFullJAR) {
+		this.summarizeFullJAR = summarizeFullJAR;
+	}
+
+	/**
+	 * Gets whether all classes from the target JAR file shall be summarized.
+	 * 
+	 * @return True if all classes from the target JAR file shall be summarized,
+	 *         otherwise false.
+	 */
+	public boolean getSummarizeFullJAR() {
+		return this.summarizeFullJAR;
+	}
+
 	/**
 	 * Sets the set of classes to be excluded from the analysis. Use pkg.* to
 	 * exclude all classes in package "pkg"
@@ -315,6 +337,7 @@ public int hashCode() {
 		result = prime * result + (int) (classSummaryTimeout ^ (classSummaryTimeout >>> 32));
 		result = prime * result + ((excludes == null) ? 0 : excludes.hashCode());
 		result = prime * result + (loadFullJAR ? 1231 : 1237);
+		result = prime * result + (summarizeFullJAR ? 1231 : 1237);
 		result = prime * result + repeatCount;
 		result = prime * result + (summarizeHashCodeEquals ? 1231 : 1237);
 		result = prime * result + (useDefaultSummaries ? 1231 : 1237);
@@ -352,6 +375,8 @@ public boolean equals(Object obj) {
 			return false;
 		if (loadFullJAR != other.loadFullJAR)
 			return false;
+		if (summarizeFullJAR != other.summarizeFullJAR)
+			return false;
 		if (repeatCount != other.repeatCount)
 			return false;
 		if (summarizeHashCodeEquals != other.summarizeHashCodeEquals)

soot-infoflow-summaries/src/soot/jimple/infoflow/methodSummary/generator/SummaryGeneratorFactory.java

@@ -13,6 +13,7 @@ public class SummaryGeneratorFactory {
 	private final boolean flowSensitiveAliasing = true;
 	private final boolean useRecursiveAccessPaths = true;
 	private final boolean loadFullJAR = true;
+	private final boolean summarizeFullJAR = true;
 
 	/**
 	 * Initializes the summary generator object
@@ -28,6 +29,7 @@ public SummaryGenerator initSummaryGenerator() {
 				enableImplicitFlows ? ImplicitFlowMode.AllImplicitFlows : ImplicitFlowMode.NoImplicitFlows);
 		s.getConfig().setFlowSensitiveAliasing(flowSensitiveAliasing);
 		s.getConfig().setLoadFullJAR(loadFullJAR);
+		s.getConfig().setSummarizeFullJAR(summarizeFullJAR);
 
 		return s;
 	}

soot-infoflow-summaries/test/soot/jimple/infoflow/test/methodSummary/junit/JDKTests.java

@@ -168,6 +168,7 @@ protected SummaryGenerator getSummary() {
 		sg.getConfig().getAccessPathConfiguration().setAccessPathLength(4);
 		sg.getConfig().getAccessPathConfiguration().setUseRecursiveAccessPaths(true);
 		sg.getConfig().setLoadFullJAR(false);
+		sg.getConfig().setSummarizeFullJAR(false);
 		sg.getConfig().setEnableExceptionTracking(true);
 		return sg;
 	}