com.baomidou.kisso.SSOHelper Maven / Gradle / Ivy
Show all versions of kisso Show documentation
/*
* Copyright (c) 2011-2020, hubin ([email protected]).
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.baomidou.kisso;
import com.baomidou.kisso.security.JwtHelper;
import com.baomidou.kisso.security.token.SSOToken;
import com.baomidou.kisso.service.ConfigurableAbstractKissoService;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
/**
*
* SSO 帮助类
*
*
* @author hubin
* @since 2016-01-21
*/
public class SSOHelper {
protected static SSOConfig SSO_CONFIG;
protected static ConfigurableAbstractKissoService kissoService;
public static SSOConfig getSsoConfig() {
if (null == SSO_CONFIG) {
SSO_CONFIG = new SSOConfig();
}
return SSO_CONFIG;
}
public static SSOConfig setSsoConfig(SSOConfig ssoConfig) {
SSO_CONFIG = ssoConfig;
return SSO_CONFIG;
}
/**
* Kisso 服务初始化
*/
public static ConfigurableAbstractKissoService getKissoService() {
if (kissoService == null) {
kissoService = new ConfigurableAbstractKissoService();
}
return kissoService;
}
/**
* HS512 密钥
*/
public static String getHS512SecretKey() {
return JwtHelper.getHS512SecretKey();
}
/**
* ------------------------------- 登录相关方法 -------------------------------
*/
/**
*
* 设置加密 Cookie（登录验证成功）
* 最后一个参数 true 销毁当前JSESSIONID. 创建可信的 JSESSIONID 防止伪造 SESSIONID 攻击
*
*
* 最后一个参数 false 只设置 cookie
*
* request.setAttribute(SSOConfig.SSO_COOKIE_MAXAGE, maxAge);
* 可以动态设置 Cookie maxAge 超时时间 ，优先于配置文件的设置，无该参数 - 默认读取配置文件数据 。
* maxAge 定义：-1 浏览器关闭时自动删除 0 立即删除 120 表示Cookie有效期2分钟(以秒为单位)
*
*
* @param request
* @param response
* @param ssoToken SSO 票据
* @param invalidate 销毁当前 JSESSIONID
*/
public static void setCookie(HttpServletRequest request, HttpServletResponse response, SSOToken ssoToken, boolean invalidate) {
if (invalidate) {
getKissoService().authCookie(request, response, ssoToken);
} else {
getKissoService().setCookie(request, response, ssoToken);
}
}
public static void setCookie(HttpServletRequest request, HttpServletResponse response, SSOToken ssoToken) {
setCookie(request, response, ssoToken, false);
}
/**
* ------------------------------- 客户端相关方法 -------------------------------
*/
/**
*
* 获取当前请求 token
* 该方法直接从 cookie 中解密获取 token, 常使用在登录系统及拦截器中使用 getToken(request)
*
*
* 如果该请求在登录拦截器之后请使用 attrToken(request) 防止二次解密
*
*
* @param request
* @return
*/
@SuppressWarnings("unchecked")
public static T getSSOToken(HttpServletRequest request) {
return (T) getKissoService().getSSOToken(request);
}
/**
*
* 从请求中获取 token 通过登录拦截器之后使用
* 该数据为登录拦截器放入 request 中，防止二次解密
*
*
* @param request 访问请求
* @return
*/
public static T attrToken(HttpServletRequest request) {
return getKissoService().attrSSOToken(request);
}
/**
*
* 退出登录， 并且跳至 sso.properties 配置的属性 sso.logout.url 地址
*
*
* @param request
* @param response
* @throws IOException
*/
public static void logout(HttpServletRequest request, HttpServletResponse response) throws IOException {
getKissoService().logout(request, response);
}
/**
*
* 清理当前登录状态
* 清理 Cookie、缓存、统计、等数据
*
*
* @param request
* @param response
* @return
*/
public static boolean clearLogin(HttpServletRequest request, HttpServletResponse response) {
return getKissoService().clearLogin(request, response);
}
/**
*
* 退出重定向登录页，跳至 sso.properties 配置的属性 sso.login.url 地址
*
*
* @param request
* @param response
* @throws IOException
*/
public static void clearRedirectLogin(HttpServletRequest request, HttpServletResponse response) throws IOException {
getKissoService().clearRedirectLogin(request, response);
}
/**
*
* 获取 token 的缓存主键
*
*
* @param request 当前请求
* @return
*/
public static String getTokenCacheKey(HttpServletRequest request) {
return getSSOToken(request).toCacheKey();
}
/**
*
* 获取 token 的缓存主键
*
*
* @param userId 用户ID
* @return
*/
public static String getTokenCacheKey(Object userId) {
return SSOConfig.toCacheKey(userId);
}
/**
*
* 踢出 指定用户 ID 的登录用户，退出当前系统。
*
*
* @param userId 用户ID
* @return
*/
public static boolean kickLogin(Object userId) {
return getKissoService().kickLogin(userId);
}
}