How to build Microsoft Entra ID OIDC enterprise SSO with Flutter

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 Microsoft Entra ID OIDC enterprise SSO Anmeldeerfahrung (Benutzerauthentifizierung) mit Flutter und Logto aufzubauen.

Voraussetzungen

Eine laufende Logto-Instanz. Sieh dir die Einführungsseite an, um loszulegen.
Grundkenntnisse in Flutter.
Ein nutzbares Microsoft Entra ID OIDC enterprise SSO Konto.

Create an application in Logto

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 Native app Anwendung zu erstellen, folge einfach diesen Schritten:

Ö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.
Klicke im sich öffnenden Modal auf den Abschnitt "Native app" oder filtere alle verfügbaren "Native app" Frameworks mit den Schnellfilter-Checkboxen auf der linken Seite. Klicke auf die "Flutter" Framework-Karte, um mit der Erstellung deiner Anwendung zu beginnen.
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.

Integrate Flutter SDK

tipp:

Das SDK-Paket ist verfügbar auf pub.dev und im Logto GitHub-Repository.
Das Beispielprojekt wurde mit Flutter Material erstellt. Du findest es auf pub.dev.
Dieses SDK ist kompatibel mit Flutter-Anwendungen auf iOS-, Android- und Web-Plattformen. Die Kompatibilität mit anderen Plattformen wurde nicht getestet.

Installation

pub.dev
GitHub

Du kannst das logto_dart_sdk package direkt mit dem Pub-Paketmanager installieren. Führe den folgenden Befehl im Stammverzeichnis deines Projekts aus:

flutter pub add logto_dart_sdk

Oder füge das Folgende zu deiner pubspec.yaml Datei hinzu:

dependencies:
  logto_dart_sdk: ^3.0.0

Dann führe aus:

flutter pub get

Wenn du es vorziehst, deine eigene Version des SDK zu forken, kannst du das Repository direkt von GitHub klonen.

git clone https://github.com/logto-io/dart

Abhängigkeit und Konfigurationen

SDK-Version-Kompatibilität

Logto SDK-Version	Dart SDK-Version	Dart 3.0 kompatibel
< 2.0.0	>= 2.17.6 < 3.0.0	false
>= 2.0.0 < 3.0.0	>= 3.0.0	true
>= 3.0.0	>= 3.6.0	true

flutter_secure_storage Einrichtung

Im Hintergrund verwendet dieses SDK flutter_secure_storage, um die plattformübergreifende, persistente sichere Token-Speicherung zu implementieren.

Keychain wird für iOS verwendet
AES-Verschlüsselung wird für Android verwendet.

Android-Version konfigurieren

Setze die android:minSdkVersion auf >= 18 in der android/app/build.gradle-Datei deines Projekts.

build.gradle
  android {
      ...

      defaultConfig {
          ...
          minSdkVersion 18
          ...
      }
  }

Automatisches Backup auf Android deaktivieren

Standardmäßig sichert Android Daten auf Google Drive. Dies kann die Ausnahme java.security.InvalidKeyException:Failed verursachen, um den Schlüssel zu entpacken. Um dies zu vermeiden,

Um das automatische Backup zu deaktivieren, gehe zu deiner App-Manifest-Datei und setze die Attribute android:allowBackup und android:fullBackupContent auf false.

AndroidManifest.xml
<manifest ... >
    ...
    <application
      android:allowBackup="false"
      android:fullBackupContent="false"
      ...
    >
        ...
    </application>
</manifest>

Schließe sharedprefs von FlutterSecureStorage aus.

Wenn du android:fullBackupContent für deine App beibehalten musst, anstatt es zu deaktivieren, kannst du das sharedprefs-Verzeichnis vom Backup ausschließen. Siehe weitere Details in der Android-Dokumentation.

