org.springframework.security.authentication.dao

Class DaoAuthenticationProvider

java.lang.Object

org.springframework.security.authentication.dao.AbstractUserDetailsAuthenticationProvider

org.springframework.security.authentication.dao.DaoAuthenticationProvider

All Implemented Interfaces:

Aware, InitializingBean, MessageSourceAware, AuthenticationProvider

public class DaoAuthenticationProvider
extends AbstractUserDetailsAuthenticationProvider

An AuthenticationProvider implementation that retrieves user details from a UserDetailsService.

Author:

Ben Alex, Rob Winch

Field Summary

Fields inherited from class org.springframework.security.authentication.dao.AbstractUserDetailsAuthenticationProvider

hideUserNotFoundExceptions, logger, messages

Constructor Summary

Constructors

Constructor and Description
DaoAuthenticationProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	additionalAuthenticationChecks(UserDetails userDetails, UsernamePasswordAuthenticationToken authentication) Allows subclasses to perform any additional checks of a returned (or cached) UserDetails for a given authentication request.
protected void	doAfterPropertiesSet()
protected PasswordEncoder	getPasswordEncoder()
protected SaltSource	getSaltSource()
protected UserDetailsService	getUserDetailsService()
protected UserDetails	retrieveUser(String username, UsernamePasswordAuthenticationToken authentication) Allows subclasses to actually retrieve the UserDetails from an implementation-specific location, with the option of throwing an AuthenticationException immediately if the presented credentials are incorrect (this is especially useful if it is necessary to bind to a resource as the user in order to obtain or generate a UserDetails).
void	setPasswordEncoder(Object passwordEncoder) Sets the PasswordEncoder instance to be used to encode and validate passwords.
void	setSaltSource(SaltSource saltSource) The source of salts to use when decoding passwords.
void	setUserDetailsService(UserDetailsService userDetailsService)

Methods inherited from class org.springframework.security.authentication.dao.AbstractUserDetailsAuthenticationProvider

afterPropertiesSet, authenticate, createSuccessAuthentication, getPostAuthenticationChecks, getPreAuthenticationChecks, getUserCache, isForcePrincipalAsString, isHideUserNotFoundExceptions, setAuthoritiesMapper, setForcePrincipalAsString, setHideUserNotFoundExceptions, setMessageSource, setPostAuthenticationChecks, setPreAuthenticationChecks, setUserCache, supports

Methods inherited from class java.lang.Object

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

Constructor Detail

DaoAuthenticationProvider

public DaoAuthenticationProvider()

Method Detail

additionalAuthenticationChecks

protected void additionalAuthenticationChecks(UserDetails userDetails,
                                  UsernamePasswordAuthenticationToken authentication)
                                       throws AuthenticationException

Description copied from class: AbstractUserDetailsAuthenticationProvider

Allows subclasses to perform any additional checks of a returned (or cached) UserDetails for a given authentication request. Generally a subclass will at least compare the Authentication.getCredentials() with a UserDetails.getPassword(). If custom logic is needed to compare additional properties of UserDetails and/or UsernamePasswordAuthenticationToken, these should also appear in this method.

Specified by:

additionalAuthenticationChecks in class AbstractUserDetailsAuthenticationProvider

Parameters:

userDetails - as retrieved from the AbstractUserDetailsAuthenticationProvider.retrieveUser(String, UsernamePasswordAuthenticationToken) or UserCache

authentication - the current request that needs to be authenticated

Throws:

AuthenticationException - AuthenticationException if the credentials could not be validated (generally a BadCredentialsException, an AuthenticationServiceException)

doAfterPropertiesSet

protected void doAfterPropertiesSet()
                             throws Exception

Overrides:

doAfterPropertiesSet in class AbstractUserDetailsAuthenticationProvider

Throws:

Exception

retrieveUser

protected final UserDetails retrieveUser(String username,
                       UsernamePasswordAuthenticationToken authentication)
                                  throws AuthenticationException

Description copied from class: AbstractUserDetailsAuthenticationProvider

Allows subclasses to actually retrieve the UserDetails from an implementation-specific location, with the option of throwing an AuthenticationException immediately if the presented credentials are incorrect (this is especially useful if it is necessary to bind to a resource as the user in order to obtain or generate a UserDetails).

Subclasses are not required to perform any caching, as the AbstractUserDetailsAuthenticationProvider will by default cache the UserDetails. The caching of UserDetails does present additional complexity as this means subsequent requests that rely on the cache will need to still have their credentials validated, even if the correctness of credentials was assured by subclasses adopting a binding-based strategy in this method. Accordingly it is important that subclasses either disable caching (if they want to ensure that this method is the only method that is capable of authenticating a request, as no UserDetails will ever be cached) or ensure subclasses implement AbstractUserDetailsAuthenticationProvider.additionalAuthenticationChecks(UserDetails, UsernamePasswordAuthenticationToken) to compare the credentials of a cached UserDetails with subsequent authentication requests.

Most of the time subclasses will not perform credentials inspection in this method, instead performing it in AbstractUserDetailsAuthenticationProvider.additionalAuthenticationChecks(UserDetails, UsernamePasswordAuthenticationToken) so that code related to credentials validation need not be duplicated across two methods.

Specified by:

retrieveUser in class AbstractUserDetailsAuthenticationProvider

Parameters:

username - The username to retrieve

authentication - The authentication request, which subclasses may need to perform a binding-based retrieval of the UserDetails

Returns:

the user information (never null - instead an exception should the thrown)

Throws:

AuthenticationException - if the credentials could not be validated (generally a BadCredentialsException, an AuthenticationServiceException or UsernameNotFoundException)

setPasswordEncoder

public void setPasswordEncoder(Object passwordEncoder)

Sets the PasswordEncoder instance to be used to encode and validate passwords. If not set, the password will be compared as plain text.

For systems which are already using salted password which are encoded with a previous release, the encoder should be of type org.springframework.security.authentication.encoding.PasswordEncoder. Otherwise, the recommended approach is to use org.springframework.security.crypto.password.PasswordEncoder.

Parameters:

passwordEncoder - must be an instance of one of the PasswordEncoder types.

getPasswordEncoder

protected PasswordEncoder getPasswordEncoder()

setSaltSource

public void setSaltSource(SaltSource saltSource)

The source of salts to use when decoding passwords. null is a valid value, meaning the DaoAuthenticationProvider will present null to the relevant PasswordEncoder.

Instead, it is recommended that you use an encoder which uses a random salt and combines it with the password field. This is the default approach taken in the org.springframework.security.crypto.password package.

Parameters:

saltSource - to use when attempting to decode passwords via the PasswordEncoder

getSaltSource

protected SaltSource getSaltSource()

setUserDetailsService

public void setUserDetailsService(UserDetailsService userDetailsService)

getUserDetailsService

protected UserDetailsService getUserDetailsService()