Laravel Passport API 认证使用小结

八月 4, 2017 发布在 Laravel

看到Laravel-China 社区常有人问 Laravel Passport 用于密码验证方式来获取 Token 的问题,刚好我最近一个 API 项目使用 Laravel Dingo Api+Passport,也是使用 Oauth2 的'grant_type' => 'password'密码授权来做 Auth 验证,对于如何做登录登出,以及多账号系统的认证等常用场景做一下简单的使用小总结。

基本配置

基本安装配置主要参照官方文档,具体不详细说,列出关键代码段

config/auth.php

'guards' => [
'api' => [
'driver' => 'passport',
'provider' => 'users',
],
], 'providers' => [
'users' => [
'driver' => 'eloquent',
'model' => \App\Models\User::class
],
],

Providers/AuthServiceProvider.php

    public function boot()
{
$this->registerPolicies(); //默认令牌发放的有效期是永久
//Passport::tokensExpireIn(Carbon::now()->addDays(2));
//Passport::refreshTokensExpireIn(Carbon::now()->addDays(4));
Passport::routes(function (RouteRegistrar $router) {
//对于密码授权的方式只要这几个路由就可以了
config(['auth.guards.api.provider' => 'users']);
$router->forAccessTokens();
});
}

Middleware/AuthenticateApi.php 自定义中间件返回

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Auth\Middleware\Authenticate;
use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException; class AuthenticateApi extends Authenticate
{
protected function authenticate(array $guards)
{ if ($this->auth->guard('api')->check()) {
return $this->auth->shouldUse('api');
} throw new UnauthorizedHttpException('', 'Unauthenticated');
}
}

App/Http/Kernel.php

    /**
* The application's route middleware.
*
* These middleware may be assigned to groups or used individually.
*
* @var array
*/
protected $routeMiddleware = [
'api-auth' => AuthenticateApi::class,
......
];
}

账号验证字段不止邮箱

对于账号验证不止是数据表中的 emial 字段,还可能是用户名或者手机号字段只需要在 User 模型中添加findForPassport方法,示例代码如下:

App\Models\Users

class User extends Authenticatable implements Transformable
{
use TransformableTrait, HasApiTokens, SoftDeletes;
public function findForPassport($login)
{
return $this->orWhere('email', $login)->orWhere('phone', $login)->first();
}
}

客户端获取 access_token 请求只传用户名和密码

对于密码授权的方式需要提交的参数如下:

$response = $http->post('http://your-app.com/oauth/token', [
'form_params' => [
'grant_type' => 'password',
'client_id' => 'client-id',
'client_secret' => 'client-secret',
'username' => 'taylor@laravel.com',
'password' => 'my-password',
'scope' => '',
],
]);

但是客户端请求的时候不想把grant_type,client_id,client_secret,scope放到请求参数中或者暴露给客户端,只像 JWT 一样只发送usernamepassword 怎么办?很简单我们只要将不需要请求的放到配置文件中,然后客户端请求用户名密码以后我们再向oauth/token发送请求带上相关的配置就可以了。

.env.php

OAUTH_GRANT_TYPE=password
OAUTH_CLIENT_ID=1
OAUTH_CLIENT_SECRET=EvE4UPGc25TjXwv9Lmk432lpp7Uzb8G4fNJsyJ83
OAUTH_SCOPE=*

config/passport.php 当然该配置你可以配置多个client

return [
'grant_type' => env('OAUTH_GRANT_TYPE'),
'client_id' => env('OAUTH_CLIENT_ID'),
'client_secret' => env('OAUTH_CLIENT_SECRET'),
'scope' => env('OAUTH_SCOPE', '*'),
];

LoginController.php的示例代码如下,因为用了Dingo Api配置了api前缀,所以请求/api/oauth/token

 	/**
* 获取登录TOKEN
* @param LoginRequest $request
* @return \Illuminate\Http\JsonResponse
*/
public function token(LoginRequest $request)
{
$username = $request->get('username');
$user = User::orWhere('email', $username)->orWhere('phone', $username)->first(); if ($user && ($user->status == 0)) {
throw new UnauthorizedHttpException('', '账号已被禁用');
} $client = new Client();
try {
$request = $client->request('POST', request()->root() . '/api/oauth/token', [
'form_params' => config('passport') + $request->only(array_keys($request->rules()))
]); } catch (RequestException $e) {
throw new UnauthorizedHttpException('', '账号验证失败');
} if ($request->getStatusCode() == 401) {
throw new UnauthorizedHttpException('', '账号验证失败');
}
return response()->json($request->getBody()->getContents());
}

退出登录并清除 Token

对于客户端退出后并清除记录在oauth_access_tokens表中的记录,示例代码如下:

  /**
* 退出登录
*/
public function logout()
{
if (\Auth::guard('api')->check()) {
\Auth::guard('api')->user()->token()->delete();
} return response()->json(['message' => '登出成功', 'status_code' => 200, 'data' => null]);
}

根据用户 ID 认证用户

app('auth')->guard('api')->setUser(User::find($userId));

