ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
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.

51 {
52 $this->setPathObject($ilWACPath);
53 }
setPathObject(ilWACPath $path_object)

References setPathObject().

+ Here is the call graph for this function:

Member Function Documentation

◆ buildAndSetTokenInstance()

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

ilWACException

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

325 : void
326 {
327 $this->setTokenInstance($this->buildTokenInstance($timestamp, $ttl));
328 }
foreach($mandatory_scripts as $file) $timestamp
Definition: buildRTE.php:70
setTokenInstance(ilWACToken $token_instance)
buildTokenInstance(int $timestamp=0, int $ttl=0)

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

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

+ 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.

304 {
305 if ($this->getType() === 0) {
307 }
308
309 $path = match ($this->getType()) {
310 PathType::FOLDER => $this->getPathObject()->getSecurePath(),
311 default => $this->getPathObject()->getPathWithoutQuery(),
312 };
313
314 $client = $this->getPathObject()->getClient();
315 $timestamp = $timestamp !== 0 ? $timestamp : $this->getPathObject()->getTimestamp();
316 $ttl = $ttl !== 0 ? $ttl : $this->getPathObject()->getTTL();
317
318 return new ilWACToken($path, $client, $timestamp, $ttl);
319 }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
$client
$path
Definition: ltiservices.php:30

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

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ checkToken()

ilWACSignedPath::checkToken ( )
protected
Exceptions

ilWACException

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

271 : bool
272 {
273 $request_token_string = $this->getPathObject()->getToken();
274 $request_ttl = $this->getPathObject()->getTTL();
275 $request_timestamp = $this->getPathObject()->getTimestamp();
276 $current_timestamp = time();
277
278 $timestamp_valid = ($current_timestamp < ($request_timestamp + $request_ttl));
279
280 if (!$timestamp_valid) {
281 $this->setChecked(true);
282
283 return false;
284 }
285
286 $simulated_token = $this->buildTokenInstance($request_timestamp, $request_ttl);
287 $simulated_token_string = $simulated_token->getToken();
288 $token_valid = ($simulated_token_string === $request_token_string);
289
290 if (!$token_valid) {
291 $this->setChecked(true);
292
293 return false;
294 }
295
296 return true;
297 }
setChecked(bool $checked)

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

Referenced by isFolderTokenValid(), and isSignedPathValid().

+ 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.

347 : int
348 {
350 }
static int $cookie_max_lifetime_in_seconds

References $cookie_max_lifetime_in_seconds.

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

+ Here is the caller graph for this function:

◆ getPathObject()

ilWACSignedPath::getPathObject ( )

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

258 : ?\ilWACPath
259 {
260 return $this->path_object;
261 }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...

References $path_object.

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

+ Here is the caller graph for this function:

◆ getRelevantLifeTime()

ilWACSignedPath::getRelevantLifeTime ( )
protected

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

365 : int
366 {
367 $request_ttl = $this->getPathObject()->getTTL();
368 if ($request_ttl > 0) {
369 return $request_ttl;
370 }
371
372 return match ($this->getType()) {
373 PathType::FOLDER => self::getCookieMaxLifetimeInSeconds(),
374 PathType::FILE => self::getTokenMaxLifetimeInSeconds(),
375 default => 0,
376 };
377 }
static getCookieMaxLifetimeInSeconds()
static getTokenMaxLifetimeInSeconds()

References getCookieMaxLifetimeInSeconds(), getPathObject(), getTokenMaxLifetimeInSeconds(), and getType().

+ Here is the call graph for this function:

◆ getSignedPath()

ilWACSignedPath::getSignedPath ( )
Exceptions
ilWACException

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

58 : string
59 {
60 if ($this->getType() !== PathType::FILE) {
62 }
63 if ($this->getPathObject()->getOriginalRequest() === '' || $this->getPathObject()->getOriginalRequest() === '0') {
64 return '';
65 }
66 if (!$this->getPathObject()->fileExists()) {
67 // return $this->getPathObject()->getOriginalRequest();
68 }
69
70 if (strpos($this->getPathObject()->getPath(), '?')) {
71 $path = $this->getPathObject()->getPath() . '&' . self::WAC_TOKEN_ID . '='
72 . $this->getTokenInstance()->getToken();
73 } else {
74 $path = $this->getPathObject()->getPath() . '?' . self::WAC_TOKEN_ID . '='
75 . $this->getTokenInstance()->getToken();
76 }
77
78 $path .= '&' . self::WAC_TTL_ID . '=' . $this->getTokenInstance()->getTTL();
79
80 return $path . '&' . self::WAC_TIMESTAMP_ID . '='
81 . $this->getTokenInstance()->getTimestamp();
82 }

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

+ Here is the call graph for this function:

◆ getTokenInstance()

ilWACSignedPath::getTokenInstance ( )

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

