Laravel and JWT

In this article, we will look at using JWT to secure our Laravel APIs.

JSON Web Token (JWT) is an open standard that allows two parties to securely send data and information as JSON objects. This information can be verified and trusted because it is digitally signed.

JWT authentication has aided the wider adoption of stateless API services. It makes it convenient to authorise and verify clients accessing API resources. It is a critical part of the authentication system in javascript powered applications.

Prerequisites

Knowledge of PHP
Knowledge of Laravel
Have composer and Laravel installer installed
Knowledge of git
Have and know how to use postman

Getting Started

1. 使用 composer 安装

1 2	# 建议使用1.0以上版本 composer require tymon/jwt-auth 1.*@rc

2. 进行一些配置

这里指的注意的是，有些文档会说要添加 Tymon\JWTAuth\Providers\LaravelServiceProvider::class，这只在 Laravel 5.4 及以下版本是必要的，更新的 Laravel 版本无需添加。

还有一些文档说要添加 Tymon\JWTAuth\Providers\JWTAuthServiceProvider 这是很久以前的 JWT 版本的（大概0.5.3 以前的版本）。

2.1 发布配置文件

1 2	# 这条命令会在 config 下增加一个 jwt.php 的配置文件 php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\LaravelServiceProvider"

2.2 生成加密密钥

1 2	# 这条命令会在 .env 文件下生成一个加密密钥，如：JWT_SECRET=foobar php artisan jwt:secret

2.3 更新你的模型

如果你使用默认的 User 表来生成 token，你需要在该模型下增加一段代码

<?php
namespace App;
use Tymon\JWTAuth\Contracts\JWTSubject;
use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;
class User extends Authenticatable implements JWTSubject    # 这里别忘了加
{
  use Notifiable;
  public $table = 'user';
  /**
   * The attributes that are mass assignable. * * @var array
   */
  protected $fillable = [ 'name', 'password'];
  /**
   * The attributes that should be hidden for arrays. * * @var array
   */
  protected $hidden = [ 'password', 'remember_token'];
  // Rest omitted for brevity
  /**
   * Get the identifier that will be stored in the subject claim of the JWT. * * @return mixed
   */
  public function getJWTIdentifier()
  {
    return $this->getKey();
  }
  /**
   * Return a key value array, containing any custom claims to be added to the JWT. * * @return array
   */
  public function getJWTCustomClaims()
  {
    return [];
  }
}

2.4 注册两个 Facade

这两个 Facade 并不是必须的，但是使用它们会给你的代码编写带来一点便利。

config/app.php

'aliases' => [
  ... // 添加以下两行
  'JWTAuth' => 'Tymon\JWTAuth\Facades\JWTAuth',
  'JWTFactory' => 'Tymon\JWTAuth\Facades\JWTFactory',
],

如果你不使用这两个 Facade，你可以使用辅助函数 auth()

auth() 是一个辅助函数，返回一个guard，暂时可以看成 Auth Facade。

2.5 修改 `auth.php`

config/auth.php

'guards' => [
  'web' => [
    'driver' => 'session',
    'provider' => 'users',
  ],
  'api' => [
    'driver' => 'jwt',
    // 原来是 token 改成jwt
    'provider' => 'users',
  ],
],

2.6 注册一些路由

注意：在 Laravel 下，route/api.php 中的路由默认都有前缀 api。

Route::any('login', 'AuthController@authenticate');
Route::group(['middleware' => ['jwt.verify']], function () {
  Route::get('me', 'AuthController@getAuthenticatedUser');
});

2.7 创建 token 控制器

1	php artisan make:controller AuthController

AuthController

<?php
namespace App\Http\Controllers;
use App\User;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Hash;
use Illuminate\Support\Facades\Validator;
use JWTAuth;
use Tymon\JWTAuth\Exceptions\JWTException;
//eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC9sb3ZlLnRhb21lbmcudGVjaFwvYXBpXC9sb2dpbiIsImlhdCI6MTU0MzIyOTA2MCwiZXhwIjoxNTQzMjMyNjYwLCJuYmYiOjE1NDMyMjkwNjAsImp0aSI6IkRlZ1MwR1VYWm5NaTZqQWsiLCJzdWIiOjEsInByd
iI6Ijg3ZTBhZjFlZjlmZDE1ODEyZmRlYzk3MTUzYTE0ZTBiMDQ3NTQ2YWEifQ.deIqDWAYImLs6Y5qCjn42Bk6bz0XRfeUrpJOMG2ZzVg
class AuthController extends Controller
{
  public function authenticate(Request $request)
  {
    $credentials = $request->only('name', 'password');
    try {
      if (! $token = JWTAuth::attempt($credentials)) {
        return response()->json(['error' => 'invalid_credentials'], 400);
      }
    }
    catch (JWTException $e) {
      return response()->json(['error' => 'could_not_create_token'], 500);
    }
    return response()->json(compact('token'));
  }
  public function getAuthenticatedUser()
  {
    try {
      if (! $user = JWTAuth::parseToken()->authenticate()) {
        return response()->json(['user_not_found'], 404);
      }
    }
    catch (Tymon\JWTAuth\Exceptions\TokenExpiredException $e) {
      return response()->json(['token_expired'], $e->getStatusCode());
    }
    catch (Tymon\JWTAuth\Exceptions\TokenInvalidException $e) {
      return response()->json(['token_invalid'], $e->getStatusCode());
    }
    catch (Tymon\JWTAuth\Exceptions\JWTException $e) {
      return response()->json(['token_absent'], $e->getStatusCode());
    }
    return response()->json(compact('user'));
  }
}

Creating our routes

Before we define our API routes, we need to create a JwtM``iddleware which will protect our routes. Run this command via your terminal.

1	$ php artisan make:middleware JwtMiddleware

This will create a new middleware file inside our Middleware directory. This file can be located here app/Http/Middleware/JwtMiddleware. Open up the file and replace the content with the following:

<?php
namespace App\Http\Middleware;
use Closure;
use JWTAuth;
use Exception;
use Tymon\JWTAuth\Http\Middleware\BaseMiddleware;
class JwtMiddleware extends BaseMiddleware
{
  /**
   * Handle an incoming request. * * @param  \Illuminate\Http\Request  $request * @param  \Closure  $next * @return mixed
   */
  public function handle($request, Closure $next)
  {
    try {
      $user = JWTAuth::parseToken()->authenticate();
    }
    catch (Exception $e) {
      if ($e instanceof \Tymon\JWTAuth\Exceptions\TokenInvalidException) {
        return response()->json(['status' => 'Token is Invalid']);
      }
      else if ($e instanceof \Tymon\JWTAuth\Exceptions\TokenExpiredException) {
        return response()->json(['status' => 'Token is Expired']);
      }
      else {
        return response()->json(['status' => 'Authorization Token not found']);
      }
    }
    return $next($request);
  }
}

This middleware extends Tymon\JWTAuth\Http\Middleware\BaseMiddleware, with this, we can catch token errors and return appropriate error codes to our users.

Next, we need to register our middleware. Open app/http/Kernel.php and add the following:

[...]
protected $routeMiddleware = [ [...]
  'jwt.verify' => \App\Http\Middleware\JwtMiddleware::class];
  [...]

备注：token的表示方法：`Authorization`: Bearer insert_user_token_here

数据库设计： 备注：token的表示方法：Authorization:示意图

本文早期发布于个人 CSDN 博客：查看原文