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

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

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

相关推荐

十分钟让你学会LNMP架构负载均衡(impala负载均衡)

业务架构、应用架构、数据架构和技术架构一、几个基本概念1、pv值pv值(pageviews):页面的浏览量概念:一个网站的所有页面,在一天内,被浏览的总次数。(大型网站通常是上千万的级别)2、u...

AGV仓储机器人调度系统架构(agv物流机器人)

系统架构层次划分采用分层模块化设计,分为以下五层:1.1用户接口层功能:提供人机交互界面(Web/桌面端),支持任务下发、实时监控、数据可视化和报警管理。模块:任务管理面板:接收订单(如拣货、...

远程热部署在美团的落地实践(远程热点是什么意思)

Sonic是美团内部研发设计的一款用于热部署的IDEA插件,本文其实现原理及落地的一些技术细节。在阅读本文之前,建议大家先熟悉一下Spring源码、SpringMVC源码、SpringBoot...

springboot搭建xxl-job(分布式任务调度系统)

一、部署xxl-job服务端下载xxl-job源码:https://gitee.com/xuxueli0323/xxl-job二、导入项目、创建xxl_job数据库、修改配置文件为自己的数据库三、启动...

大模型:使用vLLM和Ray分布式部署推理应用

一、vLLM:面向大模型的高效推理框架1.核心特点专为推理优化:专注于大模型(如GPT-3、LLaMA)的高吞吐量、低延迟推理。关键技术:PagedAttention:类似操作系统内存分页管理,将K...

国产开源之光【分布式工作流调度系统】:DolphinScheduler

DolphinScheduler是一个开源的分布式工作流调度系统,旨在帮助用户以可靠、高效和可扩展的方式管理和调度大规模的数据处理工作流。它支持以图形化方式定义和管理工作流,提供了丰富的调度功能和监控...

简单可靠高效的分布式任务队列系统

#记录我的2024#大家好,又见面了,我是GitHub精选君!背景介绍在系统访问量逐渐增大,高并发、分布式系统成为了企业技术架构升级的必由之路。在这样的背景下,异步任务队列扮演着至关重要的角色,...

虚拟服务器之间如何分布式运行?(虚拟服务器部署)

  在云计算和虚拟化技术快速发展的今天,传统“单机单任务”的服务器架构早已难以满足现代业务对高并发、高可用、弹性伸缩和容错容灾的严苛要求。分布式系统应运而生,并成为支撑各类互联网平台、企业信息系统和A...

一文掌握 XXL-Job 的 6 大核心组件

XXL-Job是一个分布式任务调度平台,其核心组件主要包括以下部分,各组件相互协作实现高效的任务调度与管理:1.调度注册中心(RegistryCenter)作用:负责管理调度器(Schedule...

京东大佬问我,SpringBoot中如何做延迟队列?单机与分布式如何做?

京东大佬问我,SpringBoot中如何做延迟队列?单机如何做?分布式如何做呢?并给出案例与代码分析。嗯,用户问的是在SpringBoot中如何实现延迟队列,单机和分布式环境下分别怎么做。这个问题其实...

企业级项目组件选型(一)分布式任务调度平台

官网地址:https://www.xuxueli.com/xxl-job/能力介绍架构图安全性为提升系统安全性,调度中心和执行器进行安全性校验,双方AccessToken匹配才允许通讯;调度中心和执...

python多进程的分布式任务调度应用场景及示例

多进程的分布式任务调度可以应用于以下场景:分布式爬虫:importmultiprocessingimportrequestsdefcrawl(url):response=re...

SpringBoot整合ElasticJob实现分布式任务调度

介绍ElasticJob是面向互联网生态和海量任务的分布式调度解决方案,由两个相互独立的子项目ElasticJob-Lite和ElasticJob-Cloud组成。它通过弹性调度、资源管控、...

分布式可视化 DAG 任务调度系统 Taier 的整体流程分析

Taier作为袋鼠云的开源项目之一,是一个分布式可视化的DAG任务调度系统。旨在降低ETL开发成本,提高大数据平台稳定性,让大数据开发人员可以在Taier直接进行业务逻辑的开发,而不用关...

SpringBoot任务调度:@Scheduled与TaskExecutor全面解析

一、任务调度基础概念1.1什么是任务调度任务调度是指按照预定的时间计划或特定条件自动执行任务的过程。在现代应用开发中,任务调度扮演着至关重要的角色,它使得开发者能够自动化处理周期性任务、定时任务和异...

取消回复欢迎 发表评论: