操作指南:使用 PKCE 的单页应用程序进行身份验证

本指南介绍如何配置 Spring 授权服务器 以支持使用 Proof Key for Code Exchange (PKCE) 的单页应用程序 (SPA)。本指南的目的是演示如何支持公共客户端并要求使用 PKCE 进行客户端身份验证。

Spring 授权服务器不会为公共客户端颁发刷新令牌。我们建议使用后端到前端 (BFF) 模式作为公开公共客户端的替代方案。有关更多信息,请参阅 gh-297

启用 CORS

SPA 由静态资源组成,这些资源可以通过多种方式部署。它可以与后端分开部署,例如使用 CDN 或单独的 Web 服务器,也可以与使用 Spring Boot 的后端一起部署。

当 SPA 托管在不同的域下时,可以使用跨域资源共享 (CORS) 允许应用程序与后端进行通信。

例如,如果您在端口 4200 上本地运行 Angular 开发服务器,则可以定义一个 CorsConfigurationSource @Bean 并配置 Spring Security 以允许使用 cors() DSL 进行预检请求,如以下示例所示

启用 CORS
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.annotation.Order;
import org.springframework.http.MediaType;
import org.springframework.security.config.Customizer;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.oauth2.server.authorization.config.annotation.web.configuration.OAuth2AuthorizationServerConfiguration;
import org.springframework.security.oauth2.server.authorization.config.annotation.web.configurers.OAuth2AuthorizationServerConfigurer;
import org.springframework.security.web.SecurityFilterChain;
import org.springframework.security.web.authentication.LoginUrlAuthenticationEntryPoint;
import org.springframework.security.web.util.matcher.MediaTypeRequestMatcher;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.CorsConfigurationSource;
import org.springframework.web.cors.UrlBasedCorsConfigurationSource;

@Configuration
@EnableWebSecurity
public class SecurityConfig {

	@Bean
	@Order(1)
	public SecurityFilterChain authorizationServerSecurityFilterChain(HttpSecurity http)
			throws Exception {
		OAuth2AuthorizationServerConfiguration.applyDefaultSecurity(http);
		http.getConfigurer(OAuth2AuthorizationServerConfigurer.class)
			.oidc(Customizer.withDefaults());	// Enable OpenID Connect 1.0
		http
			// Redirect to the login page when not authenticated from the
			// authorization endpoint
			.exceptionHandling((exceptions) -> exceptions
				.defaultAuthenticationEntryPointFor(
					new LoginUrlAuthenticationEntryPoint("/login"),
					new MediaTypeRequestMatcher(MediaType.TEXT_HTML)
				)
			)
			// Accept access tokens for User Info and/or Client Registration
			.oauth2ResourceServer((oauth2) -> oauth2.jwt(Customizer.withDefaults()));

		return http.cors(Customizer.withDefaults()).build();
	}

	@Bean
	@Order(2)
	public SecurityFilterChain defaultSecurityFilterChain(HttpSecurity http)
			throws Exception {
		http
			.authorizeHttpRequests((authorize) -> authorize
				.anyRequest().authenticated()
			)
			// Form login handles the redirect to the login page from the
			// authorization server filter chain
			.formLogin(Customizer.withDefaults());

		return http.cors(Customizer.withDefaults()).build();
	}

	@Bean
	public CorsConfigurationSource corsConfigurationSource() {
		UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
		CorsConfiguration config = new CorsConfiguration();
		config.addAllowedHeader("*");
		config.addAllowedMethod("*");
		config.addAllowedOrigin("http://127.0.0.1:4200");
		config.setAllowCredentials(true);
		source.registerCorsConfiguration("/**", config);
		return source;
	}

}
单击上面的代码示例中的“展开折叠文本”图标以显示完整示例。

配置公共客户端

SPA 无法安全地存储凭据,因此必须被视为 公共客户端。公共客户端应要求使用 Proof Key for Code Exchange (PKCE)。

继续 前面的 示例,您可以配置 Spring 授权服务器以使用客户端身份验证方法 none 支持公共客户端,并要求使用 PKCE,如以下示例所示

  • Yaml

  • Java

spring:
  security:
    oauth2:
      authorizationserver:
        client:
          public-client:
            registration:
              client-id: "public-client"
              client-authentication-methods:
                - "none"
              authorization-grant-types:
                - "authorization_code"
              redirect-uris:
                - "http://127.0.0.1:4200"
              scopes:
                - "openid"
                - "profile"
            require-authorization-consent: true
            require-proof-key: true
@Bean
public RegisteredClientRepository registeredClientRepository() {
	RegisteredClient publicClient = RegisteredClient.withId(UUID.randomUUID().toString())
		.clientId("public-client")
		.clientAuthenticationMethod(ClientAuthenticationMethod.NONE)
		.authorizationGrantType(AuthorizationGrantType.AUTHORIZATION_CODE)
		.redirectUri("http://127.0.0.1:4200")
		.scope(OidcScopes.OPENID)
		.scope(OidcScopes.PROFILE)
		.clientSettings(ClientSettings.builder()
			.requireAuthorizationConsent(true)
			.requireProofKey(true)
			.build()
		)
		.build();

	return new InMemoryRegisteredClientRepository(publicClient);
}
requireProofKey 设置对于防止 PKCE 降级攻击 非常重要。

使用客户端进行身份验证

一旦服务器配置为支持公共客户端,一个常见的问题是:如何验证客户端并获取访问令牌? 简短的答案是:与任何其他客户端一样。

SPA 是基于浏览器的应用程序,因此使用与任何其他客户端相同的基于重定向的流程。这个问题通常与对通过 REST API 执行身份验证的期望有关,而这在 OAuth2 中并非如此。

更详细的答案需要了解 OAuth2 和 OpenID Connect 中涉及的流程,在本例中为授权码流程。授权码流程的步骤如下

  1. 客户端通过重定向到 授权端点 发起 OAuth2 请求。对于公共客户端,此步骤包括生成 code_verifier 并计算 code_challenge,然后将其作为查询参数发送。

  2. 如果用户未经身份验证,授权服务器将重定向到登录页面。身份验证后,用户将被重定向回授权端点。

  3. 如果用户尚未同意请求的范围,并且需要同意,则会显示同意页面。

  4. 一旦用户同意,授权服务器将生成一个 authorization_code 并通过 redirect_uri 重定向回客户端。

  5. 客户端通过查询参数获取 authorization_code,并对 令牌端点 执行请求。对于公共客户端,此步骤包括发送 code_verifier 参数而不是凭据进行身份验证。

如您所见,流程相当复杂,此概述只是触及了表面。

建议您使用单页应用程序框架支持的强大的客户端库来处理授权码流程。