ilAuthApache Class Reference

Apache based authentication More...

Inheritance diagram for ilAuthApache:

Collaboration diagram for ilAuthApache:

Public Member Functions
	supportsRedirects ()
	Returns true, if the current auth mode allows redirection to e.g to loginScreen, public section... More...
	__construct ($storageDriver, $options='', $loginFunction='', $showLogin=true)
	Contructor. More...
	login ()

Private Attributes
	$apache_settings

Additional Inherited Members
Static Public Member Functions inherited from SimpleSAML\Utils\Auth
static	getAdminLoginURL ($returnTo=null)
	Retrieve a admin login URL. More...
static	isAdmin ()
	Check whether the current user is admin. More...
static	requireAdmin ()
	Require admin access to the current page. More...

Detailed Description

Apache based authentication

Author

Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version

$id$

Definition at line 35 of file class.ilAuthApache.php.

Constructor & Destructor Documentation

__construct()

ilAuthApache::__construct	(		$storageDriver,
			$options = '',
			$loginFunction = '',
			$showLogin = true
	)

Contructor.

Returns

Parameters

object	$a_container
object	$a_addition_options,[optional]

Definition at line 55 of file class.ilAuthApache.php.

References $_POST, $_SERVER, $_SESSION, $lng, $options, APACHE_AUTH_TYPE_BY_FUNCTION, APACHE_AUTH_TYPE_DIRECT_MAPPING, APACHE_AUTH_TYPE_EXTENDED_MAPPING, AUTH_APACHE, defined, and ApacheCustom\getUsername().

    {
        global $lng;
        
        parent::__construct($storageDriver, $options, '', false);
        $this->setSessionName("_authhttp" . md5(CLIENT_ID));

        $this->apache_settings = new ilSetting('apache_auth');
        
        if (defined('IL_CERT_SSO') && IL_CERT_SSO) {
            // DO NOT DELETE!!!
            // faking post values is REQUIRED to avoid canceling of the
            // startup routines
            // $_POST['username'] = 'xxx';
            $_POST['password'] = 'yyy';
            $_POST['sendLogin'] = '1';
            $_POST['auth_mode'] = AUTH_APACHE;
            $_POST['cmd[butSubmit]'] = 'Submit';

            if ($_POST['username'] != 'anonymous') {
                switch ($this->apache_settings->get('apache_auth_username_config_type')) {
                                        case APACHE_AUTH_TYPE_DIRECT_MAPPING:
                                                $_POST['username'] = $_SERVER[$this->apache_settings->get('apache_auth_username_direct_mapping_fieldname')];
                                                break;
                                        case APACHE_AUTH_TYPE_EXTENDED_MAPPING:
                                                throw new ilException("APACHE_AUTH_TYPE_EXTENDED_MAPPING not yet implemented");
                                        case APACHE_AUTH_TYPE_BY_FUNCTION:
                                                include_once 'Services/AuthApache/classes/custom_username_func.php';
                                                $_POST['username'] = ApacheCustom::getUsername();
                                                break;
                                }
            }
        }

        if (defined('IL_CERT_SSO') && IL_CERT_SSO && !$_POST['username']) {
            $_POST['username'] = '§invalid';
            $_POST['password'] = 'anonymous';
            $_SESSION['username_invalid'] = true;
        }
            
        $this->initAuth();
    }

Here is the call graph for this function:

Member Function Documentation

login()

ilAuthApache::login

(

)

Definition at line 99 of file class.ilAuthApache.php.

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

    {
        $skipClasses = array('ilpasswordassistancegui', 'ilaccountregistrationgui');
        $skipFiles   = array('pwassist.php');
        if (in_array(strtolower($_REQUEST['cmdClass']), $skipClasses)) {
            return;
        } else {
            $script = pathinfo($_SERVER['PHP_SELF'], PATHINFO_BASENAME);
            if (in_array(strtolower($script), $skipFiles)) {
                return;
            }
        }
        if (
            !$this->apache_settings->get('apache_auth_authenticate_on_login_page') &&
            (
                preg_match('/.*login\.php$/', $_SERVER['SCRIPT_NAME']) ||
                ((in_array($_REQUEST['cmd'], array('showLogin', 'showTermsOfService')) || isset($_POST['change_lang_to'])) && strtolower($_REQUEST['cmdClass']) == 'ilstartupgui')
            )
        ) {
            return;
        }

        if (!$this->apache_settings->get('apache_auth_authenticate_on_login_page') && preg_match('/.*login\.php$/', $_SERVER['SCRIPT_NAME'])) {
            return;
        }
        
        if (ilContext::supportsRedirects() && !isset($_GET['passed_sso']) && (!defined('IL_CERT_SSO') || IL_CERT_SSO == false)) {

            // redirect to sso
            // this part is executed in default ilias context...

            $path = $_SERVER['REQUEST_URI'];

            if ($path{0} == '/') {
                $path = substr($path, 1);
            }

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

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

Here is the call graph for this function:

supportsRedirects()

ilAuthApache::supportsRedirects

(

)

Returns true, if the current auth mode allows redirection to e.g to loginScreen, public section...

Returns

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

    {
        return true;
    }

Field Documentation

$apache_settings

ilAuthApache::$apache_settings

private

Definition at line 37 of file class.ilAuthApache.php.

---

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

• Services/AuthApache/classes/class.ilAuthApache.php