SpringCloud之SSO单点登录-基于Gateway和OAuth2的跨系统统一认证和鉴权详解

本文详述了如何利用SpringCloud、Gateway和OAuth2实现跨系统的统一认证和鉴权。文章介绍了SSO单点登录的概念和优势，通过具体的配置和代码示例，讲解了如何搭建一个安全、高效的认证中心，实现用户只需一次登录即可访问多个系统的目标，从而提高系统安全性和用户体验。

Damon_Liu_0806

13247人浏览 · 2024-05-29 00:46:29

Damon_Liu_0806 · 2024-05-29 00:46:29 发布

单点登录（SSO）是一种身份验证过程，允许用户通过一次登录访问多个系统。本文将深入解析单点登录的原理，并详细介绍如何在Spring Cloud环境中实现单点登录。通过具体的架构图和代码示例，我们将展示SSO的工作机制和优势，帮助开发者更好地理解和应用这一技术。

在这里插入图片描述

一、单点登录简介

1、单点登录介绍

单点登录（Single Sign-On，简称SSO）是一种认证机制，允许用户通过一次身份验证后，访问多个相互信任的应用系统。它简化了用户的操作，提高了用户体验，同时也降低了管理多个认证系统的复杂性。在现代分布式系统和微服务架构中，SSO尤为重要，因为它可以减少重复的登录操作，统一用户认证入口，提高系统的安全性和可管理性。

2、单点登录原理

SSO的基本原理是通过共享认证状态来实现对多个系统的访问。其核心步骤包括：

用户认证：用户在SSO认证中心进行登录，认证中心验证用户身份后生成一个Token。
Token共享：用户访问其他受信任的应用系统时，携带这个Token。应用系统通过验证Token来确认用户身份。
会话管理：SSO系统管理用户会话状态，确保用户在有效期内不需要重复登录。

3、单点登录架构图

在这里插入图片描述

二、单点登录实现

在Spring Cloud环境中实现单点登录需要考虑以下几个步骤：

步骤	描述
1. 建立认证中心	创建一个专门的认证服务，负责用户登录和Token生成。可以使用Spring Security和OAuth2来实现这一功能。
2. 配置网关服务	通过Spring Cloud Gateway或Zuul来实现请求路由和Token验证。
3. 应用服务集成	将各个应用服务与认证中心集成，确保每个请求都经过Token验证。

1. 建立认证中心

认证中心负责用户认证和Token生成。可以使用Spring Security和OAuth2来实现认证中心。

OAuth2 协议介绍：

OAuth2 协议是一种授权框架，允许第三方应用在用户授权下，访问用户的资源而无需共享用户的凭据，常用于社交媒体登录等场景。

OAuth2 协议一共支持四种不同的授权模式：

授权码模式：大多数第三方平台登录功能都采用这种模式，因其具有较高的安全性。
简化模式：简化模式不需要第三方服务器（客户端）的参与，直接在浏览器中向授权服务器申请令牌（token）。如果网站是纯静态页面，可以采用这种方式。
密码模式：密码模式要求用户将用户名和密码直接提供给客户端，客户端再使用这些信息向授权服务器申请令牌（token）。这种模式需要用户对客户端有高度的信任，例如客户端应用和服务器提供商是同一家公司。
客户端模式：客户端模式是指客户端以自己的名义而非用户的名义向授权服务器申请授权。严格来说，客户端模式并不属于OAuth协议的典型解决方案，但在某些移动端授权服务器上使用这种模式对开发者来说非常方便。

最常用的是授权码模式，也是我们这里使用的模式。

OAuth2 授权码模式示意图：

为了更清晰地展示授权码模式的每个环节，我们可以使用Mermaid将流程分为几个部分。以下是分成四张图分别介绍每个环节的示例代码：

Step 1: 用户请求资源并重定向到授权服务器

在这里插入图片描述

Step 2: 用户同意授权并获取授权码

在这里插入图片描述

Step 3: 客户端交换授权码获取访问令牌

在这里插入图片描述

Step 4: 客户端使用访问令牌访问资源服务器

在这里插入图片描述

① 添加OAuth2依赖

