Merge pull request #987 from damienbod/fabiangosebrink/improve-auto-login

Fabiangosebrink/improve auto login

Author: damienbod

CHANGELOG.md

@@ -1,5 +1,11 @@
 ## Angular Lib for OpenID Connect/OAuth2 Changelog
 
+### 2021-02-27 Version 11.6.1
+
+- Added AutoLoginGuard
+  - [PR](https://github.com/damienbod/angular-auth-oidc-client/pull/987)
+- Updated Azure AD, Azure B2C templates to prompt for select_account (problem with multiple accounts)
+
 ### 2021-02-24 Version 11.6.0
 
 - Added support for OAuth Pushed authorisation requests (PAR)

README.md

@@ -78,12 +78,15 @@ or with yarn
 
 - [Guards](https://github.com/damienbod/angular-auth-oidc-client/tree/main/docs/guards.md)
 - [Features](https://github.com/damienbod/angular-auth-oidc-client/tree/main/docs/features.md)
+
   - [Public Events](https://github.com/damienbod/angular-auth-oidc-client/tree/main/docs/features.md#public-events)
   - [Auth with a popup](https://github.com/damienbod/angular-auth-oidc-client/tree/main/docs/authorizing-popup.md)
   - [Custom Storage](https://github.com/damienbod/angular-auth-oidc-client/tree/main/docs/features.md#custom-storage)
   - [Custom parameters](https://github.com/damienbod/angular-auth-oidc-client/tree/main/docs/features.md#custom-parameters)
+  - [Auto Login](https://github.com/damienbod/angular-auth-oidc-client/tree/main/docs/features.md#auto-login)
   - [Using the OIDC package in a module or a Angular lib](https://github.com/damienbod/angular-auth-oidc-client/tree/main/docs/features.md#using-the-oidc-package-in-a-module-or-a-angular-lib)
   - [Delay the loading or pass an existing AuthWellKnownEndpoints config](https://github.com/damienbod/angular-auth-oidc-client/tree/main/docs/features.md#delay-the-loading-or-pass-an-existing-well-knownopenid-configuration-configuration)
+
 - [Logout](https://github.com/damienbod/angular-auth-oidc-client/tree/main/docs/logout.md)
 - [Using and revoking the access token](https://github.com/damienbod/angular-auth-oidc-client/tree/main/docs/using-access-tokens.md)
 - [CSP & CORS](https://github.com/damienbod/angular-auth-oidc-client/tree/main/docs/csp-cors-config.md)

docs/features.md

@@ -3,6 +3,7 @@
 - [Public Events](#public-events)
 - [Custom Storage](#custom-storage)
 - [Custom parameters](#custom-parameters)
+- [Auto Login](#auto-login)
 - [Using the OIDC package in a module or a Angular lib](#using-the-oidc-package-in-a-module-or-a-angular-lib)
 - [Delay the loading or pass an existing AuthWellKnownEndpoints config](#delay-the-loading-or-pass-an-existing-well-knownopenid-configuration-configuration)
 
@@ -88,6 +89,28 @@ Then provide the class in the module:
 })
 ```
 
+## Auto Login
+
+If you want to have your app being redirected to the sts automatically without the user clicking any login button you can use the `AutoLoginGuard` provided by the lib. Use it for all the routes you want automatic login to be enabled.
+
+If you are using auto login _make sure_ to _*not*_ call the `checkAuth()` method in your `app.component.ts`. This will be done by the guard automatically for you.
+
+Sample routes could be
+
+```typescript
+import { AutoLoginGuard } from 'angular-auth-oidc-client';
+
+const appRoutes: Routes = [
+  { path: '', pathMatch: 'full', redirectTo: 'home' },
+  { path: 'home', component: HomeComponent, canActivate: [AutoLoginGuard] },
+  { path: 'protected', component: ProtectedComponent, canActivate: [AutoLoginGuard] },
+  { path: 'forbidden', component: ForbiddenComponent, canActivate: [AutoLoginGuard] },
+  { path: 'unauthorized', component: UnauthorizedComponent },
+];
+```
+
+[src code](../projects/sample-code-flow-auto-login)
+
 ## Custom parameters
 
 Custom parameters can be added to the auth request by adding them to the config you are calling the `withConfig(...)` method with. They are provided by

docs/guards.md

@@ -11,22 +11,22 @@ import { map } from 'rxjs/operators';
 
 @Injectable({ providedIn: 'root' })
 export class AuthorizationGuard implements CanActivate {
-    constructor(private oidcSecurityService: OidcSecurityService, private router: Router) {}
-
-    canActivate(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable<boolean> {
-        return this.oidcSecurityService.isAuthenticated$.pipe(
-            map((isAuthorized: boolean) => {
-                console.log('AuthorizationGuard, canActivate isAuthorized: ' + isAuthorized);
-
-                if (!isAuthorized) {
-                    this.router.navigate(['/unauthorized']);
-                    return false;
-                }
-
-                return true;
-            })
-        );
-    }
+  constructor(private oidcSecurityService: OidcSecurityService, private router: Router) {}
+
+  canActivate(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable<boolean> {
+    return this.oidcSecurityService.isAuthenticated$.pipe(
+      map((isAuthorized: boolean) => {
+        console.log('AuthorizationGuard, canActivate isAuthorized: ' + isAuthorized);
+
+        if (!isAuthorized) {
+          this.router.navigate(['/unauthorized']);
+          return false;
+        }
+
+        return true;
+      })
+    );
+  }
 }
 ```
 

docs/logout.md

@@ -1,6 +1,6 @@
 # Logout
 
-The `logoff()` function sends an endsesion request to the OIDC server, if it is available, or the check session has not sent a changed event.
+The `logoff()` function sends an end session request to the OIDC server, if it is available, or the check session has not sent a changed event.
 
 ```typescript
 logout() {