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

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

ccwgpt 2024-09-21 13:37 21 浏览 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)执行后面的组件

相关推荐

迈向群体智能 | 智源发布首个跨本体具身大小脑协作框架

允中发自凹非寺量子位|公众号QbitAI3月29日,智源研究院在2025中关村论坛“未来人工智能先锋论坛”上发布首个跨本体具身大小脑协作框架RoboOS与开源具身大脑RoboBrain,可实...

大模型对接微信个人号,极空间部署AstrBot机器人,万事不求百度

「亲爱的粉丝朋友们好啊!今天熊猫又来介绍好玩有趣的Docker项目了,喜欢的记得点个关注哦!」引言前两天熊猫发过一篇关于如何在极空间部署AstrBot并对接QQ消息平台的文章,不过其实QQ现在已经很少...

Seata,让分布式事务不再是难题!实战分享带你领略Seata的魅力!

终身学习、乐于分享、共同成长!前言Seata是一款开源的分布式事务解决方案,致力于提供高性能和简单易用的分布式事务服务。Seata将为用户提供了AT、TCC、SAGA和XA事务模式,为用户打造一站式的...

常见分布式事务解决方案(分布式事务解决的问题)

1.两阶段提交(2PC)原理:分为准备阶段(协调者询问参与者是否可提交)和提交阶段(协调者根据参与者反馈决定提交或回滚)。优点:强一致性,适用于数据库层(如XA协议)。缺点:同步阻塞:所有参与者阻塞...

分布式事务:从崩溃到高可用,程序员必须掌握的实战方案!

“支付成功,但订单状态未更新!”、“库存扣减后,交易却回滚了!”——如果你在分布式系统中踩过这些“天坑”,这篇文章就是你的救命稻草!本文将手把手拆解分布式事务的核心痛点和6大主流解决方案,用代码实战+...

谈谈对分布式事务的一点理解和解决方案

分布式事务首先,做系统拆分的时候几乎都会遇到分布式事务的问题,一个仿真的案例如下:项目初期,由于用户体量不大,订单模块和钱包模块共库共应用(大war包时代),模块调用可以简化为本地事务操作,这样做只要...

一篇教你通过Seata解决分布式事务问题

1 Seata介绍Seata是由阿里中间件团队发起的开源分布式事务框架项目,依赖支持本地ACID事务的关系型数据库,可以高效并且对业务0侵入的方式解决微服务场景下面临的分布式事务问题,目前提供AT...

Seata分布式事务详解(原理流程及4种模式)

Seata分布式事务是SpringCloudAlibaba的核心组件,也是构建分布式的基石,下面我就全面来详解Seata@mikechen本篇已收于mikechen原创超30万字《阿里架构师进阶专题合...

分布式事务最终一致性解决方案有哪些?MQ、TCC、saga如何实现?

JTA方案适用于单体架构多数据源时实现分布式事务,但对于微服务间的分布式事务就无能为力了,我们需要使用其他的方案实现分布式事务。1、本地消息表本地消息表的核心思想是将分布式事务拆分成本地事务进行处理...

彻底掌握分布式事务2PC、3PC模型(分布式事务视频教程)

原文:https://mp.weixin.qq.com/s/_zhntxv07GEz9ktAKuj70Q作者:马龙台工作中使用最多的是本地事务,但是在对单一项目拆分为SOA、微服务之后,就会牵扯出分...

Seata分布式事务框架关于Annotation的SAGA模式分析

SAGAAnnotation是ApacheSeata版本2.3.0中引入的功能,它提供了一种使用Java注解而不是传统的JSON配置或编程API来实现SAGA事务模式的声明...

分布式事务,原理简单,写起来全是坑

今天我们就一起来看下另一种模式,XA模式!其实我觉得seata中的四种不同的分布式事务模式,学完AT、TCC以及XA就够了,Saga不好玩,而且长事务本身就有很多问题,也不推荐使用。S...

内存空间节约利器redis的bitmap(位图)应用场景有哪些你知道吗

在前面我们分享过一次Redis常用数据结构和使用场景,文章对Redis基本使用做了一个简单的API说明,但是对于其中String类型中的bitmap(位图)我们需要重点说明一下,因为他的作用真的不容忽...

分布式事务原理详解(图文全面总结)

分布式事务是非常核心的分布式系统,也是大厂经常考察对象,下面我就重点详解分布式事务及原理实现@mikechen本文作者:陈睿|mikechen文章来源:mikechen.cc分布式事务分布式事务指的是...

大家平时天天说的分布式系统到底是什么东西?

目录从单块系统说起团队越来越大,业务越来越复杂分布式出现:庞大系统分而治之分布式系统所带来的技术问题一句话总结:什么是分布式系统设计和开发经验补充说明:中间件系统及大数据系统前言现在有很多Java技术...

取消回复欢迎 发表评论: