top.dcenter.ums.security.core.api.oauth.state.service

接口 Auth2StateCoder

public interface Auth2StateCoder

对 OAuth2 login 流程中的 state 进行自定义编解码. 可以传递必要的信息, 如: 第三方登录成功的跳转地址等.
注意此接口的两个方法必须同时实现对应的编解码逻辑, 实现此接口后注入 IOC 容器即可, 如有前端向后端获取 authorizeUrl 时向后端传递额外参数 且用作注册时的信息, 需配合 UserDetailsRegisterService.registerUser(AuthUser, String, String, String) 方法实现.
https://gitee.com/pcore/just-auth-spring-security-starter/issues/I22JC7

版本:

V2.0 Created by 2020/10/26 10:06

作者:

YongWu zheng

方法概要

限定符和类型	方法和说明
String	decode(String encoderState) 对 encoderState 进行解码
String	encode(String state, javax.servlet.http.HttpServletRequest request) 对 state 进行编码, 通过 HttpServletRequest, 方便对 OAuth2 login 过程中, 前端向后端获取 authorizeUrl 时 向后端传递额外的参数, 从而编码进 state 中, 在 OAuth2 login 流程中传递参数.

方法详细资料

encode

String encode(@NonNull
              String state,
              @NonNull
              javax.servlet.http.HttpServletRequest request)

对 state 进行编码, 通过 HttpServletRequest, 方便对 OAuth2 login 过程中, 前端向后端获取 authorizeUrl 时 向后端传递额外的参数, 从而编码进 state 中, 在 OAuth2 login 流程中传递参数.
注意: 对 state 进行对称编码时注意增加混淆逻辑, 以免信息泄露.

参数:

state - state 字符串, 如为未实现 Auth2DefaultRequest.generateState(), 默认传入的是 UUID

request - HttpServletRequest, 方便对 OAuth2 login 过程中, 前端向后端获取 authorizeUrl 时向后端传递额外参数, 从而编码进 state 中, 在 OAuth2 login 流程中传递参数.

返回:

返回编码后的 state

decode

String decode(@NonNull
              String encoderState)

对 encoderState 进行解码

参数:

encoderState - 编码后的 state

返回:

返回解码后的 state