Implementierung und Test der Socialite-Authentifizierung in Laravel

Laravel Socialite ist ein Laravel-Erstanbieterpaket, das Entwickler bei der Implementierung der sozialen OAuth- und OAuth2-Authentifizierung in ihren Anwendungen unterstützt. Es verfügt über integrierte Unterstützung für Facebook, Twitter, Google, LinkedIn, GitHub, GitLab und Bitbucket. Socialite kann andere Anbieter durch Community-Pakete unterstützen.

Dieser Beitrag wird:

• Erklären Sie, was Socialite tut und was nicht.
• Zeigen Sie, wie Sie die Google-Authentifizierung über Socialite in ein neues Laravel-Projekt integrieren.
• Zeigen Sie ein Beispiel für den Test von Socialite.

TLDR:Sie können das abgeschlossene Projekt auf meinem GitHub ansehen. Werfen Sie einen Blick darauf, wenn Sie lieber nur den fertigen Code lesen möchten.

Was macht Laravel Socialite und was nicht?

Socialite ist ein kleines Paket, dessen Haupt-API hauptsächlich aus zwei Hauptmethoden besteht:

• Socialite::driver($authProvider)->redirect() leitet den Benutzer zum angegebenen Authentifizierungsanbieter weiter und übergibt alle erforderlichen Informationen über URL-Parameter an den Anbieter.
• Socialite::driver($authProvider)->user() ruft vom Authentifizierungsanbieter zurückgegebene Benutzerdaten ab und stellt sie dem Endpunkt zur Verfügung.

Es gibt zusätzliche Unterstützungsmethoden für Einstellungsbereiche und optionale Parameter. Sie können darüber in der Socialite-Dokumentation nachlesen.

Socialite macht nicht Folgendes:es überlässt die Implementierung dieser Funktionen dem Entwickler:

• ❌ Erstellen Sie Datenbanktabellen oder -spalten, die zum Speichern von Social-Authentifizierungsdaten erforderlich sind.
• ❌ Erstellen Sie Benutzer, die während des Authentifizierungsprozesses nicht vorhanden sind.
• ❌ Authentifizieren Sie den Benutzer nach einem erfolgreichen OAuth-Flow.
• ❌ OAuth-Tokens aktualisieren.

Voraussetzungen: Erstellen eines Google Cloud-Projekts

Wir werden ein kleines Socialite-Projekt aufsetzen, das es dem Benutzer ermöglicht, sich über Google zu authentifizieren. Dazu müssen Sie eine Google-App erstellen.

Erstellen Sie zunächst ein neues Google Cloud-Projekt und konfigurieren Sie dann einen OAuth-Zustimmungsbildschirm für das Projekt. Setzen Sie den Benutzertyp auf extern und aktivieren Sie dann die folgenden Bereiche:

• .../auth/userinfo.email
• .../auth/userinfo.profile

Nachdem Sie den Zustimmungsbildschirm konfiguriert haben, erstellen Sie eine OAuth 2.0-Client-ID, indem Sie die Seite mit den Google Cloud-Anmeldeinformationen besuchen. Bewahren Sie die Client-ID und das Client-Geheimnis auf: Wir werden sie später im Projekt verwenden.

Einrichten eines minimalen Laravel-Projekts mit Socialite

Erstellen Sie ein neues Laravel-Projekt:

laravel new socialite-tests

Wählen Sie im Installationsprogramm die folgenden Optionen aus:

 ┌ Would you like to install a starter kit? ────────────────────┐
 │ No starter kit                                               │
 └──────────────────────────────────────────────────────────────┘

 ┌ Which testing framework do you prefer? ──────────────────────┐
 │ Pest                                                         │
 └──────────────────────────────────────────────────────────────┘

 ┌ Which database will your application use? ───────────────────┐
 │ SQLite                                                       │
 └──────────────────────────────────────────────────────────────┘

 ┌ Would you like to run the default database migrations? ──────┐
 │ Yes                                                          │
 └──────────────────────────────────────────────────────────────┘

Wechseln Sie in das Projektverzeichnis und installieren Sie Socialite.

laravel new socialite-tests

Erstellen Sie eine neue Migration.

 ┌ Would you like to install a starter kit? ────────────────────┐
 │ No starter kit                                               │
 └──────────────────────────────────────────────────────────────┘

 ┌ Which testing framework do you prefer? ──────────────────────┐
 │ Pest                                                         │
 └──────────────────────────────────────────────────────────────┘

 ┌ Which database will your application use? ───────────────────┐
 │ SQLite                                                       │
 └──────────────────────────────────────────────────────────────┘

 ┌ Would you like to run the default database migrations? ──────┐
 │ Yes                                                          │
 └──────────────────────────────────────────────────────────────┘

Fügen Sie den folgenden Code in die neu erstellte Migrationsdatei in Datenbank/Migrationen ein:

cd socialite-tests
composer require laravel/socialite