238 : ?\ilWACToken
239 {
241 }

References $token_instance.

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

+ Here is the caller graph for this function:

◆ getTokenMaxLifetimeInSeconds()

static ilWACSignedPath::getTokenMaxLifetimeInSeconds ( )
static

◆ getType()

ilWACSignedPath::getType ( )

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

248 : int
249 {
250 return $this->type;
251 }

References $type.

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

+ Here is the caller graph for this function:

◆ isChecked()

ilWACSignedPath::isChecked ( )

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

379 : bool
380 {
381 return $this->checked;
382 }

References $checked.

◆ isFolderSigned()

ilWACSignedPath::isFolderSigned ( )

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

84 : bool
85 {
86 $this->httpService->cookieJar();
87
88 $this->setType(PathType::FOLDER);
89 $plain_token = $this->buildTokenInstance();
90 $name = $plain_token->getHashedId();
91
92 // Token
93 $default_token = '';
94 $token_cookie_value = $this->httpService->request()->getCookieParams()[$name] ?? $default_token;
95 // Timestamp
96 $default_timestamp = 0;
97 $timestamp_cookie_value = $this->httpService->request()->getCookieParams()[$name . self::TS_SUFFIX] ?? $default_timestamp;
98 $timestamp_cookie_value = (int) $timestamp_cookie_value;
99 // TTL
100 $default_ttl = 0;
101 $ttl_cookie_value = $this->httpService->request()->getCookieParams()[$name . self::TTL_SUFFIX] ?? $default_ttl;
102 $ttl_cookie_value = (int) $ttl_cookie_value;
103
104 $this->getPathObject()->setToken($token_cookie_value);
105 $this->getPathObject()->setTimestamp($timestamp_cookie_value);
106 $this->getPathObject()->setTTL($ttl_cookie_value);
108
109 return $this->getPathObject()->hasToken();
110 }
buildAndSetTokenInstance(int $timestamp=0, int $ttl=0)

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

Referenced by isFolderTokenValid().

+ 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.

115 : bool
116 {
117 if (!$this->isFolderSigned()) {
118 return false;
119 }
120
121 return $this->checkToken();
122 }

References checkToken(), and isFolderSigned().

+ Here is the call graph for this function:

◆ isSignedPath()

ilWACSignedPath::isSignedPath ( )

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

191 : bool
192 {
193 return ($this->getPathObject()->hasToken() && $this->getPathObject()->hasTimestamp()
194 && $this->getPathObject()->hasTTL());
195 }

References getPathObject().

+ Here is the call graph for this function:

◆ isSignedPathValid()

ilWACSignedPath::isSignedPathValid ( )
Exceptions
ilWACException

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

200 : bool
201 {
202 $this->buildAndSetTokenInstance($this->getPathObject()->getTimestamp(), $this->getPathObject()->getTTL());
203
204 return $this->checkToken();
205 }

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

+ Here is the call graph for this function:

◆ revalidatingFolderToken()

ilWACSignedPath::revalidatingFolderToken ( )

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

176 : bool
177 {
178 if ($this->getType() !== PathType::FOLDER) {
179 return false;
180 }
181 $this->buildAndSetTokenInstance(time(), $this->getPathObject()->getTTL());
182 $this->getPathObject()->setTTL($this->getTokenInstance()->getTTL());
183 $this->getPathObject()->setTimestamp($this->getTokenInstance()->getTimestamp());
184 $this->getPathObject()->setToken($this->getTokenInstance()->getToken());
185
186 $this->saveFolderToken();
187
188 return true;
189 }

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

+ Here is the call graph for this function:

◆ saveFolderToken()

ilWACSignedPath::saveFolderToken ( )
protected

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

124 : void
125 {
126 $ttl = $this->getPathObject()->getTTL();
127 $cookie_lifetime = $ttl !== 0 ? $ttl : self::getCookieMaxLifetimeInSeconds();
128 $id = $this->getTokenInstance()->getHashedId();
129 $expire = time() + $cookie_lifetime + 3600;
130 $secure = true;
131 $domain = null;
132 $http_only = true;
133 $path = '/';
134
135 $tokenCookie = $this->cookieFactory->create($id, $this->getTokenInstance()->getToken())
136 ->withExpires($expire)
137 ->withPath($path)
138 ->withSecure($secure)
139 ->withDomain($domain)
140 ->withHttpOnly($http_only);
141
142 $timestampCookie = $this->cookieFactory->create($id . self::TS_SUFFIX, time())
143 ->withExpires($expire)
144 ->withPath($path)
145 ->withDomain($domain)
146 ->withSecure($secure)
147 ->withHttpOnly($http_only);
148
149 $ttlCookie = $this->cookieFactory->create($id . self::TTL_SUFFIX, $cookie_lifetime)
150 ->withExpires($expire)
151 ->withPath($path)
152 ->withDomain($domain)
153 ->withSecure($secure)
154 ->withHttpOnly($http_only);
155
156 $jar = $this->httpService->cookieJar()->with($tokenCookie)
157 ->with($timestampCookie)
158 ->with($ttlCookie);
159
160 // FIX: currently the cookies are never stored, we must use setcookie
161 foreach ($jar->getAll() as $cookie) {
162 setcookie(
163 $cookie->getName(),
164 (string) $cookie->getValue(),
165 [
166 'expires' => $cookie->getExpires(),
167 'path' => $cookie->getPath() ?? '/',
168 'domain' => $cookie->getDomain() ?? '',
169 'secure' => $cookie->getSecure(),
170 'httponly' => $cookie->getHttpOnly()
171 ]
172 );
173 }
174 }
$id
plugin.php for ilComponentBuildPluginInfoObjectiveTest::testAddPlugins
Definition: plugin.php:23

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

