1. module passport-oauth2
   1. function passport-oauth2 (options, verify)
   2. function passport-oauth2.AuthorizationError (message, code, uri, status)
   3. function passport-oauth2.InternalOAuthError (message, err)
   4. function passport-oauth2.Strategy (options, verify)
   5. function passport-oauth2.TokenError (message, code, uri, status)
   6. function passport-oauth2.super_ ()
   7. object passport-oauth2.InternalOAuthError.prototype
   8. object passport-oauth2.Strategy.prototype
   9. object passport-oauth2.super_.prototype
2. module passport-oauth2.InternalOAuthError
   1. function passport-oauth2.InternalOAuthError (message, err)
3. module passport-oauth2.InternalOAuthError.prototype
   1. function passport-oauth2.InternalOAuthError.prototype.toString ()
4. module passport-oauth2.Strategy
   1. function passport-oauth2.Strategy (options, verify)
   2. function passport-oauth2.Strategy.AuthorizationError (message, code, uri, status)
   3. function passport-oauth2.Strategy.InternalOAuthError (message, err)
   4. function passport-oauth2.Strategy.TokenError (message, code, uri, status)
   5. function passport-oauth2.Strategy.super_ ()
5. module passport-oauth2.Strategy.prototype
   1. function passport-oauth2.Strategy.prototype._createOAuthError (message, err)
   2. function passport-oauth2.Strategy.prototype._loadUserProfile (accessToken, done)
   3. function passport-oauth2.Strategy.prototype.authenticate (req, options)
   4. function passport-oauth2.Strategy.prototype.authorizationParams (options)
   5. function passport-oauth2.Strategy.prototype.parseErrorResponse (body, status)
   6. function passport-oauth2.Strategy.prototype.tokenParams (options)
   7. function passport-oauth2.Strategy.prototype.userProfile (accessToken, done)
6. module passport-oauth2.super_
   1. function passport-oauth2.super_ ()
   2. function passport-oauth2.super_.Strategy ()
7. module passport-oauth2.super_.prototype
   1. function passport-oauth2.super_.prototype.authenticate (req, options)

module passport-oauth2

function passport-oauth2 (options, verify)

• description and source-code

  function OAuth2Strategy(options, verify) {
    if (typeof options == 'function') {
      verify = options;
      options = undefined;
    }
    options = options || {};
  
    if (!verify) { throw new TypeError('OAuth2Strategy requires a verify callback'); }
    if (!options.authorizationURL) { throw new TypeError('OAuth2Strategy requires a authorizationURL option'); }
    if (!options.tokenURL) { throw new TypeError('OAuth2Strategy requires a tokenURL option'); }
    if (!options.clientID) { throw new TypeError('OAuth2Strategy requires a clientID option'); }
  
    passport.Strategy.call(this);
    this.name = 'oauth2';
    this._verify = verify;
  
    // NOTE: The _oauth2 property is considered "protected".  Subclasses are
    //       allowed to use it when making protected resource requests to retrieve
    //       the user profile.
    this._oauth2 = new OAuth2(options.clientID,  options.clientSecret,
        '', options.authorizationURL, options.tokenURL, options.customHeaders);
  
    this._callbackURL = options.callbackURL;
    this._scope = options.scope;
    this._scopeSeparator = options.scopeSeparator || ' ';
    this._key = options.sessionKey || ('oauth2:' + url.parse(options.authorizationURL).hostname);
  
    if (options.store) {
      this._stateStore = options.store;
    } else {
      if (options.state) {
        this._stateStore = new SessionStateStore({ key: this._key });
      } else {
        this._stateStore = new NullStateStore();
      }
    }
    this._trustProxy = options.proxy;
    this._passReqToCallback = options.passReqToCallback;
    this._skipUserProfile = (options.skipUserProfile === undefined) ? false : options.skipUserProfile;
  }

• example usage

  n/a

function passport-oauth2.AuthorizationError (message, code, uri, status)

• description and source-code

  function AuthorizationError(message, code, uri, status) {
    if (!status) {
      switch (code) {
        case 'access_denied': status = 403; break;
        case 'server_error': status = 502; break;
        case 'temporarily_unavailable': status = 503; break;
      }
    }
  
    Error.call(this);
    Error.captureStackTrace(this, this.constructor);
    this.name = this.constructor.name;
    this.message = message;
    this.code = code || 'server_error';
    this.uri = uri;
    this.status = status || 500;
  }

