com.nimbusds.jose.proc

Class JWSAlgorithmFamilyJWSKeySelector<C extends SecurityContext>

java.lang.Object

com.nimbusds.jose.proc.JWSAlgorithmFamilyJWSKeySelector<C>

All Implemented Interfaces:

JWSKeySelector<C>

public class JWSAlgorithmFamilyJWSKeySelector<C extends SecurityContext>
extends Object
implements JWSKeySelector<C>

A JWSKeySelector that expects an algorithm from a specified algorithm family.

Since:

2019-07-12

Author:

Josh Cummings

Constructor Summary

Constructors

Constructor and Description
JWSAlgorithmFamilyJWSKeySelector(JWSAlgorithm.Family jwsAlgFamily, JWKSource<C> jwkSource) Creates a JWSKeySelector that matches any algorithm from the given JWSAlgorithm.Family.

Method Summary

Modifier and Type	Method and Description
static <C extends SecurityContext> JWSAlgorithmFamilyJWSKeySelector<C>	fromJWKSetURL(URL jwkSetURL) Queries the given JWK Set URL for keys, creating a JWSAlgorithmFamilyJWSKeySelector based on the RSA or EC key type, whichever comes back first.
static <C extends SecurityContext> JWSAlgorithmFamilyJWSKeySelector<C>	fromJWKSource(JWKSource<C> jwkSource) Queries the given JWKSource for keys, creating a JWSAlgorithmFamilyJWSKeySelector based on the RSA or EC key type, whichever comes back first.
JWKSource<C>	getJWKSource() Returns the JWK source.
List<? extends Key>	selectJWSKeys(JWSHeader header, C context) Selects key candidates for verifying a JWS object.

Methods inherited from class java.lang.Object

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

Constructor Detail

JWSAlgorithmFamilyJWSKeySelector

public JWSAlgorithmFamilyJWSKeySelector(JWSAlgorithm.Family jwsAlgFamily,
                                        JWKSource<C> jwkSource)

Creates a JWSKeySelector that matches any algorithm from the given JWSAlgorithm.Family.

Parameters:

jwsAlgFamily - The JWSAlgorithm.Family to use.

jwkSource - The JWKSource from which to draw the set of JWKs.

Method Detail

selectJWSKeys

public List<? extends Key> selectJWSKeys(JWSHeader header,
                                         C context)
                                  throws KeySourceException

Description copied from interface: JWSKeySelector

Selects key candidates for verifying a JWS object.

Specified by:

selectJWSKeys in interface JWSKeySelector<C extends SecurityContext>

Parameters:

header - The header of the JWS object. Must not be null.

context - Optional context of the JWS object, null if not required.

Returns:

The key candidates in trial order, empty list if none.

Throws:

KeySourceException - If a key sourcing exception is encountered, e.g. on remote JWK retrieval.

fromJWKSetURL

public static <C extends SecurityContext> JWSAlgorithmFamilyJWSKeySelector<C> fromJWKSetURL(URL jwkSetURL)
                                                                                     throws KeySourceException

Queries the given JWK Set URL for keys, creating a JWSAlgorithmFamilyJWSKeySelector based on the RSA or EC key type, whichever comes back first.

Type Parameters:

C - The SecurityContext

Parameters:

jwkSetURL - The JWK Set URL to query.

Returns:

An instance of JWSAlgorithmFamilyJWSKeySelector.

Throws:

KeySourceException - if the JWKs cannot be retrieved or no RSA or EC public JWKs are found.

fromJWKSource

public static <C extends SecurityContext> JWSAlgorithmFamilyJWSKeySelector<C> fromJWKSource(JWKSource<C> jwkSource)
                                                                                     throws KeySourceException

Queries the given JWKSource for keys, creating a JWSAlgorithmFamilyJWSKeySelector based on the RSA or EC key type, whichever comes back first.

Type Parameters:

C - The SecurityContext.

Parameters:

jwkSource - The JWKSource.

Returns:

An instance of JWSAlgorithmFamilyJWSKeySelector.

Throws:

KeySourceException - If the JWKs cannot be retrieved or no RSA or EC public JWKs are found.

getJWKSource

public JWKSource<C> getJWKSource()

Returns the JWK source.

Returns:

The JWK source.