Simple.PasswordGenerator 1.0.3

Simple.PasswordGenerator

🚀 Overview

Simple.PasswordGenerator is a lightweight, secure password generator for .NET applications.
It creates cryptographically strong passwords based on customizable policies — including length, required character types, and special characters.

No dependencies beyond .NET. Simple to integrate, flexible to configure, and safe to use.

🔑 Key Features

• 🔐 Cryptographically secure password generation
• ⚙️ Fully customizable policies (length, uppercase, lowercase, digits, special chars)
• 🎯 Default policy with sensible security defaults
• 🔄 Supports configuration via lambda or predefined policy objects
• 🧩 Compatible with .NET 8 and later

📚 Table of Contents

1. Getting Started
   • Installing
   • Basic Usage
   • Advanced Usage
2. Examples
3. Technical Information
4. Known Issues & Limitations
5. Contributing
6. License

🚦 Getting Started

Use Simple.PasswordGenerator to generate strong, policy-compliant passwords easily.

📦 Installing

Add the package via NuGet:

dotnet add package Simple.PasswordGenerator

🧪 Basic Usage

var generator = new PasswordGenerator();
var password = generator.Generate();
Console.WriteLine($"Generated password: {password}");

🎯 Advanced Usage

Configure a custom password policy using a lambda:

var password = generator.Generate(policy =>
{
    policy.Length = 20;
    policy.RequireSpecial = false;
    policy.RequireDigit = true;
    policy.RequireUppercase = true;
    policy.RequireLowercase = true;
});

Or generate using a predefined PasswordPolicy object:

var policy = new PasswordPolicy
{
    Length = 12,
    RequireSpecial = true,
    RequireDigit = true,
    RequireUppercase = false,
    RequireLowercase = true,
    SpecialCharacters = "@#$"
};
var passwordFromPolicy = generator.Generate(policy);

🖼️ Examples

using Simple.PasswordGenerator;

var passwordGenerator = new PasswordGenerator();

// Default policy password
var defaultPassword = passwordGenerator.Generate();
Console.WriteLine($"Default policy password: {defaultPassword}");

// Custom policy via lambda
var customPassword = passwordGenerator.Generate(policy =>
{
    policy.Length = 20;
    policy.RequireSpecial = false;
    policy.RequireDigit = true;
    policy.RequireUppercase = true;
    policy.RequireLowercase = true;
});
Console.WriteLine($"Custom policy password: {customPassword}");

// Using a PasswordPolicy instance
var policyInstance = new PasswordPolicy
{
    Length = 12,
    RequireSpecial = true,
    RequireDigit = true,
    RequireUppercase = false,
    RequireLowercase = true,
    SpecialCharacters = "@#$"
};
var policyPassword = passwordGenerator.Generate(policyInstance);
Console.WriteLine($"Password from policy instance: {policyPassword}");

🔬 Technical Information

• Uses System.Security.Cryptography.RandomNumberGenerator for secure randomization
• Password policy validation ensures minimum length and at least one character from required categories
• Character categories: uppercase, lowercase, digits, and customizable special characters
• Password characters shuffled with Fisher–Yates algorithm for unpredictability

🐞 Known Issues & Limitations

• No support yet for exclusion of ambiguous characters (e.g., 'O' vs '0')
• No built-in localization or culture-specific character sets
• Does not support password strength estimation or entropy reporting

🤝 Contributing

Bug reports, feature requests, and pull requests are welcome!
Please open an issue or submit a PR via GitHub Issues.

📄 License

This project is licensed under the MIT License.