This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilHTTPS:

Public Member Functions
	__construct ()

	isDetected ()
	check if https is detected More...

	checkHTTPS (int $port=443)

	enableSecureCookies ()

	checkProtocolAndRedirectIfNeeded ()

Data Fields
const	SETTINGS_GROUP_SERVER = 'server'

const	SETTING_HTTP_PATH = 'http_path'

const	SETTINGS_GROUP_HTTPS = 'https'

const	SETTING_AUTO_HTTPS_DETECT_ENABLED = "auto_https_detect_enabled"

const	SETTING_AUTO_HTTPS_DETECT_HEADER_NAME = "auto_https_detect_header_name"

const	SETTING_AUTO_HTTPS_DETECT_HEADER_VALUE = "auto_https_detect_header_value"

const	SETTING_FORCED = 'forced'

Protected Attributes
const	PROTOCOL_HTTP = 1

const	PROTOCOL_HTTPS = 2

bool	$enabled = false

array	$protected_classes = []

array	$protected_scripts = []

bool	$automatic_detection = false

string	$header_name = null

string	$header_value = null

ilIniFile	$ilias_ini

ilIniFile	$client_ini

Private Member Functions
	readProtectedScripts ()

	readProtectedClasses ()

	shouldSwitchProtocol ($to_protocol)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilHTTPS

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

     Find usages: (((DIC|GLOBALS)\[['"]https.*)|(global .* $https))

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

Constructor & Destructor Documentation

◆ __construct()

ilHTTPS::__construct ( )

Definition at line 45 of file class.ilHTTPS.php.

    {
        global $DIC;
        $this->ilias_ini = $DIC->iliasIni();
        $this->client_ini = $DIC->clientIni();
 
        if ($this->enabled = (bool) $this->ilias_ini->readVariable(
            self::SETTINGS_GROUP_HTTPS,
            self::SETTING_FORCED
        )) {
            $this->readProtectedScripts();
            $this->readProtectedClasses();
        }
 
        if ($this->automatic_detection = (bool) $this->ilias_ini->readVariable(
            self::SETTINGS_GROUP_HTTPS,
            self::SETTING_AUTO_HTTPS_DETECT_ENABLED
        )) {
            $this->header_name = $this->ilias_ini->readVariable(
                self::SETTINGS_GROUP_HTTPS,
                self::SETTING_AUTO_HTTPS_DETECT_HEADER_NAME
            );
            $this->header_value = $this->ilias_ini->readVariable(
                self::SETTINGS_GROUP_HTTPS,
                self::SETTING_AUTO_HTTPS_DETECT_HEADER_VALUE
            );
        }
    }

References $DIC, readProtectedClasses(), and readProtectedScripts().

Here is the call graph for this function:

Member Function Documentation

◆ checkHTTPS()

ilHTTPS::checkHTTPS ( int $port = 443 )

Definition at line 116 of file class.ilHTTPS.php.

                                               : bool
    {
        if (($sp = fsockopen($_SERVER["SERVER_NAME"], $port, $errno, $error)) === false) {
            return false;
        }
        fclose($sp);
        return true;
    }

References $_SERVER.

◆ checkProtocolAndRedirectIfNeeded()

ilHTTPS::checkProtocolAndRedirectIfNeeded ( )

Definition at line 144 of file class.ilHTTPS.php.

                                                      : bool
    {
        // if https is enabled for scripts or classes, check for redirection
        if ($this->enabled) {
            if ($this->shouldSwitchProtocol(self::PROTOCOL_HTTPS)) {
                header("location: https://" . $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"]);
                exit;
            }
            if ($this->shouldSwitchProtocol(self::PROTOCOL_HTTP)) {
                header("location: http://" . $_SERVER["SERVER_NAME"] . $_SERVER["REQUEST_URI"]);
                exit;
            }
        }
        return true;
    }

References $_SERVER, exit, ILIAS\UI\examples\Symbol\Glyph\Header\header(), and shouldSwitchProtocol().

Here is the call graph for this function:

◆ enableSecureCookies()

ilHTTPS::enableSecureCookies ( )

Definition at line 125 of file class.ilHTTPS.php.

                                         : void
    {
        $secure_disabled = (bool) $this->client_ini->readVariable('session', 'disable_secure_cookies');
        if (!$secure_disabled && !$this->enabled && $this->isDetected() && !session_id()) {
            if (!defined('IL_COOKIE_SECURE')) {
                define('IL_COOKIE_SECURE', true);
            }
 
            session_set_cookie_params([
                'lifetime' => IL_COOKIE_EXPIRE,
                'path' => IL_COOKIE_PATH,
                'domain' => IL_COOKIE_DOMAIN,
                'secure' => IL_COOKIE_SECURE,
                'httponly' => true,
                'samesite' => (strtolower(session_get_cookie_params()['samesite'] ?? '')) === 'strict' ? session_get_cookie_params()['samesite'] : 'Lax'
            ]);
        }
    }

References IL_COOKIE_PATH, and isDetected().

Here is the call graph for this function:

◆ isDetected()

ilHTTPS::isDetected ( )

check if https is detected

Returns: bool, if https is detected by protocol or by automatic detection, if enabled, false otherwise

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

                                : bool
    {
        if (isset($_SERVER["HTTPS"]) && $_SERVER["HTTPS"] === "on") {
            return true;
        }
 
        if ($this->automatic_detection) {
            $header_name = "HTTP_" . str_replace("-", "_", strtoupper($this->header_name));
            /* echo $header_name;
             echo $_SERVER[$header_name];*/
            if (isset($_SERVER[$header_name])) {
                if (strcasecmp($_SERVER[$header_name], $this->header_value) === 0) {
                    $_SERVER["HTTPS"] = "on";
                    return true;
                }
            }
        }
 
        return false;
    }

References $_SERVER, and $header_name.

Referenced by enableSecureCookies().

Here is the caller graph for this function:

◆ readProtectedClasses()

ilHTTPS::readProtectedClasses ( )

private

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

                                           : void
    {
        $this->protected_classes[] = 'ilstartupgui';
        $this->protected_classes[] = 'ilaccountregistrationgui';
        $this->protected_classes[] = 'ilpersonalsettingsgui';
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ readProtectedScripts()

ilHTTPS::readProtectedScripts ( )

private

Definition at line 74 of file class.ilHTTPS.php.

                                           : void
    {
        $this->protected_scripts[] = 'login.php';
        $this->protected_scripts[] = 'index.php';
        $this->protected_scripts[] = 'register.php';
        $this->protected_scripts[] = 'webdav.php';
        $this->protected_scripts[] = 'shib_login.php';
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ shouldSwitchProtocol()

ilHTTPS::shouldSwitchProtocol ( $to_protocol )

private

Definition at line 160 of file class.ilHTTPS.php.

                                                       : bool
    {
        switch ($to_protocol) {
            case self::PROTOCOL_HTTP:
                return (
                    !in_array(basename($_SERVER['SCRIPT_NAME']), $this->protected_scripts) &&
                    !in_array(strtolower($_GET['cmdClass']), $this->protected_classes)
                ) && $_SERVER['HTTPS'] === 'on';
 
            case self::PROTOCOL_HTTPS:
                return (
                    in_array(basename($_SERVER['SCRIPT_NAME']), $this->protected_scripts) ||
                    in_array(strtolower($_GET['cmdClass']), $this->protected_classes)
                ) && $_SERVER['HTTPS'] !== 'on';
        }
 
        return false;
    }

References $_GET, $_SERVER, PROTOCOL_HTTP, and PROTOCOL_HTTPS.

Referenced by checkProtocolAndRedirectIfNeeded().

Here is the caller graph for this function:

Field Documentation

◆ $automatic_detection

bool ilHTTPS::$automatic_detection = false

protected

Definition at line 39 of file class.ilHTTPS.php.

◆ $client_ini

ilIniFile ilHTTPS::$client_ini

protected

Definition at line 43 of file class.ilHTTPS.php.

◆ $enabled

bool ilHTTPS::$enabled = false

protected

Definition at line 36 of file class.ilHTTPS.php.

◆ $header_name

string ilHTTPS::$header_name = null

protected

Definition at line 40 of file class.ilHTTPS.php.

Referenced by isDetected().

◆ $header_value

string ilHTTPS::$header_value = null

protected

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

◆ $ilias_ini

ilIniFile ilHTTPS::$ilias_ini

protected

Definition at line 42 of file class.ilHTTPS.php.

◆ $protected_classes

array ilHTTPS::$protected_classes = []

protected

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

◆ $protected_scripts

array ilHTTPS::$protected_scripts = []

protected

Definition at line 38 of file class.ilHTTPS.php.

◆ PROTOCOL_HTTP

const ilHTTPS::PROTOCOL_HTTP = 1

protected

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

Referenced by shouldSwitchProtocol().

◆ PROTOCOL_HTTPS

const ilHTTPS::PROTOCOL_HTTPS = 2

protected

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

Referenced by shouldSwitchProtocol().

◆ SETTING_AUTO_HTTPS_DETECT_ENABLED

const ilHTTPS::SETTING_AUTO_HTTPS_DETECT_ENABLED = "auto_https_detect_enabled"

Definition at line 32 of file class.ilHTTPS.php.

Referenced by ilHttpConfigStoredObjective\achieve(), and ilHttpConfigStoredObjective\isApplicable().

◆ SETTING_AUTO_HTTPS_DETECT_HEADER_NAME

const ilHTTPS::SETTING_AUTO_HTTPS_DETECT_HEADER_NAME = "auto_https_detect_header_name"

Definition at line 33 of file class.ilHTTPS.php.

Referenced by ilHttpConfigStoredObjective\achieve(), and ilHttpConfigStoredObjective\isApplicable().

◆ SETTING_AUTO_HTTPS_DETECT_HEADER_VALUE

const ilHTTPS::SETTING_AUTO_HTTPS_DETECT_HEADER_VALUE = "auto_https_detect_header_value"

Definition at line 34 of file class.ilHTTPS.php.

Referenced by ilHttpConfigStoredObjective\achieve(), and ilHttpConfigStoredObjective\isApplicable().

◆ SETTING_FORCED

const ilHTTPS::SETTING_FORCED = 'forced'

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

Referenced by ilHttpConfigStoredObjective\achieve(), and ilHttpConfigStoredObjective\isApplicable().

◆ SETTING_HTTP_PATH

const ilHTTPS::SETTING_HTTP_PATH = 'http_path'

Definition at line 30 of file class.ilHTTPS.php.

Referenced by ilHttpConfigStoredObjective\achieve(), and ilHttpConfigStoredObjective\isApplicable().

◆ SETTINGS_GROUP_HTTPS

const ilHTTPS::SETTINGS_GROUP_HTTPS = 'https'

Definition at line 31 of file class.ilHTTPS.php.

Referenced by ilHttpConfigStoredObjective\achieve(), and ilHttpConfigStoredObjective\isApplicable().

◆ SETTINGS_GROUP_SERVER

const ilHTTPS::SETTINGS_GROUP_SERVER = 'server'

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

Referenced by ilHttpConfigStoredObjective\achieve(), and ilHttpConfigStoredObjective\isApplicable().

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

components/ILIAS/Http_/classes/class.ilHTTPS.php

Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkHTTPS()

◆ checkProtocolAndRedirectIfNeeded()

◆ enableSecureCookies()

◆ isDetected()

◆ readProtectedClasses()

◆ readProtectedScripts()

◆ shouldSwitchProtocol()

Field Documentation

◆ $automatic_detection

◆ $client_ini

◆ $enabled

◆ $header_name

◆ $header_value

◆ $ilias_ini

◆ $protected_classes

◆ $protected_scripts

◆ PROTOCOL_HTTP

◆ PROTOCOL_HTTPS

◆ SETTING_AUTO_HTTPS_DETECT_ENABLED

◆ SETTING_AUTO_HTTPS_DETECT_HEADER_NAME

◆ SETTING_AUTO_HTTPS_DETECT_HEADER_VALUE

◆ SETTING_FORCED

◆ SETTING_HTTP_PATH

◆ SETTINGS_GROUP_HTTPS

◆ SETTINGS_GROUP_SERVER