详解laravel安装使用Passportca88会员登录中心,5中接纳Passport完结Auth认证的措施

ca88会员登录中心

Laravel通过传统的登录表单已经让用户认证变得很简单,但是API怎么办?API通常使用token进行认证并且在请求之间不维护session状态。Laravel使用Laravel
Passport让API认证变得轻而易举,Passport基于Alex Bilbie维护的League
OAuth2 server,可以在数分钟内为Laravel应用提供完整的OAuth2服务器实现。

前言

也可以关注我的个人博客

 这里摘录下laravel5.5教程的认证文档,做个总结,方便今后查阅。

前言

中文文档

安装passport

使用 Composer 依赖包管理器安装 Passport :

composer require laravel/passport

接下来,将 Passport 的服务提供者注册到配置文件 config/app.php 的
providers 数组中:

Laravel\Passport\PassportServiceProvider::class,

Passport
使用服务提供者注册内部的数据库迁移脚本目录,所以上一步完成后,你需要更新你的数据库结构。Passport
的迁移脚本会自动创建应用程序需要的客户端数据表和令牌数据表:

php artisan migrate

如果你不打算使用 Passport 的默认迁移,你应该在 AppServiceProvider 的
register 方法中调用 Passport :: ignoreMigrations 方法。
你可以导出这个默认迁移用
php artisan vendor:publish --tag=passport-migrations命令。

接下来,你需要运行 passport:install
命令来创建生成安全访问令牌时用到的加密密钥,同时,这条命令也会创建「私人访问」客户端和「密码授权」客户端:

php artisan passport:install

上面命令执行后,请将 Laravel\Passport\HasApiTokens Trait 添加到
App\User 模型中,这个 Trait
会给你的模型提供一些辅助函数,用于检查已认证用户的令牌和使用作用域:

class User extends Authenticatable
{
    use HasApiTokens, Notifiable;
}

接下来,需要在 AuthServiceProvider 的 boot 方法中调用 Passport::routes
函数。这个函数会注册一些在访问令牌、客户端、私人访问令牌的发放和吊销过程中会用到的必要路由:

class AuthServiceProvider extends ServiceProvider
{

    /**
     * Register any authentication / authorization services.
     *
     * @return void
     */
    public function boot()
    {
        $this->registerPolicies();

        Passport::routes();
    }
}

最后,需要将配置文件 config/auth.php 中 api 部分的授权保护项( driver
)改为 passport 。此调整会让你的应用程序在接收到 API 的授权请求时使用
Passport 的 TokenGuard 来处理:

