Unlimited Plugins, WordPress themes, videos & courses! Unlimited asset downloads! From $16.50/m
Advertisement
  1. Code
  2. Laravel 5
Code

Erstellen eines benutzerdefinierten Authentifizierungswächters in Laravel

by
Difficulty:IntermediateLength:LongLanguages:

German (Deutsch) translation by Wei Zhang (you can also view the original English article)

In diesem Artikel behandeln wir das Authentifizierungssystem im Laravel-Framework. Das Hauptziel dieses Artikels besteht darin, einen benutzerdefinierten Authentifizierungswächter zu erstellen, indem das Kernauthentifizierungssystem erweitert wird.

Laravel bietet ein sehr solides Authentifizierungssystem im Kern, das die Implementierung der Standardauthentifizierung zum Kinderspiel macht. In der Tat müssen Sie nur ein paar handwerkliche Befehle ausführen, um das Gerüst eines Authentifizierungssystems einzurichten.

Darüber hinaus ist das System selbst so konzipiert, dass Sie es erweitern und Ihre eigenen Authentifizierungsadapter anschließen können. Das werden wir in diesem Artikel ausführlich besprechen. Bevor wir mit der Implementierung des benutzerdefinierten Authentifizierungs-Wächters beginnen, beginnen wir mit einer Diskussion der grundlegenden Elemente im Laravel-Authentifizierungssystem - Wächter und Anbieter.

Die Kernelemente: Wächter und Anbieter

Das Laravel-Authentifizierungssystem besteht aus zwei Elementen in seinen Kernwachen und -anbietern.

Wächter

Sie könnten sich einen Wächter vorstellen, um die Logik zu liefern, mit der die authentifizierten Benutzer identifiziert werden. Im Kern bietet Laravel verschiedene Wachen wie Session und Token. Der Sitzungswächter behält den Zustand des Benutzers bei jeder Anfrage durch Cookies bei, und andererseits authentifiziert der Berechtigungswächter den Benutzer, indem er bei jeder Anfrage ein gültiges Token überprüft.

Wie Sie sehen können, definiert der Wächter also die Logik der Authentifizierung. Es muss nicht immer mit dieser Sicherheit umgehen, indem gültige Anmeldeinformationen vom Back-End abgerufen werden. Sie können einen Wächter implementieren, der einfach das Vorhandensein eines bestimmten Objekts in Anforderungsheadern überprüft und Benutzer basierend darauf authentifiziert.

Später in diesem Artikel implementieren wir einen Wächter, der bestimmte JSON-Parameter in Anforderungsheadern überprüft und den gültigen Benutzer vom MongoDB-Back-End abruft.

Anbieter

Wenn der Wächter die Logik der Authentifizierung definiert, ist der Authentifizierungsanbieter dafür verantwortlich, den Benutzer aus dem Back-End-Speicher abzurufen. Wenn der Schutz erfordert, dass der Benutzer gegen den Back-End-Speicher validiert werden muss, dann geht die Implementierung des Abrufens des Benutzers in den Authentifizierungsanbieter.

Laravel wird mit zwei Standard-Authentifizierungsanbietern geliefert: Datenbank und Eloquent. Der Datenbankauthentifizierungsanbieter befasst sich mit dem einfachen Abrufen der Benutzeranmeldeinformationen aus dem Back-End-Speicher, während Eloquent eine Abstraktionsschicht bereitstellt, die das Notwendige tut.

In unserem Beispiel implementieren wir einen MongoDB-Authentifizierungsanbieter, der die Benutzeranmeldeinformationen vom MongoDB-Back-End abruft.

Das war eine grundlegende Einführung in die Wächter und Anbieter des Laravel-Authentifizierungssystems. Ab dem nächsten Abschnitt konzentrieren wir uns auf die Entwicklung des Custom Authentication Guards und Providers!

Ein kurzer Blick auf das Datei-Setup

