passport-wechat-work

0.2.0 • Public • Published

passport-wechat-work

Passport strategy for authenticating with Wechat Work Accounts using the OAuth 2.0 API.

Passport的企业微信OAuth2.0, 二维码扫码登录,用户验证模块, 支持Express,Strongloop|Loopback.

本程序基于passport-wechat-enterprise源码改写.

企业微信开发文档

微信企业号,转至 passport-wechat-enterprise

微信公众号,转至 passport-wechat-public

Install

$ npm install passport-wechat-work

Usage

Configure Strategy

  • 在Passport注册WechatWorkStrategy, Passport.use()的第一个参数是name,可以忽略使用默认的名字’wechat-work'。WechatWorkStrategy的构造函数的参数是options,verify 以及getAccessToken和saveAccessToken。

    options的corpId,corpSecret, agentId和callbackURL是必需的,其他为可选。verify函数是验证或创建用户传给done函数, getAccessToken和saveAccessToken用已获得AccessToken和保存新的AccessToken,当getAccessToken返回的AccessToken无效时,会通过调用微信的/gettoken接口获取新的AccessToken,并用saveAccessToken进行保存。getAccessToken and saveAccessToken 都是必需的。 options的href 可以用来传递微信企业二维码链接的css美化,可参考v.qq.com的微信登录链接

passport.use("wechat-work",new WechatWorkStrategy({
    corpId: CORP_ID,
    corpSecret: CORP_SECRET,
    agentId: agent_id,
    callbackURL: "http://localhost:3000/auth/wechat/callback",
    href: href,
    state: "state",
    scope: "snsapi_base",
  },
  function(profile, done) {
    User.findOrCreate({ userId: profile.UserId }, function (err, user) {
      return done(err, user);
    });
  },
  function getAccessToken(cb) { ... },
  function saveAccessToken(accessToken,cb){ ... }
))

Authenticate Requests

passport.authenticate()在对应的route下,注意strategy名字和passport.use()时一致。

For example

app.get('/auth/wechatwork',
  passport.authenticate('wechat-work'));

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

Additional

  • 微信企业用户验证只获得了用户基本信息,实际只获得了id,需要详细的用户信息仍需要调用微信的Users API.
{
   "UserId":"USERID",
   "DeviceId":"DEVICEID"
}

Readme

Keywords

Package Sidebar

Install

npm i passport-wechat-work

Weekly Downloads

22

Version

0.2.0

License

MIT

Last publish

Collaborators

  • harryhan1989