Package org.keycloak.protocol.oidc.par.endpoints

Class ParEndpoint

java.lang.Object

org.keycloak.protocol.oidc.par.endpoints.AbstractParEndpoint

org.keycloak.protocol.oidc.par.endpoints.ParEndpoint

public class ParEndpoint
extends AbstractParEndpoint

Pushed Authorization Request endpoint

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CACHE_KEY_PREFIX
static final String	PAR_CLIENT_ID
static final String	PAR_CREATED_TIME
static final String	PAR_DPOP_PROOF_JKT
static final String	REQUEST_URI_PREFIX
static final int	REQUEST_URI_PREFIX_LENGTH

Fields inherited from class org.keycloak.protocol.oidc.par.endpoints.AbstractParEndpoint

client, cors, event, realm, session

Constructor Summary

Constructors

Constructor	Description
ParEndpoint(KeycloakSession session, EventBuilder event)

Method Summary

Modifier and Type	Method	Description
static String	buildCacheKey(String realmId, String key)	Builds the realm-scoped cache key for a PAR entry.
static void	flattenDecodedFormParametersToParamsMap(jakarta.ws.rs.core.MultivaluedMap<String,String> decodedFormParameters, Map<String,String> params)	Flattens the given decodedFormParameters MultivaluedMap to a plain Map.
static jakarta.ws.rs.core.UriBuilder	parUrl(jakarta.ws.rs.core.UriBuilder baseUriBuilder)
jakarta.ws.rs.core.Response	request()

Methods inherited from class org.keycloak.protocol.oidc.par.endpoints.AbstractParEndpoint

authorizeClient, checkRealm, checkSsl, errorResponseException, getHash

Methods inherited from class java.lang.Object

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

Field Details

PAR_CREATED_TIME

public static final String PAR_CREATED_TIME

See Also:

• Constant Field Values

PAR_DPOP_PROOF_JKT

public static final String PAR_DPOP_PROOF_JKT

See Also:

• Constant Field Values

PAR_CLIENT_ID

public static final String PAR_CLIENT_ID

See Also:

• Constant Field Values

REQUEST_URI_PREFIX

public static final String REQUEST_URI_PREFIX

See Also:

• Constant Field Values

REQUEST_URI_PREFIX_LENGTH

public static final int REQUEST_URI_PREFIX_LENGTH

CACHE_KEY_PREFIX

public static final String CACHE_KEY_PREFIX

See Also:

• Constant Field Values

Constructor Details

ParEndpoint

public ParEndpoint(KeycloakSession session,
 EventBuilder event)

Method Details

parUrl

public static jakarta.ws.rs.core.UriBuilder parUrl(jakarta.ws.rs.core.UriBuilder baseUriBuilder)

request

@Path("/")
@POST
@Consumes("application/x-www-form-urlencoded")
@Produces("application/json")
public jakarta.ws.rs.core.Response request()

buildCacheKey

public static String buildCacheKey(String realmId,
 String key)

Builds the realm-scoped cache key for a PAR entry. The realm ID is included so that a request_uri issued in one realm cannot be consumed by the authorization endpoint of another realm.

flattenDecodedFormParametersToParamsMap

public static void flattenDecodedFormParametersToParamsMap(jakarta.ws.rs.core.MultivaluedMap<String,String> decodedFormParameters,
 Map<String,String> params)

Flattens the given decodedFormParameters MultivaluedMap to a plain Map. Rationale: The SingleUseObjectProvider used as store for PARs only accepts Map so that MultivaluedMap needs to be converted to Map.

Parameters:

decodedFormParameters - form parameters sent in request body

params - target parameter Map