ilWebAccessChecker Class Reference

Class ilWebAccessChecker. More...

Collaboration diagram for ilWebAccessChecker:

Public Member Functions
	__construct (GlobalHttpState $httpState, CookieFactory $cookieFactory)
	ilWebAccessChecker constructor. More...
	check ()
	initILIAS ()
	isChecked ()
	setChecked ($checked)
	getPathObject ()
	setPathObject (ilWACPath $path_object)
	getDisposition ()
	setDisposition ($disposition)
	getOverrideMimetype ()
	setOverrideMimetype ($override_mimetype)
	isInitialized ()
	setInitialized ($initialized)
	isSendStatusCode ()
	setSendStatusCode ($send_status_code)
	isRevalidateFolderTokens ()
	setRevalidateFolderTokens ($revalidate_folder_tokens)
	getAppliedCheckingMethods ()
	setAppliedCheckingMethods (array $applied_checking_methods)

Static Public Member Functions
static	isUseSeperateLogfile ()
static	setUseSeperateLogfile ($use_seperate_logfile)

Data Fields
const	DISPOSITION = 'disposition'
const	STATUS_CODE = 'status_code'
const	REVALIDATE = 'revalidate'
const	CM_FILE_TOKEN = 1
const	CM_FOLDER_TOKEN = 2
const	CM_CHECKINGINSTANCE = 3
const	CM_SECFOLDER = 4

Protected Member Functions
	sendHeader ($message)
	checkPublicSection ()
	checkUser ()
	addAppliedCheckingMethod ($method)

Protected Attributes
	$applied_checking_methods = []

Private Attributes
	$http
	$cookieFactory
	$ressource_not_found

Detailed Description

Class ilWebAccessChecker.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version

1.0.0

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

Constructor & Destructor Documentation

__construct()

ilWebAccessChecker::__construct	(	GlobalHttpState	$httpState,
		CookieFactory	$cookieFactory
	)

ilWebAccessChecker constructor.

Parameters

GlobalHttpState	$httpState
CookieFactory	$cookieFactory

Definition at line 68 of file class.ilWebAccessChecker.php.

References $cookieFactory, Vendor\Package\$e, ILIAS\FileDelivery\http(), ilWACException\NOT_FOUND, ILIAS\HTTP\GlobalHttpState\request(), and setPathObject().

    {
        try {
            $this->setPathObject(new ilWACPath($httpState->request()->getRequestTarget()));
        } catch (ilWACException $e) {
            if ($e->getCode() !== ilWACException::NOT_FOUND) {
                throw $e;
            }
            $this->ressource_not_found = $e;
        }

        $this->http = $httpState;
        $this->cookieFactory = $cookieFactory;
    }

Here is the call graph for this function:

Member Function Documentation

addAppliedCheckingMethod()

ilWebAccessChecker::addAppliedCheckingMethod (   $method )

protected

Parameters

int

$method

Returns

void

Definition at line 468 of file class.ilWebAccessChecker.php.

References $DIC, ANONYMOUS_USER_ID, ilContext\CONTEXT_WAC, ilContext\init(), and ilInitialisation\reinitILIAS().

