1. module angular2-oauth2
   1. function angular2-oauth2.OAuthService ()
   2. object angular2-oauth2.OAuthService.prototype
2. module angular2-oauth2.OAuthService
   1. function angular2-oauth2.OAuthService ()
3. module angular2-oauth2.OAuthService.prototype
   1. function angular2-oauth2.OAuthService.prototype.authorizationHeader ()
   2. function angular2-oauth2.OAuthService.prototype.callEventIfExists (options)
   3. function angular2-oauth2.OAuthService.prototype.checkAtHash (accessToken, idClaims)
   4. function angular2-oauth2.OAuthService.prototype.createAndSaveNonce ()
   5. function angular2-oauth2.OAuthService.prototype.createLoginUrl (state)
   6. function angular2-oauth2.OAuthService.prototype.createNonce ()
   7. function angular2-oauth2.OAuthService.prototype.getAccessToken ()
   8. function angular2-oauth2.OAuthService.prototype.getFragment ()
   9. function angular2-oauth2.OAuthService.prototype.getIdToken ()
   10. function angular2-oauth2.OAuthService.prototype.getIdentityClaims ()
   11. function angular2-oauth2.OAuthService.prototype.hasValidAccessToken ()
   12. function angular2-oauth2.OAuthService.prototype.hasValidIdToken ()
   13. function angular2-oauth2.OAuthService.prototype.initImplicitFlow (additionalState)
   14. function angular2-oauth2.OAuthService.prototype.logOut ()
   15. function angular2-oauth2.OAuthService.prototype.padBase64 (base64data)
   16. function angular2-oauth2.OAuthService.prototype.parseQueryString (queryString)
   17. function angular2-oauth2.OAuthService.prototype.processIdToken (idToken, accessToken)
   18. function angular2-oauth2.OAuthService.prototype.setStorage (storage)
   19. function angular2-oauth2.OAuthService.prototype.tryLogin (options)
   20. function angular2-oauth2.OAuthService.prototype.tryLoginWithIFrame ()
   21. function angular2-oauth2.OAuthService.prototype.tryRefresh (timeoutInMsec)

module angular2-oauth2

function angular2-oauth2.OAuthService ()

• description and source-code

  function OAuthService() {
      this.clientId = "";
      this.redirectUri = "";
      this.loginUrl = "";
      this.scope = "";
      this.rngUrl = "";
      this.oidc = false;
      this.state = "";
      this.issuer = "";
      this.logoutUrl = "";
      this._storage = localStorage;
  }

• example usage

  n/a

module angular2-oauth2.OAuthService

function angular2-oauth2.OAuthService ()

• description and source-code

  function OAuthService() {
      this.clientId = "";
      this.redirectUri = "";
      this.loginUrl = "";
      this.scope = "";
      this.rngUrl = "";
      this.oidc = false;
      this.state = "";
      this.issuer = "";
      this.logoutUrl = "";
      this._storage = localStorage;
  }

• example usage

  n/a

module angular2-oauth2.OAuthService.prototype

function angular2-oauth2.OAuthService.prototype.authorizationHeader ()

• description and source-code

  authorizationHeader = function () {
      return "Bearer " + this.getAccessToken();
  }

• example usage

  n/a

function angular2-oauth2.OAuthService.prototype.callEventIfExists (options)

• description and source-code

  callEventIfExists = function (options) {
      var that = this;
      if (options.onTokenReceived) {
          var tokenParams = {
              idClaims: that.getIdentityClaims(),
              idToken: that.getIdToken(),
              accessToken: that.getAccessToken(),
              state: that.state
          };
          options.onTokenReceived(tokenParams);
      }
  }

