Guest create page: name field autofocus

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

diff --git a/app/Auth/Access/Saml2Service.php b/app/Auth/Access/Saml2Service.php
index b1489fbced83264b46c23151e4f7d974aca65884..a95e3b1d2e8d410f510680b0911bc7307ebd2269 100644 (file)
--- a/app/Auth/Access/Saml2Service.php
+++ b/app/Auth/Access/Saml2Service.php
@@ -9,6 +9,7 @@ use BookStack\Exceptions\StoppedAuthenticationException;
 use BookStack\Exceptions\UserRegistrationException;
 use Exception;
 use OneLogin\Saml2\Auth;
 use BookStack\Exceptions\UserRegistrationException;
 use Exception;
 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,22 +18,22 @@ 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 $loginService;
-
-    /**
-     * Saml2Service constructor.
-     */
-    public function __construct(RegistrationService $registrationService, LoginService $loginService, User $user)
-    {
-        parent::__construct($registrationService, $user);
-        
+    protected array $config;
+    protected RegistrationService $registrationService;
+    protected LoginService $loginService;
+    protected GroupSyncService $groupSyncService;
+
+    public function __construct(
+        RegistrationService $registrationService,
+        LoginService $loginService,
+        GroupSyncService $groupSyncService
+    ) {

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

+        $this->groupSyncService = $groupSyncService;

     }
 
     /**
     }
 
     /**


@@ -56,13 +57,20 @@ class Saml2Service extends ExternalAuthService
      *
      * @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) {


@@ -88,16 +96,20 @@ class Saml2Service extends ExternalAuthService
      * @throws JsonDebugException
      * @throws UserRegistrationException
      */
      * @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)) {
         $toolkit = $this->getToolkit();
         $toolkit->processResponse($requestId);
         $errors = $toolkit->getErrors();
 
         if (!empty($errors)) {

-            throw new Error(
-                'Invalid ACS Response: ' . implode(', ', $errors)
-            );
+            $reason = $toolkit->getLastErrorReason();
+            $message = 'Invalid ACS Response; Errors: ' . implode(', ', $errors);
+            $message .= $reason ? "; Reason: {$reason}" : '';
+            throw new Error($message);

         }
 
         if (!$toolkit->isAuthenticated()) {
         }
 
         if (!$toolkit->isAuthenticated()) {


@@ -118,8 +130,13 @@ class Saml2Service extends ExternalAuthService
     public function processSlsResponse(?string $requestId): ?string
     {
         $toolkit = $this->getToolkit();
     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)) {
         $errors = $toolkit->getErrors();
 
         if (!empty($errors)) {


@@ -149,7 +166,7 @@ class Saml2Service extends ExternalAuthService
      */
     public function metadata(): string
     {
      */
     public function metadata(): string
     {

-        $toolKit = $this->getToolkit();
+        $toolKit = $this->getToolkit(true);

         $settings = $toolKit->getSettings();
         $metadata = $settings->getSPMetadata();
         $errors = $settings->validateMetadata($metadata);
         $settings = $toolKit->getSettings();
         $metadata = $settings->getSPMetadata();
         $errors = $settings->validateMetadata($metadata);


@@ -170,7 +187,7 @@ class Saml2Service extends ExternalAuthService
      * @throws Error
      * @throws Exception
      */
      * @throws Error
      * @throws Exception
      */

-    protected function getToolkit(): Auth
+    protected function getToolkit(bool $spOnly = false): Auth

     {
         $settings = $this->config['onelogin'];
         $overrides = $this->config['onelogin_overrides'] ?? [];
     {
         $settings = $this->config['onelogin'];
         $overrides = $this->config['onelogin_overrides'] ?? [];


@@ -180,14 +197,14 @@ class Saml2Service extends ExternalAuthService
         }
 
         $metaDataSettings = [];
         }
 
         $metaDataSettings = [];

-        if ($this->config['autoload_from_metadata']) {
+        if (!$spOnly && $this->config['autoload_from_metadata']) {

             $metaDataSettings = IdPMetadataParser::parseRemoteXML($settings['idp']['entityId']);
         }
 
         $spSettings = $this->loadOneloginServiceProviderDetails();
         $settings = array_replace_recursive($settings, $spSettings, $metaDataSettings, $overrides);
 
             $metaDataSettings = IdPMetadataParser::parseRemoteXML($settings['idp']['entityId']);
         }
 
         $spSettings = $this->loadOneloginServiceProviderDetails();
         $settings = array_replace_recursive($settings, $spSettings, $metaDataSettings, $overrides);
 

-        return new Auth($settings);
+        return new Auth($settings, $spOnly);

     }
 
     /**
     }
 
     /**


@@ -259,6 +276,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
     {


@@ -353,14 +372,19 @@ 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']);

         }
 
         $this->loginService->login($user, 'saml2');
         }
 
         $this->loginService->login($user, 'saml2');