• example usage

  n/a

function passport-oauth2.InternalOAuthError (message, err)

• description and source-code

  function InternalOAuthError(message, err) {
    Error.call(this);
    Error.captureStackTrace(this, this.constructor);
    this.name = this.constructor.name;
    this.message = message;
    this.oauthError = err;
  }

• example usage

  n/a

function passport-oauth2.Strategy (options, verify)

• description and source-code

  function OAuth2Strategy(options, verify) {
    if (typeof options == 'function') {
      verify = options;
      options = undefined;
    }
    options = options || {};
  
    if (!verify) { throw new TypeError('OAuth2Strategy requires a verify callback'); }
    if (!options.authorizationURL) { throw new TypeError('OAuth2Strategy requires a authorizationURL option'); }
    if (!options.tokenURL) { throw new TypeError('OAuth2Strategy requires a tokenURL option'); }
    if (!options.clientID) { throw new TypeError('OAuth2Strategy requires a clientID option'); }
  
    passport.Strategy.call(this);
    this.name = 'oauth2';
    this._verify = verify;
  
    // NOTE: The _oauth2 property is considered "protected".  Subclasses are
    //       allowed to use it when making protected resource requests to retrieve
    //       the user profile.
    this._oauth2 = new OAuth2(options.clientID,  options.clientSecret,
        '', options.authorizationURL, options.tokenURL, options.customHeaders);
  
    this._callbackURL = options.callbackURL;
    this._scope = options.scope;
    this._scopeSeparator = options.scopeSeparator || ' ';
    this._key = options.sessionKey || ('oauth2:' + url.parse(options.authorizationURL).hostname);
  
    if (options.store) {
      this._stateStore = options.store;
    } else {
      if (options.state) {
        this._stateStore = new SessionStateStore({ key: this._key });
      } else {
        this._stateStore = new NullStateStore();
      }
    }
    this._trustProxy = options.proxy;
    this._passReqToCallback = options.passReqToCallback;
    this._skipUserProfile = (options.skipUserProfile === undefined) ? false : options.skipUserProfile;
  }

• example usage

  n/a

function passport-oauth2.TokenError (message, code, uri, status)

• description and source-code

  function TokenError(message, code, uri, status) {
    Error.call(this);
    Error.captureStackTrace(this, this.constructor);
    this.name = this.constructor.name;
    this.message = message;
    this.code = code || 'invalid_request';
    this.uri = uri;
    this.status = status || 500;
  }

• example usage

  n/a

function passport-oauth2.super_ ()

• description and source-code

  function Strategy() {
  }

• example usage

  n/a

module passport-oauth2.InternalOAuthError

function passport-oauth2.InternalOAuthError (message, err)

• description and source-code

  function InternalOAuthError(message, err) {
    Error.call(this);
    Error.captureStackTrace(this, this.constructor);
    this.name = this.constructor.name;
    this.message = message;
    this.oauthError = err;
  }

• example usage

  n/a

module passport-oauth2.InternalOAuthError.prototype

function passport-oauth2.InternalOAuthError.prototype.toString ()

• description and source-code

  toString = function () {
    var m = this.name;
    if (this.message) { m += ': ' + this.message; }
    if (this.oauthError) {
      if (this.oauthError instanceof Error) {
        m = this.oauthError.toString();
      } else if (this.oauthError.statusCode && this.oauthError.data) {
        m += ' (status: ' + this.oauthError.statusCode + ' data: ' + this.oauthError.data + ')';
      }
    }
    return m;
  }

• example usage

  ...
   * @api public
   */
  InternalOAuthError.prototype.toString = function() {
    var m = this.name;
    if (this.message) { m += ': ' + this.message; }
    if (this.oauthError) {
      if (this.oauthError instanceof Error) {
        m = this.oauthError.toString();
      } else if (this.oauthError.statusCode && this.oauthError.data) {
        m += ' (status: ' + this.oauthError.statusCode + ' data: ' + this.oauthError.data + ')';
      }
    }
    return m;
  };
  ...

module passport-oauth2.Strategy

function passport-oauth2.Strategy (options, verify)

