Update changelog

Sephster · Sephster · commit c4dbbcb64d99 · 2024-12-20T22:59:04.000Z
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -28,7 +28,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with: 
           fetch-depth: 0
 
@@ -38,6 +38,10 @@ jobs:
           php-version: ${{ matrix.php }}
           extensions: dom, curl, libxml, mbstring, zip
           coverage: pcov
+ 
+      - name: Remove Security Advisories on obsolete PHP versions
+        run: composer remove "roave/security-advisories" --dev --no-update
+        if: matrix.php <= 7.4
 
       - name: Install dependencies
         run:
diff --git a/.styleci.yml b/.styleci.yml
@@ -27,6 +27,7 @@ enabled:
   - no_unreachable_default_argument_value
   - no_unused_imports
   - no_whitespace_before_comma_in_array
+  - nullable_type_declarations
   - ordered_imports
   - phpdoc_align
   - phpdoc_indent
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [8.5.5] - released 2024-12-20
+### Fixed
+- PHP 8.4 deprecation notices fixed (PR #1466)
+
 ## [8.5.4] - released 2023-08-25
 ### Added
 - Support for league/uri ^7.0 (PR #1367)
@@ -606,7 +610,8 @@ Version 5 is a complete code rewrite.
 
 - First major release
 
-[Unreleased]: https://github.com/thephpleague/oauth2-server/compare/8.5.4...HEAD
+[Unreleased]: https://github.com/thephpleague/oauth2-server/compare/8.5.5...HEAD
+[8.5.4]: https://github.com/thephpleague/oauth2-server/compare/8.5.4...8.5.5
 [8.5.4]: https://github.com/thephpleague/oauth2-server/compare/8.5.3...8.5.4
 [8.5.3]: https://github.com/thephpleague/oauth2-server/compare/8.5.2...8.5.3
 [8.5.2]: https://github.com/thephpleague/oauth2-server/compare/8.5.1...8.5.2
diff --git a/examples/public/api.php b/examples/public/api.php
@@ -33,18 +33,18 @@
     function (ServerRequestInterface $request, ResponseInterface $response) use ($app) {
         $users = [
             [
-                'id'    => 123,
-                'name'  => 'Alex',
+                'id' => 123,
+                'name' => 'Alex',
                 'email' => 'alex@thephpleague.com',
             ],
             [
-                'id'    => 124,
-                'name'  => 'Frank',
+                'id' => 124,
+                'name' => 'Frank',
                 'email' => 'frank@thephpleague.com',
             ],
             [
-                'id'    => 125,
-                'name'  => 'Phil',
+                'id' => 125,
+                'name' => 'Phil',
                 'email' => 'phil@thephpleague.com',
             ],
         ];
diff --git a/examples/public/auth_code.php b/examples/public/auth_code.php
@@ -24,7 +24,7 @@
 include __DIR__ . '/../vendor/autoload.php';
 
 $app = new App([
-    'settings'    => [
+    'settings' => [
         'displayErrorDetails' => true,
     ],
     AuthorizationServer::class => function () {
diff --git a/examples/public/client_credentials.php b/examples/public/client_credentials.php
@@ -20,7 +20,7 @@
 include __DIR__ . '/../vendor/autoload.php';
 
 $app = new App([
-    'settings'                 => [
+    'settings' => [
         'displayErrorDetails' => true,
     ],
     AuthorizationServer::class => function () {
diff --git a/examples/public/implicit.php b/examples/public/implicit.php
@@ -22,7 +22,7 @@
 include __DIR__ . '/../vendor/autoload.php';
 
 $app = new App([
-    'settings'    => [
+    'settings' => [
         'displayErrorDetails' => true,
     ],
     AuthorizationServer::class => function () {
diff --git a/examples/public/middleware_use.php b/examples/public/middleware_use.php
@@ -26,7 +26,7 @@
 include __DIR__ . '/../vendor/autoload.php';
 
 $app = new App([
-    'settings'                 => [
+    'settings' => [
         'displayErrorDetails' => true,
     ],
     AuthorizationServer::class => function () {
@@ -89,7 +89,7 @@
 
         if (\in_array('basic', $request->getAttribute('oauth_scopes', []))) {
             $params = [
-                'id'   => 1,
+                'id' => 1,
                 'name' => 'Alex',
                 'city' => 'London',
             ];
diff --git a/examples/public/refresh_token.php b/examples/public/refresh_token.php
@@ -21,7 +21,7 @@
 include __DIR__ . '/../vendor/autoload.php';
 
 $app = new App([
-    'settings'    => [
+    'settings' => [
         'displayErrorDetails' => true,
     ],
     AuthorizationServer::class => function () {
diff --git a/examples/src/Repositories/ClientRepository.php b/examples/src/Repositories/ClientRepository.php
@@ -39,9 +39,9 @@ public function validateClient($clientIdentifier, $clientSecret, $grantType)
     {
         $clients = [
             'myawesomeapp' => [
-                'secret'          => \password_hash('abc123', PASSWORD_BCRYPT),
-                'name'            => self::CLIENT_NAME,
-                'redirect_uri'    => self::REDIRECT_URI,
+                'secret' => \password_hash('abc123', PASSWORD_BCRYPT),
+                'name' => self::CLIENT_NAME,
+                'redirect_uri' => self::REDIRECT_URI,
                 'is_confidential' => true,
             ],
         ];
diff --git a/src/AuthorizationServer.php b/src/AuthorizationServer.php
@@ -100,7 +100,7 @@ public function __construct(
         ScopeRepositoryInterface $scopeRepository,
         $privateKey,
         $encryptionKey,
-        ResponseTypeInterface $responseType = null
+        ?ResponseTypeInterface $responseType = null
     ) {
         $this->clientRepository = $clientRepository;
         $this->accessTokenRepository = $accessTokenRepository;
@@ -128,7 +128,7 @@ public function __construct(
      * @param GrantTypeInterface $grantType
      * @param null|DateInterval  $accessTokenTTL
      */
-    public function enableGrantType(GrantTypeInterface $grantType, DateInterval $accessTokenTTL = null)
+    public function enableGrantType(GrantTypeInterface $grantType, ?DateInterval $accessTokenTTL = null)
     {
         if ($accessTokenTTL === null) {
             $accessTokenTTL = new DateInterval('PT1H');
diff --git a/src/AuthorizationValidators/BearerTokenValidator.php b/src/AuthorizationValidators/BearerTokenValidator.php
@@ -51,7 +51,7 @@ class BearerTokenValidator implements AuthorizationValidatorInterface
      * @param AccessTokenRepositoryInterface $accessTokenRepository
      * @param \DateInterval|null             $jwtValidAtDateLeeway
      */
-    public function __construct(AccessTokenRepositoryInterface $accessTokenRepository, \DateInterval $jwtValidAtDateLeeway = null)
+    public function __construct(AccessTokenRepositoryInterface $accessTokenRepository, ?\DateInterval $jwtValidAtDateLeeway = null)
     {
         $this->accessTokenRepository = $accessTokenRepository;
         $this->jwtValidAtDateLeeway = $jwtValidAtDateLeeway;
diff --git a/src/Exception/OAuthServerException.php b/src/Exception/OAuthServerException.php
@@ -57,15 +57,15 @@ class OAuthServerException extends Exception
      * @param null|string $redirectUri    A HTTP URI to redirect the user back to
      * @param Throwable   $previous       Previous exception
      */
-    public function __construct($message, $code, $errorType, $httpStatusCode = 400, $hint = null, $redirectUri = null, Throwable $previous = null)
+    public function __construct($message, $code, $errorType, $httpStatusCode = 400, $hint = null, $redirectUri = null, ?Throwable $previous = null)
     {
         parent::__construct($message, $code, $previous);
         $this->httpStatusCode = $httpStatusCode;
         $this->errorType = $errorType;
         $this->hint = $hint;
         $this->redirectUri = $redirectUri;
         $this->payload = [
-            'error'             => $errorType,
+            'error' => $errorType,
             'error_description' => $message,
         ];
         if ($hint !== null) {
@@ -133,7 +133,7 @@ public static function unsupportedGrantType()
      *
      * @return static
      */
-    public static function invalidRequest($parameter, $hint = null, Throwable $previous = null)
+    public static function invalidRequest($parameter, $hint = null, ?Throwable $previous = null)
     {
         $errorMessage = 'The request is missing a required parameter, includes an invalid parameter value, ' .
             'includes a parameter more than once, or is otherwise malformed.';
@@ -202,7 +202,7 @@ public static function invalidCredentials()
      *
      * @codeCoverageIgnore
      */
-    public static function serverError($hint, Throwable $previous = null)
+    public static function serverError($hint, ?Throwable $previous = null)
     {
         return new static(
             'The authorization server encountered an unexpected condition which prevented it from fulfilling'
@@ -224,7 +224,7 @@ public static function serverError($hint, Throwable $previous = null)
      *
      * @return static
      */
-    public static function invalidRefreshToken($hint = null, Throwable $previous = null)
+    public static function invalidRefreshToken($hint = null, ?Throwable $previous = null)
     {
         return new static('The refresh token is invalid.', 8, 'invalid_request', 401, $hint, null, $previous);
     }
@@ -238,7 +238,7 @@ public static function invalidRefreshToken($hint = null, Throwable $previous = n
      *
      * @return static
      */
-    public static function accessDenied($hint = null, $redirectUri = null, Throwable $previous = null)
+    public static function accessDenied($hint = null, $redirectUri = null, ?Throwable $previous = null)
     {
         return new static(
             'The resource owner or authorization server denied the request.',
diff --git a/src/Grant/AuthCodeGrant.php b/src/Grant/AuthCodeGrant.php
@@ -366,13 +366,13 @@ public function completeAuthorizationRequest(AuthorizationRequest $authorization
             );
 
             $payload = [
-                'client_id'             => $authCode->getClient()->getIdentifier(),
-                'redirect_uri'          => $authCode->getRedirectUri(),
-                'auth_code_id'          => $authCode->getIdentifier(),
-                'scopes'                => $authCode->getScopes(),
-                'user_id'               => $authCode->getUserIdentifier(),
-                'expire_time'           => (new DateTimeImmutable())->add($this->authCodeTTL)->getTimestamp(),
-                'code_challenge'        => $authorizationRequest->getCodeChallenge(),
+                'client_id' => $authCode->getClient()->getIdentifier(),
+                'redirect_uri' => $authCode->getRedirectUri(),
+                'auth_code_id' => $authCode->getIdentifier(),
+                'scopes' => $authCode->getScopes(),
+                'user_id' => $authCode->getUserIdentifier(),
+                'expire_time' => (new DateTimeImmutable())->add($this->authCodeTTL)->getTimestamp(),
+                'code_challenge' => $authorizationRequest->getCodeChallenge(),
                 'code_challenge_method' => $authorizationRequest->getCodeChallengeMethod(),
             ];
 
@@ -387,7 +387,7 @@ public function completeAuthorizationRequest(AuthorizationRequest $authorization
                 $this->makeRedirectUri(
                     $finalRedirectUri,
                     [
-                        'code'  => $this->encrypt($jsonPayload),
+                        'code' => $this->encrypt($jsonPayload),
                         'state' => $authorizationRequest->getState(),
                     ]
                 )
diff --git a/src/Grant/ImplicitGrant.php b/src/Grant/ImplicitGrant.php
@@ -207,9 +207,9 @@ public function completeAuthorizationRequest(AuthorizationRequest $authorization
                     $finalRedirectUri,
                     [
                         'access_token' => (string) $accessToken,
-                        'token_type'   => 'Bearer',
-                        'expires_in'   => $accessToken->getExpiryDateTime()->getTimestamp() - \time(),
-                        'state'        => $authorizationRequest->getState(),
+                        'token_type' => 'Bearer',
+                        'expires_in' => $accessToken->getExpiryDateTime()->getTimestamp() - \time(),
+                        'state' => $authorizationRequest->getState(),
                     ],
                     $this->queryDelimiter
                 )
diff --git a/src/ResourceServer.php b/src/ResourceServer.php
@@ -42,7 +42,7 @@ class ResourceServer
     public function __construct(
         AccessTokenRepositoryInterface $accessTokenRepository,
         $publicKey,
-        AuthorizationValidatorInterface $authorizationValidator = null
+        ?AuthorizationValidatorInterface $authorizationValidator = null
     ) {
         $this->accessTokenRepository = $accessTokenRepository;
 
diff --git a/src/ResponseTypes/BearerTokenResponse.php b/src/ResponseTypes/BearerTokenResponse.php
@@ -26,19 +26,19 @@ public function generateHttpResponse(ResponseInterface $response)
         $expireDateTime = $this->accessToken->getExpiryDateTime()->getTimestamp();
 
         $responseParams = [
-            'token_type'   => 'Bearer',
-            'expires_in'   => $expireDateTime - \time(),
+            'token_type' => 'Bearer',
+            'expires_in' => $expireDateTime - \time(),
             'access_token' => (string) $this->accessToken,
         ];
 
         if ($this->refreshToken instanceof RefreshTokenEntityInterface) {
             $refreshTokenPayload = \json_encode([
-                'client_id'        => $this->accessToken->getClient()->getIdentifier(),
+                'client_id' => $this->accessToken->getClient()->getIdentifier(),
                 'refresh_token_id' => $this->refreshToken->getIdentifier(),
-                'access_token_id'  => $this->accessToken->getIdentifier(),
-                'scopes'           => $this->accessToken->getScopes(),
-                'user_id'          => $this->accessToken->getUserIdentifier(),
-                'expire_time'      => $this->refreshToken->getExpiryDateTime()->getTimestamp(),
+                'access_token_id' => $this->accessToken->getIdentifier(),
+                'scopes' => $this->accessToken->getScopes(),
+                'user_id' => $this->accessToken->getUserIdentifier(),
+                'expire_time' => $this->refreshToken->getExpiryDateTime()->getTimestamp(),
             ]);
 
             if ($refreshTokenPayload === false) {
diff --git a/tests/AuthorizationServerTest.php b/tests/AuthorizationServerTest.php
@@ -301,7 +301,7 @@ public function testValidateAuthorizationRequest()
             $cookies = [],
             $queryParams = [
                 'response_type' => 'code',
-                'client_id'     => 'foo',
+                'client_id' => 'foo',
             ]
         );
 
@@ -342,7 +342,7 @@ public function testValidateAuthorizationRequestWithMissingRedirectUri()
             $cookies = [],
             $queryParams = [
                 'response_type' => 'code',
-                'client_id'     => 'foo',
+                'client_id' => 'foo',
             ]
         );
 
@@ -369,7 +369,7 @@ public function testValidateAuthorizationRequestUnregistered()
             'client_id' => 'foo',
         ]);
 
-        $this->expectException(\League\OAuth2\Server\Exception\OAuthServerException::class);
+        $this->expectException(OAuthServerException::class);
         $this->expectExceptionCode(2);
 
         $server->validateAuthorizationRequest($request);
diff --git a/tests/Grant/AbstractGrantTest.php b/tests/Grant/AbstractGrantTest.php
@@ -109,7 +109,7 @@ public function testGetClientCredentialsClientSecretNotAString()
             [],
             [],
             [
-                'client_id'     => 'client_id',
+                'client_id' => 'client_id',
                 'client_secret' => ['not', 'a', 'string'],
             ]
         );
@@ -161,9 +161,9 @@ public function testValidateClientConfidential()
         $abstractGrantReflection = new \ReflectionClass($grantMock);
 
         $serverRequest = (new ServerRequest())->withParsedBody([
-            'client_id'     => 'foo',
+            'client_id' => 'foo',
             'client_secret' => 'bar',
-            'redirect_uri'  => 'http://foo/bar',
+            'redirect_uri' => 'http://foo/bar',
         ]);
 
         $validateClientMethod = $abstractGrantReflection->getMethod('validateClient');
@@ -229,7 +229,7 @@ public function testValidateClientInvalidClientSecret()
         $abstractGrantReflection = new \ReflectionClass($grantMock);
 
         $serverRequest = (new ServerRequest())->withParsedBody([
-            'client_id'     => 'foo',
+            'client_id' => 'foo',
             'client_secret' => 'foo',
         ]);
 
@@ -255,7 +255,7 @@ public function testValidateClientInvalidRedirectUri()
         $abstractGrantReflection = new \ReflectionClass($grantMock);
 
         $serverRequest = (new ServerRequest())->withParsedBody([
-            'client_id'    => 'foo',
+            'client_id' => 'foo',
             'redirect_uri' => 'http://bar/foo',
         ]);
 
@@ -281,7 +281,7 @@ public function testValidateClientInvalidRedirectUriArray()
         $abstractGrantReflection = new \ReflectionClass($grantMock);
 
         $serverRequest = (new ServerRequest())->withParsedBody([
-            'client_id'    => 'foo',
+            'client_id' => 'foo',
             'redirect_uri' => 'http://bar/foo',
         ]);
 
@@ -307,7 +307,7 @@ public function testValidateClientMalformedRedirectUri()
         $abstractGrantReflection = new \ReflectionClass($grantMock);
 
         $serverRequest = (new ServerRequest())->withParsedBody([
-            'client_id'    => 'foo',
+            'client_id' => 'foo',
             'redirect_uri' => ['not', 'a', 'string'],
         ]);
 
@@ -331,7 +331,7 @@ public function testValidateClientBadClient()
         $abstractGrantReflection = new \ReflectionClass($grantMock);
 
         $serverRequest = (new ServerRequest())->withParsedBody([
-            'client_id'     => 'foo',
+            'client_id' => 'foo',
             'client_secret' => 'bar',
         ]);
 
diff --git a/tests/Grant/AuthCodeGrantTest.php b/tests/Grant/AuthCodeGrantTest.php
diff --git a/tests/Grant/ClientCredentialsGrantTest.php b/tests/Grant/ClientCredentialsGrantTest.php
diff --git a/tests/Grant/ImplicitGrantTest.php b/tests/Grant/ImplicitGrantTest.php
diff --git a/tests/Grant/PasswordGrantTest.php b/tests/Grant/PasswordGrantTest.php
diff --git a/tests/Grant/RefreshTokenGrantTest.php b/tests/Grant/RefreshTokenGrantTest.php
diff --git a/tests/Stubs/GrantType.php b/tests/Stubs/GrantType.php