'guards' => [
    'web' => [
        'driver' => 'session',
        'provider' => 'users',
    ],

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

到此为止,基本的设置已经完成,接下来救来用passport开始认证吧。

最近在写一个前后端分离项目,本来想用 Jwt-auth + Dingo
开发的,但是略感笨重,于是想到了 Laravel 的 Passport 和 5.5 新出的 Api
Resource。Laravel Passport 是一套已经封装好的 OAuth2 服务端实现

使用passport

OAuth是一个关于授权(authorization)的开放网络标准,在全世界得到广泛应用,目前的版本是2.0版。

安装

发放访问令牌

OAuth 2.0 是目前比较流行的做法,它率先被Google, Yahoo, Microsoft,
Facebook等使用。之所以标注为
2.0,是因为最初有一个1.0协议,但这个1.0协议被弄得太复杂,易用性差,所以没有得到普及。2.0是一个新的设计,协议简单清晰,但它并不兼容1.0,可以说与1.0没什么关系。

composer require laravel/passport

管理客户端

首先,接入应用如果想要与你应用的 API
进行交互,必须先在你的应用程序中注册一个「客户端」。一般来说,这个注册过程需要开发者提供两部分信息:接入应用名称和用户授权后的跳转链接。

命令 passport:client#

创建客户端最简单的方式是使用 Artisan 命令 passport:client
,你可以使用此命令创建自己的客户端,用于测试 OAuth2 的功能。在你执行
client 命令时,Passport
会提示输入更多关于你的客户端的信息,最终会提供给你生成的客户端的 ID 和
密钥:

php artisan passport:client

执行完成之后会生成 client ID 和client secret;

这些都是你的本地环境生成的,别人如果想使用的话还需要接下来的步骤;

JSON API

考虑到你的用户们并没有办法使用 client 命令,Passport
同时提供了用户创建客户端的 JSON API
。这样你就不用再花时间编码来实现客户端创建、更新和删除的相关控制器逻辑了。

然而,你仍旧需要基于 Passport 的 JSON API
开发一套前端界面,方便你的用户管理他们授权的客户端。下面我们会列出所有用于管理客户端的
API,方便起见,我们使用 Axios 展示对 API 的 HTTP 请求。

GET /oauth/clients#

此接口会返回当前认证用户的所有客户端。主要用途是列出当前用户所有客户端,方便用户修改或删除:

axios.get('/oauth/clients')
    .then(response => {
        console.log(response.data);
    });

POST /oauth/clients#

此接口用于用户创建新的客户端。它需要两部分数据:客户端的名称、客户端的
redirect 链接。当用户允许或拒绝授权请求后,用户都会被重定向到这个
redirect 链接。

当客户端创建完成后,会生成此客户端的 ID
和密钥,客户端可以使用这两个值从你的应用程序请求访问令牌。此接口会返回新建客户端实例的信息:

const data = {
    name: 'Client Name',
    redirect: 'http://example.com/callback'
};

axios.post('/oauth/clients', data)
    .then(response => {
        console.log(response.data);
    })
    .catch (response => {
        // List errors on response...
    });

PUT /oauth/clients/{client-id}#

此接口用于更新客户端信息。它需要两部分数据:客户端的 name 和 redirect
链接。当用户允许或拒绝授权请求后,用户都会被重定向到这个 redirect
链接。此接口会返回被更新客户端实例的信息:

const data = {
    name: 'New Client Name',
    redirect: 'http://example.com/callback'
};

axios.put('/oauth/clients/' + clientId, data)
    .then(response => {
        console.log(response.data);
    })
    .catch (response => {
        // List errors on response...
    });

DELETE /oauth/clients/{client-id}#

此接口用于删除客户端:

axios.delete('/oauth/clients/' + clientId)
    .then(response => {
        //
    });

所以这里就不细说了,先来看看怎么安装它吧。

接下来,在配置文件 config/app.php 的providers 数组中注册 Passport
服务提供者:

1.授权码方式获取token

添加一个路由到你的项目中:

Route::get('/redirect', function () {
    $query = http_build_query([
        'client_id' => 'client-id',
        'redirect_uri' => 'http://example.com/callback',
        'response_type' => 'code',
        'scope' => '',
    ]);

    return redirect('http://your-app.com/oauth/authorize?'.$query);
});

这里的路由可以随便定义,不一定非要是redirect

接下来定义callback的路由:

Route::get('/callback', function (Request $request) {
   $http = new GuzzleHttp\Client;

   $response = $http->post('http://your-app.com/oauth/token', [
       'form_params' => [
           'grant_type' => 'authorization_code',
           'client_id' => 'client-id',
           'client_secret' => 'client-secret',
           'redirect_uri' => 'http://example.com/callback',
           'code' => $request->code,
       ],
   ]);

   return json_decode((string) $response->getBody(), true);
});

这里的redirect_uri必须和上诉的保持一致。

安装

Laravel\Passport\PassportServiceProvider::class,

2.密码方式获取token

创建密码授权客户端

如果想要通过密码授权机制来发布令牌,首先你需要创建一个密码授权客户端。你可以使用带有
–password 参数的 passport:client 命令。如果你已经运行了
passport:install 命令,那无需再单独运行此命令:

php artisan passport:client --password

当你创建密码授权客户端后,你可以向 /oauth/token 接口发起 POST
请求来获取访问令牌,请求时需要带有用户的邮箱地址和密码信息。注意,该接口已经在
Passport::routes
方法中定义,所以无需再次手动定义。请求成功后,服务端返回的 JSON
响应数据中会带有 access_token 和 refresh_token 属性:

$http = new GuzzleHttp\Client;

$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' => '',
   ],
]);

