KeyRotation 1.1.1

Supported Frameworks

• .NET Framework 4.5, 4.6, 4.8
• .NET Core 2.1, 3.1
• .NET 5, 6, 7, 8

Installation

Install the package via NuGet Package Manager:

dotnet add package KeyRotation

Or via Package Manager Console:

Install-Package KeyRotation

Usage

Basic Usage

using KeyRotation;

// Encrypt an API key with current UTC date
string apiKey = "your-api-key-here";
string encryptedKey = KeyRotationHelper.EncryptApiKey(apiKey);
Console.WriteLine($"Encrypted Key: {encryptedKey}");

Advanced Usage

using KeyRotation;
using System;

// Encrypt with specific UTC date
DateTime specificDate = new DateTime(2024, 1, 15, 0, 0, 0, DateTimeKind.Utc);
string apiKey = "your-api-key-here";
string encryptedKey = KeyRotationHelper.EncryptApiKey(apiKey, specificDate);

// Validate encrypted key
bool isValid = KeyRotationHelper.ValidateApiKey(apiKey, encryptedKey, specificDate);
Console.WriteLine($"Key is valid: {isValid}");

// Validate with time tolerance (±5 minutes) to handle server/client time differences
bool isValidWithTolerance = KeyRotationHelper.ValidateApiKey(apiKey, encryptedKey, 5);
Console.WriteLine($"Key is valid with tolerance: {isValidWithTolerance}");

// Validate with specific date and tolerance
bool isValidWithSpecificTolerance = KeyRotationHelper.ValidateApiKey(apiKey, encryptedKey, specificDate, 10);
Console.WriteLine($"Key is valid with 10-minute tolerance: {isValidWithSpecificTolerance}");

// Get date string for specific date
string dateString = KeyRotationHelper.GetDateString(specificDate);
Console.WriteLine($"Date string: {dateString}"); // Output: 20240115

Example

API Reference

EncryptApiKey(string apiKey)

Encrypts an API key using the current UTC date.

Parameters:

• apiKey (string): The API key to encrypt

Returns: SHA256 hash as a hexadecimal string

Exceptions:

• ArgumentNullException: When apiKey is null
• ArgumentException: When apiKey is empty or whitespace

EncryptApiKey(string apiKey, DateTime utcDateTime)

Encrypts an API key using a specific UTC date.

Parameters:

• apiKey (string): The API key to encrypt
• utcDateTime (DateTime): The UTC datetime to use for encryption

Returns: SHA256 hash as a hexadecimal string

Exceptions:

• ArgumentNullException: When apiKey is null
• ArgumentException: When apiKey is empty or whitespace

ValidateApiKey(string apiKey, string encryptedKey)

Validates an encrypted API key against the current UTC date.

Parameters:

• apiKey (string): The original API key
• encryptedKey (string): The encrypted key to validate

Returns: true if valid, false otherwise