前言
在我之前的【Node服务集成权限认证中间件之Passport】一文中已经介绍了如何为普通express应用集成passport认证中间件。那么对于下一代的Node应用框架——Koa,能否完美集成passport中间件呢?
困难
不得不承认,对于Koa而言,尤其是最新版本2.X版本Koa,其生态目前完全出于一个起步阶段,对比目前express大量稳定可用的中间件,的确是有许多的不足。但是开源的力量永远是最强大的,只要有需求,就一定有解决方案
思路
1、首选,passport中间件的官方只是提供了对express的支持。但是相对应的,koa也有其对应的开源集成版本——【koa-passport】
2、这里需要注意的是,koa-passport本质上并非全新实现的另外一个版本的passport,它仅仅只是作为中间件,将原先passport对express的支持,转移到了koa上。通过分析其源码可以看出,它其实是将原先绑定在express的req和res中的API方法,重新绑定到了koa的ctx中
3、美中不足的是koa-passport的官方文档中并没有给出很详细的使用方法,其koa-passport-example项目的示例也没有给出很清晰的使用说明,就我个人直接使用koa-passport-example项目,如果不加以修改,是无法完成认证功能的,所以难免会对初学者造成困扰,甚至是放弃
解决
对于koa-passport集成进入koa2版本,虽然是google和baidu了大量资料,但是很遗憾,目前似乎并没有太多关于这两者的集成文章,相关的都是比较老版本的文章或者是经过实践并没有生效的文章,并没有太多的参考价值
所以,这一篇文章可能是全网第一篇koa2版本正确集成koa-passport的教程,通过较长时间的分析koa-passport和passport的源码,最终得出了以下的正确集成方法,在此作为文章分享出来
步骤
第一,安装koa-passport
npm install koa-bodyparser --save
npm install passport --save
npm install passport-local --save
npm install koa-passport --save
npm install koa-session2 --save 【官方示例文档上使用的是koa-session,存在兼容问题】
第二,创建passport配置文件passport_config.js
【UserModel是数据库查询封装,在此省略】
const passport = require('koa-passport')
const LocalStrategy = require('passport-local')
const UserModel = require(__dirname + '/../../src/model/UserModel')
// 用户名密码验证策略
passport.use(new LocalStrategy(
/**
* @param username 用户输入的用户名
* @param password 用户输入的密码
* @param done 验证验证完成后的回调函数,由passport调用
*/
function (username, password, done) {
let where = { where: { username: username } }
UserModel.findOne(where).then(function (result) {
if (result != null) {
if (result.password == password) {
return done(null, result)
} else {
return done(null, false, '密码错误')
}
} else {
return done(null, false, '未知用户')
}
}).catch(function (err) {
log.error(err.message)
return done(null, false, { message: err.message })
})
}
))
// serializeUser 在用户登录验证成功以后将会把用户的数据存储到 session 中
passport.serializeUser(function (user, done) {
done(null, user)
})
// deserializeUser 在每次请求的时候将从 session 中读取用户对象
passport.deserializeUser(function (user, done) {
return done(null, user)
})
module.exports = passport
第三,创建认证路由xauth.js
【这里使用的是koa-router的koa2版本】
// 路由相关
const Router = require('koa-router')
// 初始化路由
const router = new Router()
// 认证相关
const passport = require(__dirname + '/passport_config.js')
/**
* 认证登录
*/
router.post('/xauth/login', function (ctx, next) {
return passport.authenticate('local', function (err, user, info, status) {
if (user) {
ctx.body = 'Y'
return ctx.login(user)
} else {
ctx.body = info
}
})(ctx, next)
})
/**
* 认证登出
*/
router.get('/xauth/logout', function (ctx, next) {
ctx.logout()
ctx.body = 'Y'
})
// 以下为自定义需要身份认证的路由
router.post('/xauth/test', function (ctx, next) {
if (ctx.isAuthenticated()) {
ctx.body = '认证通过'
} else {
ctx.throw(401)
ctx.body = '非法访问'
}
})
module.exports = router
最后,Koa的App中初始化和引入passport
// 认证相关
const bodyParser = require('koa-bodyparser')
const mount = require('koa-mount')
const session = require("koa-session2")
const passport = require(__dirname + '/src/auth/passport_config.js')
const xauth = require(__dirname + '/src/auth/xauth.js')
// 初始化应用服务
const app = new Koa()
// 启用认证路由
app.proxy = true
app.use(session({key: "SESSIONID"}))
app.use(bodyParser())
app.use(passport.initialize())
app.use(passport.session())
app.use(mount('/',xauth.routes()))
后记
关于本文中提到的内容,引用于我的开源项目【XServer——组件化后端构建】,本文代码开源于Github的【x-koa——组件化后端开发模板】,十分感谢对于本文的阅读,如有任何的疑问或者建议甚至批评,可以随时通过评论或私信联系我,我会第一时间回复