Web 应用程序安全

<debug>

启用 Spring Security 调试基础设施。这将提供人类可读的(多行)调试信息以监控进入安全过滤器的请求。这可能包括敏感信息,例如请求参数或标头,并且仅应在开发环境中使用。

<http>

如果您在应用程序中使用<http>元素,则会创建一个名为“springSecurityFilterChain”的FilterChainProxy bean,并且<http>元素中的配置将用于在FilterChainProxy中构建过滤器链。从 Spring Security 3.1 开始,可以使用额外的http元素添加额外的过滤器链[1] 有关如何设置从您的web.xml映射的说明)。一些核心过滤器始终在过滤器链中创建,而其他过滤器将根据存在的属性和子元素添加到堆栈中。标准过滤器的顺序是固定的(请参阅命名空间介绍中的过滤器顺序表),消除了以前版本框架中用户必须在FilterChainProxy bean 中显式配置过滤器链时常见的错误来源。当然,如果您需要完全控制配置,您仍然可以这样做。

所有需要引用AuthenticationManager的过滤器将自动注入由命名空间配置创建的内部实例。

每个<http>命名空间块始终创建一个SecurityContextPersistenceFilter、一个ExceptionTranslationFilter和一个FilterSecurityInterceptor。这些是固定的,不能用替代品替换。

<http> 属性

<http>元素上的属性控制核心过滤器上的一些属性。

  • use-authorization-manager 使用 AuthorizationManager API 而不是 SecurityMetadataSource(默认为 true)

  • access-decision-manager-ref 使用此 AuthorizationManager 而不是从 <intercept-url> 元素派生一个

  • access-decision-manager-ref 可选属性,指定用于授权 HTTP 请求的AccessDecisionManager实现的 ID。默认情况下,使用AffirmativeBased实现,其中包含RoleVoterAuthenticatedVoter

  • authentication-manager-ref 对由此 http 元素创建的FilterChain使用的AuthenticationManager的引用。

  • observation-registry-refFilterChain和相关组件使用的ObservationRegistry的引用。

  • auto-config 自动注册登录表单、BASIC 身份验证、注销服务。如果设置为“true”,则添加所有这些功能(尽管您仍然可以通过提供相应的元素来自定义每个功能的配置)。如果未指定,则默认为“false”。不建议使用此属性。使用显式配置元素来避免混淆。

  • create-session 控制 Spring Security 类创建 HTTP 会话的积极性。选项包括

    • always - Spring Security 会主动创建会话,即使会话不存在。

    • ifRequired - Spring Security 仅在需要时才创建会话(默认值)。

    • never - Spring Security 永远不会创建会话,但如果应用程序使用会话,它会使用现有的会话。

    • stateless - Spring Security 不会创建会话,并且会忽略会话以获取 Spring Authentication

  • disable-url-rewriting 阻止在应用程序中将会话 ID 附加到 URL。如果将此属性设置为 true,则客户端必须使用 cookie。默认值为 true

  • entry-point-ref 通常,使用的 AuthenticationEntryPoint 将根据已配置的身份验证机制进行设置。此属性允许通过定义一个自定义的 AuthenticationEntryPoint bean 来覆盖此行为,该 bean 将启动身份验证过程。

  • jaas-api-provision 如果可用,则将请求作为从 JaasAuthenticationToken 获取的 Subject 运行,JaasAuthenticationToken 是通过将 JaasApiIntegrationFilter bean 添加到堆栈来实现的。默认为 false

  • name bean 标识符,用于在上下文中其他地方引用 bean。

  • once-per-request 对应于 FilterSecurityInterceptorobserveOncePerRequest 属性。默认为 false

  • filter-all-dispatcher-types 对应于 AuthorizationFiltershouldFilterAllDispatcherTypes 属性。当 use-authorization-manager=false 时不起作用。默认为 true

  • patternhttp 元素定义模式控制将通过其定义的过滤器列表进行过滤的请求。解释取决于配置的 request-matcher。如果没有定义模式,则将匹配所有请求,因此应首先声明最具体的模式。

  • realm 设置用于基本身份验证(如果已启用)的领域名称。对应于 BasicAuthenticationEntryPoint 上的 realmName 属性。

  • request-matcher 定义在 FilterChainProxy 和由 intercept-url 创建的 bean 中使用的 RequestMatcher 策略,以匹配传入的请求。当前选项包括 mvcantregexciRegex,分别对应 Spring MVC、ant、正则表达式和不区分大小写的正则表达式。对于每个 intercept-url 元素,使用其 patternmethodservlet-path 属性创建单独的实例。Ant 路径使用 AntPathRequestMatcher 进行匹配,正则表达式使用 RegexRequestMatcher 进行匹配,而 Spring MVC 路径匹配则使用 MvcRequestMatcher。有关匹配执行方式的更多详细信息,请参阅这些类的 Javadoc。如果类路径中存在 Spring MVC,则 MVC 是默认策略;否则,将使用 Ant 路径。

  • request-matcher-ref 对实现 RequestMatcher 的 bean 的引用,该 bean 将确定是否应使用此 FilterChain。这比 pattern 更强大的替代方案。

  • security 通过将此属性设置为 none,可以将请求模式映射到空过滤器链。不会应用任何安全性,并且 Spring Security 的任何功能都不可用。

  • security-context-repository-ref 允许将自定义 SecurityContextHolderStrategy 注入 SecurityContextPersistenceFilterSecurityContextHolderFilterBasicAuthenticationFilterUsernamePasswordAuthenticationFilterExceptionTranslationFilterLogoutFilter 等。

  • security-context-explicit-save 如果为 true,则使用 SecurityContextHolderFilter 而不是 SecurityContextPersistenceFilter。需要显式保存。

  • security-context-repository-ref 允许将自定义 SecurityContextRepository 注入 SecurityContextPersistenceFilter

  • servlet-api-provision 提供 HttpServletRequest 安全方法(如 isUserInRole()getPrincipal())的版本,这些方法通过将 SecurityContextHolderAwareRequestFilter bean 添加到堆栈来实现。默认为 true

<access-denied-handler>

