Inheritance diagram for ilSamlSettingsGUI:

Collaboration diagram for ilSamlSettingsGUI:

Public Member Functions
	__construct (private readonly int $ref_id)

	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...

	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

	getRefId ()

	executeCommand ()

Data Fields
const string	DEFAULT_CMD = 'listIdps'

Private Member Functions
	ensureAccess (string $operation)

	ensureWriteAccess ()

	ensureReadAccess ()

	getIdpIdOrZero ()

	initIdp ()

	listIdps ()

	handleTableActions ()

	deactivateIdp ()

	activateIdp ()

	setSubTabs (int $a_view_mode)

	initUserAttributeMapping ()

	getUserAttributeMappingForm ()

	addAttributeRuleFieldToForm (ilPropertyFormGUI $form, string $field_label, string $field_name)

	saveUserAttributeMapping ()

	showUserAttributeMappingForm (?ilPropertyFormGUI $form=null)

	getSettingsForm (array $values=[])

	prepareRoleSelection ()

	saveSettings ()

	showSettings (?StandardForm $form=null)

	showIdpSettings (?StandardForm $form=null)

	saveIdpSettings ()

	getIdpForm ()

	saveNewIdp ()

	showNewIdpForm (?StandardForm $form=null)

	populateWithMetadata (ilSamlIdp $idp, array &$data)

	storeMetadata (ilSamlIdp $idp, string $metadata)

	confirmDeleteIdp ()

	deleteIdp ()

Private Attributes
const int	VIEW_MODE_GLOBAL = 1

const int	VIEW_MODE_SINGLE = 2

const string	PERMISSION_WRITE = 'write'

const string	REQUEST_PARAM_SAML_IDP_ID = 'saml_idp_id'

const string	REQUEST_PARAM_SAML_IDP_IDS = 'saml_idp_ids'

const string	MESSAGE_TYPE_FAILURE = 'failure'

const string	MESSAGE_TYPE_SUCCESS = 'success'

const string	LNG_SAVED_SUCCESSFULLY = 'saved_successfully'

const string	LNG_AUTH_SAML_USER_MAPPING = 'auth_saml_user_mapping'

const string	LNG_LOGIN_FORM = 'login_form'

const string	LNG_CANCEL = 'cancel'

const string	CMD_SHOW_SETTINGS = 'showSettings'

const string	CMD_SAVE_NEW_IDP = 'saveNewIdp'

const string	CMD_SAVE_SETTINGS = 'saveSettings'

const string	CMD_SHOW_IDP_SETTINGS = 'showIdpSettings'

const string	CMT_SAVE_IDP_SETTINGS = 'saveIdpSettings'

const string	CMD_SAVE = 'save'

const string	CMD_SAVE_USER_ATTRIBUTE_MAPPING = 'saveUserAttributeMapping'

const string	PROP_UPDATE_SUFFIX = '_update'

const string	METADATA_STORAGE_KEY = 'metadata'

const array	GLOBAL_COMMANDS

const array	GLOBAL_ENTITY_COMMANDS

const array	IGNORED_USER_FIELDS

readonly ilCtrlInterface	$ctrl

readonly ilLanguage	$lng

readonly ilGlobalTemplateInterface	$tpl

readonly RBACServices	$rbac

readonly ilErrorHandling	$error_handler

readonly ilTabsGUI	$tabs

readonly ilToolbarGUI	$toolbar

readonly GlobalHttpState	$http_state

readonly Refinery	$refinery

readonly ilHelpGUI	$help

ilExternalAuthUserAttributeMapping	$mapping = null

ilSamlIdp	$idp = null

ilSamlAuth	$saml_auth = null

readonly ILIAS UI Factory	$ui_factory

readonly ILIAS UI Renderer	$ui_renderer

Detailed Description

Definition at line 28 of file class.ilSamlSettingsGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilSamlSettingsGUI::__construct ( private readonly int $ref_id )

