W3cubDocs

/Symfony 4.1

LdapBindAuthenticationProvider

class LdapBindAuthenticationProvider extends UserAuthenticationProvider

LdapBindAuthenticationProvider authenticates a user against an LDAP server.

The only way to check user credentials is to try to connect the user with its credentials to the ldap.

Methods

__construct(UserProviderInterface $userProvider, UserCheckerInterface $userChecker, string $providerKey, LdapInterface $ldap, string $dnString = '{username}', bool $hideUserNotFoundExceptions = true)
TokenInterface authenticate(TokenInterface $token)

Attempts to authenticate a TokenInterface object.

from UserAuthenticationProvider
bool supports(TokenInterface $token)

Checks whether this provider supports the given token.

from UserAuthenticationProvider
UserInterface retrieveUser(string $username, UsernamePasswordToken $token)

Retrieves the user from an implementation-specific location.

checkAuthentication(UserInterface $user, UsernamePasswordToken $token)

Does additional checks on the user and token (like validating the credentials).

setQueryString(string $queryString)

Set a query string to use in order to find a DN for the username.

Details

__construct(UserProviderInterface $userProvider, UserCheckerInterface $userChecker, string $providerKey, LdapInterface $ldap, string $dnString = '{username}', bool $hideUserNotFoundExceptions = true)

Parameters

UserProviderInterface $userProvider
UserCheckerInterface $userChecker
string $providerKey
LdapInterface $ldap
string $dnString
bool $hideUserNotFoundExceptions

Exceptions

InvalidArgumentException

TokenInterface authenticate(TokenInterface $token)

Attempts to authenticate a TokenInterface object.

Parameters

TokenInterface $token The TokenInterface instance to authenticate

Return Value

TokenInterface An authenticated TokenInterface instance, never null

Exceptions

AuthenticationException if the authentication fails

bool supports(TokenInterface $token)

Checks whether this provider supports the given token.

Parameters

TokenInterface $token

Return Value

bool true if the implementation supports the Token, false otherwise

protected UserInterface retrieveUser(string $username, UsernamePasswordToken $token)

Retrieves the user from an implementation-specific location.

Parameters

string $username The username to retrieve
UsernamePasswordToken $token The Token

Return Value

UserInterface The user

Exceptions

AuthenticationException if the credentials could not be validated

protected checkAuthentication(UserInterface $user, UsernamePasswordToken $token)

Does additional checks on the user and token (like validating the credentials).

Parameters

UserInterface $user
UsernamePasswordToken $token

Exceptions

AuthenticationException if the credentials could not be validated

setQueryString(string $queryString)

Set a query string to use in order to find a DN for the username.

Parameters

string $queryString