In deiner AndroidManifest.xml-Datei füge das Attribut android:fullBackupContent zum <application>-Element hinzu, wie im folgenden Beispiel gezeigt. Dieses Attribut verweist auf eine XML-Datei, die Backup-Regeln enthält.
AndroidManifest.xml
```
<application ...
  android:fullBackupContent="@xml/backup_rules">
</application>
```
Erstelle eine XML-Datei namens @xml/backup_rules im Verzeichnis res/xml/. In dieser Datei füge Regeln mit den Elementen <include> und <exclude> hinzu. Das folgende Beispiel sichert alle Shared Preferences außer device.xml:
@xml/backup_rules
```
<?xml version="1.0" encoding="utf-8"?>
<full-backup-content>
  <exclude domain="sharedpref" path="FlutterSecureStorage"/>
</full-backup-content>
```

Bitte überprüfe flutter_secure_storage für weitere Details.

flutter_web_auth_2 Einrichtung

Im Hintergrund verwendet dieses SDK flutter_web_auth_2, um Benutzer mit Logto zu authentifizieren. Dieses Paket bietet eine einfache Möglichkeit, Benutzer mit Logto über das System-Webview oder den Browser zu authentifizieren.

Dieses Plugin verwendet ASWebAuthenticationSession auf iOS 12+ und macOS 10.15+, SFAuthenticationSession auf iOS 11, Chrome Custom Tabs auf Android und öffnet ein neues Fenster im Web.

iOS: Keine zusätzliche Einrichtung erforderlich

Android: Registriere die Callback-URL auf Android

Um die Callback-URL von Logtos Anmelde-Webseite zu erfassen, musst du deine Anmelde-redirectUri in deiner AndroidManifest.xml-Datei registrieren.

AndroidManifest.xml
  <manifest>
    <application>
        <activity
          android:name="com.linusu.flutter_web_auth_2.CallbackActivity"
          android:exported="true">
          <intent-filter android:label="flutter_web_auth_2">
          <action android:name="android.intent.action.VIEW" />
          <category android:name="android.intent.category.DEFAULT" />
          <category android:name="android.intent.category.BROWSABLE" />
          <data android:scheme="YOUR_CALLBACK_URL_SCHEME_HERE" />
          </intent-filter>
        </activity>
    </application>
  </manifest>

Webbrowser: Erstelle einen Endpunkt, um die Callback-URL zu verarbeiten

Wenn du die Webplattform verwendest, musst du einen Endpunkt erstellen, um die Callback-URL zu verarbeiten und sie mit der postMessage-API an die Anwendung zurückzusenden.

callback.html
<!doctype html>
<title>Authentifizierung abgeschlossen</title>
<p>
  Die Authentifizierung ist abgeschlossen. Falls dies nicht automatisch geschieht, bitte das
  Fenster schließen.
</p>
<script>
  function postAuthenticationMessage() {
    const message = {
      'flutter-web-auth-2': window.location.href,
    };

    if (window.opener) {
      window.opener.postMessage(message, window.location.origin);
      window.close();
    } else if (window.parent && window.parent !== window) {
      window.parent.postMessage(message, window.location.origin);
    } else {
      localStorage.setItem('flutter-web-auth-2', window.location.href);
      window.close();
    }
  }

  postAuthenticationMessage();
</script>

Bitte überprüfe die Einrichtungshinweise im flutter_web_auth_2 Paket für weitere Details.

Integration

LogtoClient initialisieren

Importiere das logto_dart_sdk Paket und initialisiere die LogtoClient Instanz am Root deiner Anwendung.

lib/main.dart
import 'package:logto_dart_sdk/logto_dart_sdk.dart';
import 'package:http/http.dart' as http;

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'Flutter Demo',
      home: MyHomePage(title: 'Logto Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);
  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  late LogtoClient logtoClient;

  void render() {
    // Zustandsänderung
  }

  // LogtoConfig
  final logtoConfig = const LogtoConfig(
    endpoint: "<your-logto-endpoint>",
    appId: "<your-app-id>"
  );

  void _init() {
    logtoClient = LogtoClient(
      config: logtoConfig,
      httpClient: http.Client(), // Optionaler HTTP-Client
    );
    render();
  }

  @override
  void initState() {
    super.initState();
    _init();
  }

  // ...
}

