Rename IdTokenResponse to TokenResponse

Author: cicnavi

routing/services/services.yml

@@ -64,8 +64,8 @@ services:
     factory: ['@SimpleSAML\Module\oidc\Factories\Grant\PreAuthCodeGrantFactory', 'build']
 
   # Responses
-  SimpleSAML\Module\oidc\Server\ResponseTypes\IdTokenResponse:
-    factory: ['@SimpleSAML\Module\oidc\Factories\IdTokenResponseFactory', 'build']
+  SimpleSAML\Module\oidc\Server\ResponseTypes\TokenResponse:
+    factory: ['@SimpleSAML\Module\oidc\Factories\TokenResponseFactory', 'build']
 
   oidc.key.private:
     class: League\OAuth2\Server\CryptKey
@@ -81,7 +81,7 @@ services:
   SimpleSAML\Module\oidc\Factories\AuthorizationServerFactory:
     arguments:
       $privateKey: '@oidc.key.private'
-  SimpleSAML\Module\oidc\Factories\IdTokenResponseFactory:
+  SimpleSAML\Module\oidc\Factories\TokenResponseFactory:
     arguments:
       $privateKey: '@oidc.key.private'
   SimpleSAML\Module\oidc\Factories\Entities\AccessTokenEntityFactory:

src/Entities/AuthCodeEntity.php

@@ -74,7 +74,9 @@ public function getState(): array
             'nonce' => $this->getNonce(),
             'flow_type' => $this->flowTypeEnum?->value,
             'tx_code' => $this->txCode,
-            'authorization_details' => json_encode($this->authorizationDetails, JSON_THROW_ON_ERROR),
+            'authorization_details' => is_array($this->authorizationDetails) ?
+                json_encode($this->authorizationDetails, JSON_THROW_ON_ERROR) :
+                null,
         ];
     }
 

src/Factories/AuthorizationServerFactory.php

@@ -27,7 +27,7 @@
 use SimpleSAML\Module\oidc\Server\Grants\PreAuthCodeGrant;
 use SimpleSAML\Module\oidc\Server\Grants\RefreshTokenGrant;
 use SimpleSAML\Module\oidc\Server\RequestRules\RequestRulesManager;
