Fixed failing test after drawio default url change

[bookstack] / app / Auth / Access / Saml2Service.php

diff --git a/app/Auth/Access/Saml2Service.php b/app/Auth/Access/Saml2Service.php
index 0316ff976e4623e222ac69cdcf956f8efab55334..f5d0cd7ccf57ee61fd863c8a85f5f9144d71db75 100644 (file)
--- a/app/Auth/Access/Saml2Service.php
+++ b/app/Auth/Access/Saml2Service.php
@@ -1,14 +1,15 @@
-<?php namespace BookStack\Auth\Access;
+<?php
+
+namespace BookStack\Auth\Access;

 
 

-use BookStack\Actions\ActivityType;

 use BookStack\Auth\User;
 use BookStack\Exceptions\JsonDebugException;
 use BookStack\Exceptions\SamlException;
 use BookStack\Auth\User;
 use BookStack\Exceptions\JsonDebugException;
 use BookStack\Exceptions\SamlException;

+use BookStack\Exceptions\StoppedAuthenticationException;

 use BookStack\Exceptions\UserRegistrationException;
 use BookStack\Exceptions\UserRegistrationException;

-use BookStack\Facades\Activity;

 use Exception;
 use Exception;

-use Illuminate\Support\Str;

 use OneLogin\Saml2\Auth;
 use OneLogin\Saml2\Auth;

+use OneLogin\Saml2\Constants;

 use OneLogin\Saml2\Error;
 use OneLogin\Saml2\IdPMetadataParser;
 use OneLogin\Saml2\ValidationError;
 use OneLogin\Saml2\Error;
 use OneLogin\Saml2\IdPMetadataParser;
 use OneLogin\Saml2\ValidationError;


@@ -17,47 +18,62 @@ use OneLogin\Saml2\ValidationError;
  * Class Saml2Service
  * Handles any app-specific SAML tasks.
  */
  * Class Saml2Service
  * Handles any app-specific SAML tasks.
  */

