ilAuthFrontendCredentialsSoap Class Reference

Inheritance diagram for ilAuthFrontendCredentialsSoap:

Collaboration diagram for ilAuthFrontendCredentialsSoap:

Public Member Functions
	__construct (ServerRequestInterface $httpRequest, ilCtrlInterface $ctrl, ilSetting $settings)
	tryAuthenticationOnLoginPage ()
	Check if an authentication attempt should be done when login page has been called. More...
Public Member Functions inherited from ilAuthFrontendCredentials
	__construct ()
	setUsername (string $a_name)
	getUsername ()
	setPassword (string $a_password)
	getPassword ()
	setAuthMode (string $a_auth_mode)
	getAuthMode ()

Private Attributes
ServerRequestInterface	$httpRequest
ilCtrlInterface	$ctrl
ilSetting	$settings
ilAuthSession	$authSession
ilGlobalTemplateInterface	$main_tpl

Additional Inherited Members
Protected Attributes inherited from ilAuthFrontendCredentials
ilLogger	$logger

Detailed Description

Definition at line 23 of file class.ilAuthFrontendCredentialsSoap.php.

Constructor & Destructor Documentation

__construct()

ilAuthFrontendCredentialsSoap::__construct	(	ServerRequestInterface	$httpRequest,
		ilCtrlInterface	$ctrl,
		ilSetting	$settings
	)

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

References $ctrl, $DIC, $httpRequest, $settings, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), and ILIAS\Repository\settings().

    {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->authSession = $DIC['ilAuthSession'];
        $this->httpRequest = $httpRequest;
        $this->ctrl = $ctrl;
        $this->settings = $settings;
        parent::__construct();
    }

Here is the call graph for this function:

Member Function Documentation

tryAuthenticationOnLoginPage()

ilAuthFrontendCredentialsSoap::tryAuthenticationOnLoginPage

(

)

Check if an authentication attempt should be done when login page has been called.

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

References $provider, ilUtil\appendUrlParameterString(), ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ILIAS\Repository\ctrl(), ilAuthStatus\getInstance(), ilLoggerFactory\getLogger(), ilAuthFrontendCredentials\getPassword(), ilAuthFrontendCredentials\getUsername(), ILIAS\Repository\logger(), ilInitialisation\redirectToStartingPage(), ILIAS\Repository\settings(), ilAuthStatus\STATUS_AUTHENTICATED, and ilAuthStatus\STATUS_AUTHENTICATION_FAILED.

                                                  : void
    {
        $passedSso = '';
        if (isset($this->httpRequest->getQueryParams()['passed_sso']) && is_string($this->httpRequest->getQueryParams()['passed_sso'])) {
            $passedSso = $this->httpRequest->getQueryParams()['passed_sso'];
        }

        if (!empty($passedSso)) {
            return;
        }

        if (!$this->settings->get('soap_auth_active', '')) {
            return;
        }

        if (empty($this->getUsername()) || empty($this->getPassword())) {
            return;
        }

        $this->logger->debug('Using SOAP authentication.');

        $status = ilAuthStatus::getInstance();

        $provider = new ilAuthProviderSoap($this);

        $frontend_factory = new ilAuthFrontendFactory();
        $frontend_factory->setContext(ilAuthFrontendFactory::CONTEXT_STANDARD_FORM);
        $frontend = $frontend_factory->getFrontend(
            $this->authSession,
            $status,
            $this,
            [$provider]
        );
        $frontend->authenticate();

        switch ($status->getStatus()) {
            case ilAuthStatus::STATUS_AUTHENTICATED:
                ilLoggerFactory::getLogger('auth')->debug(
                    'Redirecting to default starting page.'
                );
                ilInitialisation::redirectToStartingPage();
                break;

            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                $this->main_tpl->setOnScreenMessage('failure', $status->getTranslatedReason(), true);
                $this->ctrl->redirectToURL(ilUtil::appendUrlParameterString(
                    $this->ctrl->getLinkTargetByClass('ilStartupGUI', 'showLoginPage', '', false, false),
                    'passed_sso=1'
                ));
                break;
        }
    }

Here is the call graph for this function:

Field Documentation

$authSession

ilAuthSession ilAuthFrontendCredentialsSoap::$authSession

private

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

$ctrl

ilCtrlInterface ilAuthFrontendCredentialsSoap::$ctrl

private

Definition at line 26 of file class.ilAuthFrontendCredentialsSoap.php.

Referenced by __construct().

$httpRequest

ServerRequestInterface ilAuthFrontendCredentialsSoap::$httpRequest

private

Definition at line 25 of file class.ilAuthFrontendCredentialsSoap.php.

Referenced by __construct().

$main_tpl

ilGlobalTemplateInterface ilAuthFrontendCredentialsSoap::$main_tpl

private

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

$settings

ilSetting ilAuthFrontendCredentialsSoap::$settings

private

Definition at line 27 of file class.ilAuthFrontendCredentialsSoap.php.

Referenced by __construct().

---

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

• components/ILIAS/Authentication/classes/Frontend/class.ilAuthFrontendCredentialsSoap.php