Bevor wir in die Details eintauchen, hier ein kurzer Überblick über die Endbenutzererfahrung. Der Anmeldeprozess kann wie folgt vereinfacht werden:

Deine App ruft die Anmeldemethode auf.
Der Benutzer wird zur Logto-Anmeldeseite umgeleitet. Bei nativen Apps wird der Systembrowser geöffnet.
Der Benutzer meldet sich an und wird zurück zu deiner App umgeleitet (konfiguriert als die Redirect-URI).

Dieser Authentifizierungsprozess folgt dem OpenID Connect (OIDC) Protokoll, und Logto erzwingt strenge Sicherheitsmaßnahmen, um die Benutzeranmeldung zu schützen.
Wenn du mehrere Apps hast, kannst du denselben Identitätsanbieter (Logto) verwenden. Sobald sich der Benutzer bei einer App anmeldet, wird Logto den Anmeldeprozess automatisch abschließen, wenn der Benutzer auf eine andere App zugreift.

Um mehr über die Gründe und Vorteile der umleitungsbasierten Anmeldung zu erfahren, siehe Logto-Anmeldeerfahrung erklärt.

Bevor du beginnst, musst du eine Redirect-URI in der Admin-Konsole für deine Anwendung hinzufügen.

Wechseln wir zur Seite "Anwendungsdetails" der Logto-Konsole. Füge eine Redirect-URI io.logto://callback hinzu und klicke auf "Änderungen speichern".

Für iOS spielt das Redirect-URI-Schema keine Rolle, da die ASWebAuthenticationSession Klasse auf die Redirect-URI hört, unabhängig davon, ob sie registriert ist.
Für Android muss das Redirect-URI-Schema in der AndroidManifest.xml Datei registriert werden.

Nachdem die Redirect-URI konfiguriert ist, fügen wir deiner Seite einen Anmeldebutton hinzu, der die logtoClient.signIn API aufruft, um den Logto-Anmeldefluss zu starten:

lib/main.dart
class _MyHomePageState extends State<MyHomePage> {
  // ...
  final redirectUri = 'io.logto://callback';

  @override
  Widget build(BuildContext context) {
    // ...

    Widget signInButton = TextButton(
      onPressed: () async {
        await logtoClient.signIn(redirectUri);
        render();
      },
      child: const Text('Sign In'),
    );

    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            SelectableText('My Demo App'),
            signInButton,
          ],
        ),
      ),
    );
  }
}

Abmeldung implementieren

Wechseln wir zur Seite mit den Anwendungsdetails der Logto-Konsole. Füge eine Post Sign-out Redirect URI io.logto://callback hinzu und klicke auf „Änderungen speichern“.

Post Sign-out Redirect URI in Logto Console

Post Sign-out Redirect URI ist ein OAuth 2.0-Konzept, das impliziert, wohin nach dem Abmelden umgeleitet werden soll.

Fügen wir nun auf der Hauptseite einen Abmeldebutton hinzu, damit sich Benutzer von deiner Anwendung abmelden können.

lib/main.dart
class _MyHomePageState extends State<MyHomePage> {
  // ...

  final postSignOutRedirectUri = 'io.logto//home';

  @override
  Widget build(BuildContext context) {
    // ...

    Widget signOutButton = TextButton(
      onPressed: () async {
        await logtoClient.signOut(postSignOutRedirectUri);
        render();
      },
      child: const Text('Sign Out'),
    );

    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            SelectableText('My Demo App'),
            signInButton,
            signOutButton,
          ],
        ),
      ),
    );
  }
}

Authentifizierungsstatus verwalten

