library auth

kolayik/auth

Kolay Auth

Documentation

For version dev-master See the below for documentation., _(*1)

Installation

To install this package you will need:, _(*2)

• Laravel 4 or 5
• PHP 5.4 +

Install package via composer require, _(*3)

composer require kolayik/auth:dev-master

or edit your composer.json, _(*4)

"require": {

    "kolayik/auth": "dev-master"
}

Then run composer update in your terminal to pull it in., _(*5)

Once this has finished, you will need to add the service provider to the providers array in your app.php config as follows:, _(*6)

KolayIK\Auth\Providers\LaravelServiceProvider::class

Finally, you will want to publish the config and migration file using the following command:, _(*7)

Laravel 5:, _(*8)

$ php artisan vendor:publish --provider="KolayIK\Auth\Providers\LaravelServiceProvider"

Configuration

Open .env file and change according to your request., _(*9)

Token time to live - KOLAY_AUTH_TTL, _(*10)

Storage - KOLAY_AUTH_DRIVER, _(*11)

KOLAY_AUTH_DRIVER:"database" or "cache"

KOLAY_AUTH_TTL:1440

Quick Start

How do generate a custom token ?, _(*12)

use KolayIK\Auth\Facades\KolayAuth;

class AuthenticateController extends Controller
{
    public function authenticate(Request $request)
    {
        // your add custom login code
        $userId = "kolayik";

        return response()->json(KolayAuth::generate($userId));
    }
}

How do authenticate via token in custom middleware ?, _(*13)

    namespace App\Http\Middleware;
    use KolayIK\Auth\Facades\KolayAuth;

    class CustomAuth
    {
        public function handle($request, Closure $next)
        {   
            $token = KolayAuth::authenticate();

            if ($token->isExpired()) {
                throw new \Exception('Session expired!');
            }

            return $next($request);
        }
    }

Authentication

To make authenticated requests via http using the built in methods, you will need to set an authorization header as follows:, _(*14)

Authorization: Bearer {yourtoken}

Note to Apache users, _(*15)

Apache seems to discard the Authorization header if it is not a base64 encoded user/pass combo. So to fix this you can add the following to your apache config, _(*16)

RewriteEngine On
RewriteCond %{HTTP:Authorization} ^(.*)
RewriteRule .* - [e=HTTP_AUTHORIZATION:%1]

Alternatively you can include the token via a query string, _(*17)

http://api.mysite.com/me?authorization_key={yourtoken}

To get the token from the request you can do:, _(*18)

$token = KolayAuth::getToken();

Middleware, _(*19)

You can use kolay.auth middleware:, _(*20)

Route::group(['prefix' => '/api/v1', 'middleware' => 'kolay.auth'], function () {
    //your code
});

License

The MIT License (MIT), _(*21)