Add parsing of custom claims

thephpleague · May 3, 2021 · b30b03b · b30b03b
1 parent 244b055
commit b30b03b
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/src/AuthorizationValidators/BearerTokenValidator.php b/src/AuthorizationValidators/BearerTokenValidator.php
@@ -118,7 +118,8 @@ public function validateAuthorization(ServerRequestInterface $request)
             ->withAttribute('oauth_access_token_id', $claims->get('jti'))
             ->withAttribute('oauth_client_id', $this->convertSingleRecordAudToString($claims->get('aud')))
             ->withAttribute('oauth_user_id', $claims->get('sub'))
-            ->withAttribute('oauth_scopes', $claims->get('scopes'));
+            ->withAttribute('oauth_scopes', $claims->get('scopes'))
+            ->withAttribute('oauth_custom_claims', $this->extractCustomClaims($claims->all()));
     }
 
     /**
@@ -132,4 +133,16 @@ private function convertSingleRecordAudToString($aud)
     {
         return \is_array($aud) && \count($aud) === 1 ? $aud[0] : $aud;
     }
+
+    /**
+     * Extract custom claims
+     *
+     * @param array $claims
+     *
+     * @return array
+     */
+    private function extractCustomClaims($claims)
+    {
+        return \array_diff_key($claims, \array_flip(['jti', 'aud', 'sub', 'scopes', 'iat', 'nbf', 'exp']));
+    }
 }
diff --git a/tests/AuthorizationValidators/BearerTokenValidatorTest.php b/tests/AuthorizationValidators/BearerTokenValidatorTest.php
@@ -34,6 +34,8 @@ public function testBearerTokenValidatorAcceptsValidToken()
             ->expiresAt((new DateTimeImmutable())->add(new DateInterval('PT1H')))
             ->relatedTo('user-id')
             ->withClaim('scopes', 'scope1 scope2 scope3 scope4')
+            ->withClaim('custom1', 'value')
+            ->withClaim('custom2', 42)
             ->getToken(new Sha256(), LocalFileReference::file(__DIR__ . '/../Stubs/private.key'));
 
         $request = (new ServerRequest())->withHeader('authorization', \sprintf('Bearer %s', $validJwt->toString()));
@@ -46,6 +48,7 @@ public function testBearerTokenValidatorAcceptsValidToken()
         $this->assertEquals('client-id', $response->getAttribute('oauth_client_id'));
         $this->assertEquals('user-id', $response->getAttribute('oauth_user_id'));
         $this->assertEquals('scope1 scope2 scope3 scope4', $response->getAttribute('oauth_scopes'));
+        $this->assertEquals(['custom1' => 'value', 'custom2' => 42], $response->getAttribute('oauth_custom_claims'));
     }
 
     public function testBearerTokenValidatorRejectsExpiredToken()