Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maymeow/maymeow.cryptography
🔐 Wrapper arround .NET Cryptography library
https://github.com/maymeow/maymeow.cryptography
cryptography csharp dotnet dotnet-core dotnet-standard hacktoberfest hacktoberfest2021 nuget-package
Last synced: 6 days ago
JSON representation
🔐 Wrapper arround .NET Cryptography library
- Host: GitHub
- URL: https://github.com/maymeow/maymeow.cryptography
- Owner: MayMeow
- License: mit
- Created: 2020-02-07T21:25:19.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-03T19:37:14.000Z (9 months ago)
- Last Synced: 2024-11-07T10:03:21.123Z (6 days ago)
- Topics: cryptography, csharp, dotnet, dotnet-core, dotnet-standard, hacktoberfest, hacktoberfest2021, nuget-package
- Language: C#
- Homepage: https://www.nuget.org/packages/MayMeow.Cryptography/
- Size: 85.9 KB
- Stars: 17
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# MayMeow.Cryptography
Wrapper arround .NET Cryptography library.
[](https://ko-fi.com/D1D5DMOTA)
## Installation
This library can be installed to your project with NuGet package manager
```powershell
Install-Package MayMeow.Cryptography -Version 1.1.0
```
or with dotnet cli
```powershell
dotnet add package MayMeow.Cryptography --version 1.1.0
```
For more installation methods refer [NuGet page](https://www.nuget.org/packages/MayMeow.Cryptography) of this project.
## Usage
### Using this library
Use in you project
```csharp
using MayMeow.Cryptography;
```
### AES encryption (symmetric one)
- Symmetric-key algorithm
- Approved and used by NSA
- Much faster than DES and 3DES for bulk data encryption.
- Original name is **Rijndael**, named to AES after [Advanced Encryption Standard](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard_process) contest.
Initialize aes and generate new key and IV. AES is an symmetric encryption which using same key to encrypt and decrypt.
```csharp
AES aes = new AES();
string AesKey = aes.GetAesKey();
string AesIV = aes.GetIV();
```
To encrypt your text use
```csharp
string AesEncrypted = AES.Encrypt(message, AesKey, AesIV);
```
and simillarly to decrypt use
```csharp
string AesDecrypted = AES.Decrypt(AesEncrypted, AesKey);
```
Example above using generated and unprotected key for your encryption.
### RSA Encryption (asymmetric one)
- Achieving strong encryption through the use of two large prime numbers [Wikipedia](https://en.wikipedia.org/wiki/RSA_(cryptosystem))
- Encrypts your data with public key
- Decrypts your data with private key
- **Solves** I want anybody to be able to encrypt a message, but I'm the only one who can decrypt it. I don't want to share decryption keys with anybody.
First initialize RSA and create your public and private key
```csharp
RSA rsa = new RSA(RSA.KEY_SIZE);
string pubKey = TextConversion.Base64Encode(rsa.GetPublicKey());
string privKey = TextConversion.Base64Encode(rsa.GetPrivateKey());
```
Now encryption is easy as
```csharp
string message = "Hello world";
string encryptedText = RSA.Encrypt(message, RSA.SetKeyFromString(pubKey));
string plainText = RSA.Decrypt(encryptedText, RSA.SetKeyFromString(privKey));
```
### AES GCM encryption with protected key (combination of asymmetric and symmetric one)
This is more advande example where key for encryption is protected with RSA. RSA is asymetric encryption where public key is used for encryption your data and for decryption is used private key, which is in most time also protected by password. :warning: Do not share your private key with anyone!
#### Initialize RSA keys
```csharp
RSA rsa = new RSA(RSA.KEY_SIZE);
string pubKey = TextConversion.Base64Encode(rsa.GetPublicKey());
string privKey = TextConversion.Base64Encode(rsa.GetPrivateKey());
```
Initialize key and aad for GCM encryption
```csharp
// Create AES Keys
byte[] key = new byte[16];
RandomNumberGenerator.Fill(key);
byte[] aad = new byte[32];
RandomNumberGenerator.Fill(aad);
```
Now secure your key
```csharp
byte[] encryptedAeskey = RSA.EncryptBytes(key, RSA.SetKeyFromString(pubKey));
```
before using it you have to decrypt it
```csharp
byte[] decryptedAesKey = RSA.DecryptBytes(encryptedAeskey, RSA.SetKeyFromString(privKey));
```
Key above was secured with asymmetric cryptography. **Never share your private key with anyone.**
Now encryption is simmilar as in our first example
```csharp
byte[] encryptedData = GCM.Encrypt(dataToEncrypt, key, aad);
byte[] decryptedData = GCM.Decrypt(encryptedData, decryptedAesKey, aad);
```
If you want to encrypt string you have to do it as follows
```csharp
byte[] encryptedStringData = GCM.Encrypt(Encoding.UTF8.GetBytes(stringToEncrypt), key, aad);
```
For decryption is it same as above.
## Sign and verify data using RSA (a.k.a. Digital signature)
- Sign data using private key
- Verify data using public key
- Usually used in cases where it is important to detect forgery or tampering
- Provides cryptographic way of Authentication, Integrity, Non-repudiation
For more information check this [Wikipedia](https://en.wikipedia.org/wiki/Digital_signature) page.
### Initialize RSA parameters (a.k.a. get your keys)
First you will need to get your public and private key. You can do this as in [RSA encryption](#rsa-encryption-asymmetric-one). Or you can use random generated one as follows:
```csharp
RSA rsa = new RSA(RSA.KEY_SIZE);
RSAParameters key = rsa.GetRSAParameters(true);
```
method above will be available from version `1.3.0` for all RSA related tasks.
Now you can Sign your data like follows. (You are signing your data with your private key)
```csharp
byte[] signedData = RSA.HashAndSignBytes(dataToSign, key);
// if you using method with keys provided from string use
byte[] signedData = RSA.HashAndSignBytes(dataToSign, RSA.SetKeyFromString(privKey));
```
And for verification use following lines (You are verifying your data with your Public key)
```csharp
// will be TRUE if your data wasn't modified from time of your signature, otherwise it will be FALSE
bool isVerified = RSA.VerifySignedHash(dataToSign, key);
// if you using method with keys provided from string use
bool isVerified = RSA.VerifySignedHash(dataToSign, RSA.SetKeyFromString(pubKey));
```
## Key derivation with PBKDF2
This function is used to derive you key (for example for unlocking private key) from your password. You can read more about it on [Wikipedia](https://en.wikipedia.org/wiki/PBKDF2)
to derive key use following snippet
```csharp
// string password = "my$up3r$3cr3tP4$$w0rd1";
// string salt = "8VySCxa42j9McSqGjZxCVQnH4x4rSZszEL9YQT3VkZ75xbBD";
var derivedKey = PBKDF2.keyDerivate(password, salt, 1024, 10);
```
License MIT