Referenced by revalidatingFolderToken().

+ 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.

384 : void
385 {
386 $this->checked = $checked;
387 }

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

Referenced by checkToken().

+ 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

ilWACException

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

357 : void
358 {
359 if ($cookie_max_lifetime_in_seconds > self::MAX_LIFETIME) {
361 }
362 self::$cookie_max_lifetime_in_seconds = $cookie_max_lifetime_in_seconds;
363 }

References $cookie_max_lifetime_in_seconds, and ilWACException\MAX_LIFETIME.

◆ setPathObject()

ilWACSignedPath::setPathObject ( ilWACPath  $path_object)

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

263 : void
264 {
265 $this->path_object = $path_object;
266 }

References $path_object.

Referenced by __construct().

+ Here is the caller graph for this function:

◆ setTokenInstance()

ilWACSignedPath::setTokenInstance ( ilWACToken  $token_instance)

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

243 : void
244 {
245 $this->token_instance = $token_instance;
246 }

References $token_instance.

Referenced by buildAndSetTokenInstance().

+ Here is the caller graph for this function:

◆ setTokenMaxLifetimeInSeconds()

static ilWACSignedPath::setTokenMaxLifetimeInSeconds ( int  $token_max_lifetime_in_seconds)
static
Exceptions

ilWACException

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

339 : void
340 {
341 if ($token_max_lifetime_in_seconds > self::MAX_LIFETIME) {
343 }
344 self::$token_max_lifetime_in_seconds = $token_max_lifetime_in_seconds;
345 }

References $token_max_lifetime_in_seconds, and ilWACException\MAX_LIFETIME.

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

+ Here is the caller graph for this function:

◆ setType()

ilWACSignedPath::setType ( int  $type)

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

253 : void
254 {
255 $this->type = $type;
256 }

References $type.

Referenced by isFolderSigned().

+ 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.

212 : string
213 {
214 global $DIC;
215 if ($path_to_file === '' || $path_to_file === '0') {
216 return '';
217 }
218 $ilWACPath = new ilWACPath($path_to_file);
219 if ($ilWACPath->getClient() === '' || $ilWACPath->getClient() === '0') {
220 return $path_to_file;
221 }
222 $obj = new self($ilWACPath, $DIC->http(), new CookieFactoryImpl());
223 $obj->setType(PathType::FILE);
224 $obj->buildAndSetTokenInstance(time(), self::getTokenMaxLifetimeInSeconds());
225
226 return $obj->getSignedPath();
227 }
global $DIC
Definition: shib_login.php:26

References $DIC, and getTokenMaxLifetimeInSeconds().

Referenced by assImagemapQuestionGUI\areaEditor(), ilObjCertificateSettings\getBackgroundImageIdentification(), ilDclMobRecordRepresentation\getHTML(), ILIAS\MediaObjects\MediaObjectManager\getLocalSrc(), ilWACTokenTest\getModifiedSignedPath(), assQuestion\getSuggestedSolutionOutput(), ilObjMediaObject\getXML(), ilUserCertificateGUI\listCertificates(), and ilWACTokenTest\testFileToken().

+ Here is the call graph for this function:
+ 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.

229 : void
230 {
231 global $DIC;
232 $obj = new self(new ilWACPath($start_file_path), $DIC->http(), new CookieFactoryImpl());
233 $obj->setType(PathType::FOLDER);
234 $obj->buildAndSetTokenInstance(time(), self::getCookieMaxLifetimeInSeconds());
235 $obj->saveFolderToken();
236 }

References $DIC, and getCookieMaxLifetimeInSeconds().

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

+ Here is the call graph for this function:
+ 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

◆ $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

◆ $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.

Referenced by isFolderSigned().

◆ TTL_SUFFIX

const ilWACSignedPath::TTL_SUFFIX = 'ttl'

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

Referenced by isFolderSigned().

◆ 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: