ilSamlSettingsGUI Class Reference

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 ()
	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...
	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

Data Fields
const string	DEFAULT_CMD = self::CMD_LIST_IDPS
Data Fields inherited from ilSamlCommands
const string	CMD_LIST_IDPS = 'listIdps'
const string	CMD_TABLE_ACTIONS = 'handleTableActions'
const string	CMD_SHOW_NEW_IDP_FORM = 'showNewIdpForm'
const string	CMD_SAVE_NEW_IDP = 'saveNewIdp'
const string	CMD_DELETE_IDP = 'deleteIdp'
const string	CMD_SAVE_SETTINGS = 'saveSettings'
const string	CMD_SHOW_SETTINGS = 'showSettings'
const string	CMD_SHOW_IDP_SETTINGS = 'showIdpSettings'
const string	CMD_SAVE_IDP_SETTINGS = 'saveIdpSettings'
const string	CMD_SAVE_USER_ATTRIBUTE_MAPPING = 'saveUserAttributeMapping'
const string	CMD_SHOW_USER_ATTRIBUTE_MAPPING_FORM = 'showUserAttributeMappingForm'
const string	TABLE_ACTION_CONFIRM_DELETE_IDP = 'confirmDeleteIdp'
const string	TABLE_ACTION_DEACTIVATE_IDP = 'deactivateIdp'
const string	TABLE_ACTION_ACTIVATE_IDP = 'activateIdp'
const string	TABLE_ACTION_SHOW_IDP_SETTINGS = 'showIdpSettings'
const array	GLOBAL_COMMANDS
const array	GLOBAL_ENTITY_COMMANDS
const array	GLOBAL_ENTITY_TABLE_ACTIONS

Private Member Functions
	ensureAccess (string $operation)
	ensureWriteAccess ()
	ensureReadAccess ()
	getIdpIdOrZero ()
	initIdp ()
	shouldRenderGlobalCommandSubTabs (string $cmd)
	listIdpsCommand ()
	getTableAction ()
	handleTableActionsCommand ()
	deactivateIdp ()
	activateIdp ()
	setSubTabs (int $a_view_mode)
	initUserAttributeMapping ()
	getUserAttributeMappingForm ()
	addAttributeRuleFieldToForm (ilPropertyFormGUI $form, string $field_label, string $field_name)
	saveUserAttributeMappingCommand ()
	showUserAttributeMappingFormCommand (?ilPropertyFormGUI $form=null)
	getSettingsForm (array $values=[])
	prepareRoleSelection ()
	saveSettingsCommand ()
	showSettingsCommand (?StandardForm $form=null)
	metadataValidationConstraint (?string &$medadata_entity_id=null)
	showIdpSettingsCommand (?StandardForm $form=null)
	saveIdpSettingsCommand ()
	getIdpForm ()
	saveNewIdpCommand ()
	showNewIdpFormCommand (?StandardForm $form=null)
	populateWithMetadata (ilSamlIdp $idp, array &$data)
	storeMetadata (ilSamlIdp $idp, string $metadata)
	confirmDeleteIdp ()
	deleteIdpCommand ()

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	LNG_SAVE = 'save'
const string	PROP_UPDATE_SUFFIX = '_update'
const string	METADATA_STORAGE_KEY = 'metadata'
const string	METADATA_ENTITY_ID = 'entity_id'
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
readonly Profile	$profile

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilSamlSettingsGUI::__construct

(

private readonly int

$ref_id

)

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

    {
        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->profile = $DIC['user']->getProfile();
 
        $this->lng->loadLanguageModule('auth');
    }

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

Here is the call graph for this function:

Member Function Documentation

activateIdp()

ilSamlSettingsGUI::activateIdp ( )

private

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

                                  : 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);
    }

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

Referenced by handleTableActionsCommand().

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 435 of file class.ilSamlSettingsGUI.php.

     : 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);
    }

Referenced by getUserAttributeMappingForm().

Here is the caller graph for this function:

confirmDeleteIdp()

ilSamlSettingsGUI::confirmDeleteIdp ( )

