net.shibboleth.idp.authn.impl

Class ValidateUsernamePasswordAgainstLDAP

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction<InboundMessageType,OutboundMessageType>

org.opensaml.profile.action.AbstractConditionalProfileAction<InboundMessageType,OutboundMessageType>

net.shibboleth.idp.profile.AbstractProfileAction<InboundMessageType,OutboundMessageType>

net.shibboleth.idp.authn.AbstractAuthenticationAction<InboundMessageType,OutboundMessageType>

net.shibboleth.idp.authn.AbstractValidationAction

net.shibboleth.idp.authn.AbstractUsernamePasswordValidationAction

net.shibboleth.idp.authn.impl.ValidateUsernamePasswordAgainstLDAP

All Implemented Interfaces:

PrincipalSupportingComponent, Component, DestructableComponent, InitializableComponent, ProfileAction, org.springframework.beans.factory.Aware, org.springframework.context.MessageSource, org.springframework.context.MessageSourceAware, org.springframework.webflow.execution.Action

public class ValidateUsernamePasswordAgainstLDAP
extends AbstractUsernamePasswordValidationAction

An action that checks for a UsernamePasswordContext and directly produces an AuthenticationResult based on that identity by authenticating against an LDAP.

Event:

EventIds.PROCEED_EVENT_ID, AuthnEventIds.AUTHN_EXCEPTION, AuthnEventIds.ACCOUNT_WARNING, AuthnEventIds.ACCOUNT_ERROR, AuthnEventIds.INVALID_CREDENTIALS

Precondition:

 ProfileRequestContext.getSubcontext(AuthenticationContext.class).getAttemptedFlow() != null
 

Postcondition:

If AuthenticationContext.getSubcontext(UsernamePasswordContext.class) != null, then an AuthenticationResult is saved to the AuthenticationContext on a successful login. On a failed login, the AbstractValidationAction.handleError(ProfileRequestContext, AuthenticationContext, String, String) method is called.

Field Summary

Fields

Modifier and Type	Field and Description
private Authenticator	authenticator LDAP authenticator.
private static String	DEFAULT_METRIC_NAME Default prefix for metrics.
private org.slf4j.Logger	log Class logger.
private AuthenticationResponse	response Authentication response associated with the login.
private String[]	returnAttributes Attributes to return from authentication.

Constructor Summary

Constructors

Constructor and Description
ValidateUsernamePasswordAgainstLDAP() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doExecute(ProfileRequestContext profileRequestContext, AuthenticationContext authenticationContext)
protected void	doInitialize()
Authenticator	getAuthenticator() Returns the authenticator.
String[]	getReturnAttributes() Returns the return attributes.
protected Subject	populateSubject(Subject subject)
void	setAuthenticator(Authenticator auth) Sets the authenticator.
void	setReturnAttributes(String... attributes) Sets the return attributes.

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

doPreExecute, getLockoutManager, getUsernamePasswordContext, recordFailure, recordSuccess, removeContextAfterValidation, savePasswordToCredentialSet, setLockoutManager, setMatchExpression, setRemoveContextAfterValidation, setSavePasswordToCredentialSet

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

addDefaultPrincipals, buildAuthenticationResult, getClassifiedErrors, getMetricName, getResultCachingPredicate, getSubject, getSupportedPrincipals, handleError, handleError, handleWarning, recordFailure, recordSuccess, setAddDefaultPrincipals, setClassifiedMessages, setMetricName, setRequesterLookupStrategy, setResponderLookupStrategy, setResultCachingPredicate, setSupportedPrincipals

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

doExecute, doPreExecute, setLookupStrategy

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

doExecute, execute, getMessage, getMessage, getMessage, 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, execute, getHttpServletRequest, getHttpServletResponse, getLogPrefix, setHttpServletRequest, setHttpServletResponse

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, 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.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

DEFAULT_METRIC_NAME

@Nonnull
@NotEmpty
private static final String DEFAULT_METRIC_NAME

Default prefix for metrics.

See Also:

Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

authenticator

@Nonnull
private Authenticator authenticator

LDAP authenticator.

returnAttributes

@Nullable
private String[] returnAttributes

Attributes to return from authentication.

response

@Nullable
private AuthenticationResponse response

Authentication response associated with the login.

Constructor Detail

ValidateUsernamePasswordAgainstLDAP

public ValidateUsernamePasswordAgainstLDAP()

Constructor.

Method Detail

getAuthenticator

@NonnullAfterInit
public Authenticator getAuthenticator()

Returns the authenticator.

Returns:

authenticator

setAuthenticator

public void setAuthenticator(@Nonnull
                    Authenticator auth)

Sets the authenticator.

Parameters:

auth - to authenticate with

getReturnAttributes

@Nullable
public String[] getReturnAttributes()

Returns the return attributes.

Returns:

attribute names

setReturnAttributes

public void setReturnAttributes(@Nullable
                       String... attributes)

Sets the return attributes.

Parameters:

attributes - attribute names

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doExecute

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

Overrides:

doExecute in class AbstractAuthenticationAction

populateSubject

@Nonnull
protected Subject populateSubject(@Nonnull
                              Subject subject)

Overrides:

populateSubject in class AbstractUsernamePasswordValidationAction