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

Class CibaGrantType

java.lang.Object

org.keycloak.protocol.oidc.grants.OAuth2GrantTypeBase

org.keycloak.protocol.oidc.grants.ciba.CibaGrantType

All Implemented Interfaces:

OAuth2GrantType, Provider

public class CibaGrantType
extends OAuth2GrantTypeBase

OpenID Connect Client-Initiated Backchannel Authentication Flow https://openid.net/specs/openid-client-initiated-backchannel-authentication-core-1_0.html#rfc.section.10.1

Author:

Pedro Igor

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.protocol.oidc.grants.OAuth2GrantType

OAuth2GrantType.Context

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADDITIONAL_BACKCHANNEL_REQ_PARAMS_PREFIX	Prefix used to store additional params from the backchannel authentication request into AuthenticationSessionModel note to be available later in Authenticators, RequiredActions etc.
static final String	ADDITIONAL_CALLBACK_PARAMS_PREFIX	Prefix used to store additional params from the original authentication callback response into AuthenticationSessionModel note to be available later in Authenticators, RequiredActions etc.
static final String	AUTH_REQ_ID
static final String	BINDING_MESSAGE
static final String	CLIENT_NOTIFICATION_TOKEN
static final String	IS_CONSENT_REQUIRED
static final String	LOGIN_HINT
static final String	LOGIN_HINT_TOKEN
static final String	REQUEST
static final String	REQUEST_URI
static final String	REQUESTED_EXPIRY
static final String	USER_CODE

Fields inherited from class org.keycloak.protocol.oidc.grants.OAuth2GrantTypeBase

client, clientAuthAttributes, clientConfig, clientConnection, context, cors, event, formParams, headers, realm, request, response, session, tokenManager

Constructor Summary

Constructors

Constructor	Description
CibaGrantType()

Method Summary

Modifier and Type	Method	Description
static jakarta.ws.rs.core.UriBuilder	authenticationUrl(jakarta.ws.rs.core.UriBuilder baseUriBuilder)
static jakarta.ws.rs.core.UriBuilder	authorizationUrl(jakarta.ws.rs.core.UriBuilder baseUriBuilder)
EventType	getEventType()	Returns the event type associated with this OAuth 2.0 grant type.
Set<String>	getTokenParameterNames()	Name of the "token" parameters, which this grant type supports.
jakarta.ws.rs.core.Response	process(OAuth2GrantType.Context context)	Processes grant request.

Methods inherited from class org.keycloak.protocol.oidc.grants.OAuth2GrantTypeBase

addCustomTokenResponseClaims, afterAuthorizationDetailsProcessed, checkAndBindMtlsHoKToken, checkClient, close, createTokenResponse, createTokenResponse, createTokenResponseBuilder, getRequestedScopes, handleMissingAuthorizationDetails, processAuthorizationDetails, processStoredAuthorizationDetails, setContext, updateClientSession, updateUserSessionFromClientAuth, useRefreshToken

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.protocol.oidc.grants.OAuth2GrantType

getSupportedMultivaluedRequestParameters, isTokenAllowed

Field Details

IS_CONSENT_REQUIRED

public static final String IS_CONSENT_REQUIRED

See Also:

• Constant Field Values

LOGIN_HINT

public static final String LOGIN_HINT

See Also:

• Constant Field Values

LOGIN_HINT_TOKEN

public static final String LOGIN_HINT_TOKEN

See Also:

• Constant Field Values

BINDING_MESSAGE

public static final String BINDING_MESSAGE

See Also:

• Constant Field Values

AUTH_REQ_ID

public static final String AUTH_REQ_ID

See Also:

• Constant Field Values

CLIENT_NOTIFICATION_TOKEN

public static final String CLIENT_NOTIFICATION_TOKEN

See Also:

• Constant Field Values

REQUESTED_EXPIRY

public static final String REQUESTED_EXPIRY

See Also:

• Constant Field Values

USER_CODE

public static final String USER_CODE

See Also:

• Constant Field Values

REQUEST

public static final String REQUEST

See Also:

• Constant Field Values

REQUEST_URI

public static final String REQUEST_URI

See Also:

• Constant Field Values

ADDITIONAL_CALLBACK_PARAMS_PREFIX

public static final String ADDITIONAL_CALLBACK_PARAMS_PREFIX

Prefix used to store additional params from the original authentication callback response into AuthenticationSessionModel note to be available later in Authenticators, RequiredActions etc. Prefix is used to prevent collisions with internally used notes.

See Also:

• AuthenticationSessionModel.getClientNote(String)
• Constant Field Values

ADDITIONAL_BACKCHANNEL_REQ_PARAMS_PREFIX

public static final String ADDITIONAL_BACKCHANNEL_REQ_PARAMS_PREFIX

Prefix used to store additional params from the backchannel authentication request into AuthenticationSessionModel note to be available later in Authenticators, RequiredActions etc. Prefix is used to prevent collisions with internally used notes.

See Also:

• AuthenticationSessionModel.getClientNote(String)
• Constant Field Values

Constructor Details

CibaGrantType

public CibaGrantType()

Method Details

authorizationUrl

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

authenticationUrl

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

process

public jakarta.ws.rs.core.Response process(OAuth2GrantType.Context context)

Description copied from interface: OAuth2GrantType

Processes grant request.

Parameters:

context - grant request context

Returns:

token response

getEventType

public EventType getEventType()

Description copied from interface: OAuth2GrantType

Returns the event type associated with this OAuth 2.0 grant type.

Returns:

event type

getTokenParameterNames

public Set<String> getTokenParameterNames()

Description copied from interface: OAuth2GrantType

Name of the "token" parameters, which this grant type supports. As 'token' parameter is considered a parameter containing possibly long token (for example big JWT or SAML assertion) with unbounded data (For example possibly big amount of roles inside JWT). Example of such parameter is for example 'subject_token' parameter case of token exchange grant.

Returns:

set of strings with the "token" parameters supported by this grant type