Applied latest styles changes from style CI

diff --git a/app/Auth/Access/GroupSyncService.php b/app/Auth/Access/GroupSyncService.php
index ddd539b7773ac01c73ebe658703b234ea0a130ec..db19b007ac32b31f5a2bb6112514b6aa7b271826 100644 (file)
--- a/app/Auth/Access/GroupSyncService.php
+++ b/app/Auth/Access/GroupSyncService.php
@@ -73,4 +73,4 @@ class GroupSyncService
             $user->roles()->syncWithoutDetaching($groupsAsRoles);
         }
     }
             $user->roles()->syncWithoutDetaching($groupsAsRoles);
         }
     }

-}
\ No newline at end of file
+}

diff --git a/app/Auth/Access/LdapService.php b/app/Auth/Access/LdapService.php
index ddd6ada97fe429d4e1fe9ae3b1aa7ca5b9e1cbbc..e3a38537ac3ae4ae9def8d7336b29a330e587aa6 100644 (file)
--- a/app/Auth/Access/LdapService.php
+++ b/app/Auth/Access/LdapService.php
@@ -285,6 +285,7 @@ class LdapService
         }
 
         $userGroups = $this->groupFilter($user);
         }
 
         $userGroups = $this->groupFilter($user);

+

         return $this->getGroupsRecursive($userGroups, []);
     }
 
         return $this->getGroupsRecursive($userGroups, []);
     }
 

diff --git a/app/Auth/Access/Oidc/OidcAccessToken.php b/app/Auth/Access/Oidc/OidcAccessToken.php
index 63853e08ab07a411c401ffc1c9975254a9d5a26b..520966f6ae420020087bb123b7f488dd69b13486 100644 (file)
--- a/app/Auth/Access/Oidc/OidcAccessToken.php
+++ b/app/Auth/Access/Oidc/OidcAccessToken.php
@@ -11,7 +11,8 @@ class OidcAccessToken extends AccessToken
      * Constructs an access token.
      *
      * @param array $options An array of options returned by the service provider
      * Constructs an access token.
      *
      * @param array $options An array of options returned by the service provider

-     *     in the access token request. The `access_token` option is required.
+     *                       in the access token request. The `access_token` option is required.
+     *

      * @throws InvalidArgumentException if `access_token` is not provided in `$options`.
      */
     public function __construct(array $options = [])
      * @throws InvalidArgumentException if `access_token` is not provided in `$options`.
      */
     public function __construct(array $options = [])


@@ -20,7 +21,6 @@ class OidcAccessToken extends AccessToken
         $this->validate($options);
     }
 
         $this->validate($options);
     }
 

-

     /**
      * Validate this access token response for OIDC.
      * As per https://openid.net/specs/openid-connect-basic-1_0.html#TokenOK.
     /**
      * Validate this access token response for OIDC.
      * As per https://openid.net/specs/openid-connect-basic-1_0.html#TokenOK.


@@ -50,5 +50,4 @@ class OidcAccessToken extends AccessToken
     {
         return $this->getValues()['id_token'];
     }
     {
         return $this->getValues()['id_token'];
     }

-
-}
\ No newline at end of file
+}

diff --git a/app/Auth/Access/Oidc/OidcIdToken.php b/app/Auth/Access/Oidc/OidcIdToken.php
index de9c42ab277e0c321904cb83834ae08aba50b057..c955c3b091573b042380dabf1230ee568d7d80e0 100644 (file)
--- a/app/Auth/Access/Oidc/OidcIdToken.php
+++ b/app/Auth/Access/Oidc/OidcIdToken.php
@@ -60,6 +60,7 @@ class OidcIdToken
     {
         $json = $this->base64UrlDecode($part) ?: '{}';
         $decoded = json_decode($json, true);
     {
         $json = $this->base64UrlDecode($part) ?: '{}';
         $decoded = json_decode($json, true);

+

         return is_array($decoded) ? $decoded : [];
     }
 
         return is_array($decoded) ? $decoded : [];
     }
 


@@ -74,6 +75,7 @@ class OidcIdToken
 
     /**
      * Validate all possible parts of the id token.
 
     /**
      * Validate all possible parts of the id token.

+     *

      * @throws OidcInvalidTokenException
      */
     public function validate(string $clientId): bool
      * @throws OidcInvalidTokenException
      */
     public function validate(string $clientId): bool


@@ -81,12 +83,14 @@ class OidcIdToken
         $this->validateTokenStructure();
         $this->validateTokenSignature();
         $this->validateTokenClaims($clientId);
         $this->validateTokenStructure();
         $this->validateTokenSignature();
         $this->validateTokenClaims($clientId);

+

         return true;
     }
 
     /**
      * Fetch a specific claim from this token.
      * Returns null if it is null or does not exist.
         return true;
     }
 
     /**
      * Fetch a specific claim from this token.
      * Returns null if it is null or does not exist.

+     *

      * @return mixed|null
      */
     public function getClaim(string $claim)
      * @return mixed|null
      */
     public function getClaim(string $claim)


@@ -104,7 +108,8 @@ class OidcIdToken
 
     /**
      * Validate the structure of the given token and ensure we have the required pieces.
 
     /**
      * Validate the structure of the given token and ensure we have the required pieces.

-     * As per https://datatracker.ietf.org/doc/html/rfc7519#section-7.2
+     * As per https://datatracker.ietf.org/doc/html/rfc7519#section-7.2.
+     *

      * @throws OidcInvalidTokenException
      */
     protected function validateTokenStructure(): void
      * @throws OidcInvalidTokenException
      */
     protected function validateTokenStructure(): void


@@ -116,12 +121,13 @@ class OidcIdToken
         }
 
         if (empty($this->signature) || !is_string($this->signature)) {
         }
 
         if (empty($this->signature) || !is_string($this->signature)) {

-            throw new OidcInvalidTokenException("Could not parse out a valid signature within the provided token");
+            throw new OidcInvalidTokenException('Could not parse out a valid signature within the provided token');

         }
     }
 
     /**
      * Validate the signature of the given token and ensure it validates against the provided key.
         }
     }
 
     /**
      * Validate the signature of the given token and ensure it validates against the provided key.

+     *

      * @throws OidcInvalidTokenException
      */
     protected function validateTokenSignature(): void
      * @throws OidcInvalidTokenException
      */
     protected function validateTokenSignature(): void


@@ -130,7 +136,7 @@ class OidcIdToken
             throw new OidcInvalidTokenException("Only RS256 signature validation is supported. Token reports using {$this->header['alg']}");
         }
 
             throw new OidcInvalidTokenException("Only RS256 signature validation is supported. Token reports using {$this->header['alg']}");
         }
 

-        $parsedKeys = array_map(function($key) {
+        $parsedKeys = array_map(function ($key) {

             try {
                 return new OidcJwtSigningKey($key);
             } catch (OidcInvalidKeyException $e) {
             try {
                 return new OidcJwtSigningKey($key);
             } catch (OidcInvalidKeyException $e) {


@@ -153,7 +159,8 @@ class OidcIdToken
 
     /**
      * Validate the claims of the token.
 
     /**
      * Validate the claims of the token.

-     * As per https://openid.net/specs/openid-connect-basic-1_0.html#IDTokenValidation
+     * As per https://openid.net/specs/openid-connect-basic-1_0.html#IDTokenValidation.
+     *

      * @throws OidcInvalidTokenException
      */
     protected function validateTokenClaims(string $clientId): void
      * @throws OidcInvalidTokenException
      */
     protected function validateTokenClaims(string $clientId): void


@@ -228,5 +235,4 @@ class OidcIdToken
             throw new OidcInvalidTokenException('Missing token subject value');
         }
     }
             throw new OidcInvalidTokenException('Missing token subject value');
         }
     }

-
-}
\ No newline at end of file
+}

diff --git a/app/Auth/Access/Oidc/OidcInvalidKeyException.php b/app/Auth/Access/Oidc/OidcInvalidKeyException.php
index 17c32f41685e27205f32c3a3a6f0633d34ec793c..1b3310e06d915c2672e90a3cd8975954a902f5ff 100644 (file)
--- a/app/Auth/Access/Oidc/OidcInvalidKeyException.php
+++ b/app/Auth/Access/Oidc/OidcInvalidKeyException.php
@@ -4,5 +4,4 @@ namespace BookStack\Auth\Access\Oidc;
 
 class OidcInvalidKeyException extends \Exception
 {
 
 class OidcInvalidKeyException extends \Exception
 {

-
-}
\ No newline at end of file
+}

diff --git a/app/Auth/Access/Oidc/OidcInvalidTokenException.php b/app/Auth/Access/Oidc/OidcInvalidTokenException.php
index 30ac79280b50888e3815b7974c9a107276761565..4f47eb08fc07d61b7a7d1fd62e0e6da7bac0287e 100644 (file)
--- a/app/Auth/Access/Oidc/OidcInvalidTokenException.php
+++ b/app/Auth/Access/Oidc/OidcInvalidTokenException.php
@@ -6,5 +6,4 @@ use Exception;
 
 class OidcInvalidTokenException extends Exception
 {
 
 class OidcInvalidTokenException extends Exception
 {

-
-}
\ No newline at end of file
+}

diff --git a/app/Auth/Access/Oidc/OidcIssuerDiscoveryException.php b/app/Auth/Access/Oidc/OidcIssuerDiscoveryException.php
index 47c49c6259615216e6078b97abd8f380820b2637..e2f364e89db97a198be3116a3b17e9b8f2e272a0 100644 (file)
--- a/app/Auth/Access/Oidc/OidcIssuerDiscoveryException.php
+++ b/app/Auth/Access/Oidc/OidcIssuerDiscoveryException.php
@@ -4,5 +4,4 @@ namespace BookStack\Auth\Access\Oidc;
 
 class OidcIssuerDiscoveryException extends \Exception
 {
 
 class OidcIssuerDiscoveryException extends \Exception
 {

-
-}
\ No newline at end of file
+}

diff --git a/app/Auth/Access/Oidc/OidcJwtSigningKey.php b/app/Auth/Access/Oidc/OidcJwtSigningKey.php
index 3e77cf331732401afc902d06953275db5a60ca4f..9a5b3833ade3aec9e44faae9101703f81acb42e6 100644 (file)
--- a/app/Auth/Access/Oidc/OidcJwtSigningKey.php
+++ b/app/Auth/Access/Oidc/OidcJwtSigningKey.php
@@ -18,15 +18,17 @@ class OidcJwtSigningKey
      * Can be created either from a JWK parameter array or local file path to load a certificate from.
      * Examples:
      * 'file:///var/www/cert.pem'
      * Can be created either from a JWK parameter array or local file path to load a certificate from.
      * Examples:
      * 'file:///var/www/cert.pem'

-     * ['kty' => 'RSA', 'alg' => 'RS256', 'n' => 'abc123...']
+     * ['kty' => 'RSA', 'alg' => 'RS256', 'n' => 'abc123...'].
+     *

      * @param array|string $jwkOrKeyPath
      * @param array|string $jwkOrKeyPath

+     *

      * @throws OidcInvalidKeyException
      */
     public function __construct($jwkOrKeyPath)
     {
         if (is_array($jwkOrKeyPath)) {
             $this->loadFromJwkArray($jwkOrKeyPath);
      * @throws OidcInvalidKeyException
      */
     public function __construct($jwkOrKeyPath)
     {
         if (is_array($jwkOrKeyPath)) {
             $this->loadFromJwkArray($jwkOrKeyPath);

-        } else if (is_string($jwkOrKeyPath) && strpos($jwkOrKeyPath, 'file://') === 0) {
+        } elseif (is_string($jwkOrKeyPath) && strpos($jwkOrKeyPath, 'file://') === 0) {

             $this->loadFromPath($jwkOrKeyPath);
         } else {
             throw new OidcInvalidKeyException('Unexpected type of key value provided');
             $this->loadFromPath($jwkOrKeyPath);
         } else {
             throw new OidcInvalidKeyException('Unexpected type of key value provided');


@@ -47,7 +49,7 @@ class OidcJwtSigningKey
         }
 
         if (!($this->key instanceof RSA)) {
         }
 
         if (!($this->key instanceof RSA)) {

-            throw new OidcInvalidKeyException("Key loaded from file path is not an RSA key as expected");
+            throw new OidcInvalidKeyException('Key loaded from file path is not an RSA key as expected');

         }
     }
 
         }
     }
 


@@ -104,5 +106,4 @@ class OidcJwtSigningKey
     {
         return $this->key->toString('PKCS8');
     }
     {
         return $this->key->toString('PKCS8');
     }

-
-}
\ No newline at end of file
+}

diff --git a/app/Auth/Access/Oidc/OidcOAuthProvider.php b/app/Auth/Access/Oidc/OidcOAuthProvider.php
index 03230e373dfb1daefbeaf640aaa9cdfefa2382f5..9b9d0524c0d66d6ef3dc467e015d8c92cddcec5e 100644 (file)
--- a/app/Auth/Access/Oidc/OidcOAuthProvider.php
+++ b/app/Auth/Access/Oidc/OidcOAuthProvider.php
@@ -30,7 +30,6 @@ class OidcOAuthProvider extends AbstractProvider
      */
     protected $tokenEndpoint;
 
      */
     protected $tokenEndpoint;
 

-

     /**
      * Returns the base URL for authorizing a client.
      */
     /**
      * Returns the base URL for authorizing a client.
      */


@@ -66,7 +65,6 @@ class OidcOAuthProvider extends AbstractProvider
         return ['openid', 'profile', 'email'];
     }
 
         return ['openid', 'profile', 'email'];
     }
 

-

     /**
      * Returns the string that should be used to separate scopes when building
      * the URL for requesting an access token.
     /**
      * Returns the string that should be used to separate scopes when building
      * the URL for requesting an access token.


@@ -80,9 +78,11 @@ class OidcOAuthProvider extends AbstractProvider
      * Checks a provider response for errors.
      *
      * @param ResponseInterface $response
      * Checks a provider response for errors.
      *
      * @param ResponseInterface $response

-     * @param array|string $data Parsed response data
-     * @return void
+     * @param array|string      $data     Parsed response data
+     *

      * @throws IdentityProviderException
      * @throws IdentityProviderException

+     *
+     * @return void

      */
     protected function checkResponse(ResponseInterface $response, $data)
     {
      */
     protected function checkResponse(ResponseInterface $response, $data)
     {


@@ -99,8 +99,9 @@ class OidcOAuthProvider extends AbstractProvider
      * Generates a resource owner object from a successful resource owner
      * details request.
      *
      * Generates a resource owner object from a successful resource owner
      * details request.
      *

-     * @param array $response
+     * @param array       $response

      * @param AccessToken $token
      * @param AccessToken $token

+     *

      * @return ResourceOwnerInterface
      */
     protected function createResourceOwner(array $response, AccessToken $token)
      * @return ResourceOwnerInterface
      */
     protected function createResourceOwner(array $response, AccessToken $token)


@@ -114,14 +115,13 @@ class OidcOAuthProvider extends AbstractProvider
      * The grant that was used to fetch the response can be used to provide
      * additional context.
      *
      * The grant that was used to fetch the response can be used to provide
      * additional context.
      *

-     * @param array $response
+     * @param array         $response

      * @param AbstractGrant $grant
      * @param AbstractGrant $grant

+     *

      * @return OidcAccessToken
      */
     protected function createAccessToken(array $response, AbstractGrant $grant)
     {
         return new OidcAccessToken($response);
     }
      * @return OidcAccessToken
      */
     protected function createAccessToken(array $response, AbstractGrant $grant)
     {
         return new OidcAccessToken($response);
     }

-
-
-}
\ No newline at end of file
+}

diff --git a/app/Auth/Access/Oidc/OidcProviderSettings.php b/app/Auth/Access/Oidc/OidcProviderSettings.php
index 2b72c54b00b363a587c9ada9823eadadba021244..32946d058cf807c51153c3ce9f2108ccd2c708d9 100644 (file)
--- a/app/Auth/Access/Oidc/OidcProviderSettings.php
+++ b/app/Auth/Access/Oidc/OidcProviderSettings.php
@@ -70,6 +70,7 @@ class OidcProviderSettings
 
     /**
      * Validate any core, required properties have been set.
 
     /**
      * Validate any core, required properties have been set.

+     *

      * @throws InvalidArgumentException
      */
     protected function validateInitial()
      * @throws InvalidArgumentException
      */
     protected function validateInitial()


@@ -82,12 +83,13 @@ class OidcProviderSettings
         }
 
         if (strpos($this->issuer, 'https://') !== 0) {
         }
 
         if (strpos($this->issuer, 'https://') !== 0) {

-            throw new InvalidArgumentException("Issuer value must start with https://");
+            throw new InvalidArgumentException('Issuer value must start with https://');

         }
     }
 
     /**
      * Perform a full validation on these settings.
         }
     }
 
     /**
      * Perform a full validation on these settings.

+     *

      * @throws InvalidArgumentException
      */
     public function validate(): void
      * @throws InvalidArgumentException
      */
     public function validate(): void


@@ -103,13 +105,14 @@ class OidcProviderSettings
 
     /**
      * Discover and autoload settings from the configured issuer.
 
     /**
      * Discover and autoload settings from the configured issuer.

+     *

      * @throws OidcIssuerDiscoveryException
      */
     public function discoverFromIssuer(ClientInterface $httpClient, Repository $cache, int $cacheMinutes)
     {
         try {
             $cacheKey = 'oidc-discovery::' . $this->issuer;
      * @throws OidcIssuerDiscoveryException
      */
     public function discoverFromIssuer(ClientInterface $httpClient, Repository $cache, int $cacheMinutes)
     {
         try {
             $cacheKey = 'oidc-discovery::' . $this->issuer;

-            $discoveredSettings = $cache->remember($cacheKey, $cacheMinutes * 60, function() use ($httpClient) {
+            $discoveredSettings = $cache->remember($cacheKey, $cacheMinutes * 60, function () use ($httpClient) {

                 return $this->loadSettingsFromIssuerDiscovery($httpClient);
             });
             $this->applySettingsFromArray($discoveredSettings);
                 return $this->loadSettingsFromIssuerDiscovery($httpClient);
             });
             $this->applySettingsFromArray($discoveredSettings);


@@ -134,7 +137,7 @@ class OidcProviderSettings
         }
 
         if ($result['issuer'] !== $this->issuer) {
         }
 
         if ($result['issuer'] !== $this->issuer) {

-            throw new OidcIssuerDiscoveryException("Unexpected issuer value found on discovery response");
+            throw new OidcIssuerDiscoveryException('Unexpected issuer value found on discovery response');

         }
 
         $discoveredSettings = [];
         }
 
         $discoveredSettings = [];


@@ -160,13 +163,14 @@ class OidcProviderSettings
      */
     protected function filterKeys(array $keys): array
     {
      */
     protected function filterKeys(array $keys): array
     {

-        return array_filter($keys, function(array $key) {
+        return array_filter($keys, function (array $key) {

             return $key['kty'] === 'RSA' && $key['use'] === 'sig' && $key['alg'] === 'RS256';
         });
     }
 
     /**
      * Return an array of jwks as PHP key=>value arrays.
             return $key['kty'] === 'RSA' && $key['use'] === 'sig' && $key['alg'] === 'RS256';
         });
     }
 
     /**
      * Return an array of jwks as PHP key=>value arrays.

+     *

      * @throws ClientExceptionInterface
      * @throws OidcIssuerDiscoveryException
      */
      * @throws ClientExceptionInterface
      * @throws OidcIssuerDiscoveryException
      */


@@ -177,7 +181,7 @@ class OidcProviderSettings
         $result = json_decode($response->getBody()->getContents(), true);
 
         if (empty($result) || !is_array($result) || !isset($result['keys'])) {
         $result = json_decode($response->getBody()->getContents(), true);
 
         if (empty($result) || !is_array($result) || !isset($result['keys'])) {

-            throw new OidcIssuerDiscoveryException("Error reading keys from issuer jwks_uri");
+            throw new OidcIssuerDiscoveryException('Error reading keys from issuer jwks_uri');

         }
 
         return $result['keys'];
         }
 
         return $result['keys'];


@@ -193,6 +197,7 @@ class OidcProviderSettings
         foreach ($settingKeys as $setting) {
             $settings[$setting] = $this->$setting;
         }
         foreach ($settingKeys as $setting) {
             $settings[$setting] = $this->$setting;
         }

+

         return $settings;
     }
         return $settings;
     }

-}
\ No newline at end of file
+}

diff --git a/app/Auth/Access/Oidc/OidcService.php b/app/Auth/Access/Oidc/OidcService.php
index d59d274e8875a74332117beba062efb0ac8250bb..b8e017b4b135c85fd3b7aee9afbce252b0b372c1 100644 (file)
--- a/app/Auth/Access/Oidc/OidcService.php
+++ b/app/Auth/Access/Oidc/OidcService.php
@@ -1,5 +1,8 @@
-<?php namespace BookStack\Auth\Access\Oidc;
+<?php

 
 

+namespace BookStack\Auth\Access\Oidc;
+
+use function auth;

 use BookStack\Auth\Access\LoginService;
 use BookStack\Auth\Access\RegistrationService;
 use BookStack\Auth\User;
 use BookStack\Auth\Access\LoginService;
 use BookStack\Auth\Access\RegistrationService;
 use BookStack\Auth\User;


@@ -7,13 +10,12 @@ use BookStack\Exceptions\JsonDebugException;
 use BookStack\Exceptions\OpenIdConnectException;
 use BookStack\Exceptions\StoppedAuthenticationException;
 use BookStack\Exceptions\UserRegistrationException;
 use BookStack\Exceptions\OpenIdConnectException;
 use BookStack\Exceptions\StoppedAuthenticationException;
 use BookStack\Exceptions\UserRegistrationException;

+use function config;

 use Exception;
 use Illuminate\Support\Facades\Cache;
 use League\OAuth2\Client\OptionProvider\HttpBasicAuthOptionProvider;
 use Psr\Http\Client\ClientExceptionInterface;
 use Psr\Http\Client\ClientInterface as HttpClient;
 use Exception;
 use Illuminate\Support\Facades\Cache;
 use League\OAuth2\Client\OptionProvider\HttpBasicAuthOptionProvider;
 use Psr\Http\Client\ClientExceptionInterface;
 use Psr\Http\Client\ClientInterface as HttpClient;

-use function auth;
-use function config;

 use function trans;
 use function url;
 
 use function trans;
 use function url;
 


@@ -39,14 +41,16 @@ class OidcService
 
     /**
      * Initiate an authorization flow.
 
     /**
      * Initiate an authorization flow.

+     *

      * @return array{url: string, state: string}
      */
     public function login(): array
     {
         $settings = $this->getProviderSettings();
         $provider = $this->getProvider($settings);
      * @return array{url: string, state: string}
      */
     public function login(): array
     {
         $settings = $this->getProviderSettings();
         $provider = $this->getProvider($settings);

+

         return [
         return [

-            'url' => $provider->getAuthorizationUrl(),
+            'url'   => $provider->getAuthorizationUrl(),

             'state' => $provider->getState(),
         ];
     }
             'state' => $provider->getState(),
         ];
     }


@@ -56,6 +60,7 @@ class OidcService
      * return the matching, or new if registration active, user matched to
      * the authorization server.
      * Returns null if not authenticated.
      * return the matching, or new if registration active, user matched to
      * the authorization server.
      * Returns null if not authenticated.

+     *

      * @throws Exception
      * @throws ClientExceptionInterface
      */
      * @throws Exception
      * @throws ClientExceptionInterface
      */


@@ -80,12 +85,12 @@ class OidcService
     {
         $config = $this->config();
         $settings = new OidcProviderSettings([
     {
         $config = $this->config();
         $settings = new OidcProviderSettings([

-            'issuer' => $config['issuer'],
-            'clientId' => $config['client_id'],
-            'clientSecret' => $config['client_secret'],
-            'redirectUri' => url('/oidc/callback'),
+            'issuer'                => $config['issuer'],
+            'clientId'              => $config['client_id'],
+            'clientSecret'          => $config['client_secret'],
+            'redirectUri'           => url('/oidc/callback'),

             'authorizationEndpoint' => $config['authorization_endpoint'],
             'authorizationEndpoint' => $config['authorization_endpoint'],

-            'tokenEndpoint' => $config['token_endpoint'],
+            'tokenEndpoint'         => $config['token_endpoint'],

         ]);
 
         // Use keys if configured
         ]);
 
         // Use keys if configured


@@ -109,13 +114,13 @@ class OidcService
     protected function getProvider(OidcProviderSettings $settings): OidcOAuthProvider
     {
         return new OidcOAuthProvider($settings->arrayForProvider(), [
     protected function getProvider(OidcProviderSettings $settings): OidcOAuthProvider
     {
         return new OidcOAuthProvider($settings->arrayForProvider(), [

-            'httpClient' => $this->httpClient,
+            'httpClient'     => $this->httpClient,

             'optionProvider' => new HttpBasicAuthOptionProvider(),
         ]);
     }
 
     /**
             'optionProvider' => new HttpBasicAuthOptionProvider(),
         ]);
     }
 
     /**

-     * Calculate the display name
+     * Calculate the display name.

      */
     protected function getUserDisplayName(OidcIdToken $token, string $defaultValue): string
     {
      */
     protected function getUserDisplayName(OidcIdToken $token, string $defaultValue): string
     {


@@ -138,21 +143,24 @@ class OidcService
 
     /**
      * Extract the details of a user from an ID token.
 
     /**
      * Extract the details of a user from an ID token.

+     *

      * @return array{name: string, email: string, external_id: string}
      */
     protected function getUserDetails(OidcIdToken $token): array
     {
         $id = $token->getClaim('sub');
      * @return array{name: string, email: string, external_id: string}
      */
     protected function getUserDetails(OidcIdToken $token): array
     {
         $id = $token->getClaim('sub');

+

         return [
             'external_id' => $id,
         return [
             'external_id' => $id,

-            'email' => $token->getClaim('email'),
-            'name' => $this->getUserDisplayName($token, $id),
+            'email'       => $token->getClaim('email'),
+            'name'        => $this->getUserDisplayName($token, $id),

         ];
     }
 
     /**
      * Processes a received access token for a user. Login the user when
      * they exist, optionally registering them automatically.
         ];
     }
 
     /**
      * Processes a received access token for a user. Login the user when
      * they exist, optionally registering them automatically.

+     *

      * @throws OpenIdConnectException
      * @throws JsonDebugException
      * @throws UserRegistrationException
      * @throws OpenIdConnectException
      * @throws JsonDebugException
      * @throws UserRegistrationException


@@ -189,7 +197,9 @@ class OidcService
         }
 
         $user = $this->registrationService->findOrRegister(
         }
 
         $user = $this->registrationService->findOrRegister(

-            $userDetails['name'], $userDetails['email'], $userDetails['external_id']
+            $userDetails['name'],
+            $userDetails['email'],
+            $userDetails['external_id']

         );
 
         if ($user === null) {
         );
 
         if ($user === null) {


@@ -197,6 +207,7 @@ class OidcService
         }
 
         $this->loginService->login($user, 'oidc');
         }
 
         $this->loginService->login($user, 'oidc');

+

         return $user;
     }
 
         return $user;
     }
 

diff --git a/app/Auth/Access/RegistrationService.php b/app/Auth/Access/RegistrationService.php
index 48970bd2e4c531d82a7ebbcda11c7bf7cbb39433..dcdb68bd5cd725530ab31cf69c4a6cc382ea39b6 100644 (file)
--- a/app/Auth/Access/RegistrationService.php
+++ b/app/Auth/Access/RegistrationService.php
@@ -54,6 +54,7 @@ class RegistrationService
     /**
      * Attempt to find a user in the system otherwise register them as a new
      * user. For use with external auth systems since password is auto-generated.
     /**
      * Attempt to find a user in the system otherwise register them as a new
      * user. For use with external auth systems since password is auto-generated.

+     *

      * @throws UserRegistrationException
      */
     public function findOrRegister(string $name, string $email, string $externalId): User
      * @throws UserRegistrationException
      */
     public function findOrRegister(string $name, string $email, string $externalId): User

diff --git a/app/Auth/Access/Saml2Service.php b/app/Auth/Access/Saml2Service.php
index 8e076f86ca3d0a3aa96f1c22c24592f5cbde9f32..6d3915c4d5bc23f8b4bd00cf207e19d9b37341bc 100644 (file)
--- a/app/Auth/Access/Saml2Service.php
+++ b/app/Auth/Access/Saml2Service.php
@@ -29,10 +29,9 @@ class Saml2Service
      */
     public function __construct(
         RegistrationService $registrationService,
      */
     public function __construct(
         RegistrationService $registrationService,

-        LoginService        $loginService,
-        GroupSyncService    $groupSyncService
-    )
-    {
+        LoginService $loginService,
+        GroupSyncService $groupSyncService
+    ) {

         $this->config = config('saml2');
         $this->registrationService = $registrationService;
         $this->loginService = $loginService;
         $this->config = config('saml2');
         $this->registrationService = $registrationService;
         $this->loginService = $loginService;


@@ -51,7 +50,7 @@ class Saml2Service
 
         return [
             'url' => $toolKit->login($returnRoute, [], false, false, true),
 
         return [
             'url' => $toolKit->login($returnRoute, [], false, false, true),

-            'id' => $toolKit->getLastRequestID(),
+            'id'  => $toolKit->getLastRequestID(),

         ];
     }
 
         ];
     }
 


@@ -200,7 +199,7 @@ class Saml2Service
     protected function loadOneloginServiceProviderDetails(): array
     {
         $spDetails = [
     protected function loadOneloginServiceProviderDetails(): array
     {
         $spDetails = [

-            'entityId' => url('/saml2/metadata'),
+            'entityId'                 => url('/saml2/metadata'),

             'assertionConsumerService' => [
                 'url' => url('/saml2/acs'),
             ],
             'assertionConsumerService' => [
                 'url' => url('/saml2/acs'),
             ],


@@ -211,7 +210,7 @@ class Saml2Service
 
         return [
             'baseurl' => url('/saml2'),
 
         return [
             'baseurl' => url('/saml2'),

-            'sp' => $spDetails,
+            'sp'      => $spDetails,

         ];
     }
 
         ];
     }
 


@@ -263,6 +262,7 @@ class Saml2Service
 
     /**
      * Extract the details of a user from a SAML response.
 
     /**
      * Extract the details of a user from a SAML response.

+     *

      * @return array{external_id: string, name: string, email: string, saml_id: string}
      */
     protected function getUserDetails(string $samlID, $samlAttributes): array
      * @return array{external_id: string, name: string, email: string, saml_id: string}
      */
     protected function getUserDetails(string $samlID, $samlAttributes): array


@@ -275,9 +275,9 @@ class Saml2Service
 
         return [
             'external_id' => $externalId,
 
         return [
             'external_id' => $externalId,

-            'name' => $this->getUserDisplayName($samlAttributes, $externalId),
-            'email' => $email,
-            'saml_id' => $samlID,
+            'name'        => $this->getUserDisplayName($samlAttributes, $externalId),
+            'email'       => $email,
+            'saml_id'     => $samlID,

         ];
     }
 
         ];
     }
 


@@ -344,8 +344,8 @@ class Saml2Service
 
         if ($this->config['dump_user_details']) {
             throw new JsonDebugException([
 
         if ($this->config['dump_user_details']) {
             throw new JsonDebugException([

-                'id_from_idp' => $samlID,
-                'attrs_from_idp' => $samlAttributes,
+                'id_from_idp'         => $samlID,
+                'attrs_from_idp'      => $samlAttributes,

                 'attrs_after_parsing' => $userDetails,
             ]);
         }
                 'attrs_after_parsing' => $userDetails,
             ]);
         }


@@ -359,7 +359,9 @@ class Saml2Service
         }
 
         $user = $this->registrationService->findOrRegister(
         }
 
         $user = $this->registrationService->findOrRegister(

-            $userDetails['name'], $userDetails['email'], $userDetails['external_id']
+            $userDetails['name'],
+            $userDetails['email'],
+            $userDetails['external_id']

         );
 
         if ($user === null) {
         );
 
         if ($user === null) {

diff --git a/app/Config/auth.php b/app/Config/auth.php
index 69da69bf1195202524de8ec25736ececd29c6982..88c22e70aca0760315963f942422adf6d2f8c511 100644 (file)
--- a/app/Config/auth.php
+++ b/app/Config/auth.php
@@ -41,7 +41,7 @@ return [
             'provider' => 'external',
         ],
         'oidc' => [
             'provider' => 'external',
         ],
         'oidc' => [

-            'driver' => 'async-external-session',
+            'driver'   => 'async-external-session',

             'provider' => 'external',
         ],
         'api' => [
             'provider' => 'external',
         ],
         'api' => [

diff --git a/app/Config/oidc.php b/app/Config/oidc.php
index 1b50d9d66c9cabacb1d72e2068112f4caf2f7ede..842ac8af6b8ef236822fe50a9c11c8190627bff7 100644 (file)
--- a/app/Config/oidc.php
+++ b/app/Config/oidc.php
@@ -31,5 +31,5 @@ return [
 
     // OAuth2 endpoints.
     'authorization_endpoint' => env('OIDC_AUTH_ENDPOINT', null),
 
     // OAuth2 endpoints.
     'authorization_endpoint' => env('OIDC_AUTH_ENDPOINT', null),

-    'token_endpoint' => env('OIDC_TOKEN_ENDPOINT', null),
+    'token_endpoint'         => env('OIDC_TOKEN_ENDPOINT', null),

 ];
 ];

diff --git a/app/Exceptions/OpenIdConnectException.php b/app/Exceptions/OpenIdConnectException.php
index d585857320f3895091974b58561a74b2863915d3..7bbc4bdaf57f467267b106dc93a12e174394e6a6 100644 (file)
--- a/app/Exceptions/OpenIdConnectException.php
+++ b/app/Exceptions/OpenIdConnectException.php
@@ -1,6 +1,7 @@
-<?php namespace BookStack\Exceptions;
+<?php
+
+namespace BookStack\Exceptions;

 
 class OpenIdConnectException extends NotifyException
 {
 
 class OpenIdConnectException extends NotifyException
 {

-

 }
 }

diff --git a/app/Http/Controllers/Auth/OidcController.php b/app/Http/Controllers/Auth/OidcController.php
index f4103cb0a788acb640d4bdf46f17bed930fa5c8a..ff93dd803aa822b82138d81332cd28125821b504 100644 (file)
--- a/app/Http/Controllers/Auth/OidcController.php
+++ b/app/Http/Controllers/Auth/OidcController.php
@@ -8,7 +8,6 @@ use Illuminate\Http\Request;
 
 class OidcController extends Controller
 {
 
 class OidcController extends Controller
 {

-

     protected $oidcService;
 
     /**
     protected $oidcService;
 
     /**


@@ -42,10 +41,12 @@ class OidcController extends Controller
 
         if ($storedState !== $responseState) {
             $this->showErrorNotification(trans('errors.oidc_fail_authed', ['system' => config('oidc.name')]));
 
         if ($storedState !== $responseState) {
             $this->showErrorNotification(trans('errors.oidc_fail_authed', ['system' => config('oidc.name')]));

+

             return redirect('/login');
         }
 
         $this->oidcService->processAuthorizeResponse($request->query('code'));
             return redirect('/login');
         }
 
         $this->oidcService->processAuthorizeResponse($request->query('code'));

+

         return redirect()->intended();
     }
 }
         return redirect()->intended();
     }
 }

diff --git a/app/Providers/AppServiceProvider.php b/app/Providers/AppServiceProvider.php
index da41de6513a189e1403ec24b3b41e2388131d322..34a3a290f0c0cf200537217abf0f0d677c38a5d3 100644 (file)
--- a/app/Providers/AppServiceProvider.php
+++ b/app/Providers/AppServiceProvider.php
@@ -22,8 +22,8 @@ use Illuminate\Support\Facades\URL;
 use Illuminate\Support\Facades\View;
 use Illuminate\Support\ServiceProvider;
 use Laravel\Socialite\Contracts\Factory as SocialiteFactory;
 use Illuminate\Support\Facades\View;
 use Illuminate\Support\ServiceProvider;
 use Laravel\Socialite\Contracts\Factory as SocialiteFactory;

-use Whoops\Handler\HandlerInterface;

 use Psr\Http\Client\ClientInterface as HttpClientInterface;
 use Psr\Http\Client\ClientInterface as HttpClientInterface;

+use Whoops\Handler\HandlerInterface;

 
 class AppServiceProvider extends ServiceProvider
 {
 
 class AppServiceProvider extends ServiceProvider
 {


@@ -85,7 +85,7 @@ class AppServiceProvider extends ServiceProvider
             return new CspService();
         });
 
             return new CspService();
         });
 

-        $this->app->bind(HttpClientInterface::class, function($app) {
+        $this->app->bind(HttpClientInterface::class, function ($app) {

             return new Client([
                 'timeout' => 3,
             ]);
             return new Client([
                 'timeout' => 3,
             ]);

diff --git a/app/Providers/AuthServiceProvider.php b/app/Providers/AuthServiceProvider.php
index bc7caa195ac4876e7a58621ac7699fabedc5ce68..4a626e4fadd49e49d697967c496aad433f6de488 100644 (file)
--- a/app/Providers/AuthServiceProvider.php
+++ b/app/Providers/AuthServiceProvider.php
@@ -4,8 +4,8 @@ namespace BookStack\Providers;
 
 use BookStack\Api\ApiTokenGuard;
 use BookStack\Auth\Access\ExternalBaseUserProvider;
 
 use BookStack\Api\ApiTokenGuard;
 use BookStack\Auth\Access\ExternalBaseUserProvider;

-use BookStack\Auth\Access\Guards\LdapSessionGuard;

 use BookStack\Auth\Access\Guards\AsyncExternalBaseSessionGuard;
 use BookStack\Auth\Access\Guards\AsyncExternalBaseSessionGuard;

+use BookStack\Auth\Access\Guards\LdapSessionGuard;

 use BookStack\Auth\Access\LdapService;
 use BookStack\Auth\Access\LoginService;
 use BookStack\Auth\Access\RegistrationService;
 use BookStack\Auth\Access\LdapService;
 use BookStack\Auth\Access\LoginService;
 use BookStack\Auth\Access\RegistrationService;

diff --git a/tests/Auth/OidcTest.php b/tests/Auth/OidcTest.php
index cf04080fcddbada23c85af1736773902ceaa9520..6c806aa8ed4e99901aa84bf1060baba20e8eda6a 100644 (file)
--- a/tests/Auth/OidcTest.php
+++ b/tests/Auth/OidcTest.php
@@ -1,7 +1,8 @@
-<?php namespace Tests\Auth;
+<?php
+
+namespace Tests\Auth;

 
 use BookStack\Actions\ActivityType;
 
 use BookStack\Actions\ActivityType;

-use BookStack\Auth\Access\Oidc\OidcService;

 use BookStack\Auth\User;
 use GuzzleHttp\Psr7\Request;
 use GuzzleHttp\Psr7\Response;
 use BookStack\Auth\User;
 use GuzzleHttp\Psr7\Request;
 use GuzzleHttp\Psr7\Response;


@@ -25,18 +26,18 @@ class OidcTest extends TestCase
         file_put_contents($this->keyFilePath, OidcJwtHelper::publicPemKey());
 
         config()->set([
         file_put_contents($this->keyFilePath, OidcJwtHelper::publicPemKey());
 
         config()->set([

-            'auth.method' => 'oidc',
-            'auth.defaults.guard' => 'oidc',
-            'oidc.name' => 'SingleSignOn-Testing',
-            'oidc.display_name_claims' => ['name'],
-            'oidc.client_id' => OidcJwtHelper::defaultClientId(),
-            'oidc.client_secret' => 'testpass',
-            'oidc.jwt_public_key' => $this->keyFilePath,
-            'oidc.issuer' => OidcJwtHelper::defaultIssuer(),
+            'auth.method'                 => 'oidc',
+            'auth.defaults.guard'         => 'oidc',
+            'oidc.name'                   => 'SingleSignOn-Testing',
+            'oidc.display_name_claims'    => ['name'],
+            'oidc.client_id'              => OidcJwtHelper::defaultClientId(),
+            'oidc.client_secret'          => 'testpass',
+            'oidc.jwt_public_key'         => $this->keyFilePath,
+            'oidc.issuer'                 => OidcJwtHelper::defaultIssuer(),

             'oidc.authorization_endpoint' => 'https://oidc.local/auth',
             'oidc.authorization_endpoint' => 'https://oidc.local/auth',

-            'oidc.token_endpoint' => 'https://oidc.local/token',
-            'oidc.discover' => false,
-            'oidc.dump_user_details' => false,
+            'oidc.token_endpoint'         => 'https://oidc.local/token',
+            'oidc.discover'               => false,
+            'oidc.dump_user_details'      => false,

         ]);
     }
 
         ]);
     }
 


@@ -131,7 +132,7 @@ class OidcTest extends TestCase
 
         $transactions = &$this->mockHttpClient([$this->getMockAuthorizationResponse([
             'email' => '[email protected]',
 
         $transactions = &$this->mockHttpClient([$this->getMockAuthorizationResponse([
             'email' => '[email protected]',

-            'sub' => 'benny1010101'
+            'sub'   => 'benny1010101',

         ])]);
 
         // Callback from auth provider
         ])]);
 
         // Callback from auth provider


@@ -148,12 +149,11 @@ class OidcTest extends TestCase
         $this->assertStringContainsString('code=SplxlOBeZQQYbYS6WxSbIA', $tokenRequest->getBody());
         $this->assertStringContainsString('redirect_uri=' . urlencode(url('/oidc/callback')), $tokenRequest->getBody());
 
         $this->assertStringContainsString('code=SplxlOBeZQQYbYS6WxSbIA', $tokenRequest->getBody());
         $this->assertStringContainsString('redirect_uri=' . urlencode(url('/oidc/callback')), $tokenRequest->getBody());
 

-

         $this->assertTrue(auth()->check());
         $this->assertDatabaseHas('users', [
         $this->assertTrue(auth()->check());
         $this->assertDatabaseHas('users', [

-            'email' => '[email protected]',
+            'email'            => '[email protected]',

             'external_auth_id' => 'benny1010101',
             'external_auth_id' => 'benny1010101',

-            'email_confirmed' => false,
+            'email_confirmed'  => false,

         ]);
 
         $user = User::query()->where('email', '=', '[email protected]')->first();
         ]);
 
         $user = User::query()->where('email', '=', '[email protected]')->first();


@@ -176,15 +176,15 @@ class OidcTest extends TestCase
 
         $resp = $this->runLogin([
             'email' => '[email protected]',
 
         $resp = $this->runLogin([
             'email' => '[email protected]',

-            'sub' => 'benny505'
+            'sub'   => 'benny505',

         ]);
 
         $resp->assertStatus(200);
         $resp->assertJson([
             'email' => '[email protected]',
         ]);
 
         $resp->assertStatus(200);
         $resp->assertJson([
             'email' => '[email protected]',

-            'sub' => 'benny505',
-            "iss" => OidcJwtHelper::defaultIssuer(),
-            "aud" => OidcJwtHelper::defaultClientId(),
+            'sub'   => 'benny505',
+            'iss'   => OidcJwtHelper::defaultIssuer(),
+            'aud'   => OidcJwtHelper::defaultClientId(),

         ]);
         $this->assertFalse(auth()->check());
     }
         ]);
         $this->assertFalse(auth()->check());
     }


@@ -193,7 +193,7 @@ class OidcTest extends TestCase
     {
         $this->runLogin([
             'email' => '',
     {
         $this->runLogin([
             'email' => '',

-            'sub' => 'benny505'
+            'sub'   => 'benny505',

         ]);
 
         $this->assertSessionError('Could not find an email address, for this user, in the data provided by the external authentication system');
         ]);
 
         $this->assertSessionError('Could not find an email address, for this user, in the data provided by the external authentication system');


@@ -205,7 +205,7 @@ class OidcTest extends TestCase
 
         $this->runLogin([
             'email' => '[email protected]',
 
         $this->runLogin([
             'email' => '[email protected]',

-            'sub' => 'benny505'
+            'sub'   => 'benny505',

         ]);
 
         $this->assertSessionError('Already logged in');
         ]);
 
         $this->assertSessionError('Already logged in');


@@ -221,7 +221,7 @@ class OidcTest extends TestCase
 
         $this->runLogin([
             'email' => '[email protected]',
 
         $this->runLogin([
             'email' => '[email protected]',

-            'sub' => 'benny505'
+            'sub'   => 'benny505',

         ]);
 
         $this->assertTrue(auth()->check());
         ]);
 
         $this->assertTrue(auth()->check());


@@ -238,7 +238,7 @@ class OidcTest extends TestCase
 
         $this->runLogin([
             'email' => $editor->email,
 
         $this->runLogin([
             'email' => $editor->email,

-            'sub' => 'benny505'
+            'sub'   => 'benny505',

         ]);
 
         $this->assertSessionError('A user with the email ' . $editor->email . ' already exists but with different credentials.');
         ]);
 
         $this->assertSessionError('A user with the email ' . $editor->email . ' already exists but with different credentials.');


@@ -300,7 +300,7 @@ class OidcTest extends TestCase
             $this->getAutoDiscoveryResponse(),
             $this->getJwksResponse(),
             $this->getAutoDiscoveryResponse([
             $this->getAutoDiscoveryResponse(),
             $this->getJwksResponse(),
             $this->getAutoDiscoveryResponse([

-                'issuer' => 'https://auto.example.com'
+                'issuer' => 'https://auto.example.com',

             ]),
             $this->getJwksResponse(),
         ]);
             ]),
             $this->getJwksResponse(),
         ]);


@@ -321,11 +321,11 @@ class OidcTest extends TestCase
     protected function withAutodiscovery()
     {
         config()->set([
     protected function withAutodiscovery()
     {
         config()->set([

-            'oidc.issuer' => OidcJwtHelper::defaultIssuer(),
-            'oidc.discover' => true,
+            'oidc.issuer'                 => OidcJwtHelper::defaultIssuer(),
+            'oidc.discover'               => true,

             'oidc.authorization_endpoint' => null,
             'oidc.authorization_endpoint' => null,

-            'oidc.token_endpoint' => null,
-            'oidc.jwt_public_key' => null,
+            'oidc.token_endpoint'         => null,
+            'oidc.jwt_public_key'         => null,

         ]);
     }
 
         ]);
     }
 


@@ -341,41 +341,41 @@ class OidcTest extends TestCase
     protected function getAutoDiscoveryResponse($responseOverrides = []): Response
     {
         return new Response(200, [
     protected function getAutoDiscoveryResponse($responseOverrides = []): Response
     {
         return new Response(200, [

-            'Content-Type' => 'application/json',
+            'Content-Type'  => 'application/json',

             'Cache-Control' => 'no-cache, no-store',
             'Cache-Control' => 'no-cache, no-store',

-            'Pragma' => 'no-cache'
+            'Pragma'        => 'no-cache',

         ], json_encode(array_merge([
         ], json_encode(array_merge([

-            'token_endpoint' => OidcJwtHelper::defaultIssuer() . '/oidc/token',
+            'token_endpoint'         => OidcJwtHelper::defaultIssuer() . '/oidc/token',

             'authorization_endpoint' => OidcJwtHelper::defaultIssuer() . '/oidc/authorize',
             'authorization_endpoint' => OidcJwtHelper::defaultIssuer() . '/oidc/authorize',

-            'jwks_uri' => OidcJwtHelper::defaultIssuer() . '/oidc/keys',
-            'issuer' => OidcJwtHelper::defaultIssuer()
+            'jwks_uri'               => OidcJwtHelper::defaultIssuer() . '/oidc/keys',
+            'issuer'                 => OidcJwtHelper::defaultIssuer(),

         ], $responseOverrides)));
     }
 
     protected function getJwksResponse(): Response
     {
         return new Response(200, [
         ], $responseOverrides)));
     }
 
     protected function getJwksResponse(): Response
     {
         return new Response(200, [

-            'Content-Type' => 'application/json',
+            'Content-Type'  => 'application/json',

             'Cache-Control' => 'no-cache, no-store',
             'Cache-Control' => 'no-cache, no-store',

-            'Pragma' => 'no-cache'
+            'Pragma'        => 'no-cache',

         ], json_encode([
             'keys' => [
         ], json_encode([
             'keys' => [

-                OidcJwtHelper::publicJwkKeyArray()
-            ]
+                OidcJwtHelper::publicJwkKeyArray(),
+            ],

         ]));
     }
 
     protected function getMockAuthorizationResponse($claimOverrides = []): Response
     {
         return new Response(200, [
         ]));
     }
 
     protected function getMockAuthorizationResponse($claimOverrides = []): Response
     {
         return new Response(200, [

-            'Content-Type' => 'application/json',
+            'Content-Type'  => 'application/json',

             'Cache-Control' => 'no-cache, no-store',
             'Cache-Control' => 'no-cache, no-store',

-            'Pragma' => 'no-cache'
+            'Pragma'        => 'no-cache',

         ], json_encode([
             'access_token' => 'abc123',
         ], json_encode([
             'access_token' => 'abc123',

-            'token_type' => 'Bearer',
-            'expires_in' => 3600,
-            'id_token' => OidcJwtHelper::idToken($claimOverrides)
+            'token_type'   => 'Bearer',
+            'expires_in'   => 3600,
+            'id_token'     => OidcJwtHelper::idToken($claimOverrides),

         ]));
     }
 }
         ]));
     }
 }

diff --git a/tests/Helpers/OidcJwtHelper.php b/tests/Helpers/OidcJwtHelper.php
index 0c44efb01a6e3f7682677f439f39ceca9455dc33..55a34d4dc967108834ddf910bac09900002bd32d 100644 (file)
--- a/tests/Helpers/OidcJwtHelper.php
+++ b/tests/Helpers/OidcJwtHelper.php
@@ -12,31 +12,31 @@ class OidcJwtHelper
 {
     public static function defaultIssuer(): string
     {
 {
     public static function defaultIssuer(): string
     {

-        return "https://auth.example.com";
+        return 'https://auth.example.com';

     }
 
     public static function defaultClientId(): string
     {
     }
 
     public static function defaultClientId(): string
     {

-        return "xxyyzz.aaa.bbccdd.123";
+        return 'xxyyzz.aaa.bbccdd.123';

     }
 
     public static function defaultPayload(): array
     {
         return [
     }
 
     public static function defaultPayload(): array
     {
         return [

-            "sub" => "abc1234def",
-            "name" => "Barry Scott",
-            "email" => "[email protected]",
-            "ver" => 1,
-            "iss" => static::defaultIssuer(),
-            "aud" => static::defaultClientId(),
-            "iat" => time(),
-            "exp" => time() + 720,
-            "jti" => "ID.AaaBBBbbCCCcccDDddddddEEEeeeeee",
-            "amr" => ["pwd"],
-            "idp" => "fghfghgfh546456dfgdfg",
-            "preferred_username" => "xXBazzaXx",
-            "auth_time" => time(),
-            "at_hash" => "sT4jbsdSGy9w12pq3iNYDA",
+            'sub'                => 'abc1234def',
+            'name'               => 'Barry Scott',
+            'email'              => '[email protected]',
+            'ver'                => 1,
+            'iss'                => static::defaultIssuer(),
+            'aud'                => static::defaultClientId(),
+            'iat'                => time(),
+            'exp'                => time() + 720,
+            'jti'                => 'ID.AaaBBBbbCCCcccDDddddddEEEeeeeee',
+            'amr'                => ['pwd'],
+            'idp'                => 'fghfghgfh546456dfgdfg',
+            'preferred_username' => 'xXBazzaXx',
+            'auth_time'          => time(),
+            'at_hash'            => 'sT4jbsdSGy9w12pq3iNYDA',

         ];
     }
 
         ];
     }
 


@@ -55,6 +55,7 @@ class OidcJwtHelper
 
         $privateKey = static::privateKeyInstance();
         $signature = $privateKey->sign($top);
 
         $privateKey = static::privateKeyInstance();
         $signature = $privateKey->sign($top);

+

         return $top . '.' . static::base64UrlEncode($signature);
     }
 
         return $top . '.' . static::base64UrlEncode($signature);
     }
 


@@ -75,7 +76,7 @@ class OidcJwtHelper
 
     public static function publicPemKey(): string
     {
 
     public static function publicPemKey(): string
     {

-        return "-----BEGIN PUBLIC KEY-----
+        return '-----BEGIN PUBLIC KEY-----

 MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqo1OmfNKec5S2zQC4SP9
 DrHuUR0VgCi6oqcGERz7zqO36hqk3A3R3aCgJkEjfnbnMuszRRKs45NbXoOp9pvm
 zXL16c93Obn7G8x8A3ao6yN5qKO5S5+CETqOZfKN/g75Xlz7VsC3igOhgsXnPx6i
 MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqo1OmfNKec5S2zQC4SP9
 DrHuUR0VgCi6oqcGERz7zqO36hqk3A3R3aCgJkEjfnbnMuszRRKs45NbXoOp9pvm
 zXL16c93Obn7G8x8A3ao6yN5qKO5S5+CETqOZfKN/g75Xlz7VsC3igOhgsXnPx6i


@@ -83,12 +84,12 @@ iM6sbYbk0U/XpFaT84LXKI8VTIPUo7gTeZN1pTET//i9FlzAOzX+xfWBKdOqlEzl
 +zihMHCZUUvQu99P+o0MDR0lMUT+vPJ6SJeRfnoHexwt6bZFiNnsZIEL03bX4QNk
 WvsLta1+jNUee+8IPVhzCO8bvM86NzLaKUJ4k6NZ5IVrmdCFpFsjCWByOrDG8wdw
 3wIDAQAB
 +zihMHCZUUvQu99P+o0MDR0lMUT+vPJ6SJeRfnoHexwt6bZFiNnsZIEL03bX4QNk
 WvsLta1+jNUee+8IPVhzCO8bvM86NzLaKUJ4k6NZ5IVrmdCFpFsjCWByOrDG8wdw
 3wIDAQAB

------END PUBLIC KEY-----";
+-----END PUBLIC KEY-----';

     }
 
     public static function privatePemKey(): string
     {
     }
 
     public static function privatePemKey(): string
     {

-        return "-----BEGIN PRIVATE KEY-----
+        return '-----BEGIN PRIVATE KEY-----

 MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCqjU6Z80p5zlLb
 NALhI/0Ose5RHRWAKLqipwYRHPvOo7fqGqTcDdHdoKAmQSN+ducy6zNFEqzjk1te
 g6n2m+bNcvXpz3c5ufsbzHwDdqjrI3moo7lLn4IROo5l8o3+DvleXPtWwLeKA6GC
 MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCqjU6Z80p5zlLb
 NALhI/0Ose5RHRWAKLqipwYRHPvOo7fqGqTcDdHdoKAmQSN+ducy6zNFEqzjk1te
 g6n2m+bNcvXpz3c5ufsbzHwDdqjrI3moo7lLn4IROo5l8o3+DvleXPtWwLeKA6GC


@@ -115,7 +116,7 @@ W0TI+6Fc2xwPj38vP465dTentbKM1E+wdSYW6SMwSfhO6ECDbfJsst5Sr2Kkt1N7
 efqXPwg2wAPYeiec49EbfnteQQKAkqNfJ9K69yE2naf6bw3/5mCBsq/cXeuaBMII
 ylysUIRBqt2J0kWm2yCpFWR7H+Ilhdx9A7ZLCqYVt8e+vjO/BOI3cQDe2VPOLPSl
 q/1PY4iJviGKddtmfClH3v4=
 efqXPwg2wAPYeiec49EbfnteQQKAkqNfJ9K69yE2naf6bw3/5mCBsq/cXeuaBMII
 ylysUIRBqt2J0kWm2yCpFWR7H+Ilhdx9A7ZLCqYVt8e+vjO/BOI3cQDe2VPOLPSl
 q/1PY4iJviGKddtmfClH3v4=

------END PRIVATE KEY-----";
+-----END PRIVATE KEY-----';

     }
 
     public static function publicJwkKeyArray(): array
     }
 
     public static function publicJwkKeyArray(): array


@@ -125,8 +126,8 @@ q/1PY4iJviGKddtmfClH3v4=
             'alg' => 'RS256',
             'kid' => '066e52af-8884-4926-801d-032a276f9f2a',
             'use' => 'sig',
             'alg' => 'RS256',
             'kid' => '066e52af-8884-4926-801d-032a276f9f2a',
             'use' => 'sig',

-            'e' => 'AQAB',
-            'n' => 'qo1OmfNKec5S2zQC4SP9DrHuUR0VgCi6oqcGERz7zqO36hqk3A3R3aCgJkEjfnbnMuszRRKs45NbXoOp9pvmzXL16c93Obn7G8x8A3ao6yN5qKO5S5-CETqOZfKN_g75Xlz7VsC3igOhgsXnPx6iiM6sbYbk0U_XpFaT84LXKI8VTIPUo7gTeZN1pTET__i9FlzAOzX-xfWBKdOqlEzl-zihMHCZUUvQu99P-o0MDR0lMUT-vPJ6SJeRfnoHexwt6bZFiNnsZIEL03bX4QNkWvsLta1-jNUee-8IPVhzCO8bvM86NzLaKUJ4k6NZ5IVrmdCFpFsjCWByOrDG8wdw3w',
+            'e'   => 'AQAB',
+            'n'   => 'qo1OmfNKec5S2zQC4SP9DrHuUR0VgCi6oqcGERz7zqO36hqk3A3R3aCgJkEjfnbnMuszRRKs45NbXoOp9pvmzXL16c93Obn7G8x8A3ao6yN5qKO5S5-CETqOZfKN_g75Xlz7VsC3igOhgsXnPx6iiM6sbYbk0U_XpFaT84LXKI8VTIPUo7gTeZN1pTET__i9FlzAOzX-xfWBKdOqlEzl-zihMHCZUUvQu99P-o0MDR0lMUT-vPJ6SJeRfnoHexwt6bZFiNnsZIEL03bX4QNkWvsLta1-jNUee-8IPVhzCO8bvM86NzLaKUJ4k6NZ5IVrmdCFpFsjCWByOrDG8wdw3w',

         ];
     }
         ];
     }

-}
\ No newline at end of file
+}

diff --git a/tests/SharedTestHelpers.php b/tests/SharedTestHelpers.php
index 606a3cd9e20c601d9a2f6263c73a17efdffc8d53..04952d22345caa18761466b026ce3b701395599c 100644 (file)
--- a/tests/SharedTestHelpers.php
+++ b/tests/SharedTestHelpers.php
@@ -252,6 +252,7 @@ trait SharedTestHelpers
     /**
      * Mock the http client used in BookStack.
      * Returns a reference to the container which holds all history of http transactions.
     /**
      * Mock the http client used in BookStack.
      * Returns a reference to the container which holds all history of http transactions.

+     *

      * @link https://docs.guzzlephp.org/en/stable/testing.html#history-middleware
      */
     protected function &mockHttpClient(array $responses = []): array
      * @link https://docs.guzzlephp.org/en/stable/testing.html#history-middleware
      */
     protected function &mockHttpClient(array $responses = []): array


@@ -262,6 +263,7 @@ trait SharedTestHelpers
         $handlerStack = new HandlerStack($mock);
         $handlerStack->push($history);
         $this->app[ClientInterface::class] = new Client(['handler' => $handlerStack]);
         $handlerStack = new HandlerStack($mock);
         $handlerStack->push($history);
         $this->app[ClientInterface::class] = new Client(['handler' => $handlerStack]);

+

         return $container;
     }
 
         return $container;
     }
 

diff --git a/tests/Unit/OidcIdTokenTest.php b/tests/Unit/OidcIdTokenTest.php
index b08d578b3b954c8b2d8bc4cc920c7bacac64971b..ad91eecd8b26e5b7de232b7e948900c2854ad9d6 100644 (file)
--- a/tests/Unit/OidcIdTokenTest.php
+++ b/tests/Unit/OidcIdTokenTest.php
@@ -2,8 +2,8 @@
 
 namespace Tests\Unit;
 
 
 namespace Tests\Unit;
 

-use BookStack\Auth\Access\Oidc\OidcInvalidTokenException;

 use BookStack\Auth\Access\Oidc\OidcIdToken;
 use BookStack\Auth\Access\Oidc\OidcIdToken;

+use BookStack\Auth\Access\Oidc\OidcInvalidTokenException;

 use Tests\Helpers\OidcJwtHelper;
 use Tests\TestCase;
 
 use Tests\Helpers\OidcJwtHelper;
 use Tests\TestCase;
 


@@ -12,7 +12,7 @@ class OidcIdTokenTest extends TestCase
     public function test_valid_token_passes_validation()
     {
         $token = new OidcIdToken(OidcJwtHelper::idToken(), OidcJwtHelper::defaultIssuer(), [
     public function test_valid_token_passes_validation()
     {
         $token = new OidcIdToken(OidcJwtHelper::idToken(), OidcJwtHelper::defaultIssuer(), [

-            OidcJwtHelper::publicJwkKeyArray()
+            OidcJwtHelper::publicJwkKeyArray(),

         ]);
 
         $this->assertTrue($token->validate('xxyyzz.aaa.bbccdd.123'));
         ]);
 
         $this->assertTrue($token->validate('xxyyzz.aaa.bbccdd.123'));


@@ -54,6 +54,7 @@ class OidcIdTokenTest extends TestCase
         foreach ($messagesAndTokenValues as [$message, $tokenValue]) {
             $token = new OidcIdToken($tokenValue, OidcJwtHelper::defaultIssuer(), []);
             $err = null;
         foreach ($messagesAndTokenValues as [$message, $tokenValue]) {
             $token = new OidcIdToken($tokenValue, OidcJwtHelper::defaultIssuer(), []);
             $err = null;

+

             try {
                 $token->validate('abc');
             } catch (\Exception $exception) {
             try {
                 $token->validate('abc');
             } catch (\Exception $exception) {


@@ -77,8 +78,8 @@ class OidcIdTokenTest extends TestCase
     {
         $token = new OidcIdToken(OidcJwtHelper::idToken(), OidcJwtHelper::defaultIssuer(), [
             array_merge(OidcJwtHelper::publicJwkKeyArray(), [
     {
         $token = new OidcIdToken(OidcJwtHelper::idToken(), OidcJwtHelper::defaultIssuer(), [
             array_merge(OidcJwtHelper::publicJwkKeyArray(), [

-                'n' => 'iqK-1QkICMf_cusNLpeNnN-bhT0-9WLBvzgwKLALRbrevhdi5ttrLHIQshaSL0DklzfyG2HWRmAnJ9Q7sweEjuRiiqRcSUZbYu8cIv2hLWYu7K_NH67D2WUjl0EnoHEuiVLsZhQe1CmdyLdx087j5nWkd64K49kXRSdxFQUlj8W3NeK3CjMEUdRQ3H4RZzJ4b7uuMiFA29S2ZhMNG20NPbkUVsFL-jiwTd10KSsPT8yBYipI9O7mWsUWt_8KZs1y_vpM_k3SyYihnWpssdzDm1uOZ8U3mzFr1xsLAO718GNUSXk6npSDzLl59HEqa6zs4O9awO2qnSHvcmyELNk31w'
-            ])
+                'n' => 'iqK-1QkICMf_cusNLpeNnN-bhT0-9WLBvzgwKLALRbrevhdi5ttrLHIQshaSL0DklzfyG2HWRmAnJ9Q7sweEjuRiiqRcSUZbYu8cIv2hLWYu7K_NH67D2WUjl0EnoHEuiVLsZhQe1CmdyLdx087j5nWkd64K49kXRSdxFQUlj8W3NeK3CjMEUdRQ3H4RZzJ4b7uuMiFA29S2ZhMNG20NPbkUVsFL-jiwTd10KSsPT8yBYipI9O7mWsUWt_8KZs1y_vpM_k3SyYihnWpssdzDm1uOZ8U3mzFr1xsLAO718GNUSXk6npSDzLl59HEqa6zs4O9awO2qnSHvcmyELNk31w',
+            ]),

         ]);
         $this->expectException(OidcInvalidTokenException::class);
         $this->expectExceptionMessage('Token signature could not be validated using the provided keys');
         ]);
         $this->expectException(OidcInvalidTokenException::class);
         $this->expectExceptionMessage('Token signature could not be validated using the provided keys');


@@ -97,7 +98,7 @@ class OidcIdTokenTest extends TestCase
     {
         $token = new OidcIdToken(OidcJwtHelper::idToken([], ['alg' => 'HS256']), OidcJwtHelper::defaultIssuer(), []);
         $this->expectException(OidcInvalidTokenException::class);
     {
         $token = new OidcIdToken(OidcJwtHelper::idToken([], ['alg' => 'HS256']), OidcJwtHelper::defaultIssuer(), []);
         $this->expectException(OidcInvalidTokenException::class);

-        $this->expectExceptionMessage("Only RS256 signature validation is supported. Token reports using HS256");
+        $this->expectExceptionMessage('Only RS256 signature validation is supported. Token reports using HS256');

         $token->validate('abc');
     }
 
         $token->validate('abc');
     }
 


@@ -134,10 +135,11 @@ class OidcIdTokenTest extends TestCase
 
         foreach ($claimOverridesByErrorMessage as [$message, $overrides]) {
             $token = new OidcIdToken(OidcJwtHelper::idToken($overrides), OidcJwtHelper::defaultIssuer(), [
 
         foreach ($claimOverridesByErrorMessage as [$message, $overrides]) {
             $token = new OidcIdToken(OidcJwtHelper::idToken($overrides), OidcJwtHelper::defaultIssuer(), [

-                OidcJwtHelper::publicJwkKeyArray()
+                OidcJwtHelper::publicJwkKeyArray(),

             ]);
 
             $err = null;
             ]);
 
             $err = null;

+

             try {
                 $token->validate('xxyyzz.aaa.bbccdd.123');
             } catch (\Exception $exception) {
             try {
                 $token->validate('xxyyzz.aaa.bbccdd.123');
             } catch (\Exception $exception) {


@@ -155,10 +157,10 @@ class OidcIdTokenTest extends TestCase
         $testFilePath = 'file://' . stream_get_meta_data($file)['uri'];
         file_put_contents($testFilePath, OidcJwtHelper::publicPemKey());
         $token = new OidcIdToken(OidcJwtHelper::idToken(), OidcJwtHelper::defaultIssuer(), [
         $testFilePath = 'file://' . stream_get_meta_data($file)['uri'];
         file_put_contents($testFilePath, OidcJwtHelper::publicPemKey());
         $token = new OidcIdToken(OidcJwtHelper::idToken(), OidcJwtHelper::defaultIssuer(), [

-            $testFilePath
+            $testFilePath,

         ]);
 
         $this->assertTrue($token->validate('xxyyzz.aaa.bbccdd.123'));
         unlink($testFilePath);
     }
         ]);
 
         $this->assertTrue($token->validate('xxyyzz.aaa.bbccdd.123'));
         unlink($testFilePath);
     }

-}
\ No newline at end of file
+}