EncryptionUtils.Cryptography 1.0.0

🔐 EncryptionUtils

EncryptionUtils is a lightweight, modular cryptography framework for .NET — providing unified abstractions for encryption, hashing, and encryption-aware JSON serialization with minimal dependencies and maximum flexibility.

📘 Overview

EncryptionUtils is built around a simple but powerful concept: abstraction first.
Every cryptographic algorithm, hasher, and JSON converter implements one of three interfaces:

• IEncryptionAlgorithm
• IHasher
• IJsonConverter

This unified design allows you to:

• 🔄 Swap algorithms at runtime with dependency injection
• 🧩 Mix and match implementations
• ⚙️ Extend with your own algorithms easily

⚙️ Installation

dotnet add package EncryptionUtils.Cryptography.Algorithms
dotnet add package EncryptionUtils.Serialization.TextJson
# or
dotnet add package EncryptionUtils.Serialization.Newtonsoft

🚀 Quick Start

Example 1 — General Project Usage (AES-GCM 256)

using EncryptionUtils.Cryptography.Algorithms;

// Base64 key and IV
var key = "bVd8bJcX7v3WyqfWAWp6xPq5L9Z4Hq0QOStvzQ7XjCk=";
var iv  = "QmFzZTY0SVY=";

var aes = new AESGCM(key, iv);

string plainText = "Confidential message";
string encrypted = aes.Encrypt(plainText);
string decrypted = aes.Decrypt(encrypted);

Console.WriteLine($"Encrypted: {encrypted}");
Console.WriteLine($"Decrypted: {decrypted}");

Example 2 — Dependency Injection Setup (ASP.NET Core)

using EncryptionUtils.Cryptography.Algorithms;
using EncryptionUtils.Cryptography.Interfaces_Abstracts;
using Microsoft.Extensions.DependencyInjection;

var services = new ServiceCollection();

// Register AES-GCM 256 with DI
services.AddSingleton<IEncryptionAlgorithm>(_ =>
    new AESGCM(
        key: "bVd8bJcX7v3WyqfWAWp6xPq5L9Z4Hq0QOStvzQ7XjCk=",
        iv:  "QmFzZTY0SVY="));

var provider = services.BuildServiceProvider();
var aes = provider.GetRequiredService<IEncryptionAlgorithm>();

string data = "API secret";
string cipher = aes.Encrypt(data);
string plain  = aes.Decrypt(cipher);

Console.WriteLine($"Decrypted: {plain}");

🧩 Key Components

🔐 Encryption-Aware Serialization

Automatically encrypt and decrypt marked properties during JSON (de)serialization.

Example — Using System.Text.Json

using EncryptionUtils.Serialization.Attributes;

public class User
{
    public string Name { get; set; }

    [Encrypt]
    public string Password { get; set; }
}

using EncryptionUtils.Serialization.TextJson;
using EncryptionUtils.Serialization.Core;
using EncryptionUtils.Cryptography.Algorithms;

var aes = new AESGCM(256);
var converter = new TextJsonConverter();
var serializer = new EncryptedJsonSerializer(converter, aes);

var user = new User { Name = "Alice", Password = "SuperSecret" };

string json = await serializer.SerializeAsync(user);   // Password is encrypted
var restored = await serializer.DeserializeAsync<User>(json); // Password is decrypted

Example — Using Newtonsoft.Json

using EncryptionUtils.Serialization.Newtonsoft;
using EncryptionUtils.Serialization.Core;
using EncryptionUtils.Cryptography.Algorithms;
using EncryptionUtils.Serialization.Attributes;

public class Account
{
    public string Username { get; set; }

    [Encrypt]
    public string ApiKey { get; set; }
}

var aes = new AESGCM(256);
var converter = new NewtonsoftJsonConverter();
var serializer = new EncryptedJsonSerializer(converter, aes);

var account = new Account { Username = "valadis", ApiKey = "TopSecretKey" };

string json = await serializer.SerializeAsync(account);
Console.WriteLine(json); // ApiKey is encrypted

var restored = await serializer.DeserializeAsync<Account>(json);
Console.WriteLine(restored.ApiKey); // decrypted back to "TopSecretKey"

🧠 Philosophy

• 🪶 Lightweight: minimal dependencies, pure C#
• 🧩 Modular: plug-and-play architecture
• 💡 Flexible: your own algorithms can implement the same interfaces
• ⚖️ Consistent: identical usage patterns across all algorithm types

📦 Project Structure

EncryptionUtils/
├── EncryptionUtils.Cryptography/
│   └── Interfaces_Abstracts/
├── EncryptionUtils.Cryptography.Algorithms/
├── EncryptionUtils.Serialization/
├── EncryptionUtils.Serialization.TextJson/
├── EncryptionUtils.Serialization.Newtonsoft/
└── EncryptionUtils.Tests/

⚖️ License

• Main projects: MIT License
• Algorithms project includes Scrypt.NET (Apache 2.0)

❤️ Contributing

Contributions and ideas are welcome!
Please open an issue or pull request on GitHub.

👨‍💻 Author

Valadis Pitsas
GitHub: @cpitsas
NuGet: EncryptionUtils.Cryptography

✅ TL;DR

A clean, consistent, and extensible cryptography abstraction layer for .NET —
simple to use, powerful to extend, and ready for production.