Werfen wir einen kurzen Blick auf die Liste der Dateien, die wir im Verlauf dieses Artikels implementieren werden.

  • config/auth.php: Es ist die Authentifizierungs-Konfigurationsdatei, in der wir einen Eintrag unseres benutzerdefinierten Schutzes hinzufügen.
  • config/mongo.php: Es ist die Datei, die die MongoDB-Konfiguration enthält.
  • app/Services/Contracts/NosqlServiceInterface.php: Es ist eine Schnittstelle, die unsere benutzerdefinierte Mongo-Datenbank-Klasse implementiert.
  • app / Database / MongoDatabase.php: Dies ist eine Hauptdatenbankklasse, die mit MongoDB interagiert.
  • app/Models/Auth/User.php: Es ist die Benutzermodellklasse, die den Authenticable-Vertrag implementiert.
  • app/Extensions/MongoUserProvider.php: Es ist eine Implementierung des Authentifizierungsanbieters.
  • app/Services/Auth/JsonGuard.php: Es ist eine Implementierung des Authentifizierungs-Wächter-Treibers.
  • app/Providers/AuthServiceProvider.php: Dies ist eine vorhandene Datei, die wir zum Hinzufügen unserer Service-Container-Bindungen verwenden.
  • app/Http/Controller/MongoController.php: Es ist eine Demo-Controller-Datei, die wir implementieren, um unsere benutzerdefinierte Wache zu testen.

Machen Sie sich keine Sorgen, wenn die Liste der Dateien noch nicht viel Sinn ergibt, da wir alles im Detail besprechen werden, während wir es durchgehen.

Tief tauchen in die Umsetzung

In diesem Abschnitt werden wir die Implementierung der erforderlichen Dateien durchführen.

Das erste, was wir tun müssen, ist, Laravel über unseren Wachmann zu informieren. Fahren Sie fort und geben Sie die benutzerdefinierten Guard-Details in der Datei config/auth.php wie gezeigt ein.

Wie Sie sehen können, haben wir unseren benutzerdefinierten Schutz unter dem benutzerdefinierten Schlüssel hinzugefügt.

Als Nächstes müssen wir im Abschnitt "Provider" einen zugehörigen Providereintrag hinzufügen.

Wir haben unseren Anbietereintrag unter dem Mongo Key hinzugefügt.

Schließlich, lassen Sie uns den Standardauthentifizierungsschutz von Web zu Gewohnheit ändern.

Natürlich wird es noch nicht funktionieren, da wir die notwendigen Dateien noch nicht implementiert haben. Und das werden wir in den nächsten Abschnitten besprechen.

Richten Sie den MongoDB-Treiber ein

In diesem Abschnitt implementieren wir die notwendigen Dateien, die mit der zugrunde liegenden MongoDB-Instanz kommunizieren.

Lassen Sie uns zunächst eine Konfigurationsdatei config / mongo.php erstellen, die die standardmäßigen MongoDB-Verbindungseinstellungen enthält.

Natürlich müssen Sie die Platzhalterwerte gemäß Ihren Einstellungen ändern.

Anstatt direkt eine Klasse zu erstellen, die mit MongoDB interagiert, erstellen wir zuerst eine Schnittstelle.

Der Vorteil der Erstellung einer Schnittstelle besteht darin, dass sie einen Vertrag bereitstellt, den ein Entwickler während seiner Implementierung einhalten muss. Außerdem könnte unsere Implementierung von MongoDB bei Bedarf problemlos durch eine andere NoSQL-Implementierung ersetzt werden.

Machen Sie weiter und erstellen Sie eine Interface-Datei app/Services/Contracts/NosqlServiceInterface.php mit folgendem Inhalt.

Es ist eine ziemlich einfache Schnittstelle, die die grundlegenden CRUD-Methoden deklariert, die eine Klasse definieren muss, die diese Schnittstelle implementiert.

Definieren wir nun eine tatsächliche Klasse in app/Database/MongoDatabase.php.

Natürlich gehe ich davon aus, dass Sie MongoDB und die dazugehörige MongoDB PHP-Erweiterung installiert haben.

