Using the command line mode - SmartAssembly

Instead of using the SmartAssembly user interface to build your project, you can use the command line. This is useful if you want to apply a setting to multiple assemblies, or to make a change to existing settings during your build process, for example.

The console application SmartAssembly.com is stored in the same folder as SmartAssembly.exe. This is usually in %ProgramFiles%\Red Gate\SmartAssembly.

To run SmartAssembly from the command line, the syntax is:

     SmartAssembly.com [switch] [projectfile | reportfile] [options]

There are two ways to use the command line:

• Integrating SmartAssembly in your build process, or making changes to multiple SmartAssembly projects.
• Performing regular management tasks

Integrating SmartAssembly in your build process, or making changes to multiple SmartAssembly projects.

To use the command line to integrate SmartAssembly in your build process, or to make changes to multiple SmartAssembly projects:

1. Choose either to:
   • build an assembly based on existing SmartAssembly project settings
   • edit existing SmartAssembly project settings
   • create new SmartAssembly project settings
2. Set the options for your SmartAssembly project
3. Set the options for the assemblies in your project

1. Building, creating, or editing a SmartAssembly project

2. Setting project options

You can use the following switches to control how SmartAssembly processes your project.

• If you are using the /build or /edit switch, all of these switches are optional.

  If you do not set some of the switches, the settings in your .saproj file are used instead.

• If you are using the /create switch, you must set the /input and /output options. All other switches are optional.

  If you do not set some of the switches, the settings in bold are used instead.

Setting the input and output assemblies

/input=newassembly.exe

Overrides the input assembly specified in the *.saproj file (if applicable), using newassembly.exe instead.

Must be used with the /create switch.

Can be used with the /edit and /build switches if the assembly specified in the *.saproj file has been moved to a different location.

/output=newoutput.exe

Overrides the output assembly specified in the *.saproj file (if applicable), using newoutput.exe instead.

To overwrite the input file with the output file, use /output=$self

Must be used with the /create switch.

Can be used with the /edit and /build switches

Signing your assembly with a strong name key

/keyfilename=[path\to\file.snk | false]

Sign the assembly with the specified strong name key file.

Adding tamper protection to the assembly

/tamperprotection=[true | false]

Apply tamper protection to the assembly.

Ignored if /keyfilename=false

Reducing the assembly's unused, allocated memory

/reducemem=[true | false]

Reduce the assembly's unused, allocated memory.

Sealing classes that are not inherited

/sealclasses=[true | false]

Seal classes that are not inherited.

Preventing Microsoft IL Disassembler from opening your assembly

/preventildasm=[true | false]

Prevent Microsoft IL Disassembler from opening your assembly.

Setting the types / methods name mangling level

/typemethodobfuscation=[1 | 2 | 3]

Apply types / methods name mangling at the specified level to assemblies with nameobfuscate:true:

1 = ASCII renaming
2 = Unicode unprintable characters
3 = Unicode unprintable characters and advanced renaming

Note that this switch does not apply name mangling itself. It sets the level that will be used for assemblies with nameobfuscate:true set.

Setting the fields name mangling level

/fieldobfuscation=[1 | 2 | 3]

Apply fields name mangling at the specified level to assemblies with nameobfuscate:true:

1 = One-to-one renaming
2 = Standard renaming
3 = Advanced renaming

Note that this switch does not apply fields name mangling itself. It set the level that will be used for assemblies with nameobfuscate:true set.

Setting strings encoding

To disable strings encoding:

/stringsencoding=false

To enable strings encoding, set /stringsencoding=true. You may specify settings for the three sub-options:

• Use improved protection?
• Compress and encrypt resources?
• Cache the strings for improved performance?

/stringsencoding=true;
improved:[true | false],
compressencrypt:[true | false]
cache:[true | false]

Creating a PDB file

/makepdb=[true | false]

Create a PDB file

Obfuscating URLs in the PDB file

/obfuscatepdburls=[true | false]

Obfuscate URLs in the PDB file.

Ignored if /markpdb=false

Setting the application, project and company names for use in error and feature usage reports

/reportappname=""
/reportprojectname=""
/reportcompanyname="Microsoft"

