php passport security,使用 Laravel Passport 处理 API 认证

image

我们将会学习使用 Laravel 的 Passport API OAuth 来创建一个验证系统。

第一步. 安装 Laravel

我们需要用以下命令来创建一个最新的 Laravel 应用，所以请打开终端执行：

laravel new auth

第二步. 安装 Laravel Passport 包

Laravel Passport 可以在几分钟内为你的应用实现一个完整的 OAuth2 服务器。

composer require laravel/passport

第三步. 运行数据库迁移

Passport 的迁移会创建你的应用用来存储客户端和 Access Token 的表。

php artisan migrate

第四步. 生成秘钥

此命令会创建秘钥以用来生成安全的 Access Token。除此之外，它也会创建用来生成 Access Token 的 personal access 和 password grant：

php artisan passport:install

执行完毕后，将 Laravel\Passport\HasApiTokens trait 添加到你的 App\User 模型中。这个 trait 会为模型添加一系列助手函数用来验证用户的秘钥和作用域：

第五步 . Passport 配置

namespace App;

use Illuminate\Notifications\Notifiable;

use Illuminate\Foundation\Auth\User as Authenticatable;

use Laravel\Passport\HasApiTokens;

class User extends Authenticatable

{

use Notifiable, HasApiTokens;

}

接下来，你应该在 AuthServiceProvider 中的 boot 方法中调用 Passport::routes 方法。这个方法会注册必要的路由去颁发访问令牌，撤销访问令牌，客户端和个人令牌：

namespace App\Providers;

use Laravel\Passport\Passport;

use Illuminate\Support\Facades\Gate;

use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;

class AuthServiceProvider extends ServiceProvider

{

/**

* The policy mappings for the application.

*

* @var array

*/

protected $policies = [

'App\Model' => 'App\Policies\ModelPolicy',

];

/**

* Register any authentication / authorization services.

*

* @return void

*/

public function boot()

{

$this->registerPolicies();

Passport::routes();

}

}

最后，在 config/auth.php 配置文件中，你应该设置 api 权限认证守卫的 driver 选项为 passport。当需要权限认证的 API 请求进来时会告诉你的应用去使用 Passport's 的 TokenGuard。

'guards' => [

'web' => [

'driver' => 'session',

'provider' => 'users',

],

'api' => [

'driver' => 'passport',

'provider' => 'users',

],

],

第六步. 添加 API 路由

Laravel 提供了 routes/api.php 文件来给我们编写 web 路由，因此在这个文件添加新的路由即可。

use Illuminate\Http\Request;

Route::group([

'prefix' => 'auth'

], function () {

Route::post('login', 'AuthController@login');

Route::post('signup', 'AuthController@signup');

Route::group([

'middleware' => 'auth:api'

], function() {

Route::get('logout', 'AuthController@logout');

Route::get('user', 'AuthController@user');

});

});

第七步: 创建控制器

最后一步我们必须创建新的控制器和 api 方法。因此我们先创建 AuthController 并且把代码写进去：

namespace App\Http\Controllers;

use Illuminate\Http\Request;

use Illuminate\Support\Facades\Auth;

use Carbon\Carbon;

use App\User;

class AuthController extends Controller

{

/**

* Create user

*

* @param [string] name

* @param [string] email

* @param [string] password

* @param [string] password_confirmation

* @return [string] message

*/

public function signup(Request $request)

{

$request->validate([

'name' => 'required|string',

'email' => 'required|string|email|unique:users',

'password' => 'required|string|confirmed'

]);

$user = new User([

'name' => $request->name,

'email' => $request->email,

'password' => bcrypt($request->password)

]);

$user->save();

return response()->json([

'message' => 'Successfully created user!'

], 201);

}

/**

* Login user and create token

*

* @param [string] email

* @param [string] password

* @param [boolean] remember_me

* @return [string] access_token

* @return [string] token_type

* @return [string] expires_at

*/

public function login(Request $request)

{

$request->validate([

'email' => 'required|string|email',

'password' => 'required|string',

'remember_me' => 'boolean'

]);

$credentials = request(['email', 'password']);

if(!Auth::attempt($credentials))

return response()->json([

'message' => 'Unauthorized'

], 401);

$user = $request->user();

$tokenResult = $user->createToken('Personal Access Token');

$token = $tokenResult->token;

if ($request->remember_me)

$token->expires_at = Carbon::now()->addWeeks(1);

$token->save();

return response()->json([

'access_token' => $tokenResult->accessToken,

'token_type' => 'Bearer',

'expires_at' => Carbon::parse(

$tokenResult->token->expires_at

)->toDateTimeString()

]);

}

/**

* Logout user (Revoke the token)

*

* @return [string] message

*/

public function logout(Request $request)

{

$request->user()->token()->revoke();

return response()->json([

'message' => 'Successfully logged out'

]);

}

/**

* Get the authenticated User

*

* @return [json] user object

*/

public function user(Request $request)

{

return response()->json($request->user());

}

}

现在我们已经准备好运行我们的示例了，运行下面的命令以快速运行：

php artisan serve

测试

现在，我们可以使用 REST 客户端工具来简化测试，例如 Postman。我执行测试你可以看见以下的截图。

你要为这个 API 设置以下两个头信息：

Content-Type: application/json

X-Requested-With: XMLHttpRequest

image

注册

image

登录

image

登出

image

用户

image

感谢阅读！

资源

引用