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

Sa-Token v1.42.0 发布,新增 API Key、TOTP 验证码等能力

wptr33 2025-05-02 21:37 12 浏览

Sa-Token 是一款 免费开源 的轻量级 Java 权限认证框架,主要解决:登录认证权限认证单点登录OAuth2.0微服务网关鉴权 等一系列权限相关问题。

目前最新版本 v1.42.0 已推送至 Maven 中央仓库 ,大家可以通过如下方式引入:

<!-- Sa-Token 权限认证 -->
<dependency>
    <groupId>cn.dev33</groupId>
    <artifactId>sa-token-spring-boot-starter</artifactId>
    <version>1.42.0</version>
</dependency>

该版本包含大量 新增特性、底层重构、代码优化 等,下面容我列举几条比较重要的更新内容供大家参阅:

更新点1:新增 API Key 模块

如果你曾经对接过 ChatGPT、DeepSeek 等大模型平台的开放接口,那你一定对 API Key 不陌生。

API Key 是一种接口调用密钥,类似于会话 token ,但比会话 token 具有更灵活的权限控制。

本次更新带来了 API Key 的全流程管理,支持为指定账号签发、校验、禁用、删除 API Key 。
同时每个 API Key 都可以单独设置不同的 scope 权限,以便在不同的场景下使用不同的 API Key,做到秘钥相互隔离,最小化授权。

为了更好的展示此模块的能力,我们专门制作了一个 demo 示例:

sa-api-key

示例仓库地址:sa-token-demo-apikey

在这个示例中,你可以登录测试不同的账号,并为它们签发 API Key,设置 scope 权限,并使用不同的 API Key 测试调用接口,观察响应结果。

框架默认将所有 API Key 信息保存在缓存中,这可以称之为“缓存模式”,在这种模式下,重启缓存库后,数据将会丢失。

框架预留了 SaApiKeyDataLoader 接口,以便你将数据的加载切换为 “数据库模式”,做到数据长久有效保存。

在线文档直达地址:API Key 接口调用秘钥

更新点2:重构 TempToken 模块新增 value 反查机制

在 Sa-Token 文档中有一段这样的示例:

sa-refresh-token

该示例演示了如何通过临时 Token 认证模块,创建 RefreshToken 为登录会话做到双 Token 的效果。

但是有一天我在官网 sa-token 小助手接收到一位用户的咨询:

sa-refresh-token-wnglian-zixun

该用户指出,是否可以为 RefreshToken 提供反查机制,以便获取某个账号历史签发的 全部 RefreshToken

必须安排!

此次版本更新,允许程序在创建 refresh-token 时,指定第三个参数,该参数表示是否允许框架记录 Token 索引信息:

SaTempUtil.createToken("10001", 2592000, true);

指定为 false 代表不记录索引,只生成 token,指定为 true 代表记录索引信息,以便日后可以通过 value 反查历史签发的所有 token。

例如我们可以通过 SaTempUtil.getTempTokenList("xxx") 方法获取指定账号所有历史签发的 RefreshToken 记录:

List<String> refreshTokenList = SaTempUtil.getTempTokenList("10001");

在线文档直达地址:临时 Token 令牌认证

更新点3:新增 TOTP 算法实现

TOTP 是一种动态密码算法,用于生成短暂有效的数字验证码(通常6-8位)。它的核心原理是:结合密钥与当前时间,通过哈希运算生成一次性密码。

TOTP 一般有以下应用场景:

  • o 1、登录时的双因子认证:用户输入账号密码后还需要再输入 TOTP 验证码才可以登录成功。
  • o 2、敏感操作的二次认证:用户在进行一些高危敏感操作时,需要输入 TOTP 验证码才可以继续操作。
  • o 3、替代短信验证码:TOTP 验证码无需网络,可离线计算生成,一定程度上可以替代短信验证码验证身份。

本次版本新增了 TOTP 验证码的生成与校验功能,这将方便大家为自己的系统添加双因子认证能力。

更新点4:重构升级SaTokenContext上下文读写策略

这可能是近几个版本中最底层的一次重构,几乎完全推翻了之前上下文模块的设计。

在之前的版本中,Sa-Token 对接不同的 Web 框架需要利用这些 Web 框架的原生上下文能力来构建 Sa-Token 的上下文。

本次更新 Sa-Token 利用 ThreadLocal 实现了自己的上下文存储机制,这将带来以下好处:

  • o 1、可以更方便、更简单的对接更多的 Web 框架。
  • o 2、可在异步场景中临时 Mock 一个上下文,调用 Sa-Token 框架同步 API。
  • o 3、彻底删除了二级上下文模块,做到了 Web 请求与 RPC 请求的上下文统一。
  • o 4、在防火墙 hook 里也可以调用 Sa-Token 同步 API 了。

更新点5:新增CORS跨域策略处理函数,提供不同架构下统一的跨域处理方案