Die __construct-Methode instanziiert die MongoClient-Klasse mit den erforderlichen Parametern. Die andere wichtige Methode, an der wir interessiert sind, ist die find-Methode, die den Datensatz basierend auf den als Methodenargumenten bereitgestellten Kriterien abruft.

Das war also die Implementierung des MongoDB-Treibers, und ich habe versucht, es so einfach wie möglich zu halten.

Richten Sie das Benutzermodell ein

Im Einklang mit den Standards des Authentifizierungssystems müssen wir das Benutzermodell implementieren, das den Vertrag Illuminate\Contracts\Auth\Authenticatable implementieren muss.

Gehen Sie voran und erstellen Sie eine Datei-app/Models/Auth/User.php mit den folgenden Inhalten.

Sie sollten bereits bemerkt haben, dass App\Models\Auth\User den Illuminate\Contracts\ Auth\Authenticatable-Vertrag implementiert.

Die meisten in unserer Klasse implementierten Methoden sind selbsterklärend. Allerdings haben wir die Methode fetchUserByCredentials definiert, die den Benutzer vom verfügbaren Backend abruft. In unserem Fall handelt es sich um eine MongoDatabase-Klasse, die aufgerufen wird, um die erforderlichen Informationen abzurufen.

Das ist also die Implementierung des Benutzermodells.

Richten Sie den Authentifizierungsanbieter ein

Wie bereits erwähnt, besteht das Laravel-Authentifizierungssystem aus zwei Elementen - Wächtern und Anbietern.

In diesem Abschnitt erstellen wir einen Authentifizierungsanbieter, der sich mit dem Benutzerabruf vom Back-End befasst.

Gehen Sie voran und erstellen Sie eine Datei-app/Extensions/MongoUserProvider.php wie unten gezeigt.

Auch hier müssen Sie sicherstellen, dass der benutzerdefinierte Anbieter den Vertrag Illuminate\Contracts\Auth\UserProvider implementieren muss.

Im weiteren Verlauf definiert es zwei wichtige Methoden - retrieveByCredentials und validateCredentials.

Die retrieveByCredentials-Methode wird verwendet, um die Benutzeranmeldeinformationen mithilfe der Benutzermodellklasse abzurufen, die im vorherigen Abschnitt behandelt wurde. Auf der anderen Seite wird die validateCredentials-Methode verwendet, um einen Benutzer anhand der angegebenen Anmeldeinformationen zu validieren.

Und das war die Implementierung unseres benutzerdefinierten Authentifizierungsanbieters. Im nächsten Abschnitt werden wir einen Wächter erstellen, der mit dem MongoUserProvider-Authentifizierungsanbieter interagiert.

Richten Sie den Authentifizierungsschutz ein

Wie bereits erwähnt, legt der Wächter im Laravel-Authentifizierungssystem fest, wie der Benutzer authentifiziert wird. In unserem Fall überprüfen wir das Vorhandensein des jsondata-Anforderungsparameters, der die JSON-codierte Zeichenfolge der Anmeldeinformationen enthalten sollte.

In diesem Abschnitt erstellen wir einen Wächter, der mit dem Authentifizierungsanbieter interagiert, der gerade im letzten Abschnitt erstellt wurde.

Gehen Sie voran und erstellen Sie eine Datei-app/Services/Auth/JsonGuard.php mit den folgenden Inhalten.

Zuallererst muss unsere Klasse die Schnittstelle Illuminate\Contracts\Auth\Guard implementieren. Daher müssen wir alle Methoden definieren, die in dieser Schnittstelle deklariert sind.

Beachten Sie hier, dass die __construct-Funktion eine Implementierung von Illuminate\Contracts\Auth\UserProvider erfordert. In unserem Fall übergeben wir eine Instanz von App\Extensions\MongoUserProvider, wie wir im späteren Abschnitt sehen werden.

Als nächstes gibt es eine Funktion getJsonParams, die die Benutzeranmeldeinformationen vom Anforderungsparameter jsondata abruft. Da erwartet wird, dass wir eine JSON-codierte Zeichenfolge der Benutzeranmeldeinformationen erhalten, haben wir die json_decode-Funktion zum Decodieren der JSON-Daten verwendet.