此元素允许您使用 error-page 属性设置 ExceptionTranslationFilter 使用的默认 AccessDeniedHandlererrorPage 属性,或使用 ref 属性提供您自己的实现。这将在 ExceptionTranslationFilter 部分中详细讨论。

<access-denied-handler> 的父元素

<access-denied-handler> 属性

  • error-page 经过身份验证的用户在请求他们无权访问的页面时将被重定向到的访问拒绝页面。

  • ref 定义对类型为 AccessDeniedHandler 的 Spring bean 的引用。

<cors>

此元素允许配置 CorsFilter。如果未指定 CorsFilterCorsConfigurationSource 并且 Spring MVC 在类路径中,则 HandlerMappingIntrospector 将用作 CorsConfigurationSource

<cors> 属性

<cors> 元素上的属性控制 headers 元素。

  • ref 指定 CorsFilter 的 bean 名称的可选属性。

  • cors-configuration-source-ref 指定要注入到由 XML 命名空间创建的 CorsFilter 中的 CorsConfigurationSource 的 bean 名称的可选属性。

<cors> 的父元素

<headers>

此元素允许配置要与响应一起发送的附加(安全)标头。它可以轻松配置多个标头,还可以通过 header 元素设置自定义标头。有关更多信息,请参阅参考中的 安全标头 部分。

  • Cache-ControlPragmaExpires - 可以使用 cache-control 元素设置。这确保浏览器不会缓存您的安全页面。

  • Strict-Transport-Security - 可以使用 hsts 元素设置。这确保浏览器自动为将来的请求请求 HTTPS。

  • X-Frame-Options - 可以使用 frame-options 元素设置。 X-Frame-Options 标头可用于防止点击劫持攻击。

  • X-XSS-Protection - 可以使用 xss-protection 元素设置。 X-XSS-Protection 标头可用于浏览器进行基本控制。

  • X-Content-Type-Options - 可以使用 content-type-options 元素设置。 X-Content-Type-Options 标头可防止 Internet Explorer 从声明的内容类型中嗅探出响应的 MIME 类型。 这也适用于 Google Chrome,在下载扩展程序时。

  • Public-Key-PinningPublic-Key-Pinning-Report-Only - 可以使用 hpkp 元素设置。 这允许 HTTPS 网站通过使用错误签发或其他欺诈证书来抵抗攻击者的模仿。

  • Content-Security-PolicyContent-Security-Policy-Report-Only - 可以使用 content-security-policy 元素设置。 内容安全策略 (CSP) 是一种机制,Web 应用程序可以利用它来缓解内容注入漏洞,例如跨站点脚本 (XSS)。

  • Referrer-Policy - 可以使用 referrer-policy 元素设置, Referrer-Policy 是一种机制,Web 应用程序可以利用它来管理 referrer 字段,该字段包含用户访问的最后一个页面。

  • Feature-Policy - 可以使用 feature-policy 元素设置, Feature-Policy 是一种机制,允许 Web 开发人员选择性地启用、禁用和修改浏览器中某些 API 和 Web 功能的行为。

  • Cross-Origin-Opener-Policy - 可以使用 cross-origin-opener-policy 元素设置, Cross-Origin-Opener-Policy 是一种机制,允许您确保顶级文档不会与跨域文档共享浏览上下文组。

  • Cross-Origin-Embedder-Policy - 可以使用 cross-origin-embedder-policy 元素设置, Cross-Origin-Embedder-Policy 是一种机制,可防止文档加载任何未明确授予文档权限的跨域资源。

  • Cross-Origin-Resource-Policy - 可以使用 cross-origin-resource-policy 元素设置,Cross-Origin-Resource-Policy 是一种机制,它传达了希望浏览器阻止对给定资源的 no-cors 跨源/跨站点请求的愿望。

<headers> 属性

<headers> 元素上的属性控制 headers 元素。

  • defaults-disabled 可选属性,指定是否禁用默认的 Spring Security HTTP 响应头。默认值为 false(包含默认头)。

  • disabled 可选属性,指定是否禁用 Spring Security 的 HTTP 响应头。默认值为 false(启用头)。

<headers> 的父元素

<cache-control>

添加 Cache-ControlPragmaExpires 头以确保浏览器不会缓存您的安全页面。

<cache-control> 属性

  • disabled 指定是否禁用缓存控制。默认值为 false。

<cache-control> 的父元素

<hsts>

启用后,将 Strict-Transport-Security 头添加到任何安全请求的响应中。这允许服务器指示浏览器在将来的请求中自动使用 HTTPS。

<hsts> 属性

  • disabled 指定是否禁用 Strict-Transport-Security。默认值为 false。

  • include-sub-domains 指定是否应包含子域。默认值为 true。

  • max-age-seconds 指定主机应被视为已知 HSTS 主机的最长时间。默认值为一年。

  • request-matcher-ref 用于确定是否应设置头的 RequestMatcher 实例。默认值为 HttpServletRequest.isSecure() 为 true。

  • preload 指定是否应包含预加载。默认值为 false。

<hsts> 的父元素

<hpkp>

启用后,会为任何安全请求的响应添加 HTTP 公钥固定扩展 标头。这允许 HTTPS 网站通过使用错误颁发或欺诈性证书来抵御攻击者的模仿。

<hpkp> 属性

  • disabled 指定是否应禁用 HTTP 公钥固定 (HPKP)。默认值为 true。

  • include-sub-domains 指定是否应包含子域。默认值为 false。

  • max-age-seconds 设置 Public-Key-Pins 标头的 max-age 指令的值。默认值为 60 天。

  • report-only 指定浏览器是否应该仅报告固定验证失败。默认值为 true。

  • report-uri 指定浏览器应报告固定验证失败的 URI。

<hpkp> 的父元素

<pins>

固定列表

<pins> 的子元素

<pin>

固定使用 base64 编码的 SPKI 指纹作为值,并使用加密哈希算法作为属性来指定

<pin> 属性

  • algorithm 加密哈希算法。默认值为 SHA256。

<pin> 的父元素

<content-security-policy>