• example usage

  ...
          return false;
  }
  if (options.validationHandler) {
      var validationParams = { accessToken: accessToken, idToken: idToken };
      options
          .validationHandler(validationParams)
          .then(function () {
          _this.callEventIfExists(options);
      })
          .catch(function (reason) {
          console.error('Error validating tokens');
          console.error(reason);
      });
  }
  else {
  ...

function angular2-oauth2.OAuthService.prototype.checkAtHash (accessToken, idClaims)

• description and source-code

  checkAtHash = function (accessToken, idClaims) {
      if (!accessToken || !idClaims || !idClaims.at_hash)
          return true;
      var tokenHash = sha256(accessToken, { asBytes: true });
      var leftMostHalf = tokenHash.slice(0, (tokenHash.length / 2));
      var tokenHashBase64 = base64_js_1.fromByteArray(leftMostHalf);
      var atHash = tokenHashBase64.replace(/\+/g, "-").replace(/\//g, "_").replace(/=/g, "");
      var claimsAtHash = idClaims.at_hash.replace(/=/g, "");
      if (atHash != claimsAtHash) {
          console.warn("exptected at_hash: " + atHash);
          console.warn("actual at_hash: " + claimsAtHash);
      }
      return (atHash == claimsAtHash);
  }

• example usage

  ...
      console.warn("Wrong issuer: " + claims.iss);
      return false;
  }
  if (claims.nonce !== savedNonce) {
      console.warn("Wrong nonce: " + claims.nonce);
      return false;
  }
  if (accessToken && !this.checkAtHash(accessToken, claims)) {
      console.warn("Wrong at_hash");
      return false;
  }
  var now = Date.now();
  var issuedAtMSec = claims.iat * 1000;
  var expiresAtMSec = claims.exp * 1000;
  var tenMinutesInMsec = 1000 * 60 * 10;
  ...

function angular2-oauth2.OAuthService.prototype.createAndSaveNonce ()

• description and source-code

  createAndSaveNonce = function () {
      var that = this;
      return this.createNonce().then(function (nonce) {
          that._storage.setItem("nonce", nonce);
          return nonce;
      });
  }

• example usage

  ...
      this._storage = storage;
  };
  OAuthService.prototype.createLoginUrl = function (state) {
      var that = this;
      if (typeof state === "undefined") {
          state = "";
      }
      return this.createAndSaveNonce().then(function (nonce) {
          if (state) {
              state = nonce + ";" + state;
          }
          else {
              state = nonce;
          }
          var response_type = "token";
  ...

function angular2-oauth2.OAuthService.prototype.createLoginUrl (state)

• description and source-code

  createLoginUrl = function (state) {
      var that = this;
      if (typeof state === "undefined") {
          state = "";
      }
      return this.createAndSaveNonce().then(function (nonce) {
          if (state) {
              state = nonce + ";" + state;
          }
          else {
              state = nonce;
          }
          var response_type = "token";
          if (that.oidc) {
              response_type = "id_token+token";
          }
          var url = that.loginUrl
              + "?response_type="
              + response_type
              + "&client_id="
              + encodeURIComponent(that.clientId)
              + "&state="
              + encodeURIComponent(state)
              + "&redirect_uri="
              + encodeURIComponent(that.redirectUri)
              + "&scope="
              + encodeURIComponent(that.scope);
          if (that.oidc) {
              url += "&nonce=" + encodeURIComponent(nonce);
          }
          return url;
      });
  }

• example usage

  ...
          }
          return url;
      });
  };
  ;
  OAuthService.prototype.initImplicitFlow = function (additionalState) {
      if (additionalState === void 0) { additionalState = ""; }
      this.createLoginUrl(additionalState).then(function (url) {
          location.href = url;
      })
          .catch(function (error) {
          console.error("Error in initImplicitFlow");
          console.error(error);
      });
  };
  ...

function angular2-oauth2.OAuthService.prototype.createNonce ()

• description and source-code

  createNonce = function () {
      var _this = this;
      return new Promise(function (resolve, reject) {
          if (_this.rngUrl) {
              throw new Error("createNonce with rng-web-api has not been implemented so far");
          }
          else {
              var text = "";
              var possible = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
              for (var i = 0; i < 40; i++)
                  text += possible.charAt(Math.floor(Math.random() * possible.length));
              resolve(text);
          }
      });
  }