return json_decode((string) $response->getBody(), true);

安装 Passport

Passport 迁移将会为应用生成用于存放客户端和访问令牌的数据表
(迁移文件位置/vendor/laravel/passport/database)

3.简化授权令牌

简化授权和通过授权码授权相似; 区别是,
不需要通过授权码去获取令牌而是把令牌直接返回客户端.
主要用在无法安全存储证书场景中,这种授权在 JavaScript 和 移动应用
是最常用的. 开启授权, 在 AuthServiceProvider 中调用 enableImplicitGrant
方法:

/**
 * Register any authentication / authorization services.
 *
 * @return void
 */
public function boot() 
{
    $this->registerPolicies();

    Passport::routes();

    Passport::enableImplicitGrant();
}

调用上面方法开启授权后, 开发者可以通过自己的应用把 client ID
当做参数去请求一个令牌。在你的应用程序 /oauth/authorize
的接口中应该有一个重定向请求像下面这样:

Route::get('/redirect', function () {
    $query = http_build_query([
        'client_id' => 'client-id',
        'redirect_uri' => 'http://example.com/callback',
        'response_type' => 'token',
        'scope' => '',
    ]);

    return redirect('http://your-app.com/oauth/authorize?'.$query);
});

1.在你的 Shell 中执行以下命令

php artisan migrate

4.客户端证书授权令牌

这是不需要登录直接可以获取token的方式,用于机器与机器之前(app与服务端之间)

要使用这种授权,你首先需要在 app/Http/Kernel.php 的 $routeMiddleware
变量中添加新的中间件:

use Laravel\Passport\Http\Middleware\CheckClientCredentials::class;

protected $routeMiddleware = [
    'client' => CheckClientCredentials::class,
];

然后将这个中间件附加到路由中:

Route::get('/user', function(Request $request) {
   ...
})->middleware('client');

实际开发中不可能给每个路由都这么分配,我们可以在跟控制器中添加中间件:

    function __construct()
   {
       $this->middleware('client');
   }

要获取令牌,向 oauth/token 接口发出请求:

Route::get('/get_token',function(){
        $http = new GuzzleHttp\Client;

       $response = $http->post(env('AUTH_HOST') . '/oauth/token', [
           'form_params' => [
               'grant_type' => 'client_credentials',
               'client_id' => '6',
               'client_secret' => 'CfERioCd1lJcoKOiXGb5dXbkzXdB7VHnSMBCs3X6',
               'scope' => '',
           ],

//    以json的格式返回报错信息
           'http_errors' => false // add this to return errors in json
       ]);

       return json_decode((string) $response->getBody(), true);

})

还有一个私人令牌这里没有写,有兴趣的同学可以直接访问laravel5.5的文档,
做个总结,方便今后查阅。

composer require laravel/passport

创建生成安全访问令牌时用到的加密密钥及私人访问和密码访问客户端。

如果你使用的 Laravel 版本是 5.5 以下,你需要手动在 config/app.php 文件
providers 数组中加入如下代码

php artisan passport:install
Laravel\Passport\PassportServiceProvider::class,

Trait 添加到 App\User 模型中,这个 Trait
会给这个模型提供一些辅助函数,用于检查已认证用户的令牌和使用作用于。

2.运行迁移文件

Laravel\Passport\HasApiTokens

在你的 Shell 中执行如下命令

ca88会员登录中心 1

php artisan migrate

然后在 AuthServiceProvider 的 boot 方法中添加 Passport::roues();

Passport
服务提供器使用框架注册自己的迁移目录,因此在注册服务后,你可以直接运行
php artisan migrate 来为 Passport 生成所需的数据表

ca88会员登录中心 2

3.生成加密密钥

最后,修改文件 config/auth.php 中 api 部分的授权保护项( driver )改为
passport 。此调整会让你的应用程序在接收到 API 的授权请求时使用 Passport
的 TokenGuard 来处理