启用后,会将 内容安全策略 (CSP) 标头添加到响应中。CSP 是一种机制,Web 应用程序可以利用它来缓解内容注入漏洞,例如跨站点脚本 (XSS)。

<content-security-policy> 属性

  • policy-directives 内容安全策略标头的安全策略指令,或者如果 report-only 设置为 true,则使用 Content-Security-Policy-Report-Only 标头。

  • report-only 设置为 true,以启用 Content-Security-Policy-Report-Only 标头,仅用于报告策略违规。默认值为 false。

<content-security-policy> 的父元素

<referrer-policy>

启用后,会将 推荐来源策略 标头添加到响应中。

<referrer-policy> 属性

  • policy 推荐来源策略标头的策略。默认值为 "no-referrer"。

<referrer-policy> 的父元素

<feature-policy>

启用后,会在响应中添加 功能策略 头部。

<feature-policy> 属性

  • policy-directives 功能策略头部的安全策略指令。

<feature-policy> 的父元素

<frame-options>

启用后,会在响应中添加 X-Frame-Options 头部,这允许较新的浏览器进行一些安全检查并防止 点击劫持 攻击。

<frame-options> 属性

  • disabled 如果禁用,则不会包含 X-Frame-Options 头部。默认值为 false。

  • policy

    • DENY 页面不能在框架中显示,无论尝试显示该页面的站点是什么。这是指定 frame-options-policy 时默认值。

    • SAMEORIGIN 页面只能在与页面本身相同来源的框架中显示

    换句话说,如果您指定 DENY,那么不仅从其他站点加载页面时尝试在框架中加载页面会失败,而且从同一站点加载页面时尝试在框架中加载页面也会失败。另一方面,如果您指定 SAMEORIGIN,则只要包含该页面的框架的站点与提供该页面的站点相同,您仍然可以在框架中使用该页面。

<frame-options> 的父元素

<permissions-policy>

在响应中添加 权限策略头部

<permissions-policy> 属性

  • policy 要为 Permissions-Policy 头部写入的策略值

<permissions-policy> 的父元素

<xss-protection>

在响应中添加 X-XSS-Protection 头部,以帮助防止 反射/类型 1 跨站点脚本 (XSS) 攻击。这绝不是对 XSS 攻击的完全保护!

<xss-protection> 属性

<xss-protection> 的父元素

<content-type-options>

将 X-Content-Type-Options 标头添加到响应中,其值为 nosniff。这 禁用 MIME 嗅探 用于 IE8+ 和 Chrome 扩展程序。

<content-type-options> 属性

  • disabled 指定是否应禁用内容类型选项。默认值为 false。

<content-type-options> 的父元素

<cross-origin-embedder-policy>

启用后,将 Cross-Origin-Embedder-Policy 标头添加到响应中。

<cross-origin-embedder-policy> 属性
  • policy Cross-Origin-Embedder-Policy 标头的策略。

<cross-origin-embedder-policy> 的父元素

<cross-origin-opener-policy>

启用后,将 Cross-Origin-Opener-Policy 标头添加到响应中。

<cross-origin-opener-policy> 属性
  • policy Cross-Origin-Opener-Policy 标头的策略。

<cross-origin-opener-policy> 的父元素

<cross-origin-resource-policy>

启用后,将 Cross-Origin-Resource-Policy 标头添加到响应中。

<cross-origin-resource-policy> 属性
  • policy Cross-Origin-Resource-Policy 标头的策略。

<cross-origin-resource-policy> 的父元素

<header>

将其他标头添加到响应中,需要指定名称和值。

<header-attributes> 属性

  • header-name 标头的 name

  • value 要添加的标头的 value

  • refHeaderWriter 接口的自定义实现的引用。

<header> 的父元素

<anonymous>

AnonymousAuthenticationFilter 添加到堆栈和 AnonymousAuthenticationProvider。如果您使用 IS_AUTHENTICATED_ANONYMOUSLY 属性,则需要此项。

<anonymous> 的父元素

<anonymous> 属性

  • enabled 使用默认命名空间设置,匿名“身份验证”功能会自动启用。您可以使用此属性禁用它。

  • granted-authority 应分配给匿名请求的授予的权限。通常,这用于为匿名请求分配特定角色,这些角色随后可用于授权决策。如果未设置,则默认为 ROLE_ANONYMOUS

  • key 提供者和过滤器之间共享的密钥。通常不需要设置此值。如果未设置,它将默认为安全随机生成的值。这意味着在使用匿名功能时,设置此值可以提高启动时间,因为安全随机值可能需要一段时间才能生成。

  • username 应分配给匿名请求的用户名。这允许识别主体,这对于日志记录和审计可能很重要。如果未设置,则默认为 anonymousUser

<csrf>

此元素将向应用程序添加 跨站点请求伪造 (CSRF) 保护。它还更新默认的 RequestCache,使其仅在成功身份验证后重播“GET”请求。更多信息可以在参考的 跨站点请求伪造 (CSRF) 部分找到。

<csrf> 的父元素

<csrf> 属性

  • disabled 可选属性,指定禁用 Spring Security 的 CSRF 保护。默认值为 false(启用 CSRF 保护)。强烈建议保持启用 CSRF 保护。

  • token-repository-ref 要使用的 CsrfTokenRepository。默认值为 HttpSessionCsrfTokenRepository

  • request-handler-ref 要使用的可选 CsrfTokenRequestHandler。默认值为 CsrfTokenRequestAttributeHandler

  • request-matcher-ref 要用于确定是否应应用 CSRF 的 RequestMatcher 实例。默认值为除“GET”、“TRACE”、“HEAD”、“OPTIONS”之外的任何 HTTP 方法。

<custom-filter>

此元素用于向过滤器链添加过滤器。它不会创建任何其他 bean,而是用于选择类型为 jakarta.servlet.Filter 的 bean(该 bean 已在应用程序上下文中定义)并在 Spring Security 维持的过滤器链中添加该 bean。完整详细信息可以在 命名空间章节 中找到。

<custom-filter> 的父元素