-use SimpleSAML\Module\oidc\Server\ResponseTypes\IdTokenResponse;
+use SimpleSAML\Module\oidc\Server\ResponseTypes\TokenResponse;
 
 class AuthorizationServerFactory
 {
@@ -39,7 +39,7 @@ public function __construct(
         private readonly AuthCodeGrant $authCodeGrant,
         private readonly ImplicitGrant $implicitGrant,
         private readonly RefreshTokenGrant $refreshTokenGrant,
-        private readonly IdTokenResponse $idTokenResponse,
+        private readonly TokenResponse $tokenResponse,
         private readonly RequestRulesManager $requestRulesManager,
         private readonly CryptKey $privateKey,
         private readonly PreAuthCodeGrant $preAuthCodeGrant,
@@ -54,7 +54,7 @@ public function build(): AuthorizationServer
             $this->scopeRepository,
             $this->privateKey,
             $this->moduleConfig->getEncryptionKey(),
-            $this->idTokenResponse,
+            $this->tokenResponse,
             $this->requestRulesManager,
         );
 

src/Factories/IdTokenResponseFactory.php renamed to src/Factories/TokenResponseFactory.php

@@ -19,10 +19,10 @@
 use League\OAuth2\Server\CryptKey;
 use SimpleSAML\Module\oidc\ModuleConfig;
 use SimpleSAML\Module\oidc\Repositories\UserRepository;
-use SimpleSAML\Module\oidc\Server\ResponseTypes\IdTokenResponse;
+use SimpleSAML\Module\oidc\Server\ResponseTypes\TokenResponse;
 use SimpleSAML\Module\oidc\Services\IdTokenBuilder;
 
-class IdTokenResponseFactory
+class TokenResponseFactory
 {
     public function __construct(
         private readonly ModuleConfig $moduleConfig,
@@ -32,15 +32,15 @@ public function __construct(
     ) {
     }
 
-    public function build(): IdTokenResponse
+    public function build(): TokenResponse
     {
-        $idTokenResponse = new IdTokenResponse(
+        $tokenResponse = new TokenResponse(
             $this->userRepository,
             $this->idTokenBuilder,
             $this->privateKey,
         );
-        $idTokenResponse->setEncryptionKey($this->moduleConfig->getEncryptionKey());
+        $tokenResponse->setEncryptionKey($this->moduleConfig->getEncryptionKey());
 
-        return $idTokenResponse;
+        return $tokenResponse;
     }
 }

src/Server/ResponseTypes/IdTokenResponse.php renamed to src/Server/ResponseTypes/TokenResponse.php

@@ -37,7 +37,7 @@
  *
  * @see https://github.com/steverhoades/oauth2-openid-connect-server/blob/master/src/IdTokenResponse.php
  */
-class IdTokenResponse extends BearerTokenResponse implements
+class TokenResponse extends BearerTokenResponse implements
     // phpcs:ignore
     NonceResponseTypeInterface,
     // phpcs:ignore

src/Services/Container.php

@@ -54,11 +54,11 @@
 use SimpleSAML\Module\oidc\Factories\Grant\ImplicitGrantFactory;
 use SimpleSAML\Module\oidc\Factories\Grant\PreAuthCodeGrantFactory;
 use SimpleSAML\Module\oidc\Factories\Grant\RefreshTokenGrantFactory;
-use SimpleSAML\Module\oidc\Factories\IdTokenResponseFactory;
 use SimpleSAML\Module\oidc\Factories\JwksFactory;
 use SimpleSAML\Module\oidc\Factories\ProcessingChainFactory;
 use SimpleSAML\Module\oidc\Factories\ResourceServerFactory;
 use SimpleSAML\Module\oidc\Factories\TemplateFactory;
+use SimpleSAML\Module\oidc\Factories\TokenResponseFactory;
 use SimpleSAML\Module\oidc\Forms\Controls\CsrfProtection;
 use SimpleSAML\Module\oidc\Helpers;
 use SimpleSAML\Module\oidc\ModuleConfig;
@@ -98,7 +98,7 @@
 use SimpleSAML\Module\oidc\Server\RequestRules\Rules\ScopeRule;
 use SimpleSAML\Module\oidc\Server\RequestRules\Rules\StateRule;
 use SimpleSAML\Module\oidc\Server\RequestRules\Rules\UiLocalesRule;
-use SimpleSAML\Module\oidc\Server\ResponseTypes\IdTokenResponse;
+use SimpleSAML\Module\oidc\Server\ResponseTypes\TokenResponse;
 use SimpleSAML\Module\oidc\Server\TokenIssuers\RefreshTokenIssuer;
 use SimpleSAML\Module\oidc\Server\Validators\BearerTokenValidator;
 use SimpleSAML\Module\oidc\Stores\Session\LogoutTicketStoreBuilder;
@@ -438,13 +438,13 @@ public function __construct()
         $sessionLogoutTicketStoreBuilder = new LogoutTicketStoreBuilder($sessionLogoutTicketStoreDb);
         $this->services[LogoutTicketStoreBuilder::class] = $sessionLogoutTicketStoreBuilder;
 
-        $idTokenResponseFactory = new IdTokenResponseFactory(
+        $tokenResponseFactory = new TokenResponseFactory(
             $moduleConfig,
             $userRepository,
             $this->services[IdTokenBuilder::class],
             $privateKey,
         );
-        $this->services[IdTokenResponse::class] = $idTokenResponseFactory->build();
+        $this->services[TokenResponse::class] = $tokenResponseFactory->build();
 
         $this->services[Helpers::class] = $helpers;
 
@@ -512,7 +512,7 @@ public function __construct()
             $this->services[AuthCodeGrant::class],
             $this->services[ImplicitGrant::class],
             $this->services[RefreshTokenGrant::class],
-            $this->services[IdTokenResponse::class],
+            $this->services[TokenResponse::class],
             $requestRuleManager,
             $privateKey,
             $this->services[PreAuthCodeGrant::class],

tests/unit/src/Entities/AuthCodeEntityTest.php

@@ -103,6 +103,7 @@ public function testCanGetState(): void
                 'nonce' => 'nonce',
                 'flow_type' => null,
                 'tx_code' => null,
+                'authorization_details' => null,
             ],
         );
     }

tests/unit/src/Server/ResponseTypes/IdTokenResponseTest.php renamed to tests/unit/src/Server/ResponseTypes/TokenResponseTest.php

@@ -31,15 +31,15 @@
 use SimpleSAML\Module\oidc\Factories\Entities\ClaimSetEntityFactory;
 use SimpleSAML\Module\oidc\ModuleConfig;
 use SimpleSAML\Module\oidc\Repositories\Interfaces\IdentityProviderInterface;
-use SimpleSAML\Module\oidc\Server\ResponseTypes\IdTokenResponse;
+use SimpleSAML\Module\oidc\Server\ResponseTypes\TokenResponse;
 use SimpleSAML\Module\oidc\Services\IdTokenBuilder;
 use SimpleSAML\Module\oidc\Services\JsonWebTokenBuilderService;
 use SimpleSAML\Module\oidc\Utils\ClaimTranslatorExtractor;
 
 /**
- * @covers \SimpleSAML\Module\oidc\Server\ResponseTypes\IdTokenResponse
+ * @covers \SimpleSAML\Module\oidc\Server\ResponseTypes\TokenResponse
  */
-class IdTokenResponseTest extends TestCase
+class TokenResponseTest extends TestCase
 {
     final public const TOKEN_ID = 'tokenId';
     final public const ISSUER = 'someIssuer';
@@ -121,26 +121,26 @@ protected function setUp(): void
         );
     }
 
-    protected function prepareMockedInstance(): IdTokenResponse
+    protected function prepareMockedInstance(): TokenResponse
     {
-        $idTokenResponse = new IdTokenResponse(
+        $tokenResponse = new TokenResponse(
             $this->identityProviderMock,
             $this->idTokenBuilder,
             $this->privateKey,
         );
 
-        $idTokenResponse->setNonce(null);
-        $idTokenResponse->setAuthTime(null);
-        $idTokenResponse->setAcr(null);
-        $idTokenResponse->setSessionId(null);
+        $tokenResponse->setNonce(null);
+        $tokenResponse->setAuthTime(null);
+        $tokenResponse->setAcr(null);
+        $tokenResponse->setSessionId(null);
 
-        return $idTokenResponse;
+        return $tokenResponse;
     }
 
     public function testItIsInitializable(): void
     {
         $this->assertInstanceOf(
-            IdTokenResponse::class,
+            TokenResponse::class,
             $this->prepareMockedInstance(),
         );
     }