SmartAssembly

https://documentation.red-gate.com/sa/
Admin
SmartAssembly enables you to perform a range of improvement and protection operations on your...
Tokens:21,350
Snippets:347
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Configure SQL Server instance

Source: https://documentation.red-gate.com/sa8/building-your-assembly/using-the-command-line-mode

Example of specifying the database server instance for SQL Server.

```text
/dbServer="localhost\SQL2016"
```

--------------------------------

### Configure SQL Server creator connection string

Source: https://documentation.red-gate.com/sa8/building-your-assembly/using-the-command-line-mode

Example of providing an administrative connection string for database creation.

```text
/dbServer="Server=localhost\SQL2016;Database=SmartAssembly;User Id=admin;Password=adminPassword;"
```

--------------------------------

### Configure SQL Server connection string

Source: https://documentation.red-gate.com/sa8/building-your-assembly/using-the-command-line-mode

Example of providing a full connection string for SQL Server database access.

```text
/dbServer="Server=localhost\SQL2016;Database=SmartAssembly;User Id=regularUser;Password=userPassword;"
```

--------------------------------

### Define multiple target frameworks in csproj

Source: https://documentation.red-gate.com/sa8/building-your-assembly/using-smartassembly-with-msbuild/process-a-project-targeting-multiple-frameworks

Example of a project file configured to target multiple .NET frameworks.

```xml
  1. <!-- ProjectA.csproj -->
  2. <Project Sdk="Microsoft.NET.Sdk">
  3.   <PropertyGroup>
  4.     <TargetFrameworks>netcoreapp3.1;net472;netstandard2.1</TargetFrameworks>
  5.   </PropertyGroup>
  6. </Project>
```

--------------------------------

### String encoding transformation example

Source: https://documentation.red-gate.com/sa/obfuscating-your-code-with-smartassembly/encoding-strings

Comparison of raw strings versus their encoded representation after processing by SmartAssembly.

```text
  1. "Fred.gate@hotmail.com"
  2. "p@ssw0rd1"
  3. "licensingUrl=http://licensing.red-gate.com/licensingactivation.asmx"
```

```text
  1. "FNRFk1TTJZM016VTPQ==.bmV1dSBzcGVjaWZpZWQ9sbGVjdGlvbi4=L"
```

--------------------------------

### Deactivate Product via Command Line

Source: https://documentation.red-gate.com/sa8/getting-started/licensing/deactivating

Syntax and example for deactivating a Redgate product executable from the command prompt.

```text
  1. <productEXE> /deactivateSerial
```

```text
  1. sqlcompare /deactivateSerial
```

--------------------------------

### Configure SmartAssembly properties in .csproj

Source: https://documentation.red-gate.com/sa/building-your-assembly/using-smartassembly-with-msbuild

Example of setting optional SmartAssembly properties within a PropertyGroup in an MSBuild project file.

```xml
  1. <Project>
  2.   ...
  3.   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
  4.  
  5.   <!-- Optional SmartAssembly properties -->
  6.   <PropertyGroup>
  7.     <SmartAssemblyIsEnabled>False</SmartAssemblyIsEnabled>
  8.     <SmartAssemblyIsEnabled Condition=" '$(Configuration)' == 'Debug' ">True</SmartAssemblyIsEnabled>
  9.     <SmartAssemblyProjectFile>$(MSBuildProjectDirectory)\$(AssemblyName)_$(Configuration).saproj</SmartAssemblyProjectFile>
  10.     <SmartAssemblyInput>$(TargetPath)</SmartAssemblyInput>
  11.     <SmartAssemblyOutput>$(OutputPath)\Protected\$(TargetFileName)</SmartAssemblyOutput>
  12.     <SmartAssemblyOverwriteAssembly>True</SmartAssemblyOverwriteAssembly>
  13.   </PropertyGroup>
  14.   <!-- /Optional SmartAssembly properties -->
  15. </Project>
```

--------------------------------

### Configure Assembly Options via Command Line

Source: https://documentation.red-gate.com/sa8/building-your-assembly/using-the-command-line-mode

Use the /assembly switch followed by the assembly name and a comma-separated list of options to configure specific build settings.

```text
/assembly="MyAssembly";prune:true,merge:true,embed:true,nameobfuscate:true,dynamicproxy:true,compressencryptresources:true,controlflowobfuscate:1,compressassembly:true,encryptassembly:true,keyfilename:file.pfx,keypassword:"p@ssword"
```

