AuthUserLookupInterface
interface AuthUserLookupInterface (View source)
The account rows the authenticators read while deciding a login.
Each method carries the exact column set and the active/use_ldap filter its authenticator relies on, so the filter cannot be dropped at a call site.
Methods
The password-login row: id, fullname, password, active, email. LDAP accounts are excluded so a directory account cannot be logged into with a local hash.
The LDAP-login row: id, fullname, email, for active LDAP-enabled accounts only.
Whether the account is still active and still LDAP-enabled, re-checked on every request so a disabled account loses a cached LDAP bind at once.
Whether the account still exists and is active, re-checked on every request for sessions an identity provider established.
The HTTP Basic row: id, password, use_ldap, for active accounts only.
The stored auth_method for a username, or null when no such account exists.
Details
array|null
findSqlLoginUser(string $username)
The password-login row: id, fullname, password, active, email. LDAP accounts are excluded so a directory account cannot be logged into with a local hash.
array|null
findActiveLdapUser(string $username)
The LDAP-login row: id, fullname, email, for active LDAP-enabled accounts only.
bool
hasActiveLdapUser(string $username)
Whether the account is still active and still LDAP-enabled, re-checked on every request so a disabled account loses a cached LDAP bind at once.
bool
isActiveUser(int $userId)
Whether the account still exists and is active, re-checked on every request for sessions an identity provider established.
array|null
findBasicAuthUser(string $username)
The HTTP Basic row: id, password, use_ldap, for active accounts only.
array|null
findAuthMethodRow(string $username)
The stored auth_method for a username, or null when no such account exists.
The row is returned rather than the value so a missing account stays distinguishable from an account with no auth_method set.