norotaro/wn-guardian-plugin

v1.1.2 2021-07-26 15:40 UTC

Requires

• norotaro/wn-rest-plugin: ^1.0

MIT

• Nelson Otazo

• plugin
• routes
• winter
• wintercms
• winter-plugin

README

Allows to easily restrict access to routes declared by plugins in routes.php.

Using the AuthorizationControl middleware provided with this plugin your routes will be accesibles only by the clients registered in the back-end.

Installation

Run the following command in a project's root directory:

composer require norotaro/wn-guardian-plugin
php artisan winter:up

Managing clients

Clients are managed on the Guardian menu found in the back-end. Each client provides minimal data fields - Name, Shortname, Active and Authorization Codes.

Each Authorization Code is represented by a Value and an Active field.

Client authorization

When a client make a request it needs to authenticate sending the following headers:

• User-Agent: {{shortname}}
• Authorization: {{activeCode}}

Where {{shortname}} is a short name of a client created in the back-end and {{activeCode}} is one of the code created for that client and that is active.

AuthorizationControl middleware

Access to routes are restricted by applying the AuthorizationControl middleware.

<?php
Route::middleware([\Norotaro\Guardian\Middlewares\AuthorizationControl::class])
    ->group(function () {
    // All routes here will require authorization
});