Laravel PassPort API 认证之基本实现

前言

最近在搞一个小小的项目,练练手,需要前后端分离,所以后端就得提供api接口,那么接口就得需要认证!
所以选择了PassPort来做认证!

参考博客文档

如果我有写的不好的地方,大家可以参看这些博客文档,文中有些文字来源于这些博客以及文档

1
composer require laravel/passport
  • 数据库迁移(ps: 在这之前请配置好.env里的数据库信息
1
php artisan migrate

在这里插入图片描述

  • 创建生成安全访问令牌时所需的加密密钥(默认密码模式(对于密码模式,我们只使用第二个密钥
1
php artisan passport:install

在这里插入图片描述

  • 在App\User 模型中添加Laravel\Passport\HasApiTokens Trait
1
2
3
4
5
6
7
8
9
10
11
12
<?php

namespace App; // 模型命名空间 如放到\App\Model 中 修改为namespace App\Model

use Laravel\Passport\HasApiTokens;
use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable
{
use HasApiTokens, Notifiable;
}
  • 在 /app/Providers/AuthServiceProvider.php 的 boot 方法中调用 Passport::routes 函数。这个函数会注册发出访问令牌并撤销访问令牌、客户端和个人访问令牌所必需的路由:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
<?php

namespace App\Providers;

use Laravel\Passport\Passport;
use Illuminate\Support\Facades\Gate;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;

class AuthServiceProvider extends ServiceProvider
{
/**
* 应用程序的策略映射。
*
* @var array
*/
protected $policies = [
'App\Model' => 'App\Policies\ModelPolicy',
];

/**
* 注册认证 / 授权服务
*
* @return void
*/
public function boot()
{
$this->registerPolicies();

// 注册passport用到的路由
Passport::routes();

// 设置token过期时间
Passport::tokensExpireIn(now()->addMinutes(15));

// 设置刷新token过期时间
Passport::refreshTokensExpireIn(now()->addMinutes(15));
}
}
  • 最后,将配置文件 config/auth.php 中授权看守器 guards 的 api 的 driver 选项改为 passport。此调整会让你的应用程序在在验证传入的 API 的请求时使用 Passport 的 TokenGuard 来处理:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
'defaults' => [
'guard' => 'api', // 修改为api
'passwords' => 'users',
],
'guards' => [
'web' => [
'driver' => 'session',
'provider' => 'users',
],

'api' => [
'driver' => 'passport',
'provider' => 'users',
'hash' => false,
],
],

辛酸历程之自定义认证

  • 自定义用户名字段
    当你使用密码授权进行身份验证时,Passport 在模型里用 email 属性作为「username」。不过,你仍然可以通过在你的模型里面定义一个 findForPassport 方法来自定义验证行为。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<?php

namespace App;

use Laravel\Passport\HasApiTokens;
use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable
{
use HasApiTokens, Notifiable;

/**
* 通过给定的username获取用户实例。
*
* @param string $username
* @return \App\User
*/
public function findForPassport($username)
{
// 修改查找用户的字段,或者 多字段查找 orwhere
return $this->where('username', $username)->first();
}
}
  • 自定义密码验证
    当你使用密码授权进行身份验证时,Passport 会在你的模型里使用 password 字段来验证给定的密码。如果你的模型里面没有 password 属性或者你期望能够自动密码验证逻辑,你可以在你的模型里面定义一个 validateForPassportPasswordGrant 方法:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<?php

namespace App;

use Laravel\Passport\HasApiTokens;
use Illuminate\Support\Facades\Hash;
use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable
{
use HasApiTokens, Notifiable;

/**
* 通过Passport的密码授权验证用户使用的密码。
*
* @param string $password
* @return bool
*/
public function validateForPassportPasswordGrant($password)
{
// 修改你的密码校验方式,或者验证码校验
// passport 默认password为密码字段,无法修改, 不过可以继承重写方法以实现修改password
return Hash::check($password, $this->password);
}
}

辛酸历程之实现

由于只写了一个注册就来写博客了,我就先暂时展示注册的功能!

  • 添加路由
1
2
3
4
5
6
7
8
// 用户获取token 方式有很多
Route::post('/oauth/token', '\Laravel\Passport\Http\Controllers\AccessTokenController@issueToken');
// 注册接口
Route::post('/register', 'User\UserController@register');
// 拿到token后,试着用token 获取用户信息
Route::get('test', function () {
return \Auth::user();
})->middleware('auth'); // 默认中间件
  • 控制器代码
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
protected $clientId;
protected $clientSecret;

public function __construct()
{
$this->middleware('auth')->except('login', 'register', 'refresh');
// 使用密码模式服务端密钥 可以有多个
// 这里应该写个缓存,或者写进配置文件里
$client = \DB::table('oauth_clients')->where('id', 2)->first();
$this->clientId = $client->id;
$this->clientSecret = $client->secret;
}

/**
* 定义查找用户字段
*/
protected function username()
{
return 'phone';
}

/**
* 得到token
*/

private function getToken($phone, $password)
{
$response = null;
try {
$response = (new Client())->post(url('/oauth/token'), [
'form_params' => [
'grant_type' => 'password',
'username' => $phone,
'password' => $password,
'client_id' => $this->clientId,
'client_secret' => $this->clientSecret,
'scope' => '*', // 用户权限域 * 代表可以访问所有域
],
]);
} catch (RequestException $e) {
return json_encode(['code' => 401, 'msg' => '账号登录失败!请重试!']);
}

if($response->getStatusCode() == 401) {
return json_encode(['code' => 401, 'msg' => '账号登录失败!请重试!']);
}

return json_encode(['code' => 200, 'data' => json_decode((string) $response->getBody(), true)]);
}

/**
* 用户注册
* @param Request $request
* @return \Illuminate\Contracts\Routing\ResponseFactory|\Illuminate\Http\JsonResponse|\Illuminate\Http\Response
*/
public function register(Request $request)
{
//获取用户输入
$input = $request->all();

//表单验证规则
$rule = [
'phone' => 'required|digits:11|numeric',
'password' => 'required|between:8,20',
];

$msg = [
'phone.required' => 'wrongPhone',
'phone.digits' => 'wrongPhone',
'phone.numeric' => 'wrongPhone',
'password.required' => 'wrongPw',
'password.between' => 'wrongPw',
];

$validator = Validator::make($input, $rule, $msg);

//注册信息有错误
if($validator->fails()){
//返回第一个错误
return response()->json(['code'=>202, 'msg'=>$validator->errors()->first()]);
}


//查询是否有重复
$res = User::where($this->username(), '=', $input['phone'])->first();

if($res != null) {

return response()->json(['code'=>202, 'msg'=>'hadUser', 'user'=>$res]);

}
else {

User::query()->create(['phone'=>$input['phone'], 'password'=>password_hash($input['password'], PASSWORD_DEFAULT)]);

$tokenData = json_decode((string)$this->getToken($input['phone'], $input['password']), true);

if($tokenData['code'] != 200) {
return response()->json(['code' => 401, 'msg' => '登录认证失败, 请重试!']);
}

$tokenData = $tokenData['data']['token_type'] . ' ' . $tokenData['data']['access_token'];

return response()
->json(['code'=>200, 'msg'=>'success'])
->header('Authorization', $tokenData);
}
}

辛酸历程之结果

  • 注册,返回注册成功, token 我直接返回在了header里
    在这里插入图片描述
    在这里插入图片描述
  • 使用token 获取自己的信息
    在这里插入图片描述

    还没完,后续再更新

本文标题:Laravel PassPort API 认证之基本实现

文章作者:HKer_YM

发布时间:2020年03月04日 - 14:03:20

最后更新:2020年03月04日 - 14:06:24

原始链接:https://blog.dreams-wj.top/2020/03/04/Laravel-PassPort-API-%E8%AE%A4%E8%AF%81%E4%B9%8B%E5%9F%BA%E6%9C%AC%E5%AE%9E%E7%8E%B0/

许可协议: 署名-非商业性使用-禁止演绎 4.0 国际 转载请保留原文链接及作者。