AuthenticationHandler
interface AuthenticationHandler implements IdentityStore (View source)
An AuthenticationHandler is responsible for providing an identity (in the form of a Member object) for a given HTTPRequest.
It should return the authenticated Member if successful. If a Member cannot be found from the current request it should not attempt to redirect the visitor to a log-in from or 3rd party handler, as that is the responsibiltiy of other systems.
Methods
Log the given member into this identity store.
Given the current request, authenticate the request for non-session authorization (outside the CMS).
Details
logIn(Member $member, bool $persistent = false, HTTPRequest $request = null)
Log the given member into this identity store.
logOut(HTTPRequest $request = null)
Log any logged-in member out of this identity store.
Member|null
authenticateRequest(HTTPRequest $request)
Given the current request, authenticate the request for non-session authorization (outside the CMS).
The Member returned from this method will be provided to the Manager for use in the OperationResolver context in place of the current CMS member.
Authenticators can be given a priority. In this case, the authenticator with the highest priority will be returned first. If not provided, it will default to a low number.
An example for configuring the BasicAuthAuthenticator:
SilverStripe\Security\Security:
authentication_handlers:
- SilverStripe\Security\BasicAuthentionHandler