ilWACSignedPath Class Reference

Class ilWACSignedPath. More...

Collaboration diagram for ilWACSignedPath:

Public Member Functions
	__construct (ilWACPath $ilWACPath, private GlobalHttpState $httpService, private CookieFactory $cookieFactory)
	ilWACSignedPath constructor. More...
	getSignedPath ()
	isFolderSigned ()
	isFolderTokenValid ()
	revalidatingFolderToken ()
	isSignedPath ()
	isSignedPathValid ()
	getTokenInstance ()
	setTokenInstance (ilWACToken $token_instance)
	getType ()
	setType (int $type)
	getPathObject ()
	setPathObject (ilWACPath $path_object)
	buildAndSetTokenInstance (int $timestamp=0, int $ttl=0)
	isChecked ()
	setChecked (bool $checked)

Static Public Member Functions
static	signFile (string $path_to_file)
static	signFolderOfStartFile (string $start_file_path)
static	getTokenMaxLifetimeInSeconds ()
static	setTokenMaxLifetimeInSeconds (int $token_max_lifetime_in_seconds)
static	getCookieMaxLifetimeInSeconds ()
static	setCookieMaxLifetimeInSeconds (int $cookie_max_lifetime_in_seconds)

Data Fields
const	WAC_TOKEN_ID = 'il_wac_token'
const	WAC_TIMESTAMP_ID = 'il_wac_ts'
const	WAC_TTL_ID = 'il_wac_ttl'
const	TS_SUFFIX = 'ts'
const	TTL_SUFFIX = 'ttl'
const	MAX_LIFETIME = 600

Protected Member Functions
	saveFolderToken ()
	checkToken ()
	buildTokenInstance (int $timestamp=0, int $ttl=0)
	getRelevantLifeTime ()

Protected Attributes
ilWACPath	$path_object = null
ilWACToken	$token_instance = null
int	$type = PathType::FILE
bool	$checked = false

Static Protected Attributes
static int	$token_max_lifetime_in_seconds = 5
static int	$cookie_max_lifetime_in_seconds = 300

Detailed Description

Class ilWACSignedPath.

Author

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

Version

1.0.0

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

Constructor & Destructor Documentation

__construct()

ilWACSignedPath::__construct	(	ilWACPath	$ilWACPath,
		private GlobalHttpState	$httpService,
		private CookieFactory	$cookieFactory
	)

ilWACSignedPath constructor.

Definition at line 50 of file class.ilWACSignedPath.php.

References setPathObject().

    {
        $this->setPathObject($ilWACPath);
    }

Here is the call graph for this function:

Member Function Documentation

buildAndSetTokenInstance()

ilWACSignedPath::buildAndSetTokenInstance	(	int	$timestamp = 0,
		int	$ttl = 0
	)

Exceptions

Definition at line 325 of file class.ilWACSignedPath.php.

References $timestamp, buildTokenInstance(), and setTokenInstance().