给项目添加OAuth2依赖项：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-oauth2-client</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-oauth2-resource-server</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.security</groupId>
    <artifactId>spring-security-oauth2-jose</artifactId>
</dependency>

② 配置OAuth2认证服务器

创建并配置OAuth2认证服务器：

@Configuration
@EnableAuthorizationServer
public class AuthorizationServerConfig extends AuthorizationServerConfigurerAdapter {

    @Autowired
    private AuthenticationManager authenticationManager;

    @Override
    public void configure(ClientDetailsServiceConfigurer clients) throws Exception {
        clients.inMemory()
                .withClient("client-id")
                .secret("{noop}client-secret")
                .authorizedGrantTypes("authorization_code", "refresh_token", "password")
                .scopes("read", "write")
                .redirectUris("http://localhost:8081/login/oauth2/code/custom");
    }

    @Override
    public void configure(AuthorizationServerEndpointsConfigurer endpoints) throws Exception {
        endpoints.authenticationManager(authenticationManager)
                 .tokenStore(new InMemoryTokenStore());
    }
}

③ 配置Spring Security

创建并配置Spring Security：

@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(AuthenticationManagerBuilder auth) throws Exception {
        auth.inMemoryAuthentication()
            .withUser("user")
            .password("{noop}password")
            .roles("USER");
    }

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
            .anyRequest().authenticated()
            .and()
            .formLogin().permitAll();
    }

    @Bean
    @Override
    public AuthenticationManager authenticationManagerBean() throws Exception {
        return super.authenticationManagerBean();
    }
}

2. 配置网关服务

网关服务负责路由请求和验证Token。我们使用Spring Cloud Gateway来实现。

① 添加网关服务依赖

给项目添加网关服务依赖项：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-oauth2-client</artifactId>
</dependency>

② 增加Gateway配置

在application.yml中添加Gateway配置：

