Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mika-f/plana
Plana is a powerful general purpose obfuscator for C#, but optimized for Unity and UdonSharp, containing a variety of features which provide protection for your source code from the hackers
https://github.com/mika-f/plana
csharp dotnet obfuscate obfuscation obfuscator protection security udonsharp unity vrchat
Last synced: 4 days ago
JSON representation
Plana is a powerful general purpose obfuscator for C#, but optimized for Unity and UdonSharp, containing a variety of features which provide protection for your source code from the hackers
- Host: GitHub
- URL: https://github.com/mika-f/plana
- Owner: mika-f
- License: mit
- Created: 2023-10-22T12:54:25.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-16T19:32:53.000Z (8 months ago)
- Last Synced: 2024-05-02T02:21:28.055Z (7 months ago)
- Topics: csharp, dotnet, obfuscate, obfuscation, obfuscator, protection, security, udonsharp, unity, vrchat
- Language: C#
- Homepage: https://docs.natsuneko.com/plana
- Size: 655 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Plana
Plana is a powerful general purpose obfuscator for C#, but optimized for Unity and UdonSharp, containing a variety of features which provide protection for your source code from the hackers.
## Key Features
- cli and unity integration
- support C#, Unity C#, and UdonSharp
- pluggable
## Official Plugins
- (Planned) Plana.Composition.ControlFlowFlattening
- (Planned) Plana.Composition.DeadCodeInjection
- Plana.Composition.DisableConsoleOutput
- (Planned) Plana.Composition.NumbersToExpressions
- Plana.Composition.RenameSymbols
- Plana.Composition.ShuffleDeclarations
- (Planned) Plana.Composition.SourceMaps
- (Planned) Plana.Composition.SplitStrings
- (Planned) Plana.Composition.StringEncryption
## How to use
You can use Plana from any integrations.
### Command Line
```bash
# assembly level obfuscate
$ plana-cli obfuscate --workspace ./YourUdonSharpProject.csproj --plugins ./plugins/ --rename-symbols --control-flow-flattening --source-maps
# project level obfuscate
$ plana-cli obfuscate --workspace ./YourUnityProject.sln --plugins ./plugins/ --rename-symbols --control-flow-flattening --source-maps
```
Please visit https://docs.natsuneko.com/plana/integrations/cli for more information.
### Unity Integration
See https://docs.natsuneko.com/plana/integrations/unity
### Desktop Integration (for Windows and Linux)
See https://docs.natsuneko.com/plana/integrations/desktop
## Develop Plugin
You can add any behaviour to Plana, by plugin system.
1. create a C# project with .NET 8.
2. add a new reference of `Plana.Composition.Abstractions` to project
1. also add `Plana.Composition.Extensions` for useful extension methods
3. create a new C# source with the following template:
```csharp
using System.Runtime.CompilerServices;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Plana.Composition.Abstractions;
using Plana.Composition.Abstractions.Attributes;
using Plana.Composition.Extensions;
[assembly: InternalsVisibleTo("Plana.Composition.YourFirstPlugin.Tests")]
namespace Plana.Composition.YourFirstPlugin;
[PlanaPlugin("your-first-plugin")]
public class YourFirstPlugin : IPlanaPlugin2
{
private static readonly PlanaPluginOption Flag = new("flag", "Flag Option", "this is flag option", false);
internal bool IsFlagged;
public IReadOnlyCollection Options => new List { Flag }.AsReadOnly();
public string Name => "Your First Plugin";
public void BindParameters(IPlanaPluginParameterBinder binder)
{
IsFlagged = binder.GetValue(FlagOption);
}
public async Task ObfuscateAsync(IPlanaPluginRunContext context)
{
foreach (var document in context.Solution.Projects.SelectMany(w => w.Documents))
{
var oldNode = await document.SyntaxTree.GetRootAsync(context.CancellationToken);
var newNode = // create a new node
await document.ApplyChangesAsync(newNode, context.CancellationToken);
}
}
}
```
4. add the following lines to csproj:
```xml
true
$(CI)
```
## License
MIT by [@6jz](https://twitter.com/6jz)