此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Security 6.4.1! |
表单登录
Spring Security 支持通过 HTML 表单提供用户名和密码。 本节详细介绍了基于表单的身份验证在 Spring Security 中的工作原理。
本节介绍基于表单的登录在 Spring Security 中的工作原理。 首先,我们了解用户是如何被重定向到登录表单的:
前面的图建立在我们的SecurityFilterChain
图。
首先,用户向资源发出未经身份验证的请求 (/private
),但未获得授权。
Spring Security 的AuthorizationFilter
表示未经身份验证的请求被拒绝,方法是抛出AccessDeniedException
.
由于用户未经过身份验证,因此ExceptionTranslationFilter
启动 Start Authentication 并将重定向发送到具有已配置AuthenticationEntryPoint
.
在大多数情况下,AuthenticationEntryPoint
是LoginUrlAuthenticationEntryPoint
.
浏览器请求它重定向到的登录页面。
应用程序中的某些内容必须呈现登录页面。
提交用户名和密码后,UsernamePasswordAuthenticationFilter
验证用户名和密码。
这UsernamePasswordAuthenticationFilter
扩展了AbstractAuthenticationProcessingFilter,因此下图应该看起来非常相似:
该图建立在我们的SecurityFilterChain
图。
当用户提交其用户名和密码时,UsernamePasswordAuthenticationFilter
创建一个UsernamePasswordAuthenticationToken
,这是一种Authentication
,方法是从HttpServletRequest
实例。
接下来,UsernamePasswordAuthenticationToken
传递到AuthenticationManager
实例进行身份验证。
什么的细节AuthenticationManager
看起来取决于用户信息的存储方式。
如果身份验证失败,则为 Failure。
-
RememberMeServices.loginFail
被调用。 如果未配置 Remember me,则为 no-op。 请参阅RememberMeServices
接口。 -
AuthenticationFailureHandler
被调用。 请参阅AuthenticationFailureHandler
javadoc 中的 class
如果身份验证成功,则为 Success。
-
SessionAuthenticationStrategy
收到新登录的通知。 请参阅SessionAuthenticationStrategy
接口。 -
Authentication在SecurityContextHolder上设置。 请参阅
SecurityContextPersistenceFilter
类。 -
RememberMeServices.loginSuccess
被调用。 如果未配置 Remember me,则为 no-op。 请参阅RememberMeServices
接口。 -
ApplicationEventPublisher
发布InteractiveAuthenticationSuccessEvent
. -
这
AuthenticationSuccessHandler
被调用。通常,这是一个SimpleUrlAuthenticationSuccessHandler
,该请求会重定向到由ExceptionTranslationFilter
当我们重定向到登录页面时。
默认情况下,Spring Security 表单登录处于启用状态。 但是,一旦提供了任何基于 servlet 的配置,就必须显式提供基于表单的登录。 以下示例显示了一个最小的显式 Java 配置:
-
Java
-
XML
-
Kotlin
public SecurityFilterChain filterChain(HttpSecurity http) {
http
.formLogin(withDefaults());
// ...
}
<http>
<!-- ... -->
<form-login />
</http>
open fun filterChain(http: HttpSecurity): SecurityFilterChain {
http {
formLogin { }
}
// ...
}
在前面的配置中, Spring Security 呈现默认登录页面。 大多数生产应用程序都需要自定义登录表单。
以下配置演示了如何提供自定义登录表单。
-
Java
-
XML
-
Kotlin
public SecurityFilterChain filterChain(HttpSecurity http) {
http
.formLogin(form -> form
.loginPage("/login")
.permitAll()
);
// ...
}
<http>
<!-- ... -->
<intercept-url pattern="/login" access="permitAll" />
<form-login login-page="/login" />
</http>
open fun filterChain(http: HttpSecurity): SecurityFilterChain {
http {
formLogin {
loginPage = "/login"
permitAll()
}
}
// ...
}
在 Spring Security 配置中指定登录页面时,您负责呈现该页面。
以下 Thymeleaf 模板生成一个 HTML 登录表单,该表单符合/login
.:
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:th="https://www.thymeleaf.org">
<head>
<title>Please Log In</title>
</head>
<body>
<h1>Please Log In</h1>
<div th:if="${param.error}">
Invalid username and password.</div>
<div th:if="${param.logout}">
You have been logged out.</div>
<form th:action="@{/login}" method="post">
<div>
<input type="text" name="username" placeholder="Username"/>
</div>
<div>
<input type="password" name="password" placeholder="Password"/>
</div>
<input type="submit" value="Log in" />
</form>
</body>
</html>
关于默认 HTML 表单,有几个关键点:
许多用户只需要自定义登录页面即可。 但是,如果需要,您可以使用其他配置自定义前面显示的所有内容。
如果使用 Spring MVC,则需要一个控制器,该控制器将GET /login
添加到我们创建的登录模板中。
以下示例显示了一个最小值LoginController
:
-
Java
-
Kotlin
@Controller
class LoginController {
@GetMapping("/login")
String login() {
return "login";
}
}
@Controller
class LoginController {
@GetMapping("/login")
fun login(): String {
return "login"
}
}