Package Exports

passport-oauth2-client-password

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (passport-oauth2-client-password) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

passport-oauth2-client-password

OAuth 2.0 client password authentication strategy for Passport.

This module lets you authenticate requests containing client credentials in the request body, as defined by the OAuth 2.0 specification. These credentials are typically used protect the token endpoint and used as an alternative to HTTP Basic authentication.

Install

$ npm install passport-oauth2-client-password

Usage

Configure Strategy

The OAuth 2.0 client password authentication strategy authenticates clients using a client ID and client secret. The strategy requires a verify callback, which accepts those credentials and calls done providing a client.

passport.use(new ClientPasswordStrategy(
  function(clientId, clientSecret, done) {
    Clients.findOne({ clientId: clientId }, function (err, client) {
      if (err) { return done(err); }
      if (!client) { return done(null, false); }
      if (client.clientSecret != clientSecret) { return done(null, false); }
      return done(null, client);
    });
  }
));

Authenticate Requests

Use passport.authenticate(), specifying the 'oauth2-client-password' strategy, to authenticate requests. This strategy is typically used in combination with HTTP Basic authentication (as provided by passport-http), allowing clients to include credentials in the request body.

For example, as route middleware in an Express application, using OAuth2orize middleware to implement the token endpoint:

app.get('/profile', 
  passport.authenticate(['basic', 'oauth2-client-password'], { session: false }),
  oauth2orize.token());

Examples

The example included with OAuth2orize demonstrates how to implement a complete OAuth 2.0 authorization server. ClientPasswordStrategy is used to authenticate clients as they request access tokens from the token endpoint.

Tests

$ npm install --dev
$ make test

Credits

Jared Hanson

License

The MIT License