In der Validierungsfunktion überprüfen wir als erstes, ob das Argument $credentials vorhanden ist. Wenn es nicht vorhanden ist, rufen wir die getJsonParams-Methode auf, um Benutzeranmeldeinformationen aus den Anforderungsparametern abzurufen.

Als Nächstes rufen wir die Methode retrieveByCredentials des MongoUserProvider-Anbieters auf, die den Benutzer aus dem Back-End der MongoDB-Datenbank abruft. Schließlich überprüft die validateCredentials-Methode des MongoUserProvider-Anbieters die Gültigkeit des Benutzers.

Das war also die Umsetzung unserer Wachmannschaft. Im nächsten Abschnitt wird beschrieben, wie diese Teile zu einem erfolgreichen Authentifizierungssystem zusammengefügt werden.

Alles zusammenfügen

Bis jetzt haben wir alle Elemente des Custom Authentication Guards entwickelt, die uns ein neues Authentifizierungssystem zur Verfügung stellen sollten. Es funktioniert jedoch nicht sofort, da wir es zuerst mit den Laravel Service Container Bindings registrieren müssen.

Wie Sie bereits wissen sollten, ist der Laravel Service Provider der richtige Ort, um die notwendigen Bindungen zu implementieren.

Gehen Sie voran und öffnen Sie die Datei app/Providers/AuthServiceProvider.php, die es uns erlaubt, Container Bindings des Authentifizierungsdienstes hinzuzufügen. Wenn es keine benutzerdefinierten Änderungen enthält, können Sie es einfach durch den folgenden Inhalt ersetzen.

Lassen Sie uns die boot-Methode durchlaufen, die die meisten Provider-Bindungen enthält.

Zunächst erstellen wir Bindungen für die Elemente App\Database\MongoDatabase und App\Models\Auth\User.

Es ist schon eine Weile her, dass wir über Provider und Wächter gesprochen haben, und es ist Zeit, unseren eigenen Wächter in das Laravel-Authentifizierungssystem zu stecken.

Wir haben die Provider-Methode der Auth Facade verwendet, um unseren benutzerdefinierten Authentifizierungsanbieter unter dem Schlüssel mongo hinzuzufügen. Erinnern Sie sich, dass der Schlüssel die Einstellungen widerspiegelt, die zuvor in der Datei auth.php hinzugefügt wurden.

In ähnlicher Weise werden wir unsere Custom-Guard-Implementierung mit der extend-Methode der Auth-Fassade einfügen.

Als Nächstes gibt es eine register-Methode, mit der wir die App\Services\Contracts\NosqlServiceInterface-Schnittstelle an die App\Database\MongoDatabase-Implementierung gebunden haben.

Wann immer die Abhängigkeit von App\Services\Contracts\NosqlServiceInterface aufgelöst werden muss, antwortet Laravel mit der Implementierung des App\Database\MongoDatabase-Adapters.

Der Vorteil bei der Verwendung dieses Ansatzes besteht darin, dass die gegebene Implementierung leicht durch eine benutzerdefinierte Implementierung ersetzt werden kann. Angenommen, jemand möchte die App\Database\MongoDatabase-Implementierung in Zukunft durch den CouchDB-Adapter ersetzen. In diesem Fall müssen sie nur die entsprechende Bindung in der Registermethode hinzufügen.

Das war also der Dienstleister, der Ihnen zur Verfügung stand. In diesem Moment haben wir alles, was erforderlich ist, um unsere Custom-Guard-Implementierung zu testen, also geht es im nächsten und abschließenden Abschnitt darum.

Funktioniert es?

Sie haben die ganze Arbeit damit getan, Ihren ersten benutzerdefinierten Authentifizierungswächter einzurichten, und jetzt ist es an der Zeit, die Vorteile zu nutzen, während wir weitermachen und es versuchen werden.

Lassen Sie uns schnell eine ziemlich einfache Controller-Datei-App/Http/Controllers/MongoController.php wie unten gezeigt implementieren.

