Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bespredel/encryption-form
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.
https://github.com/bespredel/encryption-form
client-side-encryption data-privacy encryption form-encryption laravel open-source php privacy-protection rsa-encryption security
Last synced: 3 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/bespredel/encryption-form
- Owner: BespredeL
- License: mit
- Created: 2024-12-13T08:56:26.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2025-01-08T16:05:05.000Z (8 days ago)
- Last Synced: 2025-01-08T17:28:53.572Z (8 days ago)
- Topics: client-side-encryption, data-privacy, encryption, form-encryption, laravel, open-source, php, privacy-protection, rsa-encryption, security
- Language: PHP
- Homepage: https://bespredel.name
- Size: 137 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Encryption Form
[](https://github.com/bespredel/encryption-form/blob/master/README.md)
[](https://github.com/bespredel/encryption-form/blob/master/README_RU.md)
[](https://github.com/bespredel/encryption-form/blob/master/LICENSE)
[](https://packagist.org/packages/bespredel/encryption-form)
[](https://github.com/bespredel/encryption-form/releases)
[](https://packagist.org/packages/bespredel/encryption-form)
[](https://php.net)
[](https://laravel.com)
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.
---
## Features
- **RSA Encryption**: Uses `JSEncrypt` for secure RSA encryption.
- **HTML Attribute Control**: Specify which fields to encrypt using `data-encrypt="true"`.
- **Flexible Form Encryption**: Target specific forms using `data-encrypt-form` attribute.
- **Blade Directive**: Automatically inject encryption scripts with `@encryptFormScripts`.
- **Simple Key Management**: Easily configure keys via `.env` or generate new keys via artisan commands.
- **Zero Dependencies**: No NPM required; all scripts are included in the package.
## Installation
1. **Install the Package**:
```bash
composer require bespredel/encryption-form
```
2. **Publish Config and Scripts**:
```bash
php artisan vendor:publish --tag=encryption-form
```
3. **Add RSA Keys to ```.env```**:
```bash
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:
```bash
php artisan encryption-form:generate-keys
```
4. **Include the Blade Directive in Your Template**:
Add `@encryptFormScripts` to your layout file or specific views where forms are encrypted.
## Usage
### Middleware
For auto decryption of form data, add the `DecryptRequestFields` middleware to your `Kernel`:
```php
Add the middleware to your Kernel
protected $middleware = [
// Other middleware
\Bespredel\EncryptionForm\Middleware\DecryptRequestFields::class
]
```
or use it in a route:
```php
Route::middleware('decrypt-form')->group(function () {
// Your code
})
```
### HTML Form Example
In your Blade template:
```html
@encryptFormStyles
@encryptFormScripts
Submit
```
- Add `data-encrypt-form` to the `` 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.
**Types of Fields Available for Encryption:**
- **Input Fields:**
- Supported types: `text`, `email`, `password`, `number`, `date`, and similar.
- Exceptions: `file`, `checkbox`, `radio`, `select`.
- **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.**
### Manual decrypting data on the server
Use the `RequestDecryptor` class to decrypt data on the server:
```php
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:
```php
$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 value
```
## Commands
### Generate New RSA Keys
To generate a new pair of RSA keys:
```bash
php artisan encryption-form:generate-keys
```
This will update the keys in your `.env` file.
## Configuration
### Config File:
```config/encryption-form.php```
```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
],
];
```
## Key Rotation via Scheduler
You can schedule automatic key rotation via the `key_rotation` key in the config file.:
```php
return [
...
'key_rotation' => [
'enabled' => env('ENCRYPTION_FORM_KEY_ROTATION_ENABLED', false),
'cron_expression' => '0 0 * * *',
],
];
```
## Contributing
1. Fork the repository.
2. Create your feature branch: `git checkout -b feature/my-feature`.
3. Commit your changes: `git commit -m 'Add some feature'`.
4. Push to the branch: `git push origin feature/my-feature`.
5. Open a pull request.
## Security
PLEASE DON'T DISCLOSE SECURITY-RELATED ISSUES PUBLICLY.
If you discover any security related issues, please email [[email protected]]([email protected]) instead of using the issue tracker.
## Acknowledgements
I would like to thank the authors and contributors of the [JSEncrypt](https://github.com/travist/jsencrypt) library for providing a secure RSA
encryption solution for client-side data encryption.
## License
This package is open-source software licensed under the MIT license.