多用户表(多 Auth)认证

比如针对客户表和管理员表分别做 Auth 认证的情况,也列出关键代码段:

 'guards' => [
'api' => [
'driver' => 'passport',
'provider' => 'users',
], 'admin_api' => [
'driver' => 'passport',
'provider' => 'admin_users',
],
], 'providers' => [
'users' => [
'driver' => 'eloquent',
'model' => \App\Models\User::class
], 'admin_users' => [
'driver' => 'eloquent',
'model' => \App\Models\AdminUser::class
],
],

新建一个PasspordAdminServiceProvider来实现我们自己的PasswordGrant,别忘了添加到config/app.phpproviders配置段中

AppProviders/PasspordAdminServiceProvider

<?php

namespace App\Providers;

use App\Foundation\Repository\AdminUserPassportRepository;
use League\OAuth2\Server\Grant\PasswordGrant;
use Laravel\Passport\PassportServiceProvider as BasePassportServiceProvider;
use Laravel\Passport\Passport; class PasspordAdminServiceProvider extends BasePassportServiceProvider
{
/**
* Create and configure a Password grant instance.
*
* @return PasswordGrant
*/
protected function makePasswordGrant()
{
$grant = new PasswordGrant(
//主要是这里,我们调用我们自己UserRepository
$this->app->make(AdminUserPassportRepository::class),
$this->app->make(\Laravel\Passport\Bridge\RefreshTokenRepository::class)
); $grant->setRefreshTokenTTL(Passport::refreshTokensExpireIn()); return $grant;
} }

新建AdminUserPassportRepository,Password 的验证主要通过getUserEntityByUserCredentials,它读取配置的guards对应的provider来做认证,我们重写该方法,通过传递一个参数来告诉它我们要用哪个guard来做客户端认证

<?php

namespace App\Foundation\Repository;

use App;
use Illuminate\Http\Request;
use League\OAuth2\Server\Entities\ClientEntityInterface;
use Laravel\Passport\Bridge\UserRepository;
use Laravel\Passport\Bridge\User;
use RuntimeException; class AdminUserPassportRepository extends UserRepository
{ public function getUserEntityByUserCredentials($username, $password, $grantType, ClientEntityInterface $clientEntity)
{
$guard = App::make(Request::class)->get('guard') ?: 'api';//其实关键的就在这里,就是通过传递一个guard参数来告诉它我们是使用api还是admin_api provider来做认证
$provider = config("auth.guards.{$guard}.provider");
if (is_null($model = config("auth.providers.{$provider}.model"))) {
throw new RuntimeException('Unable to determine user model from configuration.');
} if (method_exists($model, 'findForPassport')) {
$user = (new $model)->findForPassport($username);
} else {
$user = (new $model)->where('email', $username)->first();
} if (!$user) {
return;
} elseif (method_exists($user, 'validateForPassportPasswordGrant')) {
if (!$user->validateForPassportPasswordGrant($password)) {
return;
}
} elseif (!$this->hasher->check($password, $user->password)) {
return;
} return new User($user->getAuthIdentifier());
}
}

登录和单用户系统一样,只是在请求oauth/token的时候带上guard参数,示例代码如下:

Admin/Controllers/Auth/LoginController.php

<?php

namespace Admin\Controllers\Auth;

use Admin\Requests\Auth\LoginRequest;
use App\Http\Controllers\Controller;
use App\Models\User;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
use Illuminate\Foundation\Auth\AuthenticatesUsers;
use Illuminate\Http\Request;
use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException; class LoginController extends Controller
{
/*
|--------------------------------------------------------------------------
| Login Controller
|--------------------------------------------------------------------------
|
| This controller handles authenticating users for the application and
| redirecting them to your home screen. The controller uses a trait
| to conveniently provide its functionality to your applications.
|
*/ use AuthenticatesUsers; /**
* Create a new controller instance.
*
* @return void
*/
public function __construct()
{
$this->middleware('guest')->except('logout');
} /**
* 获取登录TOKEN
* @param LoginRequest $request
* @return \Illuminate\Http\JsonResponse
*/
public function token(LoginRequest $request)
{
$username = $request->get('username');
$user = User::orWhere('email', $username)->orWhere('phone', $username)->first(); if ($user && ($user->status == 0)) {
throw new UnauthorizedHttpException('', '账号已被禁用');
} $client = new Client();
try {
$request = $client->request('POST', request()->root() . '/api/oauth/token', [
'form_params' => config('passport') + $request->only(array_keys($request->rules())) + ['guard' => 'admin_api']
]);
} catch (RequestException $e) {
throw new UnauthorizedHttpException('', '账号验证失败');
} if ($request->getStatusCode() == 401) {
throw new UnauthorizedHttpException('', '账号验证失败');
}
return response()->json($request->getBody()->getContents());
} /**
* 退出登录
*/
public function logout()
{
if (\Auth::guard('admin_api')->check()) {
\Auth::guard('admin_api')->user()->token()->delete();
} return response()->json(['message' => '登出成功', 'status_code' => 200, 'data' => null]);
}
}