Diese Migration fügt Felder hinzu, die von Socialite bereitgestellt werden, wenn sich der Benutzer erfolgreich authentifiziert. In unserer Implementierung fügen wir diese Felder der Einfachheit halber direkt zur Benutzertabelle hinzu. Wenn Sie mehr Anbieter als Google unterstützen möchten, möchten Sie möglicherweise eine separate Tabelle erstellen, in der mehrere Anbieter pro Benutzer gespeichert werden können.

Wir legen das Passwort so fest, dass es nullbar sein kann, da ein Benutzer niemals ein Passwort festlegen wird, wenn er sich nur über Google authentifiziert. Wenn Ihre App soziale Authentifizierung und Passwortauthentifizierung zulässt, müssen Sie bestätigen, dass das Passwort nicht leer oder null ist, wenn ein Benutzer versucht, sich über ein Passwort anzumelden.

Führen Sie die Migration aus.

php artisan make:migration add_socialite_fields_to_users

Fügen Sie in config/services.php den folgenden Codeblock am Ende des Services-Arrays hinzu. Eine vollständige Liste der gültigen Socialite-Dienstnamen finden Sie in den Konfigurationsdokumenten.

<?php
// database/migrations/2024_12_31_075619_add_socialite_fields_to_users.php

use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;

return new class extends Migration
{
    /**
     * Run the migrations.
     */
    public function up(): void
    {
        Schema::table('users', function (Blueprint $table) {
            $table->string('google_id')->default('');
            $table->string('google_token')->default('');
            $table->string('google_refresh_token')->default('');

            // If your app allows both password and social logins, you
            // MUST validate that the password is not blank during login.
            // If you do not, an attacker could gain access to an account
            // that uses social login by only knowing the email.
            $table->string('password')->nullable()->change();
        });
    }

    /**
     * Reverse the migrations.
     */
    public function down(): void
    {
        Schema::table('users', function (Blueprint $table) {
            $table->dropColumn('google_id');
            $table->dropColumn('google_token');
            $table->dropColumn('google_refresh_token');
            $table->string('password')->nullable(false)->change();
        });
    }
};

Fügen Sie Folgendes zu .env hinzu und verwenden Sie dabei die Anmeldeinformationen Ihrer Google-App, die Sie im Abschnitt „Voraussetzungen“ erstellt haben.

php artisan migrate

Ersetzen Sie den Inhalt von Routen/web.php durch den folgenden Code.

// config/services.php

'google' => [
    'client_id' => env('GOOGLE_CLIENT_ID'),
    'client_secret' => env('GOOGLE_CLIENT_SECRET'),
    'redirect' => '/auth/google/callback',
],

Der neue Code in dieser Datei implementiert die Routen für:

• Weiterleitung an Google für Social Login mit den entsprechenden Informationen.
• Bearbeitung des Rückrufs von Google. Diese Route erstellt oder aktualisiert einen Benutzer bei der Anmeldung, authentifiziert ihn dann und leitet ihn zur Homepage weiter.
• Abmelden eines authentifizierten Benutzers.

Ersetzen Sie abschließend den Inhalt von resources/views/welcome.php durch das folgende Markup.

# .env

GOOGLE_CLIENT_ID="your-google-client-id"
GOOGLE_CLIENT_SECRET="your-google-client-secret"

Sobald dies abgeschlossen ist, können wir die App manuell testen, indem wir den Entwicklungsserver ausführen.

<?php
// routes/web.php

use App\Models\User;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Route;
use Laravel\Socialite\Facades\Socialite;
use Laravel\Socialite\Two\InvalidStateException;
use Laravel\Socialite\Two\User as OAuth2User;

Route::get('/', function () {
    return view('welcome');
});

Route::get('/auth/google/redirect', function () {
    return Socialite::driver('google')->redirect();
});

Route::get('/auth/google/callback', function () {
    try {
        /** @var OAuth2User $google_user */
        $google_user = Socialite::driver('google')->user();
    } catch (InvalidStateException $exception) {
        abort(400, $exception->getMessage());
    }

    $user = User::updateOrCreate([
        'email' => $google_user->email,
    ], [
        'google_id' => $google_user->id,
        'name' => $google_user->name,
        'google_token' => $google_user->token,
        'google_refresh_token' => $google_user->refreshToken,
    ]);

    Auth::login($user);
    return redirect('/');
});

Route::get('/auth/logout', function () {
    Auth::logout();
    return redirect('/');
});

Wenn Sie auf den Link Mit Google anmelden klicken, sollten Sie den OAuth2-Ablauf durchlaufen und zur Startseite weitergeleitet werden, auf der Sie Informationen über den neu erstellten Benutzer von Google sehen können.

Testen von Socialite mit Pest

Unsere manuellen Tests funktionieren, aber wir möchten automatisierte Tests, um sicherzustellen, dass wir diese Funktionalität in Zukunft nicht versehentlich beeinträchtigen.

Mit dem folgenden Befehl können wir eine neue Testdatei erstellen.

