Inheritance diagram for Firebase\JWT\CachedKeySet:

Collaboration diagram for Firebase\JWT\CachedKeySet:

Public Member Functions
	__construct (string $jwksUri, ClientInterface $httpClient, RequestFactoryInterface $httpFactory, CacheItemPoolInterface $cache, int $expiresAfter=null, bool $rateLimit=false, string $defaultAlg=null)

	offsetGet ($keyId)

	offsetExists ($keyId)

	offsetSet ($offset, $value)

	offsetUnset ($offset)

Private Member Functions
	formatJwksForCache (string $jwks)

	keyIdExists (string $keyId)

	rateLimitExceeded ()

	getCacheItem ()

	setCacheKeys ()

Private Attributes
string	$jwksUri

ClientInterface	$httpClient

RequestFactoryInterface	$httpFactory

CacheItemPoolInterface	$cache

int	$expiresAfter

CacheItemInterface	$cacheItem

array	$keySet

string	$cacheKey

string	$cacheKeyPrefix = 'jwks'

int	$maxKeyLength = 64

bool	$rateLimit

string	$rateLimitCacheKey

int	$maxCallsPerMinute = 10

string	$defaultAlg

Detailed Description

<string, Key>

Definition at line 19 of file CachedKeySet.php.

Constructor & Destructor Documentation

◆ __construct()

Firebase\JWT\CachedKeySet::__construct	(	string	$jwksUri,
		ClientInterface	$httpClient,
		RequestFactoryInterface	$httpFactory,
		CacheItemPoolInterface	$cache,
		int	$expiresAfter = `null`,
		bool	$rateLimit = `false`,
		string	$defaultAlg = `null`
	)

Definition at line 78 of file CachedKeySet.php.

References Firebase\JWT\CachedKeySet\$cache, Firebase\JWT\CachedKeySet\$defaultAlg, Firebase\JWT\CachedKeySet\$expiresAfter, Firebase\JWT\CachedKeySet\$httpClient, Firebase\JWT\CachedKeySet\$httpFactory, Firebase\JWT\CachedKeySet\$jwksUri, Firebase\JWT\CachedKeySet\$rateLimit, and Firebase\JWT\CachedKeySet\setCacheKeys().

       {
         $this->jwksUri = $jwksUri;
         $this->httpClient = $httpClient;
         $this->httpFactory = $httpFactory;
         $this->cache = $cache;
         $this->expiresAfter = $expiresAfter;
         $this->rateLimit = $rateLimit;
         $this->defaultAlg = $defaultAlg;
         $this->setCacheKeys();
     }

Here is the call graph for this function:

Member Function Documentation

◆ formatJwksForCache()

Firebase\JWT\CachedKeySet::formatJwksForCache ( string $jwks )

private

Returns: array<mixed>

Definition at line 138 of file CachedKeySet.php.

References $keys, and ILIAS\LTI\ToolProvider\$kid.

Referenced by Firebase\JWT\CachedKeySet\keyIdExists().

                                                      : array
     {
         $jwks = json_decode($jwks, true);
 
         if (!isset($jwks['keys'])) {
             throw new UnexpectedValueException('"keys" member must exist in the JWK Set');
         }
 
         if (empty($jwks['keys'])) {
             throw new InvalidArgumentException('JWK Set did not contain any keys');
         }
 
         $keys = [];
         foreach ($jwks['keys'] as $k => $v) {
             $kid = isset($v['kid']) ? $v['kid'] : $k;
             $keys[(string) $kid] = $v;
         }
 
         return $keys;
     }

Here is the caller graph for this function:

◆ getCacheItem()

Firebase\JWT\CachedKeySet::getCacheItem ( )

private

Definition at line 229 of file CachedKeySet.php.

References Firebase\JWT\CachedKeySet\$cacheItem.

Referenced by Firebase\JWT\CachedKeySet\keyIdExists().

                                    : CacheItemInterface
     {
         if (\is_null($this->cacheItem)) {
             $this->cacheItem = $this->cache->getItem($this->cacheKey);
         }
 
         return $this->cacheItem;
     }

Here is the caller graph for this function:

◆ keyIdExists()

Firebase\JWT\CachedKeySet::keyIdExists ( string $keyId )

private

Definition at line 159 of file CachedKeySet.php.

References Firebase\JWT\CachedKeySet\$jwksUri, Firebase\JWT\CachedKeySet\formatJwksForCache(), Firebase\JWT\CachedKeySet\getCacheItem(), and Firebase\JWT\CachedKeySet\rateLimitExceeded().