• example usage

  ...
          return;
      var logoutUrl = this.logoutUrl.replace(/\{\{id_token\}\}/, id_token);
      location.href = logoutUrl;
  };
  ;
  OAuthService.prototype.createAndSaveNonce = function () {
      var that = this;
      return this.createNonce().then(function (nonce) {
          that._storage.setItem("nonce", nonce);
          return nonce;
      });
  };
  ;
  OAuthService.prototype.createNonce = function () {
      var _this = this;
  ...

function angular2-oauth2.OAuthService.prototype.getAccessToken ()

• description and source-code

  getAccessToken = function () {
      return this._storage.getItem("access_token");
  }

• example usage

  ...
  ;
  OAuthService.prototype.callEventIfExists = function (options) {
      var that = this;
      if (options.onTokenReceived) {
          var tokenParams = {
              idClaims: that.getIdentityClaims(),
              idToken: that.getIdToken(),
              accessToken: that.getAccessToken(),
              state: that.state
          };
          options.onTokenReceived(tokenParams);
      }
  };
  OAuthService.prototype.tryLogin = function (options) {
      var _this = this;
  ...

function angular2-oauth2.OAuthService.prototype.getFragment ()

• description and source-code

  getFragment = function () {
      if (window.location.hash.indexOf("#") === 0) {
          return this.parseQueryString(window.location.hash.substr(1));
      }
      else {
          return {};
      }
  }

• example usage

  ...
          };
          options.onTokenReceived(tokenParams);
      }
  };
  OAuthService.prototype.tryLogin = function (options) {
      var _this = this;
      options = options || {};
      var parts = this.getFragment();
      var accessToken = parts["access_token"];
      var idToken = parts["id_token"];
      var state = parts["state"];
      var oidcSuccess = false;
      var oauthSuccess = false;
      if (!accessToken || !state)
          return false;
  ...

function angular2-oauth2.OAuthService.prototype.getIdToken ()

• description and source-code

  getIdToken = function () {
      return this._storage.getItem("id_token");
  }

• example usage

  ...
  };
  ;
  OAuthService.prototype.callEventIfExists = function (options) {
      var that = this;
      if (options.onTokenReceived) {
          var tokenParams = {
              idClaims: that.getIdentityClaims(),
              idToken: that.getIdToken(),
              accessToken: that.getAccessToken(),
              state: that.state
          };
          options.onTokenReceived(tokenParams);
      }
  };
  OAuthService.prototype.tryLogin = function (options) {
  ...

function angular2-oauth2.OAuthService.prototype.getIdentityClaims ()

• description and source-code

  getIdentityClaims = function () {
      var claims = this._storage.getItem("id_token_claims_obj");
      if (!claims)
          return null;
      return JSON.parse(claims);
  }

• example usage

  ...
      });
  };
  ;
  OAuthService.prototype.callEventIfExists = function (options) {
      var that = this;
      if (options.onTokenReceived) {
          var tokenParams = {
              idClaims: that.getIdentityClaims(),
              idToken: that.getIdToken(),
              accessToken: that.getAccessToken(),
              state: that.state
          };
          options.onTokenReceived(tokenParams);
      }
  };
  ...

function angular2-oauth2.OAuthService.prototype.hasValidAccessToken ()

• description and source-code

  hasValidAccessToken = function () {
      if (this.getAccessToken()) {
          var expiresAt = this._storage.getItem("expires_at");
          var now = new Date();
          if (expiresAt && parseInt(expiresAt) < now.getTime()) {
              return false;
          }
          return true;
      }
      return false;
  }

• example usage

  n/a

function angular2-oauth2.OAuthService.prototype.hasValidIdToken ()

• description and source-code

  hasValidIdToken = function () {
      if (this.getIdToken) {
          var expiresAt = this._storage.getItem("id_token_expires_at");
          var now = new Date();
          if (expiresAt && parseInt(expiresAt) < now.getTime()) {
              return false;
          }
          return true;
      }
      return false;
  }

• example usage

  n/a

function angular2-oauth2.OAuthService.prototype.initImplicitFlow (additionalState)

• description and source-code

  initImplicitFlow = function (additionalState) {
      if (additionalState === void 0) { additionalState = ""; }
      this.createLoginUrl(additionalState).then(function (url) {
          location.href = url;
      })
          .catch(function (error) {
          console.error("Error in initImplicitFlow");
          console.error(error);
      });
  }

