在使用Spring Security OAuth3時如何自定義認(rèn)證服務(wù)器返回異常

客戶端異常處理

客戶端認(rèn)證的異常是發(fā)生在過濾器 ClientCredentialsTokenEndpointFilter上，其中有后置添加失敗處理方法，最后把異常交給 OAuth3AuthenticationEntryPoint這個所謂認(rèn)證入口處理。執(zhí)行順序如下所示：

然后跳轉(zhuǎn)到父類的 AbstractOAuth3SecurityExceptionHandler#doHandle()進行處理：

最終由 DefaultOAuth3ExceptionRenderer#handleHttpEntityResponse()方法將異常輸出給客戶端

處理方法

通過上面的分析我們得知客戶端的認(rèn)證失敗異常是過濾器 ClientCredentialsTokenEndpointFilter轉(zhuǎn)交給 OAuth3AuthenticationEntryPoint得到響應(yīng)結(jié)果的，既然這樣我們就可以重寫 ClientCredentialsTokenEndpointFilter然后使用自定義的 AuthenticationEntryPoint替換原生的 OAuth3AuthenticationEntryPoint，在自定義 AuthenticationEntryPoint處理得到我們想要的異常數(shù)據(jù)。

解決方案

為了解決上面這些異常，我們首先需要編寫不同異常的錯誤代碼：ReturnCode.java

CLIENT_AUTHENTICATION_FAILED(1001,"客戶端認(rèn)證失敗"),
USERNAME_OR_PASSWORD_ERROR(1002,"用戶名或密碼錯誤"),
UNSUPPORTED_GRANT_TYPE(1003, "不支持的認(rèn)證模式");

OAuth3Exception異常

如上所說我們編寫一個自定義異常翻譯類 CustomWebResponseExceptionTranslator

@Slf4j
public class CustomWebResponseExceptionTranslator implements WebResponseExceptionTranslator {

    @Override
    public ResponseEntity<ResultData<String>> translate(Exception e) throws Exception {
        log.error("認(rèn)證服務(wù)器異常",e);

        ResultData<String> response = resolveException(e);

        return new ResponseEntity<>(response, HttpStatus.valueOf(response.getHttpStatus()));
    }

    /**
     * 構(gòu)建返回異常
     * @param e exception
     * @return
     */
    private ResultData<String> resolveException(Exception e) {
        // 初始值 500
        ReturnCode returnCode = ReturnCode.RC500;
        int httpStatus = HttpStatus.UNAUTHORIZED.value();
        //不支持的認(rèn)證方式
        if(e instanceof UnsupportedGrantTypeException){
            returnCode = ReturnCode.UNSUPPORTED_GRANT_TYPE;
        //用戶名或密碼異常
        }else if(e instanceof InvalidGrantException){
            returnCode = ReturnCode.USERNAME_OR_PASSWORD_ERROR;
        }

        ResultData<String> failResponse = ResultData.fail(returnCode.getCode(), returnCode.getMessage());
        failResponse.setHttpStatus(httpStatus);

        return failResponse;
    }

}

然后在認(rèn)證服務(wù)器配置類中注入自定義異常翻譯類

@Override
public void configure(AuthorizationServerEndpointsConfigurer endpoints) throws Exception {
    //如果需要使用refresh_token模式則需要注入userDetailService
    endpoints
            .authenticationManager(this.authenticationManager)
            .userDetailsService(userDetailService)
//                注入tokenGranter
            .tokenGranter(tokenGranter);
            //注入自定義的tokenservice，如果不使用自定義的tokenService那么就需要將tokenServce里的配置移到這里
//                .tokenServices(tokenServices());
    // 自定義異常轉(zhuǎn)換類
    endpoints.exceptionTranslator(new CustomWebResponseExceptionTranslator());
}

客戶端異常

重寫客戶端認(rèn)證過濾器，不使用默認(rèn)的 OAuth3AuthenticationEntryPoint處理異常

public class CustomClientCredentialsTokenEndpointFilter extends ClientCredentialsTokenEndpointFilter {

    private final AuthorizationServerSecurityConfigurer configurer;

    private AuthenticationEntryPoint authenticationEntryPoint;

    public CustomClientCredentialsTokenEndpointFilter(AuthorizationServerSecurityConfigurer configurer) {
        this.configurer = configurer;
    }

    @Override
    public void setAuthenticationEntryPoint(AuthenticationEntryPoint authenticationEntryPoint) {
        super.setAuthenticationEntryPoint(null);
        this.authenticationEntryPoint = authenticationEntryPoint;
    }

    @Override
    protected AuthenticationManager getAuthenticationManager() {
        return configurer.and().getSharedObject(AuthenticationManager.class);
    }

    @Override
    public void afterPropertiesSet() {
        setAuthenticationFailureHandler((request, response, e) -> authenticationEntryPoint.commence(request, response, e));
        setAuthenticationSuccessHandler((request, response, authentication) -> {
        });
    }
}

在認(rèn)證服務(wù)器注入異常處理邏輯，自定義異常返回結(jié)果。（代碼位于 AuthorizationServerConfig）

@Bean
public AuthenticationEntryPoint authenticationEntryPoint() {
    return (request, response, e) -> {
        response.setStatus(HttpStatus.UNAUTHORIZED.value());
        ResultData<String> resultData = ResultData.fail(ReturnCode.CLIENT_AUTHENTICATION_FAILED.getCode(), ReturnCode.CLIENT_AUTHENTICATION_FAILED.getMessage());
        WebUtils.writeJson(response,resultData);
    };
}

修改認(rèn)證服務(wù)器配置，注入自定義過濾器

@Override
public void configure(AuthorizationServerSecurityConfigurer security) throws Exception {
 CustomClientCredentialsTokenEndpointFilter endpointFilter = new CustomClientCredentialsTokenEndpointFilter(security);
 endpointFilter.afterPropertiesSet();
 endpointFilter.setAuthenticationEntryPoint(authenticationEntryPoint());
 security.addTokenEndpointAuthenticationFilter(endpointFilter);

 security
   .authenticationEntryPoint(authenticationEntryPoint())
     /* .allowFormAuthenticationForClients()*/ //如果使用表單認(rèn)證則需要加上
   .tokenKeyAccess("permitAll()")
   .checkTokenAccess("isAuthenticated()");
}

此時需要刪除 allowFormAuthenticationForClients()配置，否則自定義的過濾器不生效，至于為什么不生效大家看看源碼就知道了。

測試

• 授權(quán)模式錯誤

• 賬號密碼錯誤

• 客戶端錯誤