官网:https://jwt-auth.readthedocs.io 参考:https://learnku.com/articles/10885/full-use-of-jwt#99529fphp
一、token是什么
token 翻译为令牌,就是鉴别身份的凭据,相似于身份证; token 本质就是一大串字符串,最经常使用的场景就是接口对接的鉴权。 token 经过一次登陆验证,获得一个鉴权字符串,随后其它的请求每次都携带这个鉴权字符串,便可完成鉴权。 web
二、jwt是什么
jwt 全称json web token(翻译为数据网络令牌) jwt 是一种规范化的 token,让数据在网络中安全传输。 jwt 使用场景:json
无状态的 RESTful API SSO 单点登陆api
三、jwt安装&配置
3.一、经过composer安装
//安装1.0以上版本安全
composer require tymon/jwt-auth 1.*@rc
3.二、配置
添加配置(config/app.php)网络
//providers元素中添加: Tymon\JWTAuth\Providers\LaravelServiceProvider::class, //aliases元素中添加: 'JWTAuth' => Tymon\JWTAuth\Facades\JWTAuth::class, 'JWTFactory' => Tymon\JWTAuth\Facades\JWTFactory::class,
发布配置session
php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\LaravelServiceProvider" //会自动生成一个配置文件:config/jwt.php
3.三、生成加密密钥
php artisan jwt:secret //.env 文件下生成一个加密密钥
3.四、更新生成token模型
若是使用默认的 User 表来生成 token,app\user.phpapp
实现JWTSubject接口,实现getJWTIdentifier()和getJWTCustomClaims()方法composer
use Tymon\JWTAuth\Contracts\JWTSubject; class User extends Authenticatable implements JWTSubject { ... public function getJWTIdentifier() { return $this->getKey(); } public function getJWTCustomClaims() { return []; } }
3.5.修改 auth.php
config/auth.phpide
'guards' => [ 'web' => [ 'driver' => 'session', 'provider' => 'users', ], 'api' => [ 'driver' => 'jwt', // 原来是 token 改为jwt 'provider' => 'users', ], ],
四、jwt准备
4.一、新建控制器
php artisan make:controller AuthController
4.二、控制器添加方法
官方案例:
login登陆,me获取用户信息,logout退出登陆,refresh刷新token,respondWithToken返回token
<?php namespace App\Http\Controllers; class AuthController extends Controller { /** * Create a new AuthController instance. * 要求附带email和password(数据来源users表) * @return void */ public function __construct() { // 这里额外注意了:官方文档样例中只除外了『login』 // 这样的结果是,token 只能在有效期之内进行刷新,过时没法刷新 // 若是把 refresh 也放进去,token 即便过时但仍在刷新期之内也可刷新 // 不过刷新一次做废 $this->middleware('auth:api', ['except' => ['login']]); // 另外关于上面的中间件,官方文档写的是『auth:api』 // 可是我推荐用 『jwt.auth』,效果是同样的,可是有更加丰富的报错信息返回 } /** * Get a JWT via given credentials. * * @return \Illuminate\Http\JsonResponse */ public function login() { $credentials = request(['email', 'password']); if (! $token = auth('api')->attempt($credentials)) { return response()->json(['error' => 'Unauthorized'], 401); } return $this->respondWithToken($token); } /** * Get the authenticated User. * * @return \Illuminate\Http\JsonResponse */ public function me() { return response()->json(auth('api')->user()); } /** * Log the user out (Invalidate the token). * * @return \Illuminate\Http\JsonResponse */ public function logout() { auth('api')->logout(); return response()->json(['message' => 'Successfully logged out']); } /** * Refresh a token. * 刷新token,若是开启黑名单,之前的token便会失效。 * 值得注意的是用上面的getToken再获取一次Token并不算作刷新,两次得到的Token是并行的,即两个均可用。 * @return \Illuminate\Http\JsonResponse */ public function refresh() { return $this->respondWithToken(auth('api')->refresh()); } /** * Get the token array structure. * * @param string $token * * @return \Illuminate\Http\JsonResponse */ protected function respondWithToken($token) { return response()->json([ 'access_token' => $token, 'token_type' => 'bearer', 'expires_in' => auth('api')->factory()->getTTL() * 60 ]); } }
4.三、添加路由
routes/api.php
Route::group(['prefix' => 'auth'], function(){ Route::post('login', 'AuthController@login'); Route::post('logout', 'AuthController@logout'); Route::post('refresh', 'AuthController@refresh'); Route::post('me', 'AuthController@me'); });
4.四、添加users表数据
能够注册是如何添加的,看一下密码的加密方式
App\Http\Controllers\Auth\RegisterController
... protected function create(array $data) { return User::create([ 'name' => $data['name'], 'email' => $data['email'], 'password' => Hash::make($data['password']), ]); }
添加一条用户数据
routes/web.php
Route::get('/register', function(){ \App\User::create([ 'name' => 'bb', 'email' => 'test@bb.com', 'password' => \Illuminate\Support\Facades\Hash::make('123456'), ]); });
五、jwt使用
jwt koken两种使用方式
加到 url 中:?token=你的token
加到 header 中,建议用这种,由于在 https 状况下更安全:Authorization:Bearer 你的token
第二种方式的 Bearer Bearer Bearer 别漏了,
也能够在 AuthController respondWithToken() 返回的时候加上 'Bearer '.$token
六、结果
一、登陆返回token
经测试,登陆屡次产生的token均可以在有效期内使用
其余接口请求时,携带登陆返回的token
二、获取用户信息
三、退出,删除token
四、刷新token