Für unsere neuen Freunde:

Logto ist eine Auth0-Alternative, die für moderne Apps und SaaS-Produkte entwickelt wurde. Es bietet sowohl Cloud als auch Open-Source Dienste, um dir zu helfen, dein Identity and Management (IAM) System schnell zu starten. Genieße Authentifizierung, Autorisierung und Multi-Tenant-Management alles in einem.

Wir empfehlen, mit einem kostenlosen Entwicklungsmieter auf Logto Cloud zu beginnen. Dies ermöglicht es dir, alle Funktionen einfach zu erkunden.

In diesem Artikel werden wir die Schritte durchgehen, um schnell die GitHub Anmeldeerfahrung (Benutzerauthentifizierung) mit Python und Logto aufzubauen.

Voraussetzungen

• Eine laufende Logto-Instanz. Sieh dir die Einführungsseite an, um loszulegen.
• Grundkenntnisse in Python.
• Ein nutzbares GitHub Konto.

Eine Anwendung in Logto erstellen

Logto basiert auf OpenID Connect (OIDC) Authentifizierung und OAuth 2.0 Autorisierung. Es unterstützt föderiertes Identitätsmanagement über mehrere Anwendungen hinweg, was allgemein als Single Sign-On (SSO) bezeichnet wird.

Um deine Traditionelle Webanwendung Anwendung zu erstellen, folge einfach diesen Schritten:

1. Öffne die Logto Console. Klicke im Abschnitt "Erste Schritte" auf den Link "Alle anzeigen", um die Liste der Anwendungs-Frameworks zu öffnen. Alternativ kannst du zu Logto Console > Applications navigieren und auf die Schaltfläche "Anwendung erstellen" klicken.
2. Klicke im sich öffnenden Modal auf den Abschnitt "Traditionelle Webanwendung" oder filtere alle verfügbaren "Traditionelle Webanwendung" Frameworks mit den Schnellfilter-Checkboxen auf der linken Seite. Klicke auf die "Flask" Framework-Karte, um mit der Erstellung deiner Anwendung zu beginnen.
3. Gib den Anwendungsnamen ein, z. B. "Buchladen", und klicke auf "Anwendung erstellen".

🎉 Ta-da! Du hast gerade deine erste Anwendung in Logto erstellt. Du wirst eine Glückwunschseite sehen, die einen detaillierten Integrationsleitfaden enthält. Folge dem Leitfaden, um zu sehen, wie die Erfahrung in deiner Anwendung sein wird.

Flask SDK integrieren

tipp:

• Das Beispiel verwendet Flask, aber die Konzepte sind für andere Frameworks gleich.
• Das Python-Beispielprojekt ist in unserem Python SDK-Repo verfügbar.
• Das Logto SDK nutzt Koroutinen, denke daran, await zu verwenden, wenn du asynchrone Funktionen aufrufst.

Installation

Führe im Projektstammverzeichnis aus:

pip install logto # oder `poetry add logto` oder was auch immer du verwendest

LogtoClient initialisieren

Zuerst erstelle eine Logto-Konfiguration:

client.py

from logto import LogtoClient, LogtoConfig

client = LogtoClient(
    LogtoConfig(
        endpoint="https://you-logto-endpoint.app",  # Ersetze durch deinen Logto-Endpunkt
        appId="replace-with-your-app-id",
        appSecret="replace-with-your-app-secret",
    ),
)

tipp:

Du kannst das "App Secret" auf der Anwendungsdetailseite in der Admin-Konsole finden und kopieren:

Ersetze auch den standardmäßigen Speicher im Arbeitsspeicher durch einen persistenten Speicher, zum Beispiel:

client.py

from logto import LogtoClient, LogtoConfig, Storage
from flask import session
from typing import Union

class SessionStorage(Storage):
    def get(self, key: str) -> Union[str, None]:
        return session.get(key, None)

    def set(self, key: str, value: Union[str, None]) -> None:
        session[key] = value

    def delete(self, key: str) -> None:
        session.pop(key, None)

client = LogtoClient(
    LogtoConfig(...),
    storage=SessionStorage(),
)

Siehe Storage für weitere Details.

Anmeldung und Abmeldung implementieren

In deiner Webanwendung füge eine Route hinzu, um die Anmeldeanfrage von Benutzern ordnungsgemäß zu bearbeiten. Verwenden wir /sign-in als Beispiel:

