一个注解搞定Spring Security基于Oauth2的SSO单点登录功能

下面我将详细讲解“一个注解搞定 Spring Security 基于 OAuth2 的 SSO 单点登录功能”的完整攻略。

概述

在使用 Spring Cloud 微服务框架时，为了方便统一认证和授权，我们通常会使用 Spring Security 和 OAuth2 客户端来实现单点登录（SSO）功能。这种方式需要在多个服务之间进行认证授权的传递和校验，需要花费大量时间和精力。但是，本文中我们将演示如何使用一个注解来搞定 Spring Security 基于 OAuth2 的 SSO 单点登录功能，以达到降低开发难度和提高开发效率的目的。

实现步骤

1. 导入相关依赖：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-security</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-oauth2-resource-server</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.security</groupId>
    <artifactId>spring-security-test</artifactId>
    <scope>test</scope>
</dependency>

1. 配置相关属性：

spring:
  security:
    oauth2:
      resourceserver:
        jwt:
          issuer-uri: ${issuer-uri}

1. 编写注解类：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface SsoAuthentication {
}

1. 实现配置类：

@Configuration
@EnableGlobalMethodSecurity(prePostEnabled = true)
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Bean
    public JwtDecoder jwtDecoder(OAuth2ResourceServerProperties properties) {
        String jwkSetUri = properties.getJwt().getJwkSetUri();
        return NimbusJwtDecoder.withJwkSetUri(jwkSetUri).build();
    }

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

    @Bean
    public MethodSecurityExpressionHandler createExpressionHandler() {
        return new OAuth2MethodSecurityExpressionHandler();
    }
}

1. 实现注解处理类：

@Component
public class SsoAuthenticationAspect {

    private final JwtDecoder jwtDecoder;

    public SsoAuthenticationAspect(JwtDecoder jwtDecoder) {
        this.jwtDecoder = jwtDecoder;
    }

    @Around("@annotation(SsoAuthentication)")
    public Object authentication(ProceedingJoinPoint pjp) throws Throwable {
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        String authorizationHeader = request.getHeader("Authorization");
        if (StringUtils.isBlank(authorizationHeader)) {
            throw new IllegalArgumentException("Missing Authorization header.");
        }

        String jwtToken = authorizationHeader.substring("Bearer ".length()).trim();
        Jwt jwt = jwtDecoder.decode(jwtToken);

        String username = (String) jwt.getClaims().get("user_name");
        String clientId = (String) jwt.getClaims().get("client_id");
        Collection<String> authorities = (Collection<String>) jwt.getClaims().get("authorities");

        UsernamePasswordAuthenticationToken authentication = new UsernamePasswordAuthenticationToken(username, clientId, authorities.stream().map(SimpleGrantedAuthority::new).collect(Collectors.toList()));
        SecurityContextHolder.getContext().setAuthentication(authentication);

        try {
            return pjp.proceed();
        } finally {
            SecurityContextHolder.clearContext();
        }
    }
}

示例

下面我们分别给出使用 @SsoAuthentication 注解的示例。

示例1

@RestController
public class UserController {

    private final UserService userService;

    public UserController(UserService userService) {
        this.userService = userService;
    }

    @GetMapping("/users/{userId}")
    @SsoAuthentication
    public UserDTO getUserById(@PathVariable String userId) {
        return userService.getUserById(userId);
    }
}

在上述示例中，我们使用 @SsoAuthentication 注解标记了 getUserById 方法，表示该方法需要进行单点登录认证。

示例2

@RestController
public class ProductController {

    private final ProductService productService;

    public ProductController(ProductService productService) {
        this.productService = productService;
    }

    @GetMapping("/products")
    @SsoAuthentication
    @PreAuthorize("#oauth2.hasScope('read')")
    public List<ProductDTO> getProducts() {
        return productService.getProducts();
    }
}

在上述示例中，除了使用 @SsoAuthentication 注解标记 getProducts 方法外，还使用了 @PreAuthorize 注解来实现基于 OAuth2 的权限控制。

总结

本文中，我们演示了如何使用一个注解搞定 Spring Security 基于 OAuth2 的 SSO 单点登录功能。通过简化认证授权过程，可以大大降低开发难度和提高开发效率。同时，我们还给出了两个使用 @SsoAuthentication 注解的示例，供读者参考。