Merge branch 'master' into dev_raphael_aes

Author: selfmadecode

src/SafeCrypt.Lib/README.md

@@ -34,46 +34,92 @@ To use the SafeCrypt library in your C# project, follow these steps:
 
 Now, you can reference the SafeCrypt library in your C# project.
 
-## Usage
+## Basic Usage
 
-To use the library in your C# application, instantiate the `SafeCrypt` class and call the provided methods. Here's a simple example:
+To use the library in your C# application, instantiate the `AesEncryption` or `AesDecryption` class and call the provided methods. Here's a simple example:
 
 ```csharp
-using SafeCrypt;
+using SafeCrypt.AESDecryption;
+using SafeCrypt.AESEncryption;
+using SafeCrypt.Models; 
 
 class Program
 {
-    static void Main()
+    static void Main() 
     {
         var aesEncryptor = new AesEncryption();
-        var encryptedData = aesEncryptor.AesEncrypt("Hello, World!", "mySecretKey");
-        Console.WriteLine($"Encrypted Data: {encryptedData.Data}");
+        
+        var encryptedData = aesEncryptor.EncryptToBase64String("Hello, World!", "gdjdtsraewsuteastwerse=="
+        
+        Console.WriteLine($"Encrypted Data: {encryptedData.EncryptedData}");
         Console.WriteLine($"Initialization Vector: {encryptedData.Iv}");
+
+        var aesDecryptor = new AesDecryption();
+
+        var parameterToDecrypt = new DecryptionParameters
+        {
+          DataToDecrypt = encryptedData.EncryptedData,
+          SecretKey = encryptedData.SecretKey,
+          IV = encryptedData.IV
+
+        };
+
+        var data = aesDecryptor.DecryptFromBase64String(parameterToDecrypt)
+
+        Console.WriteLine($"Decrypted Data: {data.DecryptedData}");
+        Console.WriteLine($"Initialization Vector: {data.Iv}");
     }
 }
-```
 
-## API Reference
 
-### `AesEncryption`
+-------------------------------------------------------------------------------------------------------
 
-- `AesEncrypt(byte[] data, byte[] secretKey, byte[] iv): byte[]`
-  - Encrypts a byte array using AES algorithm.
-  - Parameters:
-    - `data`: The data to encrypt.
-    - `secretKey`: The secret key for encryption.
-    - `iv`: The initialization vector for encryption.
-  - Returns: The encrypted data.
+using SafeCrypt.AESDecryption;
+using SafeCrypt.AESEncryption;
+using SafeCrypt.Models; 
 
-## Examples
+class Program
+{
+    static void Main() 
+    {
+        var dataToEncrypt = "Data to Encrypt";
 
-### Encrypting a String
+        var iv = "gyrthusdgythisdg";
+        var secret = "hghjuytsdfraestwsgtere==";
 
-```csharp
-var aesEncryptor = new AesEncryption();
-var encryptionData = aesEncryptor.AesEncrypt("Hello, World!", "mySecretKey");
-Console.WriteLine($"Encrypted Data: {encryptionData.Data}");
-Console.WriteLine($"Initialization Vector: {encryptionData.Iv}");
+        var encryptionParam = new EncryptionParameters
+        {
+            DataToEncrypt = dataToEncrypt,
+            IV = iv,
+            SecretKey = secret
+        };
+
+        var encryptor = new AesEncryption();
+
+        var response = encryptor.EncryptToBase64String(encryptionParam.DataToEncrypt, secret);
+
+        Console.WriteLine(response.EncryptedData);
+        Console.WriteLine(response.Iv);
+        Console.WriteLine(response.SecretKey);
+
+
+
+        var decryptorParam = new DecryptionParameters
+        {
+            IV = response.Iv,
+            SecretKey = secret,
+            DataToDecrypt = response.EncryptedData
+        };
+
+
+        var decryptor = new AesDecryption();
+        var decryptionData = decryptor.DecryptFromBase64String(decryptorParam);
+
+        Console.WriteLine(decryptionData.DecryptedData);
+        Console.WriteLine(decryptionData.Iv);
+        Console.WriteLine(decryptionData.SecretKey);
+    }
+}
 ```
 
 ## Contributing

src/SafeCrypt.Lib/SafeCrypt.csproj

@@ -15,37 +15,27 @@
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
     <PackageLicenseFile>MitLicense.txt</PackageLicenseFile>
-    <PackageReleaseNotes>SafeCrypt Library - Release Notes
+    <PackageReleaseNotes>SafeCrypt Library - Release Notes - Version 1.0.1
 
-Version 1.0.0
+This release (version 1.0.1) includes updates to the documentation and namespace changes. We have improved the README document to provide more comprehensive information about the library and made adjustments to the namespaces for better organization.
 
-Highlights:
-- New Features:
-  - `EncryptToHexString`: Easily encrypt data with a hexadecimal string output.
-  - `DecryptFromBase64String`: Decrypt Base64-encoded string data with validation.
-  - `GenerateAesKey`: Generate a random AES key of a specified size.
+Changes
 
-- Improvements:
-  - Enhanced validation checks for input parameters in encryption and decryption methods.
-  - Improved error handling for decryption, including padding errors.
+- Updated README document with detailed usage instructions, API references, and contribution guidelines.
+- Made changes to namespaces for better organization and clarity in the codebase.
 
-- Bug Fixes:
-  - Resolved issues related to padding errors during decryption.
+Bug Fixes
 
-- Documentation:
-  - Updated and expanded the README file for better understanding and usage instructions.
-  - Added XML documentation comments to improve code documentation.
-
-- Security:
-  - Improved key validation to ensure secure encryption and decryption.
+No bug fixes in this release.
 
 Upgrade Command:
-dotnet add package SafeCrypt --version 1.0.0
+dotnet add package SafeCrypt --version 1.0.1
 
 Feedback and Contributions:
 We appreciate your feedback and contributions! If you encounter any issues or have suggestions, please create an issue on GitHub: https://github.com/selfmadecode/SafeCrypt/issues
 
 Thank you for using the SafeCrypt Library!</PackageReleaseNotes>
+    <Version>1.0.1</Version>
   </PropertyGroup>
 
   <ItemGroup>