--------------------------------

### Suggest dependency path with HintPath

Source: https://documentation.red-gate.com/sa8/troubleshooting/unexpected-behavior-and-technical-questions/how-smartassembly-searches-for-dependencies

Use HintPath to suggest a specific assembly file; if the file is invalid or missing, the default search order will still be used.

```xml
  1. <Assembly AssemblyName="dependency_assembly_name" HintPath="C:\path\DependencyToUse.dll">
  2.   ... 
  3. </Assembly>
```

--------------------------------

### Type forwarding attribute example

Source: https://documentation.red-gate.com/sa8/obfuscating-your-code-with-smartassembly/merging-dependencies/merging-assemblies-others-depend-on

Syntax for applying the TypeForwardedTo attribute to redirect type resolution to a different assembly.

```csharp
[assembly: TypeForwardedTo(IExample)]
```

--------------------------------

### Configure post-build file copying via command line

Source: https://documentation.red-gate.com/sa/building-your-assembly/copying-files-and-dependencies-after-build

Use the /copyFiles argument with SmartAssembly.com to specify files to be copied after the build process.

```bash
  1. SmartAssembly.com /edit MyApplication.saproj "/copyFiles=./bin/Debug/sample.config;./bin/Debug/some_configuration.json"
```

--------------------------------

### Define post-build file copying in .saproj file

Source: https://documentation.red-gate.com/sa/building-your-assembly/copying-files-and-dependencies-after-build

Manually add the <AfterBuild> section to your SmartAssembly project file to define files to copy.

```xml
  1. <SmartAssemblyProject ProjectId="{1ff3c572-c94e-475a-8802-3f23db3da28c}" Version="2.0">
  2. 	    <MainAssemblyFileName>./bin/Debug/MyApplication.exe</MainAssemblyFileName>
  3. 	    <Configuration Name="Release">
  4. 	        <Destination DestinationFileName="./bin/protected/MyApplication.exe" />
  5. 	        <AfterBuild>
  6. 	            <CopyFiles>
  7. 	                <File>./bin/Debug/sample.config</File>
  8. 	                <File>./bin/Debug/some_configuration.json</File>
  9. 	            </CopyFiles>
  10. 	        </AfterBuild>
  11. 	        <Options>
  12. 	            ...
  13. 	        </Options>
  14. 	        <Assemblies>
  15. 	            ...
  16. 	        </Assemblies>
  17. 	    </Configuration>
  18. </SmartAssemblyProject>
```

--------------------------------

### Configure SmartAssembly via Command Line

Source: https://documentation.red-gate.com/sa8/building-your-assembly/using-the-command-line-mode

Use this command to modify an existing .saproj file with specific obfuscation, reporting, and dependency settings.

```bash
  1. SmartAssembly.com /edit "C:\Documents\Visual Studio 2010\Projects\Crasher\Crasher\bin\Release\Crasher.saproj" 
  2.      /keyfilename="./g.snk" 
  3.      /tamperprotection=true 
  4.      /sealclasses=true 
  5.      /preventildasm=true 
  6.      /featureusagetemplate=consent1 
  7.      /fieldobfuscation=2 
  8.      /typemethodobfuscation=3 
  9.      /cgsobfuscation=true
  10.      /stringsencoding=true;improved:true,compressencrypt:true,cache:true 
  11.      /errorreportingtemplate=auto;continueonerror=true;email="example@example.com" 
  12.      /makepdb=windows 
  13.      /reportappname="hello world" 
  14.      /reportprojectname="testproj" 
  15.      /reportcompanyname="Red Gate Software" 
  16.      /copyDependencies=true
  17.      /copyFiles=web.config;assets\logo.png;"C:\Documents\Visual Studio 2010\Projects\Crasher\Crasher\bin\Release\README.txt"
  18.      /assembly="Crasher";prune:true,merge:true,embed:true,nameobfuscate:true,controlflowobfuscate:3,dynamicproxy:true,compressencryptresources:true
```

--------------------------------

### SmartAssembly Command Line Syntax

Source: https://documentation.red-gate.com/sa8/building-your-assembly/using-the-command-line-mode

General syntax for executing the SmartAssembly console application.

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

--------------------------------

### Configure Strong Name Key File

Source: https://documentation.red-gate.com/sa8/obfuscating-your-code-with-smartassembly/merging-dependencies/merging-assemblies-others-depend-on

Specifies the path to the strong name key file for assembly signing.