Referenced by isFolderSigned(), isSignedPathValid(), and revalidatingFolderToken().

                                                                              : void
    {
        $this->setTokenInstance($this->buildTokenInstance($timestamp, $ttl));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildTokenInstance()

ilWACSignedPath::buildTokenInstance ( int  $timestamp = 0, int  $ttl = 0  )

protected

Exceptions

ilWACException

Definition at line 303 of file class.ilWACSignedPath.php.

References $client, $path, $timestamp, ilWACException\CODE_NO_TYPE, getPathObject(), and getType().

Referenced by buildAndSetTokenInstance(), checkToken(), and isFolderSigned().

                                                                           : \ilWACToken
    {
        if ($this->getType() === 0) {
            throw new ilWACException(ilWACException::CODE_NO_TYPE);
        }

        $path = match ($this->getType()) {
            PathType::FOLDER => $this->getPathObject()->getSecurePath(),
            default => $this->getPathObject()->getPathWithoutQuery(),
        };

        $client = $this->getPathObject()->getClient();
        $timestamp = $timestamp !== 0 ? $timestamp : $this->getPathObject()->getTimestamp();
        $ttl = $ttl !== 0 ? $ttl : $this->getPathObject()->getTTL();

        return new ilWACToken($path, $client, $timestamp, $ttl);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkToken()

ilWACSignedPath::checkToken ( )

protected

Exceptions

Definition at line 271 of file class.ilWACSignedPath.php.

References buildTokenInstance(), getPathObject(), and setChecked().

Referenced by isFolderTokenValid(), and isSignedPathValid().

                                   : bool
    {
        $request_token_string = $this->getPathObject()->getToken();
        $request_ttl = $this->getPathObject()->getTTL();
        $request_timestamp = $this->getPathObject()->getTimestamp();
        $current_timestamp = time();

        $timestamp_valid = ($current_timestamp < ($request_timestamp + $request_ttl));

        if (!$timestamp_valid) {
            $this->setChecked(true);

            return false;
        }

        $simulated_token = $this->buildTokenInstance($request_timestamp, $request_ttl);
        $simulated_token_string = $simulated_token->getToken();
        $token_valid = ($simulated_token_string === $request_token_string);

        if (!$token_valid) {
            $this->setChecked(true);

            return false;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCookieMaxLifetimeInSeconds()

static ilWACSignedPath::getCookieMaxLifetimeInSeconds ( )

static

Definition at line 347 of file class.ilWACSignedPath.php.

Referenced by ilObjSCORMInitData\getIliasScormVars(), and ilSCORM13PlayerGUI\getPlayer().

                                                          : int
    {
        return self::$cookie_max_lifetime_in_seconds;
    }

Here is the caller graph for this function:

getPathObject()

ilWACSignedPath::getPathObject

(

)

Definition at line 258 of file class.ilWACSignedPath.php.

References $path_object.

Referenced by buildTokenInstance(), checkToken(), getRelevantLifeTime(), getSignedPath(), isFolderSigned(), isSignedPath(), isSignedPathValid(), revalidatingFolderToken(), and saveFolderToken().

                                   : ?\ilWACPath
    {
        return $this->path_object;
    }

Here is the caller graph for this function:

getRelevantLifeTime()

ilWACSignedPath::getRelevantLifeTime ( )

protected

Definition at line 365 of file class.ilWACSignedPath.php.

References getPathObject(), and getType().

                                            : int
    {
        $request_ttl = $this->getPathObject()->getTTL();
        if ($request_ttl > 0) {
            return $request_ttl;
        }

        return match ($this->getType()) {
            PathType::FOLDER => self::getCookieMaxLifetimeInSeconds(),
            PathType::FILE => self::getTokenMaxLifetimeInSeconds(),
            default => 0,
        };
    }

Here is the call graph for this function:

getSignedPath()

ilWACSignedPath::getSignedPath

(

)

Exceptions

ilWACException

Definition at line 58 of file class.ilWACSignedPath.php.

References $path, getPathObject(), getTokenInstance(), getType(), and ilWACException\WRONG_PATH_TYPE.

                                   : string
    {
        if ($this->getType() !== PathType::FILE) {
            throw new ilWACException(ilWACException::WRONG_PATH_TYPE);
        }
        if ($this->getPathObject()->getOriginalRequest() === '' || $this->getPathObject()->getOriginalRequest() === '0') {
            return '';
        }
        if (!$this->getPathObject()->fileExists()) {
            //                  return $this->getPathObject()->getOriginalRequest();
        }

        if (strpos($this->getPathObject()->getPath(), '?')) {
            $path = $this->getPathObject()->getPath() . '&' . self::WAC_TOKEN_ID . '='
                . $this->getTokenInstance()->getToken();
        } else {
            $path = $this->getPathObject()->getPath() . '?' . self::WAC_TOKEN_ID . '='
                . $this->getTokenInstance()->getToken();
        }

        $path .= '&' . self::WAC_TTL_ID . '=' . $this->getTokenInstance()->getTTL();

        return $path . '&' . self::WAC_TIMESTAMP_ID . '='
            . $this->getTokenInstance()->getTimestamp();
    }

Here is the call graph for this function:

getTokenInstance()

ilWACSignedPath::getTokenInstance

(

)

Definition at line 238 of file class.ilWACSignedPath.php.

References $token_instance.

Referenced by getSignedPath(), revalidatingFolderToken(), and saveFolderToken().

                                      : ?\ilWACToken
    {
        return $this->token_instance;
    }

Here is the caller graph for this function:

getTokenMaxLifetimeInSeconds()

static ilWACSignedPath::getTokenMaxLifetimeInSeconds ( )

static

Definition at line 330 of file class.ilWACSignedPath.php.

Referenced by ilWACToken\__construct(), ILIAS\OnScreenChat\Repository\Subscriber\getDataByUserIds(), and ilWACTokenTest\testFileToken().

                                                         : int
    {
        return self::$token_max_lifetime_in_seconds;
    }

Here is the caller graph for this function:

getType()

ilWACSignedPath::getType

(

)

Definition at line 248 of file class.ilWACSignedPath.php.

References $type.

Referenced by buildTokenInstance(), getRelevantLifeTime(), getSignedPath(), and revalidatingFolderToken().

                             : int
    {
        return $this->type;
    }

Here is the caller graph for this function:

isChecked()

ilWACSignedPath::isChecked

(

)

Definition at line 379 of file class.ilWACSignedPath.php.

References $checked.

                               : bool
    {
        return $this->checked;
    }

isFolderSigned()

ilWACSignedPath::isFolderSigned

(

)

Definition at line 84 of file class.ilWACSignedPath.php.

References buildAndSetTokenInstance(), buildTokenInstance(), getPathObject(), ILIAS\Repository\int(), and setType().

Referenced by isFolderTokenValid().

                                    : bool
    {
        $this->httpService->cookieJar();

        $this->setType(PathType::FOLDER);
        $plain_token = $this->buildTokenInstance();
        $name = $plain_token->getHashedId();

        // Token
        $default_token = '';
        $token_cookie_value = $this->httpService->request()->getCookieParams()[$name] ?? $default_token;
        // Timestamp
        $default_timestamp = 0;
        $timestamp_cookie_value = $this->httpService->request()->getCookieParams()[$name . self::TS_SUFFIX] ?? $default_timestamp;
        $timestamp_cookie_value = (int) $timestamp_cookie_value;
        // TTL
        $default_ttl = 0;
        $ttl_cookie_value = $this->httpService->request()->getCookieParams()[$name . self::TTL_SUFFIX] ?? $default_ttl;
        $ttl_cookie_value = (int) $ttl_cookie_value;

        $this->getPathObject()->setToken($token_cookie_value);
        $this->getPathObject()->setTimestamp($timestamp_cookie_value);
        $this->getPathObject()->setTTL($ttl_cookie_value);
        $this->buildAndSetTokenInstance();

        return $this->getPathObject()->hasToken();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isFolderTokenValid()

ilWACSignedPath::isFolderTokenValid

(

)

Exceptions

ilWACException

Definition at line 115 of file class.ilWACSignedPath.php.

References checkToken(), and isFolderSigned().

                                        : bool
    {
        if (!$this->isFolderSigned()) {
            return false;
        }

        return $this->checkToken();
    }

Here is the call graph for this function:

isSignedPath()

ilWACSignedPath::isSignedPath

(

)

Definition at line 191 of file class.ilWACSignedPath.php.

References getPathObject().

                                  : bool
    {
        return ($this->getPathObject()->hasToken() && $this->getPathObject()->hasTimestamp()
            && $this->getPathObject()->hasTTL());
    }

Here is the call graph for this function:

isSignedPathValid()

ilWACSignedPath::isSignedPathValid

(

)

Exceptions

ilWACException

Definition at line 200 of file class.ilWACSignedPath.php.

References buildAndSetTokenInstance(), checkToken(), and getPathObject().

                                       : bool
    {
        $this->buildAndSetTokenInstance($this->getPathObject()->getTimestamp(), $this->getPathObject()->getTTL());

        return $this->checkToken();
    }

Here is the call graph for this function:

revalidatingFolderToken()

ilWACSignedPath::revalidatingFolderToken

(

)

Definition at line 176 of file class.ilWACSignedPath.php.

References buildAndSetTokenInstance(), getPathObject(), getTokenInstance(), getType(), and saveFolderToken().

                                             : bool
    {
        if ($this->getType() !== PathType::FOLDER) {
            return false;
        }
        $this->buildAndSetTokenInstance(time(), $this->getPathObject()->getTTL());
        $this->getPathObject()->setTTL($this->getTokenInstance()->getTTL());
        $this->getPathObject()->setTimestamp($this->getTokenInstance()->getTimestamp());
        $this->getPathObject()->setToken($this->getTokenInstance()->getToken());

        $this->saveFolderToken();

        return true;
    }

Here is the call graph for this function:

saveFolderToken()

ilWACSignedPath::saveFolderToken ( )

protected

Definition at line 124 of file class.ilWACSignedPath.php.

References $id, $path, getPathObject(), getTokenInstance(), and null.

Referenced by revalidatingFolderToken().

                                        : void
    {
        $ttl = $this->getPathObject()->getTTL();
        $cookie_lifetime = $ttl !== 0 ? $ttl : self::getCookieMaxLifetimeInSeconds();
        $id = $this->getTokenInstance()->getHashedId();
        $expire = time() + $cookie_lifetime + 3600;
        $secure = true;
        $domain = null;
        $http_only = true;
        $path = '/';

        $tokenCookie = $this->cookieFactory->create($id, $this->getTokenInstance()->getToken())
                                           ->withExpires($expire)
                                           ->withPath($path)
                                           ->withSecure($secure)
                                           ->withDomain($domain)
                                           ->withHttpOnly($http_only);

        $timestampCookie = $this->cookieFactory->create($id . self::TS_SUFFIX, time())
                                               ->withExpires($expire)
                                               ->withPath($path)
                                               ->withDomain($domain)
                                               ->withSecure($secure)
                                               ->withHttpOnly($http_only);

        $ttlCookie = $this->cookieFactory->create($id . self::TTL_SUFFIX, $cookie_lifetime)
                                         ->withExpires($expire)
                                         ->withPath($path)
                                         ->withDomain($domain)
                                         ->withSecure($secure)
                                         ->withHttpOnly($http_only);

        $jar = $this->httpService->cookieJar()->with($tokenCookie)
                                 ->with($timestampCookie)
                                 ->with($ttlCookie);

        // FIX: currently the cookies are never stored, we must use setcookie
        foreach ($jar->getAll() as $cookie) {
            setcookie(
                $cookie->getName(),
                (string) $cookie->getValue(),
                [
                    'expires' => $cookie->getExpires(),
                    'path' => $cookie->getPath() ?? '/',
                    'domain' => $cookie->getDomain() ?? '',
                    'secure' => $cookie->getSecure(),
                    'httponly' => $cookie->getHttpOnly()
                ]
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setChecked()

ilWACSignedPath::setChecked

(

bool

$checked

)

Definition at line 384 of file class.ilWACSignedPath.php.

References $checked, and ILIAS\UI\examples\Symbol\Glyph\Checked\checked().

Referenced by checkToken().

                                             : void
    {
        $this->checked = $checked;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setCookieMaxLifetimeInSeconds()

static ilWACSignedPath::setCookieMaxLifetimeInSeconds ( int  $cookie_max_lifetime_in_seconds )

static

Exceptions

Definition at line 357 of file class.ilWACSignedPath.php.

References $cookie_max_lifetime_in_seconds, and ilWACException\MAX_LIFETIME.

                                                                                             : void
    {
        if ($cookie_max_lifetime_in_seconds > self::MAX_LIFETIME) {
            throw new ilWACException(ilWACException::MAX_LIFETIME);
        }
        self::$cookie_max_lifetime_in_seconds = $cookie_max_lifetime_in_seconds;
    }

setPathObject()

ilWACSignedPath::setPathObject

(

ilWACPath

$path_object

)

Definition at line 263 of file class.ilWACSignedPath.php.

References $path_object.

Referenced by __construct().

                                                         : void
    {
        $this->path_object = $path_object;
    }

Here is the caller graph for this function:

setTokenInstance()

ilWACSignedPath::setTokenInstance

(

ilWACToken

$token_instance

)

Definition at line 243 of file class.ilWACSignedPath.php.

References $token_instance.

Referenced by buildAndSetTokenInstance().

                                                                : void
    {
        $this->token_instance = $token_instance;
    }

Here is the caller graph for this function:

setTokenMaxLifetimeInSeconds()

static ilWACSignedPath::setTokenMaxLifetimeInSeconds ( int  $token_max_lifetime_in_seconds )

static

Exceptions

Definition at line 339 of file class.ilWACSignedPath.php.

References $token_max_lifetime_in_seconds, and ilWACException\MAX_LIFETIME.

Referenced by ILIAS\OnScreenChat\Repository\Subscriber\getDataByUserIds(), ilWACTokenTest\getModifiedSignedPath(), assQuestion\getSuggestedSolutionOutput(), ilChatroomViewGUI\lostConnection(), and ilWACTokenTest\testFileToken().

                                                                                           : void
    {
        if ($token_max_lifetime_in_seconds > self::MAX_LIFETIME) {
            throw new ilWACException(ilWACException::MAX_LIFETIME);
        }
        self::$token_max_lifetime_in_seconds = $token_max_lifetime_in_seconds;
    }

Here is the caller graph for this function:

setType()

ilWACSignedPath::setType

(

int

$type

)

Definition at line 253 of file class.ilWACSignedPath.php.

References $type.

Referenced by isFolderSigned().

                                      : void
    {
        $this->type = $type;
    }

Here is the caller graph for this function:

signFile()

static ilWACSignedPath::signFile ( string  $path_to_file )

static

Exceptions

ilWACException

Definition at line 212 of file class.ilWACSignedPath.php.

References $DIC.

Referenced by ilCertificateSettingsFormRepository\__construct(), assImagemapQuestionGUI\areaEditor(), ilObjCertificateSettings\getBackgroundImageIdentification(), ilDclMobRecordRepresentation\getHTML(), ILIAS\Badge\ilBadgeImage\getImageFromResourceId(), ilBadgeImageTemplate\getImageFromResourceId(), ILIAS\MediaObjects\MediaObjectManager\getLocalSrc(), ilWACTokenTest\getModifiedSignedPath(), ILIAS\Style\Content\Style\StyleRepo\getPath(), assImagemapQuestionGUI\getPreview(), assImagemapQuestionGUI\getSolutionOutput(), assQuestion\getSuggestedSolutionOutput(), assImagemapQuestionGUI\getTestOutput(), ilObjMediaObject\getXML(), ilUserCertificateGUI\listCertificates(), ilTestHTMLGenerator\makeHtmlDocument(), assMatchingQuestionGUI\renderSolutionOutput(), and ilWACTokenTest\testFileToken().

                                                         : string
    {
        global $DIC;
        if ($path_to_file === '' || $path_to_file === '0') {
            return '';
        }
        $ilWACPath = new ilWACPath($path_to_file);
        if ($ilWACPath->getClient() === '' || $ilWACPath->getClient() === '0') {
            return $path_to_file;
        }
        $obj = new self($ilWACPath, $DIC->http(), new CookieFactoryImpl());
        $obj->setType(PathType::FILE);
        $obj->buildAndSetTokenInstance(time(), self::getTokenMaxLifetimeInSeconds());

        return $obj->getSignedPath();
    }

Here is the caller graph for this function:

signFolderOfStartFile()

static ilWACSignedPath::signFolderOfStartFile ( string  $start_file_path )

static

Definition at line 229 of file class.ilWACSignedPath.php.

References $DIC.

Referenced by ilSCORMPresentationGUI\frameset(), ilSCORM13PlayerGUI\getPlayer(), ilExerciseManagementGUI\openSubmissionViewObject(), ilSCORMPresentationGUI\pingSession(), ilSCORM13PlayerGUI\pingSession(), ilObjFileBasedLMGUI\setStartFile(), and ilWACTokenTest\testCookieGeneration().

                                                                         : void
    {
        global $DIC;
        $obj = new self(new ilWACPath($start_file_path), $DIC->http(), new CookieFactoryImpl());
        $obj->setType(PathType::FOLDER);
        $obj->buildAndSetTokenInstance(time(), self::getCookieMaxLifetimeInSeconds());
        $obj->saveFolderToken();
    }

Here is the caller graph for this function:

Field Documentation

$checked

bool ilWACSignedPath::$checked = false

protected

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

Referenced by isChecked(), and setChecked().

$cookie_max_lifetime_in_seconds

int ilWACSignedPath::$cookie_max_lifetime_in_seconds = 300

staticprotected

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

Referenced by setCookieMaxLifetimeInSeconds().

$path_object

ilWACPath ilWACSignedPath::$path_object = null

protected

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

Referenced by getPathObject(), and setPathObject().

$token_instance

ilWACToken ilWACSignedPath::$token_instance = null

protected

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

Referenced by getTokenInstance(), and setTokenInstance().

$token_max_lifetime_in_seconds

int ilWACSignedPath::$token_max_lifetime_in_seconds = 5

staticprotected

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

Referenced by setTokenMaxLifetimeInSeconds().

$type

int ilWACSignedPath::$type = PathType::FILE

protected

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

Referenced by getType(), and setType().

MAX_LIFETIME

const ilWACSignedPath::MAX_LIFETIME = 600

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

TS_SUFFIX

const ilWACSignedPath::TS_SUFFIX = 'ts'

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

TTL_SUFFIX

const ilWACSignedPath::TTL_SUFFIX = 'ttl'

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

WAC_TIMESTAMP_ID

const ilWACSignedPath::WAC_TIMESTAMP_ID = 'il_wac_ts'

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

Referenced by ilWACPath\handleParameters(), and ilWACPath\setTimestamp().

WAC_TOKEN_ID

const ilWACSignedPath::WAC_TOKEN_ID = 'il_wac_token'

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

Referenced by ilWACPath\handleParameters(), and ilWACPath\setToken().

WAC_TTL_ID

const ilWACSignedPath::WAC_TTL_ID = 'il_wac_ttl'

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

Referenced by ilWACPath\handleParameters(), and ilWACPath\setTTL().

---

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

• components/ILIAS/WebAccessChecker/classes/class.ilWACSignedPath.php