Added AbstractSecurityStorage

Author: FabianGosebrink

projects/angular-auth-oidc-client/src/lib/auth.module.ts

@@ -39,6 +39,7 @@ import { StandardLoginService } from './login/standard/standard-login.service';
 import { LogoffRevocationService } from './logoff-revoke/logoff-revocation.service';
 import { OidcSecurityService } from './oidc.security.service';
 import { PublicEventsService } from './public-events/public-events.service';
+import { AbstractSecurityStorage } from './storage/abstract-security-storage';
 import { BrowserStorageService } from './storage/browser-storage.service';
 import { DefaultSessionStorageService } from './storage/default-sessionstorage.service';
 import { StoragePersistenceService } from './storage/storage-persistence.service';
@@ -132,6 +133,8 @@ export class AuthModule {
         DefaultSessionStorageService,
         BrowserStorageService,
         CryptoService,
+
+        { provide: AbstractSecurityStorage, useClass: DefaultSessionStorageService },
       ],
     };
   }

projects/angular-auth-oidc-client/src/lib/config/config.service.ts

@@ -136,7 +136,6 @@ export class ConfigurationService {
   private prepareConfig(configuration: OpenIdConfiguration): OpenIdConfiguration {
     const openIdConfigurationInternal = { ...DEFAULT_CONFIG, ...configuration };
     this.setSpecialCases(openIdConfigurationInternal);
-    this.setStorage(openIdConfigurationInternal);
 
     return openIdConfigurationInternal;
   }
@@ -150,18 +149,6 @@ export class ConfigurationService {
     }
   }
 
-  private setStorage(currentConfig: OpenIdConfiguration): void {
-    if (currentConfig.storage) {
-      return;
-    }
-
-    if (this.hasBrowserStorage()) {
-      currentConfig.storage = this.defaultSessionStorageService;
-    } else {
-      currentConfig.storage = null;
-    }
-  }
-
   private hasBrowserStorage(): boolean {
     return typeof navigator !== 'undefined' && navigator.cookieEnabled && typeof Storage !== 'undefined';
   }

projects/angular-auth-oidc-client/src/lib/config/default-config.ts

