org.keycloak.adapters.saml.tomcat

Class SamlAuthenticatorValve

java.lang.Object

org.apache.catalina.util.LifecycleBase

org.apache.catalina.util.LifecycleMBeanBase

org.apache.catalina.valves.ValveBase

org.apache.catalina.authenticator.AuthenticatorBase

org.apache.catalina.authenticator.FormAuthenticator

org.keycloak.adapters.saml.AbstractSamlAuthenticatorValve

org.keycloak.adapters.saml.tomcat.SamlAuthenticatorValve

All Implemented Interfaces:

MBeanRegistration, org.apache.catalina.Authenticator, org.apache.catalina.Contained, org.apache.catalina.JmxEnabled, org.apache.catalina.Lifecycle, org.apache.catalina.LifecycleListener, org.apache.catalina.Valve

public class SamlAuthenticatorValve
extends AbstractSamlAuthenticatorValve

Keycloak authentication valve

Version:

$Revision: 1 $

Author:

Bill Burke

Field Summary

Fields inherited from class org.keycloak.adapters.saml.AbstractSamlAuthenticatorValve

deploymentContext, idMapperUpdater, mapper, TOKEN_STORE_NOTE, userSessionManagement

Fields inherited from class org.apache.catalina.authenticator.FormAuthenticator

characterEncoding, landingPage

Fields inherited from class org.apache.catalina.authenticator.AuthenticatorBase

alwaysUseSession, AUTH_HEADER_NAME, cache, changeSessionIdOnAuthentication, context, disableProxyCaching, REALM_NAME, securePagesWithPragma, secureRandomAlgorithm, secureRandomClass, secureRandomProvider, sessionIdGenerator, sm, sso

Fields inherited from class org.apache.catalina.valves.ValveBase

asyncSupported, container, containerLog, next

Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase

mserver

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

Constructors

Constructor and Description
SamlAuthenticatorValve()

Method Summary

Modifier and Type	Method and Description
boolean	authenticate(org.apache.catalina.connector.Request request, javax.servlet.http.HttpServletResponse response) Method called by Tomcat < 8.5.5
protected org.keycloak.adapters.tomcat.GenericPrincipalFactory	createPrincipalFactory()
protected SamlSessionStore	createSessionStore(org.apache.catalina.connector.Request request, org.keycloak.adapters.spi.HttpFacade facade, SamlDeployment resolvedDeployment)
protected boolean	doAuthenticate(org.apache.catalina.connector.Request request, javax.servlet.http.HttpServletResponse response) Method called by Tomcat >= 8.5.5
protected boolean	forwardToErrorPageInternal(org.apache.catalina.connector.Request request, javax.servlet.http.HttpServletResponse response, Object loginConfig)
protected void	initInternal()
void	logout(org.apache.catalina.connector.Request request)

Methods inherited from class org.keycloak.adapters.saml.AbstractSamlAuthenticatorValve

addTokenStoreUpdaters, authenticateInternal, beforeStop, executeAuthenticator, forwardToLogoutPage, getIdMapperUpdater, getSessionStore, invoke, keycloakInit, keycloakRestoreRequest, keycloakSaveRequest, lifecycleEvent, logoutInternal, setIdMapperUpdater

Methods inherited from class org.apache.catalina.authenticator.FormAuthenticator

forwardToErrorPage, forwardToLoginPage, getAuthMethod, getCharacterEncoding, getLandingPage, matchRequest, restoreRequest, savedRequestURL, saveRequest, setCharacterEncoding, setLandingPage

Methods inherited from class org.apache.catalina.authenticator.AuthenticatorBase

associate, doLogin, getAlwaysUseSession, getCache, getChangeSessionIdOnAuthentication, getContainer, getDisableProxyCaching, getRealmName, getRequestCertificates, getSecurePagesWithPragma, getSecureRandomAlgorithm, getSecureRandomClass, getSecureRandomProvider, login, reauthenticateFromSSO, register, setAlwaysUseSession, setCache, setChangeSessionIdOnAuthentication, setContainer, setDisableProxyCaching, setSecurePagesWithPragma, setSecureRandomAlgorithm, setSecureRandomClass, setSecureRandomProvider, startInternal, stopInternal

Methods inherited from class org.apache.catalina.valves.ValveBase

backgroundProcess, event, getDomainInternal, getNext, getObjectNameKeyProperties, isAsyncSupported, setAsyncSupported, setNext, toString

Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase

destroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister

Methods inherited from class org.apache.catalina.util.LifecycleBase

addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, init, removeLifecycleListener, setState, setState, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

SamlAuthenticatorValve

public SamlAuthenticatorValve()

Method Detail

authenticate

public boolean authenticate(org.apache.catalina.connector.Request request,
                            javax.servlet.http.HttpServletResponse response)
                     throws IOException

Method called by Tomcat < 8.5.5

Specified by:

authenticate in interface org.apache.catalina.Authenticator

Overrides:

authenticate in class org.apache.catalina.authenticator.FormAuthenticator

Throws:

IOException

doAuthenticate

protected boolean doAuthenticate(org.apache.catalina.connector.Request request,
                                 javax.servlet.http.HttpServletResponse response)
                          throws IOException

Method called by Tomcat >= 8.5.5

Throws:

IOException

forwardToErrorPageInternal

protected boolean forwardToErrorPageInternal(org.apache.catalina.connector.Request request,
                                             javax.servlet.http.HttpServletResponse response,
                                             Object loginConfig)
                                      throws IOException

Specified by:

forwardToErrorPageInternal in class AbstractSamlAuthenticatorValve

Throws:

IOException

initInternal

protected void initInternal()

Overrides:

initInternal in class org.apache.catalina.valves.ValveBase

logout

public void logout(org.apache.catalina.connector.Request request)

Specified by:

logout in interface org.apache.catalina.Authenticator

Overrides:

logout in class org.apache.catalina.authenticator.AuthenticatorBase

createPrincipalFactory

protected org.keycloak.adapters.tomcat.GenericPrincipalFactory createPrincipalFactory()

Specified by:

createPrincipalFactory in class AbstractSamlAuthenticatorValve

createSessionStore

protected SamlSessionStore createSessionStore(org.apache.catalina.connector.Request request,
                                              org.keycloak.adapters.spi.HttpFacade facade,
                                              SamlDeployment resolvedDeployment)

Overrides:

createSessionStore in class AbstractSamlAuthenticatorValve