Behandeln Sie die API-Authentifizierung mit Laravel Passport

Der PHP-Editor führt Sie durch die Verwendung von Laravel Passport für die API-Authentifizierung. Laravel Passport ist eine vollständige OAuth2-Serverimplementierung, die Entwicklern bei der einfachen Implementierung der API-Authentifizierung helfen kann und viele praktische Funktionen bietet. In diesem Artikel erfahren Sie, wie Sie mit Laravel Passport die API-Benutzerauthentifizierung verwalten und die Sicherheit der API-Schnittstelle gewährleisten.

Schritt 1. Laravel installieren

Wir müssen den folgenden Befehl verwenden, um eine aktuelle Laravel-Anwendung zu erstellen, also öffnen Sie bitte das Terminal und führen Sie aus:

laravel new auth

Schritt 2. Laravel Passport-Paket installieren

Laravel Passport kann in a verwendet werden Ein paar Minuten. Ihre Anwendung implementiert einen vollständigen OAuth2-Server.

composer require laravel/passport

Schritt 3. Führen Sie DatabaseMigration

Passport Migration aus. Dadurch werden die Tabellen erstellt, die von Ihrer Anwendung zum Speichern von Clients und Zugriffstokens verwendet werden.

PHP artisan migrate

Schritt 4. Geheimen Schlüssel generieren

Dieser Befehl erstellt einen geheimen Schlüssel, um ein sicheres Zugriffstoken zu generieren. Darüber hinaus werden auch ein persönlicher Zugang und ein PassWord Grant erstellt, die zum Generieren des Zugriffstokens verwendet werden:

php artisan passport:install

Fügen Sie nach der Ausführung LaravelPassportHasApiTokens trLaravelPassportHasApiTokens trait 添加到你的 AppUser 模型中。这个 trait 会为模型添加一系列助手函数用来验证用户的秘钥和作用域：

第五步 . Passport 配置

<?php

namespace App;

use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Laravel\Passport\HasApiTokens;

class User extends Authenticatable
{
    use Notifiable, HasApiTokens;
}

接下来，你应该在 AuthServiceProvider 中的 boot 方法中调用 Passport::routes 方法。这个方法会注册必要的路由去颁发访问令牌，撤销访问令牌，客户端和个人令牌：

<?php

namespace App\Providers;

use Laravel\Passport\Passport;
use Illuminate\Support\Facades\Gate;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;

class AuthServiceProvider extends ServiceProvider
{
    
    protected $policies = [
        &#39;App\Model&#39; => &#39;App\Policies\ModelPolicy&#39;,
    ];

    
    public function boot()
    {
        $this->reGISterPolicies();

        Passport::routes();
    }
}

最后，在 config/auth.php 配置文件中，你应该设置 api 权限认证守卫的 driver 选项为 passport。当需要权限认证的 API 请求进来时会告诉你的应用去使用 Passport's 的 TokenGuard。

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

第六步. 添加 API 路由

Laravel 提供了 routes/api.php 文件来给我们编写 web 路由，因此在这个文件添加新的路由即可。

<?php

use Illuminate\Http\Request;

