前言
登陸是一個項目的基礎(chǔ)轿曙,幾乎任何項目都需要包括登陸模塊,網(wǎng)上大部分登陸都是使用的shrio僻孝,個人感覺這種東西很老拳芙,而且不好用,偶然之前發(fā)現(xiàn)了一個叫keycloak的sso開源項目皮璧, 感覺挺不錯的舟扎,這篇文章主要講解如何使用springboot和keycloak進行結(jié)合。
版本
- springboot: 1.4.3.RELEASE 版本
- keycloak: 2.5.1.Final 版本
- vue: 2.1.0 版本
項目搭建
- 首先搭建keycloak的服務(wù) (略)
- 編寫前端代碼(用vue2寫的簡單的一個spa悴务,略)
- 編寫springboot的服務(wù)(略)
- 加入核心依賴
<dependency>
<groupId>org.keycloak</groupId>
<artifactId>keycloak-tomcat8-adapter</artifactId>
</dependency>
<dependency>
<groupId>org.keycloak</groupId>
<artifactId>keycloak-spring-security-adapter</artifactId>
</dependency>
- 在springboot的配置文件中加入
keycloak:
configurationFile: "classpath:keycloak.json"
- 在resources的目錄下加入
keycloak.json
配置文件
{
"realm": "family",
"bearer-only": true,
"auth-server-url": "http://localhost:8080/auth",
"ssl-required": "external",
"resource": "family-app",
"enable-cors": true
}
- 配置springmvc的跨域filter
@Configuration
public class CorsFilterConfig implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse,
FilterChain filterChain) throws IOException, ServletException {
HttpServletResponse res = (HttpServletResponse) servletResponse;
res.setHeader("Access-Control-Allow-Origin", "*");
res.setHeader("Access-Control-Allow-Methods", "POST, GET, OPTIONS, DELETE, PUT");
res.setHeader("Access-Control-Max-Age", "1728000");
res.setHeader("Access-Control-Allow-Headers",
"Authorization, Content-Type, Accept, x-requested-with, Cache-Control");
filterChain.doFilter(servletRequest, res);
}
@Override
public void destroy() {}
}
- 配置keycloak和spring security結(jié)合的配置文件
@Configuration
@EnableWebSecurity
@EnableGlobalMethodSecurity(prePostEnabled = true)
@ComponentScan(basePackageClasses = KeycloakSecurityComponents.class)
public class KeycloakSecurityConfig extends KeycloakWebSecurityConfigurerAdapter {
@Autowired
public void configureGlobal(AuthenticationManagerBuilder auth) throws Exception {
auth.authenticationProvider(keycloakAuthenticationProvider());
}
@Bean
@Override
protected SessionAuthenticationStrategy sessionAuthenticationStrategy() {
return new NullAuthenticatedSessionStrategy();
}
@Bean
public FilterRegistrationBean keycloakAuthenticationProcessingFilterRegistrationBean(
KeycloakAuthenticationProcessingFilter filter) {
FilterRegistrationBean registrationBean = new FilterRegistrationBean(filter);
registrationBean.setEnabled(false);
return registrationBean;
}
@Bean
public FilterRegistrationBean keycloakPreAuthActionsFilterRegistrationBean(
KeycloakPreAuthActionsFilter filter) {
FilterRegistrationBean registrationBean = new FilterRegistrationBean(filter);
registrationBean.setEnabled(false);
return registrationBean;
}
@Override
protected void configure(HttpSecurity http) throws Exception {
super.configure(http);
http.sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS)
.sessionAuthenticationStrategy(sessionAuthenticationStrategy()).and()
.addFilterBefore(keycloakPreAuthActionsFilter(), LogoutFilter.class)
.addFilterBefore(keycloakAuthenticationProcessingFilter(), X509AuthenticationFilter.class)
.exceptionHandling().authenticationEntryPoint(authenticationEntryPoint()).and()
.authorizeRequests()
.requestMatchers(CorsUtils::isCorsRequest).permitAll()
// .antMatchers("/family/*").hasAnyAuthority("user").antMatchers("/admin/*").hasRole("ADMIN")
.antMatchers("/**").authenticated()
.anyRequest().permitAll();
}
}
- 對應(yīng)的接口上增加可以執(zhí)行的用戶角色
@RequestMapping(value = "/all", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
@ResponseBody
@PreAuthorize("hasAnyAuthority('user')")
public List<Family> queryAllFamilyInfo() {
return familyInfoService.queryAllFamilyInfo();
}
遇到的坑
- 對應(yīng)keycloak的用戶權(quán)限需要使用
hasAnyAuthority
而不是hasAnyRole
睹限,并且需要在KeycloakSecurityConfig
類中加入@EnableGlobalMethodSecurity(prePostEnabled = true)
注解 -
keycloak-spring-security-adapter
和spring-boot-adpater
兩個依賴不能同時使用 - cors的跨域的配置,需要
CorsFilterConfig
的filter類配合KeycloakSecurityConfig
類中的requestMatchers(CorsUtils::isCorsRequest).permitAll()
一起使用