• description and source-code

  function OAuth2Strategy(options, verify) {
    if (typeof options == 'function') {
      verify = options;
      options = undefined;
    }
    options = options || {};
  
    if (!verify) { throw new TypeError('OAuth2Strategy requires a verify callback'); }
    if (!options.authorizationURL) { throw new TypeError('OAuth2Strategy requires a authorizationURL option'); }
    if (!options.tokenURL) { throw new TypeError('OAuth2Strategy requires a tokenURL option'); }
    if (!options.clientID) { throw new TypeError('OAuth2Strategy requires a clientID option'); }
  
    passport.Strategy.call(this);
    this.name = 'oauth2';
    this._verify = verify;
  
    // NOTE: The _oauth2 property is considered "protected".  Subclasses are
    //       allowed to use it when making protected resource requests to retrieve
    //       the user profile.
    this._oauth2 = new OAuth2(options.clientID,  options.clientSecret,
        '', options.authorizationURL, options.tokenURL, options.customHeaders);
  
    this._callbackURL = options.callbackURL;
    this._scope = options.scope;
    this._scopeSeparator = options.scopeSeparator || ' ';
    this._key = options.sessionKey || ('oauth2:' + url.parse(options.authorizationURL).hostname);
  
    if (options.store) {
      this._stateStore = options.store;
    } else {
      if (options.state) {
        this._stateStore = new SessionStateStore({ key: this._key });
      } else {
        this._stateStore = new NullStateStore();
      }
    }
    this._trustProxy = options.proxy;
    this._passReqToCallback = options.passReqToCallback;
    this._skipUserProfile = (options.skipUserProfile === undefined) ? false : options.skipUserProfile;
  }

• example usage

  n/a

function passport-oauth2.Strategy.AuthorizationError (message, code, uri, status)

• description and source-code

  function AuthorizationError(message, code, uri, status) {
    if (!status) {
      switch (code) {
        case 'access_denied': status = 403; break;
        case 'server_error': status = 502; break;
        case 'temporarily_unavailable': status = 503; break;
      }
    }
  
    Error.call(this);
    Error.captureStackTrace(this, this.constructor);
    this.name = this.constructor.name;
    this.message = message;
    this.code = code || 'server_error';
    this.uri = uri;
    this.status = status || 500;
  }

• example usage

  n/a

function passport-oauth2.Strategy.InternalOAuthError (message, err)

• description and source-code

  function InternalOAuthError(message, err) {
    Error.call(this);
    Error.captureStackTrace(this, this.constructor);
    this.name = this.constructor.name;
    this.message = message;
    this.oauthError = err;
  }

• example usage

  n/a

function passport-oauth2.Strategy.TokenError (message, code, uri, status)

• description and source-code

  function TokenError(message, code, uri, status) {
    Error.call(this);
    Error.captureStackTrace(this, this.constructor);
    this.name = this.constructor.name;
    this.message = message;
    this.code = code || 'invalid_request';
    this.uri = uri;
    this.status = status || 500;
  }

• example usage

  n/a

function passport-oauth2.Strategy.super_ ()

• description and source-code

  function Strategy() {
  }

• example usage

  n/a

module passport-oauth2.Strategy.prototype

function passport-oauth2.Strategy.prototype._createOAuthError (message, err)

• description and source-code

  _createOAuthError = function (message, err) {
    var e;
    if (err.statusCode && err.data) {
      try {
        e = this.parseErrorResponse(err.data, err.statusCode);
      } catch (_) {}
    }
    if (!e) { e = new InternalOAuthError(message, err); }
    return e;
  }