```text
  1. keyfilename=[path\to\file.snk | path\to\file.pfx | false]
```

--------------------------------

### Apply Obfuscation Attributes in C#

Source: https://documentation.red-gate.com/sa/using-custom-attributes

Demonstrates applying attributes like DoNotPrune, DoNotObfuscate, and ReportException to classes, methods, properties, and parameters.

```csharp

  1. [DoNotSealType()] 
  2. public class MyClass 
  3. { 
  4. 	[DoNotPrune()] 
  5. 	[DoNotObfuscate()] 
  6. 	public void CalledOnlyByReflection() 
  7. 	{ 
  8. 	} 
  9. 	[DoNotPrune()] 
  10. 	public string MyPropertyCalledByReflection 
  11. 	{ 
  12. 		get 
  13. 		{ 
  14. 			return "hello world"; 
  15. 		} 
  16. 	} 
  17. 	public void DoSomething([DoNotPrune()] string myString) 
  18. 	{ 
  19. 	} 
  20. 	[ReportException()] 
  21. 	[ObfuscateControlFlow()] 
  22. 	public void DoSomethingDangerous() 
  23. 	{ 
  24. 	} 
  25. 	public MyClass() 
  26. 	{ 
  27. 	} 
  28. 	[DoNotPrune()] 
  29. 	public MyClass(string[] args) 
  30. 	{ 
  31. 		//Called only by Reflection 
  32. 	} 
  33. } 
  34.  
  35. [DoNotPruneType()] 
  36. [DoNotObfuscateType()] 
  37. public class OtherClass 
  38. { 
  39. } 



```

```csharp

  1. [ForceObfuscate]
  2. public class ThisClassShouldBeObfuscated
  3. {
  4.     public ThisClassShouldBeObfuscated() { /* obfuscated constructor */ }
  5.  
  6.     [ForceObfuscate(true)]
  7.     public void ThisMethodShouldBeObfuscatedUsingHash(string thisParameterShouldBeObfuscatedUsingHash) { }
  8. }



```

--------------------------------

### Precompile the website

Source: https://documentation.red-gate.com/sa/building-your-assembly/using-smartassembly-with-an-asp-net-website

Use the aspnet_compiler utility to generate precompiled DLLs from your website source code.

```cmd
    1. aspnet_compiler -v "/" -d -p "c:\mywebsite" "c:\mynewwebsite"
```

--------------------------------

### Project Management Commands

Source: https://documentation.red-gate.com/sa8/building-your-assembly/using-the-command-line-mode

Commands for building, creating, or editing SmartAssembly project files.

```text
/build myproject.saproj [options]
```

```text
/create myproject.saproj options
```

```text
/edit myproject.saproj options
```

--------------------------------

### Define additional search directories with HintPaths

Source: https://documentation.red-gate.com/sa8/troubleshooting/unexpected-behavior-and-technical-questions/how-smartassembly-searches-for-dependencies

Add custom directories to the search path by including the HintPaths tag within the Configuration section of the project file.

```xml
  1. <SmartAssemblyProject ...>
  2.   <Configuration Name="Release">
  3.     <HintPaths>
  4.       <Directory>C:\Additional\Search\Path\For\Project\</Directory>
  5.     </HintPaths>
  6.     <Assemblies>
  7.       ...
  8.     </Assemblies>
  9.   </Configuration>
  10.   ...
  11. </SmartAssemblyProject>
```

--------------------------------

### Apply Obfuscation Attributes in VB.NET

Source: https://documentation.red-gate.com/sa/using-custom-attributes

Demonstrates applying attributes in VB.NET using the underscore line continuation character for attribute blocks.

```vbnet

  1. <DoNotSealType()> _ 
  2. Public Class Class1 
  3. 	<DoNotPrune(), DoNotObfuscate()> _
  4. 	Public Sub CalledOnlyByReflection()
  5. 	End Sub
  6. 	<DoNotPrune()> _ 
  7. 	Public ReadOnly Property 
  8. 	MyPropertyCalledByReflection()
  9. 		Get 
  10. 		Return "hello world" 
  11. 		End Get 
  12. 	End Property 
  13. 	Public Sub DoSomething(<DoNotPrune()> ByVal MyString As String) 
  14. 	End Sub 
  15. 	<ReportException()> _ 
  16. 	<ObfuscateControlFlow()> _ 
  17. 	Public Sub DoSomethingDangerous() 
  18. 	End Sub 
  19. 	Public Sub New() 
  20. 	End Sub 
  21. 	<DoNotPrune()> _ 
  22. 	Public Sub New(ByVal args As String()) 
  23. 		REM Called only by Reflection 
  24. 	End Sub 
  25. End Class 
  26.  
  27. <DoNotPruneType(), DoNotObfuscateType()> _ 
  28. Public Class OtherClass 
  29. End Class 



```

