操作指南:使用社交登录进行认证
本指南展示了如何配置 Spring Authorization Server 使用社交登录提供商(如 Google、GitHub 等)进行认证。本指南的目的是演示如何将表单登录替换为OAuth 2.0 登录。
Spring Authorization Server 基于Spring Security构建,本指南将贯穿使用 Spring Security 的概念。 |
注册社交登录提供商
首先,您需要在使用选择的社交登录提供商处设置一个应用程序。常见的提供商包括
按照您选择的提供商的步骤进行操作,直到要求指定重定向 URI。要设置重定向 URI,请选择一个 registrationId
(例如 google
、my-client
或您希望的任何其他唯一标识符),您将使用它来配置 Spring Security **以及**您的提供商。
registrationId 是 Spring Security 中 ClientRegistration 的唯一标识符。默认的重定向 URI 模板是 {baseUrl}/login/oauth2/code/{registrationId} 。有关更多信息,请参阅 Spring Security 参考文档中的设置重定向 URI。 |
例如,在本地端口 9000 上使用 registrationId 为 google 进行测试时,您的重定向 URI 将是 localhost:9000/login/oauth2/code/google。在您的提供商处设置应用程序时,输入此值作为重定向 URI。 |
完成社交登录提供商的设置过程后,您应该已获得凭据(客户端 ID 和客户端密钥)。此外,您还需要参考提供商的文档并记下以下值
-
授权 URI:用于在提供商处启动
authorization_code
流程的端点。 -
令牌 URI:用于将
authorization_code
交换为access_token
以及可选的id_token
的端点。 -
JWK Set URI:用于获取密钥以验证 JWT 签名的端点,当
id_token
可用时需要此项。 -
用户信息 URI:用于获取用户信息的端点,当
id_token
不可用时需要此项。 -
用户名属性:
id_token
或用户信息响应中包含用户名的声明(claim)。
配置 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 )设置提供商 URL、客户端 ID 和客户端密钥的**推荐**方法。有关更多信息,请参阅 Spring Boot 参考文档中的外部化配置。 |
这个简单的示例展示了一个典型的配置,但某些提供商需要额外的配置。有关配置 ClientRegistration
的更多信息,请参阅 Spring Security 参考文档中的Spring Boot 属性映射。
配置认证
最后,要配置 Spring Authorization Server 使用社交登录提供商进行认证,您可以使用 oauth2Login()
代替 formLogin()
。您还可以通过使用 AuthenticationEntryPoint
配置 exceptionHandling()
将未认证用户自动重定向到提供商。
继续我们的之前的示例,使用 `@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
,现在可以将其移除。
高级用例
demo 授权服务器示例演示了联合身份提供商的高级配置选项。从以下用例中选择以查看每个示例
-
我想将用户存储在数据库中
-
我想将声明映射到 ID 令牌
将用户存储在数据库中
以下示例 AuthenticationSuccessHandler
使用自定义组件在用户首次登录时将其存储在本地数据库中
FederatedIdentityAuthenticationSuccessHandler
import 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) {
this.oidcUserHandler.accept((OidcUser) authentication.getPrincipal());
} else if (authentication.getPrincipal() instanceof OAuth2User) {
this.oauth2UserHandler.accept((OAuth2User) authentication.getPrincipal());
}
}
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>
,用于将用户存储在数据库或其他数据存储中,以实现联合账户链接或 JIT 账户 Provisioning 等概念。这是一个简单地将用户存储在内存中的示例
UserRepositoryOAuth2UserHandler
import 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 令牌
以下示例 OAuth2TokenCustomizer
将用户从认证提供商获得的声明映射到 Spring Authorization Server 生成的 id_token
FederatedIdentityIdTokenCustomizer
import 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 oidcUser = (OidcUser) principal.getPrincipal();
OidcIdToken idToken = oidcUser.getIdToken();
claims = idToken.getClaims();
} else if (principal.getPrincipal() instanceof OAuth2User) {
OAuth2User oauth2User = (OAuth2User) principal.getPrincipal();
claims = oauth2User.getAttributes();
} else {
claims = Collections.emptyMap();
}
return new HashMap<>(claims);
}
}
您可以通过将其发布为 `@Bean` 来配置 Spring Authorization Server 使用此定制器,示例如下
@Bean
public OAuth2TokenCustomizer<JwtEncodingContext> idTokenCustomizer() {
return new FederatedIdentityIdTokenCustomizer();
}