Detaillierte Einführung in den Prozess, die Konfiguration und die Verwendung von Laravel Passport

Laravel Passport ist eine vollständige OAuth2-Serverimplementierung unter dem Laravel-Framework. Sie ermöglicht die Authentifizierung und Autorisierung von Benutzeridentitäten über APIs, sodass auf API-Dienste zugegriffen werden kann, ohne dass Benutzeranmeldeinformationen offengelegt werden, was die Arbeitsbelastung des Clients erheblich verringert und die Anwendungssicherheit verbessert .

Das OAuth2-Protokoll hinter Laravel Passport ist ein Industriestandard, sodass Sie die OAuth2-Authentifizierung und -Autorisierung problemlos in andere Sprachen und Frameworks integrieren können, indem Sie dieselben Tools und Prozesse verwenden. Im Folgenden werden in diesem Artikel der Prozess, die Konfiguration und die Verwendung von Laravel Passport im Detail vorgestellt.

Passport installieren

Bevor Sie Laravel Passport verwenden, müssen Sie es installieren. Wir können den Composer-Befehl verwenden, um Passport zu installieren. Der Befehl lautet wie folgt:

composer require laravel/passport

Enable Passport

Nach der Installation von Laravel Passport müssen Sie seinen Dienstanbieter zum Provider-Array in der Datei config/app.php hinzufügen Öffnen Sie die Datei, suchen Sie nach Anbietern und fügen Sie den Dienstanbieter von Laravel Passport hinzu, wie unten gezeigt:

'providers' => [
    // Other Service Providers...
    Laravel\Passport\PassportServiceProvider::class,
],

Datenbanktabelle erstellen

Bevor Sie Laravel Passport verwenden, müssen Sie auch die für Passport erforderliche Datenbanktabelle erstellen Befehl zum Generieren der Migrationsdatei:

php artisan migrate

Nach der Ausführung des obigen Befehls erstellt Laravel Passport mehrere neue Tabellen in Ihrer Datenbank, um Daten wie OAuth2-Client, Zugriffstoken und Aktualisierungstoken zu speichern.

Veröffentlichen Sie die Konfigurationsdatei

Führen Sie den folgenden Handwerkerbefehl aus, um die Passport-Konfigurationsdatei im Konfigurationsverzeichnis des Laravel-Projekts zu veröffentlichen:

php artisan vendor:publish --tag=passport-config

Erstellen Sie den Schlüssel

An diesem Punkt haben wir die für die Verwendung von Laravel Passport erforderlichen Voraussetzungen erfüllt Zustand. Als nächstes müssen wir den folgenden Handwerkerbefehl verwenden, um Verschlüsselungsschlüssel zu generieren:

php artisan passport:keys

Der obige Befehl generiert Verschlüsselungsschlüssel zum Signieren von Daten wie Cookies und Zugriffstoken.

Passport konfigurieren

Nach Abschluss der oben genannten Schritte müssen wir als Nächstes Passport konfigurieren, damit es ausgeführt werden kann. Ändern Sie in der Konfigurationsdatei config/auth.php den Treiber des API-Treibers in Passport und legen Sie die Wächter und Anbieter wie folgt fest:

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

Konfigurieren Sie die Anbieter in derselben Datei wie folgt:

'providers' => [
    'users' => [
        'driver' => 'eloquent',
        'model' => App\Models\User::class,
    ],
],

Einmal konfiguriert Sobald die Datei ist abgeschlossen, die API-Zertifizierung ist fertig.

Route erstellen

Als nächstes müssen wir eine API-Route in der App/HTTP-Routing-Datei erstellen, wie unten gezeigt:

Route::middleware('auth:api')->get('/user', function (Request $request) {
    return $request->user();
});

Im obigen Routing-Beispiel ist die auth:api-Middleware definiert, um zu überprüfen, ob die Anfrage von Authenticated stammt Wenn es sich nicht um authentifizierte Benutzer handelt, wird der Statuscode 401 zurückgegeben, wenn die Überprüfung fehlschlägt.

Client erstellen

