SpringBoot 集成CAS简单学习
CAS服务搭建
可以直接放在Tomcat中启动,这里可以为了方便直接用IDEA搭建启动。如果直接拉取示例代码以下内容都已修改完毕。拉取代码直接使用。
CAS
提供了模板 Overlay Template,拉取 代码。Idea
新建Maven
项目- 新建模块
cas-server
,将下载的CAS模板解压后文件内的所有文件考入该模块中。 - 修改项目该路径下
overlaysorg.apereo.cas.cas-server-webapp-tomcat-5.3.16WEB-INFclasses
的application.properties
文件
# 取消票根对应的Cookie的Secure配置,否则非https无法完成单点登录(但是能达到每个应用都需要登录的目的)
cas.tgc.secure=false
# 使用services目录下的json配置初始化serviceRegistry
cas.serviceRegistry.initFromJson=true
# 配置允许登出后跳转到指定页面
cas.logout.followServiceRedirects=true
# 跳转到指定页面需要的参数名为 service
cas.logout.redirectParameter=service
- 修改项目该路径下
overlaysorg.apereo.cas.cas-server-webapp-tomcat-5.3.16WEB-INFclassesservices
的HTTPSandIMAPS-10000001.json
,改为以下内容
"serviceId" : "^(https|http|imaps)://.*",
Idea
配置Tomcat
选择本地的Tomcat
选择项目
配置完成,点击运行即可。- 浏览器访问 http://localhost:8483/cas/login ,用户:casuser,密码:Mellon。
SpringBoot 客户端项目测试
自动配置
首先引入自动配置依赖,并启用 @EnableCasClient
注解。
<dependency>
<groupId>org.jasig.cas.client</groupId>
<artifactId>cas-client-support-springboot</artifactId>
<version>${cas.client.version}</version>
</dependency>
EnableCasClient
注解类引入了配置类 CasClientConfiguration
,配置类中做了以下几件事:
-
casAuthenticationFilter()
创建了 认证过滤器 -
casValidationFilter()
创建了 验证票据过滤器 -
casHttpServletRequestWrapperFilter()
创建了请求对象的包装类 -
casAssertionThreadLocalFilter()
创建了将Assertion
放到ThreadLocal
的过滤器,对于获取不到HttpRequest
请求对象的情况这很有用 -
casSingleSignOutFilter()
创建了单点登出的过滤器 -
casSingleSignOutListener()
创建单点登出的Listener
,用于监听登出事件,清理内存中单点登录会话缓存 -
SpringSecurityAssertionAutoConfiguration
兼容Spring Security
的配置类其中对于单点登录最重要的是
casAuthenticationFilter()
、casValidationFilter()
这两个方法,另外以上几个方法创建的对象类都在 cas-client-core.jar ,也就是说可以只引这一个包,然后自行配置。
YML配置,两个客户端类似。
server:
port: 8480
cas:
# cas服务端的地址
server-url-prefix: http://127.0.0.1:8483/cas
# cas服务端的登录地址
server-login-url: http://127.0.0.1:8483/cas/login
# 当前服务器的地址(客户端)
client-host-url: http://localhost:8480
# Ticket校验器使用Cas30ProxyReceivingTicketValidationFilter
validation-type: cas3
客户端一
@Controller
public class TestController {
@ResponseBody
@RequestMapping("/sso-test1")
public String test1(HttpSession session){
Assertion assertion = (Assertion)session.getAttribute(CONST_CAS_ASSERTION);
AttributePrincipal principal = assertion.getPrincipal();
String loginName = principal.getName();
return "sso-test1,当前登录账户"+loginName;
}
/**
* 退出 后自动重定向自定义接口
*/
@RequestMapping("/system/logout1")
public String logout1(HttpServletRequest request) {
HttpSession session = request.getSession();
session.invalidate();
return "redirect:http://127.0.0.1:8483/cas/logout?service=http://localhost:8480/system/logoutSuccess";
}
/**
* 退出成功页
*/
@RequestMapping("/system/logoutSuccess")
@ResponseBody
public String logoutSuccess() {
return "test2成功退出!";
}
}
客户端二
@Controller
public class TestController {
@ResponseBody
@RequestMapping("/sso-test2")
public String test1(HttpSession session){
Assertion assertion = (Assertion)session.getAttribute(CONST_CAS_ASSERTION);
AttributePrincipal principal = assertion.getPrincipal();
String loginName = principal.getName();
return "sso-test2,当前登录账户"+loginName;
}
/**
* 退出 后自动重定向自定义接口
*/
@RequestMapping("/system/logout2")
public String logout1(HttpServletRequest request) {
HttpSession session = request.getSession();
session.invalidate();
return "redirect:http://127.0.0.1:8483/cas/logout?service=http://localhost:8481/system/logoutSuccess";
}
/**
* 退出成功页
*/
@RequestMapping("/system/logoutSuccess")
@ResponseBody
public String logoutSuccess() {
return "test2成功退出!";
}
}
测试
CAS服务器未登录时测试:
访问 http://localhost:8480/sso-test1 ,跳转至 http://127.0.0.1:8483/cas/login页面。
访问 http://localhost:8480/sso-test2 ,跳转至 http://127.0.0.1:8483/cas/login页面。
CAS服务器登录时测试:
访问 http://localhost:8480/sso-test1 ,返回 sso-test1,当前登录账户casuser。
访问 http://localhost:8480/sso-test2 ,返回 sso-test2,当前登录账户casuser。
CAS服务器登录后登出时测试:
访问 http://localhost:8480/sso-test1 ,跳转至 http://127.0.0.1:8483/cas/login页面。
访问 http://localhost:8480/sso-test2 ,返回 sso-test2,当前登录账户casuser。
客户端一执行system/logout1登出方法测试:
访问 http://localhost:8480/system/logout1 ,未跳到指定方法/system/logoutSuccess,跳转至 http://127.0.0.1:8483/cas/login页面。
访问 http://localhost:8480/system/logout2,未跳到指定方法/system/logoutSuccess,跳转至 http://127.0.0.1:8483/cas/login页面。
客户端二执行system/logout2登出方法测试:
访问 http://localhost:8480/system/logout1 ,未跳到指定方法/system/logoutSuccess,跳转至 http://127.0.0.1:8483/cas/login页面。
访问 http://localhost:8480/system/logout2,未跳到指定方法/system/logoutSuccess,跳转至 http://127.0.0.1:8483/cas/login页面。
手动配置
可以看到上方没有跳转到指定方法/system/logoutSuccess。现在加入手动配置类,加入设置忽略方法。
package com.blackcatcas.config;
import org.jasig.cas.client.authentication.AuthenticationFilter;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.util.HashMap;
import java.util.Map;
/**
* 描述 :CAS 配置类
* @author : zhangdahui
* @date : 2022/8/2 10:07
*/
@Configuration
public class Config {
@Value("${cas.server-url-prefix}")
private String prefix;
@Value("${cas.server-login-url}")
private String login;
@Value("${cas.client-host-url}")
private String client;
/**
* description:授权过滤器
*/
@Bean
public FilterRegistrationBean filterAuthenticationRegistration() {
FilterRegistrationBean registration = new FilterRegistrationBean();
registration.setFilter(new AuthenticationFilter());
// 设定匹配的路径
registration.addUrlPatterns("/*");
Map<String,String> initParameters = new HashMap<>();
initParameters.put("casServerLoginUrl", login);
initParameters.put("serverName", client);
//设置忽略 退出登录不用登录CAS
initParameters.put("ignorePattern", "/system/*");
registration.setInitParameters(initParameters);
// 设定加载的顺序
registration.setOrder(1);
return registration;
}
}
现在访问 http://localhost:8480/system/logout1 ,跳转到指定方法/system/logoutSuccess,返回:test2成功退出!
示例代码
https://gitee.com/kylin_lawliet/springboot-cas.git