在之前的版本中,跨域处理总是要写在全局鉴权过滤器中,属于“鉴权之下的额外补充操作”。

新版本专门提供了一个 CORS 跨域处理策略组件,以后再也不用仅仅为了跨域就书写一个长长的鉴权过滤器组件了。

/**
 * CORS 跨域处理
 */
@Bean
public SaCorsHandleFunction corsHandle() {
    return (req, res, sto) -> {
        res.
                // 允许指定域访问跨域资源
                setHeader("Access-Control-Allow-Origin", "*")
                // 允许所有请求方式
                .setHeader("Access-Control-Allow-Methods", "POST, GET, OPTIONS, DELETE")
                // 有效时间
                .setHeader("Access-Control-Max-Age", "3600")
                // 允许的header参数
                .setHeader("Access-Control-Allow-Headers", "*");

        // 如果是预检请求,则立即返回到前端
        SaRouter.match(SaHttpMethod.OPTIONS)
                .free(r -> System.out.println("--------OPTIONS预检请求,不做处理"))
                .back();
    };
}

开源仓库示例:sa-token-demo-cross

更新点6:sa-token-quick-login插件支持Http Basic方式通过认证

sa-token-quick-login 可以快速、方便的为项目注入一个登录页面,当我们引入依赖后:

<dependency>
    <groupId>cn.dev33</groupId>
    <artifactId>sa-token-quick-login</artifactId>
    <version>1.42.0</version>
</dependency>

启动类:

@SpringBootApplication
public class SaTokenQuickDemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(SaTokenQuickDemoApplication.class, args);
        
        System.out.println("\n------ 启动成功 ------");
        System.out.println("name: " + SaQuickManager.getConfig().getName());
        System.out.println("pwd:  " + SaQuickManager.getConfig().getPwd());
    }
}

测试 Controller

@RestController
public class TestController {
    @RequestMapping({"/", "/index"})
    public String index() {
        String str = "<br />"
                + "<h1 style='text-align: center;'>资源页 (登录后才可进入本页面) </h1>"
                + "<hr/>"
                + "<p style='text-align: center;'> Sa-Token " + SaTokenConsts.VERSION_NO + " </p>";
        return str;
    }
}

启动项目,使用浏览器访问:http://localhost:8081,首次访问时,由于处于未登录状态,会被强制进入登录页面 :

登录

使用默认账号:sa / 123456进行登录,会看到资源页面

登录

新版本中更新了通过 Http Basic 的方式直接进行认证的能力:

http://sa:123456@localhost:8081/

这将非常有助于大家在专门的 API 测试工具下进行 quick-login 相关资源接口的测试。

完整更新日志

除了以上提到的几点以外,还有更多更新点无法逐一详细介绍,下面是 v1.42.0 版本的完整更新日志:

  • o core:
    • o 新增: 新增 API Key 模块。 [重要]
    • o 新增: 新增 TOTP 实现。 [重要]
    • o 重构:重构 TempToken 模块,新增 value 反查 token 机制。 [重要]
    • o 升级: 重构升级 SaTokenContext 上下文读写策略。 [重要]
    • o 新增: 新增 Mock 上下文模块。 [重要]
    • o 删除: 删除二级上下文模块。
    • o 新增: 新增异步场景使用 demo。 [重要]
    • o 新增: 新增 Base32 编码工具类。
    • o 新增:新增 CORS 跨域策略处理函数,提供不同架构下统一的跨域处理方案。
    • o 新增:renewTimeout 续期方法增加 token 终端信息有效性校验。
    • o 新增: 全局配置项 cookieAutoFillPrefix:cookie 模式是否自动填充 token 前缀。
    • o 新增: 全局配置项 rightNowCreateTokenSession:在登录时,是否立即创建对应的 Token-Session
    • o 优化:优化 Token-Session 获取算法,减少缓存读取次数。
    • o 新增:SaLoginParameter 支持配置 SaCookieConfig,以配置 Cookie 相关参数。
    • o 修改:防火墙校验过滤器的注册顺序 修改为 -102。
    • o 新增:防火墙 hook 注册新增 registerHookToFirstregisterHookToSecond 方法,以便更灵活的控制 hook 顺序。
  • o 插件:
    • o 新增: sa-token-quick-login 插件支持 Http Basic 方式通过认证。
  • o 单元测试:
    • o 补全:补全 Temp Token 模块单元测试。
  • o 文档:
    • o 补全:补全赞助者名单。
    • o 修复:修复 Thymeleaf 集成文档不正确的依赖示例说明。
    • o 修复:修复 unionid 章节错误描述。
    • o 优化:采用更细致的描述优化SSO模式三单点注销步骤。
    • o 新增:登录认证文档添加 Cookie 查看步骤演示图。
    • o 新增:多账号模式新增注意点:运行时不可更改 LoginType
    • o 新增: 多账号模式QA:在一个接口里获取是哪个体系的账号正在登录。
    • o 新增:新增QA:解决低版本 SpringBoot (<2.2.0) 引入 Sa-Token 报错的问题。
    • o 新增:新增QA:前后端一体项目下,在拦截未登录进入登录页面时,如何登录完成后原路返回?
    • o 新增:新增QA:Sa-Token 集成 Redis 如何集群?
    • o 新增:新增QA:如何自定义框架读取 token 的方式?
    • o 新增:新增QA:修改 hosts 文件无效可能原因排查。
    • o 新增:新增QA:如何防止 CSRF 攻击。
    • o 新增: “异步 & Mock 上下文” 章节。
    • o 升级:升级“自定义 SaTokenContext 指南”章节文档。

