SH.Framework.Library.Generators 1.1.0

SH Framework - Generators Library

A secure character and code generator library for .NET applications. Provides cryptographically secure random string generation with support for alphabetic, numeric, alphanumeric, and symbol character sets with customizable formats and patterns.

Features

• Cryptographically Secure: Uses RandomNumberGenerator for secure random generation
• Multiple Character Types: Support for alphabetic, numeric, alphanumeric, and symbol characters
• Custom Character Sets: Combine multiple character types or provide custom character sets
• Formatted Code Generation: Generate codes with specific patterns using format strings
• High Performance: Optimized for speed and memory efficiency
• Thread Safe: Safe for use in multi-threaded applications

Installation

Install the package via NuGet Package Manager:

dotnet add package SH.Framework.Library.Generators

Or via Package Manager Console:

Install-Package SH.Framework.Library.Generators

Quick Start

using SH.Framework.Library.Generators;

var generator = new CharacterGenerator();

// Generate a 6-character alphanumeric code (default)
var code = generator.Generate();
// Output: "A7xK9m"

// Generate a 10-character numeric code
var numericCode = generator.GenerateNumericCode(10);
// Output: "4729581063"

// Generate with specific character type
var alphabetic = generator.Generate(8, CharacterType.Alphabet);
// Output: "KmPqRsXz"

Usage Examples

Basic Generation

var generator = new CharacterGenerator();

// Default: 6 characters, alphanumeric
var defaultCode = generator.Generate();

// Specify length and character type
var customCode = generator.Generate(12, CharacterType.Alphanumeric);

// Numeric codes (useful for verification codes)
var verificationCode = generator.GenerateNumericCode(6);

Multiple Character Types

// Combine multiple character types
var mixedCode = generator.Generate(10, 
    CharacterType.Alphabet, 
    CharacterType.Numeric, 
    CharacterType.Symbol);

// This will include letters, numbers, and symbols

Custom Character Sets

// Use custom character sets
var customCode = generator.Generate(8, "ABCDEF", "123456");
// Will only use characters A-F and numbers 1-6

// Vowels only
var vowelCode = generator.Generate(6, "AEIOU");

Formatted Code Generation

Generate codes with specific patterns using format strings:

// Format characters:
// A = Any alphabet character (upper or lower case)
// N = Any numeric character
// B = Any alphanumeric character  
// L = Any alphabet character (lowercase only)
// S = Any symbol character
// Any other character = literal character

var formattedCode = generator.GenerateFormattedCode("AAA-NNN");
// Output: "KmP-847"

var licenseKey = generator.GenerateFormattedCode("AAAA-BBBB-NNNN");
// Output: "XYZW-A7B9-1234"

var strongPassword = generator.GenerateFormattedCode("LLLLSSNNN");
// Output: "abcd!@123"

Advanced Examples

// Generate a secure API key
var apiKey = generator.Generate(32, CharacterType.Alphanumeric);

// Generate a temporary password with symbols
var tempPassword = generator.Generate(12, 
    CharacterType.Alphabet, 
    CharacterType.Numeric, 
    CharacterType.Symbol);

// Generate a user-friendly code (no ambiguous characters)
var friendlyCode = generator.Generate(8, "ABCDEFGHJKLMNPQRSTUVWXYZ23456789");

// Generate a formatted product key
var productKey = generator.GenerateFormattedCode("AAAA-BBBB-CCCC-DDDD");

Character Types

Security Features

• Cryptographically Secure: Uses System.Security.Cryptography.RandomNumberGenerator for all random data generation.
• Uniform Distribution: Ensures a perfectly uniform character distribution by using bias-free random number generation, eliminating vulnerabilities like "modulo bias".
• No Predictable Patterns: The generated output is computationally indistinguishable from a true random sequence.
• Thread-Safe: Safe for use in concurrent, multi-threaded applications.

Performance

The library is optimized for high-performance scenarios and built to be lightweight.

• Optimized Memory Usage: Refactored to minimize memory allocations, especially for generating long strings, resulting in a low memory footprint.
• Efficient Character Set Handling: Processes custom and combined character sets effectively.
• Fast Generation: Leverages modern .NET APIs for high-speed random string creation.
• High-Throughput Ready: Suitable for demanding applications requiring a large volume of generated codes or strings.ns

Requirements

• .NET 9.0 or higher
• No external dependencies (uses only .NET BCL)

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Support

If you encounter any issues or have questions, please open an issue on GitHub.

SH Framework - Building robust .NET applications, one library at a time.