Package com.pingidentity.access

Class JwksEndpointKeyAccessor

java.lang.Object

com.pingidentity.access.JwksEndpointKeyAccessor

public final class JwksEndpointKeyAccessor
extends Object

This class provides access to PingFederate's JSON web keys. These keys are exposed at the /pf/JWKS endpoint; partners are able to use the endpoint contents to verify JWT signatures.

Since:

10.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JwksEndpointKeyAccessor.JsonWebKeyWrapper	The JSON web key wrapper object containing the Key ID, JSON web key and the private key.

Method Summary

Modifier and Type	Method	Description
JwksEndpointKeyAccessor.JsonWebKeyWrapper	getCurrentEcKey(String curveName)	Returns an instance of JwksEndpointKeyAccessor.JsonWebKeyWrapper populated with the current EC signing key associated with the curve name or null if the EC signing key associated with the requested curve is not present.
JwksEndpointKeyAccessor.JsonWebKeyWrapper	getCurrentRsaKey()	Deprecated. since 11.3, getCurrentRsaKey(String) should be used instead.
JwksEndpointKeyAccessor.JsonWebKeyWrapper	getCurrentRsaKey(String signingAlgorithm)	Returns an instance of JwksEndpointKeyAccessor.JsonWebKeyWrapper populated with current RSA signing key or null if RSA signing key is not present.
org.jose4j.jwk.JsonWebKeySet	getDecryptionKeys()	Returns a JsonWebKeySet instance containing all available decryption keys
JwksEndpointKeyAccessor.JsonWebKeyWrapper	getKeyById(String kid)	Returns an instance of JwksEndpointKeyAccessor.JsonWebKeyWrapper populated with a JWK representing the kid parameter or null if the JWK is not found.
org.jose4j.jwk.JsonWebKeySet	getSigningJsonWebKeySet()	Returns a JsonWebKeySet instance containing all available internal JSON web keys
static JwksEndpointKeyAccessor	newInstance()	Returns a new instance of JwksEndpointKeyAccessor

Methods inherited from class java.lang.Object

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

Method Details

newInstance

public static JwksEndpointKeyAccessor newInstance()

Returns a new instance of JwksEndpointKeyAccessor

Returns:

a new instance of JwksEndpointKeyAccessor

Since:

10.1

getCurrentRsaKey

@Deprecated
public JwksEndpointKeyAccessor.JsonWebKeyWrapper getCurrentRsaKey()

Deprecated.

since 11.3, getCurrentRsaKey(String) should be used instead.

Returns an instance of JwksEndpointKeyAccessor.JsonWebKeyWrapper populated with current RSA signing key or null if RSA signing key is not present.

Returns:

an instance of JwksEndpointKeyAccessor.JsonWebKeyWrapper or null

Since:

10.1

getCurrentRsaKey

public JwksEndpointKeyAccessor.JsonWebKeyWrapper getCurrentRsaKey(String signingAlgorithm)

Returns an instance of JwksEndpointKeyAccessor.JsonWebKeyWrapper populated with current RSA signing key or null if RSA signing key is not present.

Parameters:

signingAlgorithm - Signing algorithm the RSA key is intended to be used for.

Returns:

an instance of JwksEndpointKeyAccessor.JsonWebKeyWrapper intended to be used with the inout signing algorithm or null

Since:

11.3

getCurrentEcKey

public JwksEndpointKeyAccessor.JsonWebKeyWrapper getCurrentEcKey(String curveName)

Returns an instance of JwksEndpointKeyAccessor.JsonWebKeyWrapper populated with the current EC signing key associated with the curve name or null if the EC signing key associated with the requested curve is not present.

Parameters:

curveName - the curve name associated with the EC signing key to find

Returns:

an instance of JwksEndpointKeyAccessor.JsonWebKeyWrapper or null

Since:

10.1

getKeyById

public JwksEndpointKeyAccessor.JsonWebKeyWrapper getKeyById(String kid)

Returns an instance of JwksEndpointKeyAccessor.JsonWebKeyWrapper populated with a JWK representing the kid parameter or null if the JWK is not found.

Parameters:

kid - the ID of the key to find

Returns:

an instance of JwksEndpointKeyAccessor.JsonWebKeyWrapper or null

Since:

10.1

getSigningJsonWebKeySet

public org.jose4j.jwk.JsonWebKeySet getSigningJsonWebKeySet()

Returns a JsonWebKeySet instance containing all available internal JSON web keys

Returns:

a JsonWebKeySet instance

Since:

10.1

getDecryptionKeys

public org.jose4j.jwk.JsonWebKeySet getDecryptionKeys()

Returns a JsonWebKeySet instance containing all available decryption keys

Returns:

a JsonWebKeySet instance

Since:

11.3