Laravel5.5でPassportを使用してAuth認証を実装する

この記事では主に、Laravel5.5 で Auth 認証を実装するための Passport の使用法を紹介します。これには、必要な友人と共有します。

Laravel5.3 を入手します。 API 認証として Passport を使用します。以下の記事では、Passport を使用して Laravel5.5 で Auth 認証を実装する方法をサンプルコードを通じて詳しく紹介します。以下を参照してください。

まえがき

最近、私はフロントエンドとバックエンドの分離プロジェクトを書いています。当初は Jwt-auth Dingo を使用したいと考えていました。開発してみましたが、少し面倒に感じたので、Laravel の Passport と 5.5 の新しい API リソースが頭に浮かびました。 Laravel Passport は、カプセル化された OAuth2 サーバー実装のセットです。

OAuth は、認証のためのオープン ネットワーク標準であり、現在のバージョンはバージョン 2.0 です。

OAuth 2.0 は現在一般的なアプローチであり、Google、Yahoo、Microsoft、Facebook などが最初に使用しました。なぜ 2.0 とマークされているかというと、もともと 1.0 プロトコルがあったのですが、この 1.0 プロトコルは作りが複雑すぎて使いにくく、普及しなかったからです。 2.0 はシンプルで明確なプロトコルを備えた新しい設計ですが、1.0 とは互換性がなく、1.0 とは何の関係もありません。

ということで、ここでは詳しくは説明しませんが、まずはインストール方法を見てみましょう。

#インストール

Passport をインストールします

#

composer require laravel/passport

使用している Laravel バージョンが 5.5 より前の場合は、次のコードを config/ のプロバイダー配列に手動で追加する必要があります。 app.php ファイル

Laravel\Passport\PassportServiceProvider::class,

2. 移行ファイルを実行します

Shell

php artisan migrate

Passport サービス プロバイダーは、フレームワークを使用して独自の移行ディレクトリを登録するため、サービスの登録後、phpArtisan 移行を直接実行して、パスポートに必要なデータ テーブル

3. 暗号化キーを生成します

シェルで次のコマンドを実行します

php artisan passport:install

このコマンドは、安全なアクセス トークンの生成に必要な暗号化キーを作成します。同時に、このコマンドは、アクセス トークンの生成に使用される「個人アクセス」クライアントと「パスワード認証」も作成します。

4. 特性の追加

LaravelPassportHasApiTokens 特性を AppUser モデルに追加します

<?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;
}

5. ルートを登録します

AuthServiceProvider のブート メソッドで Passport::routes 関数を呼び出します。

<pre class="brush:php;toolbar:false">class AuthServiceProvider extends ServiceProvider { public function boot() { $this-&gt;registerPolicies(); Passport::routes(); } }</pre>

プログラムで、マルチプラットフォーム認証ではなく、フロントエンドとバックエンドの分離の形で OAuth 認証が必要な場合は、次のことができます。これを routers() メソッドに渡します。登録する必要があるルートをカスタマイズするための匿名関数です。フロントエンドとバックエンドを分離する認証フォームは次のとおりです。したがって、フロントエンドの 1 つに認証認証を提供するだけで済みます。クライアントなので、トークンを取得するためのルートを登録するだけで、同時にプレフィックス名もカスタマイズされます。

Passport::routes(function(RouteRegistrar $router) {
 $router->forAccessTokens();
},['prefix' => 'api/oauth']);

6. ガード ドライバーを変更します。

設定ファイル config/auth.php を承認します。 Guards API のドライバー オプションがパスポートに変更されました。この調整により、アプリケーションは受信 API リクエストを検証するときに Passport の TokenGuard を使用できるようになります。

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

この時点で、Passport はインストールされており、残りの部分はインストールされています。次のドキュメントで説明されているフロントエンド部分は、Auth 認証にのみ使用する必要があり、完全な OAuth 機能を実装する必要がないため、フロントエンド ページを使用する必要はまったくありません。

Use

データを返す 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);
}

応答関数は、基本的な戻り値を応答関数上で再カプセル化して、要求の成功と要求の失敗のデータを返すことができます。

次に、プロキシ層を使用する必要があります。

まず、プロキシを使用する理由について説明します。パスポート認証のプロセスでは、スレーブ アプリケーションがメイン アプリケーションによって生成されたクライアント トークンと、入力されたアカウント パスワードを取得します。ユーザーがメイン アプリケーションのパスポートを要求してアクセス トークン (アクセス トークン) とリフレッシュ トークン (リフレッシュ トークン) を取得し、取得したアクセス トークンを使用して auth:api のルートにアクセスします。ただし、フロントエンドとバックエンドを分離するフロントエンドがありません。このアクセストークンをフロントエンドから取得したい場合は、フロントエンドにクライアントトークンを書き込む必要があります。これは非常に不合理なので、内部でプロキシを作成し、アプリケーション自体がクライアント トークンを取得してアクセス トークンを取得するように要求することができます。これは少し混乱するかもしれませんが、要求プロセスはおそらく次のとおりです。

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() . &#39;/api/oauth/token&#39;;
   $params = array_merge(config(&#39;passport.proxy&#39;), [
    &#39;username&#39; => request(&#39;email&#39;),
    &#39;password&#39; => request(&#39;password&#39;),
   ]);
   $respond = $client->request(&#39;POST&#39;, $url, [&#39;form_params&#39; => $params]);
  } catch (RequestException $exception) {
   throw new UnauthorizedException(&#39;请求失败，服务器错误&#39;);
  }
  if ($respond->getStatusCode() !== 401) {
   return json_decode($respond->getBody()->getContents(), true);
  }
  throw new UnauthorizedException(&#39;账号或密码错误&#39;);
 }
}

config/passport.php 内容如下

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

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，一切就大功告成啦～

以上就是本文的全部内容，希望对大家的学习有所帮助，更多相关内容请关注PHP中文网！

相关推荐：

Laravel5.2使用Captcha生成验证码实现登录的方法

关于Laravel中日期时间处理包Carbon的使用

关于laravel 5.1下php artisan migrate的使用

以上がLaravel5.5でPassportを使用してAuth認証を実装するの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。