passport-weixin

General-purpose weixin authentication strategy for Passport.

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

Note that this strategy provides generic weixin support. In many cases, a provider-specific strategy can be used instead, which cuts down on unnecessary configuration, and accommodates any provider-specific quirks.

Developers who need to implement authentication against an weixin provider that is not already supported are encouraged to sub-class this strategy. If you choose to open source the new provider-specific strategy, please add it to the list so other people can find it.

Install

$ npm install passport-weixin

Usage

Configure Strategy

The weixin authentication strategy authenticates users using a third-party account and weixin tokens. The provider's weixin endpoints, as well as the client identifer and secret, are specified as options. The strategy requires a verify callback, which receives an access token and profile, and calls done providing a user.

var wechatOAuth =require('wechat').OAuth; var oauth=new wechatOAuth(exports.appId, exports.appSecret, getOAuthToken, saveOAuthToken); var _oauthtoken; function saveOAuthToken(openid, token, callback) { _oauthtoken=token; callback(null, _accesstoken); }; function getOAuthToken(openid, callback) { callback(null, _oauthtoken); };

passport.use('weixin', new WeixinStrategy({callbackURL:authCallbackUrl, appId:appId, appSecret:appSecret}, function(accessToken, refreshToken, result, profile, done) {//result:{access_token, expires_in, openid, scope} result.create_at=new Date().getTime(); saveOAuthToken(result, function(err) { if (err) return done(err); oauth.getUser(result.openid, function(err, weixinUser) { done(null, weixinUser); }); }); } ));

Authenticate Requests

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

For example, as route middleware in an Express application:

app.get('/tasks', ensureAuthenticated, getSameUI); ensureAuthenticated=function(req, res, next) { if (req.isAuthenticated()) { return next(); } console.log('user ensureAuthenticated by '+req.url); req.session = req.session || {}; req.session.authPreUrl=req.url; req.session.authState = crypto.createHash('sha1').update(-(new Date())+'').digest('hex'); passport.authenticate('weixin', { scope:'snsapi_userinfo', state: req.session.authState })(req, res, next); };

app.get('/oauth2/weixin', oauth2CallbackWeixin); oauth2CallbackWeixin=function(req, res, next) { if(req.session && req.session.authState && req.session.authState===req.query.state) { passport.authenticate('weixin', {successRedirect:req.session.authPreUrl})(req, res, next); } else { return next(new Error('user Auth State Mismatch')); } };

Related Modules

• passport-oauth1 — OAuth 1.0 authentication strategy
• passport-http-bearer — Bearer token authentication strategy for APIs
• OAuth2orize — OAuth 2.0 authorization server toolkit

Tests

$ npm install
$ npm test

Credits

• Ming Xu

License

The MIT License

Copyright (c) 2011-2014 Ming Xu