Koa2 权限认证中间件-----Passport

Koa集成权限认证中间件之Passport

前言

       你还在为koa2的权限管理问题烦恼吗?那么这篇文章你解决的忧愁!!! 对于express框架的权限框架passport大家可能不陌生,但是koa2的权限管理中间件缺很少,尤其是最2.0版本以上Koa，其生态目前完全出于一个起步阶段，对比目前express大量稳定可用的中间件，的确是有许多的不足。但是开源的力量永远是最强大的，只要有需求，就一定有解决方案,这时就诞生了koa-passport

思路

1、对于passport中间件的官方只是提供了对express的支持。但是相对应的，koa也有其对应的开源集成版本——【koa-passport】

2、koa-passport本质上并非全新实现的另外一个版本的passport，它仅仅只是作为中间件，将原先passport对express的支持，转移到了koa上。通过分析其源码可以看出，它其实是将原先绑定在express的req和res中的API方法，重新绑定到了koa的ctx中

3、让人吐槽的地方是koa-passport的官方文档很详细的使用方法和说明，直接使用官方提供的demo :koa-passport-example项目，如果不加以修改，是无法完成认证功能的,虽然是google和baidu了大量资料，但是很遗憾，目前似乎并没有太多关于这两者的集成文章，相关的都是比较老版本的文章或者是经过实践并没有生效的文章，并没有太多的参考价值

故借此机会将分析koa-passport和passport的源码得到的成果分享给大家

步骤

第一，安装koa-passport

npm install koa-bodyparser --savenpm install passport --savenpm install passport-local --savenpm install koa-passport --savenpm 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()))