EnvObfuscator 2.2.3

There is a newer version of this package available.
See the version list below for details.
dotnet add package EnvObfuscator --version 2.2.3
                    
NuGet\Install-Package EnvObfuscator -Version 2.2.3
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="EnvObfuscator" Version="2.2.3" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="EnvObfuscator" Version="2.2.3" />
                    
Directory.Packages.props
<PackageReference Include="EnvObfuscator" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add EnvObfuscator --version 2.2.3
                    
#r "nuget: EnvObfuscator, 2.2.3"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package EnvObfuscator@2.2.3
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=EnvObfuscator&version=2.2.3
                    
Install as a Cake Addin
#tool nuget:?package=EnvObfuscator&version=2.2.3
                    
Install as a Cake Tool

<div align="center">

EnvObfuscator

Generates Obfuscated Properties from .env File Content

nuget DeepWiki

</div>

 

  • Generates public static Memory<char> properties for each .env entry.
  • Generates Validate_<PropertyName>(ReadOnlySpan<char>) for constant-time comparison.

 

🚀 Getting Started

To avoid embedding "raw data" as an assembly metadata, EnvObfuscator uses preceding block comment as a source.

using EnvObfuscator;

/*
# 👇 Copy & paste .env file content
API_KEY=abc123
SERVICE_URL=https://example.com
SECRET=PA$$WORD
EMPTY=
*/
[Obfuscate(seed: 12345)]  // Omit the argument to use random seed
static partial class EnvSecrets
{
}

How to use the generated properties:

// Always returns a freshly decoded clone each time
var apiKey = EnvSecrets.API_KEY;
var cache = apiKey.ToString();

// Consuming decoded data...

// Zeroing out the span — more for peace of mind than actual security
apiKey.Span.Clear();
cache = "";

// Validation (no decoding, full-length compare to avoid timing differences)
if (EnvSecrets.Validate_SECRET("PA$$WORD"))
{
    //...
}

Diagnostics

  • Missing multiline comment yields a warning.
  • Invalid lines are ignored and reported (first invalid line is shown).
  • Invalid keys (non-identifiers, invalid characters, or duplicates) are errors.
  • Seed value 0 is allowed but warned (deterministic and predictable).
  • Obfuscation keys must be non-zero (error); change the seed to generate different keys.

Known Limitations

Obfuscated name collisions can surface as compiler errors, e.g.: error CS0101: The namespace '<random_namespace>' already contains a definition for '<random_class>' or similar.

 

🕹️ Technical Specs

  • Each non-empty, non-# line is parsed as KEY=VALUE (split on the first =).
    • Keys/values are trimmed; values may contain = after the first.
  • Keys must already be valid C# identifiers.
    • Invalid characters or keywords cause an error.
    • Duplicate names cause an error.
  • Validate_<PropertyName>(ReadOnlySpan<char>) short-circuits only on length mismatch, then performs a full-length compare to avoid leaking timing information.
  • Clear decoded values with Span.Clear() after use to zero sensitive data.
  • Obfuscation details:
    • Builds a base character table from all values + a default extra set.
    • Duplicates the table, XOR-encodes with odd/even keys, then shuffles.
    • Random helpers are emitted into random namespaces with random class/field names.
  • seed (if provided) controls the output deterministically.
    • The type’s assembly-unique identifier is mixed into the seed so each target differs.

Values are trimmed; leading/trailing spaces are not preserved.

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.5.0 69 2/11/2026
2.4.1 214 2/10/2026
2.4.0 136 2/9/2026
2.3.1 221 2/3/2026
2.3.0 83 2/3/2026
2.2.3 263 2/1/2026
2.2.2 96 2/1/2026