ilAuthFrontendCredentialsApache Class Reference

Description of class class. More...

Inheritance diagram for ilAuthFrontendCredentialsApache:

Collaboration diagram for ilAuthFrontendCredentialsApache:

Public Member Functions
	__construct ()
	Constructor. More...
	tryAuthenticationOnLoginPage ()
	Check if an authentication attempt should be done when login page has been called. More...
	initFromRequest ()
	Init credentials from request. More...
	hasValidTargetUrl ()
	getTargetUrl ()
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...

Protected Member Functions
	getSettings ()

Private Attributes
	$settings = null

Detailed Description

Description of class class.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

__construct()

ilAuthFrontendCredentialsApache::__construct

(

)

Constructor.

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

References settings().

    {
        parent::__construct();

        include_once './Services/Administration/classes/class.ilSetting.php';
        $this->settings = new ilSetting('apache_auth');
    }

Here is the call graph for this function:

Member Function Documentation

getSettings()

ilAuthFrontendCredentialsApache::getSettings ( )

protected

Returns

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

References $settings.

Referenced by initFromRequest(), and tryAuthenticationOnLoginPage().

    {
        return $this->settings;
    }

Here is the caller graph for this function:

getTargetUrl()

ilAuthFrontendCredentialsApache::getTargetUrl

(

)

Returns

string

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

References $_GET, and ilUtil\appendUrlParameterString().

    {
        return ilUtil::appendUrlParameterString(trim($_GET['r']), 'passed_sso=1');
    }

Here is the call graph for this function:

hasValidTargetUrl()

ilAuthFrontendCredentialsApache::hasValidTargetUrl

(

)

Returns

bool

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

References $_GET, $path, $url, array, and file.

    {
        if (!isset($_GET['r']) || 0 == strlen(trim($_GET['r']))) {
            return false;
        }

        $url = trim($_GET['r']);

        $validDomains = array();
        $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);
                }
            }
        }

        $urlParts       = parse_url($url);
        $redirectDomain = $urlParts['host'];

        $validRedirect = false;
        foreach ($validDomains as $validDomain) {
            if ($redirectDomain === $validDomain) {
                $validRedirect = true;
                break;
            }

            if (strlen($redirectDomain) > (strlen($validDomain) + 1)) {
                if (substr($redirectDomain, (0 - strlen($validDomain) - 1)) === '.' . $validDomain) {
                    $validRedirect = true;
                    break;
                }
            }
        }

        return $validRedirect;
    }

initFromRequest()

ilAuthFrontendCredentialsApache::initFromRequest

(

)

Init credentials from request.

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

References $_SERVER, ilAuthProviderApache\APACHE_AUTH_TYPE_BY_FUNCTION, ilAuthProviderApache\APACHE_AUTH_TYPE_DIRECT_MAPPING, ilLogLevel\DEBUG, ilAuthFrontendCredentials\getLogger(), getSettings(), ApacheCustom\getUsername(), and ilAuthFrontendCredentials\setUsername().

    {
        $this->getLogger()->dump($_SERVER, ilLogLevel::DEBUG);
        $this->getLogger()->debug($this->getSettings()->get('apache_auth_username_direct_mapping_fieldname', ''));

        include_once './Services/AuthApache/classes/class.ilAuthProviderApache.php';

        switch ($this->getSettings()->get('apache_auth_username_config_type')) {
            case ilAuthProviderApache::APACHE_AUTH_TYPE_DIRECT_MAPPING:
                if (array_key_exists($this->getSettings()->get('apache_auth_username_direct_mapping_fieldname'), $_SERVER)) {
                    $this->setUsername($_SERVER[$this->getSettings()->get('apache_auth_username_direct_mapping_fieldname', '')]);
                }
                break;

            case ilAuthProviderApache::APACHE_AUTH_TYPE_BY_FUNCTION:
                include_once 'Services/AuthApache/classes/custom_username_func.php';
                $this->setUsername(ApacheCustom::getUsername());
                break;
        }
    }

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

References $_GET, $_SERVER, $path, defined, ilUtil\getHtmlPath(), getSettings(), IL_COOKIE_PATH, ilUtil\redirect(), and ilContext\supportsRedirects().

    {
        if (strcmp((string) $_REQUEST['cmd'], 'force_login') === 0) {
            return false;
        }

        if (!$this->getSettings()->get('apache_enable_auth', false)) {
            return false;
        }

        if (!$this->getSettings()->get('apache_auth_authenticate_on_login_page', false)) {
            return false;
        }

        if (
            !ilContext::supportsRedirects() ||
            isset($_GET['passed_sso']) ||
            (defined('IL_CERT_SSO') && IL_CERT_SSO == '1')
        ) {
            return false;
        }

        $path = $_SERVER['REQUEST_URI'];
        if (substr($path, 0, 1) === '/') {
            $path = substr($path, 1);
        }

        if (substr($path, 0, 4) !== 'http') {
            $parts = parse_url(ILIAS_HTTP_PATH);
            $path = $parts['scheme'] . '://' . $parts['host'] . '/' . $path;
        }

        ilUtil::redirect(
            ilUtil::getHtmlPath(
                './sso/index.php?force_mode_apache=1&' .
                'r=' . urlencode($path) .
                '&cookie_path=' . urlencode(IL_COOKIE_PATH) .
                '&ilias_path=' . urlencode(ILIAS_HTTP_PATH)
            )
        );
    }

Here is the call graph for this function:

Field Documentation

$settings

ilAuthFrontendCredentialsApache::$settings = null

private

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

Referenced by getSettings().

---

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

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