Package com.nimbusds.jose.jwk.source

Class RemoteJWKSet<C extends SecurityContext>

java.lang.Object

com.nimbusds.jose.jwk.source.RemoteJWKSet<C>

All Implemented Interfaces:

JWKSource<C>

@ThreadSafe
public class RemoteJWKSet<C extends SecurityContext>
extends Object
implements JWKSource<C>

Remote JSON Web Key (JWK) source specified by a JWK set URL. The retrieved JWK set is cached to minimise network calls. The cache is updated whenever the key selector tries to get a key with an unknown ID.

If no ResourceRetriever is specified when creating a remote JWK set source the default one will be used, with the following HTTP timeouts and limits:

• HTTP connect timeout, in milliseconds: Determined by the DEFAULT_HTTP_CONNECT_TIMEOUT constant which can be overridden by setting the com.nimbusds.jose.jwk.source.RemoteJWKSet.defaultHttpConnectTimeout Java system property.
• HTTP read timeout, in milliseconds: Determined by the DEFAULT_HTTP_READ_TIMEOUT constant which can be overridden by setting the com.nimbusds.jose.jwk.source.RemoteJWKSet.defaultHttpReadTimeout Java system property.
• HTTP entity size limit: Determined by the DEFAULT_HTTP_SIZE_LIMIT constant which can be overridden by setting the com.nimbusds.jose.jwk.source.RemoteJWKSet.defaultHttpSizeLimit Java system property.

Version:

2022-01-24

Author:

Vladimir Dzhuvinov

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_HTTP_CONNECT_TIMEOUT	The default HTTP connect timeout for JWK set retrieval, in milliseconds.
static int	DEFAULT_HTTP_READ_TIMEOUT	The default HTTP read timeout for JWK set retrieval, in milliseconds.
static int	DEFAULT_HTTP_SIZE_LIMIT	The default HTTP entity size limit for JWK set retrieval, in bytes.

Constructor Summary

Constructors

Constructor	Description
RemoteJWKSet(URL jwkSetURL)	Creates a new remote JWK set using the default HTTP resource retriever with the default HTTP timeouts and entity size limit.
RemoteJWKSet(URL jwkSetURL, ResourceRetriever resourceRetriever)	Creates a new remote JWK set.
RemoteJWKSet(URL jwkSetURL, ResourceRetriever resourceRetriever, JWKSetCache jwkSetCache)	Creates a new remote JWK set.

Method Summary

Modifier and Type	Method	Description
List<JWK>	get(JWKSelector jwkSelector, C context)	Retrieves a list of JWKs matching the specified selector.
JWKSet	getCachedJWKSet()	Returns the cached JWK set.
protected static String	getFirstSpecifiedKeyID(JWKMatcher jwkMatcher)	Returns the first specified key ID (kid) for a JWK matcher.
JWKSetCache	getJWKSetCache()	Returns the configured JWK set cache.
URL	getJWKSetURL()	Returns the JWK set URL.
ResourceRetriever	getResourceRetriever()	Returns the HTTP resource retriever.
static int	resolveDefaultHTTPConnectTimeout()	Resolves the default HTTP connect timeout for JWK set retrieval, in milliseconds.
static int	resolveDefaultHTTPReadTimeout()	Resolves the default HTTP read timeout for JWK set retrieval, in milliseconds.
static int	resolveDefaultHTTPSizeLimit()	Resolves default HTTP entity size limit for JWK set retrieval, in bytes.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HTTP_CONNECT_TIMEOUT

public static final int DEFAULT_HTTP_CONNECT_TIMEOUT

The default HTTP connect timeout for JWK set retrieval, in milliseconds. Set to 500 milliseconds.

See Also:

Constant Field Values

DEFAULT_HTTP_READ_TIMEOUT

public static final int DEFAULT_HTTP_READ_TIMEOUT

The default HTTP read timeout for JWK set retrieval, in milliseconds. Set to 500 milliseconds.

See Also:

Constant Field Values

DEFAULT_HTTP_SIZE_LIMIT

public static final int DEFAULT_HTTP_SIZE_LIMIT

The default HTTP entity size limit for JWK set retrieval, in bytes. Set to 50 KBytes.

See Also:

Constant Field Values

Constructor Detail

RemoteJWKSet

public RemoteJWKSet(URL jwkSetURL)

Creates a new remote JWK set using the default HTTP resource retriever with the default HTTP timeouts and entity size limit.

Parameters:

jwkSetURL - The JWK set URL. Must not be null.

RemoteJWKSet

public RemoteJWKSet(URL jwkSetURL,
                    ResourceRetriever resourceRetriever)

Creates a new remote JWK set.

Parameters:

jwkSetURL - The JWK set URL. Must not be null.

resourceRetriever - The HTTP resource retriever to use, null to use the default one with the default HTTP timeouts and entity size limit.

RemoteJWKSet

public RemoteJWKSet(URL jwkSetURL,
                    ResourceRetriever resourceRetriever,
                    JWKSetCache jwkSetCache)

Creates a new remote JWK set.

Parameters:

jwkSetURL - The JWK set URL. Must not be null.

resourceRetriever - The HTTP resource retriever to use, null to use the default one with the default HTTP timeouts and entity size limit.

jwkSetCache - The JWK set cache to use, null to use the default one.

Method Detail

resolveDefaultHTTPConnectTimeout

public static int resolveDefaultHTTPConnectTimeout()

Resolves the default HTTP connect timeout for JWK set retrieval, in milliseconds.

Returns:

The static constant, overridden by setting the com.nimbusds.jose.jwk.source.RemoteJWKSet.defaultHttpConnectTimeout Java system property.

resolveDefaultHTTPReadTimeout

public static int resolveDefaultHTTPReadTimeout()

Resolves the default HTTP read timeout for JWK set retrieval, in milliseconds.

Returns:

The static constant, overridden by setting the com.nimbusds.jose.jwk.source.RemoteJWKSet.defaultHttpReadTimeout Java system property.

resolveDefaultHTTPSizeLimit

public static int resolveDefaultHTTPSizeLimit()

Resolves default HTTP entity size limit for JWK set retrieval, in bytes.

Returns:

The static constant, overridden by setting the com.nimbusds.jose.jwk.source.RemoteJWKSet.defaultHttpSizeLimit Java system property.

getJWKSetURL

public URL getJWKSetURL()

Returns the JWK set URL.

Returns:

The JWK set URL.

getResourceRetriever

public ResourceRetriever getResourceRetriever()

Returns the HTTP resource retriever.

Returns:

The HTTP resource retriever.

getJWKSetCache

public JWKSetCache getJWKSetCache()

Returns the configured JWK set cache.

Returns:

The JWK set cache.

getCachedJWKSet

public JWKSet getCachedJWKSet()

Returns the cached JWK set.

Returns:

The cached JWK set, null if none or expired.

getFirstSpecifiedKeyID

protected static String getFirstSpecifiedKeyID(JWKMatcher jwkMatcher)

Returns the first specified key ID (kid) for a JWK matcher.

Parameters:

jwkMatcher - The JWK matcher. Must not be null.

Returns:

The first key ID, null if none.

get

public List<JWK> get(JWKSelector jwkSelector,
                     C context)
              throws RemoteKeySourceException

Retrieves a list of JWKs matching the specified selector. The security context is ignored.

Specified by:

get in interface JWKSource<C extends SecurityContext>

Parameters:

jwkSelector - A JWK selector. Must not be null.

context - Optional context, null if not required.

Returns:

The matching JWKs, empty list if no matches were found.

Throws:

RemoteKeySourceException