百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

Koa开发之koa-jwt工作过程(koa jwt2)

ccwgpt 2024-09-21 13:37 32 浏览 0 评论

最近的工作是开发一个分布式的服务系统,选用的环境是node开发环境,由于需要全面的进行异步开发所以使用Koa框架,开发Web服务需要对用户进行身份认证,所以就使用koa-jwt,为什么使用token这种方式网上有很多介绍token和session的区别我这里就不再赘述了。在给大家演示代码之前我在这一章主要是介绍koa-jwt的工作流程在后面的一章中我将使用程序对大家进行演示。

首先我在这附上koa-jwt的源代码,然后为大家剖析其的工作流程。

源程序

koa-jwt的源程序的主程序在lib/index.js中

'use strict';

const pAny = require('p-any');
const unless = require('koa-unless');
const verify = require('./verify');
const getSecret = require('./get-secret');
const resolveAuthHeader = require('./resolvers/auth-header');
const resolveCookies = require('./resolvers/cookie');

module.exports = (opts = {}) => {
    const { debug, getToken, isRevoked, key = 'user', passthrough, tokenKey } = opts;
    const tokenResolvers = [resolveCookies, resolveAuthHeader];

    if (getToken && typeof getToken === 'function') {
        tokenResolvers.unshift(getToken);
    }

    const middleware = async function jwt(ctx, next) {
        let token;
        tokenResolvers.find(resolver => token = resolver(ctx, opts));

        if (!token && !passthrough) {
            ctx.throw(401, debug ? 'Token not found' : 'Authentication Error');
        }

        let { state: { secret = opts.secret } } = ctx;

        try {
            if (typeof secret === 'function') {
                secret = await getSecret(secret, token);
            }
            
            if (!secret) {
                throw new Error('Secret not provided');
            }

            let secrets = Array.isArray(secret) ? secret : [secret];
            const decodedTokens = secrets.map(async s => await verify(token, s, opts));

            const decodedToken = await pAny(decodedTokens)
                .catch(function (err) {
                    if (err instanceof pAny.AggregateError) {
                        for (const e of err) {
                            throw e;
                        }
                    } else {
                        throw err;
                    }
                });

            if (isRevoked) {
                const tokenRevoked = await isRevoked(ctx, decodedToken, token);
                if (tokenRevoked) {
                    throw new Error('Token revoked');
                }
            }

            ctx.state[key] = decodedToken;
            if (tokenKey) {
                ctx.state[tokenKey] = token;
            }

        } catch (e) {
            if (!passthrough) {
                const msg = debug ? e.message : 'Authentication Error';
                ctx.throw(401, msg, { originalError: e });
            }else{ 
                ctx.state.jwtOriginalError = e;
            }
        }

        return next();
    };

    middleware.unless = unless;
    return middleware;
};

2可配置参数

koa-jwt的可配置参数有debug,getToken,isRevoked,key,passthrough,tokenKey,secret,cookie

2.1debug参数

debug参数数据类型应该是Boolean类型,用于表示是否处于调试状态,如果不是处于调试状态返回的错误参数为Authentication Error如果处于调试状态将会返回具体的错误原因。

2.2getToken参数

getToken参数数据类型应该是函数类型,为用户自定义的获取请求token的函数,如果没有定义此参数将会从请求头的authorization字段或者是cookie中的指定字段获取token。

2.3isRevoked参数

isRevoked参数的数据类型为函数类型,为用户自定义的token是否失效的函数,如果没有定义此参数将不进行token失效处理。

2.4key参数

key参数的数据类型应该是string类型,将属性名为key的属性设置到ctx.state对象中,同时其属性值为解密的token的值,默认值为user。

2.5passthrough参数

passthrough参数的数据类型应该是Boolean类型,此参数用于对身份认证出现错误的时候是否直接抛出错误,如果此参数的值为真在身份认证过程中将不会直接抛出错误而是继续执行后面的程序,如果此参数值为假江湖在出现错误的地方将错误抛出。

2.6tokenKey参数

tokenKey参数的数据类型应该为string类型,其作用与key的作用类型,将属性名为tokenKey的属性设置到ctx.state对象中,同时其属性值为获取token的方法。默认此参数为undefined。

2.7secret参数

secret参数的数据类型为函数类型返回值为字符串类型,或者直接是字符串类型,如果没有定义此参数将会报错所以此属性为必要参数。此参数的作用是解密的秘钥。

2.8cookie参数

cookie参数的数据类型应该是字符串类型,用于指定从cookie中获取token的指定的属性名称。

3Koa-jwt的工作流程

Koa-jwt的工作流程如下图所示


从源程序和流程图我们可以看到koa-jwt的处理过程为:

(1)获取用户的配置参数。

(2)设置获取默认token的函数,如果用户定义了getToken方法将此方法放在获取token方法数组的第一位。

(3)调用获取token方法数组中的方法直到获取到token或者是遍历完数组。

(4)判断是否获取到token,如果获取到执行后面的过程,如果没有获取到抛出错误。

(5)判断secret的类型是否是函数如果是函数,调用此函数存入的值为头部数据和载荷数据返回字符串型的秘钥。

(6)判断秘钥是否为真,对于为真的执行后面的参数,对于不为真的抛出错误。