Referenced by Firebase\JWT\CachedKeySet\offsetExists(), and Firebase\JWT\CachedKeySet\offsetGet().

                                                : bool
     {
         if (null === $this->keySet) {
             $item = $this->getCacheItem();
             // Try to load keys from cache
             if ($item->isHit()) {
                 // item found! retrieve it
                 $this->keySet = $item->get();
                 // If the cached item is a string, the JWKS response was cached (previous behavior).
                 // Parse this into expected format array<kid, jwk> instead.
                 if (\is_string($this->keySet)) {
                     $this->keySet = $this->formatJwksForCache($this->keySet);
                 }
             }
         }
 
         if (!isset($this->keySet[$keyId])) {
             if ($this->rateLimitExceeded()) {
                 return false;
             }
             $request = $this->httpFactory->createRequest('GET', $this->jwksUri);
             $jwksResponse = $this->httpClient->sendRequest($request);
             if ($jwksResponse->getStatusCode() !== 200) {
                 throw new UnexpectedValueException(
                     sprintf(
                         'HTTP Error: %d %s for URI "%s"',
                         $jwksResponse->getStatusCode(),
                         $jwksResponse->getReasonPhrase(),
                         $this->jwksUri,
                     ),
                     $jwksResponse->getStatusCode()
                 );
             }
             $this->keySet = $this->formatJwksForCache((string) $jwksResponse->getBody());
 
             if (!isset($this->keySet[$keyId])) {
                 return false;
             }
 
             $item = $this->getCacheItem();
             $item->set($this->keySet);
             if ($this->expiresAfter) {
                 $item->expiresAfter($this->expiresAfter);
             }
             $this->cache->save($item);
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ offsetExists()

Firebase\JWT\CachedKeySet::offsetExists ( $keyId )

Parameters

string $keyId

Returns: bool

Definition at line 113 of file CachedKeySet.php.

References Firebase\JWT\CachedKeySet\keyIdExists().

                                         : bool
     {
         return $this->keyIdExists($keyId);
     }

Here is the call graph for this function:

◆ offsetGet()

Firebase\JWT\CachedKeySet::offsetGet ( $keyId )

Parameters

string $keyId

Returns: Key

Definition at line 101 of file CachedKeySet.php.

References Firebase\JWT\CachedKeySet\keyIdExists(), and Firebase\JWT\JWK\parseKey().

                                      : Key
     {
         if (!$this->keyIdExists($keyId)) {
             throw new OutOfBoundsException('Key ID not found');
         }
         return JWK::parseKey($this->keySet[$keyId], $this->defaultAlg);
     }

Here is the call graph for this function:

◆ offsetSet()

Firebase\JWT\CachedKeySet::offsetSet	(	$offset,
		$value
	)

Parameters

string	$offset
Key	$value

Definition at line 122 of file CachedKeySet.php.

                                               : void
     {
         throw new LogicException('Method not implemented');
     }

◆ offsetUnset()

Firebase\JWT\CachedKeySet::offsetUnset ( $offset )

Parameters

string $offset

Definition at line 130 of file CachedKeySet.php.

                                         : void
     {
         throw new LogicException('Method not implemented');
     }

◆ rateLimitExceeded()

Firebase\JWT\CachedKeySet::rateLimitExceeded ( )

private

Definition at line 209 of file CachedKeySet.php.

References ILIAS\Repository\int().

Referenced by Firebase\JWT\CachedKeySet\keyIdExists().

                                         : bool
     {
         if (!$this->rateLimit) {
             return false;
         }
 
         $cacheItem = $this->cache->getItem($this->rateLimitCacheKey);
         if (!$cacheItem->isHit()) {
             $cacheItem->expiresAfter(1); // # of calls are cached each minute
         }
 
         $callsPerMinute = (int) $cacheItem->get();
         if (++$callsPerMinute > $this->maxCallsPerMinute) {
             return true;
         }
         $cacheItem->set($callsPerMinute);
         $this->cache->save($cacheItem);
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCacheKeys()

Firebase\JWT\CachedKeySet::setCacheKeys ( )

private

Definition at line 238 of file CachedKeySet.php.

References ILIAS\LTI\ToolProvider\$key.

Referenced by Firebase\JWT\CachedKeySet\__construct().

                                    : void
     {
         if (empty($this->jwksUri)) {
             throw new RuntimeException('JWKS URI is empty');
         }
 
         // ensure we do not have illegal characters
         $key = preg_replace('|[^a-zA-Z0-9_\.!]|', '', $this->jwksUri);
 
         // add prefix
         $key = $this->cacheKeyPrefix . $key;
 
         // Hash keys if they exceed $maxKeyLength of 64
         if (\strlen($key) > $this->maxKeyLength) {
             $key = substr(hash('sha256', $key), 0, $this->maxKeyLength);
         }
 
         $this->cacheKey = $key;
 
         if ($this->rateLimit) {
             // add prefix
             $rateLimitKey = $this->cacheKeyPrefix . 'ratelimit' . $key;
 
             // Hash keys if they exceed $maxKeyLength of 64
             if (\strlen($rateLimitKey) > $this->maxKeyLength) {
                 $rateLimitKey = substr(hash('sha256', $rateLimitKey), 0, $this->maxKeyLength);
             }
 
             $this->rateLimitCacheKey = $rateLimitKey;
         }
     }

Here is the caller graph for this function:

Field Documentation

◆ $cache

CacheItemPoolInterface Firebase\JWT\CachedKeySet::$cache

private

Definition at line 36 of file CachedKeySet.php.

Referenced by Firebase\JWT\CachedKeySet\__construct().

◆ $cacheItem

CacheItemInterface Firebase\JWT\CachedKeySet::$cacheItem

private

Definition at line 44 of file CachedKeySet.php.

Referenced by Firebase\JWT\CachedKeySet\getCacheItem().

◆ $cacheKey

string Firebase\JWT\CachedKeySet::$cacheKey

private

Definition at line 52 of file CachedKeySet.php.

◆ $cacheKeyPrefix

string Firebase\JWT\CachedKeySet::$cacheKeyPrefix = 'jwks'

private

Definition at line 56 of file CachedKeySet.php.

◆ $defaultAlg

string Firebase\JWT\CachedKeySet::$defaultAlg

private

Definition at line 76 of file CachedKeySet.php.

Referenced by Firebase\JWT\CachedKeySet\__construct().

◆ $expiresAfter

int Firebase\JWT\CachedKeySet::$expiresAfter

private

Definition at line 40 of file CachedKeySet.php.

Referenced by Firebase\JWT\CachedKeySet\__construct().

◆ $httpClient

ClientInterface Firebase\JWT\CachedKeySet::$httpClient

private

Definition at line 28 of file CachedKeySet.php.

Referenced by Firebase\JWT\CachedKeySet\__construct().

◆ $httpFactory

RequestFactoryInterface Firebase\JWT\CachedKeySet::$httpFactory

private

Definition at line 32 of file CachedKeySet.php.

Referenced by Firebase\JWT\CachedKeySet\__construct().

◆ $jwksUri

string Firebase\JWT\CachedKeySet::$jwksUri

private

Definition at line 24 of file CachedKeySet.php.

Referenced by Firebase\JWT\CachedKeySet\__construct(), and Firebase\JWT\CachedKeySet\keyIdExists().

◆ $keySet

array Firebase\JWT\CachedKeySet::$keySet

private

Definition at line 48 of file CachedKeySet.php.

◆ $maxCallsPerMinute

int Firebase\JWT\CachedKeySet::$maxCallsPerMinute = 10

private

Definition at line 72 of file CachedKeySet.php.

◆ $maxKeyLength

int Firebase\JWT\CachedKeySet::$maxKeyLength = 64

private

Definition at line 60 of file CachedKeySet.php.

◆ $rateLimit

bool Firebase\JWT\CachedKeySet::$rateLimit

private

Definition at line 64 of file CachedKeySet.php.

Referenced by Firebase\JWT\CachedKeySet\__construct().

◆ $rateLimitCacheKey

string Firebase\JWT\CachedKeySet::$rateLimitCacheKey

private

Definition at line 68 of file CachedKeySet.php.

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

Services/LTI/src/Firebase/CachedKeySet.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ formatJwksForCache()

◆ getCacheItem()

◆ keyIdExists()

◆ offsetExists()

◆ offsetGet()

◆ offsetSet()

◆ offsetUnset()

◆ rateLimitExceeded()

◆ setCacheKeys()

Field Documentation

◆ $cache

◆ $cacheItem

◆ $cacheKey

◆ $cacheKeyPrefix

◆ $defaultAlg

◆ $expiresAfter

◆ $httpClient

◆ $httpFactory

◆ $jwksUri

◆ $keySet

◆ $maxCallsPerMinute

◆ $maxKeyLength

◆ $rateLimit

◆ $rateLimitCacheKey