ModCrypt 1.2.0

dotnet add package ModCrypt --version 1.2.0
                    
NuGet\Install-Package ModCrypt -Version 1.2.0
                    
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="ModCrypt" Version="1.2.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="ModCrypt" Version="1.2.0" />
                    
Directory.Packages.props
<PackageReference Include="ModCrypt" />
                    
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 ModCrypt --version 1.2.0
                    
#r "nuget: ModCrypt, 1.2.0"
                    
#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 ModCrypt@1.2.0
                    
#: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=ModCrypt&version=1.2.0
                    
Install as a Cake Addin
#tool nuget:?package=ModCrypt&version=1.2.0
                    
Install as a Cake Tool

ModCrypt

A lightweight .NET encryption library for protecting application secrets using X.509 certificates or SecretKey.

ModCrypt uses a hybrid encryption approach:

  • AES for encrypting the secret data.
  • RSA (from an X.509 certificate) for encrypting the AES key.
  • Supports secure decryption using the certificate private key.

This makes it suitable for:

  • Encrypting configuration values
  • Protecting connection strings
  • Storing API keys securely

Features

  • Hybrid AES + RSA encryption
  • X509 certificate-based security
  • Supports .NET applications hosted in:
    • IIS
    • Windows Services
    • Console Applications
    • ASP.NET Core
  • Configuration provider for encrypted JSON values
  • NuGet friendly

Installation

dotnet add package Modulith.ModCrypt

or via NuGet Package Manager:

Install-Package Modulith.ModCrypt

Certificate Requirements

The certificate must:

  • Be an X509 certificate with RSA private key
  • Supports .pfx and .pem automatically.

How to plugin ModCrypt Library in the Middleware Pipelines inside Program.cs

ProtectedJsonMode

  • Auto - Recommended - (check and encrypt automatically)
  • Encrypt
  • Decrypt

Program.cs

Using Certificate

Example:


using System.Security.Cryptography.X509Certificates;

var cert = X509CertificateLoader.LoadPkcs12FromFile("certificate.pfx", "yourcerticatepassword", X509KeyStorageFlags.PersistKeySet);
var configcrypt = builder.Configuration.AddJsonFile("appsettings.json", optional: false).AddProtectedJsonFile("appsettings.json", new CertificateSecretProtector(cert), ProtectedJsonMode.Auto, encryptedKeyExpressions: new Regex("DBConnectString|EmailUsername|EmailPassword")).Build();


Using Secret-Key


builder.Configuration.AddProtectedJsonFile(path: "appsettings.json",protector: new PasswordSecretProtector("SuperSecret!"),mode: ProtectedJsonMode.Auto,optional: false,reloadOnChange: true,encryptedKeyExpressions: new Regex("DBConnectString|EmailUsername|EmailPassword"));

appsetting.json file

     "DBConnectString" : "Your Connection String",
     "EmailUsername" : "Email Username",
     "EmailPassword" : "Email Password"
}

ASP.NET Core Configuration Encryption

Example:

appsettings.json

{
     "DBConnectString" : "Your Connection String",
     "EmailUsername" : "Email Username",
     "EmailPassword" : "Email Password"
}

Program.cs

var builder = WebApplication.CreateBuilder(args);

//register encrypted configuration provider

var cert = X509CertificateLoader.LoadPkcs12FromFile("certificate.pfx", "yourcerticatepassword", X509KeyStorageFlags.PersistKeySet);
var configcrypt = builder.Configuration.AddJsonFile("appsettings.json", optional: false).AddProtectedJsonFile("appsettings.json", new CertificateSecretProtector(cert), ProtectedJsonMode.Auto, encryptedKeyExpressions: new Regex("DBConnectString|EmailUsername|EmailPassword")).Build();

Read configuration normally:

var conn = builder.Configuration.GetConnectionString("DBConnectString");

The encrypted value is decrypted automatically.


IIS Hosting Requirements

When hosting in IIS:

Application Pool 
  -> Your App Pool
     -> Advanced Settings
        -> Change User Identity to LocalService
            -> Load User Profile = True

Common IIS Error

If you encounter:

System.Security.Cryptography.CryptographicException:

The system cannot find the file specified.

Usually this means:

  • Certificate is installed in CurrentUser store
  • Private key permissions are missing
  • IIS App Pool cannot access the key container
  • The PFX was imported without its private key

Example

var cert = new X509Certificate2(
    "mycert.pfx",
    "password",
    X509KeyStorageFlags.MachineKeySet |
    X509KeyStorageFlags.PersistKeySet);

var protector = new CertificateSecretProtector(cert);

var encrypted = protector.Encrypt("Server=db;");

var decrypted = protector.Decrypt(encrypted);

Console.WriteLine(decrypted);

Output:

Server=db;

Security Notes

  • Keep the PFX password secure.
  • Store certificates in LocalMachine store for IIS applications.
  • Limit private key permissions to only required service accounts.
  • Never commit certificates or passwords into source control.

Supported Frameworks

  • .NET 8
  • ASP.NET Core
  • IIS
  • Windows Server

License

MIT License

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in 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
1.2.0 118 8/19/2026
1.0.0 2,090 6/16/2026