Pandatech.Crypto 2.0.0

PandaTech.Crypto

Introduction

Pandatech.Crypto is a powerful cryptographic utility library backed by 99% test coverage through unit tests. The library offers an array of static methods for secure data operations, including AES256 encryption and decryption, Argon2Id password hashing and verification, as well as utilities for generating cryptographic random bytes and passwords.

Designed to work efficiently in containerized environments, the library performs effectively even with limited resources—hash generation takes under 500ms on a container with 1 vCore and 1GB of RAM.

Features

• AES 256-bit Encryption/Decryption: Encrypt your data and get the IV and encrypted bytes in one array. Decrypt it back to its original form, seamlessly handling the IV. Note that you have option to encrypt with hash and decrypt ignoring hash. (for cases where you want to apply filtering on the encrypted data or check uniqueness of the encrypted data)
• Argon2Id Hashing: Hash and verify passwords securely with an immutable configuration that's optimized for performance.
• SHA-3 Hashing: Generate and verify SHA-3 hashes with 512-bit output.
• Random Number/Password Generation: Generate cryptographic random bytes, AES256 keys, or strong passwords with specific character sets.
• Performance Optimized: Tested to run efficiently in resource-constrained environments.
• High Test Coverage: Confidence backed by 99% unit test coverage.

Installation

To use PandaTech.Crypto in your project, install the NuGet package using the following command in the Package Manager Console: Install-Package PandaTech.Crypto or, search for "PandaTech.Crypto" in the NuGet Package Manager and install it from there.

How to Use

1. AES256 Class

Configurations

1. IV: A random IV is generated for each Encryption, enhancing security.
2. PaddingMode: PKCS7

Methods

1. Encrypt(string plainText): Encrypts a plain text using a default environment variable key.
2. Encrypt(string plainText, string key): Encrypts a plain text using a given key.
3. Decrypt(byte[] cipherText): Decrypts to plain text using a default environment variable key.
4. Decrypt(byte[] cipherText, string key): Decrypts to plain text using a given key.
5. EncryptWithHash(string plainText): Encrypts and appends SHA-3 hash. (for cases where you want to apply filtering on the encrypted data)
6. DecryptIgnoringHash(byte[] cipherTextWithHash): Decrypts while ignoring SHA-3 hash. (for cases where you want to apply filtering on the encrypted data)
7. EncryptWithHash(string plainText, string key): Encrypts using a given key and appends SHA-3 hash. (for cases where you want to apply filtering on the encrypted data)
8. DecryptIgnoringHash(byte[] cipherTextWithHash, string key): Decrypts using a given key while ignoring SHA-3 hash. (for cases where you want to apply filtering on the encrypted data) Encryption and decryption with environment variable key

// Example for basic encryption and decryption
Environment.SetEnvironmentVariable("AES_KEY", Random.GenerateAes256KeyString());
var encryptedData = Aes256.Encrypt("PlainText");
var decryptedData = Aes256.Decrypt(encryptedData);

// Example for encryption with hash
var encryptedWithHash = Aes256.EncryptWithHash("PlainText");

// Example for decryption ignoring hash
var decryptedIgnoringHash = Aes256.DecryptIgnoringHash(encryptedWithHash);

2. Argon2id Class

Configurations

1. Salt: A random salt is generated for each password hash, enhancing security.
2. DegreeOfParallelism: 8
3. Iterations: 5
4. MemorySize: 128 MB

Hash password and verify hash

// Example usage for hashing
var hashedPassword = Argon2Id.HashPassword("yourPassword");

// Example usage for verifying a hash
var isPasswordValid = Argon2Id.VerifyHash("yourPassword", hashedPassword);

3. Random Class

var randomBytes = Random.GenerateBytes(16);
var aesKey = Random.GenerateAes256KeyString();

4. RandomPassword Class

var includeUppercase = true;
var includeLowercase = true;
var includeDigits = true;
var includeSpecialChars = true;
string password = RandomPassword.Generate(16, includeUppercase, includeLowercase, includeDigits, includeSpecialChars);

5. Sha3 Class

// Example usage for generating hash
var sha3Hash = Sha3.Hash("yourPlainText");

// Example usage for verifying a hash
var isHashValid = Sha3.VerifyHash("yourPlainText", sha3Hash);

License

PandaTech.Crypto is licensed under the MIT License.

Your Security, Our Priority.