SpringSecurityOAuth2–単純なトークンの失効（SpringSecurityOAuthレガシースタックを使用）

投稿日: 2019-10-19 2022-11-08
タグ: OAuth Legacy Stack, Spring Security

1. 概要

このクイックチュートリアルでは、 SpringSecurityで実装されたOAuth認証サーバーによって付与されたトークンを取り消す方法を説明します。

ユーザーがログアウトしても、トークンはトークンストアからすぐには削除されません。代わりに、それ自体が期限切れになるまで有効なままです。

したがって、トークンを取り消すと、そのトークンをトークンストアから削除することになります。 JWTトークンではなく、フレームワークでの標準トークンの実装について説明します。

2. TokenStore

まず、トークンストアを設定しましょう。 JdbcTokenStore を、付随するデータソースとともに使用します。

@Bean 
public TokenStore tokenStore() { 
    return new JdbcTokenStore(dataSource()); 
}

@Bean 
public DataSource dataSource() { 
    DriverManagerDataSource dataSource =  new DriverManagerDataSource();
    dataSource.setDriverClassName(env.getProperty("jdbc.driverClassName"));
    dataSource.setUrl(env.getProperty("jdbc.url"));
    dataSource.setUsername(env.getProperty("jdbc.user"));
    dataSource.setPassword(env.getProperty("jdbc.pass")); 
    return dataSource;
}

**3. DefaultTokenServices Bean**

すべてのトークンを処理するクラスはDefaultTokenServicesであり、構成でBeanとして定義する必要があります。

@Bean
@Primary
public DefaultTokenServices tokenServices() {
    DefaultTokenServices defaultTokenServices = new DefaultTokenServices();
    defaultTokenServices.setTokenStore(tokenStore());
    defaultTokenServices.setSupportRefreshToken(true);
    return defaultTokenServices;
}

4. トークンのリストの表示

管理目的で、現在有効なトークンを表示する方法も設定しましょう。

コントローラのTokenStoreにアクセスし、指定されたクライアントIDに対して現在保存されているトークンを取得します。

@Resource(name="tokenStore")
TokenStore tokenStore;

@RequestMapping(method = RequestMethod.GET, value = "/tokens")
@ResponseBody
public List<String> getTokens() {
    List<String> tokenValues = new ArrayList<String>();
    Collection<OAuth2AccessToken> tokens = tokenStore.findTokensByClientId("sampleClientId"); 
    if (tokens!=null){
        for (OAuth2AccessToken token:tokens){
            tokenValues.add(token.getValue());
        }
    }
    return tokenValues;
}

5. アクセストークンの取り消し

トークンを無効にするために、 ConsumerTokenServicesインターフェースからrevokeToken（）APIを使用します。

@Resource(name="tokenServices")
ConsumerTokenServices tokenServices;
	
@RequestMapping(method = RequestMethod.POST, value = "/tokens/revoke/{tokenId:.*}")
@ResponseBody
public String revokeToken(@PathVariable String tokenId) {
    tokenServices.revokeToken(tokenId);
    return tokenId;
}

もちろん、これは非常に機密性の高い操作であるため、内部でのみ使用するか、適切なセキュリティを設定して公開するように細心の注意を払う必要があります。

6. フロントエンド

この例のフロントエンドでは、有効なトークンのリスト、失効リクエストを行っているログインユーザーが現在使用しているトークン、およびユーザーが失効させたいトークンを入力できるフィールドを表示します。

$scope.revokeToken = 
  $resource("http://localhost:8082/spring-security-oauth-resource/tokens/revoke/:tokenId",
  {tokenId:'@tokenId'});
$scope.tokens = $resource("http://localhost:8082/spring-security-oauth-resource/tokens");
    
$scope.getTokens = function(){
    $scope.tokenList = $scope.tokens.query();	
}
	
$scope.revokeAccessToken = function(){
    if ($scope.tokenToRevoke && $scope.tokenToRevoke.length !=0){
        $scope.revokeToken.save({tokenId:$scope.tokenToRevoke});
        $rootScope.message="Token:"+$scope.tokenToRevoke+" was revoked!";
        $scope.tokenToRevoke="";
    }
}

ユーザーが取り消されたトークンを再度使用しようとすると、ステータスコード401の「無効なトークン」エラーが表示されます。

