ilAuthFrontendCredentialsApache Class Reference

Inheritance diagram for ilAuthFrontendCredentialsApache:

Collaboration diagram for ilAuthFrontendCredentialsApache:

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

Protected Member Functions
	getSettings ()

Private Attributes
ServerRequestInterface	$httpRequest
ilCtrlInterface	$ctrl
ilSetting	$settings

Additional Inherited Members
Protected Attributes inherited from ilAuthFrontendCredentials
ilLogger	$logger

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilAuthFrontendCredentialsApache::__construct	(	ServerRequestInterface	$httpRequest,
		ilCtrlInterface	$ctrl
	)

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

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

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

Here is the call graph for this function:

Member Function Documentation

getSettings()

ilAuthFrontendCredentialsApache::getSettings ( )

protected

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

                                    : ilSetting
    {
        return $this->settings;
    }

References $settings.

Referenced by initFromRequest(), and tryAuthenticationOnLoginPage().

Here is the caller graph for this function:

getTargetUrl()

ilAuthFrontendCredentialsApache::getTargetUrl

(

)

Definition at line 133 of file class.ilAuthFrontendCredentialsApache.php.

                                  : string
    {
        return ilUtil::appendUrlParameterString(trim($this->httpRequest->getQueryParams()['r']), 'passed_sso=1');
    }

References ilUtil\appendUrlParameterString().

Here is the call graph for this function:

hasValidTargetUrl()

ilAuthFrontendCredentialsApache::hasValidTargetUrl

(

)

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

                                       : bool
    {
        $targetUrl = trim((string) ($this->httpRequest->getQueryParams()['r'] ?? ''));
        if ($targetUrl === '') {
            return false;
        }
 
        $validDomains = [];
        $path = ILIAS_DATA_DIR . '/' . CLIENT_ID . '/apache_auth_allowed_domains.txt';
        if (file_exists($path) && is_readable($path)) {
            foreach (file($path) as $line) {
                if (trim($line)) {
                    $validDomains[] = trim($line);
                }
            }
        }
 
        return (new ilWhiteListUrlValidator($targetUrl, $validDomains))->isValid();
    }

References $path, CLIENT_ID, and ILIAS_DATA_DIR.

initFromRequest()

ilAuthFrontendCredentialsApache::initFromRequest

(

)

Definition at line 93 of file class.ilAuthFrontendCredentialsApache.php.

                                     : void
    {
        $mappingFieldName = $this->getSettings()->get('apache_auth_username_direct_mapping_fieldname', '');
 
        $this->logger->dump($this->httpRequest->getServerParams(), ilLogLevel::DEBUG);
        $this->logger->debug($mappingFieldName);
 
        switch ($this->getSettings()->get('apache_auth_username_config_type')) {
            case ilAuthProviderApache::APACHE_AUTH_TYPE_DIRECT_MAPPING:
                if (isset($this->httpRequest->getServerParams()[$mappingFieldName])) {
                    $this->setUsername($this->httpRequest->getServerParams()[$mappingFieldName]);
                }
                break;
 
            case ilAuthProviderApache::APACHE_AUTH_TYPE_BY_FUNCTION:
                $this->setUsername(ApacheCustom::getUsername());
                break;
        }
    }

References ilAuthProviderApache\APACHE_AUTH_TYPE_BY_FUNCTION, ilAuthProviderApache\APACHE_AUTH_TYPE_DIRECT_MAPPING, ilLogLevel\DEBUG, getSettings(), ApacheCustom\getUsername(), ILIAS\Repository\logger(), and ilAuthFrontendCredentials\setUsername().

Here is the call graph for this function:

tryAuthenticationOnLoginPage()

ilAuthFrontendCredentialsApache::tryAuthenticationOnLoginPage

(

)

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

Redirects in case no apache authentication has been tried before (GET['passed_sso'])

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

                                                  : void
    {
        $cmd = (string) ($this->httpRequest->getQueryParams()['cmd'] ?? '');
        if ($cmd === '') {
            $cmd = (string) ($this->httpRequest->getParsedBody()['cmd'] ?? '');
        }
 
        if ($cmd === 'force_login') {
            return;
        }
 
        if (!$this->getSettings()->get('apache_enable_auth', '0')) {
            return;
        }
 
        if (!$this->getSettings()->get('apache_auth_authenticate_on_login_page', '0')) {
            return;
        }
 
        if (
            (defined('IL_CERT_SSO') && (int) IL_CERT_SSO === 1) ||
            !ilContext::supportsRedirects() ||
            isset($this->httpRequest->getQueryParams()['passed_sso'])
        ) {
            return;
        }
 
        $path = (string) ($this->httpRequest->getServerParams()['REQUEST_URI'] ?? '');
        if (str_starts_with($path, '/')) {
            $path = substr($path, 1);
        }
 
        if (!str_starts_with($path, 'http')) {
            $parts = parse_url(ILIAS_HTTP_PATH);
            $path = $parts['scheme'] . '://' . $parts['host'] . '/' . $path;
        }
 
        $this->ctrl->redirectToURL(
            ilUtil::getHtmlPath(
                './public/sso/index.php?force_mode_apache=1&' .
                'r=' . urlencode($path) .
                '&cookie_path=' . urlencode(IL_COOKIE_PATH) .
                '&ilias_path=' . urlencode(ILIAS_HTTP_PATH)
            )
        );
    }

References $parts, $path, ILIAS\Repository\ctrl(), ilUtil\getHtmlPath(), getSettings(), IL_COOKIE_PATH, ILIAS\Repository\int(), and ilContext\supportsRedirects().

Here is the call graph for this function:

Field Documentation

$ctrl

ilCtrlInterface ilAuthFrontendCredentialsApache::$ctrl

private

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

Referenced by __construct().

$httpRequest

ServerRequestInterface ilAuthFrontendCredentialsApache::$httpRequest

private

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

Referenced by __construct().

$settings

ilSetting ilAuthFrontendCredentialsApache::$settings

private

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

Referenced by getSettings().

---

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

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