-class Saml2Service extends ExternalAuthService
+class Saml2Service

 {
     protected $config;
     protected $registrationService;
 {
     protected $config;
     protected $registrationService;

-    protected $user;
+    protected $loginService;
+    protected $groupSyncService;

 
     /**
      * Saml2Service constructor.
      */
 
     /**
      * Saml2Service constructor.
      */

-    public function __construct(RegistrationService $registrationService, User $user)
-    {
+    public function __construct(
+        RegistrationService $registrationService,
+        LoginService $loginService,
+        GroupSyncService $groupSyncService
+    ) {

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

-        $this->user = $user;
+        $this->loginService = $loginService;
+        $this->groupSyncService = $groupSyncService;

     }
 
     /**
      * Initiate a login flow.
     }
 
     /**
      * Initiate a login flow.

+     *

      * @throws Error
      */
     public function login(): array
     {
         $toolKit = $this->getToolkit();
         $returnRoute = url('/saml2/acs');
      * @throws Error
      */
     public function login(): array
     {
         $toolKit = $this->getToolkit();
         $returnRoute = url('/saml2/acs');

+

         return [
             'url' => $toolKit->login($returnRoute, [], false, false, true),
         return [
             'url' => $toolKit->login($returnRoute, [], false, false, true),

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

         ];
     }
 
     /**
      * Initiate a logout flow.
         ];
     }
 
     /**
      * Initiate a logout flow.

+     *

      * @throws Error
      */
      * @throws Error
      */

-    public function logout(): array
+    public function logout(User $user): array

     {
         $toolKit = $this->getToolkit();
         $returnRoute = url('/');
 
         try {
     {
         $toolKit = $this->getToolkit();
         $returnRoute = url('/');
 
         try {

-            $url = $toolKit->logout($returnRoute, [], null, null, true);
+            $url = $toolKit->logout(
+                $returnRoute,
+                [],
+                $user->email,
+                null,
+                true,
+                Constants::NAMEID_EMAIL_ADDRESS
+            );

             $id = $toolKit->getLastRequestID();
         } catch (Error $error) {
             if ($error->getCode() !== Error::SAML_SINGLE_LOGOUT_NOT_SUPPORTED) {
             $id = $toolKit->getLastRequestID();
         } catch (Error $error) {
             if ($error->getCode() !== Error::SAML_SINGLE_LOGOUT_NOT_SUPPORTED) {


@@ -76,21 +92,25 @@ class Saml2Service extends ExternalAuthService
      * Process the ACS response from the idp and return the
      * matching, or new if registration active, user matched to the idp.
      * Returns null if not authenticated.
      * Process the ACS response from the idp and return the
      * matching, or new if registration active, user matched to the idp.
      * Returns null if not authenticated.

+     *

      * @throws Error
      * @throws SamlException
      * @throws ValidationError
      * @throws JsonDebugException
      * @throws UserRegistrationException
      */
      * @throws Error
      * @throws SamlException
      * @throws ValidationError
      * @throws JsonDebugException
      * @throws UserRegistrationException
      */

-    public function processAcsResponse(?string $requestId): ?User
+    public function processAcsResponse(?string $requestId, string $samlResponse): ?User

     {
     {

+        // The SAML2 toolkit expects the response to be within the $_POST superglobal
+        // so we need to manually put it back there at this point.
+        $_POST['SAMLResponse'] = $samlResponse;

         $toolkit = $this->getToolkit();
         $toolkit->processResponse($requestId);
         $errors = $toolkit->getErrors();
 
         if (!empty($errors)) {
             throw new Error(
         $toolkit = $this->getToolkit();
         $toolkit->processResponse($requestId);
         $errors = $toolkit->getErrors();
 
         if (!empty($errors)) {
             throw new Error(

-                'Invalid ACS Response: '.implode(', ', $errors)
+                'Invalid ACS Response: ' . implode(', ', $errors)

             );
         }
 
             );
         }
 


@@ -106,22 +126,29 @@ class Saml2Service extends ExternalAuthService
 
     /**
      * Process a response for the single logout service.
 
     /**
      * Process a response for the single logout service.

+     *

      * @throws Error
      */
     public function processSlsResponse(?string $requestId): ?string
     {
         $toolkit = $this->getToolkit();
      * @throws Error
      */
     public function processSlsResponse(?string $requestId): ?string
     {
         $toolkit = $this->getToolkit();

-        $redirect = $toolkit->processSLO(true, $requestId, false, null, true);

 
 

+        // The $retrieveParametersFromServer in the call below will mean the library will take the query
+        // parameters, used for the response signing, from the raw $_SERVER['QUERY_STRING']
+        // value so that the exact encoding format is matched when checking the signature.
+        // This is primarily due to ADFS encoding query params with lowercase percent encoding while
+        // PHP (And most other sensible providers) standardise on uppercase.
+        $redirect = $toolkit->processSLO(true, $requestId, true, null, true);

         $errors = $toolkit->getErrors();
 
         if (!empty($errors)) {
             throw new Error(
         $errors = $toolkit->getErrors();
 
         if (!empty($errors)) {
             throw new Error(

-                'Invalid SLS Response: '.implode(', ', $errors)
+                'Invalid SLS Response: ' . implode(', ', $errors)

             );
         }
 
         $this->actionLogout();
             );
         }
 
         $this->actionLogout();

+

         return $redirect;
     }
 
         return $redirect;
     }
 


@@ -136,6 +163,7 @@ class Saml2Service extends ExternalAuthService
 
     /**
      * Get the metadata for this service provider.
 
     /**
      * Get the metadata for this service provider.

+     *

      * @throws Error
      */
     public function metadata(): string
      * @throws Error
      */
     public function metadata(): string


@@ -147,7 +175,7 @@ class Saml2Service extends ExternalAuthService
 
         if (!empty($errors)) {
             throw new Error(
 
         if (!empty($errors)) {
             throw new Error(

-                'Invalid SP metadata: '.implode(', ', $errors),
+                'Invalid SP metadata: ' . implode(', ', $errors),

                 Error::METADATA_SP_INVALID
             );
         }
                 Error::METADATA_SP_INVALID
             );
         }


@@ -157,6 +185,7 @@ class Saml2Service extends ExternalAuthService
 
     /**
      * Load the underlying Onelogin SAML2 toolkit.
 
     /**
      * Load the underlying Onelogin SAML2 toolkit.

+     *

      * @throws Error
      * @throws Exception
      */
      * @throws Error
      * @throws Exception
      */


@@ -176,6 +205,7 @@ class Saml2Service extends ExternalAuthService
 
         $spSettings = $this->loadOneloginServiceProviderDetails();
         $settings = array_replace_recursive($settings, $spSettings, $metaDataSettings, $overrides);
 
         $spSettings = $this->loadOneloginServiceProviderDetails();
         $settings = array_replace_recursive($settings, $spSettings, $metaDataSettings, $overrides);

+

         return new Auth($settings);
     }
 
         return new Auth($settings);
     }
 


@@ -185,18 +215,18 @@ class Saml2Service extends ExternalAuthService
     protected function loadOneloginServiceProviderDetails(): array
     {
         $spDetails = [
     protected function loadOneloginServiceProviderDetails(): array
     {
         $spDetails = [

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

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

-                'url' => url('/saml2/sls')
+                'url' => url('/saml2/sls'),

             ],
         ];
 
         return [
             'baseurl' => url('/saml2'),
             ],
         ];
 
         return [
             'baseurl' => url('/saml2'),

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

         ];
     }
 
         ];
     }
 


@@ -209,7 +239,7 @@ class Saml2Service extends ExternalAuthService
     }
 
     /**
     }
 
     /**

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

      */
     protected function getUserDisplayName(array $samlAttributes, string $defaultValue): string
     {
      */
     protected function getUserDisplayName(array $samlAttributes, string $defaultValue): string
     {


@@ -248,6 +278,8 @@ class Saml2Service extends ExternalAuthService
 
     /**
      * 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
     {
      */
     protected function getUserDetails(string $samlID, $samlAttributes): array
     {


@@ -259,9 +291,9 @@ class Saml2Service extends ExternalAuthService
 
         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,

         ];
     }
 
         ];
     }
 


@@ -295,6 +327,7 @@ class Saml2Service extends ExternalAuthService
                 $data = $data[0];
                 break;
         }
                 $data = $data[0];
                 break;
         }

+

         return $data;
     }
 
         return $data;
     }
 


@@ -311,36 +344,14 @@ class Saml2Service extends ExternalAuthService
         return $defaultValue;
     }
 
         return $defaultValue;
     }
 

-    /**
-     * Get the user from the database for the specified details.
-     * @throws UserRegistrationException
-     */
-    protected function getOrRegisterUser(array $userDetails): ?User
-    {
-        $user = $this->user->newQuery()
-          ->where('external_auth_id', '=', $userDetails['external_id'])
-          ->first();
-
-        if (is_null($user)) {
-            $userData = [
-                'name' => $userDetails['name'],
-                'email' => $userDetails['email'],
-                'password' => Str::random(32),
-                'external_auth_id' => $userDetails['external_id'],
-            ];
-
-            $user = $this->registrationService->registerUser($userData, null, false);
-        }
-
-        return $user;
-    }
-

     /**
      * Process the SAML response for a user. Login the user when
      * they exist, optionally registering them automatically.
     /**
      * Process the SAML response for a user. Login the user when
      * they exist, optionally registering them automatically.

+     *

      * @throws SamlException
      * @throws JsonDebugException
      * @throws UserRegistrationException
      * @throws SamlException
      * @throws JsonDebugException
      * @throws UserRegistrationException

+     * @throws StoppedAuthenticationException

      */
     public function processLoginCallback(string $samlID, array $samlAttributes): User
     {
      */
     public function processLoginCallback(string $samlID, array $samlAttributes): User
     {


@@ -349,8 +360,8 @@ class Saml2Service extends ExternalAuthService
 
         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,
             ]);
         }