```vbnet

  1. <ForceObfuscate>
  2. Public Class ThisClassShouldBeObfuscated
  3.     Public Sub New()
  4.         ' obfuscated constructor
  5.     End Sub
  6.  
  7.     <ForceObfuscate(True)>
  8.     Public Sub ThisMethodShouldBeObfuscatedUsingHash(ByVal thisParameterShouldBeObfuscatedUsingHash As String)
  9.     End Sub
  10. End Class



```

--------------------------------

### Execute a .NET Core application via CLI

Source: https://documentation.red-gate.com/sa8/troubleshooting/unexpected-behavior-and-technical-questions/protecting-net-core-s-exe-files

Use the dotnet CLI to run a .NET Core assembly by specifying the path to the .dll file.

```bash
  1. dotnet.exe path/to/MyAssembly.dll
```

--------------------------------

### Enable Copy Dependencies via Command Line

Source: https://documentation.red-gate.com/sa/building-your-assembly/copying-files-and-dependencies-after-build

Use the /copyDependencies argument to enable the automatic copying of non-merged and non-embedded dependencies.

```text
  1. SmartAssembly.com /edit MyApplication.saproj /copyDependencies=true
```

--------------------------------

### Define Assembly Command Line Parameters

Source: https://documentation.red-gate.com/sa8/obfuscating-your-code-with-smartassembly/merging-dependencies/merging-assemblies-others-depend-on

Configures assembly processing options including pruning, merging, embedding, and signing via the command line.

```text
  1. /assembly="ApiAssembly";prune:true,merge:true,embed:true,keyfilename:PathToFile,keypassword:"KeyPassword"
```

--------------------------------

### Configure SmartAssembly project path for multiple frameworks

Source: https://documentation.red-gate.com/sa8/building-your-assembly/using-smartassembly-with-msbuild/process-a-project-targeting-multiple-frameworks

MSBuild target to dynamically set the SmartAssembly project file path based on the active TargetFramework.

```xml
  1. <!-- ProjectA.csproj -->
  2. <Project Sdk="Microsoft.NET.Sdk">
  3.   ...
  4.  
  5.   <Target Name="SetSmartAssemblyProjectPathForEachTarget" BeforeTargets="BuildWithSmartAssembly">
  6.     <PropertyGroup>
  7.       <SmartAssemblyProjectFile>$(MSBuildProjectDirectory)\$(AssemblyName)_$(TargetFramework).saproj</SmartAssemblyProjectFile>
  8.     </PropertyGroup>
  9.     <Message Importance="High" Text="SmartAssembly project for '$(TargetFramework)' set to: $(SmartAssemblyProjectFile)" />
  10.   </Target>
  11. </Project>
```

--------------------------------

### Enable SmartAssembly MSBuild Logging

Source: https://documentation.red-gate.com/sa/building-your-assembly/using-smartassembly-with-msbuild/logging

Add these properties to your .csproj file to configure console logging, set the verbosity level, and optionally specify a log file path.

```xml
  <PropertyGroup>
    <SmartAssemblyLogToConsole>true</SmartAssemblyLogToConsole>
    <SmartAssemblyLogLevel>Verbose</SmartAssemblyLogLevel> <!-- Available values: Verbose, Warning, Error, None -->
    <SmartAssemblyLogFile>C:\custom\smartassembly.log</SmartAssemblyLogFile> <!-- Optional - will create additional log file in the specified location -->
  </PropertyGroup>
```

--------------------------------

### Copy non-DLL files

Source: https://documentation.red-gate.com/sa/building-your-assembly/using-smartassembly-with-an-asp-net-website

Use xcopy to transfer non-DLL files from the original compiled website to the protected website folder.

```cmd
    1. xcopy c:\mynewwebsite c:\mynewSAwebsite /E /EXCLUDE:\bin\
```

--------------------------------

### Configure the ReportsFolder in Web.config

Source: https://documentation.red-gate.com/sa/configuring-smartassembly/setting-up-a-custom-web-server-for-reporting