• example usage

  ...
  
        var params = self.tokenParams(options);
        params.grant_type = 'authorization_code';
        if (callbackURL) { params.redirect_uri = callbackURL; }
  
        self._oauth2.getOAuthAccessToken(code, params,
          function(err, accessToken, refreshToken, params) {
            if (err) { return self.error(self._createOAuthError('Failed to obtain
  access token', err)); }
  
            self._loadUserProfile(accessToken, function(err, profile) {
  if (err) { return self.error(err); }
  
  function verified(err, user, info) {
    if (err) { return self.error(err); }
    if (!user) { return self.fail(info); }
  ...

function passport-oauth2.Strategy.prototype._loadUserProfile (accessToken, done)

• description and source-code

  _loadUserProfile = function (accessToken, done) {
    var self = this;
  
    function loadIt() {
      return self.userProfile(accessToken, done);
    }
    function skipIt() {
      return done(null);
    }
  
    if (typeof this._skipUserProfile == 'function' && this._skipUserProfile.length > 1) {
      // async
      this._skipUserProfile(accessToken, function(err, skip) {
        if (err) { return done(err); }
        if (!skip) { return loadIt(); }
        return skipIt();
      });
    } else {
      var skip = (typeof this._skipUserProfile == 'function') ? this._skipUserProfile() : this._skipUserProfile;
      if (!skip) { return loadIt(); }
      return skipIt();
    }
  }

• example usage

  ...
        params.grant_type = 'authorization_code';
        if (callbackURL) { params.redirect_uri = callbackURL; }
  
        self._oauth2.getOAuthAccessToken(code, params,
          function(err, accessToken, refreshToken, params) {
            if (err) { return self.error(self._createOAuthError('Failed to obtain access token', err)); }
  
            self._loadUserProfile(accessToken, function(err, profile) {
  if (err) { return self.error(err); }
  
  function verified(err, user, info) {
    if (err) { return self.error(err); }
    if (!user) { return self.fail(info); }
  
    info = info || {};
  ...

function passport-oauth2.Strategy.prototype.authenticate (req, options)

• description and source-code

  authenticate = function (req, options) {
    options = options || {};
    var self = this;
  
    if (req.query && req.query.error) {
      if (req.query.error == 'access_denied') {
        return this.fail({ message: req.query.error_description });
      } else {
        return this.error(new AuthorizationError(req.query.error_description, req.query.error, req.query.error_uri));
      }
    }
  
    var callbackURL = options.callbackURL || this._callbackURL;
    if (callbackURL) {
      var parsed = url.parse(callbackURL);
      if (!parsed.protocol) {
        // The callback URL is relative, resolve a fully qualified URL from the
        // URL of the originating request.
        callbackURL = url.resolve(utils.originalURL(req, { proxy: this._trustProxy }), callbackURL);
      }
    }
  
    var meta = {
      authorizationURL: this._oauth2._authorizeUrl,
      tokenURL: this._oauth2._accessTokenUrl,
      clientID: this._oauth2._clientId
    }
  
    if (req.query && req.query.code) {
      function loaded(err, ok, state) {
        if (err) { return self.error(err); }
        if (!ok) {
          return self.fail(state, 403);
        }
  
        var code = req.query.code;
  
        var params = self.tokenParams(options);
        params.grant_type = 'authorization_code';
        if (callbackURL) { params.redirect_uri = callbackURL; }
  
        self._oauth2.getOAuthAccessToken(code, params,
          function(err, accessToken, refreshToken, params) {
            if (err) { return self.error(self._createOAuthError('Failed to obtain access token', err)); }
  
            self._loadUserProfile(accessToken, function(err, profile) {
              if (err) { return self.error(err); }
  
              function verified(err, user, info) {
                if (err) { return self.error(err); }
                if (!user) { return self.fail(info); }
  
                info = info || {};
                if (state) { info.state = state; }
                self.success(user, info);
              }
  
              try {
                if (self._passReqToCallback) {
                  var arity = self._verify.length;
                  if (arity == 6) {
                    self._verify(req, accessToken, refreshToken, params, profile, verified);
                  } else { // arity == 5
                    self._verify(req, accessToken, refreshToken, profile, verified);
                  }
                } else {
                  var arity = self._verify.length;
                  if (arity == 5) {
                    self._verify(accessToken, refreshToken, params, profile, verified);
                  } else { // arity == 4
                    self._verify(accessToken, refreshToken, profile, verified);
                  }
                }
              } catch (ex) {
                return self.error(ex);
              }
            });
          }
        );
      }
  
      var state = req.query.state;
      try {
        var arity = this._stateStore.verify.length;
        if (arity == 4) {
          this._stateStore.verify(req, state, meta, loaded);
        } else { // arity == 3
          this._stateStore.verify(req, state, loaded);
        }
      } catch (ex) {
        return this.error(ex);
      }
    } else {
      var params = this.authorizationParams(options);
      params.response_type = 'code';
      if (callbackURL) { params.redirect_uri = callbackURL; }
      var scope = options.scope || this._scope;
      if (scope) {
        if (Array.isArray(scope)) { scope = scope.join(this._scopeSeparator); }
        params.scope = scope;
      }
  
      var state = options.state;
      if (state) {
        params.state = state;
  
        var parsed = url.parse(this._oauth2._authorizeUrl, true);
        utils.merge(parsed.query, params);
        parsed.query['client_id'] = this._oauth2._clientId;
        delete parsed.search;
        var location = url.format(parsed);
        this.redirect(location);
      } else {
        function stored(err, state) {
          if (err) { return self.error(err); }
  
          if (state) { params.state = state; }
          var parsed = url.parse(self._oauth2._authorizeUrl, true);
          utils.merge(parsed.query, params);
          parsed.query['client_id'] = self._oauth2._clientId;
          delete parsed.search; ...

• example usage

  ...
      });
    }
  ));
  ```
  
  #### Authenticate Requests
  
  Use `passport.authenticate()`, specifying the `'oauth2'` strategy, to
  authenticate requests.
  
  For example, as route middleware in an [Express](http://expressjs.com/)
  application:
  
  ```js
  app.get('/auth/example',
  ...

function passport-oauth2.Strategy.prototype.authorizationParams (options)

• description and source-code

  authorizationParams = function (options) {
    return {};
  }

• example usage

  ...
      } else { // arity == 3
        this._stateStore.verify(req, state, loaded);
      }
    } catch (ex) {
      return this.error(ex);
    }
  } else {
    var params = this.authorizationParams(options);
    params.response_type = 'code';
    if (callbackURL) { params.redirect_uri = callbackURL; }
    var scope = options.scope || this._scope;
    if (scope) {
      if (Array.isArray(scope)) { scope = scope.join(this._scopeSeparator); }
      params.scope = scope;
    }
  ...

function passport-oauth2.Strategy.prototype.parseErrorResponse (body, status)

• description and source-code

  parseErrorResponse = function (body, status) {
    var json = JSON.parse(body);
    if (json.error) {
      return new TokenError(json.error_description, json.error, json.error_uri);
    }
    return null;
  }

• example usage

  ...
   * @param {Object|Error} err
   * @api private
   */
  OAuth2Strategy.prototype._createOAuthError = function(message, err) {
    var e;
    if (err.statusCode && err.data) {
      try {
        e = this.parseErrorResponse(err.data, err.statusCode);
      } catch (_) {}
    }
    if (!e) { e = new InternalOAuthError(message, err); }
    return e;
  };
  ...

function passport-oauth2.Strategy.prototype.tokenParams (options)

• description and source-code

  tokenParams = function (options) {
    return {};
  }

• example usage

  ...
  if (err) { return self.error(err); }
  if (!ok) {
    return self.fail(state, 403);
  }
  
  var code = req.query.code;
  
  var params = self.tokenParams(options);
  params.grant_type = 'authorization_code';
  if (callbackURL) { params.redirect_uri = callbackURL; }
  
  self._oauth2.getOAuthAccessToken(code, params,
    function(err, accessToken, refreshToken, params) {
      if (err) { return self.error(self._createOAuthError('Failed to obtain access token', err)); }
  ...

function passport-oauth2.Strategy.prototype.userProfile (accessToken, done)

• description and source-code

  userProfile = function (accessToken, done) {
    return done(null, {});
  }

• example usage

  ...
   * @param {Function} done
   * @api private
   */
  OAuth2Strategy.prototype._loadUserProfile = function(accessToken, done) {
  var self = this;
  
  function loadIt() {
    return self.userProfile(accessToken, done);
  }
  function skipIt() {
    return done(null);
  }
  
  if (typeof this._skipUserProfile == 'function' && this._skipUserProfile.length > 1) {
    // async
  ...

module passport-oauth2.super_

function passport-oauth2.super_ ()

• description and source-code

  function Strategy() {
  }

• example usage

  n/a

function passport-oauth2.super_.Strategy ()

• description and source-code

  function Strategy() {
  }

• example usage

  n/a

module passport-oauth2.super_.prototype

function passport-oauth2.super_.prototype.authenticate (req, options)

• description and source-code

  authenticate = function (req, options) {
    throw new Error('Strategy#authenticate must be overridden by subclass');
  }

• example usage

  ...
      });
    }
  ));
  ```
  
  #### Authenticate Requests
  
  Use `passport.authenticate()`, specifying the `'oauth2'` strategy, to
  authenticate requests.
  
  For example, as route middleware in an [Express](http://expressjs.com/)
  application:
  
  ```js
  app.get('/auth/example',
  ...