<custom-filter> 属性

  • after 在链中放置自定义过滤器的紧邻过滤器。此功能仅供希望将自己的过滤器混合到安全过滤器链中并了解标准 Spring Security 过滤器的用户使用。过滤器名称映射到特定的 Spring Security 实现过滤器。

  • before 在链中放置自定义过滤器的紧邻过滤器

  • position 在链中放置自定义过滤器的显式位置。如果您要替换标准过滤器,请使用此选项。

  • ref 定义对实现 Filter 的 Spring bean 的引用。

<expression-handler>

定义将用于启用基于表达式的访问控制的 SecurityExpressionHandler 实例。如果未提供,将使用默认实现(没有 ACL 支持)。

<expression-handler> 属性

  • ref 定义对实现 SecurityExpressionHandler 的 Spring bean 的引用。

<form-login>

用于将 UsernamePasswordAuthenticationFilter 添加到过滤器堆栈,并将 LoginUrlAuthenticationEntryPoint 添加到应用程序上下文以按需提供身份验证。这将始终优先于其他命名空间创建的入口点。如果未提供任何属性,则将在 URL "/login" [2] 自动生成登录页面。可以使用 <form-login> 属性 自定义行为。

<form-login> 的父元素

<form-login> 属性

  • always-use-default-target 如果设置为 true,则无论用户如何到达登录页面,用户都将始终从 default-target-url 给出的值开始。映射到 UsernamePasswordAuthenticationFilteralwaysUseDefaultTargetUrl 属性。默认值为 false

  • authentication-details-source-ref 对将由身份验证过滤器使用的 AuthenticationDetailsSource 的引用

  • authentication-failure-handler-ref 可用作 authentication-failure-url 的替代方案,让您完全控制身份验证失败后的导航流程。该值应为应用程序上下文中 AuthenticationFailureHandler bean 的名称。

  • authentication-failure-url 映射到 UsernamePasswordAuthenticationFilterauthenticationFailureUrl 属性。定义登录失败时浏览器将重定向到的 URL。默认值为 /login?error,它将由自动登录页面生成器自动处理,重新渲染登录页面并显示错误消息。

  • authentication-success-handler-ref 这可用于替代 default-target-urlalways-use-default-target,让您完全控制成功身份验证后的导航流程。该值应为应用程序上下文中 AuthenticationSuccessHandler bean 的名称。默认情况下,将使用 SavedRequestAwareAuthenticationSuccessHandler 的实现,并使用 default-target-url 进行注入。

  • default-target-url 映射到 UsernamePasswordAuthenticationFilterdefaultTargetUrl 属性。如果未设置,则默认值为 "/"(应用程序根目录)。用户登录后将被带到此 URL,前提是他们未在尝试访问受保护资源时被要求登录,在这种情况下,他们将被带到最初请求的 URL。

  • login-page 用于渲染登录页面的 URL。映射到 LoginUrlAuthenticationEntryPointloginFormUrl 属性。默认值为 "/login"。

  • login-processing-url 映射到 UsernamePasswordAuthenticationFilterfilterProcessesUrl 属性。默认值为 "/login"。

  • password-parameter 包含密码的请求参数的名称。默认值为 "password"。

  • username-parameter 包含用户名请求参数的名称。默认值为 "username"。

  • authentication-success-forward-urlForwardAuthenticationSuccessHandler 映射到 UsernamePasswordAuthenticationFilterauthenticationSuccessHandler 属性。

  • authentication-failure-forward-urlForwardAuthenticationFailureHandler 映射到 UsernamePasswordAuthenticationFilterauthenticationFailureHandler 属性。

<oauth2-login>

The OAuth 2.0 Login 功能使用 OAuth 2.0 和/或 OpenID Connect 1.0 提供者配置身份验证支持。

<oauth2-login> 的父元素

<oauth2-login> 属性

  • client-registration-repository-ref ClientRegistrationRepository 的引用。

  • authorized-client-repository-ref OAuth2AuthorizedClientRepository 的引用。

  • authorized-client-service-ref OAuth2AuthorizedClientService 的引用。

  • 授权请求存储库引用 AuthorizationRequestRepository 的引用。

  • 授权请求解析器引用 OAuth2AuthorizationRequestResolver 的引用。

  • 授权重定向策略引用 授权 RedirectStrategy 的引用。

  • 访问令牌响应客户端引用 OAuth2AccessTokenResponseClient 的引用。

  • 用户权限映射器引用 GrantedAuthoritiesMapper 的引用。

  • 用户服务引用 OAuth2UserService 的引用。

  • OpenID Connect 用户服务引用 OpenID Connect OAuth2UserService 的引用。

  • 登录处理 URL 过滤器处理身份验证请求的 URI。

  • 登录页面 发送用户登录的 URI。

  • 身份验证成功处理程序引用 AuthenticationSuccessHandler 的引用。

  • 身份验证失败处理程序引用 AuthenticationFailureHandler 的引用。

  • JWT 解码器工厂引用 OidcAuthorizationCodeAuthenticationProvider 使用的 JwtDecoderFactory 的引用。

<oauth2-client>

配置 OAuth 2.0 客户端 支持。

<oauth2-client> 的父元素

<oauth2-client> 的属性

  • client-registration-repository-ref ClientRegistrationRepository 的引用。

  • authorized-client-repository-ref OAuth2AuthorizedClientRepository 的引用。

  • authorized-client-service-ref OAuth2AuthorizedClientService 的引用。

<oauth2-client> 的子元素

<authorization-code-grant>

<authorization-code-grant> 的父元素

<authorization-code-grant> 的属性

  • 授权请求存储库引用 AuthorizationRequestRepository 的引用。

  • 授权重定向策略引用 授权 RedirectStrategy 的引用。

  • 授权请求解析器引用 OAuth2AuthorizationRequestResolver 的引用。

  • 访问令牌响应客户端引用 OAuth2AccessTokenResponseClient 的引用。

<client-registrations>

用于注册的客户端(ClientRegistration)的容器元素,这些客户端已注册到 OAuth 2.0 或 OpenID Connect 1.0 提供者。

<client-registrations> 的子元素

<client-registration>

表示已注册到 OAuth 2.0 或 OpenID Connect 1.0 提供者的客户端。

<client-registration> 的父元素