• example usage

  ...
  })
  export class HomeComponent {
  
  constructor(private oAuthService: OAuthService) {
  }
  
  public login() {
      this.oAuthService.initImplicitFlow();
  }
  
  public logoff() {
      this.oAuthService.logOut();
  }
  
  public get name() {
  ...

function angular2-oauth2.OAuthService.prototype.logOut ()

• description and source-code

  logOut = function () {
      var id_token = this.getIdToken();
      this._storage.removeItem("access_token");
      this._storage.removeItem("id_token");
      this._storage.removeItem("nonce");
      this._storage.removeItem("expires_at");
      this._storage.removeItem("id_token_claims_obj");
      this._storage.removeItem("id_token_expires_at");
      if (!this.logoutUrl)
          return;
      var logoutUrl = this.logoutUrl.replace(/\{\{id_token\}\}/, id_token);
      location.href = logoutUrl;
  }

• example usage

  ...
  }
  
  public login() {
      this.oAuthService.initImplicitFlow();
  }
  
  public logoff() {
      this.oAuthService.logOut();
  }
  
  public get name() {
      let claims = this.oAuthService.getIdentityClaims();
      if (!claims) return null;
      return claims.given_name;
  }
  ...

function angular2-oauth2.OAuthService.prototype.padBase64 (base64data)

• description and source-code

  padBase64 = function (base64data) {
      while (base64data.length % 4 !== 0) {
          base64data += "=";
      }
      return base64data;
  }

• example usage

  ...
          this.callEventIfExists(options);
      }
      return true;
  };
  ;
  OAuthService.prototype.processIdToken = function (idToken, accessToken) {
      var tokenParts = idToken.split(".");
      var claimsBase64 = this.padBase64(tokenParts[1]);
      var claimsJson = js_base64_1.Base64.decode(claimsBase64);
      var claims = JSON.parse(claimsJson);
      var savedNonce = this._storage.getItem("nonce");
      if (claims.aud !== this.clientId) {
          console.warn("Wrong audience: " + claims.aud);
          return false;
      }
  ...

function angular2-oauth2.OAuthService.prototype.parseQueryString (queryString)

• description and source-code

  parseQueryString = function (queryString) {
      var data = {}, pairs, pair, separatorIndex, escapedKey, escapedValue, key, value;
      if (queryString === null) {
          return data;
      }
      pairs = queryString.split("&");
      for (var i = 0; i < pairs.length; i++) {
          pair = pairs[i];
          separatorIndex = pair.indexOf("=");
          if (separatorIndex === -1) {
              escapedKey = pair;
              escapedValue = null;
          }
          else {
              escapedKey = pair.substr(0, separatorIndex);
              escapedValue = pair.substr(separatorIndex + 1);
          }
          key = decodeURIComponent(escapedKey);
          value = decodeURIComponent(escapedValue);
          if (key.substr(0, 1) === '/')
              key = key.substr(1);
          data[key] = value;
      }
      return data;
  }

• example usage

  ...
              resolve(text);
          }
      });
  };
  ;
  OAuthService.prototype.getFragment = function () {
      if (window.location.hash.indexOf("#") === 0) {
          return this.parseQueryString(window.location.hash.substr(1));
      }
      else {
          return {};
      }
  };
  ;
  OAuthService.prototype.parseQueryString = function (queryString) {
  ...

function angular2-oauth2.OAuthService.prototype.processIdToken (idToken, accessToken)

• description and source-code

  processIdToken = function (idToken, accessToken) {
      var tokenParts = idToken.split(".");
      var claimsBase64 = this.padBase64(tokenParts[1]);
      var claimsJson = js_base64_1.Base64.decode(claimsBase64);
      var claims = JSON.parse(claimsJson);
      var savedNonce = this._storage.getItem("nonce");
      if (claims.aud !== this.clientId) {
          console.warn("Wrong audience: " + claims.aud);
          return false;
      }
      if (this.issuer && claims.iss !== this.issuer) {
          console.warn("Wrong issuer: " + claims.iss);
          return false;
      }
      if (claims.nonce !== savedNonce) {
          console.warn("Wrong nonce: " + claims.nonce);
          return false;
      }
      if (accessToken && !this.checkAtHash(accessToken, claims)) {
          console.warn("Wrong at_hash");
          return false;
      }
      var now = Date.now();
      var issuedAtMSec = claims.iat * 1000;
      var expiresAtMSec = claims.exp * 1000;
      var tenMinutesInMsec = 1000 * 60 * 10;
      if (issuedAtMSec - tenMinutesInMsec >= now || expiresAtMSec + tenMinutesInMsec <= now) {
          console.warn("Token has been expired");
          console.warn({
              now: now,
              issuedAtMSec: issuedAtMSec,
              expiresAtMSec: expiresAtMSec
          });
          return false;
      }
      this._storage.setItem("id_token", idToken);
      this._storage.setItem("id_token_claims_obj", claimsJson);
      this._storage.setItem("id_token_expires_at", "" + expiresAtMSec);
      if (this.validationHandler) {
          this.validationHandler(idToken);
      }
      return true;
  }

• example usage

  ...
  }
  if (!oauthSuccess)
      return false;
  if (!this.oidc && options.onTokenReceived) {
      options.onTokenReceived({ accessToken: accessToken });
  }
  if (this.oidc) {
      oidcSuccess = this.processIdToken(idToken, accessToken);
      if (!oidcSuccess)
          return false;
  }
  if (options.validationHandler) {
      var validationParams = { accessToken: accessToken, idToken: idToken };
      options
          .validationHandler(validationParams)
  ...

function angular2-oauth2.OAuthService.prototype.setStorage (storage)

• description and source-code

  setStorage = function (storage) {
      this._storage = storage;
  }

• example usage

  ...
  
  // set to true, to receive also an id_token via OpenId Connect (OIDC) in addition to the
  // OAuth2-based access_token
  this.oauthService.oidc = true;
  
  // Use setStorage to use sessionStorage or another implementation of the TS-type Storage
  // instead of localStorage
  this.oauthService.setStorage(sessionStorage);
  
  // To also enable single-sign-out set the url for your auth-server's logout-endpoint here
  this.oauthService.logoutUrl = "https://steyer-identity-server.azurewebsites.net/identity/connect/endsession?id_token={{id_token
  }}";
  
  // This method just tries to parse the token within the url when
  // the auth-server redirects the user back to the web-app
  // It dosn't initiate the login
  ...

