1. 概述
API 通常使用令牌(token)进行认证并且在请求之间不维护会话(Session)状态。Laravel 官方扩展包 Laravel Passport 让 API 认证变得轻而易举,Passport 基于 Alex Bilbie 维护的 League OAuth2 server,可以在数分钟内为 Laravel 应用提供完整的 OAuth2 服务器实现。本文主要讲述Oauth2 的'grant_type' => 'password'
密码授权来做Auth验证
2. 单表用户登录
2.1 安装
首先通过 Composer 包管理器安装 Passport:
根据laravel不同的版本,加载不同的管理包,如果你使用laravel5.4版本;使用命令
composer require laravel/passport v4.*
;不然可能因为版本问题,加载失败
composer require laravel/passport
成功安装Passport包之后,我们需要设置他们的服务提供者。所以,打开你的config / app.php文件,并在其中添加以下提供程序。
'providers' => [
....
Laravel\Passport\PassportServiceProvider::class,
],
2.2 迁移数据库
Passport 服务提供者为框架注册了自己的数据库迁移目录,所以在注册服务提供者之后(Laravel 5.5之后会自动注册服务提供者)需要迁移数据库,Passport 迁移将会为应用生成用于存放客户端和访问令牌的数据表:
php artisan migrate
2.3 生成加密键oauth_clients
php artisan passport:install
该命令将会创建生成安全访问令牌(token)所需的加密键,此外,该命令还会创建“personal access”和“password grant”客户端用于生成访问令牌,生成记录存放在数据表 oauth_clients
2.4 修改user模型
添加 Laravel\Passport\HasApiTokens trait 到 App\User 模型,该 trait 将会为模型类提供一些辅助函数用于检查认证用户的 token 和 scope
<?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;
}
2.4.1 重置验证字段
先看passport封装源码,然后根据自己需求更改我们的配置;追踪源码如下
<?php
namespace Laravel\Passport\Bridge;
use RuntimeException;
use Illuminate\Contracts\Hashing\Hasher;
use League\OAuth2\Server\Entities\ClientEntityInterface;
use League\OAuth2\Server\Repositories\UserRepositoryInterface;
class UserRepository implements UserRepositoryInterface
{
/**
* The hasher implementation.
*
* @var \Illuminate\Contracts\Hashing\Hasher
*/
protected $hasher;
/**
* Create a new repository instance.
*
* @param \Illuminate\Contracts\Hashing\Hasher $hasher
* @return void
*/
public function __construct(Hasher $hasher)
{
$this->hasher = $hasher;
}
/**
* {@inheritdoc}
*/
public function getUserEntityByUserCredentials($username, $password, $grantType, ClientEntityInterface $clientEntity)
{
$provider = config('auth.guards.api.provider');
if (is_null($model = config('auth.providers.'.$provider.'.model'))) {
throw new RuntimeException('Unable to determine authentication 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->getAuthPassword())) {
return;
}
return new User($user->getAuthIdentifier());
}
}
(1)重置验证username字段,如果密码不需要重置,则不用管一下代码;
由源码method_exists($model, 'findForPassport')
我们如果要重置,只需要在User模型中添加findForPassport
方法即可
默认验证email字段,如果你想验证phone
和email
一起验证;在User表中添加如下方法:
public function findForPassport($username)
{
return $this->orWhere('email', $username)->orWhere('phone', $username)->first();
}
(2)重置验证password字段,如果密码不需要重置,则不用管一下代码;
由上面源码method_exists($user, 'validateForPassportPasswordGrant')
我们可以知道,只需要在我们的User模型中添加validateForPassportPasswordGrant
方法就好了;代码如下
public function validateForPassportPasswordGrant($password)
{
//如果请求密码等于数据库密码 返回true(此为实例,根据自己需求更改)
if($password == $t