Sets the application, project and company name for use with error reporting and feature usage reporting dialogs.

Must be used with /errorreportingtemplate and/or /featureusagetemplate

Ignored if neither /errorreportingtemplate nor /featureusagetemplate are used.

Enabling error reporting

To disable error reporting:

/errorreportingtemplate=false

To enable error reporting, set errortemplate to standard or a file name. You may specify settings for the two sub-options:

• continueonerror = Whether or not your application should try to continue after an error.
• email = When an error report is received, an email is sent to this address. To turn of email notifications, set an empty string.

/errorreportingtemplate=[standard | path\to\template.dll];
continueonerror:[true | false],
email:"example@example.com"

Enabling feature usage reporting

/featureusagetemplate=[consent1 | consent2 | auto | path\to\template.dll | false]

Apply feature usage reporting with the specified consent dialog:

• consent1 = Consent dialog on first run
• consent2 = Consent dialog on second run
• auto = Report without consent dialog
• path\to\template.dll = Use this DLL for the consent dialog
• false = Do not enable feature usage reporting

3. Setting assembly options

Some options are set per assembly.

To set these options, type the /assembly: switch, followed by the name of your assembly, then a semi-colon (;).

Add the assembly options, separated by commas, as in this example:

/assembly="MyAssembly";prune:true,merge:true,embed:true,nameobfuscate:true,
dynamicproxy:true,compressencryptresources:true,controlflowobfuscate:1,
 compressassembly:true,encryptassembly:true

Example usage

SmartAssembly.com /edit "C:\Documents\Visual Studio 2010\Projects\Crasher\Crasher\bin\Release\Crasher.saproj"

     /keyfilename="./g.snk"

     /tamperprotection=true

     /reducemem=true

     /sealclasses=true

     /preventildasm=true

     /featureusagetemplate=consent1

     /fieldobfuscation=2

     /typemethodobfuscation=3

     /stringsencoding=true;improved:true,compressencrypt:true,cache:true

     /errorreportingtemplate=auto;continueonerror=true;email="example@example.com"

     /makepdb=true

     /reportappname="hello world"

     /reportprojectname="testproj"

     /reportcompanyname="Red Gate Software"

     /assembly="Crasher";prune:true,merge:true,embed:true,nameobfuscate:true,controlflowobfuscate:3,dynamicproxy:true,compressencryptresources:true

This example:

Takes the existing SmartAssembly project file located at C:\Documents\Visual Studio 2010\Projects\Crasher\Crasher\bin\Release\Crasher.saproj and then overwrites it, replacing the following settings. The Crasher assembly is not rebuilt.

• Sign the assembly with the strong name key located at "./g.snk"
• Enable tamper protection
• Enable the reduction of unused, allocated memory
• Automatically seal classes wherever possible
• Enable MSIL Disassembler protection
• Enable Feature Usage Reporting, showing a consent dialog on the first run
• Use Standard renaming for fields in assemblies that have fields renaming enabled
• Use Unicode unprintable characters and advanced renaming algorithm in assemblies that have Types/Methods Name Mangling enabled
• Enable Strings Encoding with Improved Protection, Compress and Encrypt the Strings and enable the cache
• Enable Automatic Error Reporting without a dialog box, trying to continue when an error occurs
• Generate PBD files for the assembly
• For the purposes of Automated Error Reporting and Feature Usage Reporting, name the application 'Hello World', name the project 'testproj', set the company name to 'Red Gate Software' and set the email address to 'example@example.com'. (This is the email address that will be sent a message whenever a new error report arrives.)

Then, within the assembly called "Crasher":

• Enable Pruning
• Enable Merging
• Embed the assembly into the main assembly (which will have been set in the Crasher.saproj file already)
• Enable Types/Methods Name Mangling and Fields Name Mangling
• Enable Control Flow Obfuscation at the 'Strongest' level
• Enable the Dynamic References Proxy
• Enable Resources Compression and Encryption

Performing regular management tasks

You can also use the following command line switches to perform management tasks related to your SmartAssembly installation.

These switches are used on their own; they are not used with the /create, /build, or /edit switches.