flask.py

@app.route("/sign-in")
async def sign_in():
  # Hole die Anmelde-URL und leite den Benutzer dorthin um
  return redirect(await client.signIn(
      redirectUri="http://localhost:3000/callback",
  ))

Ersetze http://localhost:3000/callback durch die Callback-URL, die du in deiner Logto-Konsole für diese Anwendung festgelegt hast.

Wenn du die Registrierungsseite auf dem ersten Bildschirm anzeigen möchtest, kannst du interactionMode auf signUp setzen:

flask.py

@app.route("/sign-in")
async def sign_in():
  return redirect(await client.signIn(
      redirectUri="http://localhost:3000/callback",
      interactionMode="signUp", # Zeige die Registrierungsseite auf dem ersten Bildschirm
  ))

Jetzt, wann immer deine Benutzer http://localhost:3000/sign-in besuchen, wird ein neuer Anmeldeversuch gestartet und der Benutzer zur Logto-Anmeldeseite umgeleitet.

Hinweis Das Erstellen einer Anmelderoute ist nicht der einzige Weg, um einen Anmeldeversuch zu starten. Du kannst immer die signIn-Methode verwenden, um die Anmelde-URL zu erhalten und den Benutzer dorthin umzuleiten.

Nachdem der Benutzer eine Abmeldeanfrage gestellt hat, wird Logto alle Benutzer-Authentifizierungsinformationen in der Sitzung löschen.

Um die Python-Sitzung und die Logto-Sitzung zu bereinigen, kann eine Abmelderoute wie folgt implementiert werden:

flask.py

@app.route("/sign-out")
async def sign_out():
  return redirect(
      # Leite den Benutzer nach einer erfolgreichen Abmeldung zur Startseite um
      await client.signOut(postLogoutRedirectUri="http://localhost:3000/")
  )

Authentifizierungsstatus verwalten

Im Logto SDK können wir client.isAuthenticated() verwenden, um den Authentifizierungsstatus zu überprüfen. Wenn der Benutzer angemeldet ist, wird der Wert true sein, andernfalls wird der Wert false sein.

Hier implementieren wir auch eine einfache Startseite zur Demonstration:

• Wenn der Benutzer nicht angemeldet ist, wird eine Anmeldeschaltfläche angezeigt;
• Wenn der Benutzer angemeldet ist, wird eine Abmeldeschaltfläche angezeigt.

@app.route("/")
async def home():
    if client.isAuthenticated() is False:
        return "Nicht authentifiziert <a href='/sign-in'>Anmelden</a>"
    return "Authentifiziert <a href='/sign-out'>Abmelden</a>"

Checkpoint: Teste deine Anwendung

Jetzt kannst du deine Anwendung testen:

1. Starte deine Anwendung, du wirst den Anmeldebutton sehen.
2. Klicke auf den Anmeldebutton, das SDK wird den Anmeldeprozess initiieren und dich zur Logto-Anmeldeseite weiterleiten.
3. Nachdem du dich angemeldet hast, wirst du zurück zu deiner Anwendung geleitet und siehst den Abmeldebutton.
4. Klicke auf den Abmeldebutton, um den Token-Speicher zu leeren und dich abzumelden.

GitHub Connector hinzufügen

Um eine schnelle Anmeldung zu ermöglichen und die Benutzerkonversion zu verbessern, verbinde dich mit Flask als Identitätsanbieter (IdP). Der Logto Social Connector hilft dir, diese Verbindung in wenigen Minuten herzustellen, indem er mehrere Parameter-Eingaben ermöglicht.

Um einen Social Connector hinzuzufügen, folge einfach diesen Schritten:

1. Navigiere zu Console > Connectors > Social Connectors.
2. Klicke auf "Add social connector" und wähle "GitHub".
3. Folge der README-Anleitung und fülle die erforderlichen Felder aus und passe die Einstellungen an.

hinweis:

Wenn du der In-Place Connector-Anleitung folgst, kannst du den nächsten Abschnitt überspringen.

GitHub OAuth app einrichten

Mit GitHub-Konto anmelden

Gehe zur GitHub-Website und melde dich mit deinem GitHub-Konto an. Du kannst ein neues Konto registrieren, wenn du noch keines hast.

OAuth-App erstellen und konfigurieren