<client-registration> 属性

  • registration-id 用于唯一标识 ClientRegistration 的 ID。

  • client-id 客户端标识符。

  • client-secret 客户端密钥。

  • client-authentication-method 用于验证客户端与提供者身份验证的方法。支持的值为 client_secret_basicclient_secret_postprivate_key_jwtclient_secret_jwtnone (公共客户端)

  • authorization-grant-type OAuth 2.0 授权框架定义了四种 授权授权 类型。支持的值为 authorization_codeclient_credentialspassword,以及扩展授权类型 urn:ietf:params:oauth:grant-type:jwt-bearer

  • redirect-uri 客户端注册的重定向 URI,授权服务器 在最终用户完成身份验证并授权访问客户端后,将最终用户的用户代理重定向到该 URI。

  • scope 客户端在授权请求流程中请求的范围,例如 openid、email 或 profile。

  • client-name 用于客户端的描述性名称。该名称可能在某些情况下使用,例如在自动生成的登录页面中显示客户端名称时。

  • provider-id 对关联提供者的引用。可以引用 <provider> 元素或使用其中一个通用提供者(google、github、facebook、okta)。

<provider>

OAuth 2.0 或 OpenID Connect 1.0 提供者的配置信息。

<provider> 的父元素

<provider> 属性

  • provider-id 用于唯一标识提供者的 ID。

  • authorization-uri 授权服务器的授权端点 URI。

  • token-uri 授权服务器的令牌端点 URI。

  • user-info-uri 用于访问已验证最终用户声明/属性的用户信息端点 URI。

  • user-info-authentication-method 将访问令牌发送到用户信息端点时使用的身份验证方法。支持的值为 headerformquery

  • user-info-user-name-attribute UserInfo 响应中返回的属性名称,用于引用最终用户的姓名或标识符。

  • issuer-uri 用于使用 OpenID Connect 提供者的 配置端点 或授权服务器的 元数据端点 初始配置 ClientRegistration 的 URI。

<oauth2-resource-server>

BearerTokenAuthenticationFilterBearerTokenAuthenticationEntryPointBearerTokenAccessDeniedHandler 添加到配置中。此外,必须指定 <jwt><opaque-token>

<oauth2-resource-server> 的父元素

<oauth2-resource-server> 的子元素

<oauth2-resource-server> 属性

  • authentication-manager-resolver-refAuthenticationManagerResolver 的引用,该解析器将在请求时解析 AuthenticationManager

  • bearer-token-resolver-refBearerTokenResolver 的引用,该解析器将从请求中检索承载令牌

  • entry-point-refAuthenticationEntryPoint 的引用,该入口点将处理未经授权的请求

<jwt>

表示将授权 JWT 的 OAuth 2.0 资源服务器

<jwt> 的父元素

<jwt> 属性

  • jwt-authentication-converter-refConverter<Jwt, AbstractAuthenticationToken> 的引用

  • jwt-decoder-refJwtDecoder 的引用。这是一个更大的组件,它会覆盖 jwk-set-uri

  • jwk-set-uri 用于从 OAuth 2.0 授权服务器加载签名验证密钥的 JWK 集 URI

<opaque-token>

表示将授权不透明令牌的 OAuth 2.0 资源服务器

<opaque-token> 的父元素

<opaque-token> 属性

  • introspector-refOpaqueTokenIntrospector 的引用。这是一个更大的组件,它会覆盖 introspection-uriclient-idclient-secret

  • introspection-uri 用于内省不透明令牌详细信息的内省 URI。应与 client-idclient-secret 配合使用。

  • client-id 用于针对提供的 introspection-uri 进行客户端身份验证的客户端 ID。

  • client-secret 用于针对提供的 introspection-uri 进行客户端身份验证的客户端密钥。

  • authentication-converter-refOpaqueTokenAuthenticationConverter 的引用。负责将成功的内省结果转换为 Authentication 实例。

<relying-party-registrations>

注册的依赖方(ClientRegistration)与 SAML 2.0 身份提供者一起使用的容器元素。

<relying-party-registrations> 属性

  • id 唯一标识 RelyingPartyRegistrationRepository 的 ID。

<relying-party-registrations> 的子元素

<relying-party-registration>

表示与 SAML 2.0 身份提供者注册的依赖方

<relying-party-registration> 的父元素

<relying-party-registration> 属性

  • registration-id 唯一标识 RelyingPartyRegistration 的 ID。

  • metadata-location 声明方元数据位置。

  • assertion-consumer-service-location AssertionConsumerService 位置。等效于依赖方 <SPSSODescriptor><AssertionConsumerService Location="…​"/> 中找到的值。

  • assertion-consumer-service-binding AssertionConsumerService 绑定。等效于依赖方 <SPSSODescriptor><AssertionConsumerService Binding="…​"/> 中找到的值。支持的值为 POSTREDIRECT

  • single-logout-service-location SingleLogoutService 位置。等效于依赖方 <SPSSODescriptor><SingleLogoutService Location="…​"/> 中找到的值。

  • single-logout-service-response-location SingleLogoutService ResponseLocation。等效于依赖方 <SPSSODescriptor><SingleLogoutService ResponseLocation="…​"/> 中找到的值。

  • single-logout-service-binding 单点注销服务绑定。等效于依赖方 `` 中 `` 中的值。支持的值为 **POST** 和 **REDIRECT**。

  • asserting-party-id 与关联的断言方相关的引用。必须引用一个 `<asserting-party>` 元素。

<relying-party-registration> 的子元素

<decryption-credential>

与依赖方关联的解密凭据。

<decryption-credential> 的父元素

<decryption-credential> 属性

  • certificate-location 获取证书的位置

  • private-key-location 获取依赖方私钥的位置

<signing-credential>

与依赖方关联的签名凭据。

<verification-credential> 的父元素

<verification-credential> 属性

  • certificate-location 获取此证书的位置

  • private-key-location 获取依赖方私钥的位置

<asserting-party>

SAML 2.0 断言方的配置信息。

<asserting-party> 的父元素