Sehen Sie sich die Abhängigkeit der Anmeldemethode genau an, die die Implementierung des Befehls Illuminate\Contracts\Auth\Guard erfordert. Da wir den benutzerdefinierten Wächter als Standardwächter in der Datei auth.php eingestellt haben, wird die App\Services\Auth\JsonGuard tatsächlich injiziert!

Als Nächstes haben wir die validate-Methode der App\Services\Auth\JsonGuard-Klasse aufgerufen, die wiederum eine Reihe von Methodenaufrufen einleitet:

  • Es ruft die retrieveByCredentials-Methode der App\Extensions\MongoUserProvider-Klasse auf.
  • Die Methode retrieveByCredentials ruft die Methode fetchUserByCredentialsder Klasse User App\Models\Auth\Userauf.
  • Die fetchUserByCredentials-Methode ruft die find-Methode der App\Database\MongoDatabase auf, um die Benutzeranmeldeinformationen abzurufen.
  • Schließlich gibt die Methode find der App\Database\MongoDatabase die Antwort zurück!

Wenn alles wie erwartet funktioniert, sollten wir einen authentifizierten Benutzer erhalten, indem wir die user-Methode unserer Wache aufrufen.

Um auf den Controller zuzugreifen, sollten Sie eine zugehörige Route in der Datei routes/web.php hinzufügen.

Versuchen Sie, auf die URL http://your-laravel-site /custom/mongo /login zuzugreifen, ohne irgendwelche Parameter zu übergeben, und Sie sollten eine "nicht autorisierte" Nachricht sehen.

Auf der anderen Seite, versuchen Sie etwas wie http://Ihre-Laravel-Site/Benutzerdefiniert/Mongo/Login?Jsondata={"Benutzername": "admin", "password": "admin"} und das sollte eine Erfolgsmeldung zurückgeben wenn der Benutzer in Ihrer Datenbank vorhanden ist.

Bitte beachten Sie, dass dies nur zu Beispielzwecken ist, um zu demonstrieren, wie der Zollschutz funktioniert. Sie sollten eine narrensichere Lösung für ein Feature wie Login implementieren. In der Tat habe ich nur einen Einblick in den Authentifizierungsablauf gegeben; Sie sind dafür verantwortlich, eine robuste und sichere Lösung für Ihre Anwendung zu entwickeln.

Damit endet unsere Reise heute, und hoffentlich komme ich mit nützlicherem Zeug zurück. Wenn Sie möchten, dass ich zu bestimmten Themen schreibe, vergessen Sie nicht, mir eine Nachricht zu schicken!

Fazit

Das Laravel-Framework bietet ein solides Authentifizierungssystem im Kern, das erweitert werden könnte, wenn Sie ein benutzerdefiniertes System implementieren möchten. Das war das Thema des heutigen Artikels, um einen benutzerdefinierten Wächter zu implementieren und ihn mit dem Laravel-Authentifizierungs-Workflow zu verbinden.

In diesem Zuge haben wir ein System entwickelt, das den Benutzer basierend auf den JSON-Nutzdaten in der Anfrage authentifiziert und mit der MongoDB-Datenbank abgleicht. Um dies zu erreichen, haben wir am Ende einen benutzerdefinierten Guard und eine benutzerdefinierte Provider-Implementierung erstellt.

Ich hoffe, die Übung hat Ihnen einen Einblick in den Laravel-Authentifizierungsfluss gegeben, und Sie sollten sich jetzt sicherer in Bezug auf die inneren Abläufe fühlen.

Für diejenigen unter Ihnen, die gerade mit Laravel anfangen oder Ihr Wissen, Ihre Website oder Ihre Anwendung mit Erweiterungen erweitern möchten, haben wir eine Vielzahl von Dingen, die Sie auf Envato Market studieren können.

Ich würde gerne Ihre Rückmeldungen und Vorschläge hören, also schreien Sie laut mit dem Feed unten!

Advertisement
Advertisement
Advertisement
Advertisement
Looking for something to help kick start your next project?
Envato Market has a range of items for sale to help get you started.