7. 更新トークンの取り消し

更新トークンを使用して、新しいアクセストークンを取得できます。アクセストークンが取り消されるたびに、それとともに受信した更新トークンは無効になります。

更新トークン自体も無効にする場合は、クラス JdbcTokenStoreのメソッドremoveRefreshToken（）を使用できます。これにより、ストアから更新トークンが削除されます。

@RequestMapping(method = RequestMethod.POST, value = "/tokens/revokeRefreshToken/{tokenId:.*}")
@ResponseBody
public String revokeRefreshToken(@PathVariable String tokenId) {
    if (tokenStore instanceof JdbcTokenStore){
        ((JdbcTokenStore) tokenStore).removeRefreshToken(tokenId);
    }
    return tokenId;
}

取り消された後に更新トークンが無効になったことをテストするために、次のテストを記述します。このテストでは、アクセストークンを取得して更新し、更新トークンを削除して、再度更新を試みます。

失効後、「無効な更新トークン」という応答エラーが表示されます。

public class TokenRevocationLiveTest {
    private String refreshToken;

    private String obtainAccessToken(String clientId, String username, String password) {
        Map<String, String> params = new HashMap<String, String>();
        params.put("grant_type", "password");
        params.put("client_id", clientId);
        params.put("username", username);
        params.put("password", password);
        
        Response response = RestAssured.given().auth().
          preemptive().basic(clientId,"secret").and().with().params(params).
          when().post("http://localhost:8081/spring-security-oauth-server/oauth/token");
        refreshToken = response.jsonPath().getString("refresh_token");
        
        return response.jsonPath().getString("access_token");
    }
	
    private String obtainRefreshToken(String clientId) {
        Map<String, String> params = new HashMap<String, String>();
        params.put("grant_type", "refresh_token");
        params.put("client_id", clientId);
        params.put("refresh_token", refreshToken);
        
        Response response = RestAssured.given().auth()
          .preemptive().basic(clientId,"secret").and().with().params(params)
          .when().post("http://localhost:8081/spring-security-oauth-server/oauth/token");
        
        return response.jsonPath().getString("access_token");
    }
	
    private void authorizeClient(String clientId) {
        Map<String, String> params = new HashMap<String, String>();
        params.put("response_type", "code");
        params.put("client_id", clientId);
        params.put("scope", "read,write");
        
        Response response = RestAssured.given().auth().preemptive()
          .basic(clientId,"secret").and().with().params(params).
          when().post("http://localhost:8081/spring-security-oauth-server/oauth/authorize");
    }
    
    @Test
    public void givenUser_whenRevokeRefreshToken_thenRefreshTokenInvalidError() {
        String accessToken1 = obtainAccessToken("fooClientIdPassword", "john", "123");
        String accessToken2 = obtainAccessToken("fooClientIdPassword", "tom", "111");
        authorizeClient("fooClientIdPassword");
		
        String accessToken3 = obtainRefreshToken("fooClientIdPassword");
        authorizeClient("fooClientIdPassword");
        Response refreshTokenResponse = RestAssured.given().
          header("Authorization", "Bearer " + accessToken3)
          .get("http://localhost:8082/spring-security-oauth-resource/tokens");
        assertEquals(200, refreshTokenResponse.getStatusCode());
		
        Response revokeRefreshTokenResponse = RestAssured.given()
          .header("Authorization", "Bearer " + accessToken1)
          .post("http://localhost:8082/spring-security-oauth-resource/tokens/revokeRefreshToken/"+refreshToken);
        assertEquals(200, revokeRefreshTokenResponse.getStatusCode());
		
        String accessToken4 = obtainRefreshToken("fooClientIdPassword");
        authorizeClient("fooClientIdPassword");
        Response refreshTokenResponse2 = RestAssured.given()
          .header("Authorization", "Bearer " + accessToken4)
          .get("http://localhost:8082/spring-security-oauth-resource/tokens");
        assertEquals(401, refreshTokenResponse2.getStatusCode());
    }
}

8. 結論

このチュートリアルでは、OAuthアクセストークンとOauth更新トークンを取り消す方法を示しました。

このチュートリアルの実装は、GitHubプロジェクトにあります。

getdocs

13036