转载请注明:  转载自Ryan 是菜鸟 | LNMP 技术栈笔记

Laravel Passport API 认证使用小结的更多相关文章

  1. Laravel 的 API 认证系统 Passport 三部曲(二、passport的具体使用)

    GQ1994 关注 2018.04.20 09:31 字数 1152 阅读 1316评论 0喜欢 1 参考链接 Laravel 的 API 认证系统 Passport 三部曲(一.passport安装 ...

  2. laravel passport client_credentials

    我是使用 Laravel 5.4 + Dingo Api + passport/jwt 两个验证方式 目前需要用到 passport 的 client_credentials 获取 token成功之后 ...

  3. [ Laravel 5.3 文档 ] 安全 ―― API认证(Passport)保障安全性。

    1.简介 Laravel通过传统的登录表单已经让用户认证变得很简单,但是API怎么办?API通常使用token进行认证并且在请求之间不维护session状态.Laravel使用LaravelPassp ...

  4. laravel Passport - 创建 REST API 用户认证以及Dingo/Api v2.0+Passport实现api认证

    第一部分: 安装passport 使⽤ Composer 依赖包管理器安装 Passport : composer require laravel/passport 接下来,将 Passport 的服 ...

  5. laravel Passport - Dingo/Api v2.0+Passport 实现 api 认证

    第一部分: 安装passport 使⽤ Composer 依赖包管理器安装 Passport : composer require laravel/passport 接下来,将 Passport 的服 ...

  6. laravel 的passport Oauth 认证登录请求 的 oauth_token 重置

    laravel 的passport Oauth 认证登录请求 的 oauth_token 重置    使用API登录认证是需要获取访问令牌,方法为: 参数: grant_type —— 密码模式固定为 ...

  7. Laravel Passport认证-多表、多字段解决方案

    Laravel Passport认证-多表.多字段解决方案 2018年08月19日 09:31:01 醉卧码场君莫笑 阅读数:1632   1. 概述 API 通常使用令牌(token)进行认证并且在 ...

  8. 单点登录 - API 认证系统 Passport(二)

    安装 composer require laravel/passport=~4.0 notes: 1)确保系统安装unzip.zip等命令. 2)composer 安装出现 Authenticatio ...

  9. laravel dingo/api添加jwt-auth认证

    前面我们学了laravel dingo/api创建简单的api,这样api是开放给所有人的,如何查看和限制api的调用呢?可以用jwt-auth来验证,JSON Web Token Authentic ...

随机推荐

  1. urllib的简单使用

    首先需要导包 Import urllib.request 这是一个简单的网站例如:发起请求Response = urlib.request.urlopen("http://www.baidu ...

  2. Core dump文件和ECFS

    core dump文件 core dump核心转储文件,一些信号的处理方式,会生成一个elf格式的文件,用来分析进程崩溃情况. 总结一下,core dump核心转储文件就是将所有的vma都映射成一个e ...

  3. SMTP实现发送邮箱2(封装版)

    SMTP.h #ifndef __SMTP_H__ //避免重复包含 #define __SMTP_H__ #include <iostream> #include <list> ...

  4. 通过ADB调试安卓程序

    ADB,即 Android Debug Bridge,它是Android开发/测试人员不可替代的强大工具. 1.下载ADB后,将以下四个文件放到某个文件夹下即可.因为打开Cmd默认路径是 C:\Use ...

  5. Scala学习十五——注解

    一.本章要点 可以为类.方法.字段.局部变量.参数.表达式.类型参数以及各种类型定义添加注解 对于表达式和类型,注解跟在被注解的条目之后 注解的形式有@Annotation.@Annotation(v ...

  6. 记一次邮件推送的坑,c#基于smtp使用腾讯企业邮箱发送邮件总是失败的原因

    今天在弄企业邮箱推送的东西,原版代码是这样的 public void SendEmail(string title, string content) { try { MailMessage mailM ...

  7. C语言 读取配置文件

    配置文件截图: 读取结果截图: 代码转自:http://www.tuicool.com/articles/Zb2iIn 附代码: // ReadConfig.cpp : 定义控制台应用程序的入口点. ...

  8. 电脑无法上网,DNS出现fec0:0:0:ffff::1%1问题

    具体描述:qq,微信可用网,但其他不能用. 一.win+r 输入cmd 打开命令行:ipconfig /all 查看DNS 二.打开文本编辑器,输入如下文本: @Echo onpushd\window ...

  9. Windows 查看端口使用、根据pid查找引用程序

    1.查看特定端口的使用情况:以80端口为例,输入命令 netstat -aon|findstr "80" 2.根据PID号找到对应的程序:以PID是6776为例,输入命令taskl ...

  10. Python学习记录4-列表、元祖和集合

    list列表 一组由有序数据组成的序列 数据有先后顺序 数据可以不是一类数据 list的创建 直接创建,用中括号创建,内容直接用英文逗号隔开 使用list创建 列表包含单个字符串的时候是一个特例 # ...