-
-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #82 from Bdaya-Dev/feat/oidc-web-core
feat: introduce package:oidc_web_core
- Loading branch information
Showing
74 changed files
with
3,166 additions
and
1,703 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| name: oidc_web_core | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| on: | ||
| pull_request: | ||
| paths: | ||
| - ".github/workflows/oidc_web_core.yaml" | ||
| - "packages/oidc_web_core/**" | ||
| push: | ||
| branches: | ||
| - main | ||
|
|
||
| jobs: | ||
|
|
||
| build: | ||
| name: build | ||
| uses: ./.github/workflows/dart_package.yaml | ||
| with: | ||
| working_directory: packages/oidc_web_core | ||
| min_coverage: 0 | ||
| platform: chrome | ||
| custom_tests: | | ||
| dart pub global activate remove_from_coverage | ||
| dart pub global run remove_from_coverage:remove_from_coverage -f coverage/lcov.info -r '\.g\.dart$' | ||
| pana: | ||
| uses: ./.github/workflows/pana.yaml | ||
| needs: build | ||
| with: | ||
| min_score: 100 | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| part of [![package:oidc_core][package_image]][package_link] | ||
|
|
||
| A simple in-memory store useful for testing and CLI apps when persisting is not needed. | ||
|
|
||
| [package_link]: https://pub.dev/packages/oidc_core | ||
| [package_image]: https://img.shields.io/badge/package-oidc__core-0175C2?logo=dart&logoColor=white |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| # [![package:oidc_web_core][package_image]][package_link] | ||
|
|
||
| An alternative to `package:oidc` for dart web apps, that does NOT depend on flutter. | ||
|
|
||
| This can be used in things like [ngdart](https://pub.dev/packages/ngdart). | ||
|
|
||
| The package uses [package:web](https://dart.dev/interop/js-interop/package-web) to access browser APIs, making it also WASM compatible. | ||
|
|
||
| Learn more about developing dart web apps in: [dart.dev/web](https://dart.dev/web) | ||
|
|
||
| ## Getting started | ||
|
|
||
| The setup here is similar to what is done in [package:oidc](/oidc-getting-started/#web) | ||
|
|
||
| ### Add the dependencies | ||
|
|
||
| ```bash | ||
| dart pub add oidc_web_core oidc_core | ||
| ``` | ||
|
|
||
| ### Add redirect.html page | ||
|
|
||
| You need a separate html page to be delivered with your app, which will handle oidc-related requests. | ||
|
|
||
| you can get the page from the example project: | ||
|
|
||
| [redirect.html](https://github.com/Bdaya-Dev/oidc/blob/main/packages/oidc/example/web/redirect.html) | ||
|
|
||
| it doesn't matter where you put the page and what you call it, but it MUST be delivered from your redirect_uri | ||
|
|
||
| for example, here is a common configuration using this page: | ||
|
|
||
| ```dart | ||
| final htmlPageLinkDevelopment = Uri.parse('http://127.0.0.1:22433/redirect.html'); | ||
| final htmlPageLinkProduction = Uri.parse('https://mywebsite.com/redirect.html'); | ||
| final htmlPageLink = kDebugMode ? htmlPageLinkDevelopment : htmlPageLinkProduction; | ||
| final redirectUri = htmlPageLink; | ||
| final postLogoutRedirectUri = htmlPageLink; | ||
| final frontChannelLogoutUri = htmlPageLink.replace( | ||
| queryParameters: { | ||
| ...htmlPageLink.queryParameters, | ||
| 'requestType': 'front-channel-logout' | ||
| } | ||
| ); | ||
| ``` | ||
|
|
||
| Note how `frontChannelLogoutUri` needs `requestType=front-channel-logout` for the page to know the request type. | ||
|
|
||
| you will have to register these urls with the openid provider first, depending on your configuration. | ||
|
|
||
| also the html page is completely customizable, but it's preferred to leave the javascript part as is, since it's well-integrated with the plugin. | ||
|
|
||
| ## Usage | ||
|
|
||
| using this package is identical to [package:oidc](/oidc-usage/) | ||
|
|
||
| you can also see an [example here](https://github.com/Bdaya-Dev/oidc/tree/main/packages/oidc_web_core/example) of a dart web app using this package | ||
|
|
||
| 1. Define the manager | ||
| ```dart | ||
| final manager = OidcUserManagerWeb.lazy( | ||
| discoveryDocumentUri: OidcUtils.getOpenIdConfigWellKnownUri( | ||
| Uri.parse('https://demo.duendesoftware.com'), | ||
| ), | ||
| // this is a public client, | ||
| // so we use [OidcClientAuthentication.none] constructor. | ||
| clientCredentials: const OidcClientAuthentication.none( | ||
| clientId: 'interactive.public.short', | ||
| ), | ||
| // Use a web-only store | ||
| store: const OidcWebStore(), | ||
| settings: OidcUserManagerSettings( | ||
| frontChannelLogoutUri: Uri(path: 'redirect.html'), | ||
| uiLocales: ['en', 'ar'], | ||
| refreshBefore: (token) { | ||
| return const Duration(seconds: 1); | ||
| }, | ||
| // scopes supported by the provider and needed by the client. | ||
| scope: ['openid', 'profile', 'email', 'offline_access'], | ||
| // this url must be an actual html page. | ||
| // see the file in /web/redirect.html for an example. | ||
| // | ||
| // for debugging in flutter, you must run this app with --web-port 22433 | ||
| postLogoutRedirectUri: Uri.parse('http://127.0.0.1:22433/redirect.html'), | ||
| redirectUri: Uri.parse('http://127.0.0.1:22433/redirect.html'), | ||
| ), | ||
| ); | ||
| ``` | ||
| 2. Init the manager | ||
| ```dart | ||
| await manager.init(); | ||
| ``` | ||
| 3. Access the user | ||
| ```dart | ||
| manager.userChanges().listen((user) {}); | ||
| ``` | ||
| or | ||
| ```dart | ||
| manager.currentUser; | ||
| ``` | ||
| 4. Login | ||
| ```dart | ||
| final user = await manager.loginAuthorizationCodeFlow(); | ||
| ``` | ||
| 5. Logout | ||
| ```dart | ||
| await manager.logout(); | ||
| ``` | ||
| --- | ||
| [package_link]: https://pub.dev/packages/oidc_web_core | ||
| [package_image]: https://img.shields.io/badge/package-oidc__web__core-0175C2?logo=dart&logoColor=white |
Oops, something went wrong.