https://github.com/irazasyed/jwt-auth-guard

JWT Auth Guard for Laravel and Lumen Frameworks.
https://github.com/irazasyed/jwt-auth-guard

auth composer composer-packages driver jwt jwt-auth jwt-auth-guard jwt-authentication laravel laravel-5-package laravel-package lumen middleware packages php

Last synced: 6 months ago
JSON representation

JWT Auth Guard for Laravel and Lumen Frameworks.

Host: GitHub
URL: https://github.com/irazasyed/jwt-auth-guard
Owner: irazasyed
License: mit
Created: 2016-01-11T00:28:15.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2019-12-03T06:58:52.000Z (almost 6 years ago)
Last Synced: 2025-04-04T01:07:42.911Z (6 months ago)
Topics: auth, composer, composer-packages, driver, jwt, jwt-auth, jwt-auth-guard, jwt-authentication, laravel, laravel-5-package, laravel-package, lumen, middleware, packages, php
Language: PHP
Homepage: https://bit.ly/jwt-auth-guard
Size: 38.1 KB
Stars: 320
Watchers: 11
Forks: 41
Open Issues: 6
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

README

          # JWT Auth Guard

[![Join PHP Chat][ico-phpchat]][link-phpchat]

[![Chat on Telegram][ico-telegram]][link-telegram]

[![Laravel Package][ico-laravel]][link-repo]

[![Latest Version on Packagist][ico-version]][link-packagist]

[![Software License][ico-license]](LICENSE.md)

[![Total Downloads][ico-downloads]][link-downloads]

> JWT Auth Guard is a Laravel & Lumen Package that lets you use `jwt` as your driver for authentication guard in your application.

> 

> The Guard uses `tymon/jwt-auth` package for authentication and token handling.

## Requirements

- Laravel or Lumen Installation.