Specify the physical path on the web server where uploaded reports will be stored by adding the ReportsFolder key to the appSettings section.

```xml
    1. <configuration>
    2.  ...
    3.   <appSettings>
    4.    <add key="ReportsFolder" value="c:\MyCustomWebServer\" />
    5.   </appSettings>
    6.  ...
    7. </configuration>
```

--------------------------------

### Migrate data from SQL Server to SQLite

Source: https://documentation.red-gate.com/sa/upgrading/migrating-your-smartassembly-database/migrating-between-sqlite-and-sql-server

Use this command to transfer data from a SQL Server instance to a local SQLite database file.

```bash
MigrateDataCore.exe /source=SQLServer /sourceLocation=".\SQLEXPRESS" /target=SQLite /targetLocation="C:\ProgramData\Red Gate\SmartAssembly 8\SmartAssemblySQLite.db"
```

--------------------------------

### Permanently change database settings

Source: https://documentation.red-gate.com/sa8/building-your-assembly/using-the-command-line-mode

Use the /settings switch to update the persistent database configuration.

```text
SmartAssembly.com /settings /dbType=SQLite /dbPath=C:\path\to\sqlite-database-file.db
```

--------------------------------

### Temporarily change database settings

Source: https://documentation.red-gate.com/sa8/building-your-assembly/using-the-command-line-mode

Pass database options directly to build or report commands to override settings for a single session.

```text
SmartAssembly.com /build ConsoleApp.saproj /dbType=SQLite /dbPath=C:\path\to\sqlite-database-file.db
```

```text
SmartAssembly.com /addReport MyReportFile.saencryptedreport /dbType=SQLServer /dbServer="localhost\SQL2016" /dbConn="Server=localhost\SQL2016;Database=SmartAssembly;User Id=regularUser;Password=userPassword;"
```

--------------------------------

### Migrate data from SQLite to SQL Server

Source: https://documentation.red-gate.com/sa/upgrading/migrating-your-smartassembly-database/migrating-between-sqlite-and-sql-server

Use this command to transfer data from a local SQLite database file to a SQL Server instance.

```bash
MigrateDataCore.exe /source=SQLite /sourceLocation="C:\ProgramData\Red Gate\SmartAssembly 8\SmartAssemblySQLite.db" /target=SQLServer /targetLocation=".\SQLEXPRESS"
```

--------------------------------

### Set PFX Key Password

Source: https://documentation.red-gate.com/sa8/obfuscating-your-code-with-smartassembly/merging-dependencies/merging-assemblies-others-depend-on

Provides the password for a PFX key file used in signing.

```text
  1. keypassword=[keypassword | false]
```

--------------------------------

### View Assembly Structure Before Embedding

Source: https://documentation.red-gate.com/sa8/obfuscating-your-code-with-smartassembly/embedding-dependencies

Representation of the assembly structure before dependencies are embedded into the main executable.

```text

  1. internal class InvalidDocumentContentsException : Exception
  2. public sealed class DiscoveryDocument

```

```text

  1. internal class InvalidDocumentContentsException : Exception
  2. internal class LinkGrep

```

```text

  1. public sealed class DiscoveryClientResult
  2. internal struct CallId

```

--------------------------------

### View Assembly Structure After Embedding

Source: https://documentation.red-gate.com/sa8/obfuscating-your-code-with-smartassembly/embedding-dependencies

Representation of the main executable after DLL1 and DLL2 have been embedded as resources.

```text

  1. public sealed class DiscoveryClientResult
  2. internal struct CallId
  3.  
  4. Resource1 (containing compressed/encoded contents of DLL1)
  5. Resource2 (containing compressed/encoded contents of DLL2)

```

--------------------------------

### Execute SmartAssembly task manually

Source: https://documentation.red-gate.com/sa/building-your-assembly/using-smartassembly-with-msbuild

Define a custom MSBuild target to execute the SmartAssembly task with specific project file paths and optional attributes.

```xml
  1. <Target Name="MyCustomSmartAssemblyTarget" AfterTargets="CoreBuild">
  2.   <SmartAssembly ProjectFile="path\to\project.saproj" />
  3. </Target>
  4. <!--
  5. Attribute "ProjectFile" is required for "SmartAssembly" task.
  6. You can use optional attributes:
  7.   OverwriteAssembly="true or false"
  8.   Input="path\to\input\assembly.exe"
  9.   Output="path\to\output\assembly.exe"
  10. -->
```
Tokens:
Raw