Package org.keycloak.authentication

Class AuthenticationProcessor

java.lang.Object

org.keycloak.authentication.AuthenticationProcessor

Direct Known Subclasses:

ResetCredentialsActionTokenHandler.ResetCredsAuthenticationProcessor

public class AuthenticationProcessor
extends Object

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AuthenticationProcessor.Result

Field Summary

Fields

Modifier and Type	Field	Description
protected Runnable	afterResetListener
static final String	AUTHENTICATION_SELECTOR_SCREEN_DISPLAYED
protected AuthenticationSessionModel	authenticationSession
static final String	AUTHN_CREDENTIALS
static final String	BROKER_SESSION_ID
static final String	BROKER_USER_ID
protected boolean	browserFlow
protected ClientModel	client
protected Map<String,String>	clientAuthAttributes
protected ClientConnection	connection
static final String	CURRENT_AUTHENTICATION_EXECUTION
static final String	CURRENT_FLOW_PATH
protected EventBuilder	event
static final String	FIRST_OFFLINE_ACCESS
protected String	flowId
protected String	flowPath
static final String	FORKED_FROM
static final String	FORWARDED_PASSIVE_LOGIN
protected org.keycloak.authentication.AuthenticationProcessor.ForwardedFormMessageStore	forwardedErrorMessageStore	This could be an error message forwarded from another authenticator
protected org.keycloak.authentication.AuthenticationProcessor.ForwardedFormMessageStore	forwardedInfoMessageStore	This could be an success message forwarded from another authenticator
protected org.keycloak.authentication.AuthenticationProcessor.ForwardedFormMessageStore	forwardedSuccessMessageStore	This could be an success message forwarded from another authenticator
static final String	LAST_PROCESSED_EXECUTION
protected static final org.jboss.logging.Logger	logger
protected BruteForceProtector	protector
protected RealmModel	realm
protected HttpRequest	request
protected KeycloakSession	session
protected jakarta.ws.rs.core.UriInfo	uriInfo
protected UserSessionModel	userSession

Constructor Summary

Constructors

Constructor	Description
AuthenticationProcessor()

Method Summary

Modifier and Type	Method	Description
ClientSessionContext	attachSession()
static ClientSessionContext	attachSession(AuthenticationSessionModel authSession, UserSessionModel userSession, KeycloakSession session, RealmModel realm, ClientConnection connection, EventBuilder event)
jakarta.ws.rs.core.Response	authenticate()
jakarta.ws.rs.core.Response	authenticateClient()
jakarta.ws.rs.core.Response	authenticateOnly()
jakarta.ws.rs.core.Response	authenticationAction(String execution)
protected jakarta.ws.rs.core.Response	authenticationComplete()
void	clearAuthenticatedUser()
static AuthenticationSessionModel	clone(KeycloakSession session, AuthenticationSessionModel authSession)
AuthenticationProcessor.Result	createAuthenticatorContext(AuthenticationExecutionModel model, Authenticator authenticator, List<AuthenticationExecutionModel> executions)
AuthenticationProcessor.Result	createClientAuthenticatorContext(AuthenticationExecutionModel model, ClientAuthenticator clientAuthenticator, List<AuthenticationExecutionModel> executions)
AuthenticationFlow	createFlowExecution(String flowId, AuthenticationExecutionModel execution)
void	evaluateRequiredActionTriggers()
jakarta.ws.rs.core.Response	finishAuthentication(LoginProtocol protocol)
String	generateCode()
AuthenticationSessionModel	getAuthenticationSession()
BruteForceProtector	getBruteForceProtector()
ClientModel	getClient()
Map<String,String>	getClientAuthAttributes()
static String	getClientData(KeycloakSession session, AuthenticationSessionModel authSession)
ClientConnection	getConnection()
EventBuilder	getEvent()
String	getFlowPath()
RealmModel	getRealm()
URI	getRefreshUrl(boolean authSessionIdParam)
HttpRequest	getRequest()
KeycloakSession	getSession()
jakarta.ws.rs.core.UriInfo	getUriInfo()
UserSessionModel	getUserSession()
jakarta.ws.rs.core.Response	handleBrowserException(Exception failure)
jakarta.ws.rs.core.Response	handleBrowserExceptionList(AuthenticationFlowException e)
jakarta.ws.rs.core.Response	handleClientAuthException(Exception failure)
boolean	isBrowserFlow()
boolean	isSuccessful(AuthenticationExecutionModel model)
void	logFailure()
EventBuilder	newEvent()
String	nextRequiredAction()
static AuthenticationSessionModel	recreate(KeycloakSession session, AuthenticationSessionModel authSession)
jakarta.ws.rs.core.Response	redirectToFlow()
void	resetFlow()
static void	resetFlow(AuthenticationSessionModel authSession, String flowPath)
AuthenticationProcessor	setAuthenticationSession(AuthenticationSessionModel authenticationSession)
void	setAutheticatedUser(UserModel user)
AuthenticationProcessor	setBrowserFlow(boolean browserFlow)
void	setClient(ClientModel client)
AuthenticationProcessor	setConnection(ClientConnection connection)
AuthenticationProcessor	setEventBuilder(EventBuilder eventBuilder)
AuthenticationProcessor	setFlowId(String flowId)
AuthenticationProcessor	setFlowPath(String flowPath)	This is the path segment to append when generating an action URL.
AuthenticationProcessor	setForwardedErrorMessage(FormMessage forwardedErrorMessage)
AuthenticationProcessor	setForwardedInfoMessage(FormMessage forwardedInfoMessage)
AuthenticationProcessor	setForwardedSuccessMessage(FormMessage forwardedSuccessMessage)
AuthenticationProcessor	setRealm(RealmModel realm)
AuthenticationProcessor	setRequest(HttpRequest request)
AuthenticationProcessor	setSession(KeycloakSession session)
AuthenticationProcessor	setUriInfo(jakarta.ws.rs.core.UriInfo uriInfo)
void	validateUser(UserModel authenticatedUser)

Methods inherited from class java.lang.Object

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

Field Details

CURRENT_AUTHENTICATION_EXECUTION

public static final String CURRENT_AUTHENTICATION_EXECUTION

See Also:

• Constant Field Values

LAST_PROCESSED_EXECUTION

public static final String LAST_PROCESSED_EXECUTION

See Also:

• Constant Field Values

CURRENT_FLOW_PATH

public static final String CURRENT_FLOW_PATH

See Also:

• Constant Field Values

FORKED_FROM

public static final String FORKED_FROM

See Also:

• Constant Field Values

AUTHN_CREDENTIALS

public static final String AUTHN_CREDENTIALS

See Also:

• Constant Field Values

BROKER_SESSION_ID

public static final String BROKER_SESSION_ID

See Also:

• Constant Field Values

BROKER_USER_ID

public static final String BROKER_USER_ID

See Also:

• Constant Field Values

FORWARDED_PASSIVE_LOGIN

public static final String FORWARDED_PASSIVE_LOGIN

See Also:

• Constant Field Values

AUTHENTICATION_SELECTOR_SCREEN_DISPLAYED

public static final String AUTHENTICATION_SELECTOR_SCREEN_DISPLAYED

See Also:

• Constant Field Values

FIRST_OFFLINE_ACCESS

public static final String FIRST_OFFLINE_ACCESS

See Also:

• Constant Field Values

logger

protected static final org.jboss.logging.Logger logger

realm

protected RealmModel realm

userSession

protected UserSessionModel userSession

authenticationSession

protected AuthenticationSessionModel authenticationSession

connection

protected ClientConnection connection

uriInfo

protected jakarta.ws.rs.core.UriInfo uriInfo

session

protected KeycloakSession session

event

protected EventBuilder event

request

protected HttpRequest request

flowId

protected String flowId

flowPath

protected String flowPath

browserFlow

protected boolean browserFlow

protector

protected BruteForceProtector protector

afterResetListener

protected Runnable afterResetListener

forwardedErrorMessageStore

protected org.keycloak.authentication.AuthenticationProcessor.ForwardedFormMessageStore forwardedErrorMessageStore

This could be an error message forwarded from another authenticator

forwardedSuccessMessageStore

protected org.keycloak.authentication.AuthenticationProcessor.ForwardedFormMessageStore forwardedSuccessMessageStore

This could be an success message forwarded from another authenticator

forwardedInfoMessageStore

protected org.keycloak.authentication.AuthenticationProcessor.ForwardedFormMessageStore forwardedInfoMessageStore

This could be an success message forwarded from another authenticator

client

protected ClientModel client

clientAuthAttributes

protected Map<String,String> clientAuthAttributes

Constructor Details

AuthenticationProcessor

public AuthenticationProcessor()

Method Details

isBrowserFlow

public boolean isBrowserFlow()

setBrowserFlow

public AuthenticationProcessor setBrowserFlow(boolean browserFlow)

getBruteForceProtector

public BruteForceProtector getBruteForceProtector()

getRealm

public RealmModel getRealm()

getClient

public ClientModel getClient()

setClient

public void setClient(ClientModel client)

getClientAuthAttributes

public Map<String,String> getClientAuthAttributes()

getAuthenticationSession

public AuthenticationSessionModel getAuthenticationSession()

getConnection

public ClientConnection getConnection()

getUriInfo

