A Laravel package to securely encrypt form fields on the client-side using public key encryption and decrypt them on the server-side using the private key. This package integrates seamlessly with Laravel Blade templates and requires minimal configuration.
- RSA Encryption: Uses
JSEncryptfor secure RSA encryption. - HTML Attribute Control: Specify which fields to encrypt using
data-encrypt="true". - Flexible Form Encryption: Target specific forms using
data-encrypt-formattribute. - Blade Directive: Automatically inject encryption scripts with
@encryptFormScripts. - Simple Key Management: Easily configure keys via
.envor generate new keys via artisan commands. - Zero Dependencies: No NPM required; all scripts are included in the package.
-
Install the Package:
composer require bespredel/encryption-form
-
Publish Config and Scripts:
php artisan vendor:publish --tag=encryption-form
-
Add RSA Keys to
.env:ENCRYPTION_FORM_PUBLIC_KEY="-----BEGIN PUBLIC KEY-----...-----END PUBLIC KEY-----" ENCRYPTION_FORM_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----"
If you don't have keys, you can generate them using the following commands:
php artisan encryption-form:generate-keys
-
Include the Blade Directive in Your Template: Add
@encryptFormScriptsto your layout file or specific views where forms are encrypted.
For auto decryption of form data, add the DecryptRequestFields middleware to your Kernel:
Add the middleware to your Kernel
protected $middleware = [
// Other middleware
\Bespredel\EncryptionForm\Middleware\DecryptRequestFields::class
]or use it in a route:
Route::middleware('decrypt-form')->group(function () {
// Your code
})In your Blade template:
<head>
@encryptFormStyles
@encryptFormScripts
</head>
<form data-encrypt-form action="/submit" method="POST">
<input type="text" name="name" data-encrypt="true" placeholder="Enter your name" />
<input type="email" name="email" data-encrypt="true" placeholder="Enter your email" />
<input type="text" name="address" placeholder="Enter your address" />
<div class="encrypt-form-status"></div> <!-- Optional element to display encryption operation status -->
<button type="submit">Submit</button>
</form>- Add
data-encrypt-formto the<form>tag to enable encryption for this form. All supported form fields will be encrypted.- Use
data-encrypt="true"for fields that require encryption. All other fields will not be encrypted. - Use
data-encrypt="false"for fields that do not require encryption. All other fields will be encrypted.
- Use
Types of Fields Available for Encryption:
-
Input Fields:
- Supported types:
text,email,password,number,date, and similar. - Exceptions:
file,checkbox,radio,select.
- Supported types:
-
Textarea:
- Fully supported.
!!! It is important to note that the encrypted value will be longer than the original value, which may affect data length constraints.
Use the RequestDecryptor class to decrypt data on the server:
use Bespredel\EncryptionForm\Services\Decryptor;
$value = $request->input('name'); // Example for 'name' field
$privateKey = config('encryption-form.private_key');
$decryptedValue = Decryptor::decryptValue($value, $privateKey);Or use the openssl_private_decrypt function to decrypt data on the server:
$privateKey = config('encryption-form.private_key');
$encryptedData = $request->input('name'); // Example for 'name' field
$decryptedData = null;
$decodedValue = base64_decode((string)str($encryptedData)->after('ENCF:'), true);
openssl_private_decrypt($decodedValue, $decryptedData, $privateKey);
echo $decryptedData; // Output the decrypted valueTo generate a new pair of RSA keys:
php artisan encryption-form:generate-keysThis will update the keys in your .env file.
config/encryption-form.php
return [
'public_key' => env('ENCRYPTION_FORM_PUBLIC_KEY'), // Public key, required
'private_key' => env('ENCRYPTION_FORM_PRIVATE_KEY'), // Private key, required
'prefix' => env('ENCRYPTION_FORM_PREFIX', 'ENCF:'), // Field value prefix, needed for optimization to find encrypted values, default: 'ENCF:'
'key_rotation' => [ // Key automatic rotation configuration
'enabled' => env('ENCRYPTION_FORM_KEY_ROTATION_ENABLED', false), // Enable key rotation
'cron_expression' => '0 0 * * *', // Cron expression for key rotation
],
];You can schedule automatic key rotation via the key_rotation key in the config file.:
return [
...
'key_rotation' => [
'enabled' => env('ENCRYPTION_FORM_KEY_ROTATION_ENABLED', false),
'cron_expression' => '0 0 * * *',
],
];- Fork the repository.
- Create your feature branch:
git checkout -b feature/my-feature. - Commit your changes:
git commit -m 'Add some feature'. - Push to the branch:
git push origin feature/my-feature. - Open a pull request.
PLEASE DON'T DISCLOSE SECURITY-RELATED ISSUES PUBLICLY.
If you discover any security related issues, please email hello@bespredel.name instead of using the issue tracker.
I would like to thank the authors and contributors of the JSEncrypt library for providing a secure RSA encryption solution for client-side data encryption.
This package is open-source software licensed under the MIT license.