<asserting-party> 属性

  • asserting-party-id 唯一标识断言方的 ID。

  • entity-id 断言方的 EntityID

  • want-authn-requests-signed `WantAuthnRequestsSigned` 设置,指示断言方希望依赖方在发送之前对 `AuthnRequest` 进行签名。

  • single-sign-on-service-binding 单点登录服务 绑定。支持的值为 **POST** 和 **REDIRECT**。

  • signing-algorithms 此断言方的 `org.opensaml.saml.ext.saml2alg.SigningMethod` 算法列表,按优先级排序。

  • single-logout-service-location 单点注销服务位置。等效于断言方<IDPSSODescriptor>中<SingleLogoutService Location="…​"/>中的值。

  • single-logout-service-response-location 单点注销服务响应位置。等效于断言方<IDPSSODescriptor>中<SingleLogoutService ResponseLocation="…​"/>中的值。

  • single-logout-service-binding 单点注销服务绑定。等效于断言方<IDPSSODescriptor>中<SingleLogoutService Binding="…​"/>中的值。支持的值为POSTREDIRECT

<asserting-party>的子元素

<encryption-credential>

与断言方关联的加密凭据。

<encryption-credential>的父元素

<encryption-credential>属性

  • certificate-location 获取证书的位置

  • private-key-location 获取依赖方私钥的位置

<verification-credential>

与断言方关联的验证凭据。

<verification-credential>的父元素

<verification-credential>属性

  • certificate-location 获取此证书的位置

  • private-key-location 获取依赖方私钥的位置

<http-basic>

在配置中添加BasicAuthenticationFilterBasicAuthenticationEntryPoint。后者仅在未启用基于表单的登录时用作配置入口点。

<http-basic>的父元素

<http-basic>属性

  • authentication-details-source-ref 对将由身份验证过滤器使用的 AuthenticationDetailsSource 的引用

  • entry-point-ref 设置BasicAuthenticationFilter使用的AuthenticationEntryPoint

<http-firewall>元素

这是一个顶级元素,可用于将HttpFirewall的自定义实现注入到命名空间创建的FilterChainProxy中。默认实现应该适用于大多数应用程序。

<http-firewall>属性

  • ref 定义一个指向实现 HttpFirewall 接口的 Spring bean 的引用。

<intercept-url>

此元素用于定义应用程序感兴趣的 URL 模式集,并配置如何处理它们。它用于构建 FilterSecurityInterceptor 使用的 FilterInvocationSecurityMetadataSource。它还负责配置 ChannelProcessingFilter,例如,如果特定 URL 需要通过 HTTPS 访问。当将指定的模式与传入请求匹配时,匹配是在元素声明的顺序中完成的。因此,最具体的模式应该放在最前面,最通用的模式应该放在最后面。

<intercept-url> 的父元素

<intercept-url> 属性

  • access 列出将存储在 FilterInvocationSecurityMetadataSource 中的访问属性,用于定义的 URL 模式/方法组合。这应该是一个逗号分隔的安全配置属性列表(例如角色名称)。

  • method 将与模式和 servlet 路径(可选)结合使用以匹配传入请求的 HTTP 方法。如果省略,任何方法都将匹配。如果使用和不使用方法指定了相同的模式,则特定于方法的匹配将优先。

  • pattern 定义 URL 路径的模式。内容将取决于包含 http 元素的 request-matcher 属性,因此如果 Spring MVC 在类路径中,将默认为 MVC 匹配器。

  • request-matcher-ref 指向 RequestMatcher 的引用,该引用将用于确定是否使用此 <intercept-url>

  • requires-channel 可以是 "http" 或 "https",具体取决于特定 URL 模式是否应该分别通过 HTTP 或 HTTPS 访问。或者,当没有偏好时,可以使用值 "any"。如果此属性存在于任何 <intercept-url> 元素上,则 ChannelProcessingFilter 将被添加到过滤器堆栈中,并且其附加依赖项将被添加到应用程序上下文中。

如果添加了 <port-mappings> 配置,则 SecureChannelProcessorInsecureChannelProcessor bean 将使用它来确定用于重定向到 HTTP/HTTPS 的端口。

此属性对于 filter-security-metadata-source 无效
  • servlet-path 用于与模式和 HTTP 方法结合以匹配传入请求的 servlet 路径。此属性仅在 request-matcher 为 'mvc' 时适用。此外,该值仅在以下两种情况下需要:1) 在 ServletContext 中注册了两个或多个 HttpServlet,它们具有以 '/' 开头的映射并且不同;2) 模式以注册的 HttpServlet 路径的相同值开头,不包括默认(根)HttpServlet '/'

此属性对于 filter-security-metadata-source 无效

<jee>

在过滤器链中添加 J2eePreAuthenticatedProcessingFilter 以提供与容器身份验证的集成。

<jee> 的父元素

<jee> 属性

  • mappable-roles 在传入的 HttpServletRequest 中查找的角色的逗号分隔列表。

  • user-service-ref 对用户服务(或 UserDetailsService bean)ID 的引用。

<logout>

在过滤器堆栈中添加 LogoutFilter。它配置了 SecurityContextLogoutHandler

<logout> 的父元素

<logout> 属性

  • delete-cookies 用户注销时应删除的 cookie 名称的逗号分隔列表。

  • invalidate-session 映射到 SecurityContextLogoutHandlerinvalidateHttpSession。默认为“true”,因此会话将在注销时失效。

  • logout-success-url 用户注销后将被带到的目标 URL。默认为 <form-login-login-page>/?logout(即 /login?logout)

    设置此属性将使用配置了属性值的 SimpleRedirectInvalidSessionStrategySessionManagementFilter 注入 SessionManagementFilter。当提交无效的会话 ID 时,将调用该策略,重定向到配置的 URL。

  • logout-url 将导致注销的 URL(即,将由过滤器处理的 URL)。默认为“/logout”。

  • success-handler-ref 可用于提供 LogoutSuccessHandler 的实例,该实例将在注销后被调用以控制导航。

<saml2-login>

SAML 2.0 登录 功能使用 SAML 2.0 服务提供者配置身份验证支持。

<saml2-login> 的父元素

