Description of class class. More...

Inheritance diagram for ilAuthFrontendCredentialsApache:

Collaboration diagram for ilAuthFrontendCredentialsApache:

Public Member Functions
	__construct (ServerRequestInterface $httpRequest, \ilCtrl $ctrl)
	ilAuthFrontendCredentialsApache 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
	$httpRequest

	$ctrl

	$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; Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

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

Constructor & Destructor Documentation

◆ __construct()

ilAuthFrontendCredentialsApache::__construct	(	ServerRequestInterface	$httpRequest,
		\ilCtrl	$ctrl
	)

ilAuthFrontendCredentialsApache constructor.

Parameters

ServerRequestInterface	$httpRequest
\ilCtrl	$ctrl

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

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

     {
         $this->httpRequest = $httpRequest;
         $this->ctrl = $ctrl;
         parent::__construct();
 
         $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 91 of file class.ilAuthFrontendCredentialsApache.php.

References $settings.

Referenced by initFromRequest(), and tryAuthenticationOnLoginPage().

                                      : \ilSetting
     {
         return $this->settings;
     }

Here is the caller graph for this function:

◆ getTargetUrl()

ilAuthFrontendCredentialsApache::getTargetUrl ( )

Returns: string

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

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

◆ hasValidTargetUrl()

ilAuthFrontendCredentialsApache::hasValidTargetUrl ( )

Returns: bool

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

References $path.

                                         : bool
     {
         $targetUrl = trim((string) ($this->httpRequest->getQueryParams()['r'] ?? ''));
         if (0 == strlen($targetUrl)) {
             return false;
         }
 
         $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);
                 }
             }
         }
 
         $validator = new \ilWhiteListUrlValidator($targetUrl, $validDomains);
 
         return $validator->isValid();
     }

◆ initFromRequest()

ilAuthFrontendCredentialsApache::initFromRequest ( )

Init credentials from request.

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

References ilLogLevel\DEBUG, ilAuthFrontendCredentials\getLogger(), getSettings(), ApacheCustom\getUsername(), and ilAuthFrontendCredentials\setUsername().

     {
         $mappingFieldName = $this->getSettings()->get('apache_auth_username_direct_mapping_fieldname', '');
 
         $this->getLogger()->dump($this->httpRequest->getServerParams(), \ilLogLevel::DEBUG);
         $this->getLogger()->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((string) \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 41 of file class.ilAuthFrontendCredentialsApache.php.

References $path, ilUtil\getHtmlPath(), getSettings(), IL_COOKIE_PATH, and ilContext\supportsRedirects().

     {
         $cmd = (string) ($this->httpRequest->getQueryParams()['cmd'] ?? '');
         if ('' === $cmd) {
             $cmd = (string) ($this->httpRequest->getParsedBody()['cmd'] ?? '');
         }
 
         if ('force_login' === $cmd) {
             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($this->httpRequest->getQueryParams()['passed_sso']) ||
             (defined('IL_CERT_SSO') && IL_CERT_SSO == '1')
         ) {
             return false;
         }
 
         $path = (string) ($this->httpRequest->getServerParams()['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;
         }
 
         $this->ctrl->redirectToURL(
             \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

◆ $ctrl

ilAuthFrontendCredentialsApache::$ctrl

private

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

Referenced by __construct().

◆ $httpRequest

ilAuthFrontendCredentialsApache::$httpRequest

private

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

Referenced by __construct().

◆ $settings

ilAuthFrontendCredentialsApache::$settings = null

private

Definition at line 21 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

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getSettings()

◆ getTargetUrl()

◆ hasValidTargetUrl()

◆ initFromRequest()

◆ tryAuthenticationOnLoginPage()

Field Documentation

◆ $ctrl

◆ $httpRequest

◆ $settings