Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
OpenStreetMap authentication strategy for Passport and Node.js.
JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
examples/login
lib/passport-openstreetmap Wrap error for informative message.
test Wrap error for informative message.
.gitignore Update ignore files.
.npmignore Update ignore files.
.travis.yml Test on node 0.8 using Travis CI.
LICENSE Update project metadata.
Makefile Update project metadata.
README.md Update project metadata.
package.json Bump version to 0.1.2.

README.md

Passport-OpenStreetMap

Passport strategy for authenticating with OpenStreetMap using the OAuth 1.0a API.

This module lets you authenticate using OpenStreetMap in your Node.js applications. By plugging into Passport, OpenStreetMap authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.

Install

$ npm install passport-openstreetmap

Usage

Configure Strategy

The OpenStreetMap authentication strategy authenticates users using an OpenStreetMap account and OAuth tokens. The strategy requires a verify callback, which accepts these credentials and calls done providing a user, as well as options specifying a consumer key, consumer secret, and callback URL.

passport.use(new OpenStreetMapStrategy({
    consumerKey: OPENSTREETMAP_CONSUMER_KEY,
    consumerSecret: OPENSTREETMAP_CONSUMER_SECRET,
    callbackURL: "http://127.0.0.1:3000/auth/openstreetmap/callback"
  },
  function(token, tokenSecret, profile, done) {
    User.findOrCreate({ openstreetmapId: profile.id }, function (err, user) {
      return done(err, user);
    });
  }
));

Authenticate Requests

Use passport.authenticate(), specifying the 'openstreetmap' strategy, to authenticate requests.

For example, as route middleware in an Express application:

app.get('/auth/openstreetmap',
  passport.authenticate('openstreetmap'));

app.get('/auth/openstreetmap/callback', 
  passport.authenticate('openstreetmap', { failureRedirect: '/login' }),
  function(req, res) {
    // Successful authentication, redirect home.
    res.redirect('/');
  });

Examples

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

Tests

$ npm install --dev
$ make test

Build Status

Credits

License

The MIT License

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

Something went wrong with that request. Please try again.