<saml2-login> 属性

  • relying-party-registration-repository-refRelyingPartyRegistrationRepository 的引用。

  • authentication-request-repository-ref 指向 Saml2AuthenticationRequestRepository 的引用。

  • authentication-request-context-resolver-ref 指向 Saml2AuthenticationRequestResolver 的引用。

  • authentication-converter-ref 指向 AuthenticationConverter 的引用。

  • 登录处理 URL 过滤器处理身份验证请求的 URI。

  • 登录页面 发送用户登录的 URI。

  • 身份验证成功处理程序引用 AuthenticationSuccessHandler 的引用。

  • 身份验证失败处理程序引用 AuthenticationFailureHandler 的引用。

  • authentication-manager-ref 指向 AuthenticationManager 的引用。

<saml2-logout>

SAML 2.0 单点注销 功能配置了对 RP 和 AP 发起的 SAML 2.0 单点注销的支持。

<saml2-logout> 的父元素

<saml2-logout> 属性

  • logout-url 信赖方或断言方用来触发注销的 URL。

  • logout-request-url 断言方用来发送 SAML 2.0 注销请求的 URL。

  • logout-response-url 断言方用来发送 SAML 2.0 注销响应的 URL。

  • relying-party-registration-repository-refRelyingPartyRegistrationRepository 的引用。

  • logout-request-validator-ref 指向 Saml2LogoutRequestValidator 的引用。

  • logout-request-resolver-ref 指向 Saml2LogoutRequestResolver 的引用。

  • logout-request-repository-ref 指向 Saml2LogoutRequestRepository 的引用。

  • logout-response-validator-ref 指向 Saml2LogoutResponseValidator 的引用。

  • logout-response-resolver-ref 指向 Saml2LogoutResponseResolver 的引用。

<password-management>

此元素配置密码管理。

<password-management> 的父元素

<password-management> 属性

  • change-password-page 更改密码页面。默认值为 "/change-password"。

<port-mappings>

默认情况下,PortMapperImpl 的实例将被添加到配置中,用于重定向到安全和不安全的 URL。此元素可以选择用于覆盖该类定义的默认映射。每个子 <port-mapping> 元素定义一对 HTTP:HTTPS 端口。默认映射为 80:443 和 8080:8443。在 重定向到 HTTPS 中可以找到覆盖这些映射的示例。

<port-mappings> 的父元素

<port-mappings> 的子元素

<port-mapping>

提供了一种方法,在强制重定向时将 http 端口映射到 https 端口。

<port-mapping> 的父元素

<port-mapping> 属性

  • http 要使用的 http 端口。

  • https 要使用的 https 端口。

<remember-me>

RememberMeAuthenticationFilter 添加到堆栈中。 这反过来将根据属性设置配置为 TokenBasedRememberMeServicesPersistentTokenBasedRememberMeServices 或实现 RememberMeServices 的用户指定 bean。

<remember-me> 的父元素

<remember-me> 属性

  • authentication-success-handler-ref 如果需要自定义导航,则在 RememberMeAuthenticationFilter 上设置 authenticationSuccessHandler 属性。 该值应为应用程序上下文中的 AuthenticationSuccessHandler bean 的名称。

  • data-source-refDataSource bean 的引用。 如果设置了此属性,则将使用 PersistentTokenBasedRememberMeServices 并使用 JdbcTokenRepositoryImpl 实例进行配置。

  • remember-me-parameter 切换记住我身份验证的请求参数的名称。 默认值为“remember-me”。 映射到 AbstractRememberMeServices 的“parameter”属性。

  • key 映射到 AbstractRememberMeServices 的“key”属性。 应设置为唯一值,以确保记住我 cookie 仅在一个应用程序中有效 [3]。 如果未设置此属性,将生成一个安全的随机值。 由于生成安全的随机值可能需要一段时间,因此显式设置此值可以帮助在使用记住我功能时缩短启动时间。

  • services-alias 将内部定义的 RememberMeServices 导出为 bean 别名,允许应用程序上下文中的其他 bean 使用它。

  • services-ref 允许完全控制过滤器将使用的 RememberMeServices 实现。 该值应为应用程序上下文中的实现此接口的 bean 的 id。 如果使用注销过滤器,还应实现 LogoutHandler

  • token-repository-ref 配置 PersistentTokenBasedRememberMeServices,但允许使用自定义 PersistentTokenRepository bean。

  • token-validity-seconds 映射到 AbstractRememberMeServicestokenValiditySeconds 属性。 指定记住我 cookie 有效的秒数。 默认情况下,它将有效 14 天。

  • user-service-ref 记住我服务的实现需要访问 UserDetailsService,因此应用程序上下文中必须定义一个。如果只有一个,命名空间配置将自动选择并使用它。如果有多个实例,可以使用此属性显式指定 bean id

<request-cache> 元素

设置 RequestCache 实例,该实例将由 ExceptionTranslationFilter 用于在调用 AuthenticationEntryPoint 之前存储请求信息。

<request-cache> 的父元素

<request-cache> 属性

  • ref 定义对 Spring bean 的引用,该 bean 是一个 RequestCache

<session-management>

与会话管理相关的功能是通过在过滤器堆栈中添加 SessionManagementFilter 来实现的。

<session-management> 的父元素

