oidc

Description:

oidc

oidc #





An OpenId Connect RP (Relying Party) plugin for flutter.
Make sure you read the for extra information.
Table Of Contents #

Introduction ✨
Installation 💻
Usage 🛠️
Features 📚

📜 Conformance
Implemented specs
WIP Specs



Introduction ✨ #
This federated plugin builds on top of to add platform-specific handling which is required by the spec (e.g. launching a browser, listening for redirect, etc...).
Installation 💻 #
❗ In order to start using this plugin you must have the Flutter SDK installed on your machine.
Add to your pubspec.yaml:
dart pub add oidc oidc_default_store
copied to clipboard
Usage 🛠️ #
After following the Getting Started steps, it's as easy as:
//1. create the manager:
final manager = OidcUserManager.lazy(
discoveryDocumentUri: OidcUtils.getOpenIdConfigWellKnownUri(
Uri.parse('https://server.example.com'),
),
// TODO: add other settings
);

//2. init()
await manager.init();

//3. listen to user changes
manager.userChanges().listen((user) {
print('currentUser changed to $user');
});

//4. login
final newUser = await manager.loginAuthorizationCodeFlow();

//5. logout
await manager.logout();
copied to clipboard
Features 📚 #

🧩 Cross platform: most features work on all platforms that can run flutter (Android, Ios, macos, web, windows, linux).
🧰 High maintenance: everyone hates having to fix an unmaintained package. you can trust that we will solve issues as soon as they pop up. especially since we use this package in all our production apps.
⚙️ Customizability: you can customize everything; Where to store the data, provide your own http client, extend requests/responses with your own data; whatever you want, you can do.
🚀 Easy to use: you mainly need to concern yourself with the OidcUserManager class, which is very well documented and has a simple interface.

📜 Conformance #

while we are NOT openid certified yet, this package was tested against multiple conformance profiles.

Implemented specs #

OpenId Connect Core 1.0.

no hybrid flow support yet.


OpenId Connect Discovery.

no webfinger support yet.


RP Initiated logout.
Front-Channel Logout.
Authorization code grant with PKCE.
Resource Owner Password Credentials Grant.
Automatic Refresh Token rotation.
OAuth 2.0 For Native Apps
OAuth 2.0 Device Authorization Grant
Session Management (Web only)

WIP Specs #

Dynamic Client Registration


Plugin Generated by the Very Good CLI 🤖