如何使用社交登录进行身份验证
此指南展示了如何使用社交登录提供商(如 Google、GitHub 等)配置 Spring Authorization Server 进行认证。 本指南的目的是演示如何用OAuth 2.0 登录替换表单登录。
| Spring Authorization Server 是基于 Spring Security 构建的,我们将在此指南中使用 Spring Security 的概念。 |
使用社交登录提供商注册
要开始,请设置一个应用程序并与您选择的社交登录提供商进行集成。 常见的提供者包括:
根据提供商的步骤操作,直到被要求指定重定向URI。
要设置重定向URI,请选择一个registrationId(例如google、my-client或其他您愿意使用的唯一标识符),并将此标识符用于配置Spring Security 以及 您的提供商。
The registrationId 是 Spring Security 中 ClientRegistration 的唯一标识符。默认的重定向 URI 模板是 {baseUrl}/login/oauth2/code/{registrationId}。请参阅 设置重定向 URI 在 Spring Security 参考文档中以获取更多信息。 |
例如,在本地端口9000进行测试,且registrationId的值为google时,你的重定向URI将是localhost:9000/login/oauth2/code/google。在与提供者设置应用程序时,请将此值作为重定向URI输入。 |
完成与社交登录提供商的设置过程后,您应该已经获得了凭据(客户端ID和客户端密钥)。 此外,您还需要参考提供商的文档,并注意以下值:
-
授权URI:用于在提供方启动
authorization_code流的端点。 -
Token URI: 用于交换一个
authorization_code为一个access_token,并可选地交换一个id_token的端点。 -
JWK Set URI: 用于获取验证JWT签名所需密钥的端点,在存在
id_token的情况下需要使用该端点。 -
User Info URI: 获取用户信息的端点,当
id_token不可用时需要使用。 -
用户名称属性: 包含用户名的声明位于
id_token或用户信息响应中。
配置 OAuth 2.0 登录
一旦您已通过社交登录提供商完成注册,即可继续配置Spring Security以支持OAuth 2.0 登录。
添加 OAuth2 客户端依赖项
首先,添加以下依赖项:
-
Maven
-
Gradle
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-oauth2-client</artifactId>
</dependency>
implementation "org.springframework.boot:spring-boot-starter-oauth2-client"
注册客户端
接下来,使用获取到的值配置 ClientRegistration。
以 Okta 为例,配置以下属性:
okta:
base-url: ${OKTA_BASE_URL}
spring:
security:
oauth2:
client:
registration:
my-client:
provider: okta
client-id: ${OKTA_CLIENT_ID}
client-secret: ${OKTA_CLIENT_SECRET}
scope:
- openid
- profile
- email
provider:
okta:
authorization-uri: ${okta.base-url}/oauth2/v1/authorize
token-uri: ${okta.base-url}/oauth2/v1/token
user-info-uri: ${okta.base-url}/oauth2/v1/userinfo
jwk-set-uri: ${okta.base-url}/oauth2/v1/keys
user-name-attribute: sub
在上述示例中,registrationId 实际上是 my-client。 |
上述示例展示了使用环境变量(OKTA_BASE_URL、OKTA_CLIENT_ID 和 OKTA_CLIENT_SECRET)设置 Provider URL、Client ID 和 Client Secret 的推荐方式。更多详情请参阅 外部化配置 在 Spring Boot 参考文档中。 |
此简单的示例演示了一个典型的配置,但某些提供商会要求额外的配置。
有关如何配置ClientRegistration的更多信息,请参阅Spring Security参考中的Spring Boot 属性映射。
配置身份验证
最后,要配置 Spring Authorization Server 使用社会登录提供商进行身份验证,可以将oauth2Login()用于替代formLogin()。
您还可以通过将exceptionHandling()配置为带有AuthenticationEntryPoint来自动重定向未认证的用户到提供商。
继续我们之前的示例,使用@Configuration配置Spring Security,如下所示:
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.configurers.OAuth2AuthorizationServerConfigurer;
import org.springframework.security.web.SecurityFilterChain;
import org.springframework.security.web.authentication.LoginUrlAuthenticationEntryPoint;
import org.springframework.security.web.util.matcher.MediaTypeRequestMatcher;
@Configuration
@EnableWebSecurity
public class SecurityConfig {
@Bean (1)
@Order(1)
public SecurityFilterChain authorizationServerSecurityFilterChain(HttpSecurity http)
throws Exception {
OAuth2AuthorizationServerConfigurer authorizationServerConfigurer =
OAuth2AuthorizationServerConfigurer.authorizationServer();
http
.securityMatcher(authorizationServerConfigurer.getEndpointsMatcher())
.with(authorizationServerConfigurer, (authorizationServer) ->
authorizationServer
.oidc(Customizer.withDefaults()) // Enable OpenID Connect 1.0
)
.authorizeHttpRequests((authorize) ->
authorize
.anyRequest().authenticated()
)
// Redirect to the OAuth 2.0 Login endpoint when not authenticated
// from the authorization endpoint
.exceptionHandling((exceptions) -> exceptions
.defaultAuthenticationEntryPointFor( (2)
new LoginUrlAuthenticationEntryPoint("/oauth2/authorization/my-client"),
new MediaTypeRequestMatcher(MediaType.TEXT_HTML)
)
);
return http.build();
}
@Bean (3)
@Order(2)
public SecurityFilterChain defaultSecurityFilterChain(HttpSecurity http)
throws Exception {
http
.authorizeHttpRequests((authorize) -> authorize
.anyRequest().authenticated()
)
// OAuth2 Login handles the redirect to the OAuth 2.0 Login endpoint
// from the authorization server filter chain
.oauth2Login(Customizer.withDefaults()); (4)
return http.build();
}
}
| 1 | 用于协议端点的 Spring Security 过滤器链。 |
| 2 | 配置一个AuthenticationEntryPoint以重定向到OAuth 2.0 登录端点。 |
| 3 | Spring Security 过滤器链用于身份验证。 |
| 4 | 配置OAuth 2.0 登录以进行身份验证。 |
如果您在开始时配置了UserDetailsService,现在可以移除它。
高级用例
The demo授权服务器示例展示了与身份提供商集成的高级配置选项。 请选择以下用例之一,查看每个用例的示例:
-
我想通过捕获数据库中的用户
在数据库中捕获用户
The following example AuthenticationSuccessHandler uses a custom component to capture users in a local database when they first log in:
FederatedIdentityAuthenticationSuccessHandlerimport java.io.IOException;
import java.util.function.Consumer;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.security.core.Authentication;
import org.springframework.security.oauth2.client.authentication.OAuth2AuthenticationToken;
import org.springframework.security.oauth2.core.oidc.user.OidcUser;
import org.springframework.security.oauth2.core.user.OAuth2User;
import org.springframework.security.web.authentication.AuthenticationSuccessHandler;
import org.springframework.security.web.authentication.SavedRequestAwareAuthenticationSuccessHandler;
public final class FederatedIdentityAuthenticationSuccessHandler implements AuthenticationSuccessHandler {
private final AuthenticationSuccessHandler delegate = new SavedRequestAwareAuthenticationSuccessHandler();
private Consumer<OAuth2User> oauth2UserHandler = (user) -> {};
private Consumer<OidcUser> oidcUserHandler = (user) -> this.oauth2UserHandler.accept(user);
@Override
public void onAuthenticationSuccess(HttpServletRequest request, HttpServletResponse response, Authentication authentication) throws IOException, ServletException {
if (authentication instanceof OAuth2AuthenticationToken) {
if (authentication.getPrincipal() instanceof OidcUser oidcUser) {
this.oidcUserHandler.accept(oidcUser);
} else if (authentication.getPrincipal() instanceof OAuth2User oauth2User) {
this.oauth2UserHandler.accept(oauth2User);
}
}
this.delegate.onAuthenticationSuccess(request, response, authentication);
}
public void setOAuth2UserHandler(Consumer<OAuth2User> oauth2UserHandler) {
this.oauth2UserHandler = oauth2UserHandler;
}
public void setOidcUserHandler(Consumer<OidcUser> oidcUserHandler) {
this.oidcUserHandler = oidcUserHandler;
}
}
使用上述的 AuthenticationSuccessHandler,您可以插入自己的 Consumer<OAuth2User> 来捕获用户并将其存储在数据库或其他数据存储中,用于类似统一账号关联或即时账号创建的概念。
以下是一个简单的示例,它将用户存放在内存中:
UserRepositoryOAuth2UserHandlerimport java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Consumer;
import org.springframework.security.oauth2.core.user.OAuth2User;
public final class UserRepositoryOAuth2UserHandler implements Consumer<OAuth2User> {
private final UserRepository userRepository = new UserRepository();
@Override
public void accept(OAuth2User user) {
// Capture user in a local data store on first authentication
if (this.userRepository.findByName(user.getName()) == null) {
System.out.println("Saving first-time user: name=" + user.getName() + ", claims=" + user.getAttributes() + ", authorities=" + user.getAuthorities());
this.userRepository.save(user);
}
}
static class UserRepository {
private final Map<String, OAuth2User> userCache = new ConcurrentHashMap<>();
public OAuth2User findByName(String name) {
return this.userCache.get(name);
}
public void save(OAuth2User oauth2User) {
this.userCache.put(oauth2User.getName(), oauth2User);
}
}
}
将声明映射到 ID Tokens
The following example OAuth2TokenCustomizer maps a user’s claims from an authentication provider to the id_token produced by Spring Authorization Server:
FederatedIdentityIdTokenCustomizerimport java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import org.springframework.security.core.Authentication;
import org.springframework.security.oauth2.core.oidc.IdTokenClaimNames;
import org.springframework.security.oauth2.core.oidc.OidcIdToken;
import org.springframework.security.oauth2.core.oidc.endpoint.OidcParameterNames;
import org.springframework.security.oauth2.core.oidc.user.OidcUser;
import org.springframework.security.oauth2.core.user.OAuth2User;
import org.springframework.security.oauth2.server.authorization.token.JwtEncodingContext;
import org.springframework.security.oauth2.server.authorization.token.OAuth2TokenCustomizer;
public final class FederatedIdentityIdTokenCustomizer implements OAuth2TokenCustomizer<JwtEncodingContext> {
private static final Set<String> ID_TOKEN_CLAIMS = Collections.unmodifiableSet(new HashSet<>(Arrays.asList(
IdTokenClaimNames.ISS,
IdTokenClaimNames.SUB,
IdTokenClaimNames.AUD,
IdTokenClaimNames.EXP,
IdTokenClaimNames.IAT,
IdTokenClaimNames.AUTH_TIME,
IdTokenClaimNames.NONCE,
IdTokenClaimNames.ACR,
IdTokenClaimNames.AMR,
IdTokenClaimNames.AZP,
IdTokenClaimNames.AT_HASH,
IdTokenClaimNames.C_HASH
)));
@Override
public void customize(JwtEncodingContext context) {
if (OidcParameterNames.ID_TOKEN.equals(context.getTokenType().getValue())) {
Map<String, Object> thirdPartyClaims = extractClaims(context.getPrincipal());
context.getClaims().claims(existingClaims -> {
// Remove conflicting claims set by this authorization server
existingClaims.keySet().forEach(thirdPartyClaims::remove);
// Remove standard id_token claims that could cause problems with clients
ID_TOKEN_CLAIMS.forEach(thirdPartyClaims::remove);
// Add all other claims directly to id_token
existingClaims.putAll(thirdPartyClaims);
});
}
}
private Map<String, Object> extractClaims(Authentication principal) {
Map<String, Object> claims;
if (principal.getPrincipal() instanceof OidcUser oidcUser) {
OidcIdToken idToken = oidcUser.getIdToken();
claims = idToken.getClaims();
} else if (principal.getPrincipal() instanceof OAuth2User oauth2User) {
claims = oauth2User.getAttributes();
} else {
claims = Collections.emptyMap();
}
return new HashMap<>(claims);
}
}
您可以将自定义程序集配置为Spring授权服务器使用,通过将其发布为@Bean,如下例所示:
FederatedIdentityIdTokenCustomizer@Bean
public OAuth2TokenCustomizer<JwtEncodingContext> idTokenCustomizer() {
return new FederatedIdentityIdTokenCustomizer();
}