function angular2-oauth2.OAuthService.prototype.tryLogin (options)

• description and source-code

  tryLogin = function (options) {
      var _this = this;
      options = options || {};
      var parts = this.getFragment();
      var accessToken = parts["access_token"];
      var idToken = parts["id_token"];
      var state = parts["state"];
      var oidcSuccess = false;
      var oauthSuccess = false;
      if (!accessToken || !state)
          return false;
      if (this.oidc && !idToken)
          return false;
      var savedNonce = this._storage.getItem("nonce");
      var stateParts = state.split(';');
      var nonceInState = stateParts[0];
      if (savedNonce === nonceInState) {
          this._storage.setItem("access_token", accessToken);
          var expiresIn = parts["expires_in"];
          if (expiresIn) {
              var expiresInMilliSeconds = parseInt(expiresIn) * 1000;
              var now = new Date();
              var expiresAt = now.getTime() + expiresInMilliSeconds;
              this._storage.setItem("expires_at", "" + expiresAt);
          }
          if (stateParts.length > 1) {
              this.state = stateParts[1];
          }
          oauthSuccess = true;
      }
      if (!oauthSuccess)
          return false;
      if (!this.oidc && options.onTokenReceived) {
          options.onTokenReceived({ accessToken: accessToken });
      }
      if (this.oidc) {
          oidcSuccess = this.processIdToken(idToken, accessToken);
          if (!oidcSuccess)
              return false;
      }
      if (options.validationHandler) {
          var validationParams = { accessToken: accessToken, idToken: idToken };
          options
              .validationHandler(validationParams)
              .then(function () {
              _this.callEventIfExists(options);
          })
              .catch(function (reason) {
              console.error('Error validating tokens');
              console.error(reason);
          });
      }
      else {
          this.callEventIfExists(options);
      }
      return true;
  }

• example usage

  ...
  
          // To also enable single-sign-out set the url for your auth-server's logout-endpoint here
          this.oauthService.logoutUrl = "https://steyer-identity-server.azurewebsites.net/identity/connect/endsession?id_token
  ={{id_token}}";
  
          // This method just tries to parse the token within the url when
          // the auth-server redirects the user back to the web-app
          // It dosn't initiate the login
          this.oauthService.tryLogin({});
  
      }
  
  }
  
  ```
  ...

function angular2-oauth2.OAuthService.prototype.tryLoginWithIFrame ()

• description and source-code

  tryLoginWithIFrame = function () {
      throw new Error("tryLoginWithIFrame has not been implemented so far");
  }

• example usage

  n/a

function angular2-oauth2.OAuthService.prototype.tryRefresh (timeoutInMsec)

• description and source-code

  tryRefresh = function (timeoutInMsec) {
      throw new Error("tryRefresh has not been implemented so far");
  }

• example usage

  n/a