Package org.keycloak.keys.infinispan

Class InfinispanPublicKeyStorageProvider

java.lang.Object

org.keycloak.keys.infinispan.InfinispanPublicKeyStorageProvider

All Implemented Interfaces:

PublicKeyStorageProvider, Provider

public class InfinispanPublicKeyStorageProvider
extends Object
implements PublicKeyStorageProvider

Author:

Marek Posolda

Constructor Summary

Constructors

Constructor	Description
InfinispanPublicKeyStorageProvider(KeycloakSession session, org.infinispan.Cache<String,PublicKeysEntry> keys, Map<String,FutureTask<PublicKeysEntry>> tasksInProgress, int minTimeBetweenRequests, int maxCacheTime)

Method Summary

Modifier and Type	Method	Description
void	close()
protected KeycloakTransaction	getAfterTransaction()
KeyWrapper	getFirstPublicKey(String modelKey, String algorithm, PublicKeyLoader loader)	Get first found public key to verify messages signed by particular client having several public keys.
KeyWrapper	getFirstPublicKey(String modelKey, Predicate<KeyWrapper> predicate, PublicKeyLoader loader)	If the key is found in the cache that is returned straight away.
List<KeyWrapper>	getKeys(String modelKey, PublicKeyLoader loader)	return all keys under the model key.
KeyWrapper	getPublicKey(String modelKey, String kid, String algorithm, PublicKeyLoader loader)	Get public key to verify messages signed by particular client.
boolean	reloadKeys(String modelKey, PublicKeyLoader loader)	Reloads keys for the model key.
protected void	runInvalidations()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

InfinispanPublicKeyStorageProvider

public InfinispanPublicKeyStorageProvider(KeycloakSession session,
 org.infinispan.Cache<String,PublicKeysEntry> keys,
 Map<String,FutureTask<PublicKeysEntry>> tasksInProgress,
 int minTimeBetweenRequests,
 int maxCacheTime)

Method Details

getAfterTransaction

protected KeycloakTransaction getAfterTransaction()

runInvalidations

protected void runInvalidations()

getFirstPublicKey

public KeyWrapper getFirstPublicKey(String modelKey,
 String algorithm,
 PublicKeyLoader loader)

Description copied from interface: PublicKeyStorageProvider

Get first found public key to verify messages signed by particular client having several public keys. Used for example during JWT client authentication or to encrypt content encryption key (CEK) by particular client. Used for example during encrypting a token in JWE

Specified by:

getFirstPublicKey in interface PublicKeyStorageProvider

Returns:

getPublicKey

public KeyWrapper getPublicKey(String modelKey,
 String kid,
 String algorithm,
 PublicKeyLoader loader)

Description copied from interface: PublicKeyStorageProvider

Get public key to verify messages signed by particular client. Used for example during JWT client authentication

Specified by:

getPublicKey in interface PublicKeyStorageProvider

algorithm - The returned key must match this algorithm (unless the algorithm is not set in the JWK)

Returns:

getFirstPublicKey

public KeyWrapper getFirstPublicKey(String modelKey,
 Predicate<KeyWrapper> predicate,
 PublicKeyLoader loader)

If the key is found in the cache that is returned straight away. If not in cache, the keys are reloaded if allowed by the minTimeBetweenRequests and key is searched again.

Specified by:

getFirstPublicKey in interface PublicKeyStorageProvider

Parameters:

modelKey - The model key

predicate - The predicate to search the key

loader - The loader to reload keys

Returns:

The key or null

getKeys

public List<KeyWrapper> getKeys(String modelKey,
 PublicKeyLoader loader)

return all keys under the model key. The maxCacheTime is used to reload the keys from time to time.

Specified by:

getKeys in interface PublicKeyStorageProvider

Parameters:

modelKey - The model key

loader - The loader to reload keys id maxCacheTime reached

Returns:

The keys in the model

reloadKeys

public boolean reloadKeys(String modelKey,
 PublicKeyLoader loader)

Description copied from interface: PublicKeyStorageProvider

Reloads keys for the model key.

Specified by:

reloadKeys in interface PublicKeyStorageProvider

Returns:

true if reloaded, false if not

close

public void close()

Specified by:

close in interface Provider