Da wir nun die Anwendungskonfiguration und die API-Routing-Einstellungen abgeschlossen haben, müssen wir den API-Client erstellen. In Laravel Passport wird der handwerkliche Befehl „passport:client“ zum Erstellen eines neuen OAuth2-Clients bereitgestellt. Führen Sie den Befehl wie unten gezeigt aus:

php artisan passport:client --client

Nach der Ausführung des Befehls müssen wir den Clientnamen und den Autorisierungsumleitungs-URI wie unten gezeigt eingeben:

php artisan passport:client --client
Which user ID should the client be assigned to? [0]:
 > 1
What should we name the client?
 > Test
Where should we redirect the request after authorization?
 > http://example.com/callback

Der obige Befehl erstellt einen neuen OAuth2-Client zur Anwendung auf diesen. Die API des Programms sendet die Anfrage. Wir erhalten eine Client-ID und ein Client-Geheimnis, die wir in nachfolgenden API-Anfragen verwenden können.

Autorisierung erhalten

Der Client wurde erstellt und hat den Autorisierungs-Umleitungs-URI erhalten. Jetzt müssen wir eine Anfrage an den URI senden, um eine Autorisierung zu erhalten. Anschließend generiert Passport ein Zugriffstoken für den Client und sendet es an den Client zurück. Verwenden Sie die unten gezeigte URL und ersetzen Sie die Client-ID und den Umleitungs-URI:

http://your-app.com/oauth/authorize?client_id={client-id}&redirect_uri={redirect-uri} &response_type=code&scope=

Nach Eingabe der URL wird der unten gezeigte OAuth2-Autorisierungsbildschirm angezeigt:

Nach dem Klicken auf die Schaltfläche „Autorisieren“ erfolgt die Autorisierung und die Umleitung zum Umleitungs-URI erfolgt.

Zugriffstoken erhalten

Jetzt haben wir die Autorisierung erhalten und dem Kunden wurde Zugriff auf die API gewährt. Wir müssen den OAuth2-Autorisierungscode verwenden, um den Client-Schlüssel gegen das Zugriffstoken auszutauschen. Wir können den Curl-Befehl wie unten gezeigt verwenden, um das Zugriffstoken vom API-Autorisierungsserver zu erhalten:

$ curl -X POST -H "Accept: application/json" -F "client_id={client-id}" -F "client_secret={client-secret}" -F "grant_type=authorization_code" -F "code={code}" -F "redirect_uri={redirect-uri}" http://your-app.com/oauth/token

Nachdem Sie den obigen Befehl ausgeführt haben, erhalten Sie das folgende JSON-Objekt, das Informationen wie „access_token“ und „refresh_token“ enthält:

{
    "token_type": "Bearer",
    "expires_in": 86400,
    "access_token": "{access-token}",
    "refresh_token": "{refresh-token}",
}

Zugriffstoken für API-Anfragen verwenden

Da wir nun das Zugriffstoken erhalten haben, können wir das Zugriffstoken verwenden, um Anfragen mit der API zu stellen. Wir müssen den Authorization-Header zum API-Anforderungsheader hinzufügen und das Bearer-Authentifizierungsschema einrichten, um das Zugriffstoken als Token-Inhalt zu verwenden, wie unten gezeigt:

$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'http://your-app.com/api/user', [
    'headers' => [
        'Authorization' => 'Bearer '.$accessToken,
        'Accept' => 'application/json',
    ],
]);

Im obigen Code verwenden wir das Zugriffstoken als Bearer-TOKEN Das Format wird zur Überprüfung an den API-Server übermittelt. Nach Erfolg wird das API-Antwortergebnis abgerufen.

Zusammenfassung

In diesem Artikel haben wir über den Prozess, die Konfiguration und die Verwendung von Laravel Passport gesprochen. Mit Laravel Passport können wir API-Anwendungen schnell eine sichere Authentifizierung und Autorisierung hinzufügen und gleichzeitig das OAuth2-Protokoll unterstützen und mit Anwendungen interagieren, die die OAuth2-Autorisierung in anderen Programmiersprachen und Frameworks implementieren, sodass Entwickler schnell Sicherheit aufbauen können. Verwenden Sie API-Anwendungen.

Das obige ist der detaillierte Inhalt vonDetaillierte Einführung in den Prozess, die Konfiguration und die Verwendung von Laravel Passport. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!