Passport strategies for authenticating with MediaWiki using OAuth 1.0a. Documentation and code shamelessly adapted from Jared Hanson's Passport-Google-OAuth.
This module lets you authenticate using MediaWiki in your Node.js applications. By plugging into Passport, MediaWiki authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.
$ npm install passport-mediawiki-oauth
The MediaWiki OAuth 1.0 authentication strategy authenticates users using a MediaWiki
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.
var MediaWikiStrategy = require('passport-mediawiki-oauth').OAuthStrategy;
passport.use(new MediaWikiStrategy({
consumerKey: MEDIAWIKI_CONSUMER_KEY,
consumerSecret: MEDIAWIKI_CONSUMER_SECRET,
callbackURL: MEDIAWIKI_CALLBACK_URL
},
function(token, tokenSecret, profile, done) {
User.findOrCreate({ mediawikiGlobalId: profile.id }, function (err, user) {
return done(err, user);
});
}
));
Use passport.authenticate()
, specifying the 'mediawiki'
strategy, to
authenticate requests.
For example, as route middleware in an Express application:
app.get('/auth/mediawiki',
passport.authenticate('mediawiki', { scope: MEDIAWIKI_AUTH_SCOPE }));
app.get('/auth/mediawiki/callback',
passport.authenticate('mediawiki', { failureRedirect: '/login' }),
function(req, res) {
// Successful authentication, redirect home.
res.redirect('/');
});
For a complete, working example, refer to the OAuth 1.0 example. To get it up and running, you can do:
$ cd examples/oauth
$ npm install
$ node app.js
$ npm install --dev
$ make test