对于最新的稳定版本,请使用 Spring Security 6.5.3! |
Java 配置
Hello Web Security Java 配置
第一步是创建我们的 Spring Security Java 配置。
该配置创建了一个称为springSecurityFilterChain
,负责应用程序内的所有安全性(保护应用程序 URL、验证提交的用户名和密码、重定向到登录表单等)。
以下示例显示了 Spring Security Java 配置的最基本示例:
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.*;
import org.springframework.security.config.annotation.authentication.builders.*;
import org.springframework.security.config.annotation.web.configuration.*;
@Configuration
@EnableWebSecurity
public class WebSecurityConfig {
@Bean
public UserDetailsService userDetailsService() {
InMemoryUserDetailsManager manager = new InMemoryUserDetailsManager();
manager.createUser(User.withDefaultPasswordEncoder().username("user").password("password").roles("USER").build());
return manager;
}
}
这种配置并不复杂或广泛,但它做了很多:
-
要求对应用程序中的每个 URL 进行身份验证
-
为您生成登录表单
-
让用户名为
user
密码password
使用基于表单的身份验证进行身份验证 -
让用户注销
-
CSRF 攻击防护
-
会话固定保护
-
安全标头集成:
-
用于安全请求的 HTTP 严格传输安全性
-
缓存控制(稍后可以在应用程序中覆盖它以允许缓存静态资源)
-
X-Frame-Options 集成有助于防止点击劫持
-
-
与以下 Servlet API 方法集成:
抽象SecurityWebApplication初始化器
下一步是注册springSecurityFilterChain
替换为 WAR 文件。
您可以在 Java 配置中使用Spring的WebApplicationInitializer
支持在 Servlet 3.0+ 环境中。
毫不奇怪,Spring Security 提供了一个基类(AbstractSecurityWebApplicationInitializer
) 以确保springSecurityFilterChain
为您注册。
我们使用AbstractSecurityWebApplicationInitializer
取决于我们是否已经在使用 Spring,或者 Spring Security 是否是我们应用程序中唯一的 Spring 组件。
-
AbstractSecurityWebApplicationInitializer without Existing Spring - 如果您还没有使用 Spring,请使用这些说明
-
AbstractSecurityWebApplicationInitializer with Spring MVC - 如果您已经在使用 Spring,请使用这些说明
AbstractSecurityWebApplicationInitializer 没有现有 Spring
如果您没有使用 Spring 或 Spring MVC,则需要将WebSecurityConfig
到超类以确保选择配置:
import org.springframework.security.web.context.*;
public class SecurityWebApplicationInitializer
extends AbstractSecurityWebApplicationInitializer {
public SecurityWebApplicationInitializer() {
super(WebSecurityConfig.class);
}
}
这SecurityWebApplicationInitializer
:
-
自动注册
springSecurityFilterChain
筛选应用程序中的每个 URL。 -
添加一个
ContextLoaderListener
加载 WebSecurityConfig。
AbstractSecurityWebApplicationInitializer 与 Spring MVC
如果我们在应用程序的其他地方使用 Spring,我们可能已经有一个WebApplicationInitializer
那就是加载我们的 Spring 配置。
如果我们使用前面的配置,我们会得到一个错误。
相反,我们应该使用现有的ApplicationContext
.
例如,如果我们使用 Spring MVC,则我们的SecurityWebApplicationInitializer
可能如下所示:
import org.springframework.security.web.context.*;
public class SecurityWebApplicationInitializer
extends AbstractSecurityWebApplicationInitializer {
}
这仅注册springSecurityFilterChain
应用程序中的每个 URL。
之后,我们需要确保WebSecurityConfig
加载在我们现有的ApplicationInitializer
.
例如,如果我们使用 Spring MVC,它会添加到getServletConfigClasses()
:
public class MvcWebApplicationInitializer extends
AbstractAnnotationConfigDispatcherServletInitializer {
@Override
protected Class<?>[] getServletConfigClasses() {
return new Class[] { WebSecurityConfig.class, WebMvcConfig.class };
}
// ... other overrides ...
}
这样做的原因是 Spring Security 需要能够检查一些 Spring MVC 配置,以便适当地配置底层请求匹配器,因此它们需要位于相同的应用程序上下文中。
将 Spring Security 置于getRootConfigClasses
将其放入可能无法找到 Spring MVC 的HandlerMappingIntrospector
.
为多个 Spring MVC 调度程序配置
如果需要,可以将任何与 Spring MVC 无关的 Spring Security 配置放置在不同的配置类中,如下所示:
public class MvcWebApplicationInitializer extends
AbstractAnnotationConfigDispatcherServletInitializer {
@Override
protected Class<?>[] getRootConfigClasses() {
return new Class[] { NonWebSecurityConfig.class };
}
@Override
protected Class<?>[] getServletConfigClasses() {
return new Class[] { WebSecurityConfig.class, WebMvcConfig.class };
}
// ... other overrides ...
}
如果您有多个AbstractAnnotationConfigDispatcherServletInitializer
并且不想在它们之间重复常规安全配置。
Http安全
到目前为止,我们的WebSecurityConfig
仅包含有关如何对用户进行身份验证的信息。
Spring Security 如何知道我们要要求所有用户都经过身份验证?
Spring Security 如何知道我们想要支持基于表单的身份验证?
实际上,有一个配置类(称为SecurityFilterChain
)在幕后被调用。
它配置了以下默认实现:
@Bean
public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
http
.authorizeHttpRequests(authorize -> authorize
.anyRequest().authenticated()
)
.formLogin(withDefaults())
.httpBasic(withDefaults());
return http.build();
}
默认配置(如前面的示例所示):
-
确保对我们应用程序的任何请求都需要对用户进行身份验证
-
允许用户使用基于表单的登录进行身份验证
-
允许用户使用 HTTP 基本身份验证进行身份验证
请注意,此配置与 XML 命名空间配置平行:
<http>
<intercept-url pattern="/**" access="authenticated"/>
<form-login />
<http-basic />
</http>
多个 HttpSecurity 实例
我们可以配置多个HttpSecurity
实例,就像我们可以有多个<http>
块。
关键是要注册多个SecurityFilterChain
@Bean
s.
以下示例对以/api/
.
@Configuration
@EnableWebSecurity
public class MultiHttpSecurityConfig {
@Bean (1)
public UserDetailsService userDetailsService() throws Exception {
// ensure the passwords are encoded properly
UserBuilder users = User.withDefaultPasswordEncoder();
InMemoryUserDetailsManager manager = new InMemoryUserDetailsManager();
manager.createUser(users.username("user").password("password").roles("USER").build());
manager.createUser(users.username("admin").password("password").roles("USER","ADMIN").build());
return manager;
}
@Bean
@Order(1) (2)
public SecurityFilterChain apiFilterChain(HttpSecurity http) throws Exception {
http
.securityMatcher("/api/**") (3)
.authorizeHttpRequests(authorize -> authorize
.anyRequest().hasRole("ADMIN")
)
.httpBasic(withDefaults());
return http.build();
}
@Bean (4)
public SecurityFilterChain formLoginFilterChain(HttpSecurity http) throws Exception {
http
.authorizeHttpRequests(authorize -> authorize
.anyRequest().authenticated()
)
.formLogin(withDefaults());
return http.build();
}
}
1 | 像往常一样配置身份验证。 |
2 | 创建SecurityFilterChain 包含@Order 指定哪个SecurityFilterChain 应该首先考虑。 |
3 | 这http.securityMatcher 声明该HttpSecurity 仅适用于以/api/ . |
4 | 创建另一个SecurityFilterChain .
如果 URL 不是以/api/ ,则使用此配置。
此配置在apiFilterChain ,因为它有一个@Order 值1 (否@Order 默认为 last)。 |
自定义 DSL
您可以在 Spring Security 中提供自己的自定义 DSL:
public class MyCustomDsl extends AbstractHttpConfigurer<MyCustomDsl, HttpSecurity> {
private boolean flag;
@Override
public void init(HttpSecurity http) throws Exception {
// any method that adds another configurer
// must be done in the init method
http.csrf().disable();
}
@Override
public void configure(HttpSecurity http) throws Exception {
ApplicationContext context = http.getSharedObject(ApplicationContext.class);
// here we lookup from the ApplicationContext. You can also just create a new instance.
MyFilter myFilter = context.getBean(MyFilter.class);
myFilter.setFlag(flag);
http.addFilterBefore(myFilter, UsernamePasswordAuthenticationFilter.class);
}
public MyCustomDsl flag(boolean value) {
this.flag = value;
return this;
}
public static MyCustomDsl customDsl() {
return new MyCustomDsl();
}
}
这实际上就是像 |
然后,您可以使用自定义 DSL:
@Configuration
@EnableWebSecurity
public class Config {
@Bean
public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
http
.apply(customDsl())
.flag(true)
.and()
...;
return http.build();
}
}
按以下顺序调用代码:
-
代码中的
Config.filterChain
方法被调用 -
代码中的
MyCustomDsl.init
方法被调用 -
代码中的
MyCustomDsl.configure
方法被调用
如果你愿意,你可以有HttpSecurity
加MyCustomDsl
默认情况下,使用SpringFactories
. 例如,您可以在名为META-INF/spring.factories
包含以下内容:
org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer = sample.MyCustomDsl
您还可以显式禁用默认值:
@Configuration
@EnableWebSecurity
public class Config {
@Bean
public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
http
.apply(customDsl()).disable()
...;
return http.build();
}
}
后处理已配置对象
Spring Security 的 Java 配置不会公开它配置的每个对象的每个属性。这简化了大多数用户的配置。毕竟,如果每个属性都公开,则用户可以使用标准 bean 配置。
虽然有充分的理由不直接公开每个属性,但用户可能仍然需要更高级的配置选项。为了解决这个问题,Spring Security 引入了ObjectPostProcessor
,可用于修改或替换许多Object
Java 配置创建的实例。例如,要配置filterSecurityPublishAuthorizationSuccess
属性FilterSecurityInterceptor
,您可以使用以下内容:
@Bean
public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
http
.authorizeHttpRequests(authorize -> authorize
.anyRequest().authenticated()
.withObjectPostProcessor(new ObjectPostProcessor<FilterSecurityInterceptor>() {
public <O extends FilterSecurityInterceptor> O postProcess(
O fsi) {
fsi.setPublishAuthorizationSuccess(true);
return fsi;
}
})
);
return http.build();
}