JAP 1.0.2 正式发布
概要
1.0.2 支持多租户场景、支持动态
jap-ids
、支持前后端分离的业务场景;
issuer
对外提供
jap-social
、
refreshToken
和
revokeToken
方法;
getUserInfo
- 新增
模式,支持自定义部分业务场景的流程,同时引入
Pipeline
机制;
SPI
- 基于 Github Action,JAP 正式启用快照版,比如:
。(快照版实时更新,但不可用于生产环境)
1.0.2-SNAPSHOT
- 使用
管理项目版本依赖,使用
jap-bom
简化 pom 版本
flatten-maven-plugin
- JustAuth 和 JAP 项目已经加入 “开源软件供应链点亮计划 - 暑期2021”,欢迎各位在校学生踊跃参与!可在“码一码”公众号中回复 “summer” 获取活动详情。
JAP 1.0.2 版本更新内容
本次更新涉及到字段、方法返回类型的修改,请升级的时候注意。可以参照本文下方的更新说明进行修改、调整。
新功能/特性
jap-ids 模块
- 在
中添加IdsConfig
属性,enableDynamicIssuer
类型。当boolean
时,开发者不再需要单独设置enableDynamicIssuer=true
,issuer
将从当前请求的域名中自动提取jap-ids
。issuer
此功能针对客户端支持的业务场景。可以通过域名的标识(比如二级域名
自定义域名
中的标识就是
jap.justauth.plus
)确定用户所属的客户端(也可以对应到租户)。
jap
- 在
中添加IdsConfig
属性,loginPageUrl
与loginPageUrl
的区别:loginUrl
:登录表单页面 URL,关键字:页面。
loginPageUrl
:登录的api URL,关键字:API。
loginUrl
- 在
中添加IdsConfig
属性,externalLoginPageUrl
类型。boolean
如果授权服务未提供登录页面(登录页面由其他服务托管,比如登录页面在单独的静态服务中部署),则需要启用此配置。
- 在
中添加IdsConfig
属性,externalConfirmPageUrl
类型。boolean
如果授权服务未提供授权确认页面(授权确认页面由其他服务托管,比如授权确认页面在单独的静态服务中部署),则需要启用此配置。
- 在
中添加IdsConfig
属性。authorizeAutoApproveUrl
当授权 URL 中包含时,授权服务器在用户登录完成后,不会跳转到
autoapprove=true
,而是直接跳转到
confirmPageUrl
。
authorizeAutoApproveUrl
- 添加
接口类,以支持登录后对用户数据的自定义操作,默认为IdsUserStoreService
存储用户信息。感谢微信用户(antscqy)的建议。Session
- 添加
接口,开发人员可以自定义流程,目前仅支持自定义IdsPipeline
(过滤器)和IdsxxFilter
的流程。LoginEndpoint
- 添加
插件机制,spi
对外提供的接口,都可以以jap-ids
的形式实现。spi
- 添加以下内置 scope:
,profile
,address
andread
。write
- 在
中添加OauthUtil#createAuthorizeUrl(String, IdsRequestParam)
参数(可选的参数)。uid
jap-social 模块
-
对外提供SocialStrategy
、refreshToken
和revokeToken
方法。感谢群友的反馈。getUserInfo
修改
POM 依赖
- 将
依赖替换为javax.servlet-api
。jakarta.servlet-api
jap-ids 模块
- 将
参数名称修改为IdsConfig.confirmUrl
。confirmPageUrl
- 将
的返回类型修改为ApprovalEndpoint#getAuthClientInfo(HttpServletRequest)
。IdsResponse<String, Map<String, Object>>
- 将
的返回类型修改为Ap provalEndpoint#authorize(HttpServletRequest)
。IdsResponse<String, String>
- 将
的返回类型修改为AuthorizationEndpoint#agree(HttpServletRequest)
。IdsResponse<String, String>
- 将
的返回类型修改为LoginEndpoint#signin(HttpServletRequest)
。IdsResponse<String, String>
- 将
的返回类型修改为LogoutEndpoint#logout(HttpServletRequest)
。IdsResponse<String, String>
- 修改
类的注释。ClientDetail
- 将
方法的返回类型修改为泛型。IdsResponse#getData()
- 删除
方法,不再允许重置系统内置的 scope,新版IdsScopeProvider#initScopes(List<IdsScope>)
支持添加新的jap-ids
以及 修改内置的scope
描述。scope
- 当
时,response_type=id_token
中将返回用户的基本信息(依据id_token
授权范围)。scope
- 优化
方法的业务流程,对于用户的特定属性,比如手机号、邮箱等,按照提供的UserInfoEndpoint#getCurrentUserInfo(HttpServletRequest)
决定是否返回。scope
- 修改
接口的IdsUserService
和loginByUsernameAndPassword
方法,分别新增了getByName
入参。clientId
针对多租户场景下,同一个用户可能存在多个租户主体下,单纯依靠用户账密已经无法唯一确定一个用户,这种情况下业务系统可以根据 clientId
获取具体的租户下的用户信息。
PR
- 合并 Gitee PR #11 by @dreamlu。使用
简化 pom 版本flatten-maven-plugin
- 合并 Gitee PR #12 by @sywd。添加
管理项目版本依赖jap-bom
- 合并 Gitee PR #13 by @dreamlu。代码优化,方便作为 Spring bean 初始化
- 合并 Gitee PR #14 by @dreamlu。优化 pom 配置,修复
导入问题jap-bom
关于 JAP
JAP 是什么?
JAP 是一款开源的登录认证中间件,基于模块化设计,为所有需要登录认证的 WEB 应用提供一套标准的技术解决方案,开发者可以基于 JAP 适配绝大多数的 WEB 系统(自有系统、联邦协议)。
JAP 有哪些功能?
JAP 有什么优势?
- 易用性:JAP 的 API 沿袭 JustAuth 的简单性,做到了开箱即用的程度。JAP 高度抽象各种登录场景,提供了多套简单使用的 API,极大程度的降低了开发者的学习成本和使用成本
- 全面性:JAP 全量适配 JustAuth 支持的第三方平台,实现第三方登录。同时也支持所有基于标准OAuth2.0 协议或者 OIDC 协议或者 SAML 协议的应用、系统,同时 JAP 还提供不同语言版本的项目 SDK,适配多种研发场景
- 模块化:JAP 基于模块化设计开发,针对每一种登录场景,比如账号密码、OAuth、OIDC等,都单独提供了独有的模块化解决方案
- 标准化:JAP 和业务完全解耦,将登录认证相关的逻辑抽象出一套标准的技术解决方案,针对每一种业务场景,比如用户登录、验证密码、创建并绑定第三方系统的账号等,都提供了一套标准的策略或者接口,开发者可以基于 JAP,灵活并方便的完成相关业务逻辑的开发和适配
- 通用性:JAP 不仅可以用到第三方登录、OAuth授权、OIDC认证等业务场景,还能适配开发者现有的业务系统的普通账号密码的登录场景,基本将所有登录相关的业务场景都已经涵盖。针对 WEB 应用,JAP 将提供满足各种不同登录场景的解决方案(和开发语言无关)
JAP 适用于哪些场景?
JAP 适用于所有需要登录认证功能的场景。比如:
- 要求规范:新项目立项,你们需要研发一套包含登录、认证的系统,并且从长远方面考虑,你们需要一套标准的、灵活的、功能全面的登录认证功能。
- 需求灵活:现有登录模块为自研,但是新一轮的技术规划中,你们想将登录认证模块重构,以更加灵活的架构适应后面的新需求,比如:集成 MFA 登录、集成 OAuth 登录、SAML登录等。
-
力求省事:你们的项目太多(或者是开发语言较多,比如:Java、Python、Node 等),每个项目都需要登录认证模块,想解决这种重复劳动的问题,使研发人员有更多的时间和精力投入到业务开发中,提高研发产能和研发效率。
关于 JAP 的更多内容,可以参考《JAP 产品技术白皮书》
相关链接
- Gitee:https://gitee.com/fujieid/jap
- Github:https://github.com/fujieid/jap
- CodeChina:https://codechina.csdn.net/fujieid/jap
- 开发者文档:https://justauth.plus