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 |
| 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 |
setQueryString(string $queryString)
Set a query string to use in order to find a DN for the username.
Parameters
| string | $queryString |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/Security/Core/Authentication/Provider/LdapBindAuthenticationProvider.html