tzsk / crypton

Laravel Request & Response Encryption
MIT License
38 stars 9 forks source link
crypton laravel-package request-encryption response-encryption secure-api

:gift: Laravel Crypton

Crypton Cover Image

GitHub License Latest Version on Packagist GitHub Tests Action Status Total Downloads

TThis is a simple package for laravel to encrypt decrypt api request & response in both ends, Backend & Javascript.

:package: Installation

Via Composer

$ composer require tzsk/crypton

Publish config file

$ php artisan crypton:publish

Add an environment variable in the .env file

CRYPTON_KEY=your-encryption-key

:eyes: Keep in Mind

TIP: You can easily generate an encryption key by running php artisan key:generate then copy the generated key. Then again run: php artisan key:generate to make the key used by crypton and the default application key different.

WARNING: DO NOT USE THE SAME APP_KEY AND CRYPTON_KEY

:fire: Usage

Start off by adding a Middleware in the app/Http/Kernel.php file.

$routeMiddleware = [
    'crypton' => \Tzsk\Crypton\Middleware\EncryptRequestResponse::class,
];

Now, add this middleware to any api routes or groups.

Example:

Route::middleware('crypton')->post('some-endpoint', function(Request $request) {
    return Post::paginate($request->per_page ? : 10);
});

That's it.

:heart_eyes: Javascript adapter

See Laravel Crypton

:microscope: Testing

composer test

:date: Changelog

Please see CHANGELOG for more information on what has changed recently.

:crown: Contributing

Please see CONTRIBUTING for details.

:lock: Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

:heart: Credits

:policeman: License

The MIT License (MIT). Please see License File for more information.