在你的 Shell 中执行如下命令

'guards' => [
    'web' => [
      'driver' => 'session',
      'provider' => 'users',
    ],

    'api' => [
      'driver' => 'passport',
      'provider' => 'users',
    ],
  ],
php artisan passport:install

增加测试路由

此命令会创建生成安全访问令牌时所需的加密密钥,同时,这条命令也会创建用于生成访问令牌的「个人访问」客户端和「密码授权」。

Route::group(['namespace' => 'api'], function () {
  Route::post('/login', 'UserController@login');
});
Route::group(['middleware' => 'auth:api', 'namespace' => 'api'], function() {
  Route::get('V1/test/passport', 'UserController@passport');
});

4.添加 Trait

增加控制器

将 LaravelPassportHasApiTokens Trait 添加到 AppUser 模型中

php artisen make:controller UserController


<?php

namespace App\Http\Controllers\Api;

use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
use Auth;

class UserController extends Controller
{
  public function __construct()
  {
    $this->content = array();
  }
  public function login()
  {
    // dd(request('name'));
    if(Auth::attempt(['name' => request('name'), 'password' => request('password')]))
    {
      $user = Auth::user();
      $this->content['token'] = $user->createToken('Pi App')->accessToken;
      $status = 200;
    } else {

      $this->content['error'] = "未授权";
       $status = 401;
    }
     return response()->json($this->content, $status);
  }
  public function passport()
  {
    return response()->json(['user' => Auth::user()]);
  }
}
<?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;
}

通过postman进行简单测试获取token

5.注册路由

ca88会员登录中心 3

在 AuthServiceProvider 的 boot 方法中调用 Passport::routes 函数。

ca88会员登录中心 4

class AuthServiceProvider extends ServiceProvider
{
 public function boot()
 {
  $this->registerPolicies();
  Passport::routes();
 }
}

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

如果你的程序是需要前后端分离形式的OAuth认证而不是多平台认证那么你可以在routers()方法中传递一个匿名函数来自定定义自己需要注册的路由,我这里是前后端分离的认证形式,因此我只需要对我的前端一个Client提供Auth的认证,所以我只注册了获取Token的路由,同时我还为它自定义了前缀名。

您可能感兴趣的文章:

  • 基于laravel制作APP接口(API)
  • 详解Laravel5.6
    Passport实现Api接口认证
  • 基于Laravel
    Auth自定义接口API用户认证的实现方法
  • 让Laravel
    API永远返回JSON格式响应的方法示例
Passport::routes(function(RouteRegistrar $router) {
 $router->forAccessTokens();
},['prefix' => 'api/oauth']);

6.更改看守器驱动

将配置文件 config/auth.php 中授权看守器 guards 的 api 的 driver 选项改为
passport。此调整会让你的应用程序在在验证传入的 API 的请求时使用 Passport
的 TokenGuard 来处理

'guards' => [
 'web' => [
  'driver' => 'session',
  'provider' => 'users',
 ],
 'api' => [
  'driver' => 'passport',
  'provider' => 'users',
 ],
],

至此 Passport
已经安装完成,剩下的文档里所讲到的前端部分的话,由于我是只需要使用它做
Auth 的认证,并不需要实现完整的 OAuth
功能,所以我们完全可以不使用前端页面。

使用

为了 Api 返回数据方便,我封装了几个函数

function respond($status, $respond)
{
 return response()->json(['status' => $status, is_string($respond) ? 'message' : 'data' => $respond]);
}
function succeed($respond = 'Request success!')
{
 return respond(true, $respond);
}
function failed($respond = 'Request failed!')
{
 return respond(false, $respond);
}

respond 函数可以做基本返回,succeed 和 failed 是在 respond
函数上做的再次封装,用以返回请求成功和请求失败数据。

然后我们需要使用一层代理。

先说一下使用代理的原因,Passport 认证的流程是 从属应用带着 主应用

