Eine Erklärung, wie man die Auth-Authentifizierung mit Passport in Laravel5.5 implementiert

Laravel5.3 hat begonnen, Passport als API-Autorisierung zu verwenden. Der folgende Artikel stellt Ihnen hauptsächlich die Methode zur Verwendung von Passport zur Implementierung der Auth-Authentifizierung in Laravel5.5 vor Code, Freunde in Not können sich darauf beziehen, schauen wir uns unten um.

Vorwort

Vor kurzem schreibe ich ein Front-End- und Back-End-Trennprojekt, das ich ursprünglich Jwt-auth + Dingo verwenden wollte um es zu entwickeln, aber es fühlt sich etwas umständlich an. Also dachte ich an Laravel's Passport und die neue API-Ressource in 5.5. Laravel Passport ist eine Reihe gekapselter OAuth2-Serverimplementierungen

OAuth ist ein offener Netzwerkstandard für die Autorisierung, der weltweit weit verbreitet ist. Die aktuelle Version ist Version 2.0.

OAuth 2.0 ist derzeit ein beliebter Ansatz und wurde zuerst von Google, Yahoo, Microsoft, Facebook usw. verwendet. Der Grund, warum es als 2.0 gekennzeichnet ist, liegt darin, dass es ursprünglich ein 1.0-Protokoll gab, dieses 1.0-Protokoll jedoch zu kompliziert und nicht einfach zu verwenden war, sodass es nicht populär gemacht wurde. 2.0 ist ein neues Design mit einem einfachen und klaren Protokoll, aber es ist nicht mit 1.0 kompatibel und hat nichts mit 1.0 zu tun.

Da ich hier nicht auf Details eingehen möchte, werfen wir zunächst einen Blick auf die Installation.

Installieren

Passport installieren

1. Führen Sie den folgenden Befehl in Ihrer Shell aus

composer require laravel/passport

Wenn die von Ihnen verwendete Laravel-Version niedriger als 5.5 ist, müssen Sie den folgenden Code manuell zum Provider-Array der Konfigurationsdatei hinzufügen. app.php-Datei

Laravel\Passport\PassportServiceProvider::class,

2. Führen Sie die Migrationsdatei aus

Führen Sie den folgenden Befehl in Ihrem aus Shell

php artisan migrate

Der Passport-Dienstanbieter verwendet das Framework, um sein eigenes Migrationsverzeichnis zu registrieren. Nach der Registrierung des Dienstes können Sie also direkt php artisan migrate ausführen, um das zu generieren Erforderliche Datentabellen für Passport

3. Verschlüsselungsschlüssel generieren

Führen Sie den folgenden Befehl in Ihrer Shell aus

php artisan passport:install

Dieser Befehl erstellt den Verschlüsselungsschlüssel, der zum Generieren eines sicheren Zugriffstokens erforderlich ist. Gleichzeitig erstellt dieser Befehl auch den „Persönlichen Zugriff“-Client und die „Passwortautorisierung“, die zum Generieren des Zugriffstokens verwendet werden.

4. Merkmal hinzufügen

LaravelPassportHasApiTokens-Merkmal zum AppUser-Modell hinzufügen

<?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. Route registrieren

Rufen Sie die Funktion Passport::routes in der Boot-Methode von AuthServiceProvider auf.

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

Wenn Ihr Programm eine Front-End- und Back-End-getrennte OAuth-Authentifizierung anstelle einer Multi-Plattform-Authentifizierung erfordert, können Sie diese in den Routern weitergeben ()-Methode Eine anonyme Funktion zum Anpassen der Route, die Sie registrieren müssen. Hier ist das Authentifizierungsformular, das das Front-End und das Back-End trennt. Daher muss ich nur einem meiner Front-End-Clients eine Auth-Authentifizierung bereitstellen Gleichzeitig habe ich die Route registriert, um das Token zu erhalten. Ein Präfixname wird dafür angepasst.

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

6. Ändern Sie den Watcher-Treiber

Autorisieren Sie die Konfigurationsdatei config/auth.php Die Treiberoption der Guards-API wird in Passport geändert. Durch diese Anpassung kann Ihre Anwendung den TokenGuard von Passport verwenden, wenn sie eingehende API-Anfragen überprüft. Was den im folgenden Dokument erwähnten Front-End-Teil betrifft, da ich ihn nur für die Auth-Authentifizierung verwenden muss und nicht die vollständige OAuth-Funktion implementieren muss. Wir müssen die Frontend-Seite überhaupt nicht verwenden.

Verwenden Sie

Um die Rückgabe von Daten durch die API zu vereinfachen, habe ich mehrere Funktionen gekapselt

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

Die Antwortfunktion kann dafür sorgen, dass grundlegende Rückgaben erfolgreich und fehlgeschlagen sind und in der Antwortfunktion neu gekapselt werden, um Anforderungserfolgs- und Anforderungsfehlerdaten zurückzugeben.

Dann müssen wir eine Proxy-Ebene verwenden.

Lassen Sie uns zunächst über den Grund für die Verwendung eines Proxys sprechen. Der Prozess der Passport-Authentifizierung besteht darin, dass die Slave-Anwendung das von der Hauptanwendung generierte Client-Token

und das eingegebene Kontokennwort verwendet Der Benutzer fordert den Passport der Hauptanwendungs-Token-Route an, um ein Zugriffstoken (Zugriffstoken) und ein Aktualisierungstoken (Aktualisierungstoken) zu erhalten, und verwendet dann das erhaltene Zugriffstoken, um auf die Route unter auth:api zuzugreifen. Wir haben jedoch keine untergeordnete Anwendung, die das Front-End vom Front-End trennt. Wenn Sie dieses Zugriffstoken vom Front-End abrufen möchten, müssen Sie das Client-Token in das Front-End schreiben sehr unvernünftig, daher können wir intern einen Proxy schreiben und die Anwendung selbst fordert den Zugriffstoken selbst an. Dies kann etwas verwirrend sein, aber der Anforderungsprozess ist wahrscheinlich wie folgt

1 . Das Frontend trägt das vom Benutzer eingegebene Kontopasswort.

2 Der Server erhält die Kontonummer und das Passwort vom Frontend, fügt Client_id und Client_token hinzu und fordert dann sein eigenes an Passport-Authentifizierungsroute mit diesen Parametern und kehrt dann nach der Authentifizierung zum Zugriffstoken und Aktualisierungstoken zurück

下面是代码实现,我在 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服务端环境搭建的图文教程

Das obige ist der detaillierte Inhalt vonEine Erklärung, wie man die Auth-Authentifizierung mit Passport in Laravel5.5 implementiert. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!