- [tymon/jwt-auth](https://github.com/tymondesigns/jwt-auth) `^1.0@dev` Package Setup and Config'd.

## Pre-Installation

First install and setup [tymon/jwt-auth](https://github.com/tymondesigns/jwt-auth) package.

``` bash

$ composer require tymon/jwt-auth:^1.0@dev

```

Once done, config it and then install this package.

## Install

Via Composer

``` bash

$ composer require irazasyed/jwt-auth-guard

```

### Add the Service Provider

#### Laravel

Open `config/app.php` and, to your `providers` array at the bottom, add:

```php

Irazasyed\JwtAuthGuard\JwtAuthGuardServiceProvider::class

```

#### Lumen

Open `bootstrap/app.php` and register the service provider:

``` php

$app->register(Irazasyed\JwtAuthGuard\JwtAuthGuardServiceProvider::class);

```

## Usage

Open your `config/auth.php` config file and in place of driver under any of your guards, just add the `jwt-auth` as your driver and you're all set.

Make sure you also set `provider` for the guard to communicate with your database.

### Setup Guard Driver

``` php

// config/auth.php

'guards' => [

    'api' => [

        'driver' => 'jwt-auth',

        'provider' => 'users'

    ],

    

    // ...

],

'providers' => [

    'users' => [

        'driver' => 'eloquent',

        'model'  => App\User::class,

    ],

],

```

### Middleware Usage

Middleware protecting the route:

``` php

Route::get('api/content', ['middleware' => 'auth:api', 'uses' => 'ContentController@content']);

```

Middleware protecting the controller:

``` php

middleware('auth:api');

    }

}

```

**Note:** The above example assumes you've setup a guard with the name `api` whose driver is `jwt-auth` in your `config/auth.php` file as explained in "Setup Guard Driver" section above.

> The following usage examples assume you've setup your default auth guard to the one which uses the `jwt-auth` driver.

>

> You can also explicitly define the guard before making calls to any of methods by just prefixing it with `Auth::guard('api')`. 

>

> Example: `Auth::guard('api')->user()`

### Attempt To Authenticate And Return Token

``` php

// This will attempt to authenticate the user using the credentials passed and returns a JWT Auth Token for subsequent requests.

$token = Auth::attempt(['email' => 'user@domain.com', 'password' => '123456']);

```

### Authenticate Once By ID

``` php

if(Auth::onceUsingId(1)) {

    // Do something with the authenticated user

}

```

### Authenticate Once By Credentials

``` php

if(Auth::once(['email' => 'user@domain.com', 'password' => '123456'])) {

    // Do something with the authenticated user

}

```

### Validate Credentials

``` php

if(Auth::validate(['email' => 'user@domain.com', 'password' => '123456'])) {

    // Credentials are valid

}

```

### Check User is Authenticated

``` php

if(Auth::check()) {

    // User is authenticated

}

```

### Check User is a Guest

``` php

if(Auth::guest()) {

    // Welcome guests!

}

```

### Logout Authenticated User

``` php

Auth::logout(); // This will invalidate the current token and unset user/token values.

```

### Generate JWT Auth Token By ID

   

``` php

$token = Auth::generateTokenById(1);

echo $token;

```

### Get Authenticated User

Once the user is authenticated via a middleware, You can access its details by doing:

``` php

$user = Auth::user();

```

You can also manually access user info using the token itself:

``` php

$user = Auth::setToken('YourJWTAuthToken')->user();

```

### Get Authenticated User's ID

``` php

$userId = Auth::id();

```

### Refresh Expired Token

Though it's recommended you refresh using the middlewares provided with the package,

but if you'd like, You can also do it manually with this method.

Refresh expired token passed in request:

``` php

$token = Auth::refresh();

```

Refresh passed expired token:

``` php

Auth::setToken('ExpiredToken')->refresh();

```

### Invalidate Token

Invalidate token passed in request:

``` php

$forceForever = false;

Auth::invalidate($forceForever);

```

Invalidate token by setting one manually:

``` php

$forceForever = false;

Auth::setToken('TokenToInvalidate')->invalidate($forceForever);

```

### Get Token

``` php

$token = Auth::getToken(); // Returns current token passed in request.

```

### Get Token Payload

This method will decode the token and return its raw payload.

Get Payload for the token passed in request:

``` php

$payload = Auth::getPayload();

```

Get Payload for the given token manually:

``` php

$payload = Auth::setToken('TokenToGetPayload')->getPayload();

```

## Change log

Please see [CHANGELOG](.github/CHANGELOG.md) for more information what has changed recently.

## Testing

``` bash

$ composer test

```

## Contributing

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) and [CONDUCT](.github/CONDUCT.md) for details.

Any issues, feedback, suggestions or questions please use issue tracker [here](https://github.com/irazasyed/jwt-auth-guard/issues).

## Security

If you discover any security related issues, please email syed+gh@lukonet.com instead of using the issue tracker.

## Credits

- [Syed Irfaq R.][link-author]

- [All Contributors][link-contributors]

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

[ico-phpchat]: https://img.shields.io/badge/Slack-PHP%20Chat-5c6aaa.svg?style=flat-square&logo=slack&labelColor=4A154B

[ico-telegram]: https://img.shields.io/badge/@PHPChatCo-2CA5E0.svg?style=flat-square&logo=telegram&label=Telegram

[ico-version]: https://img.shields.io/packagist/v/irazasyed/jwt-auth-guard.svg?style=flat-square

[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square

[ico-travis]: https://img.shields.io/travis/irazasyed/jwt-auth-guard/master.svg?style=flat-square

[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/irazasyed/jwt-auth-guard.svg?style=flat-square

[ico-code-quality]: https://img.shields.io/scrutinizer/g/irazasyed/jwt-auth-guard.svg?style=flat-square

[ico-downloads]: https://img.shields.io/packagist/dt/irazasyed/jwt-auth-guard.svg?style=flat-square

[ico-laravel]: https://img.shields.io/badge/Laravel-5|6-FF2D20.svg?style=flat-square&logo=laravel&labelColor=black&logoColor=white

[link-phpchat]: https://phpchat.co/?ref=jwt-auth-guard

[link-telegram]: https://t.me/PHPChatCo

[link-repo]: https://github.com/irazasyed/jwt-auth-guard

[link-packagist]: https://packagist.org/packages/irazasyed/jwt-auth-guard

[link-travis]: https://travis-ci.org/irazasyed/jwt-auth-guard

[link-scrutinizer]: https://scrutinizer-ci.com/g/irazasyed/jwt-auth-guard/code-structure

[link-code-quality]: https://scrutinizer-ci.com/g/irazasyed/jwt-auth-guard

[link-downloads]: https://packagist.org/packages/irazasyed/jwt-auth-guard

[link-author]: https://github.com/irazasyed

[link-contributors]: ../../contributors

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/irazasyed/jwt-auth-guard

Awesome Lists containing this project

README