damianchojnacki/access-token

Site access token for Laravel apps.

1.0.5 2022-03-22 13:04 UTC

Requires

• php: >=7.4
• laravel/framework: >=5.8

MIT

• Damian Chojnacki

README

This package protects site from viewing by regular users. Only the ones who know unique token can access site.

WARNING! This package DOES NOT ensure high level of protection! It is intended to prevent viewing site by regular users. For real authentication use proper package like Laravel Passport.

Requirements

It requires PHP 7.4+ and Laravel 5.8+.

Installation

1. Install package using composer:

composer require damianchojnacki/access-token

1. Create .env configuration variables:

ACCESS_TOKEN=
ACCESS_EXPIRATION=

You can specify here your access token and expiration time in minutes (default 1 day).

Usage

To make usage easier there is helper middleware that validates token. If it was not found 403 error is thrown.

You can guard whole site by placing middleware into Kernel.php file

protected $middleware = [
    \Damianchojnacki\AccessToken\CheckAccessToken::class,
];

If you want to guard specific route you can define named middleware:

protected $routeMiddleware = [
    'access-token' => \Damianchojnacki\AccessToken\CheckAccessToken::class,
];

There is also command for generating new token:

php artisan access-token:generate

[OK] Access token saved to .env file. You can now access your site by visiting url below:                                                                                                                                                          

https://example.com?token=3md3Q8sLYNMCVrMvqaw67FSnUvC7d9gN

License

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