Definition at line 114 of file class.ilSamlSettingsGUI.php.

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ILIAS\Repository\rbac(), ILIAS\Repository\refinery(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

     {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->tpl = $DIC->ui()->mainTemplate();
         $this->lng = $DIC->language();
         $this->rbac = $DIC->rbac();
         $this->error_handler = $DIC['ilErr'];
         $this->tabs = $DIC->tabs();
         $this->toolbar = $DIC['ilToolbar'];
         $this->help = $DIC['ilHelp'];
         $this->http_state = $DIC->http();
         $this->refinery = $DIC->refinery();
         $this->ui_factory = $DIC->ui()->factory();
         $this->ui_renderer = $DIC->ui()->renderer();
 
         $this->lng->loadLanguageModule('auth');
     }

Here is the call graph for this function:

Member Function Documentation

◆ activateIdp()

ilSamlSettingsGUI::activateIdp ( )

private

Definition at line 341 of file class.ilSamlSettingsGUI.php.

References ILIAS\Repository\ctrl(), ensureWriteAccess(), and ILIAS\Repository\lng().

Referenced by handleTableActions().

                                   : void
     {
         $this->ensureWriteAccess();
 
         $this->idp->setActive(true);
         $this->idp->persist();
 
         $this->tpl->setOnScreenMessage(self::MESSAGE_TYPE_SUCCESS, $this->lng->txt(self::LNG_SAVED_SUCCESSFULLY), true);
         $this->ctrl->redirect($this, self::DEFAULT_CMD);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addAttributeRuleFieldToForm()

ilSamlSettingsGUI::addAttributeRuleFieldToForm	(	ilPropertyFormGUI	$form,
		string	$field_label,
		string	$field_name
	)

private

Definition at line 433 of file class.ilSamlSettingsGUI.php.

References ilPropertyFormGUI\addItem(), and ILIAS\Repository\lng().

Referenced by getUserAttributeMappingForm().

      : void {
         $field = new ilTextInputGUI($field_label, $field_name);
         $form->addItem($field);
 
         $update_automatically = new ilCheckboxInputGUI('', $field_name . self::PROP_UPDATE_SUFFIX);
         $update_automatically->setOptionTitle($this->lng->txt('auth_saml_update_field_info'));
         $update_automatically->setValue('1');
         $form->addItem($update_automatically);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmDeleteIdp()

ilSamlSettingsGUI::confirmDeleteIdp ( )

private

Definition at line 768 of file class.ilSamlSettingsGUI.php.

References ILIAS\Repository\ctrl(), ensureWriteAccess(), and ILIAS\Repository\lng().

Referenced by handleTableActions().

                                        : void
     {
         $this->ensureWriteAccess();
 
         $confirmation = new ilConfirmationGUI();
         $confirmation->setFormAction($this->ctrl->getFormAction($this, 'deleteIdp'));
         $confirmation->setConfirm($this->lng->txt('confirm'), 'deleteIdp');
         $confirmation->setCancel($this->lng->txt(self::LNG_CANCEL), self::DEFAULT_CMD);
         $confirmation->setHeaderText($this->lng->txt('auth_saml_sure_delete_idp'));
         $confirmation->addItem(
             self::REQUEST_PARAM_SAML_IDP_IDS,
             (string) $this->idp->getIdpId(),
             $this->idp->getEntityId()
         );
 
         $this->tpl->setContent($confirmation->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deactivateIdp()

ilSamlSettingsGUI::deactivateIdp ( )

private

Definition at line 330 of file class.ilSamlSettingsGUI.php.

References ILIAS\Repository\ctrl(), ensureWriteAccess(), and ILIAS\Repository\lng().

Referenced by handleTableActions().

                                     : void
     {
         $this->ensureWriteAccess();
 
         $this->idp->setActive(false);
         $this->idp->persist();
 
         $this->tpl->setOnScreenMessage(self::MESSAGE_TYPE_SUCCESS, $this->lng->txt(self::LNG_SAVED_SUCCESSFULLY), true);
         $this->ctrl->redirect($this, self::DEFAULT_CMD);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteIdp()

ilSamlSettingsGUI::deleteIdp ( )

private

Definition at line 786 of file class.ilSamlSettingsGUI.php.

References ILIAS\Repository\ctrl(), ensureWriteAccess(), ILIAS\Repository\lng(), and null.

                                 : void
     {
         $this->ensureWriteAccess();
 
         $idp_disco = $this->saml_auth->getIdpDiscovery();
         $idp_disco->deleteIdpMetadata($this->idp->getIdpId());
 
         $this->idp->delete();
 
         $this->tpl->setOnScreenMessage(self::MESSAGE_TYPE_SUCCESS, $this->lng->txt('auth_saml_deleted_idp'), true);
 
         $this->ctrl->setParameter($this, self::REQUEST_PARAM_SAML_IDP_ID, null);
         $this->ctrl->redirect($this, self::DEFAULT_CMD);
     }

Here is the call graph for this function:

◆ ensureAccess()

ilSamlSettingsGUI::ensureAccess ( string $operation )

private

Definition at line 134 of file class.ilSamlSettingsGUI.php.

References ILIAS\Repository\lng(), and ILIAS\Repository\rbac().

Referenced by ensureReadAccess(), and ensureWriteAccess().

                                                     : void
     {
         if (!$this->rbac->system()->checkAccess($operation, $this->ref_id)) {
             $this->error_handler->raiseError($this->lng->txt('msg_no_perm_read'), $this->error_handler->WARNING);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ensureReadAccess()

ilSamlSettingsGUI::ensureReadAccess ( )

private

Definition at line 158 of file class.ilSamlSettingsGUI.php.

References ensureAccess().

Referenced by executeCommand().

                                        : void
     {
         $this->ensureAccess('read');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ensureWriteAccess()

ilSamlSettingsGUI::ensureWriteAccess ( )

private

Definition at line 153 of file class.ilSamlSettingsGUI.php.

References ensureAccess().

Referenced by activateIdp(), confirmDeleteIdp(), deactivateIdp(), deleteIdp(), saveIdpSettings(), saveNewIdp(), saveSettings(), saveUserAttributeMapping(), and showNewIdpForm().

                                         : void
     {
         $this->ensureAccess(self::PERMISSION_WRITE);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilSamlSettingsGUI::executeCommand ( )

Definition at line 219 of file class.ilSamlSettingsGUI.php.

References Vendor\Package\$e, ILIAS\Repository\ctrl(), ensureReadAccess(), getIdpIdOrZero(), ILIAS\Repository\help(), initIdp(), initUserAttributeMapping(), ILIAS\Repository\lng(), null, and setSubTabs().

                                     : void
     {
         $this->ensureReadAccess();
 
         try {
             $factory = new ilSamlAuthFactory();
             $this->saml_auth = $factory->auth();
         } catch (Throwable $e) {
             if ($e->getMessage() === 'Database error: could not find driver') {
                 $this->tpl->setOnScreenMessage(
                     self::MESSAGE_TYPE_FAILURE,
                     $this->lng->txt('auth_saml_err_sqlite_driver')
                 );
             } else {
                 $this->tpl->setOnScreenMessage(self::MESSAGE_TYPE_FAILURE, $e->getMessage());
             }
         }
 
         $this->help->setScreenIdComponent('auth');
         $cmd = $this->ctrl->getCmd();
         if ($cmd === null || $cmd === '' || !method_exists($this, $cmd)) {
             $cmd = self::DEFAULT_CMD;
         }
 
         $idp_id = $this->getIdpIdOrZero();
 
         if ($idp_id > 0) {
             $this->ctrl->setParameter($this, self::REQUEST_PARAM_SAML_IDP_ID, $idp_id);
         }
 
         if (!in_array(strtolower($cmd), array_map('strtolower', self::GLOBAL_COMMANDS), true)) {
             if ($idp_id === 0) {
                 $this->ctrl->redirect($this, self::DEFAULT_CMD);
             }
 
             $this->initIdp();
             $this->initUserAttributeMapping();
         }
 
         if (in_array(strtolower($cmd), array_map('strtolower', self::GLOBAL_COMMANDS), true) ||
             in_array(strtolower($cmd), array_map('strtolower', self::GLOBAL_ENTITY_COMMANDS), true)) {
             $this->setSubTabs(self::VIEW_MODE_GLOBAL);
         } else {
             $this->setSubTabs(self::VIEW_MODE_SINGLE);
         }
 
         $this->$cmd();
     }

Here is the call graph for this function:

◆ getIdpForm()

ilSamlSettingsGUI::getIdpForm ( )

private

Definition at line 694 of file class.ilSamlSettingsGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by saveNewIdp(), and showNewIdpForm().

                                  : StandardForm
     {
         return $this->ui_factory->input()->container()->form()->standard(
             $this->ctrl->getFormAction($this, self::CMD_SAVE_NEW_IDP),
             [
                 self::METADATA_STORAGE_KEY => $this->ui_factory
                     ->input()
                     ->field()
                     ->textarea(
                         $this->lng->txt('auth_saml_add_idp_md_label'),
                         $this->lng->txt('auth_saml_add_idp_md_info')
                     )
                     ->withValue($values[self::METADATA_STORAGE_KEY] ?? '')
                     ->withRequired(true)
                     ->withDedicatedName(self::METADATA_STORAGE_KEY),
             ]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIdpIdOrZero()

ilSamlSettingsGUI::getIdpIdOrZero ( )

private

Definition at line 168 of file class.ilSamlSettingsGUI.php.

References ILIAS\Repository\refinery().

Referenced by executeCommand(), and initIdp().

                                      : int
     {
         $idpId = 0;
         if ($this->http_state->wrapper()->query()->has(self::REQUEST_PARAM_SAML_IDP_ID)) {
             $idpId = $this->http_state->wrapper()->query()->retrieve(
                 self::REQUEST_PARAM_SAML_IDP_ID,
                 $this->refinery->kindlyTo()->int()
             );
         } elseif ($this->http_state->wrapper()->post()->has(self::REQUEST_PARAM_SAML_IDP_ID)) {
             $idpId = $this->http_state->wrapper()->post()->retrieve(
                 self::REQUEST_PARAM_SAML_IDP_ID,
                 $this->refinery->kindlyTo()->int()
             );
         }
 
         if ($this->http_state->wrapper()->query()->has('saml_idps_table_action')) {
             if ($this->http_state->wrapper()->query()->has('saml_idps_idp_id')) {
                 $idpIds = $this->http_state->wrapper()->query()->retrieve(
                     'saml_idps_idp_id',
                     $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
                 );
                 if (count($idpIds) === 1) {
                     $idpId = current($idpIds);
                 }
             }
         }
 
         if ($this->http_state->wrapper()->post()->has(self::REQUEST_PARAM_SAML_IDP_IDS)) {
             $idpIds = $this->http_state->wrapper()->post()->retrieve(
                 self::REQUEST_PARAM_SAML_IDP_IDS,
                 $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
             );
             if (count($idpIds) === 1) {
                 $idpId = current($idpIds);
             }
         }
 
         return $idpId;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRefId()

ilSamlSettingsGUI::getRefId ( )

Definition at line 163 of file class.ilSamlSettingsGUI.php.

References $ref_id.

                               : int
     {
         return $this->ref_id;
     }

◆ getSafePostCommands()

ilSamlSettingsGUI::getSafePostCommands ( )

This method must return a list of safe POST commands.

Safe post commands returned by this method will no longer be CSRF protected and will NOT be appended by an ilCtrlToken.

Returns: string[]

Implements ilCtrlSecurityInterface.

Definition at line 148 of file class.ilSamlSettingsGUI.php.

                                          : array
     {
         return [];
     }

◆ getSettingsForm()

ilSamlSettingsGUI::getSettingsForm ( array $values = [] )

private

Parameters

array<string,mixed> $values

Definition at line 506 of file class.ilSamlSettingsGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\rbac(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by saveSettings(), and showSettings().

                                                         : StandardForm
     {
         $access = $this->rbac->system()->checkAccess(self::PERMISSION_WRITE, $this->ref_id);
         $form = $this->ui_factory->input()->container()->form()->standard(
             $this->ctrl->getFormAction($this, $access ? self::CMD_SAVE_SETTINGS : self::CMD_SHOW_SETTINGS),
             [
                 self::LNG_LOGIN_FORM => $this->ui_factory->input()->field()->checkbox(
                     $this->lng->txt('auth_saml_login_form'),
                     $this->lng->txt('auth_saml_login_form_info')
                 )
                                                          ->withValue((bool) ($values[self::LNG_LOGIN_FORM] ?? true))
                                                          ->withDisabled(!$access),
             ]
         );
 
         if (!$access) {
             $form = $form->withSubmitLabel($this->lng->txt('refresh'));
         }
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUnsafeGetCommands()

ilSamlSettingsGUI::getUnsafeGetCommands ( )

This method must return a list of unsafe GET commands.

Unsafe get commands returned by this method will now be CSRF protected, which means an ilCtrlToken is appended each time a link-target is generated to the class implementing this interface with a command from that list.

Tokens will be validated in

See also: ilCtrlInterface::getCmd(), whereas the fallback command will be used if the CSRF validation fails.

Returns: string[]

Implements ilCtrlSecurityInterface.

Definition at line 141 of file class.ilSamlSettingsGUI.php.

                                           : array
     {
         return [
             'handleTableActions'
         ];
     }

◆ getUserAttributeMappingForm()

ilSamlSettingsGUI::getUserAttributeMappingForm ( )

private

Definition at line 403 of file class.ilSamlSettingsGUI.php.

References $id, ilUserDefinedFields\_getInstance(), addAttributeRuleFieldToForm(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\rbac().

Referenced by saveUserAttributeMapping(), and showUserAttributeMappingForm().

                                                   : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this, self::CMD_SAVE_USER_ATTRIBUTE_MAPPING));
         $form->setTitle($this->lng->txt(self::LNG_AUTH_SAML_USER_MAPPING));
 
         $usr_profile = new ilUserProfile();
         foreach (array_keys($usr_profile->getStandardFields()) as $id) {
             if (in_array($id, self::IGNORED_USER_FIELDS, true)) {
                 continue;
             }
 
             $this->addAttributeRuleFieldToForm($form, $this->lng->txt($id), $id);
         }
 
         foreach (ilUserDefinedFields::_getInstance()->getDefinitions() as $definition) {
             $this->addAttributeRuleFieldToForm($form, $definition['field_name'], 'udf_' . $definition['field_id']);
         }
 
         if ($this->rbac->system()->checkAccess(self::PERMISSION_WRITE, $this->ref_id)) {
             $form->addCommandButton(self::CMD_SAVE_USER_ATTRIBUTE_MAPPING, $this->lng->txt(self::CMD_SAVE));
         } else {
             foreach ($form->getItems() as $item) {
                 $item->setDisabled(true);
             }
         }
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleTableActions()

ilSamlSettingsGUI::handleTableActions ( )

private

Definition at line 312 of file class.ilSamlSettingsGUI.php.

References activateIdp(), confirmDeleteIdp(), ILIAS\Repository\ctrl(), deactivateIdp(), ILIAS\Repository\refinery(), and showIdpSettings().

                                          : void
     {
         $action = $this->http_state->wrapper()->query()->retrieve(
             'saml_idps_table_action',
             $this->refinery->byTrying([
                 $this->refinery->kindlyTo()->string(),
                 $this->refinery->always('')
             ])
         );
         match ($action) {
             'showIdpSettings' => $this->showIdpSettings(),
             'activateIdp' => $this->activateIdp(),
             'deactivateIdp' => $this->deactivateIdp(),
             'confirmDeleteIdp' => $this->confirmDeleteIdp(),
             default => $this->ctrl->redirect($this, self::DEFAULT_CMD),
         };
     }

Here is the call graph for this function:

◆ initIdp()

ilSamlSettingsGUI::initIdp ( )

private

Definition at line 208 of file class.ilSamlSettingsGUI.php.

References ILIAS\Repository\ctrl(), getIdpIdOrZero(), ilSamlIdp\getInstanceByIdpId(), ILIAS\Repository\lng(), and null.

Referenced by executeCommand().

                               : void
     {
         try {
             $this->idp = ilSamlIdp::getInstanceByIdpId($this->getIdpIdOrZero());
         } catch (Exception) {
             $this->tpl->setOnScreenMessage(self::MESSAGE_TYPE_FAILURE, $this->lng->txt('auth_saml_unknow_idp'), true);
             $this->ctrl->setParameter($this, self::REQUEST_PARAM_SAML_IDP_ID, null);
             $this->ctrl->redirect($this, self::DEFAULT_CMD);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initUserAttributeMapping()

ilSamlSettingsGUI::initUserAttributeMapping ( )

private

Definition at line 398 of file class.ilSamlSettingsGUI.php.

Referenced by executeCommand().

                                                : void
     {
         $this->mapping = new ilExternalAuthUserAttributeMapping('saml', $this->idp->getIdpId());
     }

Here is the caller graph for this function:

◆ listIdps()

ilSamlSettingsGUI::listIdps ( )

private

Definition at line 268 of file class.ilSamlSettingsGUI.php.

References $info, CLIENT_ID, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\rbac(), and ILIAS\Repository\toolbar().

                                : void
     {
         if ($this->saml_auth && $this->rbac->system()->checkAccess(self::PERMISSION_WRITE, $this->ref_id)) {
             $this->toolbar->addStickyItem(
                 $this->ui_factory->button()->standard(
                     $this->lng->txt('auth_saml_add_idp_btn'),
                     $this->ctrl->getLinkTarget($this, 'showNewIdpForm')
                 )
             );
         }
 
         $federation_md_url = rtrim(
             ILIAS_HTTP_PATH,
             '/'
         ) . '/metadata.php?client_id=' . CLIENT_ID;
         $info = $this->ui_factory->messageBox()->info(
             sprintf(
                 $this->lng->txt('auth_saml_idps_info'),
                 'auth/saml/config/config.php',
                 'auth/saml/config/authsources.php',
                 $this->ui_renderer->render(
                     $this->ui_factory->link()->standard(
                         'https://simplesamlphp.org/docs/stable/simplesamlphp-sp',
                         'https://simplesamlphp.org/docs/stable/simplesamlphp-sp'
                     )
                 ),
                 $this->ui_renderer->render($this->ui_factory->link()->standard($federation_md_url, $federation_md_url))
             )
         );
 
         $table = new ilSamlIdpTableGUI(
             $this,
             $this->ui_factory,
             $this->ui_renderer,
             $this->lng,
             $this->ctrl,
             $this->http_state->request(),
             new Factory(),
             'handleTableActions',
             $this->rbac->system()->checkAccess(self::PERMISSION_WRITE, $this->ref_id)
         );
         $this->tpl->setContent($this->ui_renderer->render([$info, $table->get()]));
     }

Here is the call graph for this function:

◆ populateWithMetadata()

ilSamlSettingsGUI::populateWithMetadata	(	ilSamlIdp	$idp,
		array &	$data
	)

private

Definition at line 755 of file class.ilSamlSettingsGUI.php.

References ilSamlIdp\getIdpId().

Referenced by showIdpSettings().

                                                                        : void
     {
         $idp_disco = $this->saml_auth->getIdpDiscovery();
 
         $data[self::METADATA_STORAGE_KEY] = $idp_disco->fetchIdpMetadata($idp->getIdpId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareRoleSelection()

ilSamlSettingsGUI::prepareRoleSelection ( )

private

Returns: array<int, string>

Definition at line 531 of file class.ilSamlSettingsGUI.php.

References ilObject\_lookupTitle(), ilUtil\_sortIds(), ILIAS\Repository\lng(), and ILIAS\Repository\rbac().

Referenced by showSettings().

                                            : array
     {
         $select = [];
         $global_roles = array_map(
             intval(...),
             ilUtil::_sortIds(
                 $this->rbac->review()->getGlobalRoles(),
                 'object_data',
                 'title',
                 'obj_id'
             )
         );
 
         $select[0] = $this->lng->txt('links_select_one');
         foreach ($global_roles as $role_id) {
             $select[$role_id] = ilObject::_lookupTitle($role_id);
         }
 
         return $select;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveIdpSettings()

ilSamlSettingsGUI::saveIdpSettings ( )

private

Definition at line 672 of file class.ilSamlSettingsGUI.php.

References ILIAS\Repository\ctrl(), ensureWriteAccess(), ILIAS\Repository\lng(), showIdpSettings(), and storeMetadata().

                                       : void
     {
         $this->ensureWriteAccess();
 
         $form = $this->getIdpSettingsForm()->withRequest($this->http_state->request());
 
         if (!$form->getError()) {
             $this->idp->bindForm($form);
             $this->idp->persist();
 
             $this->storeMetadata($this->idp, $form->getData()[self::METADATA_STORAGE_KEY] ?? '');
             $this->tpl->setOnScreenMessage(
                 self::MESSAGE_TYPE_SUCCESS,
                 $this->lng->txt(self::LNG_SAVED_SUCCESSFULLY),
                 true
             );
         }
 
         $this->ctrl->redirect($this, self::CMD_SHOW_IDP_SETTINGS);
         $this->showIdpSettings($form);
     }

Here is the call graph for this function:

◆ saveNewIdp()

ilSamlSettingsGUI::saveNewIdp ( )

private

Definition at line 713 of file class.ilSamlSettingsGUI.php.

References ilSamlIdp\bindForm(), ILIAS\Repository\ctrl(), ensureWriteAccess(), getIdpForm(), ilSamlIdp\getIdpId(), ILIAS\Repository\lng(), ilSamlIdp\persist(), showNewIdpForm(), and storeMetadata().

                                  : void
     {
         $this->ensureWriteAccess();
 
         $form = $this->getIdpForm();
         if (!$form->getError()) {
             $idp = new ilSamlIdp();
             $idp->bindForm($form);
             $idp->persist();
             $this->storeMetadata($this->idp, $form->getData()[self::METADATA_STORAGE_KEY] ?? '');
 
             $this->tpl->setOnScreenMessage(
                 self::MESSAGE_TYPE_SUCCESS,
                 $this->lng->txt(self::LNG_SAVED_SUCCESSFULLY),
                 true
             );
             $this->ctrl->setParameter($this, self::REQUEST_PARAM_SAML_IDP_ID, $idp->getIdpId());
             $this->ctrl->redirect($this, self::CMD_SHOW_IDP_SETTINGS);
         }
 
         $this->showNewIdpForm($form);
     }

Here is the call graph for this function:

◆ saveSettings()

ilSamlSettingsGUI::saveSettings ( )

private

Definition at line 552 of file class.ilSamlSettingsGUI.php.

References $data, ensureWriteAccess(), ilSamlSettings\getInstance(), getSettingsForm(), ILIAS\Repository\lng(), and showSettings().

                                    : void
     {
         $this->ensureWriteAccess();
 
         $form = $this->getSettingsForm()->withRequest($this->http_state->request());
         if (!$form->getError()) {
             $data = $form->getData();
             ilSamlSettings::getInstance()->setLoginFormStatus($data[self::LNG_LOGIN_FORM]);
             $this->tpl->setOnScreenMessage(self::MESSAGE_TYPE_SUCCESS, $this->lng->txt(self::LNG_SAVED_SUCCESSFULLY));
         }
 
         $this->showSettings($form);
     }

Here is the call graph for this function:

◆ saveUserAttributeMapping()

ilSamlSettingsGUI::saveUserAttributeMapping ( )

private

Definition at line 447 of file class.ilSamlSettingsGUI.php.

References $id, ilUserDefinedFields\_getInstance(), ensureWriteAccess(), getUserAttributeMappingForm(), ILIAS\Repository\lng(), and showUserAttributeMappingForm().

                                                : void
     {
         $this->ensureWriteAccess();
 
         $form = $this->getUserAttributeMappingForm();
         if ($form->checkInput()) {
             $this->mapping->delete();
 
             $usr_profile = new ilUserProfile();
             foreach (array_keys($usr_profile->getStandardFields()) as $id) {
                 if (in_array($id, self::IGNORED_USER_FIELDS, true)) {
                     continue;
                 }
 
                 $rule = $this->mapping->getEmptyRule();
                 $rule->setAttribute($id);
                 $rule->setExternalAttribute((string) $form->getInput($rule->getAttribute()));
                 $rule->updateAutomatically((bool) $form->getInput($rule->getAttribute() . self::PROP_UPDATE_SUFFIX));
                 $this->mapping[$rule->getAttribute()] = $rule;
             }
 
             foreach (ilUserDefinedFields::_getInstance()->getDefinitions() as $definition) {
                 $rule = $this->mapping->getEmptyRule();
                 $rule->setAttribute('udf_' . $definition['field_id']);
                 $rule->setExternalAttribute((string) $form->getInput($rule->getAttribute()));
                 $rule->updateAutomatically((bool) $form->getInput($rule->getAttribute() . self::PROP_UPDATE_SUFFIX));
                 $this->mapping[$rule->getAttribute()] = $rule;
             }
 
             $this->mapping->save();
 
             $this->tpl->setOnScreenMessage(self::MESSAGE_TYPE_SUCCESS, $this->lng->txt(self::LNG_SAVED_SUCCESSFULLY));
         }
 
         $form->setValuesByPost();
 
         $this->showUserAttributeMappingForm($form);
     }

Here is the call graph for this function:

◆ setSubTabs()

ilSamlSettingsGUI::setSubTabs ( int $a_view_mode )

private

Definition at line 352 of file class.ilSamlSettingsGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Referenced by executeCommand().

                                                  : void
     {
         switch ($a_view_mode) {
             case self::VIEW_MODE_GLOBAL:
                 $this->tabs->addSubTabTarget(
                     'auth_saml_idps',
                     $this->ctrl->getLinkTarget($this, self::DEFAULT_CMD),
                     array_merge(
                         self::GLOBAL_ENTITY_COMMANDS,
                         [self::DEFAULT_CMD, 'showNewIdpForm', self::CMD_SAVE_NEW_IDP]
                     ),
                     self::class
                 );
 
                 $this->tabs->addSubTabTarget(
                     'settings',
                     $this->ctrl->getLinkTarget($this, self::CMD_SHOW_SETTINGS),
                     [self::CMD_SHOW_SETTINGS, self::CMD_SAVE_SETTINGS],
                     self::class
                 );
                 break;
 
             case self::VIEW_MODE_SINGLE:
                 $this->tabs->clearTargets();
                 $this->tabs->setBackTarget(
                     $this->lng->txt('back'),
                     $this->ctrl->getLinkTarget($this, self::DEFAULT_CMD)
                 );
 
                 $this->tabs->addSubTabTarget(
                     'auth_saml_idp_settings',
                     $this->ctrl->getLinkTarget($this, self::CMD_SHOW_IDP_SETTINGS),
                     [self::CMD_SHOW_IDP_SETTINGS, self::CMT_SAVE_IDP_SETTINGS],
                     self::class
                 );
 
                 $this->tabs->addSubTabTarget(
                     self::LNG_AUTH_SAML_USER_MAPPING,
                     $this->ctrl->getLinkTarget($this, 'showUserAttributeMappingForm'),
                     ['showUserAttributeMappingForm', self::CMD_SAVE_USER_ATTRIBUTE_MAPPING],
                     self::class
                 );
                 break;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showIdpSettings()

ilSamlSettingsGUI::showIdpSettings ( ?StandardForm $form = null )

private

Definition at line 650 of file class.ilSamlSettingsGUI.php.

References $data, ILIAS\Repository\help(), ILIAS\Repository\lng(), populateWithMetadata(), and ILIAS\Repository\tabs().

Referenced by handleTableActions(), and saveIdpSettings().

                                                                 : void
     {
         $this->tabs->setSubTabActive('auth_saml_idp_settings');
 
         if (!$form) {
             $data = $this->idp->toArray();
             $this->populateWithMetadata($this->idp, $data);
             $form = $this->getIdpSettingsForm($data);
         }
 
         $this->help->setSubScreenId('edit_idp');
 
         $title = $this->ui_factory->item()->standard(
             sprintf($this->lng->txt('auth_saml_configure_idp'), $this->idp->getEntityId())
         );
 
         $this->tpl->setContent($this->ui_renderer->render([
             $title,
             $form
         ]));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showNewIdpForm()

ilSamlSettingsGUI::showNewIdpForm ( ?StandardForm $form = null )

private

Definition at line 736 of file class.ilSamlSettingsGUI.php.

References ensureWriteAccess(), getIdpForm(), ILIAS\Repository\help(), ILIAS\Repository\lng(), and null.

Referenced by saveNewIdp().

                                                                : void
     {
         $this->ensureWriteAccess();
 
         if ($form === null) {
             $form = $this->getIdpForm();
         } else {
             $form = $form->withRequest($this->http_state->request());
         }
 
         $this->help->setSubScreenId('create_idp');
 
         $title = $this->ui_factory->item()->standard($this->lng->txt('auth_saml_add_idp_btn'));
         $this->tpl->setContent($this->ui_renderer->render([
             $title,
             $form
         ]));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showSettings()

ilSamlSettingsGUI::showSettings ( ?StandardForm $form = null )

private

Definition at line 566 of file class.ilSamlSettingsGUI.php.

References ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\Repository\ctrl(), ilSamlSettings\getInstance(), getSettingsForm(), ILIAS\Repository\lng(), null, prepareRoleSelection(), ILIAS\Repository\rbac(), ILIAS\UI\Component\Input\Container\Form\FormInput\withDisabled(), and ILIAS\UI\Implementation\Component\Input\withValue().

Referenced by saveSettings().

                                                              : void
     {
         if (!$form) {
             $form = $this->getSettingsForm([
                 self::LNG_LOGIN_FORM => ilSamlSettings::getInstance()->isDisplayedOnLoginPage()
             ]);
         }
 
         $title = $this->ui_factory->item()->standard($this->lng->txt('auth_saml_configure'));
         $this->tpl->setContent($this->ui_renderer->render([
             $title,
             $form
         ]));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showUserAttributeMappingForm()

ilSamlSettingsGUI::showUserAttributeMappingForm ( ?ilPropertyFormGUI $form = null )

private

Definition at line 486 of file class.ilSamlSettingsGUI.php.

References $data, getUserAttributeMappingForm(), and ILIAS\Repository\tabs().

Referenced by saveUserAttributeMapping().

                                                                                   : void
     {
         $this->tabs->setSubTabActive(self::LNG_AUTH_SAML_USER_MAPPING);
 
         if (!($form instanceof ilPropertyFormGUI)) {
             $form = $this->getUserAttributeMappingForm();
             $data = [];
             foreach ($this->mapping as $rule) {
                 $data[$rule->getAttribute()] = $rule->getExternalAttribute();
                 $data[$rule->getAttribute() . self::PROP_UPDATE_SUFFIX] = $rule->isAutomaticallyUpdated();
             }
             $form->setValuesByArray($data);
         }
 
         $this->tpl->setContent($form->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storeMetadata()

ilSamlSettingsGUI::storeMetadata	(	ilSamlIdp	$idp,
		string	$metadata
	)

private

Definition at line 762 of file class.ilSamlSettingsGUI.php.

References ilSamlIdp\getIdpId().

Referenced by saveIdpSettings(), and saveNewIdp().

                                                                     : void
     {
         $idp_disco = $this->saml_auth->getIdpDiscovery();
         $idp_disco->storeIdpMetadata($idp->getIdpId(), $metadata);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $ctrl

readonly ilCtrlInterface ilSamlSettingsGUI::$ctrl

private

Definition at line 98 of file class.ilSamlSettingsGUI.php.

◆ $error_handler

readonly ilErrorHandling ilSamlSettingsGUI::$error_handler

private

Definition at line 102 of file class.ilSamlSettingsGUI.php.

◆ $help

readonly ilHelpGUI ilSamlSettingsGUI::$help

private

Definition at line 107 of file class.ilSamlSettingsGUI.php.

◆ $http_state

readonly GlobalHttpState ilSamlSettingsGUI::$http_state

private

Definition at line 105 of file class.ilSamlSettingsGUI.php.

◆ $idp

ilSamlIdp ilSamlSettingsGUI::$idp = null

private

Definition at line 109 of file class.ilSamlSettingsGUI.php.

◆ $lng

readonly ilLanguage ilSamlSettingsGUI::$lng

private

Definition at line 99 of file class.ilSamlSettingsGUI.php.

◆ $mapping

ilExternalAuthUserAttributeMapping ilSamlSettingsGUI::$mapping = null

private

Definition at line 108 of file class.ilSamlSettingsGUI.php.

◆ $rbac

readonly RBACServices ilSamlSettingsGUI::$rbac

private

Definition at line 101 of file class.ilSamlSettingsGUI.php.

◆ $refinery

readonly Refinery ilSamlSettingsGUI::$refinery

private

Definition at line 106 of file class.ilSamlSettingsGUI.php.

◆ $saml_auth

ilSamlAuth ilSamlSettingsGUI::$saml_auth = null

private

Definition at line 110 of file class.ilSamlSettingsGUI.php.

◆ $tabs

readonly ilTabsGUI ilSamlSettingsGUI::$tabs

private

Definition at line 103 of file class.ilSamlSettingsGUI.php.

◆ $toolbar

readonly ilToolbarGUI ilSamlSettingsGUI::$toolbar

private

Definition at line 104 of file class.ilSamlSettingsGUI.php.

◆ $tpl

readonly ilGlobalTemplateInterface ilSamlSettingsGUI::$tpl

private

Definition at line 100 of file class.ilSamlSettingsGUI.php.

◆ $ui_factory

readonly ILIAS UI Factory ilSamlSettingsGUI::$ui_factory

private

Definition at line 111 of file class.ilSamlSettingsGUI.php.

◆ $ui_renderer

readonly ILIAS UI Renderer ilSamlSettingsGUI::$ui_renderer

private

Definition at line 112 of file class.ilSamlSettingsGUI.php.

◆ CMD_SAVE

const string ilSamlSettingsGUI::CMD_SAVE = 'save'

private

Definition at line 53 of file class.ilSamlSettingsGUI.php.

◆ CMD_SAVE_NEW_IDP

const string ilSamlSettingsGUI::CMD_SAVE_NEW_IDP = 'saveNewIdp'

private

Definition at line 49 of file class.ilSamlSettingsGUI.php.

◆ CMD_SAVE_SETTINGS

const string ilSamlSettingsGUI::CMD_SAVE_SETTINGS = 'saveSettings'

private

Definition at line 50 of file class.ilSamlSettingsGUI.php.

◆ CMD_SAVE_USER_ATTRIBUTE_MAPPING

const string ilSamlSettingsGUI::CMD_SAVE_USER_ATTRIBUTE_MAPPING = 'saveUserAttributeMapping'

private

Definition at line 54 of file class.ilSamlSettingsGUI.php.

◆ CMD_SHOW_IDP_SETTINGS

const string ilSamlSettingsGUI::CMD_SHOW_IDP_SETTINGS = 'showIdpSettings'

private

Definition at line 51 of file class.ilSamlSettingsGUI.php.

◆ CMD_SHOW_SETTINGS

const string ilSamlSettingsGUI::CMD_SHOW_SETTINGS = 'showSettings'

private

Definition at line 48 of file class.ilSamlSettingsGUI.php.

◆ CMT_SAVE_IDP_SETTINGS

const string ilSamlSettingsGUI::CMT_SAVE_IDP_SETTINGS = 'saveIdpSettings'

private

Definition at line 52 of file class.ilSamlSettingsGUI.php.

◆ DEFAULT_CMD

const string ilSamlSettingsGUI::DEFAULT_CMD = 'listIdps'

Definition at line 33 of file class.ilSamlSettingsGUI.php.

Referenced by ilObjAuthSettingsGUI\getTabs().

◆ GLOBAL_COMMANDS

const array ilSamlSettingsGUI::GLOBAL_COMMANDS

private

Initial value:

= [
        self::DEFAULT_CMD,
        'showAddIdpForm',
        self::CMD_SHOW_SETTINGS,
        self::CMD_SAVE_SETTINGS,
        'showNewIdpForm',
        'saveNewIdp',
    ]

Definition at line 61 of file class.ilSamlSettingsGUI.php.

◆ GLOBAL_ENTITY_COMMANDS

const array ilSamlSettingsGUI::GLOBAL_ENTITY_COMMANDS

private

Initial value:

= [
        'deactivateIdp',
        'activateIdp',
        'confirmDeleteIdp',
        'deleteIdp',
    ]

Definition at line 71 of file class.ilSamlSettingsGUI.php.

◆ IGNORED_USER_FIELDS

const array ilSamlSettingsGUI::IGNORED_USER_FIELDS

private

Initial value:

= [
        'mail_incoming_mail',
        'preferences',
        'hide_own_online_status',
        'show_users_online',
        'roles',
        'upload',
        'password',
        'username',
        'language',
        'skin_style',
        'interests_general',
        'interests_help_offered',
        'interests_help_looking',
        'bs_allow_to_contact_me',
        'chat_osc_accept_msg',
        'chat_broadcast_typing',
    ]

Definition at line 79 of file class.ilSamlSettingsGUI.php.

◆ LNG_AUTH_SAML_USER_MAPPING

const string ilSamlSettingsGUI::LNG_AUTH_SAML_USER_MAPPING = 'auth_saml_user_mapping'

private

Definition at line 44 of file class.ilSamlSettingsGUI.php.

◆ LNG_CANCEL

const string ilSamlSettingsGUI::LNG_CANCEL = 'cancel'

private

Definition at line 46 of file class.ilSamlSettingsGUI.php.

◆ LNG_LOGIN_FORM

const string ilSamlSettingsGUI::LNG_LOGIN_FORM = 'login_form'

private

Definition at line 45 of file class.ilSamlSettingsGUI.php.

◆ LNG_SAVED_SUCCESSFULLY

const string ilSamlSettingsGUI::LNG_SAVED_SUCCESSFULLY = 'saved_successfully'

private

Definition at line 43 of file class.ilSamlSettingsGUI.php.

◆ MESSAGE_TYPE_FAILURE

const string ilSamlSettingsGUI::MESSAGE_TYPE_FAILURE = 'failure'

private

Definition at line 40 of file class.ilSamlSettingsGUI.php.

◆ MESSAGE_TYPE_SUCCESS

const string ilSamlSettingsGUI::MESSAGE_TYPE_SUCCESS = 'success'

private

Definition at line 41 of file class.ilSamlSettingsGUI.php.

◆ METADATA_STORAGE_KEY

const string ilSamlSettingsGUI::METADATA_STORAGE_KEY = 'metadata'

private

Definition at line 58 of file class.ilSamlSettingsGUI.php.

◆ PERMISSION_WRITE

const string ilSamlSettingsGUI::PERMISSION_WRITE = 'write'

private

Definition at line 35 of file class.ilSamlSettingsGUI.php.

◆ PROP_UPDATE_SUFFIX

const string ilSamlSettingsGUI::PROP_UPDATE_SUFFIX = '_update'

private

Definition at line 56 of file class.ilSamlSettingsGUI.php.

◆ REQUEST_PARAM_SAML_IDP_ID

const string ilSamlSettingsGUI::REQUEST_PARAM_SAML_IDP_ID = 'saml_idp_id'

private

Definition at line 37 of file class.ilSamlSettingsGUI.php.

◆ REQUEST_PARAM_SAML_IDP_IDS

const string ilSamlSettingsGUI::REQUEST_PARAM_SAML_IDP_IDS = 'saml_idp_ids'

private

Definition at line 38 of file class.ilSamlSettingsGUI.php.

◆ VIEW_MODE_GLOBAL

const int ilSamlSettingsGUI::VIEW_MODE_GLOBAL = 1

private

Definition at line 30 of file class.ilSamlSettingsGUI.php.

◆ VIEW_MODE_SINGLE

const int ilSamlSettingsGUI::VIEW_MODE_SINGLE = 2

private

Definition at line 31 of file class.ilSamlSettingsGUI.php.

The documentation for this class was generated from the following file:

components/ILIAS/Saml/classes/class.ilSamlSettingsGUI.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activateIdp()

◆ addAttributeRuleFieldToForm()

◆ confirmDeleteIdp()

◆ deactivateIdp()

◆ deleteIdp()

◆ ensureAccess()

◆ ensureReadAccess()

◆ ensureWriteAccess()

◆ executeCommand()

◆ getIdpForm()

◆ getIdpIdOrZero()

◆ getRefId()

◆ getSafePostCommands()

◆ getSettingsForm()

◆ getUnsafeGetCommands()

◆ getUserAttributeMappingForm()

◆ handleTableActions()

◆ initIdp()

◆ initUserAttributeMapping()

◆ listIdps()

◆ populateWithMetadata()

◆ prepareRoleSelection()

◆ saveIdpSettings()

◆ saveNewIdp()

◆ saveSettings()

◆ saveUserAttributeMapping()

◆ setSubTabs()

◆ showIdpSettings()

◆ showNewIdpForm()

◆ showSettings()

◆ showUserAttributeMappingForm()

◆ storeMetadata()

Field Documentation

◆ $ctrl

◆ $error_handler

◆ $help

◆ $http_state

◆ $idp

◆ $lng

◆ $mapping

◆ $rbac

◆ $refinery

◆ $saml_auth

◆ $tabs

◆ $toolbar

◆ $tpl

◆ $ui_factory

◆ $ui_renderer

◆ CMD_SAVE

◆ CMD_SAVE_NEW_IDP

◆ CMD_SAVE_SETTINGS

◆ CMD_SAVE_USER_ATTRIBUTE_MAPPING

◆ CMD_SHOW_IDP_SETTINGS

◆ CMD_SHOW_SETTINGS

◆ CMT_SAVE_IDP_SETTINGS

◆ DEFAULT_CMD

◆ GLOBAL_COMMANDS

◆ GLOBAL_ENTITY_COMMANDS

◆ IGNORED_USER_FIELDS

◆ LNG_AUTH_SAML_USER_MAPPING

◆ LNG_CANCEL

◆ LNG_LOGIN_FORM

◆ LNG_SAVED_SUCCESSFULLY

◆ MESSAGE_TYPE_FAILURE

◆ MESSAGE_TYPE_SUCCESS

◆ METADATA_STORAGE_KEY

◆ PERMISSION_WRITE

◆ PROP_UPDATE_SUFFIX

◆ REQUEST_PARAM_SAML_IDP_ID

◆ REQUEST_PARAM_SAML_IDP_IDS

◆ VIEW_MODE_GLOBAL

◆ VIEW_MODE_SINGLE