1. class
  2. Symfony
  3. Component
  4. Security
  5. Core
  6. Authentication
  7. Provider
  8. LdapBindAuthenticationProvider

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, LdapClientInterface $ldap, string $dnString = '{username}', bool $hideUserNotFoundExceptions = true)

Constructor.

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

Details

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

Constructor.

Parameters

UserProviderInterface $userProvider A UserProvider
UserCheckerInterface $userChecker An UserCheckerInterface interface
string $providerKey A provider key
LdapClientInterface $ldap An Ldap client
string $dnString A string used to create the bind DN
bool $hideUserNotFoundExceptions Whether to hide user not found exception or not

in UserAuthenticationProvider at line line 58
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

in UserAuthenticationProvider at line line 105
bool supports(TokenInterface $token)

Checks whether this provider supports the given token.

Parameters

TokenInterface $token A TokenInterface instance

Return Value

bool true if the implementation supports the Token, false otherwise