更新日志在线文档直达链接:https://sa-token.cc/doc.html#/more/update-log

其它

代码仓库地址:https://gitee.com/dromara/sa-token

框架功能结构图:

js

相关推荐

每天一个编程技巧!掌握这7个神技,代码效率飙升200%

“同事6点下班,你却为改BUG加班到凌晨?不是你不努力,而是没掌握‘偷懒’的艺术!本文揭秘谷歌工程师私藏的7个编程神技,每天1分钟,让你的代码从‘能用’变‘逆天’。文末附《Python高效代码模板》,...

Git重置到某个历史节点(Sourcetree工具)

前言Sourcetree回滚提交和重置当前分支到此次提交的区别?回滚提交是指将改动的代码提交到本地仓库,但未推送到远端仓库的时候。...

git工作区、暂存区、本地仓库、远程仓库的区别和联系

很多程序员天天写代码,提交代码,拉取代码,对git操作非常熟练,但是对git的原理并不甚了解,借助豆包AI,写个文章总结一下。Git的四个核心区域(工作区、暂存区、本地仓库、远程仓库)是版本控制的核...

解锁人生新剧本的密钥:学会让往事退场

开篇:敦煌莫高窟的千年启示在莫高窟321窟的《降魔变》壁画前,讲解员指着斑驳色彩说:"画师刻意保留了历代修补痕迹,因为真正的传承不是定格,而是流动。"就像我们的人生剧本,精彩章节永远...

Reset local repository branch to be just like remote repository HEAD

技术背景在使用Git进行版本控制时,有时会遇到本地分支与远程分支不一致的情况。可能是因为误操作、多人协作时远程分支被更新等原因。这时就需要将本地分支重置为与远程分支的...

Git恢复至之前版本(git恢复到pull之前的版本)

让程序回到提交前的样子:两种解决方法:回退(reset)、反做(revert)方法一:gitreset...

如何将文件重置或回退到特定版本(怎么让文件回到初始状态)

技术背景在使用Git进行版本控制时,经常会遇到需要将文件回退到特定版本的情况。可能是因为当前版本出现了错误,或者想要恢复到之前某个稳定的版本。Git提供了多种方式来实现这一需求。...

git如何正确回滚代码(git命令回滚代码)

方法一,删除远程分支再提交①首先两步保证当前工作区是干净的,并且和远程分支代码一致$gitcocurrentBranch$gitpullorigincurrentBranch$gi...

[git]撤销的相关命令:reset、revert、checkout

基本概念如果不清晰上面的四个概念,请查看廖老师的git教程这里我多说几句:最开始我使用git的时候,我并不明白我为什么写完代码要用git的一些列指令把我的修改存起来。后来用多了,也就明白了为什么。gi...

利用shell脚本将Mysql错误日志保存到数据库中

说明:利用shell脚本将MYSQL的错误日志提取并保存到数据库中步骤:1)创建数据库,创建表CreatedatabaseMysqlCenter;UseMysqlCenter;CREATET...

MySQL 9.3 引入增强的JavaScript支持

MySQL,这一广泛采用的开源关系型数据库管理系统(RDBMS),发布了其9.x系列的第三个更新版本——9.3版,带来了多项新功能。...

python 连接 mysql 数据库(python连接MySQL数据库案例)

用PyMySQL包来连接Python和MySQL。在使用前需要先通过pip来安装PyMySQL包:在windows系统中打开cmd,输入pipinstallPyMySQL ...

mysql导入导出命令(mysql 导入命令)

mysql导入导出命令mysqldump命令的输入是在bin目录下.1.导出整个数据库  mysqldump-u用户名-p数据库名>导出的文件名  mysqldump-uw...

MySQL-SQL介绍(mysql sqlyog)

介绍结构化查询语言是高级的非过程化编程语言,允许用户在高层数据结构上工作。它不要求用户指定对数据的存放方法,也不需要用户了解具体的数据存放方式,所以具有完全不同底层结构的不同数据库系统,可以使用相同...

MySQL 误删除数据恢复全攻略:基于 Binlog 的实战指南

在MySQL的世界里,二进制日志(Binlog)就是我们的"时光机"。它默默记录着数据库的每一个重要变更,就像一位忠实的史官,为我们在数据灾难中提供最后的救命稻草。本文将带您深入掌握如...