private

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

                                       : void
    {
        $this->ensureWriteAccess();
 
        $confirmation = new ilConfirmationGUI();
        $confirmation->setFormAction($this->ctrl->getFormAction($this, self::CMD_DELETE_IDP));
        $confirmation->setConfirm($this->lng->txt('confirm'), self::CMD_DELETE_IDP);
        $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());
    }

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

Referenced by handleTableActionsCommand().

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.

                                    : 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);
    }

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

Referenced by handleTableActionsCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

deleteIdpCommand()

ilSamlSettingsGUI::deleteIdpCommand ( )

private

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

                                       : 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);
    }

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

Here is the call graph for this function:

ensureAccess()

ilSamlSettingsGUI::ensureAccess ( string  $operation )

private

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

                                                    : 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);
        }
    }

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

Referenced by ensureReadAccess(), and ensureWriteAccess().

Here is the call graph for this function:

Here is the caller graph for this function:

ensureReadAccess()

ilSamlSettingsGUI::ensureReadAccess ( )

private

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

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

References ensureAccess().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

ensureWriteAccess()

ilSamlSettingsGUI::ensureWriteAccess ( )

private

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

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

References ensureAccess().

Referenced by activateIdp(), and deactivateIdp().

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilSamlSettingsGUI::executeCommand

(

)

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

                                    : 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 . 'Command')) {
            $cmd = self::DEFAULT_CMD;
        }
        $verified_command = $cmd . 'Command';
 
        $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 ($this->shouldRenderGlobalCommandSubTabs($cmd)) {
            $this->setSubTabs(self::VIEW_MODE_GLOBAL);
        } else {
            $this->setSubTabs(self::VIEW_MODE_SINGLE);
        }
 
        $this->$verified_command();
    }

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

Here is the call graph for this function:

getIdpForm()

ilSamlSettingsGUI::getIdpForm ( )

private

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

                                 : StandardForm
    {
        $medadata_entity_id = '';
 
        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)
                    ->withoutStripTags()
                    ->withDedicatedName(self::METADATA_STORAGE_KEY)
                    ->withAdditionalTransformation($this->metadataValidationConstraint($medadata_entity_id)),
                self::METADATA_ENTITY_ID => $this->ui_factory
                    ->input()
                    ->field()
                    ->hidden()
                    ->withAdditionalTransformation(
                        $this->refinery->custom()->transformation(
                            static function (string $value) use (&$medadata_entity_id): string {
                                $sanitized_value = ilUtil::stripSlashes(trim($medadata_entity_id));
                                if ($sanitized_value !== $medadata_entity_id) {
                                    $sanitized_value = ilUtil::stripSlashes(str_replace('<', '< ', $medadata_entity_id));
                                }
 
                                return trim($sanitized_value);
                            }
                        )
                    )
            ]
        );
    }

References ILIAS\Repository\ctrl(), and ilUtil\stripSlashes().

Here is the call graph for this function:

getIdpIdOrZero()

ilSamlSettingsGUI::getIdpIdOrZero ( )

private

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

                                     : 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->getTableAction() && $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;
    }

References getTableAction(), and ILIAS\Repository\refinery().

Referenced by executeCommand(), and initIdp().

Here is the call graph for this function:

Here is the caller graph for this function:

getRefId()

ilSamlSettingsGUI::getRefId

(

)

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

                              : int
    {
        return $this->ref_id;
    }

References $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 127 of file class.ilSamlSettingsGUI.php.

                                         : array
    {
        return [];
    }

getSettingsForm()

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

private

Parameters

array<string,mixed>

$values

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

                                                        : 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;
    }

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

Here is the call graph for this function:

getTableAction()

ilSamlSettingsGUI::getTableAction ( )

private

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

                                     : ?string
    {
        return $this->http_state->wrapper()->query()->retrieve(
            'saml_idps_table_action',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $this->refinery->always(null)
            ])
        );
    }

References ILIAS\Repository\refinery().

Referenced by getIdpIdOrZero(), handleTableActionsCommand(), setSubTabs(), and shouldRenderGlobalCommandSubTabs().

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 120 of file class.ilSamlSettingsGUI.php.

                                          : array
    {
        return [
            self::CMD_TABLE_ACTIONS,
        ];
    }

