feature #213 feat: allow configuring revocation of refresh tokens (fschmtt)

This PR was merged into the 1.x-dev branch.

Discussion
----------

feat: allow configuring revocation of refresh tokens

adds a configuration for disabling revocation of refresh token after they were used. this configuration applies to all grant types that will be enabled.

complies with `league/oauth2-server`: https://github.com/thephpleague/oauth2-server/blob/master/src/AuthorizationServer.php#L209-L215

```
# config/packages/league_oauth2_server.yaml

league_oauth2_server:
    authorization_server:
        revoke_refresh_tokens: false
```

Commits
-------

e238516 feat: allow configuring revocation of refresh tokens

Author: chalasr

docs/index.md

@@ -75,6 +75,9 @@ For implementation into Symfony projects, please see [bundle documentation](basi
             # Whether to enable access token saving to persistence layer (default to true)
             persist_access_token: true
 
+            # Whether to revoke refresh tokens after they were used for all grant types (default to true)
+            revoke_refresh_tokens: true
+
         resource_server:      # Required
 
             # Full path to the public key file

src/DependencyInjection/Configuration.php

@@ -111,6 +111,10 @@ private function createAuthorizationServerNode(): NodeDefinition
                     ->info('Define a custom ResponseType')
                     ->defaultValue(null)
                 ->end()
+                ->booleanNode('revoke_refresh_tokens')
+                    ->info('Whether to revoke refresh tokens after they were used for all grant types')
+                    ->defaultTrue()
+                ->end()
             ->end()
         ;
 

src/DependencyInjection/LeagueOAuth2ServerExtension.php

@@ -152,6 +152,10 @@ private function configureAuthorizationServer(ContainerBuilder $container, array
             $authorizationServer->replaceArgument(5, new Reference($config['response_type_class']));
         }
 
+        $authorizationServer->addMethodCall('revokeRefreshTokens', [
+            $config['revoke_refresh_tokens'],
+        ]);
+
         if ($config['enable_client_credentials_grant']) {
             $authorizationServer->addMethodCall('enableGrantType', [
                 new Reference(ClientCredentialsGrant::class),

tests/Unit/ExtensionTest.php

@@ -130,6 +130,30 @@ public function testDefaultScopeValidation(array $available, array $default, boo
         $this->addToAssertionCount(1);
     }
 
+    /**
+     * @dataProvider revokeRefreshTokensProvider
+     */
+    public function testEnablingAndDisablingRevocationOfRefreshTokens(bool $shouldRevokeRefreshTokens): void
+    {
+        $container = new ContainerBuilder();
+        $extension = new LeagueOAuth2ServerExtension();
+
+        $extension->load($this->getValidConfiguration(['revoke_refresh_tokens' => $shouldRevokeRefreshTokens]), $container);
+
+        $authorizationServer = $container->findDefinition(AuthorizationServer::class);
+        $methodCalls = $authorizationServer->getMethodCalls();
+        $revokeRefreshTokens = null;
+
+        foreach ($methodCalls as $methodCall) {
+            if ('revokeRefreshTokens' === $methodCall[0]) {
+                $revokeRefreshTokens = $methodCall[1][0];
+                break;
+            }
+        }
+
+        $this->assertSame($shouldRevokeRefreshTokens, $revokeRefreshTokens);
+    }
+
     public function scopeProvider(): iterable
     {
         yield 'when a default scope is part of available scopes' => [
@@ -155,6 +179,7 @@ private function getValidConfiguration(array $options = []): array
                     'enable_client_credentials_grant' => $options['enable_client_credentials_grant'] ?? true,
                     'enable_password_grant' => $options['enable_password_grant'] ?? true,
                     'enable_refresh_token_grant' => $options['enable_refresh_token_grant'] ?? true,
+                    'revoke_refresh_tokens' => $options['revoke_refresh_tokens'] ?? true,
                 ],
                 'resource_server' => [
                     'public_key' => 'foo',
@@ -175,6 +200,12 @@ private function getValidConfiguration(array $options = []): array
         ];
     }
 
+    public function revokeRefreshTokensProvider(): iterable
+    {
+        yield 'do revoke refresh tokens' => [true];
+        yield 'do not revoke refresh tokens' => [false];
+    }
+
     private function setupContainer(ContainerBuilder $container): void
     {
         $container->register(ScopeManager::class);