<session-management> 属性

  • authentication-strategy-explicit-invocation 将此属性设置为 true 意味着 SessionManagementFilter 不会被注入,并且需要显式调用 SessionAuthenticationStrategy。

  • invalid-session-url 设置此属性将使用配置了属性值的 SimpleRedirectInvalidSessionStrategy 注入 SessionManagementFilter。当提交无效的会话 ID 时,将调用该策略,重定向到配置的 URL。

  • invalid-session-url 允许注入 SessionManagementFilter 使用的 InvalidSessionStrategy 实例。使用此属性或 invalid-session-url 属性,但不能同时使用两者。

  • session-authentication-error-url 定义当 SessionAuthenticationStrategy 抛出异常时应显示的错误页面的 URL。如果未设置,将向客户端返回未授权 (401) 错误代码。请注意,此属性不适用于在基于表单的登录期间发生的错误,在这种情况下,身份验证失败的 URL 将优先使用。

  • session-authentication-strategy-ref 允许注入 SessionManagementFilter 使用的 SessionAuthenticationStrategy 实例

  • session-fixation-protection 指示在用户身份验证时如何应用会话固定保护。如果设置为“none”,则不会应用任何保护。 “newSession” 将创建一个新的空会话,只有与 Spring Security 相关的属性被迁移。 “migrateSession” 将创建一个新的会话并将所有会话属性复制到新会话。在 Servlet 3.1(Java EE 7)和更新的容器中,指定“changeSessionId” 将保留现有会话并使用容器提供的会话固定保护(HttpServletRequest#changeSessionId())。在 Servlet 3.1 和更新的容器中默认为“changeSessionId”,在旧容器中默认为“migrateSession”。如果在旧容器中使用“changeSessionId”,则会抛出异常。

    如果启用了会话固定保护,则 SessionManagementFilter 将使用适当配置的 DefaultSessionAuthenticationStrategy 注入。有关更多详细信息,请参阅此类的 Javadoc。

<session-management> 的子元素

<concurrency-control>

添加对并发会话控制的支持,允许限制用户可以拥有的活动会话数量。将创建一个 ConcurrentSessionFilter,并将使用 ConcurrentSessionControlAuthenticationStrategySessionManagementFilter 一起使用。如果已声明 form-login 元素,则策略对象也将被注入到创建的身份验证过滤器中。将创建一个 SessionRegistry 实例(除非用户希望使用自定义 bean,否则为 SessionRegistryImpl 实例)供策略使用。

<concurrency-control> 的父元素

<concurrency-control> 属性

  • error-if-maximum-exceeded 如果设置为“true”,当用户尝试超过允许的最大会话数时,将引发 SessionAuthenticationException。默认行为是使原始会话过期。

  • expired-url 用户将被重定向到的 URL,如果他们尝试使用已被并发会话控制器“过期”的会话,因为用户已超过允许的会话数并在其他地方再次登录。应设置,除非设置了 exception-if-maximum-exceeded。如果没有提供值,则只会将过期消息直接写回响应。

  • expired-url 允许注入 ConcurrentSessionFilter 使用的 ExpiredSessionStrategy 实例

  • max-sessions 映射到 ConcurrentSessionControlAuthenticationStrategymaximumSessions 属性。指定 -1 作为值以支持无限会话。

  • session-registry-alias 拥有对内部会话注册表的引用以供您自己的 bean 或管理界面使用也很有用。您可以使用 session-registry-alias 属性公开内部 bean,并为其提供您可以在配置中其他地方使用的名称。

  • session-registry-ref 用户可以使用 session-registry-ref 属性提供自己的 SessionRegistry 实现。其他并发会话控制 bean 将被连接起来使用它。

<x509>

添加对 X.509 身份验证的支持。将向堆栈添加 X509AuthenticationFilter,并将创建一个 Http403ForbiddenEntryPoint bean。后者仅在没有使用其他身份验证机制时才会使用(其唯一功能是返回 HTTP 403 错误代码)。还将创建一个 PreAuthenticatedAuthenticationProvider,它将委托用户权限的加载到 UserDetailsService

<x509> 的父元素

<x509> 属性

  • authentication-details-source-refAuthenticationDetailsSource 的引用

  • subject-principal-regex 定义一个正则表达式,用于从证书中提取用户名(用于 UserDetailsService)。

  • user-service-ref 允许在配置多个实例的情况下,使用特定的 UserDetailsService 与 X.509 配合使用。如果未设置,将尝试自动查找合适的实例并使用它。

<filter-chain-map>

用于使用 FilterChainMap 显式配置 FilterChainProxy 实例

<filter-chain-map> 属性

  • request-matcher 定义用于匹配传入请求的策略。目前选项包括 'ant'(用于 ant 路径模式)、'regex' 用于正则表达式和 'ciRegex' 用于不区分大小写的正则表达式。

<filter-chain-map> 的子元素

<filter-chain>

用于在 中定义特定的 URL 模式以及应用于匹配该模式的 URL 的过滤器列表。当多个 filter-chain 元素按顺序组合在一起以配置 FilterChainProxy 时,最具体的模式必须放在列表的顶部,最通用的模式放在底部。

<filter-chain> 的父元素

<filter-chain> 属性

  • filters 实现 Filter 的 Spring bean 的逗号分隔列表。值 "none" 表示不应为此 FilterChain 使用任何 Filter

  • patternrequest-matcher 结合使用,创建 RequestMatcher 的模式。

  • request-matcher-refRequestMatcher 的引用,它将用于确定是否应调用 filters 属性中的任何 Filter

<filter-security-metadata-source>

用于显式配置 FilterSecurityMetadataSource bean 以与 FilterSecurityInterceptor 配合使用。通常只有在显式配置 FilterChainProxy 而不是使用 <http> 元素时才需要。使用的 intercept-url 元素应仅包含 patternmethodaccess 属性。任何其他属性都会导致配置错误。

<filter-security-metadata-source> 属性

  • id 用于在上下文中引用 bean 的 bean 标识符。

  • request-matcher 定义用于匹配传入请求的策略。目前,选项包括“ant”(用于 ant 路径模式)、“regex”(用于正则表达式)和“ciRegex”(用于不区分大小写的正则表达式)。

  • use-expressions 启用在 <intercept-url> 元素的“access”属性中使用表达式,而不是传统的配置属性列表。默认为“true”。如果启用,每个属性应包含单个布尔表达式。如果表达式计算结果为“true”,则授予访问权限。

<filter-security-metadata-source> 的子元素


1. 请参阅 xref:servlet/configuration/xml-namespace.adoc#ns-web-xml[介绍性章节
2. 此功能实际上只是为了方便提供,并不打算用于生产环境(在生产环境中,将选择视图技术并可用于呈现自定义登录页面)。类 DefaultLoginPageGeneratingFilter 负责呈现登录页面,并将为普通表单登录和/或 OIDC(如果需要)提供登录表单。
3. 这不会影响 PersistentTokenBasedRememberMeServices 的使用,其中令牌存储在服务器端。