References ilSamlCommands\CMD_TABLE_ACTIONS.

getUserAttributeMappingForm()

ilSamlSettingsGUI::getUserAttributeMappingForm ( )

private

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

                                                  : 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));
 
        foreach ($this->profile->getFields() as $field) {
            if (in_array($field->getIdentifier(), self::IGNORED_USER_FIELDS, true)) {
                continue;
            }
 
            $id = $field->getIdentifier();
            if ($field->isCustom()) {
                $id = "udf_{$id}";
            }
 
            $this->addAttributeRuleFieldToForm($form, $field->getLabel($this->lng), $id);
        }
 
        if ($this->rbac->system()->checkAccess(self::PERMISSION_WRITE, $this->ref_id)) {
            $form->addCommandButton(self::CMD_SAVE_USER_ATTRIBUTE_MAPPING, $this->lng->txt(self::LNG_SAVE));
        } else {
            foreach ($form->getItems() as $item) {
                $item->setDisabled(true);
            }
        }
 
        return $form;
    }

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

Here is the call graph for this function:

handleTableActionsCommand()

ilSamlSettingsGUI::handleTableActionsCommand ( )

private

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

                                                : void
    {
        match ($this->getTableAction()) {
            self::TABLE_ACTION_SHOW_IDP_SETTINGS => $this->ctrl->redirect($this, self::CMD_SHOW_IDP_SETTINGS),
            self::TABLE_ACTION_ACTIVATE_IDP => $this->activateIdp(),
            self::TABLE_ACTION_DEACTIVATE_IDP => $this->deactivateIdp(),
            self::TABLE_ACTION_CONFIRM_DELETE_IDP => $this->confirmDeleteIdp(),
            default => $this->ctrl->redirect($this, self::DEFAULT_CMD),
        };
    }

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

Here is the call graph for this function:

initIdp()

ilSamlSettingsGUI::initIdp ( )

private

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

                              : 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);
        }
    }

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

initUserAttributeMapping()

ilSamlSettingsGUI::initUserAttributeMapping ( )

private

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

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

Referenced by executeCommand().

Here is the caller graph for this function:

listIdpsCommand()

ilSamlSettingsGUI::listIdpsCommand ( )

private

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

                                      : 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, self::CMD_SHOW_NEW_IDP_FORM)
                )
            );
        }
 
        $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(),
            self::CMD_TABLE_ACTIONS,
            $this->rbac->system()->checkAccess(self::PERMISSION_WRITE, $this->ref_id)
        );
        $this->tpl->setContent($this->ui_renderer->render([$info, $table->get()]));
    }

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

Here is the call graph for this function:

metadataValidationConstraint()

ilSamlSettingsGUI::metadataValidationConstraint ( ?string &  $medadata_entity_id = null )

private

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

     : \ILIAS\Refinery\Constraint {
        $xml_parser_error = null;
 
        return $this->refinery->custom()->constraint(
            function (string $value) use (&$xml_parser_error, &$medadata_entity_id): bool {
                try {
                    $parser = new ilSamlIdpXmlMetadataParser(
                        new Factory(),
                        new ilSamlIdpXmlMetadataErrorFormatter()
                    );
 
                    $result = $parser->parse($value);
                    if ($result->isError()) {
                        $xml_parser_error = $result->error();
                        return false;
                    }
 
                    $medadata_entity_id = $result->value();
 
                    return true;
                } catch (Throwable) {
                    $xml_parser_error = $this->lng->txt('auth_saml_add_idp_md_error');
                    return false;
                }
            },
            implode(' ', [$this->lng->txt('auth_saml_add_idp_md_error'), $xml_parser_error])
        );
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

populateWithMetadata()

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

private

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

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

References $data, and ilSamlIdp\getIdpId().

Here is the call graph for this function:

prepareRoleSelection()

ilSamlSettingsGUI::prepareRoleSelection ( )

private

Returns

array<int, string>

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

                                           : 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;
    }

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

Here is the call graph for this function:

saveIdpSettingsCommand()

ilSamlSettingsGUI::saveIdpSettingsCommand ( )

private

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

                                             : 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);
    }

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

Here is the call graph for this function:

