AuthenticationEntryPoint
简介
AuthenticationEntryPoint
是Spring Security Web
一个概念模型接口,顾名思义,他所建模的概念是:“认证入口点”。
它在用户请求处理过程中遇到认证异常时,被ExceptionTranslationFilter
用于开启特定认证方案(authentication schema
)的认证流程。
该接口只定义了一个方法 :
void commence(HttpServletRequest request, HttpServletResponse response,
AuthenticationException authException) throws IOException, ServletException;
这里参数request
是遇到了认证异常authException
用户请求,response
是将要返回给客户的相应,方法commence
实现,也就是相应的认证方案逻辑会修改response
并返回给用户引导用户进入认证流程。
在该方法被调用前, ExceptionTranslationFilter
会做好如下工作 :
- 填充属性
HttpSession
,使用属性名称为AbstractAuthenticationProcessingFilter.SPRING_SECURITY_SAVED_REQUEST_KEY
AuthenticationEntryPoint
源代码
package org.springframework.security.web;
import org.springframework.security.core.AuthenticationException;
import org.springframework.security.web.access.ExceptionTranslationFilter;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public interface AuthenticationEntryPoint {
/**
* Commences an authentication scheme.
*
* ExceptionTranslationFilter will populate the HttpSession
* attribute named
* AbstractAuthenticationProcessingFilter.SPRING_SECURITY_SAVED_REQUEST_KEY
* with the requested target URL before calling this method.
*
* Implementations should modify the headers on the ServletResponse as
* necessary to commence the authentication process.
*
* @param request that resulted in an AuthenticationException
* @param response so that the user agent can begin authentication
* @param authException that caused the invocation
*
*/
void commence(HttpServletRequest request, HttpServletResponse response,
AuthenticationException authException) throws IOException, ServletException;
}
Spring Security Web
内置AuthenticationEntryPoint
实现类
Spring Security Web
为AuthenticationEntryPoint
提供了一些内置实现 :
Http403ForbiddenEntryPoint
设置响应状态字为
403
,并非触发一个真正的认证流程。通常在一个预验证(pre-authenticated authentication
)已经得出结论需要拒绝用户请求的情况被用于拒绝用户请求。HttpStatusEntryPoint
设置特定的响应状态字,并非触发一个真正的认证流程。
LoginUrlAuthenticationEntryPoint
根据配置计算出登录页面
url
,将用户重定向到该登录页面从而开始一个认证流程。BasicAuthenticationEntryPoint
对应标准
Http Basic
认证流程的触发动作,向响应写入状态字401
和头部WWW-Authenticate:"Basic realm="xxx"
触发标准Http Basic
认证流程。DigestAuthenticationEntryPoint
对应标准
Http Digest
认证流程的触发动作,向响应写入状态字401
和头部WWW-Authenticate:"Digest realm="xxx"
触发标准Http Digest
认证流程。DelegatingAuthenticationEntryPoint
这是一个代理,将认证任务委托给所代理的多个
AuthenticationEntryPoint
对象,其中一个被标记为缺省AuthenticationEntryPoint
。