Das Logto SDK bietet eine asynchrone Methode, um den Authentifizierungsstatus zu überprüfen. Die Methode ist logtoClient.isAuthenticated. Die Methode gibt einen booleschen Wert zurück, true, wenn der Benutzer authentifiziert ist, andernfalls false.

Im Beispiel rendern wir die Anmelde- und Abmeldebuttons bedingt basierend auf dem Authentifizierungsstatus. Aktualisieren wir nun die render Methode in unserem Widget, um die Zustandsänderung zu verwalten:

lib/main.dart
class _MyHomePageState extends State<MyHomePage> {
  // ...
  bool? isAuthenticated = false;

  void render() {
    setState(() async {
      isAuthenticated = await logtoClient.isAuthenticated;
    });
  }

  @override
  Widget build(BuildContext context) {
    // ...

    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            SelectableText('My Demo App'),
            isAuthenticated == true ? signOutButton : signInButton,
          ],
        ),
      ),
    );
  }
}

Checkpoint: Teste deine Anwendung

Jetzt kannst du deine Anwendung testen:

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

Add Microsoft Entra ID OIDC enterprise SSO connector

To simplify access management and gain enterprise-level safeguards for your big clients, connect with Flutter as a federated identity provider. The Logto enterprise SSO connector helps you establish this connection in minutes by allowing several parameter inputs.

To add an enterprise SSO connector, simply follow these steps:

Navigate to Logto console > Enterprise SSO.

SSO page

Click "Add enterprise connector" button and choose your SSO provider type. Choose from prebuilt connectors for Microsoft Entra ID (Azure AD), Google Workspace, and Okta, or create a custom SSO connection using the standard OpenID Connect (OIDC) or SAML protocol.
Provide a unique name (e.g., SSO sign-in for Acme Company).

Select your SSO provider

Configure the connection with your IdP in the "Connection" tab. Check the guides above for each connector types.

SSO connection

Customize the SSO experience and enterprise’s email domain in the "Experience" tab. Users sign in with the SSO-enabled email domain will be redirected to SSO authentication.

SSO experience

Save changes.

Set up Azure AD SSO-Anwendung

Schritt 1: Erstelle eine Microsoft EntraID OIDC-Anwendung

Gehe zum Microsoft Entra Admin Center und melde dich als Administrator an.
Navigiere zu Identity > Applications > App registrations.

Wähle New registration.
Gib den Anwendungsnamen ein und wähle den entsprechenden Kontotyp für deine Anwendung aus.
Wähle Web als Anwendungsplattform.
Kopiere und füge die redirect URI von Logtos SSO-Einstellungsseite ein. Die redirect URI ist die URL, zu der der Benutzer weitergeleitet wird, nachdem er sich mit Microsoft Entra ID authentifiziert hat.

Klicke auf Register, um die Anwendung zu erstellen.

Schritt 2: Konfiguriere Microsoft Entra ID OIDC SSO bei Logto

Nach der erfolgreichen Erstellung einer Microsoft Entra OIDC-Anwendung musst du die IdP-Konfigurationen zurück an Logto übermitteln. Navigiere zum Tab Connection in der Logto-Konsole und fülle die folgenden Konfigurationen aus:

Client ID: Ein eindeutiger Identifikator, der deiner OIDC-Anwendung von Microsoft Entra zugewiesen wird. Dieser Identifikator wird von Logto verwendet, um die Anwendung während des OIDC-Flows zu identifizieren und zu authentifizieren. Du findest ihn auf der Übersichtsseite der Anwendung als Application (client) ID.

Client Secret: Erstelle ein neues Client Secret und kopiere den Wert zu Logto. Dieses Secret wird verwendet, um die OIDC-Anwendung zu authentifizieren und die Kommunikation zwischen Logto und dem IdP zu sichern.

Aussteller (Issuer): Die Aussteller-URL, ein eindeutiger Identifikator für den IdP, der den Ort angibt, an dem der OIDC-Identitätsanbieter gefunden werden kann. Sie ist ein wesentlicher Bestandteil der OIDC-Konfiguration, da sie Logto hilft, die erforderlichen Endpunkte zu entdecken.