public jakarta.ws.rs.core.UriInfo getUriInfo()

getSession

public KeycloakSession getSession()

getUserSession

public UserSessionModel getUserSession()

setRealm

public AuthenticationProcessor setRealm(RealmModel realm)

setAuthenticationSession

public AuthenticationProcessor setAuthenticationSession(AuthenticationSessionModel authenticationSession)

setConnection

public AuthenticationProcessor setConnection(ClientConnection connection)

setUriInfo

public AuthenticationProcessor setUriInfo(jakarta.ws.rs.core.UriInfo uriInfo)

setSession

public AuthenticationProcessor setSession(KeycloakSession session)

setEventBuilder

public AuthenticationProcessor setEventBuilder(EventBuilder eventBuilder)

setRequest

public AuthenticationProcessor setRequest(HttpRequest request)

setFlowId

public AuthenticationProcessor setFlowId(String flowId)

setFlowPath

public AuthenticationProcessor setFlowPath(String flowPath)

This is the path segment to append when generating an action URL.

Parameters:

flowPath -

setForwardedErrorMessage

public AuthenticationProcessor setForwardedErrorMessage(FormMessage forwardedErrorMessage)

setForwardedSuccessMessage

public AuthenticationProcessor setForwardedSuccessMessage(FormMessage forwardedSuccessMessage)

setForwardedInfoMessage

public AuthenticationProcessor setForwardedInfoMessage(FormMessage forwardedInfoMessage)

generateCode

public String generateCode()

newEvent

public EventBuilder newEvent()

getEvent

public EventBuilder getEvent()

getRequest

public HttpRequest getRequest()

getFlowPath

public String getFlowPath()

setAutheticatedUser

public void setAutheticatedUser(UserModel user)

clearAuthenticatedUser

public void clearAuthenticatedUser()

getClientData

public static String getClientData(KeycloakSession session,
 AuthenticationSessionModel authSession)

getRefreshUrl

public URI getRefreshUrl(boolean authSessionIdParam)

logFailure

public void logFailure()

isSuccessful

public boolean isSuccessful(AuthenticationExecutionModel model)

handleBrowserExceptionList

public jakarta.ws.rs.core.Response handleBrowserExceptionList(AuthenticationFlowException e)

handleBrowserException

public jakarta.ws.rs.core.Response handleBrowserException(Exception failure)

handleClientAuthException

public jakarta.ws.rs.core.Response handleClientAuthException(Exception failure)

createFlowExecution

public AuthenticationFlow createFlowExecution(String flowId,
 AuthenticationExecutionModel execution)

authenticate

public jakarta.ws.rs.core.Response authenticate()
                                         throws AuthenticationFlowException

Throws:

AuthenticationFlowException

authenticateClient

public jakarta.ws.rs.core.Response authenticateClient()
                                               throws AuthenticationFlowException

Throws:

AuthenticationFlowException

redirectToFlow

public jakarta.ws.rs.core.Response redirectToFlow()

resetFlow

public void resetFlow()

resetFlow

public static void resetFlow(AuthenticationSessionModel authSession,
 String flowPath)

recreate

public static AuthenticationSessionModel recreate(KeycloakSession session,
 AuthenticationSessionModel authSession)

clone

public static AuthenticationSessionModel clone(KeycloakSession session,
 AuthenticationSessionModel authSession)

authenticationAction

public jakarta.ws.rs.core.Response authenticationAction(String execution)

authenticateOnly

public jakarta.ws.rs.core.Response authenticateOnly()
                                             throws AuthenticationFlowException

Throws:

AuthenticationFlowException

attachSession

public ClientSessionContext attachSession()

attachSession

public static ClientSessionContext attachSession(AuthenticationSessionModel authSession,
 UserSessionModel userSession,
 KeycloakSession session,
 RealmModel realm,
 ClientConnection connection,
 EventBuilder event)

evaluateRequiredActionTriggers

public void evaluateRequiredActionTriggers()

finishAuthentication

public jakarta.ws.rs.core.Response finishAuthentication(LoginProtocol protocol)

validateUser

public void validateUser(UserModel authenticatedUser)

authenticationComplete

protected jakarta.ws.rs.core.Response authenticationComplete()

nextRequiredAction

public String nextRequiredAction()

createAuthenticatorContext

public AuthenticationProcessor.Result createAuthenticatorContext(AuthenticationExecutionModel model,
 Authenticator authenticator,
 List<AuthenticationExecutionModel> executions)

createClientAuthenticatorContext

public AuthenticationProcessor.Result createClientAuthenticatorContext(AuthenticationExecutionModel model,
 ClientAuthenticator clientAuthenticator,
 List<AuthenticationExecutionModel> executions)