Smokescreen Build Process Integration

Products page

Revision history

User guide

Installation guide

Obfuscation notes

Directives file

Incremental obfuscation

Buildtool integration

Watermarking

License and download

Purchase

Faqs/Known issues

Email


	Revision 3.3 and later of Smokescreen will provide an exit code when the application terminates after being launched from the command line. This allows it to be integrated into a build process using a tool such as ANT. Revision 3.6 and later provide two api methods to start the obfuscation process.

	Using Smokescreen with ANT
	Smokescreen may be launched from ANT by using the 'java' task just as it would normally be used from a command line. Note that a directives file needs to be specified when launching from the command line. This file can either be present in the file system already, or it can be created on the fly just before the 'java' task is invoked. In the case of the latter, all the directives can be specified inside the build file.
	Building with the directives file already available The following sample build file shows an example of an obfuscation task where the directives file which is specified, is already available on the system. It is assumed that the 'basedir' attribute for the task points to the directory where the evaluation edition of Smokescreen rev 3.3 is installed. The directives file is assumed to be present in this same directory.
	<?xml version="1.0"?> <!-- Sample build file for using Smokescreen with existing directives file --> <project name="Ant test project" default="obfuscate" basedir="c:\Smokescreen_directory"> <target name="obfuscate" > <echo message="Starting Smokescreen"/> <java jar="Smokescreen33_Eval.jar" fork="true" failonerror="true"> <arg value="-nogui"/> <arg value="-directives"/> <arg value="SmokescreenDirectives.txt" /> </java> </target> </project>
	Building with the directives file created on the fly The following sample build file shows an example of an obfuscation task where the directives file is created on the fly, and then used to launch Smokescreen. It is assumed that the 'basedir' attribute for the task points to the directory where the evaluation edition of Smokescreen rev 3.3 is installed. The directives file will be created in this same directory, and can be referred to if Smokescreen reports an error because of one of the directives.
	<?xml version="1.0"?> <!-- Sample build file for using Smokescreen without directives file --> <project name="Ant test project" default="obfuscate" basedir="c:\Smokescreen_directory"> <target name="obfuscate" > <echo message="Starting obfuscate"/> <delete file="SmokescreenDirectives.txt" verbose="true" failonerror="false"/> <property name="SmokescreenSource" location="c:\Source_path"/> <property name="SmokescreenDest" location="c:\Destination_path"/> <echo file="SmokescreenDirectives.txt"> source_directory ${SmokescreenSource} destination_directory ${SmokescreenDest} log_changes use_class_loader_for_superclasses overwrite_classfiles classes all_non-public methods all_methods methods remove_unused fields all_fields fields remove_unused bytecode shuffle_stack_operations bytecode add_fake_exceptions bytecode change_switch_statements </echo> <fixcrlf srcdir="." includes="SmokescreenDirectives.txt"/> <java jar="Smokescreen33_Eval.jar" fork="true" failonerror="true"> <arg value="-nogui"/> <arg value="-directives"/> <arg value="SmokescreenDirectives.txt" /> </java> </target> </project>


	Building with the api
	For rev 3.6 and later there are two methods in the 'com.leesw.Smokescreen.Smokescreen' class named 'obfuscate' which may be called from a java application to start the obfuscation process. The first one is: public static boolean obfuscate(String logfile,String directiveFile) A code fragment to call this method is given below.
	boolean ret = obfuscate("logfile.txt","directives.txt"); if(!ret) System.out.println("There was an error");
	The second api method to perform an obfuscation is: public static boolean obfuscate(String logfile,String[] directivesArray) A code fragment to call this method is given below.
	String[] s = { "source_directory sourcedir", "destination_directory destdir", "log_changes", "use_class_loader_for_superclasses", "overwrite_classfiles", "classes all_non-public, remove_unused, rename_packages", "methods all_methods, remove_unused", "fields all_fields, remove_unused", "bytecode shuffle_stack_operations, add_fake_exceptions, change_switch_statements, encrypt_strings", }; boolean ret = obfuscate("logfile",s); if(!ret) System.out.println("There was an error");