<!-- resources/views/welcome.php -->
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Laravel Socialite Testing Example</title>
</head>
<body>
    <h1>Laravel Socialite Testing Example</h1>
    @if (auth()->check())
        <p>User is authenticated.</p>
        <p>Name: {{ auth()->user()->name }}</p>
        <p>Email: {{ auth()->user()->email }}</p>
        <p><a href="/auth/logout">Logout</a></p>
    @else
        <p>User is not authenticated.</p>
        <p>
            <a href="/auth/google/redirect">Login with Google</a>
        </p>
    @endif
</body>
</html>

Ersetzen Sie den Inhalt der neu erstellten Datei „tests/Feature/AuthRoutesTest.php“ durch Folgendes.

php artisan serve

So funktionieren die Tests

Beim Testen der Weiterleitungsroute testen wir, ob Socialite zur richtigen URL weiterleitet und die richtigen URL-Parameter übergibt.

Beim Testen der Rückrufrouten machen wir uns über Socialite lustig. Mocking ist nicht meine Lieblingsoption: In einer idealen Welt könnten wir Socialite durch eine andere OAuth2-Implementierung ersetzen und unsere Tests würden immer noch funktionieren. Allerdings gibt es keine einfache Möglichkeit, sich in die Autorisierungsanfrage einzuklinken, die Socialite sendet, um das Zugriffstoken zu pfänden. Aus diesem Grund ist Spott der praktischste Ansatz, um Socialite zu testen.

Es ist mühsam, Fluent-APIs über Mockery zu verspotten: Sie müssen mit dem Endaufruf beginnen und sich rückwärts vorarbeiten.

Hier ist die Socialite-Methode, die unser Callback-Endpunkt aufruft.

laravel new socialite-tests

So muss das durch Mockery verspottet werden:

 ┌ Would you like to install a starter kit? ────────────────────┐
 │ No starter kit                                               │
 └──────────────────────────────────────────────────────────────┘

 ┌ Which testing framework do you prefer? ──────────────────────┐
 │ Pest                                                         │
 └──────────────────────────────────────────────────────────────┘

 ┌ Which database will your application use? ───────────────────┐
 │ SQLite                                                       │
 └──────────────────────────────────────────────────────────────┘

 ┌ Would you like to run the default database migrations? ──────┐
 │ Yes                                                          │
 └──────────────────────────────────────────────────────────────┘

Abschließend führen wir einen Test durch, um sicherzustellen, dass die direkte Navigation zur Rückruf-URL außerhalb des OAuth-Ablaufs einen 400-Statuscode zurückgibt. Wir haben den Aufruf von Socialite::driver('google')->user() im Callback-Endpunkt innerhalb eines try/catch-Blocks verpackt. Wenn wir den Socialite-Aufruf nicht in einen Try/Catch-Block eingeschlossen hätten und jemand die Rückruf-URL in seinen Browser eingegeben hätte, würde der Endpunkt eine Ausnahme mit einem HTTP-500-Statuscode auslösen. Wenn in Ihrem Team die Überwachung von 500 Statuscodes eingerichtet ist, kann dies dazu führen, dass jemand mitten in der Nacht angerufen wird.

Einpacken

Dies ist eine minimale Integration und es könnte noch viel mehr implementiert werden. Wenn wir eine Integration mit einem sozialen Anbieter implementieren würden, bei dem sich die E-Mail-Adresse des Benutzers ändern könnte, würde diese Implementierung nicht funktionieren, da sie mit der E-Mail-Adresse abgeglichen wird. Wenn der Benutzer seine E-Mail-Adresse innerhalb unserer App ändern könnte, würde diese Implementierung aus demselben Grund auch nicht funktionieren. Nachdem Sie nun jedoch gesehen haben, wie man Socialite testet, können Sie Tests für diese Szenarien schreiben und die zugrunde liegende Implementierung so ändern, dass sie erfolgreich sind.

Ich habe viele Blogartikel und Forenbeiträge über Socialite gelesen, bevor ich verstanden habe, wie ich meine eigene Implementierung aufbaue, wie ich sie teste und worüber ich nachdenken sollte. Einige davon möchte ich hier würdigen.

• Wie ich Integrationstests für von Laravel Socialite betriebene Apps schreibe von Stefan Zweifel
• ServerSideUp-Forum: Socialite Best Practices, ein Gespräch
• Stack Overflow: So testen Sie Laravel Socialite
• Stack Exchange: Soziale Anmeldungen mit einer passenden E-Mail verknüpfen oder nicht verknüpfen
• Stapelaustausch: Umgang mit verbundenen sozialen Konten und potenziellen Waisenkindern

Lesen Sie diese, wenn Sie tiefer in die Materie eintauchen möchten. Lassen Sie mich auch wissen, ob Sie an Teil 2 dieses Beitrags interessiert sind, in dem ich mich mit der Handhabung mehrerer sozialer Anbieter, der Handhabung, wenn ein Benutzer seine E-Mail-Adresse ändert, oder der Handhabung von Aktualisierungstokens befasse.

Das obige ist der detaillierte Inhalt vonImplementierung und Test der Socialite-Authentifizierung in Laravel. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!