feat: release 1.0

shiwildy · web-flow · commit faafbc1e9657 · 2024-11-03T00:46:01.000+07:00
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Wildy Sheverando
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,57 @@
+# SEncrypt
+SEncrypt is a secure & simple encryption library using SHA-512, AES-256-CBC, and BASE64. It provides easy-to-use methods for encrypting and decrypting data securely.
+
+## Installation
+```bash
+composer require shiwildy/sencrypt
+```
+
+## Example
+```php
+<?php
+    require 'vendor/autoload.php';
+    use ShiWildy\SEncrypt;
+
+    $plaintext = "Hello, just testing..";
+    $password = "secret";
+
+    try {
+        $encrypted = SEncrypt::encrypt($plaintext, $password);
+        echo "Encrypted: " . $encrypted . "\n\n";
+
+        $decrypted = SEncrypt::decrypt($encrypted, $password);
+        echo "Decrypted: " . $decrypted . "\n\n";
+
+    } catch (Exception $e) {
+        echo "An error occurred: " . $e->getMessage() . "\n";
+    }
+?>
+```
+
+## How It Works ?
+### Encryption:
+- Salt Generation: A random salt generated to enhance security.
+- Key Derivation: Encryption key is derived from the provided password and generated salt using PBKDF2 Algoritm with SHA-512
+- IV Generation: A random initialization vector [IV] generated for use on AES-256-CBC
+- Combining Data: Salt, IV, and encrypted data are concatenated and then encoded using base64 to create final encrypted output.
+
+### Decryption:
+- Base64 Decode: Encrypted data is first decoded from Base64.
+- Data Extraction: salt, IV, and encrypted text are extracted from decoded data.
+- Key Derivation: Decryption key is derived using same method in encryption.
+- Decryption: Encrypted data is decrypted using derived key and IV.
+- Output: Decrypted text returned.
+
+## Contributing
+Contributions are welcome! Please open an issue or submit a pull request for any enhancements or bug fixes.
+
+## License
+This project licensed under The MIT License
+
+## Credits
+- https://www.php.net/manual/en/function.hash-pbkdf2.php
+- https://www.tutorialspoint.com/php/php_function_hash_pdkdf2.htm
+- https://www.php.net/manual/en/function.openssl-pbkdf2.php
+- https://stackoverflow.com/questions/12766852/pbkdf2-password-hashing-for-php
+- https://ppgia.pucpr.br/pt/arquivos/techdocs/php/function.hash-pbkdf2.html
+- https://nishothan-17.medium.com/pbkdf2-hashing-algorithm-841d5cc9178d
diff --git a/composer.json b/composer.json
@@ -0,0 +1,35 @@
+{
+    "name": "shiwildy/sencrypt",
+    "description": "A secure and simple encryption library using SHA-512, AES-256-CBC, and BASE64.",
+    "license": "MIT",
+    "keywords": [
+        "encryption",
+        "encrypt",
+        "sha",
+        "sha512",
+        "cryptography",
+        "aes",
+        "openssl",
+        "crypto",
+        "encryptor"
+    ],
+    "type": "library",
+    "require": {
+        "php": ">=7.4"
+    },
+    "autoload": {
+        "psr-4": {
+            "ShiWildy\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "Wildy Sheverando",
+            "email": "hai@shiwildy.com",
+            "homepage": "https://github.com/shiwildy.git"
+        }
+    ],
+    "minimum-stability": "stable",
+    "prefer-stable": true,
+    "version": "1.0"
+}
diff --git a/src/SEncrypt.php b/src/SEncrypt.php
@@ -0,0 +1,125 @@
+<?php
+
+//
+// SEncrypt
+// A secure and simple encryption library using SHA-512, AES-256-CBC, and BASE64.
+//
+// Author  : Wildy Sheverando <hai@shiwildy.com>
+// Version : 1.0
+//
+// https://github.com/shiwildy/SEncrypt.git
+// 
+// This project Licensed under The MIT License.
+//
+
+namespace ShiWildy;
+
+class SEncrypt {
+    private const CIPHER = 'aes-256-cbc';
+    private const PBKDF2_ITERATIONS = 1000;
+    private const KEY_LENGTH = 32; // 256-bit key for AES-256
+    private const IV_LENGTH = 16; // 128-bit IV Length for AES-256-CBC
+
+    /**
+     * Encrypts a plaintext string using AES-256-CBC with a derived key.
+     *
+     * @param string $plaintext The data to encrypt.
+     * @param string $password The password to derive encryption keys.
+     * @return string Base64-encoded encrypted data.
+     * @throws Exception If encryption fails.
+     */
+    public static function encrypt(string $plaintext, string $password): string {
+        try {
+            // Generate a random salt
+            $salt = random_bytes(self::KEY_LENGTH);
+
+            // Derive encryption key
+            $key = hash_pbkdf2(
+                'sha512',
+                $password,
+                $salt,
+                self::PBKDF2_ITERATIONS,
+                self::KEY_LENGTH,
+                true
+            );
+
+            // Generate a random IV key
+            $iv = random_bytes(self::IV_LENGTH);
+
+            // Encrypt using openssl_encrypt functions
+            $encrypted = openssl_encrypt(
+                $plaintext,
+                self::CIPHER,
+                $key,
+                OPENSSL_RAW_DATA,
+                $iv
+            );
+
+            if ($encrypted === false) {
+                throw new \Exception('Encryption failed.');
+            }
+
+            // Combine salt, iv, encrypted then base64 encode
+            return base64_encode($salt . $iv . $encrypted);
+
+        } catch (Exception $e) {
+            throw new \Exception($e->getMessage());
+        }
+    }
+    
+    /**
+     * Decrypts a Base64-encoded encrypted string using AES-256-CBC with a derived key.
+     *
+     * @param string $encryptedBase64 The Base64-encoded encrypted data.
+     * @param string $password The password to derive decryption keys.
+     * @return string The decrypted plaintext.
+     * @throws Exception If decryption fails.
+     */
+    public static function decrypt(string $encryptedBase64, string $password): string {
+        try {
+            // Decode base64
+            $combined = base64_decode($encryptedBase64, true);
+            if ($combined === false) {
+                throw new \Exception('Cannot decode base64.');
+            }
+
+            // Extract salt, iv, encrypted from combined
+            $salt = substr($combined, 0, self::KEY_LENGTH);
+            $iv = substr($combined, self::KEY_LENGTH, self::IV_LENGTH);
+            $ciphertext = substr($combined, self::KEY_LENGTH + self::IV_LENGTH);
+
+            if ($salt === false || $iv === false || $ciphertext === false) {
+                throw new \Exception('Encrypted format is invalid.');
+            }
+
+            // Derive decryption key
+            $key = hash_pbkdf2(
+                'sha512',
+                $password,
+                $salt,
+                self::PBKDF2_ITERATIONS,
+                self::KEY_LENGTH,
+                true
+            );
+            
+            // Decrypt encrypted text
+            $decrypted = openssl_decrypt(
+                $ciphertext,
+                self::CIPHER,
+                $key,
+                OPENSSL_RAW_DATA,
+                $iv
+            );
+            
+            if ($decrypted === false) {
+                throw new \Exception('Decryption failed.');
+            }
+            
+            return $decrypted;
+        } catch (Exception $e) {
+            throw new \Exception($e->getMessage());
+        }
+    }
+}
+
+?>
diff --git a/test.php b/test.php
@@ -0,0 +1,18 @@
+<?php
+    include "src/sencrypt.php";
+
+    $plaintext = "Hello, just testing..";
+    $password = "secret";
+
+    try {
+        $encrypted = SEncrypt::encrypt($plaintext, $password);
+        echo "Encrypted: " . $encrypted . "\n\n";
+
+        $decrypted = SEncrypt::decrypt($encrypted, $password);
+        echo "Decrypted: " . $decrypted . "\n\n";
+
+    } catch (Exception $e) {
+        echo "An error occurred: " . $e->getMessage() . "\n";
+    }
+
+?>