Route::group([
    &#39;prefix&#39; => &#39;auth&#39;
], function () {
    Route::post(&#39;login&#39;, &#39;AuthController@login&#39;);
    Route::post(&#39;signup&#39;, &#39;AuthController@signup&#39;);

    Route::group([
      &#39;middleware&#39; => &#39;auth:api&#39;
    ], function() {
        Route::get(&#39;loGout&#39;, &#39;AuthController@logout&#39;);
        Route::get(&#39;user&#39;, &#39;AuthController@user&#39;);
    });
});

第七步: 创建控制器

最后一步我们必须创建新的控制器和 api 方法。因此我们先创建 AuthControllerai

t in Ihren ein AppUser-Modell. Diese Eigenschaft fügt dem Modell eine Reihe von Hilfsfunktionen hinzu, um den geheimen Schlüssel und Umfang des Benutzers zu überprüfen:

Schritt 5. Passport-Konfiguration

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Carbon\Carbon;
use App\User;

class AuthController extends Controller
{
    
    public function signup(Request $request)
    {
        $request->validate([
            &#39;name&#39; => &#39;required|string&#39;,
            &#39;email&#39; => &#39;required|string|email|unique:users&#39;,
            &#39;password&#39; => &#39;required|string|confirmed&#39;
        ]);

        $user = new User([
            &#39;name&#39; => $request->name,
            &#39;email&#39; => $request->email,
            &#39;password&#39; => bcrypt($request->password)
        ]);

        $user->save();

        return response()->JSON([
            &#39;message&#39; => &#39;Successfully created user!&#39;
        ], 201);
    }

    
    public function login(Request $request)
    {
        $request->validate([
            &#39;email&#39; => &#39;required|string|email&#39;,
            &#39;password&#39; => &#39;required|string&#39;,
            &#39;remember_me&#39; => &#39;boolean&#39;
        ]);

        $credentials = request([&#39;email&#39;, &#39;password&#39;]);

        if(!Auth::attempt($credentials))
            return response()->json([
                &#39;message&#39; => &#39;Unauthorized&#39;
            ], 401);

        $user = $request->user();

        $tokenResult = $user->createToken(&#39;Personal Access Token&#39;);
        $token = $tokenResult->token;

        if ($request->remember_me)
            $token->expires_at = Carbon::now()->addWeeks(1);

        $token->save();

        return response()->json([
            &#39;access_token&#39; => $tokenResult->accessToken,
            &#39;token_type&#39; => &#39;Bearer&#39;,
            &#39;expires_at&#39; => Carbon::parse(
                $tokenResult->token->expires_at
            )->toDateTimeString()
        ]);
    }

    
    public function logout(Request $request)
    {
        $request->user()->token()->revoke();

        return response()->json([
            &#39;message&#39; => &#39;Successfully logged out&#39;
        ]);
    }

    
    public function user(Request $request)
    {
        return response()->json($request->user());
    }
}

Als nächstes sollten Sie in <code>AuthServiceProvider Der Passport::routes-Methode wird in der >boot-Methode aufgerufen. Diese Methode registriert die notwendigen Routen zum Ausstellen von Zugriffstokens, zum Widerrufen von Zugriffstokens, Client- und persönlichen Tokens:

---

php artisan serve

Schließlich sollten Sie in der Konfigurationsdatei config/auth.php den festlegen Die Treiberoption des Berechtigungsauthentifizierungsschutzes api ist passport. Wenn eine API-Anfrage eingeht, die eine Berechtigungsauthentifizierung erfordert, wird Ihre Anwendung angewiesen, den TokenGuard von Passport zu verwenden.

Content-Type: application/json
X-Requested-With: XMLHttpRequest

Schritt 6. API-Routing hinzufügen

Laravel stellt die Datei routes/api.php zur Verfügung, damit wir Webrouten schreiben können. Fügen Sie dieser Datei also einfach eine neue Route hinzu. rrreeeSchritt 7: Controller erstellen

Im letzten Schritt müssen wir neue Controller und API-Methoden erstellen. Also erstellen wir zuerst AuthController und fügen darin den Code ein:

rrreee

Jetzt sind wir bereit, unser Beispiel auszuführen. Führen Sie den folgenden Befehl aus, um es schnell auszuführen:

rrreee

Test

Jetzt können wir REST-Client-Tools verwenden, um das Testen zu vereinfachen, z. B. Postman. Ich habe den Test durchgeführt und Sie können den Screenshot unten sehen.

Sie müssen die folgenden zwei Header-Informationen für diese API festlegen:

rrreee

Registrieren

Anmelden

---

Abmelden

• Benutzer

Danke zum Lesen !

🎜🎜Ressourcen🎜🎜🎜🎜GitHub🎜🎜🎜🎜Postman-Sammlungen🎜🎜🎜

Das obige ist der detaillierte Inhalt vonBehandeln Sie die API-Authentifizierung mit Laravel Passport. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!