(7)根据秘钥判断token是否正确,对于token正确的执行后面的过程,对于token不正确的抛出错误。

(8)根据是否定义失效处理函数,如果定义失效处理函数,对此token进行失效判断,如果失效抛出错误,对于未失效继续处理后面的内容。

(9)根据定义key参数设置ctx.state的key属性的值为获取的解密的token

(10)根据用户是否定义tokenKey设置ctx.state的tokenKey属性的值为获取token的函数。

(11)执行后面的组件

相关推荐

土豪农村建个别墅不新鲜 建个车库都用框架结构?

农村建房子过去都是没车库,也没有那么多豪车,一般直接停在路边或者院子里。现在很多人都会在建房子的时候留一个车库,通过车库可以直接进入客厅,省得雨雪天气折腾。农村土豪都是有钱任性,建房子跟我们普通人不一...

自建框架结构出现裂缝怎么回事?

三层自建房梁底与墙体连接处裂缝是结构问题吗?去前帮我姑画了一份三层自建房的图纸,前天他们全部装修好了。我姑丈突然打电话给我说他发现二层的梁底与墙分离了,有裂缝。也就是图纸中前面8.3米那跨梁与墙体衔接...

钢结构三维图集-框架结构(钢柱对接)

1、实腹式钢柱对接说明1:1.上节钢柱的安装吊点设置在钢柱的上部,利用四个吊点进行吊装;2.吊装前,下节钢柱顶面和本节钢柱底面的渣土和浮锈要清除干净,保证上下节钢柱对接面接触顶紧;3.钢柱吊装到位后...

三层框架结构主体自建房设计案例!布局13*12米占地面积156平米!

绘创意设计乡村好房子设计小编今日头条带来分享一款:三层框架结构主体自建房设计案例!布局13*12米占地面积156平米!本案例设计亮点:这是一款三层新中式框架结构自建房,占地13×12米,户型占地面积...

Casemaker机箱框架结构3D图纸 STEP格式

农村自建房新宠!半框架结构凭啥这么火?内行人揭开3个扎心真相

回老家闲逛,竟发现个有意思的现象:村里盖新房,十家有八家都选了"半框架结构"。隔壁王叔家那栋刚封顶的二层小楼,外墙红砖还露着糙面没勾缝,里头的水泥柱子倒先支棱得笔直,这到底是啥讲究?蹲...

砖混结构与框架结构!究竟有何区别?千万别被坑!

农村自建房选结构,砖混省钱但出事真能保命吗?7月建材价格波动期,多地建房户因安全焦虑陷入选择困境——框架结构虽贵30%,却是地震区保命的关键。框架柱和梁组成的承重体系,受力分散得像一张网。砖混靠墙硬扛...

砖混结构与框架结构,究竟有何区别?千万别被坑!

农村建房选砖混结构还是框架结构?这个问题算是近期留言板里问得最多的问题了。今天咱们说说二者的区别,帮您选个合适的。01成本区别假如盖一栋砖混结构的房子需要30万,那么换成框架结构,一般要多掏30%的费...

6个小众却逆天的App神器,个个都是黑科技的代表

你的手机上有哪些好用的软件?今天我就给大家分享6个小众却逆天的App神器,个个都是黑科技的代表!01*Via浏览器推荐理由:体积极小的浏览器,没有任何广告。使用感受:它的体量真的很小,只有702KB,...

合肥App开发做一个app需要多少钱?制作周期有多久?

在移动互联网时代,开发一款APP已成为企业数字化转型与个人创业的重要途径。然而,APP的开发成本与制作周期受功能复杂度、技术架构、团队类型等多重因素影响,差异极大。好牛软件将从这两个维度展开分析,帮助...

详解应对App臃肿化的五大法则

编者注:本文转自腾讯ISUX。先来看一张图:图上看到,所有平台上用户花费时间都在减少,除了移动端。观察身边也是如此,回家不开电脑的小伙伴越来越多。手机平板加电视,下班场景全搞定。连那些以前电脑苦手的...

实战!如何从零搭建10万级 QPS 大流量、高并发优惠券系统

需求背景春节活动中,多个业务方都有发放优惠券的需求,且对发券的QPS量级有明确的需求。所有的优惠券发放、核销、查询都需要一个新系统来承载。因此,我们需要设计、开发一个能够支持十万级QPS的券系...

8种移动APP导航设计模式大对比

当我们确定了移动APP的设计需求和APP产品设计流程之后,开始着手设计APP界面UI或是APP原型图啦。这个时候我们都要面临的第一个问题就是如何将信息以最优的方式组合起来?也许我们对比和了解了其他一些...

数字资产支付 App 的技术框架

开发一款功能强大、安全可靠的数字资产支付App需要一个整合了区块链技术、后端服务、前端应用以及第三方集成的全栈技术框架。这个框架的核心在于保障数字资产的安全流通,并将其高效地桥接到传统的法币支付场...

从MyBatis到App架构:设计模式全景应用指南

从MyBatis到App架构:设计模式全景应用指南引言在企业级应用和服务端开发领域,MyBatis凭借其灵活、简洁、强大的ORM映射能力被广泛应用。而它之所以能拥有如此优秀的可扩展性和工程可维护性,正...

取消回复欢迎 发表评论: