Class OAuth2GrantTypeBase

java.lang.Object
org.keycloak.protocol.oidc.grants.OAuth2GrantTypeBase
All Implemented Interfaces:
OAuth2GrantType, Provider
Direct Known Subclasses:
AuthorizationCodeGrantType, CibaGrantType, ClientCredentialsGrantType, DeviceGrantType, JWTAuthorizationGrantType, PermissionGrantType, PreAuthorizedCodeGrantType, RefreshTokenGrantType, ResourceOwnerPasswordCredentialsGrantType, TokenExchangeGrantType

public abstract class OAuth2GrantTypeBase extends Object implements OAuth2GrantType
Base class for OAuth 2.0 grant types
Author:
Dmitry Telegin (et al.)
  • Field Details

  • Constructor Details

    • OAuth2GrantTypeBase

      public OAuth2GrantTypeBase()
  • Method Details

    • setContext

      protected void setContext(OAuth2GrantType.Context context)
    • createTokenResponseBuilder

      protected TokenManager.AccessTokenResponseBuilder createTokenResponseBuilder(UserModel user, UserSessionModel userSession, ClientSessionContext clientSessionCtx, String scopeParam, Function<TokenManager.AccessTokenResponseBuilder,ClientPolicyContext> clientPolicyContextGenerator)
    • createTokenResponse

      protected jakarta.ws.rs.core.Response createTokenResponse(TokenManager.AccessTokenResponseBuilder responseBuilder, ClientSessionContext clientSessionCtx, boolean code)
    • createTokenResponse

      protected jakarta.ws.rs.core.Response createTokenResponse(UserModel user, UserSessionModel userSession, ClientSessionContext clientSessionCtx, String scopeParam, boolean code, Function<TokenManager.AccessTokenResponseBuilder,ClientPolicyContext> clientPolicyContextGenerator)
    • checkAndBindMtlsHoKToken

      protected void checkAndBindMtlsHoKToken(TokenManager.AccessTokenResponseBuilder responseBuilder, boolean useRefreshToken)
    • updateClientSession

      protected void updateClientSession(AuthenticatedClientSessionModel clientSession)
    • updateUserSessionFromClientAuth

      protected void updateUserSessionFromClientAuth(UserSessionModel userSession)
    • getRequestedScopes

      protected String getRequestedScopes()
    • checkClient

      protected void checkClient()
    • addCustomTokenResponseClaims

      protected void addCustomTokenResponseClaims(org.keycloak.representations.AccessTokenResponse res, ClientSessionContext clientSessionCtx)
      Extension point for subclasses to add custom claims to the AccessTokenResponse before it is returned. Default implementation does nothing.
    • afterAuthorizationDetailsProcessed

      protected void afterAuthorizationDetailsProcessed(UserSessionModel userSession, ClientSessionContext clientSessionCtx, List<org.keycloak.representations.AuthorizationDetailsJSONRepresentation> authorizationDetailsResponse)
      Hook method called after authorization_details are processed and before the token response is created. This allows authorization details processors to perform post-processing actions (e.g., creating state objects). Processors can store information in session notes during processing, and this hook allows them to act on it. Default implementation does nothing.
      Parameters:
      userSession - the user session
      clientSessionCtx - the client session context
      authorizationDetailsResponse - the processed authorization details response
    • processAuthorizationDetails

      protected List<org.keycloak.representations.AuthorizationDetailsJSONRepresentation> processAuthorizationDetails(UserSessionModel userSession, ClientSessionContext clientSessionCtx)
      Processes the authorization_details parameter using provider discovery. This method can be overridden by subclasses to customize the behavior.
      Parameters:
      userSession - the user session
      clientSessionCtx - the client session context
      Returns:
      the authorization details response if processing was successful, null otherwise
    • handleMissingAuthorizationDetails

      protected List<org.keycloak.representations.AuthorizationDetailsJSONRepresentation> handleMissingAuthorizationDetails(UserSessionModel userSession, ClientSessionContext clientSessionCtx)
      Allows processors to generate an authorization details response when the authorization_details parameter is missing in the request. This applies to flows where pre-authorization or credential offers are present, and is general to all AuthorizationDetailsProcessor implementations.
      Parameters:
      userSession - the user session
      clientSessionCtx - the client session context
      Returns:
      the authorization details response if generation was successful, null otherwise
    • processStoredAuthorizationDetails

      protected List<org.keycloak.representations.AuthorizationDetailsJSONRepresentation> processStoredAuthorizationDetails(UserSessionModel userSession, ClientSessionContext clientSessionCtx) throws CorsErrorResponseException
      Process stored authorization_details from the authorization request (e.g., from PAR). This method is specifically for Authorization Code Flow where authorization_details was used in the authorization request but is missing from the token request.
      Parameters:
      userSession - the user session
      clientSessionCtx - the client session context
      Returns:
      the authorization details response if processing was successful, null otherwise
      Throws:
      CorsErrorResponseException
    • useRefreshToken

      protected boolean useRefreshToken()
    • close

      public void close()
      Specified by:
      close in interface Provider