Referenced by check().

    {
        assert(is_int($method));
        $this->applied_checking_methods[] = $method;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

check()

ilWebAccessChecker::check

(

)

Returns

bool

Exceptions

ilWACException

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

References addAppliedCheckingMethod(), CLIENT_WEB_DIR, ilWACException\CODE_NO_PATH, getPathObject(), ilWACSecurePath\hasCheckingInstanceRegistered(), ILIAS\FileDelivery\http(), initILIAS(), isRevalidateFolderTokens(), ilWACException\NOT_FOUND, sendHeader(), and setChecked().

Referenced by ilWebAccessCheckerDelivery\handleRequest(), ilWACCheckingInstanceTest\testBasic(), and ilWACCheckingInstanceTest\testNonCheckingInstanceNoSec().

    {
        if ($this->getPathObject() === null) {
            if ($this->ressource_not_found !== null) {
                throw new ilWACException(ilWACException::NOT_FOUND, '', $this->ressource_not_found);
            }

            throw new ilWACException(ilWACException::CODE_NO_PATH);
        }

        // Check if Path has been signed with a token
        $ilWACSignedPath = new ilWACSignedPath($this->getPathObject(), $this->http, $this->cookieFactory);
        if ($ilWACSignedPath->isSignedPath()) {
            $this->addAppliedCheckingMethod(self::CM_FILE_TOKEN);
            if ($ilWACSignedPath->isSignedPathValid()) {
                $this->setChecked(true);
                $this->sendHeader('checked using token');

                return true;
            }
        }

        // Check if the whole secured folder has been signed
        if ($ilWACSignedPath->isFolderSigned()) {
            $this->addAppliedCheckingMethod(self::CM_FOLDER_TOKEN);
            if ($ilWACSignedPath->isFolderTokenValid()) {
                if ($this->isRevalidateFolderTokens()) {
                    $ilWACSignedPath->revalidatingFolderToken();
                }
                $this->setChecked(true);
                $this->sendHeader('checked using secure folder');

                return true;
            }
        }

        // Fallback, have to initiate ILIAS
        $this->initILIAS();

        // Check if Path is within accepted paths
        if ($this->getPathObject()->getModuleType() !== 'rs') {
            $clean_path = $this->getPathObject()->getCleanURLdecodedPath();
            $path = realpath($clean_path);
            $data_dir = realpath(CLIENT_WEB_DIR);
            if (strpos($path, (string) $data_dir) !== 0) {
                return false;
            }
            if (dirname($path) === $data_dir && is_file($path)) {
                return false;
            }
        }

        if (ilWACSecurePath::hasCheckingInstanceRegistered($this->getPathObject())) {
            // Maybe the path has been registered, lets check
            $checkingInstance = ilWACSecurePath::getCheckingInstance($this->getPathObject());
            $this->addAppliedCheckingMethod(self::CM_CHECKINGINSTANCE);
            $canBeDelivered = $checkingInstance->canBeDelivered($this->getPathObject());
            if ($canBeDelivered) {
                $this->sendHeader('checked using fallback');
                if ($ilWACSignedPath->isFolderSigned() && $this->isRevalidateFolderTokens()) {
                    $ilWACSignedPath->revalidatingFolderToken();
                }

                $this->setChecked(true);

                return true;
            } else {
                $this->setChecked(true);

                return false;
            }
        }

        // none of the checking mechanisms could have been applied. no access
        $this->setChecked(true);
        if ($this->getPathObject()->isInSecFolder()) {
            $this->addAppliedCheckingMethod(self::CM_SECFOLDER);

            return false;
        } else {
            $this->addAppliedCheckingMethod(self::CM_SECFOLDER);

            return true;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkPublicSection()

ilWebAccessChecker::checkPublicSection ( )

protected

Returns

void

Exceptions

ilWACException

Definition at line 242 of file class.ilWebAccessChecker.php.

References $DIC, ilWACException\ACCESS_DENIED_NO_PUB, and ANONYMOUS_USER_ID.

Referenced by initILIAS().

    {
        global $DIC;
        $is_anonymous = ((int) $DIC->user()->getId() === (int) ANONYMOUS_USER_ID);
        $is_null_user = ($DIC->user()->getId() === 0);
        $pub_section_activated = (bool) $DIC['ilSetting']->get('pub_section');
        $isset = isset($DIC['ilSetting']);
        $instanceof = $DIC['ilSetting'] instanceof ilSetting;

        if (!$isset || !$instanceof) {
            throw new ilWACException(ilWACException::ACCESS_DENIED_NO_PUB);
        }

        if ($pub_section_activated && ($is_null_user || $is_anonymous)) {
            // Request is initiated from an enabled public area
            return;
        }

        if ($is_anonymous || $is_null_user) {
            throw new ilWACException(ilWACException::ACCESS_DENIED_NO_PUB);
        }
    }

Here is the caller graph for this function:

checkUser()

ilWebAccessChecker::checkUser ( )

protected

Definition at line 266 of file class.ilWebAccessChecker.php.

References $DIC, and ilWACException\ACCESS_DENIED_NO_LOGIN.

Referenced by initILIAS().

    {
        global $DIC;

        $is_user = $DIC->user() instanceof ilObjUser;
        $user_id_is_zero = ((int) $DIC->user()->getId() === 0);
        if (!$is_user || $user_id_is_zero) {
            throw new ilWACException(ilWACException::ACCESS_DENIED_NO_LOGIN);
        }
    }

Here is the caller graph for this function:

getAppliedCheckingMethods()

ilWebAccessChecker::getAppliedCheckingMethods

(

)

Returns

int[]

Definition at line 446 of file class.ilWebAccessChecker.php.

References $applied_checking_methods.

    {
        return (array) $this->applied_checking_methods;
    }

getDisposition()

ilWebAccessChecker::getDisposition

(

)

Returns

string

Definition at line 322 of file class.ilWebAccessChecker.php.

Referenced by ilWebAccessCheckerDelivery\deliver(), ilWebAccessCheckerDelivery\deliverDummyImage(), and ilWebAccessCheckerDelivery\deliverDummyVideo().

    {
        return (string) $this->disposition;
    }

Here is the caller graph for this function:

getOverrideMimetype()

ilWebAccessChecker::getOverrideMimetype

(

)

Returns

string

Definition at line 343 of file class.ilWebAccessChecker.php.

    {
        return (string) $this->override_mimetype;
    }

getPathObject()

ilWebAccessChecker::getPathObject

(

)

Returns

ilWACPath

Definition at line 302 of file class.ilWebAccessChecker.php.

Referenced by check(), ilWebAccessCheckerDelivery\deliver(), ilWebAccessCheckerDelivery\handleAccessErrors(), and initILIAS().

    {
        return $this->path_object;
    }

Here is the caller graph for this function:

initILIAS()

ilWebAccessChecker::initILIAS

(

)

Returns

void

Definition at line 190 of file class.ilWebAccessChecker.php.

References $DIC, Vendor\Package\$e, $GLOBALS, $response, ilWACException\ACCESS_DENIED_NO_LOGIN, ANONYMOUS_USER_ID, checkPublicSection(), checkUser(), ilContext\CONTEXT_WAC, getPathObject(), ILIAS\FileDelivery\http(), ilContext\init(), ilInitialisation\initILIAS(), isInitialized(), and setInitialized().

Referenced by check(), and ilWebAccessCheckerDelivery\handleAccessErrors().

    {
        global $DIC;

        if ($this->isInitialized()) {
            return;
        }

        $GLOBALS['COOKIE_PATH'] = '/';

        $cookie = $this->cookieFactory->create('ilClientId', $this->getPathObject()->getClient())
                                      ->withPath('/')
                                      ->withExpires(0);

        $response = $this->http->cookieJar()
                               ->with($cookie)
                               ->renderIntoResponseHeader($this->http->response());

        $this->http->saveResponse($response);

        ilContext::init(ilContext::CONTEXT_WAC);
        try {
            ilInitialisation::initILIAS();
            $this->checkUser();
            $this->checkPublicSection();
        } catch (Exception $e) {
            if ($e instanceof ilWACException
                && $e->getCode() !== ilWACException::ACCESS_DENIED_NO_LOGIN) {
                throw  $e;
            }
            if (($e instanceof Exception && $e->getMessage() == 'Authentication failed.')
                || $e->getCode() === ilWACException::ACCESS_DENIED_NO_LOGIN) {
                $this->initAnonymousSession();
                $this->checkUser();
                $this->checkPublicSection();
            }
        }
        $this->setInitialized(true);

        // This workaround is needed because these issues:
        // https://mantis.ilias.de/view.php?id=32284 and
        // https://mantis.ilias.de/view.php?id=32063
        if ($DIC->user()->getId() === 0) {
            $DIC->user()->setId(ANONYMOUS_USER_ID);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isChecked()

ilWebAccessChecker::isChecked

(

)

Returns

bool

Definition at line 281 of file class.ilWebAccessChecker.php.

Referenced by ilWebAccessCheckerDelivery\deliver(), and ilWebAccessCheckerDelivery\deny().

    {
        return (bool) $this->checked;
    }

Here is the caller graph for this function:

isInitialized()

ilWebAccessChecker::isInitialized

(

)

Returns

bool

Definition at line 364 of file class.ilWebAccessChecker.php.

Referenced by initILIAS().

    {
        return (bool) $this->initialized;
    }

Here is the caller graph for this function:

isRevalidateFolderTokens()

ilWebAccessChecker::isRevalidateFolderTokens

(

)

Returns

bool

Definition at line 404 of file class.ilWebAccessChecker.php.

Referenced by check().

    {
        return (bool) $this->revalidate_folder_tokens;
    }

Here is the caller graph for this function:

isSendStatusCode()

ilWebAccessChecker::isSendStatusCode

(

)

Returns

bool

Definition at line 383 of file class.ilWebAccessChecker.php.

    {
        return (bool) $this->send_status_code;
    }

isUseSeperateLogfile()

static ilWebAccessChecker::isUseSeperateLogfile ( )

static

Returns

bool

Definition at line 425 of file class.ilWebAccessChecker.php.

    {
        return (bool) self::$use_seperate_logfile;
    }

sendHeader()

ilWebAccessChecker::sendHeader (   $message )

protected

Parameters

string

$message

Returns

void

Definition at line 180 of file class.ilWebAccessChecker.php.

References $message, $response, and ILIAS\FileDelivery\http().

Referenced by check().

    {
        $response = $this->http->response()->withHeader('X-ILIAS-WebAccessChecker', $message);
        $this->http->saveResponse($response);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setAppliedCheckingMethods()

ilWebAccessChecker::setAppliedCheckingMethods

(

array

$applied_checking_methods

)

Parameters

int[]

$applied_checking_methods

Returns

void

Definition at line 457 of file class.ilWebAccessChecker.php.

References $applied_checking_methods.

    {
        $this->applied_checking_methods = $applied_checking_methods;
    }

setChecked()

ilWebAccessChecker::setChecked

(

$checked

)

Parameters

boolean

$checked

Returns

void

Definition at line 292 of file class.ilWebAccessChecker.php.

Referenced by check().

    {
        assert(is_bool($checked));
        $this->checked = $checked;
    }

Here is the caller graph for this function:

setDisposition()

ilWebAccessChecker::setDisposition

(

$disposition

)

Parameters

string

$disposition

Returns

void

Definition at line 333 of file class.ilWebAccessChecker.php.

Referenced by ilWebAccessCheckerDelivery\handleRequest().

    {
        assert(is_string($disposition));
        $this->disposition = $disposition;
    }

Here is the caller graph for this function:

setInitialized()

ilWebAccessChecker::setInitialized

(

$initialized

)

Parameters

bool

$initialized

Definition at line 373 of file class.ilWebAccessChecker.php.

Referenced by initILIAS().

    {
        assert(is_bool($initialized));
        $this->initialized = $initialized;
    }

Here is the caller graph for this function:

setOverrideMimetype()

ilWebAccessChecker::setOverrideMimetype

(

$override_mimetype

)

Parameters

string

$override_mimetype

Returns

void

Definition at line 354 of file class.ilWebAccessChecker.php.

    {
        assert(is_string($override_mimetype));
        $this->override_mimetype = $override_mimetype;
    }

setPathObject()

ilWebAccessChecker::setPathObject

(

ilWACPath

$path_object

)

Parameters

ilWACPath

$path_object

Returns

void

Definition at line 313 of file class.ilWebAccessChecker.php.

Referenced by __construct().

    {
        $this->path_object = $path_object;
    }

Here is the caller graph for this function:

setRevalidateFolderTokens()

ilWebAccessChecker::setRevalidateFolderTokens

(

$revalidate_folder_tokens

)

Parameters

bool

$revalidate_folder_tokens

Returns

void

Definition at line 415 of file class.ilWebAccessChecker.php.

Referenced by ilWebAccessCheckerDelivery\handleRequest().

    {
        assert(is_bool($revalidate_folder_tokens));
        $this->revalidate_folder_tokens = $revalidate_folder_tokens;
    }

Here is the caller graph for this function:

setSendStatusCode()

ilWebAccessChecker::setSendStatusCode

(

$send_status_code

)

Parameters

bool

$send_status_code

Returns

void

Definition at line 394 of file class.ilWebAccessChecker.php.

Referenced by ilWebAccessCheckerDelivery\handleRequest().

    {
        assert(is_bool($send_status_code));
        $this->send_status_code = $send_status_code;
    }

Here is the caller graph for this function:

setUseSeperateLogfile()

static ilWebAccessChecker::setUseSeperateLogfile (   $use_seperate_logfile )

static

Parameters

bool

$use_seperate_logfile

Returns

void

Definition at line 436 of file class.ilWebAccessChecker.php.

    {
        assert(is_bool($use_seperate_logfile));
        self::$use_seperate_logfile = $use_seperate_logfile;
    }

Field Documentation

$applied_checking_methods

ilWebAccessChecker::$applied_checking_methods = []

protected

Definition at line 48 of file class.ilWebAccessChecker.php.

Referenced by getAppliedCheckingMethods(), and setAppliedCheckingMethods().

$cookieFactory

ilWebAccessChecker::$cookieFactory

private

Definition at line 56 of file class.ilWebAccessChecker.php.

Referenced by __construct().

$http

ilWebAccessChecker::$http

private

Definition at line 52 of file class.ilWebAccessChecker.php.

$ressource_not_found

ilWebAccessChecker::$ressource_not_found

private

Definition at line 60 of file class.ilWebAccessChecker.php.

CM_CHECKINGINSTANCE

const ilWebAccessChecker::CM_CHECKINGINSTANCE = 3

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

CM_FILE_TOKEN

const ilWebAccessChecker::CM_FILE_TOKEN = 1

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

CM_FOLDER_TOKEN

const ilWebAccessChecker::CM_FOLDER_TOKEN = 2

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

CM_SECFOLDER

const ilWebAccessChecker::CM_SECFOLDER = 4

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

DISPOSITION

const ilWebAccessChecker::DISPOSITION = 'disposition'

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

Referenced by ilWebAccessCheckerDelivery\handleRequest().

REVALIDATE

const ilWebAccessChecker::REVALIDATE = 'revalidate'

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

Referenced by ilWebAccessCheckerDelivery\handleRequest().

STATUS_CODE

const ilWebAccessChecker::STATUS_CODE = 'status_code'

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

Referenced by ilWebAccessCheckerDelivery\handleRequest().

---

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

• Services/WebAccessChecker/classes/class.ilWebAccessChecker.php