passport-http-bearer 1.0.1

HTTP Bearer authentication strategy for Passport.

Platform: npm

Language: JavaScript

License: MIT

Keywords: passport, auth, authn, authentication, authz, authorization, http, bearer, token, oauth

Repository: https://github.com/jaredhanson/passport-http-bearer

View on registry: https://www.npmjs.com/package/passport-http-bearer

Direct download link: https://registry.npmjs.org/passport-http-bearer/-/passport-http-bea...

Install: npm install [email protected]


passport-http-bearer

Build Coverage Dependencies

HTTP Bearer authentication strategy for Passport.

This module lets you authenticate HTTP requests using bearer tokens, as specified by RFC 6750, in your Node.js applications. Bearer tokens are typically used protect API endpoints, and are often issued using OAuth 2.0.

By plugging into Passport, bearer token support can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.

Install

$ npm install passport-http-bearer

Usage

Configure Strategy

The HTTP Bearer authentication strategy authenticates users using a bearer token. The strategy requires a verify callback, which accepts that credential and calls done providing a user. Optional info can be passed, typically including associated scope, which will be set by Passport at req.authInfo to be used by later middleware for authorization and access control.

passport.use(new BearerStrategy(
  function(token, done) {
    User.findOne({ token: token }, function (err, user) {
      if (err) { return done(err); }
      if (!user) { return done(null, false); }
      return done(null, user, { scope: 'all' });
    });
  }
));

Authenticate Requests

Use passport.authenticate(), specifying the 'bearer' strategy, to authenticate requests. Requests containing bearer tokens do not require session support, so the session option can be set to false.

For example, as route middleware in an Express application:

app.get('/profile', 
  passport.authenticate('bearer', { session: false }),
  function(req, res) {
    res.json(req.user);
  });

Issuing Tokens

Bearer tokens are typically issued using OAuth 2.0. OAuth2orize is a toolkit for implementing OAuth 2.0 servers and issuing bearer tokens. Once issued, this module can be used to authenticate tokens as described above.

Examples

For a complete, working example, refer to the Bearer example.

Related Modules

  • OAuth2orize — OAuth 2.0 authorization server toolkit

Tests

$ npm install
$ npm test

Credits

License

The MIT License

Copyright (c) 2011-2013 Jared Hanson <http://jaredhanson.net/>

Sustain

Releases

1.0.1 August 02, 2013
1.0.0 August 02, 2013
0.2.1 February 10, 2013
0.2.0 July 10, 2012
0.1.2 April 05, 2012
0.1.1 March 05, 2012
0.1.0 October 30, 2011

Project Statistics

SourceRank 19
Dependencies 1
Dependent projects 186
Dependent repositories 2.5K
Total releases 7
Latest release
First release
Stars 544
Forks 108
Watchers 11
Contributors 1
Repo Size: 436 KB

Top Contributors See all

Jared Hanson

Something wrong with this page? Make a suggestion

Export .ABOUT file for this library

Last synced: 2017-04-30 03:07:49 UTC