feat: update readme doc to reflect rsa implementation

Author: selfmadecode

README.md

@@ -12,6 +12,7 @@ The Encryption library provides a set of methods for encrypting and decrypting d
 - [Usage](#usage)
 - [API Reference](#api-reference)
 - [Examples](#examples)
+- [RSA Encryption and Decryption](#rsa)
 - [Contributing](#contributing)
 - [License](#license)
 
@@ -121,6 +122,9 @@ class Program
     }
 }
 ```
+## Rsa
+For more details on RSA Encryption, check the [Rsa.md](../doc/Rsa.md) document.
+
 
 ## Contributing
 

Rsa.md

@@ -0,0 +1,89 @@
+# RSA Encryption and Decryption
+
+## Overview
+
+This library provides a straightforward implementation of RSA encryption and decryption in C# using the .NET `RSACryptoServiceProvider`.
+It includes methods for generating RSA key pairs, encrypting data with a public key, and decrypting data with a private key.
+
+## Table of Contents
+
+- [Usage](#usage)
+  - [Generate RSA Keys](#generate-rsa-keys)
+  - [Encrypt and Decrypt using RSA](#encrypt-and-decrypt-using-rsa)
+
+## Usage
+
+### Generate RSA Keys
+
+```csharp
+using SafeCrypt.Helpers;
+
+var rsaKeyPair = KeyGenerators.GenerateRsaKeys(2048);
+
+string rsaPublicKey = rsaKeyPair.Item1;
+string rsaPrivateKey = rsaKeyPair.Item2;
+
+Console.WriteLine($"Public Key: {rsaPublicKey}");
+Console.WriteLine($"Private Key: {rsaPrivateKey}");
+```
+
+### Encrypt and Decrypt using RSA
+
+```csharp
+    using SafeCrypt.RsaEncryption;
+
+    // Encrypt
+    string originalData = "Hello, RSA Encryption!";
+
+    var encryptionModel = new RsaEncryptionParameters
+    {
+        DataToEncrypt = originalData,
+        PublicKey = rsaPublicKey,
+    };
+
+    var encryptedData = await Rsa.EncryptAsync(encryptionModel);
+
+    Console.WriteLine($"Original Data: {originalData}");
+    Console.WriteLine("Encrypted Data: " + BitConverter.ToString(encryptedData.EncryptedData));
+
+    // Convert encrypted byte array to Base64 string
+    string encryptedDataConvertedString = Convert.ToBase64String(encryptedData.EncryptedData);
+
+    // Convert string back to byte array for decryption
+    byte[] convertedBytes = Convert.FromBase64String(encryptedDataConvertedString);
+
+    bool arraysAreEqual = StructuralComparisons.StructuralEqualityComparer.Equals(encryptedData.EncryptedData, convertedBytes);
+    Console.WriteLine("Original and converted byte arrays are equal: " + arraysAreEqual); // should return true
+
+
+
+    // Decrypt
+    var decryptionModel = new RsaDecryptionParameters
+    {
+        DataToDecrypt = convertedBytes, // encryptedData.EncryptedData
+        PrivateKey = rsaPrivateKey,
+    };
+
+    var decryptedData = await Rsa.DecryptAsync(decryptionModel);
+
+    // if Error occurs during encryption
+    if (decryptedData.Errors.Count > 0)
+    {
+        Console.WriteLine("Decryption Errors:");
+        foreach (var error in decryptedData.Errors)
+        {
+            Console.WriteLine(error);
+        }
+    }
+    else
+    {
+        Console.WriteLine($"Decrypted Data: {decryptedData.DecryptedData}"); 
+    }
+
+// Note: The return type from Rsa.EncryptAsync is `EncryptionResult`, and Rsa.DecryptAsync is `DecryptionResult`.
+// Both models include a list of errors encountered during encryption/decryption.
+
+```
+## Contributing
+
+Contributions are welcome! Feel free to open issues, submit pull requests, or provide feedback.

SafeCrypt.sln

@@ -13,6 +13,11 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SafeCrypt", "src\SafeCrypt.
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SafeCrypt.App", "src\SafeCrypt.Test\SafeCrypt.App.csproj", "{DAD7FFA3-AABC-47FF-BA79-0C9531BFBBE6}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "doc", "doc", "{632FAE12-6DE3-4B21-ADBB-F5222B35F707}"
+	ProjectSection(SolutionItems) = preProject
+		Rsa.md = Rsa.md
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -36,6 +41,7 @@ Global
 		{1D91E775-F63F-4537-B81E-B8F9A6480D6D} = {0B7C0C60-9850-4554-AF85-86C0378B6B16}
 		{AE9FAE54-9854-4F98-A60F-19125CEAA3A8} = {8507D130-9F07-426C-8EE6-0AC714CF72E5}
 		{DAD7FFA3-AABC-47FF-BA79-0C9531BFBBE6} = {1D91E775-F63F-4537-B81E-B8F9A6480D6D}
+		{632FAE12-6DE3-4B21-ADBB-F5222B35F707} = {0B7C0C60-9850-4554-AF85-86C0378B6B16}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {639A4359-2BA4-4F71-9EBF-D6EAB68C84CB}