mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 12:05:37 +00:00
c4194f0ed2
Move to canLogin in the authentication check. Protected isLockedOut Enable login to be called with a different login service (CMSLogin), enabling CMS Log in. Seems the styling and/or output is still broken. logOut could be managed from the Authenticator instead of the member
94 lines
2.9 KiB
PHP
94 lines
2.9 KiB
PHP
<?php
|
|
|
|
namespace SilverStripe\Security;
|
|
|
|
use SilverStripe\Core\Config\Configurable;
|
|
use SilverStripe\Core\Extensible;
|
|
use SilverStripe\Core\Injector\Injectable;
|
|
use SilverStripe\Control\Controller;
|
|
use SilverStripe\Forms\Form;
|
|
|
|
/**
|
|
* Abstract base class for an authentication method
|
|
*
|
|
* This class is used as a base class for the different authentication
|
|
* methods like {@link MemberAuthenticator} or {@link OpenIDAuthenticator}.
|
|
*
|
|
* @author Markus Lanthaler <markus@silverstripe.com>
|
|
*/
|
|
interface Authenticator
|
|
{
|
|
|
|
const LOGIN = 1;
|
|
const LOGOUT = 2;
|
|
const CHANGE_PASSWORD = 4;
|
|
const RESET_PASSWORD = 8;
|
|
const CMS_LOGIN = 16;
|
|
|
|
/**
|
|
* Returns the services supported by this authenticator
|
|
*
|
|
* The number should be a bitwise-OR of 1 or more of the following constants:
|
|
* Authenticator::LOGIN, Authenticator::LOGOUT, Authenticator::CHANGE_PASSWORD,
|
|
* Authenticator::RESET_PASSWORD, or Authenticator::CMS_LOGIN
|
|
*
|
|
* @return int
|
|
*/
|
|
public function supportedServices();
|
|
|
|
/**
|
|
* Return RequestHandler to manage the log-in process.
|
|
*
|
|
* The default URL of the RequetHandler should return the initial log-in form, any other
|
|
* URL may be added for other steps & processing.
|
|
*
|
|
* URL-handling methods may return an array [ "Form" => (form-object) ] which can then
|
|
* be merged into a default controller.
|
|
*
|
|
* @param string $link The base link to use for this RequestHnadler
|
|
*/
|
|
public function getLoginHandler($link);
|
|
|
|
/**
|
|
* Return RequestHandler to manage the change-password process.
|
|
*
|
|
* The default URL of the RequetHandler should return the initial change-password form,
|
|
* any other URL may be added for other steps & processing.
|
|
*
|
|
* URL-handling methods may return an array [ "Form" => (form-object) ] which can then
|
|
* be merged into a default controller.
|
|
*
|
|
* @param string $link The base link to use for this RequestHnadler
|
|
*/
|
|
public function getChangePasswordHandler($link);
|
|
|
|
/**
|
|
* @todo
|
|
*/
|
|
public function getLostPasswordHandler($link);
|
|
|
|
/**
|
|
* Method to authenticate an user.
|
|
*
|
|
* @param array $data Raw data to authenticate the user.
|
|
* @param string $message A variable to return an error message if authentication fails
|
|
* @return Member The matched member, or null if the authentication fails
|
|
*/
|
|
public function authenticate($data, &$message);
|
|
|
|
/**
|
|
* Return the keys that should be passed to authenticate()
|
|
* @return array
|
|
*/
|
|
// public function getAuthenticateFields();
|
|
|
|
/**
|
|
* Log the member out of this Authentication method.
|
|
*
|
|
* @param Member $member by reference, to allow for multiple actions on the member with a single write
|
|
* @return boolean|Member if logout was unsuccessfull, return true, otherwise, the member is returned
|
|
*/
|
|
public function doLogOut(&$member);
|
|
|
|
}
|