com.baomidou.kisso

类 SSOHelper

java.lang.Object

com.baomidou.kisso.SSOHelper

public class SSOHelper
extends Object

SSO 帮助类

作者:

hubin

字段概要

字段

限定符和类型	字段和说明
protected static ConfigurableAbstractKissoService	kissService
protected static Logger	logger

构造器概要

构造器

构造器和说明
SSOHelper()

方法概要

方法

限定符和类型	方法和说明
static AuthToken	askCiphertext(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String privateKey) 生成跨域询问票据
static <T extends Token> T	attrToken(javax.servlet.http.HttpServletRequest request) 从请求中获取 token 通过登录拦截器之后使用 该数据为登录拦截器放入 request 中，防止二次解密
static boolean	clearLogin(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 清理当前登录状态 清理 Cookie、缓存、统计、等数据
static void	clearRedirectLogin(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 退出重定向登录页，跳至 sso.properties 配置的属性 sso.login.url 地址
static String	getLoginCount(javax.servlet.http.HttpServletRequest request) 当前登录人总数（合计多少个）
static String	getSecretKey() 生成 18 位随机字符串密钥 替换配置文件 sso.properties 属性 sso.secretkey=随机18位字符串
static Token	getToken(javax.servlet.http.HttpServletRequest request) 获取当前请求 token 该方法直接从 cookie 中解密获取 token, 常使用在登录系统及拦截器中使用 getToken(request) 如果该请求在登录拦截器之后请使用 attrToken(request) 防止二次解密
static String	getTokenCacheKey(javax.servlet.http.HttpServletRequest request) 获取 token 的缓存主键
static void	logout(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) 退出登录， 并且跳至 sso.properties 配置的属性 sso.logout.url 地址
static AuthToken	ok(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String replyData, String atPk, String ssoPrk) 验证回复密文，成功!
static AuthToken	replyCiphertext(javax.servlet.http.HttpServletRequest request, String askData) 生成跨域回复票据
static void	setSSOCookie(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Token token, boolean invalidate) 设置加密 Cookie（登录验证成功） 最后一个参数 true 销毁当前JSESSIONID.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

logger

protected static final Logger logger

kissService

protected static ConfigurableAbstractKissoService kissService

构造器详细资料

SSOHelper

public SSOHelper()

方法详细资料

getSecretKey

public static String getSecretKey()

生成 18 位随机字符串密钥

替换配置文件 sso.properties 属性 sso.secretkey=随机18位字符串

getLoginCount

public static String getLoginCount(javax.servlet.http.HttpServletRequest request)

当前登录人总数（合计多少个）

参数:

request -

返回:

setSSOCookie

public static void setSSOCookie(javax.servlet.http.HttpServletRequest request,
                javax.servlet.http.HttpServletResponse response,
                Token token,
                boolean invalidate)

设置加密 Cookie（登录验证成功）

最后一个参数 true 销毁当前JSESSIONID. 创建可信的 JSESSIONID 防止伪造 SESSIONID 攻击

最后一个参数 false 只设置 cookie

request.setAttribute(SSOConfig.SSO_COOKIE_MAXAGE, -1); 可以设置 Cookie 超时时间 ，默认读取配置文件数据 。 -1 浏览器关闭时自动删除 0 立即删除 120 表示Cookie有效期2分钟(以秒为单位)

参数:

request -

response -

token - SSO 票据

invalidate - 销毁当前 JSESSIONID

getToken

public static Token getToken(javax.servlet.http.HttpServletRequest request)

获取当前请求 token

该方法直接从 cookie 中解密获取 token, 常使用在登录系统及拦截器中使用 getToken(request)

如果该请求在登录拦截器之后请使用 attrToken(request) 防止二次解密

参数:

request -

返回:

attrToken

public static <T extends Token> T attrToken(javax.servlet.http.HttpServletRequest request)

从请求中获取 token 通过登录拦截器之后使用

该数据为登录拦截器放入 request 中，防止二次解密

参数:

request - 访问请求

返回:

logout

public static void logout(javax.servlet.http.HttpServletRequest request,
          javax.servlet.http.HttpServletResponse response)
                   throws IOException

退出登录， 并且跳至 sso.properties 配置的属性 sso.logout.url 地址

参数:

request -

response -

抛出:

IOException

clearLogin

public static boolean clearLogin(javax.servlet.http.HttpServletRequest request,
                 javax.servlet.http.HttpServletResponse response)

清理当前登录状态

清理 Cookie、缓存、统计、等数据

参数:

request -

response -

返回:

clearRedirectLogin

public static void clearRedirectLogin(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
                               throws IOException

退出重定向登录页，跳至 sso.properties 配置的属性 sso.login.url 地址

参数:

request -

response -

抛出:

IOException

getTokenCacheKey

public static String getTokenCacheKey(javax.servlet.http.HttpServletRequest request)

获取 token 的缓存主键

参数:

request - 当前请求

返回:

askCiphertext

public static AuthToken askCiphertext(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response,
                      String privateKey)

生成跨域询问票据

参数:

request -

response -

privateKey - RSA 私钥（业务系统私钥，用于签名）

返回:

AuthToken AuthToken

replyCiphertext

public static AuthToken replyCiphertext(javax.servlet.http.HttpServletRequest request,
                        String askData)

生成跨域回复票据

参数:

authToken - 跨域信任 Token

userId - 用户ID

askTxt - 询问密文

返回:

AuthToken AuthToken

ok

public static AuthToken ok(javax.servlet.http.HttpServletRequest request,
           javax.servlet.http.HttpServletResponse response,
           String replyData,
           String atPk,
           String ssoPrk)

验证回复密文，成功! 返回 绑定用户ID 等信息

参数:

request -

response -

authToken - 跨域信任 Token

replyTxt - 回复密文

atPk - RSA 公钥 (业务系统公钥，验证authToken签名)

ssoPrk - RSA 公钥 (SSO 回复密文公钥验证签名)

返回:

AuthToken AuthToken