Anstatt alle diese OIDC-Endpunkte manuell bereitzustellen, ruft Logto automatisch alle erforderlichen Konfigurationen und IdP-Endpunkte ab. Dies geschieht, indem die von dir bereitgestellte Aussteller-URL verwendet wird und ein Aufruf zum Discover-Endpunkt des IdP gemacht wird.

Um die Aussteller-URL zu erhalten, findest du sie im Abschnitt Endpoints auf der Übersichtsseite der Anwendung.

Suche den Endpunkt OpenID Connect metadata document und kopiere die URL OHNE den abschließenden Pfad .well-known/openid-configuration. Dies liegt daran, dass Logto automatisch .well-known/openid-configuration an die Aussteller-URL anhängt, wenn die OIDC-Konfigurationen abgerufen werden.

Berechtigung (Scope): Eine durch Leerzeichen getrennte Liste von Zeichenfolgen, die die gewünschten Berechtigungen oder Zugriffsebenen definieren, die von Logto während des OIDC-Authentifizierungsprozesses angefordert werden. Der Scope-Parameter ermöglicht es dir, anzugeben, welche Informationen und Zugriffe Logto vom IdP anfordert.

Der Scope-Parameter ist optional. Unabhängig von den benutzerdefinierten Scope-Einstellungen sendet Logto immer die Scopes openid, profile und email an den IdP.

Klicke auf Speichern, um den Konfigurationsprozess abzuschließen.

Schritt 3: E-Mail-Domänen festlegen und den SSO-Connector aktivieren

Gib die E-Mail-Domains deiner Organisation auf der Connector-Erfahrung-Registerkarte an. Dies aktiviert den SSO-Connector als Authentifizierungsmethode für diese Benutzer.

Benutzer mit E-Mail-Adressen in den angegebenen Domains werden ausschließlich darauf beschränkt, deinen SSO-Connector als einzige Authentifizierungsmethode zu verwenden.

Save your configuration

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

You don’t need to configure enterprise connectors individually, Logto simplifies SSO integration into your applications with just one click.

Navigate to: Console > Sign-in experience > Sign-up and sign-in.
Enable the "Enterprise SSO" toggle.
Save changes.

Once enabled, a "Single Sign-On" button will appear on your sign-in page. Enterprise users with SSO-enabled email domains can access your services using their enterprise identity providers (IdPs).

Auto detect SSO sign-in via email domain

To learn more about the SSO user experience, including SP-initiated SSO and IdP-initiated SSO, refer to User flows: Enterprise SSO.

Testing and Validation

Kehre zu deiner Flutter-App zurück. Du solltest dich jetzt mit Microsoft Entra ID OIDC enterprise SSO anmelden können. Viel Spaß!

Create an application in Logto​

Integrate Flutter SDK​

Installation​

Abhängigkeit und Konfigurationen​

SDK-Version-Kompatibilität​

flutter_secure_storage Einrichtung​

Android-Version konfigurieren​

Automatisches Backup auf Android deaktivieren​

flutter_web_auth_2 Einrichtung​

Integration​

LogtoClient initialisieren​

Anmeldung implementieren​

Bezüglich der umleitungsbasierten Anmeldung​

Abmeldung implementieren​

Authentifizierungsstatus verwalten​

Checkpoint: Teste deine Anwendung​

Add Microsoft Entra ID OIDC enterprise SSO connector​

Set up Azure AD SSO-Anwendung​

Schritt 1: Erstelle eine Microsoft EntraID OIDC-Anwendung​

Schritt 2: Konfiguriere Microsoft Entra ID OIDC SSO bei Logto​

Schritt 3: E-Mail-Domänen festlegen und den SSO-Connector aktivieren​

Save your configuration​

Enable Microsoft Entra ID OIDC enterprise SSO connector in Sign-in Experience​

Testing and Validation​

Further readings​