SgnSharp 0.2.0

SgnSharp

SgnSharp is a .NET port of EgeBalci's SGN encoder for x86/x64 payloads. It provides a library API and a console utility.

Supported Native Runtimes

The packaged Keystone native runtime currently supports these host runtimes:

• win-x64
• linux-x64
• linux-musl-x64

linux-arm64, win-x86, and macOS are not bundled in this pass.

Building Native Assets And Packages

Build the native Keystone runtime into the shared staging layout:

pwsh ./eng/build-keystone.ps1 -RuntimeIdentifier win-x64

sh ./eng/build-keystone.sh linux-x64
sh ./eng/build-keystone.sh linux-musl-x64

Once all staged runtime assets exist under artifacts/native/runtimes, pack both NuGet artifacts:

pwsh ./eng/pack.ps1
pwsh ./eng/validate-packages.ps1

sh ./eng/pack.sh
sh ./eng/validate-packages.sh

CLI Usage

Build and run from the repo root:

dotnet build
dotnet run --project SgnSharp.Cli -- -i path\to\payload.bin -a 64 -c 2 -M 50 -S -v

CLI Flags

-h, --help               Show help
-i, --input=STRING       Input binary path
-o, --out=STRING         Encoded output binary name
-a, --arch=64            Binary architecture (32/64)
-c, --enc=1              Number of times to encode the binary
-M, --max=50             Maximum number of bytes for decoder obfuscation
    --plain              Do not encode the decoder stub
    --ascii              Generate ASCII printable payload (not supported yet)
-S, --safe               Preserve all register values
    --badchars=STRING    Disallow specified bytes in hex form (not supported yet)
    --seed=BYTE          Hex seed value (e.g. 0x2a)
-v, --verbose            Verbose output
    --version            Show version

Notes

• --ascii and --badchars are not implemented yet and will return an error.
• The library and CLI both load Keystone from bundled runtime assets under runtimes/<rid>/native.
• Package builds expect staged native assets for all supported runtimes before dotnet pack runs.
• Third-party notice and upstream license links are tracked in THIRD-PARTY-NOTICES.md.

Library Usage

using SgnSharp;
using SgnSharp.Types;

var payload = File.ReadAllBytes("myfile.bin");
var encoder = new Encoder(
    Arch.x64,
    obfuscationLimit: 50,
    plainDecoder: false,
    encodingCount: 1,
    saveRegisters: false
);

var result = encoder.Encode(payload);
if (result.IsFailure)
{
    Console.WriteLine(result.Error);
    return;
}

File.WriteAllBytes("myfile.bin.sgn", result.Value);