saveNewIdpCommand()

ilSamlSettingsGUI::saveNewIdpCommand ( )

private

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

                                        : void
    {
        $this->ensureWriteAccess();
 
        $form = $this->getIdpForm()->withRequest($this->http_state->request());
        if (!$form->getError()) {
            $idp = new ilSamlIdp();
            $idp->bindForm($form);
            $idp->persist();
            $this->storeMetadata($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::TABLE_ACTION_SHOW_IDP_SETTINGS);
        }
 
        $this->showNewIdpFormCommand($form);
    }

References ilSamlIdp\bindForm(), ILIAS\Repository\ctrl(), ilSamlIdp\getIdpId(), ILIAS\Repository\lng(), and ilSamlIdp\persist().

Here is the call graph for this function:

saveSettingsCommand()

ilSamlSettingsGUI::saveSettingsCommand ( )

private

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

                                          : 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->showSettingsCommand($form);
    }

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

Here is the call graph for this function:

saveUserAttributeMappingCommand()

ilSamlSettingsGUI::saveUserAttributeMappingCommand ( )

private

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

                                                      : void
    {
        $this->ensureWriteAccess();
 
        $form = $this->getUserAttributeMappingForm();
        if ($form->checkInput()) {
            $this->mapping->delete();
 
            foreach ($this->profile->getFields() as $field) {
                if (in_array($field->getIdentifier(), self::IGNORED_USER_FIELDS, true)) {
                    continue;
                }
 
                $id = $field->getIdentifier();
                if ($field->isCustom()) {
                    $id = "udf_{$id}";
                }
 
                $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;
            }
 
            $this->mapping->save();
 
            $this->tpl->setOnScreenMessage(self::MESSAGE_TYPE_SUCCESS, $this->lng->txt(self::LNG_SAVED_SUCCESSFULLY));
        }
 
        $form->setValuesByPost();
 
        $this->showUserAttributeMappingFormCommand($form);
    }

References $id, ilPropertyFormGUI\checkInput(), ilPropertyFormGUI\getInput(), ILIAS\Repository\lng(), ILIAS\Repository\profile(), and ilPropertyFormGUI\setValuesByPost().

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.

                                                 : 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, self::CMD_SHOW_NEW_IDP_FORM, self::CMD_SAVE_NEW_IDP]
                    ),
                    self::class,
                    '',
                    ($this->getTableAction() === self::TABLE_ACTION_CONFIRM_DELETE_IDP)
                );
 
                $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::CMD_SAVE_IDP_SETTINGS],
                    self::class
                );
 
                $this->tabs->addSubTabTarget(
                    self::LNG_AUTH_SAML_USER_MAPPING,
                    $this->ctrl->getLinkTarget($this, self::CMD_SHOW_USER_ATTRIBUTE_MAPPING_FORM),
                    [self::CMD_SHOW_USER_ATTRIBUTE_MAPPING_FORM, self::CMD_SAVE_USER_ATTRIBUTE_MAPPING],
                    self::class
                );
                break;
        }
    }

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

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

shouldRenderGlobalCommandSubTabs()

ilSamlSettingsGUI::shouldRenderGlobalCommandSubTabs ( string  $cmd )

private

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

                                                                  : bool
    {
        $is_global_command = in_array(strtolower($cmd), array_map('strtolower', self::GLOBAL_COMMANDS), true);
        $is_global_entity_command = in_array(
            strtolower($cmd),
            array_map('strtolower', self::GLOBAL_ENTITY_COMMANDS),
            true
        );
 
        $is_global_table_action = in_array(
            strtolower($this->getTableAction() ?? ''),
            array_map('strtolower', self::GLOBAL_ENTITY_TABLE_ACTIONS),
            true
        );
 
        return $is_global_command || $is_global_entity_command || $is_global_table_action;
    }

References getTableAction().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

showIdpSettingsCommand()

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

private

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

                                                                       : 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
        ]));
    }

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

Here is the call graph for this function:

showNewIdpFormCommand()

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

private

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

                                                                      : 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
        ]));
    }

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

Here is the call graph for this function:

showSettingsCommand()

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

