PreEmptive Solutions Dotfuscator Test Samples

🚀 Overview

This repository houses a collection of test sample projects designed to demonstrate various C# application types and common language constructs. These samples serve as a robust test bed for Dotfuscator, providing diverse scenarios to validate its obfuscation, protection, and hardening capabilities across different Microsoft .NET platforms.

👥 Audience

This repository is primarily intended for the technical team responsible for developing, testing, and maintaining Dotfuscator. The samples provide practical, code-based scenarios to aid in product validation, feature development, and understanding Dotfuscator's behavior across various application types.

🌿 Versioning Strategy

To effectively support Dotfuscator's non-regression testing across different .NET framework versions, this repository utilizes a folder-based versioning strategy within the main branch, allowing for clear separation and targeted backporting.

main Branch Structure:

• The main branch contains top-level directories, each dedicated to a specific .NET framework version (e.g., dotnet8.0/, dotnet6.0/).
• Each of these directories holds a complete solution (.sln) and its associated projects, all configured specifically for that particular .NET version.
• For example:

/
├── dotnet10.0/
│   └── Samples.sln (configured for .NET 10)
│       ├── Samples.Console/
│       └── ... (other .NET 10 projects)
├── dotnet9.0/
│   └── Samples.sln (configured for .NET 9)
│       ├── Samples.Console/
│       └── ... (other .NET 9 projects)
├── dotnet8.0/
│   └── Samples.sln (configured for .NET 8)
│       ├── Samples.Console/
│       └── ... (other .NET 8 projects)
├── dotnet6.0/
│   └── Samples.sln (configured for .NET 6)
│       ├── Samples.Console/
│       └── ... (other .NET 6 projects)
└── README.md

Latest Supported Version:

• The dotnetX.Y/ directory corresponding to the latest supported .NET version (e.g., dotnet8.0/) serves as the primary development area. All new development, feature enhancements, and initial fixes for cutting-edge samples are introduced in the projects within this directory.

Backporting Changes:

• When an enhancement, new sample syntax, or bug fix (such as adding an inheritance example after identifying an issue) is implemented within the projects of the latest supported .NET version directory, it can be manuallybackported to the projects in relevant older .NET version directories (e.g., copying the updated class/file from dotnet8.0/ to dotnet6.0/).
• This ensures that critical test scenarios and improvements are propagated to all necessary historical versions, maintaining a robust suite for comprehensive non-regression testing, all within the main branch's history..

✨ Key Features

Microsoft Stack Focus: All projects are built using the Microsoft .NET ecosystem and C#.

Diverse Frameworks: The solution includes projects targeting a variety of .NET application models:

• .NET API
• WPF (Windows Presentation Foundation)
• MAUI (Multi-platform App UI)
• Console App
• Windows Forms

Comprehensive C# Constructs: Each project is intentionally designed to incorporate a range of C# language features and application patterns, including but not limited to:

• Object-Oriented Programming (OOP) Concepts: Abstract classes, virtual methods, interfaces, inheritance, polymorphism.
• Resource Handling: Usage of file resources, embedded resources, and other asset types.

📦 Project Structure & Naming Convention

The solution is organized to clearly identify the target platform for each sample.

Naming Convention: All projects adhere to the following naming convention: Samples.{TargetPlatform} Examples:

• Samples.Console
• Samples.Api
• Samples.Maui
• Samples.WPF
• Samples.WinForms

🛠️ Installation Guidelines

To get started with these test samples, follow these simple steps:

1. Clone the Repository:

git clone https://github.com/preemptive/dotfuscator-test-samples-core.git

2. Install .NET SDK: Ensure you have the .NET SDK installed for the Target Framework. You can download it from the official Microsoft .NET website: https://dotnet.microsoft.com/download

3. Install Dotfuscator - latest version

4. Configuration environment variables. Note: Some of the environment variables may already been set up in Windows after Dotfuscator installation.

DOTFUSCATOR_HOME - The location of dotfuscaotr installer
Windows: typically found at C:\Program Files (x86)\PreEmptive Protection Dotfuscator Professional (version)\
Linux/Mac: typically found at {{nugetInstalledDir}}/PreEmptive.Protection.Dotfuscator.Pro/tools/programdir/netcore

DOTFUSCATOR_MSBUILDPATH - The location of dotfuscator msbuild
Windows: typically found at C:\Program Files (x86)\MSBuild\PreEmptive\Dotfuscator\7
Linux/Mac: typically found at  {{nugetInstalledDir}}/PreEmptive.Protection.Dotfuscator.Pro/tools/msbuilddir

export DOTFUSCATOR_LICENSE=xxxxxxx:[email protected]

5. Navigate to the root folder of a specific dotnet sdk and build the Solution / Project using .NET CLI

dotnet build -c Release

This command will restore any necessary NuGet packages and compile all projects within the solution.

Obfuscating and running a project using CLI

1. Go to the root directory of the target project
2. dotnet build -c {projectName}
3. dotfuscator.exe DotfuscatorConfig.xml -v
4. dotnet run

📜 License

This repository is intended for test and demonstration purposes only. All usage must comply with your organization's license for PreEmptive Dotfuscator.