如何为spring boot RESTful web服务配置多级身份验证？

Question

我们正在使用Spring Boot构建一个RESTful webservice。我们希望有两级身份验证来保护endpoint。

首先，对于每个请求，我们希望检查请求头内部是否有指定的apiKey，如果没有，我们将拒绝该请求。如果请求有一个apiKey，我们将对某些请求使用用户名/密码登录进行下一个身份验证。有只需要apiKey身份验证的公共endpoint，和首先需要apiKey身份验证，然后需要用户名/密码身份验证才能访问它们的私有endpoint。

对于apiKey身份验证，我在这里复制了代码，我还可以找到许多关于用户名/密码身份验证的示例。

我的问题是：如何在WebSecurityConfigurerAdapter内部做Java配置，将它们结合在一起。

现在，我为这两个身份验证过滤器定义了扩展WebSecurityConfigurerAdapter的两个配置类，但是请求将只通过其中一个，这取决于我将哪个设置为@order(1)。

多谢了。

Answer 1

整个答案由一个运行中的Spring Boot应用程序支持，并通过单元测试来确认。

如果你觉得这个答案有帮助，请投票。

简单的回答是，您的安全配置可能如下所示

    http
        .sessionManagement()
            .disable()
        //application security
        .authorizeRequests()
            .anyRequest().hasAuthority("API_KEY")
            .and()
        .addFilterBefore(new ApiKeyFilter(), HeaderWriterFilter.class)
        .addFilterAfter(new UserCredentialsFilter(), ApiKeyFilter.class)
        .csrf().ignoringAntMatchers(
            "/api-key-only",
            "/dual-auth"
    )
        ;
        // @formatter:on
    }

}

>

我使用WebSecurityConfigurerAdapter来满足ApiKey要求

.authorizeRequests()
    .anyRequest().hasAuthority("API_KEY")

我通过启用它来使用方法级安全性

@EnableGlobalMethodSecurity（prePostEnabled=true)

    @PreAuthorize("hasAuthority('USER_CREDENTIALS')")
    public String twoLayersOfAuth() {
        //only logic here
    }

ApiKey过滤器非常简单

public class ApiKeyFilter extends OncePerRequestFilter {
    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
        throws ServletException, IOException {

        final String authorization = request.getHeader("Authorization");
        final String prefix = "ApiKey ";
        if (hasText(authorization) && authorization.startsWith(prefix)) {
            String key = authorization.substring(prefix.length());
            if ("this-is-a-valid-key".equals(key)) {
                RestAuthentication<SimpleGrantedAuthority> authentication = new RestAuthentication<>(
                    key,
                    Collections.singletonList(new SimpleGrantedAuthority("API_KEY"))
                );
                SecurityContextHolder.getContext().setAuthentication(authentication);
            }
        }
        filterChain.doFilter(request, response);

    }
}

第二层身份验证甚至很简单（它依赖于第一层的执行）

public class UserCredentialsFilter extends OncePerRequestFilter {
    @Override
    protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
        throws ServletException, IOException {
        final String userCredentials = request.getHeader("X-User-Credentials");
        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
        if ("valid-user".equals(userCredentials) && authentication instanceof RestAuthentication) {
            RestAuthentication<SimpleGrantedAuthority> restAuthentication =
                (RestAuthentication<SimpleGrantedAuthority>)authentication;
            restAuthentication.addAuthority(new SimpleGrantedAuthority("USER_CREDENTIALS"));
        }
        filterChain.doFilter(request, response);

    }
}

请注意：每个筛选器如何并不关心在没有身份验证或身份验证不足的情况下会发生什么。这些都帮你处理好了。筛选器只需验证正确的数据；

    mvc.perform(
        post("/api-key-only")
            .header("Authorization", "ApiKey this-is-a-valid-key")
            .header("X-User-Credentials", "valid-user")
    )
        .andExpect(status().isOk())
        .andExpect(authenticated()
            .withAuthorities(
                asList(
                    new SimpleGrantedAuthority("API_KEY"),
                    new SimpleGrantedAuthority("USER_CREDENTIALS")
                )
            )
        )
        .andExpect(content().string("API KEY ONLY"))
    ;

    mvc.perform(
        post("/dual-auth")
            .header("Authorization", "ApiKey this-is-a-valid-key")
    )
        .andExpect(status().is4xxClientError())
        .andExpect(authenticated()
            .withAuthorities(
                asList(
                    new SimpleGrantedAuthority("API_KEY")
                )
            )
        )
    ;

当然，我们总有一条幸福的路

    mvc.perform(
        post("/dual-auth")
            .header("Authorization", "ApiKey this-is-a-valid-key")
            .header("X-User-Credentials", "valid-user")
    )
        .andExpect(status().isOk())
        .andExpect(content().string("DUAL AUTH"))
        .andExpect(authenticated()
            .withAuthorities(
                asList(
                    new SimpleGrantedAuthority("API_KEY"),
                    new SimpleGrantedAuthority("USER_CREDENTIALS")
                )
            )
        )
    ;