Package org.keycloak.protocol.oidc.grants.ciba.endpoints

Class BackchannelAuthenticationCallbackEndpoint

java.lang.Object

org.keycloak.protocol.oidc.grants.ciba.endpoints.AbstractCibaEndpoint

org.keycloak.protocol.oidc.grants.ciba.endpoints.BackchannelAuthenticationCallbackEndpoint

public class BackchannelAuthenticationCallbackEndpoint
extends AbstractCibaEndpoint

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	BackchannelAuthenticationCallbackEndpoint.BackchannelAuthCallbackContext

Field Summary

Fields inherited from class org.keycloak.protocol.oidc.grants.ciba.endpoints.AbstractCibaEndpoint

event, realm, session

Constructor Summary

Constructors

Constructor	Description
BackchannelAuthenticationCallbackEndpoint(KeycloakSession session, EventBuilder event)

Method Summary

Modifier and Type	Method	Description
protected void	approveRequest(String authReqId, Map<String,String> additionalParams)	Approves the request respectively the code.
protected void	cancelRequest(String authResultId)	Handels the cancellation of an authentication request.
protected void	denyRequest(String authReqId, AuthenticationChannelResponse.Status status)
protected String	getRawBearerToken(jakarta.ws.rs.core.HttpHeaders httpHeaders, AuthenticationChannelResponse response)	Extracts the raw bearer token from the request.
protected AuthenticationChannelResponse.Status	preApprove(AuthenticationChannelResponse response)	Is called before the request approving, allows additional validation of other factors.
jakarta.ws.rs.core.Response	processAuthenticationChannelResult(AuthenticationChannelResponse response)
protected void	sendClientNotificationRequest(ClientModel client, CibaConfig cibaConfig, OAuth2DeviceCodeModel deviceModel)
protected BackchannelAuthenticationCallbackEndpoint.BackchannelAuthCallbackContext	verifyAuthenticationRequest(String rawBearerToken)

Methods inherited from class org.keycloak.protocol.oidc.grants.ciba.endpoints.AbstractCibaEndpoint

authenticateClient, checkRealm, checkSsl

Methods inherited from class java.lang.Object

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

Constructor Details

BackchannelAuthenticationCallbackEndpoint

public BackchannelAuthenticationCallbackEndpoint(KeycloakSession session,
 EventBuilder event)

Method Details

processAuthenticationChannelResult

@Path("/")
@POST
@Consumes("application/json")
@Produces("application/json")
public jakarta.ws.rs.core.Response processAuthenticationChannelResult(AuthenticationChannelResponse response)

verifyAuthenticationRequest

protected BackchannelAuthenticationCallbackEndpoint.BackchannelAuthCallbackContext verifyAuthenticationRequest(String rawBearerToken)

cancelRequest

protected void cancelRequest(String authResultId)

Handels the cancellation of an authentication request.

Parameters:

authResultId - The id to identify the request.

preApprove

protected AuthenticationChannelResponse.Status preApprove(AuthenticationChannelResponse response)

Is called before the request approving, allows additional validation of other factors.

Parameters:

response - The AuthenticationChannelResponse to work with.

Returns:

The AuthenticationChannelResponse.Status of the response, after pre-approving.

approveRequest

protected void approveRequest(String authReqId,
 Map<String,String> additionalParams)

Approves the request respectively the code.

Parameters:

authReqId - The id to identify the request.

additionalParams - Additional parameters.

denyRequest

protected void denyRequest(String authReqId,
 AuthenticationChannelResponse.Status status)

getRawBearerToken

protected String getRawBearerToken(jakarta.ws.rs.core.HttpHeaders httpHeaders,
 AuthenticationChannelResponse response)

Extracts the raw bearer token from the request.

Parameters:

httpHeaders - The request headers.

response - The AuthenticationChannelResponse

Returns:

The raw bearer token.

sendClientNotificationRequest

protected void sendClientNotificationRequest(ClientModel client,
 CibaConfig cibaConfig,
 OAuth2DeviceCodeModel deviceModel)