https://github.com/jeroenheijmans/sample-angular-oauth2-oidc-with-auth-guards
Basic example of how to integrate the angular-oauth2-oidc library in an Angular SPA utilizing AuthGuards.
https://github.com/jeroenheijmans/sample-angular-oauth2-oidc-with-auth-guards
angular angular-oauth2-oidc typescript
Last synced: about 1 month ago
JSON representation
Basic example of how to integrate the angular-oauth2-oidc library in an Angular SPA utilizing AuthGuards.
- Host: GitHub
- URL: https://github.com/jeroenheijmans/sample-angular-oauth2-oidc-with-auth-guards
- Owner: jeroenheijmans
- License: mit
- Created: 2018-06-14T21:59:14.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-04-30T18:27:54.000Z (about 2 months ago)
- Last Synced: 2025-05-13T09:15:00.631Z (about 2 months ago)
- Topics: angular, angular-oauth2-oidc, typescript
- Language: TypeScript
- Homepage:
- Size: 7.31 MB
- Stars: 270
- Watchers: 9
- Forks: 114
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Example angular-oauth2-oidc with AuthGuard
This repository shows a basic Angular CLI application with [the `angular-oauth2-oidc` library](https://github.com/manfredsteyer/angular-oauth2-oidc) and Angular AuthGuards.
[](https://github.com/jeroenheijmans/sample-angular-oauth2-oidc-with-auth-guards/actions/workflows/ci-workflow.yml)
## ⚠ Third-party Cookies
**TLDR 👉 See [my "SPA Necromancy" blogpost for all options and workarounds known to me](https://infi.nl/nieuws/spa-necromancy/).**
Browser vendors are implementing increasingly strict rules around cookies.
This is increasingly problematic for SPA's with their Identity Server on a third-party domain.
Most notably **problems occur if the "silent refresh via an iframe" technique is used**.
This repository uses that technique currently, [starting with a `silentRefresh()`](https://github.com/jeroenheijmans/sample-angular-oauth2-oidc-with-auth-guards/blob/36316ee1971a8a8160033f55ba7eabe14f7d3add/src/app/core/auth.service.ts#L106-L109).
This will fire up an iframe to load an IDS page with `noprompt`, hoping cookies get sent along to so the IDS can see if a user is logged in.
[Safari will block cookies from being sent](https://webkit.org/blog/10218/full-third-party-cookie-blocking-and-more/), prompting a leading OAuth/OpenID community member to write "[SPAs are dead!?](https://leastprivilege.com/2020/03/31/spas-are-dead/)".
In fact, if you fire up this sample repository on `localhost`, which talks to `demo.duendesoftware.com` (another domain!), and use it in Safari: you will notice that the silent refresh technique already fails!
For reference, see [issue #40](https://github.com/jeroenheijmans/sample-angular-oauth2-oidc-with-auth-guards/issues/40), or [my blogpost that explains workarounds and solutions](https://infi.nl/nieuws/spa-necromancy/).
## Features
⚠ To see **the Implicit Flow** refer to [the `implicit-flow` branch](https://github.com/jeroenheijmans/sample-angular-oauth2-oidc-with-auth-guards/tree/implicit-flow) (which might be getting outdated, since Code Flow is now the recommended flow).
This demonstrates:
- Use of **the Code+PKCE Flow** (so no JWKS validation)
- Async but mandatory bootstrapping (via an `APP_INITIALIZER`) before the rest of the app can run
- Modules (core, shared, and two feature modules)
- An auth guard that forces you to login when navigating to protected routes
- An auth guard that just prevents you from navigating to protected routes
- Asynchronous loading of login information (and thus async auth guards)
- Using `localStorage` for storing tokens (use at your own risk!)
- Loading IDS details from its discovery document
- Trying refresh on app startup before potientially starting a login flow
- OpenID's external logout features
Most interesting features can be found in [the core module](./src/app/core).
## Implicit Flow
If you need an example of the _Implicit Flow_ check out [the last commit with that flow](https://github.com/jeroenheijmans/sample-angular-oauth2-oidc-with-auth-guards/commit/3c95d8891b4c086d5cd109d05cdd66171ef4b960) or even earlier versions.
For new applications Code+PKCE flow is recommended for JavaScript clients, and this example repository now demonstrates this as the main use case.
## Usage
This repository has been scaffolded with the Angular 5 CLI, then later upgraded to newer versions of the Angular CLI.
To use the repository:
1. Clone this repository
1. Run `npm ci` to get the exact locked dependencies
1. Run `npm run start` (or `start-with-ssl`) to get it running on [http://localhost:4200](http://localhost:4200) (or [https://localhost:4200](https://localhost:4200))
This connects to the [demo Duende IdentityServer instance](https://demo.duendesoftware.com/) also used in the library's examples.
The **credentials** and ways of logging in are disclosed on the login page itself (as it's only a demo server).
You could also connect to your own IdentityServer by changing `auth-config.ts`.
Note that your server must whitelist both `http://localhost:4200/index.html` and `http://localhost:4200/silent-refresh.html` for this to work.
You can run the end-to-end tests using:
1. Run `npx playwright install` to grab the Playwright browsers
2. Run `npm run test` to run the specs
## Differences between Identity Server options
**This repository demonstrates features using https://demo.duendesoftware.com (Duende IdentityServer)**.
There are various other server side solutions available, each with their own intricacies.
This codebase does not keep track itself of the specifics for each other server side solution.
Instead, we recommend you look for specific guidance for other solutions elsewhere.
Here are some potential starting points you could consider:
- IdenitityServer4
- This sample itself uses IDS4
- Auth0
- [github.com/jeroenheijmans/sample-auth0-angular-oauth2-oidc](https://github.com/jeroenheijmans/sample-auth0-angular-oauth2-oidc): Angular 6 and Auth0 integration
- Keycloak
- No samples or tutorials yet
- Okta
- No samples or tutorials yet
- Azure AD
- [Community-provided steps listed in a (closed) GitHub issue](https://github.com/jeroenheijmans/sample-angular-oauth2-oidc-with-auth-guards/issues/119)
- ...
Feel free to open an issue and PR if you want to add additional pieces of guidance to this section.
## Example
The application is supposed to look somewhat like this:
