1.在pom.xml中增加sso接入相关依赖
<!--cas-client-->
<dependency>
<groupId>org.jasig.cas.client</groupId>
<artifactId>cas-client-core</artifactId>
<version>3.4.1</version>
</dependency>
<dependency>
<groupId>org.apache.shiro</groupId>
<artifactId>shiro-core</artifactId>
<version>${shiro.version}</version>
</dependency>
<dependency>
<groupId>org.apache.shiro</groupId>
<artifactId>shiro-cas</artifactId>
<version>${shiro.version}</version>
</dependency>
<dependency>
<groupId>org.apache.shiro</groupId>
<artifactId>shiro-aspectj</artifactId>
<version>${shiro.version}</version>
</dependency>
<!--单点登录-->
<dependency>
<groupId>org.pac4j</groupId>
<artifactId>pac4j-cas</artifactId>
<version>3.0.2</version>
</dependency>
<dependency>
<groupId>io.buji</groupId>
<artifactId>buji-pac4j</artifactId>
<version>4.0.0</version>
<exclusions>
<exclusion>
<artifactId>shiro-web</artifactId>
<groupId>org.apache.shiro</groupId>
</exclusion>
</exclusions>
</dependency>
2. 在springboot项目的配置文件application-dev.xml新增以下配置项:
#cas配置
cas:
client-name: kb
server:
#cas服务端前缀,不是登录地
url: http://127.0.0.1:8085/cas
project:
#当前客户端地址,即应用地址(域名)
url: http://127.0.0.1:8088/kg
#前端首页地址,用于sso验证成功后重定向到此页面(注意不是登陆页面,是登陆成功后的首页)
ui-url: http://127.0.0.1:11000/admin/#/home
3.重写ShiroConfig.java文件:
import io.buji.pac4j.filter.CallbackFilter;
import io.buji.pac4j.filter.LogoutFilter;
import io.buji.pac4j.filter.SecurityFilter;
import io.buji.pac4j.subject.Pac4jSubjectFactory;
import org.apache.shiro.spring.LifecycleBeanPostProcessor;
import org.apache.shiro.spring.security.interceptor.AuthorizationAttributeSourceAdvisor;
import org.apache.shiro.spring.web.ShiroFilterFactoryBean;
import org.apache.shiro.web.mgt.DefaultWebSecurityManager;
import org.jasig.cas.client.session.SingleSignOutFilter;
import org.jasig.cas.client.session.SingleSignOutHttpSessionListener;
import org.pac4j.core.config.Config;
import org.springframework.aop.framework.autoproxy.DefaultAdvisorAutoProxyCreator;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.boot.web.servlet.ServletListenerRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.DependsOn;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.web.filter.DelegatingFilterProxy;
import javax.servlet.DispatcherType;
import javax.servlet.Filter;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.Map;
/**
* cas整合shiro
* @author jay
* @date 2019-12-20
*
*/
@Configuration
public class CasShiroConfig {
/**
* 项目工程路径
*/
@Value("${cas.project.url}")
private String projectUrl;
/**
* 项目cas服务路径
*/
@Value("${cas.server.url}")
private String casServerUrl;
/**
* 客户端名称
*/
@Value("${cas.client-name}")
private String clientName;
/**
* 单点登出的listener
*
* @return
*/
@SuppressWarnings({"rawtypes", "unchecked"})
@Bean
public ServletListenerRegistrationBean<?> singleSignOutHttpSessionListener() {
ServletListenerRegistrationBean bean = new ServletListenerRegistrationBean();
bean.setListener(new SingleSignOutHttpSessionListener());
bean.setEnabled(true);
return bean;
}
/**
* 单点登出filter
*
* @return
*/
@Bean
@Order(Ordered.HIGHEST_PRECEDENCE)
public FilterRegistrationBean singleSignOutFilter() {
FilterRegistrationBean bean = new FilterRegistrationBean();
bean.setName("singleSignOutFilter");
SingleSignOutFilter singleSignOutFilter = new SingleSignOutFilter();
singleSignOutFilter.setCasServerUrlPrefix(casServerUrl);
singleSignOutFilter.setIgnoreInitConfiguration(true);
bean.setFilter(singleSignOutFilter);
bean.addUrlPatterns("/*");
bean.setEnabled(true);
return bean;
}
@Bean("securityManager")
public DefaultWebSecurityManager securityManager(Pac4jSubjectFactory subjectFactory, CasRealm casRealm) {
DefaultWebSecurityManager manager = new DefaultWebSecurityManager();
manager.setRealm(casRealm);
manager.setSubjectFactory(subjectFactory);
// manager.setSessionManager(sessionManager); //去掉session管理
return manager;
}
@Bean
public CasRealm casRealm() {
CasRealm realm = new CasRealm();
// 使用自定义的realm
realm.setClientName(clientName);
realm.setCachingEnabled(false);
//暂时不使用缓存
realm.setAuthenticationCachingEnabled(false);
realm.setAuthorizationCachingEnabled(false);
//realm.setAuthenticationCacheName("authenticationCache");
//realm.setAuthorizationCacheName("authorizationCache");
return realm;
}
/**
* 使用 pac4j 的 subjectFactory
*
* @return
*/
@Bean
public Pac4jSubjectFactory subjectFactory() {
return new Pac4jSubjectFactory();
}
@Bean
public FilterRegistrationBean filterRegistrationBean() {
FilterRegistrationBean filterRegistration = new FilterRegistrationBean();
filterRegistration.setFilter(new DelegatingFilterProxy("shiroFilter"));
// 该值缺省为false,表示生命周期由SpringApplicationContext管理,设置为true则表示由ServletContainer管理
filterRegistration.addInitParameter("targetFilterLifecycle", "true");
filterRegistration.setEnabled(true);
filterRegistration.addUrlPatterns("/*");
filterRegistration.setDispatcherTypes(DispatcherType.REQUEST, DispatcherType.FORWARD);
return filterRegistration;
}
/**
* 加载shiroFilter权限控制规则(从数据库读取然后配置)
*
* @param shiroFilterFactoryBean
*/
private void loadShiroFilterChain(ShiroFilterFactoryBean shiroFilterFactoryBean) {
/*下面这些规则配置最好配置到配置文件中 */
Map<String, String> filterChainDefinitionMap = new LinkedHashMap<>();
filterChainDefinitionMap.put("/kg/", "securityFilter");
filterChainDefinitionMap.put("/kg/ssoLogin", "securityFilter");
filterChainDefinitionMap.put("/kg/index", "securityFilter");
filterChainDefinitionMap.put("/kg/callback/**", "callbackFilter");
//filterChainDefinitionMap.put("kg/logout", "logout");
filterChainDefinitionMap.put("kg/ssoLogout", "ssoLogoutFilter");
// filterChainDefinitionMap.put("/**","anon");
filterChainDefinitionMap.put("/**", "jwt"); //使用自己的过滤器
// filterChainDefinitionMap.put("/user/edit/**", "authc,perms[user:edit]");
shiroFilterFactoryBean.setFilterChainDefinitionMap(filterChainDefinitionMap);
}
/**
* shiroFilter
*
* @param securityManager
* @param config
* @return
*/
@Bean("shiroFilter")
public ShiroFilterFactoryBean factory(DefaultWebSecurityManager securityManager, Config config) {
ShiroFilterFactoryBean shiroFilterFactoryBean = new ShiroFilterFactoryBean();
// 必须设置 SecurityManager
shiroFilterFactoryBean.setSecurityManager(securityManager);
//shiroFilterFactoryBean.setUnauthorizedUrl("/403");
// 添加casFilter到shiroFilter中
loadShiroFilterChain(shiroFilterFactoryBean);
Map<String, Filter> filters = new HashMap<>(4);
//cas 资源认证拦截器
SecurityFilter securityFilter = new SecurityFilter();
securityFilter.setConfig(config);
securityFilter.setClients(clientName);
filters.put("securityFilter", securityFilter);
//cas 认证后回调拦截器
CallbackFilter callbackFilter = new CallbackFilter();
callbackFilter.setConfig(config);
callbackFilter.setDefaultUrl(projectUrl);
filters.put("callbackFilter", callbackFilter);
//验证请求拦截器
filters.put("jwt", new JWTFilter()); //添加自己的过滤器
// 注销 拦截器
LogoutFilter logoutFilter = new LogoutFilter();
logoutFilter.setConfig(config);
logoutFilter.setCentralLogout(true);
logoutFilter.setLocalLogout(true);
logoutFilter.setDefaultUrl(projectUrl + "/callback?client_name=" + clientName);
filters.put("ssoLogoutFilter", logoutFilter);
shiroFilterFactoryBean.setFilters(filters);
return shiroFilterFactoryBean;
}
/**
* 下面的代码是添加注解支持
*/
@Bean
@DependsOn("lifecycleBeanPostProcessor")
public DefaultAdvisorAutoProxyCreator defaultAdvisorAutoProxyCreator() {
DefaultAdvisorAutoProxyCreator defaultAdvisorAutoProxyCreator = new DefaultAdvisorAutoProxyCreator();
// 强制使用cglib,防止重复代理和可能引起代理出错的问题
// https://zhuanlan.zhihu.com/p/29161098
defaultAdvisorAutoProxyCreator.setProxyTargetClass(true);
return defaultAdvisorAutoProxyCreator;
}
@Bean
public static LifecycleBeanPostProcessor lifecycleBeanPostProcessor() {
return new LifecycleBeanPostProcessor();
}
@Bean
public AuthorizationAttributeSourceAdvisor authorizationAttributeSourceAdvisor(DefaultWebSecurityManager securityManager) {
AuthorizationAttributeSourceAdvisor advisor = new AuthorizationAttributeSourceAdvisor();
advisor.setSecurityManager(securityManager);
return advisor;
}
}
4.重写ShiroRealm.java文件
注意点:这里有个大坑,一定要注意重写supports方法增加对token类型的支持,不然会报类型不支持的错,导致后续所有权限验证失败,这个错折腾了最少三天才解决!!!
import io.buji.pac4j.realm.Pac4jRealm;
import io.buji.pac4j.subject.Pac4jPrincipal;
import io.buji.pac4j.token.Pac4jToken;
import org.apache.commons.lang3.StringUtils;
import org.apache.shiro.authc.AuthenticationException;
import org.apache.shiro.authc.AuthenticationInfo;
import org.apache.shiro.authc.AuthenticationToken;
import org.apache.shiro.authc.SimpleAuthenticationInfo;
import org.apache.shiro.authz.AuthorizationInfo;
import org.apache.shiro.authz.SimpleAuthorizationInfo;
import org.apache.shiro.subject.PrincipalCollection;
import org.apache.shiro.subject.SimplePrincipalCollection;
import org.pac4j.core.profile.CommonProfile;
import org.springframework.beans.factory.annotation.Autowired;
import javax.servlet.http.HttpServletRequest;
import java.util.List;
import java.util.Set;
/**
* cas认证与授权
* @author jay
* @date 2019-12-20
**/
public class CasRealm extends Pac4jRealm {
private String clientName;
public String getClientName() {
return clientName;
}
public void setClientName(String clientName) {
this.clientName = clientName;
}
@Autowired
private UserManager userManager;
@Autowired
private RedisService redisService;
/**
* 认证
* @param authenticationToken
* @return
* @throws AuthenticationException
*/
@Override
protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) {
if (!(authenticationToken instanceof JWTToken)) {
final Pac4jToken pac4jToken = (Pac4jToken) authenticationToken;
final List<CommonProfile> commonProfileList = pac4jToken.getProfiles();
final CommonProfile commonProfile = commonProfileList.get(0);
System.out.println("单点登录返回的信息" + commonProfile.toString());
//todo
final Pac4jPrincipal principal = new Pac4jPrincipal(commonProfileList, getPrincipalNameAttribute());
final PrincipalCollection principalCollection = new SimplePrincipalCollection(principal, getName());
return new SimpleAuthenticationInfo(principalCollection, commonProfileList.hashCode());
//return new SimpleAuthenticationInfo(t, t, "kb_shiro_realm");
} else {
// 这里的 token是从 JWTFilter 的 executeLogin 方法传递过来的,已经经过了解密
// System.out.println(authenticationToken.getCredentials());
String token = (String)authenticationToken.getCredentials();
// 从 redis里获取这个 token
HttpServletRequest request = HttpContextUtil.getHttpServletRequest();
String ip = IPUtil.getIpAddr(request);
String encryptToken = KBUtil.encryptToken(token);
String encryptTokenInRedis = null;
try {
encryptTokenInRedis = redisService.get(KBConstant.TOKEN_CACHE_PREFIX + encryptToken + "." + ip);
} catch (Exception ignore) {
}
// 如果找不到,说明已经失效
if (StringUtils.isBlank(encryptTokenInRedis))
throw new AuthenticationException("token已经过期");
String username = JWTUtil.getUsername(token);
if (StringUtils.isBlank(username))
throw new AuthenticationException("token校验不通过");
// 通过用户名查询用户信息
User user = userManager.getUser(username);
if (user == null)
throw new AuthenticationException("用户名或密码错误");
if (!JWTUtil.verify(token, username, user.getPassword()))
throw new AuthenticationException("token校验不通过");
return new SimpleAuthenticationInfo(token, token, "kb_shiro_realm");
}
}
/**
* 授权/验权(todo 后续有权限在此增加)
* @param principals
* @return
*/
@Override
protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection token) {
String username = JWTUtil.getUsername(token.toString());
SimpleAuthorizationInfo simpleAuthorizationInfo = new SimpleAuthorizationInfo();
// 获取用户角色集
Set<String> roleSet = userManager.getUserRoles(username);
simpleAuthorizationInfo.setRoles(roleSet);
// 获取用户权限集
Set<String> permissionSet = userManager.getUserPermissions(username);
simpleAuthorizationInfo.setStringPermissions(permissionSet);
return simpleAuthorizationInfo;
}
/**
* @author jay
* 需要重写 AuthorizingRealm(被Pac4jRealm继承)的supports方法,增加对JWTToken的支持
* 否则会报错:does not support authentication token
* @param token
* @return
*/
@Override
public boolean supports(AuthenticationToken token) {
Boolean flag = false;
if (super.supports(token) || token instanceof Pac4jToken || token instanceof JWTToken ) {
flag = true;
}
return flag;
}
}
5.增加 CasClient.java类
package com.upai.kb.common.authentication;
import org.pac4j.cas.config.CasConfiguration;
import org.pac4j.core.context.Pac4jConstants;
import org.pac4j.core.context.WebContext;
import org.pac4j.core.context.session.SessionStore;
import org.pac4j.core.redirect.RedirectAction;
import org.pac4j.core.util.CommonHelper;
/**
* cas客户端
* @author jay
* @date 2019-12-20
*
*/
public class CasClient extends org.pac4j.cas.client.CasClient {
public CasClient() {
super();
}
public CasClient(CasConfiguration configuration) {
super(configuration);
}
/*
* (non-Javadoc)
* @see org.pac4j.core.client.IndirectClient#getRedirectAction(org.pac4j.core.context.WebContext)
*/
@Override
public RedirectAction getRedirectAction(WebContext context) {
this.init();
if (getAjaxRequestResolver().isAjax(context)) {
this.logger.info("AJAX request detected -> returning the appropriate action");
RedirectAction action = getRedirectActionBuilder().redirect(context);
this.cleanRequestedUrl(context);
return getAjaxRequestResolver().buildAjaxResponse(action.getLocation(), context);
} else {
final String attemptedAuth = (String)context.getSessionStore().get(context, this.getName() + ATTEMPTED_AUTHENTICATION_SUFFIX);
if (CommonHelper.isNotBlank(attemptedAuth)) {
this.cleanAttemptedAuthentication(context);
this.cleanRequestedUrl(context);
//这里按自己需求处理,默认是返回了401,我在这边改为跳转到cas登录页面
//throw HttpAction.unauthorized(context);
return this.getRedirectActionBuilder().redirect(context);
} else {
return this.getRedirectActionBuilder().redirect(context);
}
}
}
private void cleanRequestedUrl(WebContext context) {
SessionStore<WebContext> sessionStore = context.getSessionStore();
if (sessionStore.get(context, Pac4jConstants.REQUESTED_URL) != null) {
sessionStore.set(context, Pac4jConstants.REQUESTED_URL, "");
}
}
private void cleanAttemptedAuthentication(WebContext context) {
SessionStore<WebContext> sessionStore = context.getSessionStore();
if (sessionStore.get(context, this.getName() + ATTEMPTED_AUTHENTICATION_SUFFIX) != null) {
sessionStore.set(context, this.getName() + ATTEMPTED_AUTHENTICATION_SUFFIX, "");
}
}
}
6.增加Pac4jConfig.java类,Pac4j主要做跳转用,跳转地址都在这个类里面配置
import edu.yale.its.tp.cas.util.SecureHash64Util;
import io.buji.pac4j.context.ShiroSessionStore;
import org.pac4j.cas.config.CasConfiguration;
import org.pac4j.cas.config.CasProtocol;
import org.pac4j.core.config.Config;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.io.IOException;
/**
* cas跳转
* @author jay
* @date 2019-12-20
*
*/
@Configuration
public class Pac4jConfig {
/**
* 地址为:cas地址
*/
@Value("${cas.server.url}")
private String casServerUrl;
/**
* 地址为:验证返回后的项目地址:http://localhost:8081
*/
@Value("${cas.project.url}")
private String projectUrl;
/**
* 相当于一个标志,可以随意
*/
@Value("${cas.client-name}")
private String clientName;
@Value("${cas.sysIdStr}")
private String sysIdStr;
/**
* pac4j配置
*
* @param casClient
* @param shiroSessionStore
* @return
*/
@Bean("authcConfig")
public Config config(CasClient casClient, ShiroSessionStore shiroSessionStore) {
Config config = new Config(casClient);
config.setSessionStore(shiroSessionStore);
return config;
}
/**
* 自定义存储
*
* @return
*/
@Bean
public ShiroSessionStore shiroSessionStore() {
return new ShiroSessionStore();
}
/**
* cas 客户端配置
*
* @param casConfig
* @return
*/
@Bean
public CasClient casClient(CasConfiguration casConfig) {
CasClient casClient = new CasClient(casConfig);
//客户端回调地址, 登陆成功后会拦截这个地址
casClient.setCallbackUrl(projectUrl + "/callback");
casClient.setName(clientName);
return casClient;
}
/**
* 请求cas服务端配置
*
* @param
*/
@Bean
public CasConfiguration casConfig() throws IOException {
final CasConfiguration configuration = new CasConfiguration();
String serviceEncrypted = SecureHash64Util.obfusecate(projectUrl + "/callback?client_name="+clientName);
//CAS server登录地址,这里增加了几个参数是因为针对公司sso客户端的需要,可以不加
configuration.setLoginUrl(casServerUrl + "/login?" +
"sysIdStr=" + sysIdStr +
"&flag=" + serviceEncrypted
);
//CAS 版本,默认为 CAS30,我们使用的是 CAS20
configuration.setProtocol(CasProtocol.CAS20);
configuration.setAcceptAnyProxy(true);
configuration.setPrefixUrl(casServerUrl + "/");
return configuration;
}
}
7.增加LoginController.java中的登录成功回调方法,用于重定向到前端首页
说明:本项目只是简单接入sso,通过sso登录,并没有使用ticket作为权限验证凭据,而是获取sso登陆成功后的用户名再根据用户名去获取菜单角色等权限信息,沿用了项目本身的验证,可以根据项目需要来更改ticket验证方式!
sso登录成功后后台拿到登录用户,经过aes对称加密一起返回给前端,前端再调接口获取需要的权限角色等信息完成登录,
博主这个没有一次把所有信息返回给前端,是因为参数太多,都拼接再地址后面感觉不好,就只传递了一个加密后的用户名,如果有更好的方法可以留言交流一下。
/**
* cas登录认证
*
* @return 登录结果
* @author jay
* @date 2019-12-20
*/
@ApiOperation(value = "sso登录接口", notes = "sso登录接口")
@GetMapping({"/", "/ssoLogin", "/index"})
public void login(HttpServletRequest request, HttpServletResponse response) {
try {
Pac4jPrincipal principal = (Pac4jPrincipal) request.getUserPrincipal();
String userStr = (String) principal.getProfile().getId();
String loginAccount = userStr.split(":")[0];
//aes 16位加密,防止恶意登录
loginAccount = AESUtils.encrypt(loginAccount);
logger.info("---sso返回参数---Pac4jPrincipal:" + principal
+ ";userStr:" + userStr
+ ";loginAccount:"+loginAccount
);
/*重定向到前端登录页面,考虑到安全问题,只传给前端登陆账户,前端再调接口获取登录所需数据
http://前端服务器地址:前端项目端口(前端部署到nginx后nginx配置端口)
+ "/"(注意/是前端路由中登录页面的path,并且与nginx.conf文件中的
location后的/一致)+ 返回给前端的数据。
注意:前端服务器地址与前端项目中
config/index.js配置的host: 'x.x.x.x',保持一致*/
//参数暂定在重定向时传过去,缺点是会显得url太长,后续考虑只传用户id过去,再根据id查询需要的参数
String serviceEncrypted = SecureHash64Util.obfusecate(projectUrl + "/callback");
/*String url = casServerUrl + "/login?" +
"service=" + projectUrl + "/callback" +
"&sysIdStr=" + sysIdStr +
"&flag=" + serviceEncrypted;*/
String url = casUIUrl + "?loginAccount="+loginAccount;
response.sendRedirect(url);
} catch (Exception e) {
System.out.println("登录失败,请联系管理员!");
e.printStackTrace();
}
}
8.源码
等后续有空会把源码上传到github上发出来。