@@ -30,7 +30,6 @@ export const DEFAULT_CONFIG: OpenIdConfiguration = {
   historyCleanupOff: false,
   maxIdTokenIatOffsetAllowedInSeconds: 120,
   disableIatOffsetValidation: false,
-  storage: null,
   customParamsAuthRequest: {},
   customParamsRefreshTokenRequest: {},
   customParamsEndSessionRequest: {},

projects/angular-auth-oidc-client/src/lib/config/openid-configuration.ts

@@ -131,8 +131,7 @@ export interface OpenIdConfiguration {
    * The acceptable range is client specific.
    */
   disableIatOffsetValidation?: boolean;
-  /** The storage mechanism to use */
-  storage?: any;
+
   /** Extra parameters to add to the authorization URL request */
   customParamsAuthRequest?: { [key: string]: string | number | boolean };
 

projects/angular-auth-oidc-client/src/lib/logging/abstract-logger.service.ts

@@ -0,0 +1,14 @@
+import { Injectable } from '@angular/core';
+import { OpenIdConfiguration } from '../config/openid-configuration';
+
+/**
+ * Implement this class-interface to create a custom logger service.
+ */
+@Injectable()
+export abstract class AbstractLoggerService {
+  abstract logError(configuration: OpenIdConfiguration, message: any, ...args: any[]): void;
+
+  abstract logWarning(configuration: OpenIdConfiguration, message: any, ...args: any[]): void;
+
+  abstract logDebug(configuration: OpenIdConfiguration, message: any, ...args: any[]): void;
+}

projects/angular-auth-oidc-client/src/lib/logging/logger.service.ts

@@ -1,9 +1,10 @@
 import { Injectable } from '@angular/core';
 import { OpenIdConfiguration } from '../config/openid-configuration';
+import { AbstractLoggerService } from './abstract-logger.service';
 import { LogLevel } from './log-level';
 
 @Injectable()
-export class LoggerService {
+export class LoggerService implements AbstractLoggerService {
   logError(configuration: OpenIdConfiguration, message: any, ...args: any[]): void {
     if (this.loggingIsTurnedOff(configuration)) {
       return;

projects/angular-auth-oidc-client/src/lib/storage/abstract-security-storage.ts

@@ -10,25 +10,25 @@ export abstract class AbstractSecurityStorage {
    *
    * @return The value of the given key
    */
-  public abstract read(key: string): any;
+  abstract read(key: string): any;
 
   /**
    * This method must contain the logic to write the storage.
    *
    * @param key The key to write a value for
    * @param value The value for the given key
    */
-  public abstract write(key: string, value: any): void;
+  abstract write(key: string, value: any): void;
 
   /**
    * This method must contain the logic to remove an item from the storage.
    *
    * @param key The value for the key to be removed
    */
-  public abstract remove(key: string): void;
+  abstract remove(key: string): void;
 
   /**
    * This method must contain the logic to remove all items from the storage.
    */
-  public abstract clear(): void;
+  abstract clear(): void;
 }

projects/angular-auth-oidc-client/src/lib/storage/browser-storage.service.ts

@@ -5,7 +5,7 @@ import { AbstractSecurityStorage } from './abstract-security-storage';
 
 @Injectable()
 export class BrowserStorageService {
-  constructor(private loggerService: LoggerService) {}
+  constructor(private loggerService: LoggerService, private abstractSecurityStorage: AbstractSecurityStorage) {}
 
   read(key: string, configuration: OpenIdConfiguration): any {
     const { configId } = configuration;
@@ -16,15 +16,15 @@ export class BrowserStorageService {
       return null;
     }
 
-    const storage = this.getStorage(configuration);
+    // const storage = this.getStorage(configuration);
 
-    if (!storage) {
-      this.loggerService.logDebug(configuration, `Wanted to read config for '${configId}' but Storage was falsy`);
+    // if (!storage) {
+    //   this.loggerService.logDebug(configuration, `Wanted to read config for '${configId}' but Storage was falsy`);
 
-      return null;
-    }
+    //   return null;
+    // }
 
-    const storedConfig = storage.read(configId);
+    const storedConfig = this.abstractSecurityStorage.read(configId);
 
     if (!storedConfig) {
       return null;
@@ -42,16 +42,16 @@ export class BrowserStorageService {
       return false;
     }
 
-    const storage = this.getStorage(configuration);
-    if (!storage) {
-      this.loggerService.logDebug(configuration, `Wanted to write '${value}' but Storage was falsy`);
+    // const storage = this.getStorage(configuration);
+    // if (!storage) {
+    //   this.loggerService.logDebug(configuration, `Wanted to write '${value}' but Storage was falsy`);
 
-      return false;
-    }
+    //   return false;
+    // }
 
     value = value || null;
 
-    storage.write(configId, JSON.stringify(value));
+    this.abstractSecurityStorage.write(configId, JSON.stringify(value));
 
     return true;
   }
@@ -63,14 +63,14 @@ export class BrowserStorageService {
       return false;
     }
 
-    const storage = this.getStorage(configuration);
-    if (!storage) {
-      this.loggerService.logDebug(configuration, `Wanted to write '${key}' but Storage was falsy`);
+    // const storage = this.getStorage(configuration);
+    // if (!storage) {
+    //   this.loggerService.logDebug(configuration, `Wanted to write '${key}' but Storage was falsy`);
 
-      return false;
-    }
+    //   return false;
+    // }
 
-    storage.remove(key);
+    this.abstractSecurityStorage.remove(key);
 
     return true;
   }
@@ -83,24 +83,18 @@ export class BrowserStorageService {
       return false;
     }
 
-    const storage = this.getStorage(configuration);
-    if (!storage) {
-      this.loggerService.logDebug(configuration, `Wanted to clear storage but Storage was falsy`);
+    // const storage = this.getStorage(configuration);
+    // if (!storage) {
+    //   this.loggerService.logDebug(configuration, `Wanted to clear storage but Storage was falsy`);
 
-      return false;
-    }
+    //   return false;
+    // }
 
-    storage.clear();
+    this.abstractSecurityStorage.clear();
 
     return true;
   }
 
-  private getStorage(configuration: OpenIdConfiguration): AbstractSecurityStorage {
-    const { storage } = configuration || {};
-
-    return storage;
-  }
-
   private hasStorage(): boolean {
     return typeof Storage !== 'undefined';
   }

projects/sample-code-flow-auth0/src/app/auth-config.module.ts

@@ -1,5 +1,23 @@
 import { NgModule } from '@angular/core';
-import { AuthModule, LogLevel } from 'angular-auth-oidc-client';
+import { AbstractSecurityStorage, AuthModule, LogLevel } from 'angular-auth-oidc-client';
+
+export class MyStorageService extends AbstractSecurityStorage {
+  read(key: string) {
+    throw new Error('Method not implemented.');
+  }
+  write(key: string, value: any): void {
+    throw new Error('Method not implemented.');
+  }
+  remove(key: string): void {
+    throw new Error('Method not implemented.');
+  }
+  clear(): void {
+    throw new Error('Method not implemented.');
+  }
+  constructor() {
+    super();
+  }
+}
 
 @NgModule({
   imports: [
@@ -23,6 +41,10 @@ import { AuthModule, LogLevel } from 'angular-auth-oidc-client';
       },
     }),
   ],
+  providers: [
+    // { provide: AbstractSecurityStorage, useClass: MyStorageService },
+    //{ provide: LoggerService, useClass: MyLoggerService },
+  ],
   exports: [AuthModule],
 })
 export class AuthConfigModule {}