Laravel5.5でAuth認証を実装するためにPassportを使用する方法の説明

Laravel5.3 API認可としてPassportを使い始める. PassportはOAuth2をベースとしています. 以下の記事では主に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 のインストール

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

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 関数を呼び出します。

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

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

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 を追加して、そのアカウント パスワードをリクエストします。これらのパラメータを使用した独自のパスポート認証ルート、および認証後に返されるアクセス トークンとリフレッシュ トークン

下面是代码实现,我在 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中你可能忽略的性能优化利器：生成器的相关内容

Laravel框架中composer自动加载的实现详解

PHP服务端环境搭建的图文教程

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