Laravel Shield

Shield is a HTTP basic auth middleware for Laravel and Lumen. No database required, instead we put the user credentials within the configuration file.

// Use on your routes.
Route::get('/', ['middleware' => 'shield', function () {
    // Your protected page.
}]);

// Use it within your controller constructor.
$this->middleware('shield');

// Use specific user credentials.
$this->middleware('shield:hasselhoff');

Installation

Require this package, with Composer, in the root directory of your project.

composer require vinkla/shield

Add the service provider to config/app.php in the providers array.

Vinkla\Shield\ShieldServiceProvider::class

Add the middleware to the $routeMiddleware array in your Kernel.php file.

'shield' => \Vinkla\Shield\ShieldMiddleware::class,

Configuration

Laravel Shield requires configuration. To get started, you'll need to publish all vendor assets:

php artisan vendor:publish

This will create a config/shield.php file in your app that you can modify to set your configuration. Also, make sure you check for changes to the original config file in this package between releases.

HTTP Basic Auth Credentials

The user credentials which are used when logging in with HTTP basic authentication. You can hash new user credentials by running the artisan command shield:hash.

Usage

To protect your routes with the shield you can add it to the routes file.

Route::get('/', ['middleware' => 'shield', function () {
    // Your protected page.
}]);

You can also add the shield middleware to your controllers constructor.

$this->middleware('shield');

The middleware accepts one optional parameter to specify which user credentials to compared with.

$this->middleware('shield:kitt');

To hash new user credentials, please use the command below. Then copy and paste the credentials to the shield.php configuration file. The command expects an array of items (separated with spaces).

php artisan shield:hash david hasselhoff

## License

Laravel Shield is licensed under [The MIT License (MIT)](LICENSE).