private

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

                                                                    : 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
        ]));
    }

References ilSamlSettings\getInstance(), and ILIAS\Repository\lng().

Here is the call graph for this function:

showUserAttributeMappingFormCommand()

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

private

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

                                                                                         : 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());
    }

References $data, ilPropertyFormGUI\getHTML(), ilPropertyFormGUI\setValuesByArray(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

storeMetadata()

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

private

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

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

References ilSamlIdp\getIdpId().

Here is the call graph for this function:

Field Documentation

$ctrl

readonly ilCtrlInterface ilSamlSettingsGUI::$ctrl

private

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

$error_handler

readonly ilErrorHandling ilSamlSettingsGUI::$error_handler

private

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

$help

readonly ilHelpGUI ilSamlSettingsGUI::$help

private

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

$http_state

readonly GlobalHttpState ilSamlSettingsGUI::$http_state

private

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

$idp

ilSamlIdp ilSamlSettingsGUI::$idp = null

private

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

$lng

readonly ilLanguage ilSamlSettingsGUI::$lng

private

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

$mapping

ilExternalAuthUserAttributeMapping ilSamlSettingsGUI::$mapping = null

private

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

$profile

readonly Profile ilSamlSettingsGUI::$profile

private

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

$rbac

readonly RBACServices ilSamlSettingsGUI::$rbac

private

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

$refinery

readonly Refinery ilSamlSettingsGUI::$refinery

private

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

$saml_auth

ilSamlAuth ilSamlSettingsGUI::$saml_auth = null

private

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

$tabs

readonly ilTabsGUI ilSamlSettingsGUI::$tabs

private

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

$toolbar

readonly ilToolbarGUI ilSamlSettingsGUI::$toolbar

private

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

$tpl

readonly ilGlobalTemplateInterface ilSamlSettingsGUI::$tpl

private

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

$ui_factory

readonly ILIAS UI Factory ilSamlSettingsGUI::$ui_factory

private

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

$ui_renderer

readonly ILIAS UI Renderer ilSamlSettingsGUI::$ui_renderer

private

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

DEFAULT_CMD

const string ilSamlSettingsGUI::DEFAULT_CMD = self::CMD_LIST_IDPS

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

Referenced by executeCommand(), and ilObjAuthSettingsGUI\getTabs().

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 56 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 45 of file class.ilSamlSettingsGUI.php.

LNG_CANCEL

const string ilSamlSettingsGUI::LNG_CANCEL = 'cancel'

private

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

LNG_LOGIN_FORM

const string ilSamlSettingsGUI::LNG_LOGIN_FORM = 'login_form'

private

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

LNG_SAVE

const string ilSamlSettingsGUI::LNG_SAVE = 'save'

private

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

LNG_SAVED_SUCCESSFULLY

const string ilSamlSettingsGUI::LNG_SAVED_SUCCESSFULLY = 'saved_successfully'

private

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

MESSAGE_TYPE_FAILURE

const string ilSamlSettingsGUI::MESSAGE_TYPE_FAILURE = 'failure'

private

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

MESSAGE_TYPE_SUCCESS

const string ilSamlSettingsGUI::MESSAGE_TYPE_SUCCESS = 'success'

private

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

METADATA_ENTITY_ID

const string ilSamlSettingsGUI::METADATA_ENTITY_ID = 'entity_id'

private

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

METADATA_STORAGE_KEY

const string ilSamlSettingsGUI::METADATA_STORAGE_KEY = 'metadata'

private

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

PERMISSION_WRITE

const string ilSamlSettingsGUI::PERMISSION_WRITE = 'write'

private

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

PROP_UPDATE_SUFFIX

const string ilSamlSettingsGUI::PROP_UPDATE_SUFFIX = '_update'

private

Definition at line 50 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 38 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 39 of file class.ilSamlSettingsGUI.php.

VIEW_MODE_GLOBAL

const int ilSamlSettingsGUI::VIEW_MODE_GLOBAL = 1

private

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

Referenced by setSubTabs().

VIEW_MODE_SINGLE

const int ilSamlSettingsGUI::VIEW_MODE_SINGLE = 2

private

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

Referenced by setSubTabs().

---

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

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