php-cpm/http-basic-auth-guard

HTTP Basic Auth Guard for Lumen 5.2

HTTP Basic Auth Guard

[![Latest Version on Packagist][ico-version]][link-packagist] ![Software License][ico-license] [![Total Downloads][ico-downloads]][link-downloads], _(*1)

This is a modified version of HTTP Basic Auth Guard, provided for api auth., _(*2)

when I readed Pingxx's documents, They tell me the APIs should be authed by basic auth and leave password empty,then I found their php SDK use bearer Token way, _(*3)

so I make my own version middleware to sovle this problem., _(*4)

As stateless APIs, each time request, we need to verify a token called API Secret., _(*5)

so parse the request Header to get a token, verify it through Model and get Info from db., _(*6)

Installation

Pull in package

$ composer require php-cpm/http-basic-auth-guard

Read & Follow Documentation

Authentication, _(*7)

Important:, _(*8)

Before using Lumen's authentication features, you should uncomment the call to register the AuthServiceProvider service provider in your bootstrap/app.php file.
If you would like to use Auth::user() to access the currently authenticated user, you should uncomment the $app->withFacades() method in your bootstrap/app.php file., _(*9)

Add the Service Provider

Open bootstrap/app.php and register the service provider:, _(*10)

$app->register(Phpcpm\BasicAuth\BasicGuardServiceProvider::class);

Setup Guard Driver

Note: In Lumen you first have to copy the config file from the directory vendor/laravel/lumen-framework/config/auth.php, create a config folder in your root folder and finally paste the copied file there., _(*11)

Open your config/auth.php config file.
In guards add a new key of your choice (api in this example).
Add basic as the driver.
Make sure you also set provider for the guard to communicate with your database., _(*12)

// config/auth.php
'guards' => [
    'api' => [
        'driver' => 'basic',
        'provider' => 'users'
    ],

    // ...
],

'providers' => [
    'users' => [
        'driver' => 'eloquent',
        'model'  => App\User::class,
    ],
],

Middleware Usage

Middleware protecting the route:, _(*13)

Route::get('api/whatever', ['middleware' => 'auth:api', 'uses' => 'NiceController@awesome']);

Middleware protecting the controller:, _(*14)

<?php

namespace App\Http\Controllers;

class NiceController extends Controller
{
    public function __construct()
    {
        $this->middleware('auth:api');
    }
}

Change log

Please see CHANGELOG for more information what has changed recently., _(*15)

Contributing

Please see CONTRIBUTING for details., _(*16)

Any issues, feedback, suggestions or questions please use issue tracker here., _(*17)

Security

If you discover any security related issues, please email zouyi@leying365.com instead of using the issue tracker., _(*18)

License

The MIT License (MIT)., _(*19)