ilAuthFrontendCredentialsSoap Class Reference

Inheritance diagram for ilAuthFrontendCredentialsSoap:

Collaboration diagram for ilAuthFrontendCredentialsSoap:

Public Member Functions
	__construct (ServerRequestInterface $httpRequest, ilCtrl $ctrl, ilSetting $settings)
	ilAuthFrontendCredentialsApache constructor. More...
	tryAuthenticationOnLoginPage ()
	Check if an authentication attempt should be done when login page has been called. More...
Public Member Functions inherited from ilAuthFrontendCredentials
	__construct ()
	getLogger ()
	Get logger. More...
	setLogger (ilLogger $logger)
	Set Logger. More...
	setUsername ($a_name)
	Set username. More...
	getUsername ()
	Get username. More...
	setPassword ($a_password)
	Set password. More...
	getPassword ()
	Get password. More...
	setCaptchaCode ($a_code)
	Set captcha code. More...
	getCaptchaCode ()
	Get captcha code. More...
	setAuthMode ($a_auth_mode)
	Set auth mode. More...
	getAuthMode ()
	Get auth mode. More...
	setUsername ($a_name)
	Set username. More...
	getUsername ()
	Get username. More...
	setPassword ($a_password)
	Set password. More...
	getPassword ()
	Get password. More...
	setCaptchaCode ($a_code)
	Set captcha code. More...
	getCaptchaCode ()
	Get captcha code. More...
	setAuthMode ($a_auth_mode)
	Set auth mode. More...
	getAuthMode ()
	Get auth mode. More...

Private Attributes
	$httpRequest
	$ctrl
	$settings

Detailed Description

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

Constructor & Destructor Documentation

__construct()

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

ilAuthFrontendCredentialsApache constructor.

Parameters

ServerRequestInterface	$httpRequest
ilCtrl	$ctrl
ilSetting	$settings

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

    {
        $this->httpRequest = $httpRequest;
        $this->ctrl = $ctrl;
        $this->settings = $settings;
        parent::__construct();
    }

References $ctrl, $httpRequest, $settings, and settings().

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 32 of file class.ilAuthFrontendCredentialsSoap.php.

    {
        $cmd = '';
        if (isset($this->httpRequest->getQueryParams()['cmd']) && is_string($this->httpRequest->getQueryParams()['cmd'])) {
            $cmd = $this->httpRequest->getQueryParams()['cmd'];
        }
        if ('' === $cmd) {
            if (isset($this->httpRequest->getParsedBody()['cmd']) && is_string($this->httpRequest->getParsedBody()['cmd'])) {
                $cmd = $this->httpRequest->getParsedBody()['cmd'];
            }
        }
 
        $passedSso = '';
        if (isset($this->httpRequest->getQueryParams()['passed_sso']) && is_string($this->httpRequest->getQueryParams()['passed_sso'])) {
            $passedSso = $this->httpRequest->getParsedBody()['passed_sso'];
        }
 
        if ('force_login' === $cmd || !empty($passedSso)) {
            return false;
        }
 
        if (!$this->settings->get('soap_auth_active', false)) {
            return false;
        }
 
        if (empty($this->getUsername()) || empty($this->getPassword())) {
            return false;
        }
 
        $this->getLogger()->debug('Using SOAP authentication.');
 
        $status = ilAuthStatus::getInstance();
 
        require_once 'Services/SOAPAuth/classes/class.ilAuthProviderSoap.php';
        $provider = new ilAuthProviderSoap($this);
 
        $frontend_factory = new ilAuthFrontendFactory();
        $frontend_factory->setContext(ilAuthFrontendFactory::CONTEXT_STANDARD_FORM);
        $frontend = $frontend_factory->getFrontend(
            $GLOBALS['DIC']['ilAuthSession'],
            $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:
                ilUtil::sendFailure($status->getTranslatedReason(), true);
                $this->ctrl->redirectToURL(ilUtil::appendUrlParameterString(
                    $this->ctrl->getLinkTargetByClass('ilStartupGUI', 'showLoginPage', '', false, false),
                    'passed_sso=1'
                ));
                break;
        }
    }

References $GLOBALS, PHPMailer\PHPMailer\$provider, ilUtil\appendUrlParameterString(), ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ilAuthStatus\getInstance(), ilLoggerFactory\getLogger(), ilAuthFrontendCredentials\getLogger(), ilAuthFrontendCredentials\getPassword(), ilAuthFrontendCredentials\getUsername(), ilUtil\sendFailure(), settings(), ilAuthStatus\STATUS_AUTHENTICATED, and ilAuthStatus\STATUS_AUTHENTICATION_FAILED.

Here is the call graph for this function:

Field Documentation

$ctrl

ilAuthFrontendCredentialsSoap::$ctrl

private

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

Referenced by __construct().

$httpRequest

ilAuthFrontendCredentialsSoap::$httpRequest

private

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

Referenced by __construct().

$settings

ilAuthFrontendCredentialsSoap::$settings

private

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

Referenced by __construct().

---

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

• Services/Authentication/classes/Frontend/class.ilAuthFrontendCredentialsSoap.php