Package net.shibboleth.idp.plugin.authn.duo.impl

Class HealthCheckDuoOIDCAuthAPI

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction

org.opensaml.profile.action.AbstractConditionalProfileAction

net.shibboleth.idp.profile.AbstractProfileAction

net.shibboleth.idp.authn.AbstractAuthenticationAction

net.shibboleth.idp.plugin.authn.duo.AbstractDuoAuthenticationAction

net.shibboleth.idp.plugin.authn.duo.impl.HealthCheckDuoOIDCAuthAPI

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, MessageSource, MessageSourceAware, Action

public class HealthCheckDuoOIDCAuthAPI
extends AbstractDuoAuthenticationAction

An action that checks the health of the Duo 2FA endpoint for the established Duo integration. An AuthnEventIds.AUTHN_EXCEPTION event is emitted if the health endpoint is unreachable or unhealthy (unhealthy can also mean the client details are incorrect e.g. the client is not registered with Duo).

Event:

EventIds.PROCEED_EVENT_ID, EventIds.IO_ERROR

Precondition:

      ProfileRequestContext.getSubcontext(AuthenticationContext.class, false) != null
      

,

      AuthenticationContext.getSubcontext(DuoOIDCAuthenticationContext.class, false) != null
      

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	log	Class logger.

Constructor Summary

Constructors

Constructor	Description
HealthCheckDuoOIDCAuthAPI()

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext, AuthenticationContext authenticationContext, DuoOIDCAuthenticationContext duoContext)	Performs this Duo authentication action using the supplied Duo context.

Methods inherited from class net.shibboleth.idp.plugin.authn.duo.AbstractDuoAuthenticationAction

doExecute, doPreExecute, doPreExecute, setDuoContextLookupStrategy

Methods inherited from class net.shibboleth.idp.authn.AbstractAuthenticationAction

doExecute, doPreExecute, setAuthenticationContextLookupStrategy

Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction

doExecute, execute, getBean, getBean, getMessage, getMessage, getMessage, getParameter, getParameter, getProfileContextLookupStrategy, getRequestContext, getResult, setMessageSource, setProfileContextLookupStrategy

Methods inherited from class org.opensaml.profile.action.AbstractConditionalProfileAction

getActivationCondition, setActivationCondition

Methods inherited from class org.opensaml.profile.action.AbstractProfileAction

doPostExecute, doPostExecute, ensureHttpServletRequest, ensureHttpServletResponse, execute, getHttpServletRequest, getHttpServletRequestSupplier, getHttpServletResponse, getHttpServletResponseSupplier, getLogPrefix, isPreExecuteCalled, setHttpServletRequestSupplier, setHttpServletResponseSupplier

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, doInitialize, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.shared.component.InitializableComponent

initialize, isInitialized

Field Details

log

@Nonnull
@NotEmpty
private final org.slf4j.Logger log

Class logger.

Constructor Details

HealthCheckDuoOIDCAuthAPI

public HealthCheckDuoOIDCAuthAPI()

Method Details

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext,
 @Nonnull
 AuthenticationContext authenticationContext,
 @Nonnull
 DuoOIDCAuthenticationContext duoContext)

Description copied from class: AbstractDuoAuthenticationAction

Performs this Duo authentication action using the supplied Duo context. Implementations should override this method.

Overrides:

doExecute in class AbstractDuoAuthenticationAction

Parameters:

profileRequestContext - the current IdP profile request context

authenticationContext - the current authentication context

duoContext - the Duo authentication context