Folge der Anleitung zum Erstellen einer OAuth-App und registriere eine neue Anwendung.

Benenne deine neue OAuth-Anwendung im Feld Application name und fülle die Homepage URL der App aus. Du kannst das Feld Application description leer lassen und die Authorization callback URL als ${your_logto_origin}/callback/${connector_id} anpassen. Die connector_id findest du in der oberen Leiste der Logto Admin Console auf der Seite mit den Connector-Details.

hinweis:

Wenn du die Fehlermeldung "The redirect_uri MUST match the registered callback URL for this application." beim Anmelden erhältst, versuche, die Authorization Callback URL deiner GitHub OAuth-App und die Redirect-URL deiner Logto-App (natürlich einschließlich des Protokolls) abzugleichen, um das Problem zu lösen.

Wir empfehlen, das Kästchen vor Enable Device Flow nicht zu aktivieren, da Benutzer, die sich mit GitHub auf mobilen Geräten anmelden, die anfängliche Anmeldeaktion in der GitHub-App bestätigen müssen. Viele GitHub-Benutzer haben die GitHub-Mobile-App nicht auf ihren Telefonen installiert, was den Anmeldevorgang blockieren könnte. Bitte ignoriere unsere Empfehlung, wenn du erwartest, dass Endbenutzer ihren Anmeldevorgang bestätigen. Siehe Details zum Device Flow.

Verwaltung von OAuth-Apps

Gehe zur OAuth-Apps-Seite, wo du vorhandene OAuth-Apps hinzufügen, bearbeiten oder löschen kannst. Du kannst auch Client ID finden und Client secrets auf den Detailseiten der OAuth-App generieren.

Konfiguriere deinen Connector

Fülle die Felder clientId und clientSecret mit der Client ID und dem Client Secret aus, die du auf den in der vorherigen Sektion erwähnten Detailseiten der OAuth-App erhalten hast.

scope ist eine durch Leerzeichen getrennte Liste von Berechtigungen (Scopes). Wenn nicht angegeben, ist die Standardberechtigung read:user.

Konfigurationstypen

Name	Typ
clientId	string
clientSecret	string
scope	string

Konfiguration speichern

Überprüfe, ob du alle notwendigen Werte im Logto Connector-Konfigurationsbereich ausgefüllt hast. Klicke auf "Speichern und Fertig" (oder "Änderungen speichern") und der GitHub Connector sollte jetzt verfügbar sein.

GitHub Connector in der Anmeldeerfahrung aktivieren

Sobald du einen sozialen Connector erfolgreich erstellt hast, kannst du ihn als "Weiter mit GitHub"-Button in der Anmeldeerfahrung aktivieren.

1. Navigiere zu Konsole > Anmeldeerfahrung > Registrierung und Anmeldung.
2. (Optional) Wähle "Nicht zutreffend" für das Registrierungskennzeichen, wenn du nur die soziale Anmeldung benötigst.
3. Füge den konfigurierten GitHub Connector zum Abschnitt "Soziale Anmeldung" hinzu.

Testen und Validieren

Kehre zu deiner Python-App zurück. Du solltest dich jetzt mit GitHub anmelden können. Viel Spaß!

Weiterführende Lektüre

Endbenutzerflüsse: Logto bietet sofort einsatzbereite Authentifizierungsflüsse, einschließlich Multi-Faktor-Authentifizierung (MFA) und Enterprise SSO, zusammen mit leistungsstarken APIs für die flexible Implementierung von Kontoeinstellungen, Sicherheitsüberprüfung und Multi-Tenant-Erfahrung.

Autorisierung: Autorisierung (Authorization) definiert die Aktionen, die ein Benutzer ausführen kann, oder die Ressourcen, auf die er nach der Authentifizierung zugreifen kann. Erfahre, wie du deine API für native und Single-Page-Anwendungen schützen und rollenbasierte Zugangskontrolle (RBAC) implementieren kannst.

Organisationen: Besonders effektiv in Multi-Tenant-SaaS- und B2B-Anwendungen, ermöglicht die Organisationsfunktion die Erstellung von Mandanten, das Mitgliedermanagement, organisationsweite RBAC und Just-in-Time-Bereitstellung.

Kunden-IAM-Serie: Unsere Blogserie über Customer (oder Consumer) Identity and Access Management, von den Grundlagen bis zu fortgeschrittenen Themen und darüber hinaus.