spring:
  cloud:
    gateway:
      routes:
        - id: user-service
          uri: lb://USER-SERVICE
          predicates:
            - Path=/user/**
          filters:
            - TokenRelay
  security:
    oauth2:
      client:
        provider:
          custom:
            authorization-uri: http://localhost:8080/oauth/authorize
            token-uri: http://localhost:8080/oauth/token
            user-info-uri: http://localhost:8080/userinfo
            jwk-set-uri: http://localhost:8080/.well-known/jwks.json
        registration:
          custom:
            client-id: client-id
            client-secret: client-secret
            authorization-grant-type: authorization_code
            redirect-uri: "{baseUrl}/login/oauth2/code/{registrationId}"
            scope: read,write

3. 应用服务集成

每个微服务都需要配置为资源服务器，以确保每个请求都经过Token验证。

① 给每个服务添加依赖

给每个服务添加OAuth2资源服务器依赖项：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-oauth2-resource-server</artifactId>
</dependency>

② 给每个服务添加配置

在application.yml中添加OAuth2资源服务器配置：

spring:
  security:
    oauth2:
      resourceserver:
        jwt:
          issuer-uri: http://localhost:8080/

③ 配置安全策略

创建并配置Spring Security以确保所有请求都经过Token验证：

@Configuration
@EnableWebSecurity
public class ResourceServerConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests()
            .antMatchers("/public/**").permitAll()
            .anyRequest().authenticated()
            .and()
            .oauth2ResourceServer().jwt();
    }
}

4、编写单点登录接口

在实现单点登录的过程中，涉及到客户端应用向认证中心请求认证并获取Token，然后将Token传递给各个微服务以进行资源访问。以下是单点登录调用代码的详细步骤，包括获取授权码、请求访问令牌以及使用令牌访问受保护资源的示例代码。

① 获取授权码

首先，客户端应用需要引导用户到SSO认证中心进行登录，并获取授权码。
可以通过浏览器重定向实现：

@GetMapping("/login")
public void login(HttpServletResponse response) throws IOException {
    String authorizationUri = "http://localhost:8080/oauth/authorize";
    String clientId = "client-id";
    String redirectUri = "http://localhost:8081/callback";
    String responseType = "code";
    String scope = "read write";

    String authUrl = authorizationUri + "?response_type=" + responseType
            + "&client_id=" + clientId
            + "&redirect_uri=" + URLEncoder.encode(redirectUri, "UTF-8")
            + "&scope=" + URLEncoder.encode(scope, "UTF-8");

    response.sendRedirect(authUrl);
}

② 获取访问令牌

用户在认证中心成功登录后，认证中心会重定向回客户端应用，并附带授权码。
客户端应用需要使用这个授权码来请求访问令牌：

@GetMapping("/callback")
public String callback(@RequestParam("code") String code, Model model) {
    String tokenUri = "http://localhost:8080/oauth/token";
    String clientId = "client-id";
    String clientSecret = "client-secret";
    String redirectUri = "http://localhost:8081/callback";

    RestTemplate restTemplate = new RestTemplate();

    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);
    headers.setBasicAuth(clientId, clientSecret);

    MultiValueMap<String, String> params = new LinkedMultiValueMap<>();
    params.add("grant_type", "authorization_code");
    params.add("code", code);
    params.add("redirect_uri", redirectUri);

    HttpEntity<MultiValueMap<String, String>> request = new HttpEntity<>(params, headers);

    ResponseEntity<Map> response = restTemplate.exchange(tokenUri, HttpMethod.POST, request, Map.class);

    Map<String, Object> responseBody = response.getBody();
    String accessToken = (String) responseBody.get("access_token");

    model.addAttribute("accessToken", accessToken);

    return "home";
}

③ 使用访问令牌访问受保护资源

获取访问令牌后，客户端应用可以使用这个令牌来访问受保护的资源。
以下是如何使用RestTemplate访问受保护资源的示例代码：

@GetMapping("/resource")
public String getResource(@RequestParam("accessToken") String accessToken, Model model) {
    String resourceUri = "http://localhost:8082/resource";

    RestTemplate restTemplate = new RestTemplate();

    HttpHeaders headers = new HttpHeaders();
    headers.setBearerAuth(accessToken);

    HttpEntity<String> request = new HttpEntity<>(headers);

    ResponseEntity<String> response = restTemplate.exchange(resourceUri, HttpMethod.GET, request, String.class);

    String resource = response.getBody();

    model.addAttribute("resource", resource);

    return "resource";
}

5、示例项目结构

示例项目结构如下：

/sso-auth-server
  ├── src/main/java/com/example/auth
  │   ├── AuthorizationServerConfig.java
  │   ├── SecurityConfig.java
  │   └── Application.java
  └── src/main/resources
      └── application.yml

/sso-gateway
  ├── src/main/java/com/example/gateway
  │   └── Application.java
  └── src/main/resources
      └── application.yml

/sso-user-service
  ├── src/main/java/com/example/user
  │   ├── ResourceServerConfig.java
  │   └── Application.java
  └── src/main/resources
      └── application.yml

/sso-client
  ├── src/main/java/com/example/client
  │   ├── SsoController.java
  │   └── Application.java
  └── src/main/resources
      └── application.yml

这个结构包括四个主要部分：

认证服务器 (sso-auth-server)：负责用户认证和Token生成。
网关服务 (sso-gateway)：负责路由请求和Token验证。
用户服务 (sso-user-service)：作为资源服务器，提供受保护的资源。
客户端应用 (sso-client)：负责引导用户登录、获取Token并访问受保护资源。

三、单点登录总结

1、单点登录的优势

优势	描述
用户体验提升	用户只需一次登录即可访问所有系统，避免了重复登录的繁琐操作。
安全性增强	统一的认证入口和集中式管理可以提高系统的安全性，减少各个系统独立管理认证信息的风险。
管理简化	集中管理用户身份信息和认证逻辑，简化了系统的维护和管理工作。
提高生产力	减少了用户在不同系统之间切换的时间，进而提升了整体工作效率。
降低开发成本	开发者只需实现一次认证和授权逻辑，可以节省开发和维护多个认证系统的成本。
统一用户管理	用户数据和权限集中存储和管理，使得用户信息更新和权限变更更加便捷高效。
改善审计和合规性	集中的认证和授权机制有助于监控用户行为，满足法规和审计的要求。
便于集成扩展	可以方便地集成新的应用系统，无需为每个新系统单独配置登录和认证流程。