ILIAS\WOPI\Discovery\ProofKeyRefresh Class Reference

Fetches the proof keys from the discovery again when a request could not be verified with the stored ones - the WOPI client may have rotated its keys since the last crawl, see https://learn.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/online/scenarios/proofkeys. More...

Collaboration diagram for ILIAS\WOPI\Discovery\ProofKeyRefresh:

Public Member Functions
	__construct (private ProofKeyRepository $repository, private \ilSetting $settings, private \Closure $fetch, ?\Closure $clock=null)
	__invoke ()

Data Fields
const	MIN_INTERVAL = 5 * 60

Private Attributes
const	LAST_REFRESH = 'wopi_proof_refreshed_at'
Closure	$clock

Detailed Description

Fetches the proof keys from the discovery again when a request could not be verified with the stored ones - the WOPI client may have rotated its keys since the last crawl, see https://learn.microsoft.com/en-us/microsoft-365/cloud-storage-partner-program/online/scenarios/proofkeys.

Every request failing the verification would trigger a fetch, so it happens at most once within MIN_INTERVAL. A failed fetch keeps the stored keys.

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 33 of file ProofKeyRefresh.php.

Constructor & Destructor Documentation

__construct()

ILIAS\WOPI\Discovery\ProofKeyRefresh::__construct	(	private ProofKeyRepository	$repository,
		private \ilSetting	$settings,
		private \Closure	$fetch,
		?\Closure	$clock = null
	)

Parameters

Closure(): ?ProofKeys $fetch reads the proof keys from the discovery

Parameters

Closure(): int|null $clock returns the current unix timestamp, for testing

Definition at line 47 of file ProofKeyRefresh.php.

      {
        $this->clock = $clock ?? static fn(): int => time();
    }

References ILIAS\WOPI\Discovery\ProofKeyRefresh\$clock.

Member Function Documentation

__invoke()

ILIAS\WOPI\Discovery\ProofKeyRefresh::__invoke

(

)

Returns

ProofKeys|null the keys just fetched, null if nothing was fetched

Definition at line 59 of file ProofKeyRefresh.php.

                              : ?ProofKeys
    {
        $now = ($this->clock)();
        if ($now - (int) $this->settings->get(self::LAST_REFRESH, '0') < self::MIN_INTERVAL) {
            return null;
        }
        $this->settings->set(self::LAST_REFRESH, (string) $now);
 
        try {
            $keys = ($this->fetch)();
        } catch (\Throwable) {
            return null;
        }
        if ($keys === null) {
            return null;
        }
        $this->repository->store($keys);
 
        return $keys;
    }

References ILIAS\WOPI\Discovery\ProofKeyRefresh\$clock, ILIAS\WOPI\Discovery\ProofKeyRefresh\MIN_INTERVAL, ILIAS\UI\examples\Deck\repository(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Field Documentation

$clock

Closure ILIAS\WOPI\Discovery\ProofKeyRefresh::$clock

private

Definition at line 41 of file ProofKeyRefresh.php.

Referenced by ILIAS\WOPI\Discovery\ProofKeyRefresh\__construct(), and ILIAS\WOPI\Discovery\ProofKeyRefresh\__invoke().

LAST_REFRESH

const ILIAS\WOPI\Discovery\ProofKeyRefresh::LAST_REFRESH = 'wopi_proof_refreshed_at'

private

Definition at line 36 of file ProofKeyRefresh.php.

MIN_INTERVAL

const ILIAS\WOPI\Discovery\ProofKeyRefresh::MIN_INTERVAL = 5 * 60

Definition at line 35 of file ProofKeyRefresh.php.

Referenced by ILIAS\WOPI\Discovery\ProofKeyRefresh\__invoke(), and ILIAS\WOPI\Discovery\ProofKeyRefreshTest\testFetchesAtMostOnceWithinTheInterval().

---

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

• components/ILIAS/WOPI/classes/Discovery/ProofKeyRefresh.php