@@ -363,18 +374,23 @@ class Saml2Service extends ExternalAuthService
             throw new SamlException(trans('errors.saml_already_logged_in'), '/login');
         }
 
             throw new SamlException(trans('errors.saml_already_logged_in'), '/login');
         }
 

-        $user = $this->getOrRegisterUser($userDetails);
+        $user = $this->registrationService->findOrRegister(
+            $userDetails['name'],
+            $userDetails['email'],
+            $userDetails['external_id']
+        );
+

         if ($user === null) {
             throw new SamlException(trans('errors.saml_user_not_registered', ['name' => $userDetails['external_id']]), '/login');
         }
 
         if ($this->shouldSyncGroups()) {
             $groups = $this->getUserGroups($samlAttributes);
         if ($user === null) {
             throw new SamlException(trans('errors.saml_user_not_registered', ['name' => $userDetails['external_id']]), '/login');
         }
 
         if ($this->shouldSyncGroups()) {
             $groups = $this->getUserGroups($samlAttributes);

-            $this->syncWithGroups($user, $groups);
+            $this->groupSyncService->syncUserWithFoundGroups($user, $groups, $this->config['remove_from_groups']);

         }
 
         }
 

-        auth()->login($user);
-        Activity::add(ActivityType::AUTH_LOGIN, "saml2; {$user->logDescriptor()}");
+        $this->loginService->login($user, 'saml2');
+

         return $user;
     }
 }
         return $user;
     }
 }