生成的 Client Token 和 用户输入的账号密码去请求主应用的 Passport Token
路由,以获得 access token (访问令牌) 和 refresh token
(刷新令牌),然后带着得到的 access token 就可以访问 auth:api
下的路由了。但是我们并没有从属应用,是由前后端分离的前端来请求这个token,如果从前端想来拉取这个
access token 就需要把 Client token
写死在前端里,这样是很不合理的,所以我们可以在内部写一个代理,由应用自身带着
Client token 去请求自身以获取 access
token,这样说可能有一点绕,大概请求过程是下面这个样子

1.前端带着用户输入的账号密码请求服务端

2.服务端带着从前端接收到账号与密码,并在其中添加 Client_id 与
Client_token,然后带着这些参数请求自身的 Passport
认证路由,然后返回认证后的 Access token 与 refresh token

下面是代码实现,我在 AppHttpControllersTraits 下新建了一个 ProxyHelpers

Trait,当然,这个函数是我根据我的业务逻辑自己封装的,如果不适合你的业务逻辑你可以自行调整。

<?php

namespace App\Http\Controllers\Traits;

use GuzzleHttp\Client;
use App\Exceptions\UnauthorizedException;
use GuzzleHttp\Exception\RequestException;

trait ProxyHelpers
{
 public function authenticate()
 {
  $client = new Client();
  try {
   $url = request()->root() . '/api/oauth/token';
   $params = array_merge(config('passport.proxy'), [
    'username' => request('email'),
    'password' => request('password'),
   ]);
   $respond = $client->request('POST', $url, ['form_params' => $params]);
  } catch (RequestException $exception) {
   throw new UnauthorizedException('请求失败,服务器错误');
  }
  if ($respond->getStatusCode() !== 401) {
   return json_decode($respond->getBody()->getContents(), true);
  }
  throw new UnauthorizedException('账号或密码错误');
 }
}

config/passport.php 内容如下

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

env 文件内容如下

OAUTH_GRANT_TYPE=password
OAUTH_CLIENT_ID=2
OAUTH_CLIENT_SECRET=2HaTQJF33Sx98HjcKDiSVWZjrhVYGgkHGP8XLG1O
OAUTH_SCOPE=*

我们需要用到的 client token 是 id 为 2 的 client token,不要搞错了哟~

然后我们只需要在控制器中 use 这个 Trait,然后调用
$this->authenticate()就可以得到认证成功的
token,如果请求失败的话,你可以使用 catch 来捕捉错误抛出异常。

 public function login(Request $request)
{
  $needs = $this->validate($request, rules('login'));
  $user = User::where('email', $needs['email'])->first();

  if (!$user) {
   throw new UnauthorizedException('此用户不存在');
  }
  $tokens = $this->authenticate();
  return succeed(['token' => $tokens, 'user' => new UserResource($user)]);
}

得到的 tokens 返回如以下格式

{
 "token_type": "Bearer",
 "expires_in": 31536000,
 "access_token": "token_str",
 "refresh_token": "token_str"
}

做完这一切后你就可以在前端向这样子请求服务端了

axios.post('yourdomain/login',login_form).then(resource => { 
})

如果请求成功,那么你将会得到 用户的信息和 access token,refresh token。

然后在你的前端 http 请求 header 里需要加入一个参数 Authorization

axios.defaults.headers.common['Authorization'] = token.token_type + ' ' + token.access_token

然后在你需要使用到 auth 认证的路由里使用中间件
auth:api,一切就大功告成啦~

总结

ca88会员登录中心,以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对脚本之家的支持。

您可能感兴趣的文章:

  • Laravel
    5框架学习之用户认证
  • Laravel实现用户多字段认证的解决方法
  • 通过修改Laravel
    Auth使用salt和password进行认证用户详解
  • Laravel多用户认证系统示例详解
  • 基于Laravel
    Auth自定义接口API用户认证的实现方法
  • Laravel认证原理以及完全自定义认证详解

发表评论

电子邮件地址不会被公开。 必填项已用*标注

网站地图xml地图