milhouse1337 / cogul
This package can secure any route in Laravel with a simple cookie.
Installs: 1 751
Dependents: 0
Suggesters: 0
Security: 0
Stars: 5
Watchers: 1
Forks: 0
Open Issues: 0
Requires
- php: >=5.6
This package is auto-updated.
Last update: 2024-09-19 03:34:21 UTC
README
COokie GUard for Laravel
This package can secure any route in Laravel with a simple cookie. It will prevent anyone (or anything) to access a specific route if the cookie value you defined is not present on the request.
Installation
You can install the package via Composer:
composer require milhouse1337/cogul
Configuration
To generate a random token (string) you can use openssl
like this:
openssl rand -hex 32
Add the token on your .env
file:
COGUL_TOKEN=random_token_here
You can publish the config with (optional):
php artisan vendor:publish --provider="Milhouse1337\Cogul\CogulServiceProvider"
Here is an example config/cogul.php
file:
return [ 'token' => env('COGUL_TOKEN', ''), 'url' => env('COGUL_URL', '/auth/token/{token}'), 'redirect' => env('COGUL_REDIRECT', '/'), 'cookie' => env('COGUL_COOKIE', 'cogul'), 'expiration' => env('COGUL_EXPIRATION', 2628000), // 5 years. 'middleware' => env('COGUL_MIDDLEWARE', 'web'), 'whitelist' => [], ];
Usage
You have to define the routes you want to secure with the auth.cogul
middleware, like this:
Route::get('example', 'Controller@example')->middleware('auth.cogul');
Now if you GET
this /example
you will have a 403
response from Laravel.
In order to get the expected response, you need to access the following link in your browser to set the cogul
cookie:
/auth/token/random_token_here
The cookie should be stored in your browser and you will be redirected to the URL you configured.
You will now be able to access /example
normally until the cookie gets expired or deleted.
Credits
License
The MIT License (MIT). Please see License File for more information.