82 lines
2.6 KiB
PHP
82 lines
2.6 KiB
PHP
<?php
|
|
/**
|
|
* @brief Trait for Login Handlers which accept username/email address and password
|
|
* @author <a href='https://www.invisioncommunity.com'>Invision Power Services, Inc.</a>
|
|
* @copyright (c) Invision Power Services, Inc.
|
|
* @license https://www.invisioncommunity.com/legal/standards/
|
|
* @package Invision Community
|
|
* @since 12 May 2017
|
|
* @version SVN_VERSION_NUMBER
|
|
*/
|
|
|
|
namespace IPS\Login\Handler;
|
|
|
|
/* To prevent PHP errors (extending class does not exist) revealing path */
|
|
|
|
use IPS\Helpers\Form\Select;
|
|
use IPS\Login;
|
|
use IPS\Login\Exception;
|
|
use IPS\Member;
|
|
use function defined;
|
|
|
|
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
|
|
{
|
|
header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* Abstract Login Handler for handlers which accept username/email address and password
|
|
*/
|
|
trait UsernamePasswordHandler
|
|
{
|
|
/**
|
|
* Get type
|
|
*
|
|
* @return int
|
|
*/
|
|
public function type(): int
|
|
{
|
|
return Login::TYPE_USERNAME_PASSWORD;
|
|
}
|
|
|
|
/**
|
|
* ACP Settings Form
|
|
*
|
|
* @return array List of settings to save - settings will be stored to core_login_methods.login_settings DB field
|
|
* @code
|
|
return array( 'savekey' => new \IPS\Helpers\Form\[Type]( ... ), ... );
|
|
* @endcode
|
|
*/
|
|
public function acpForm(): array
|
|
{
|
|
$id = $this->id ?: 'new';
|
|
return array(
|
|
'auth_types' => new Select( 'login_auth_types', $this->settings['auth_types'] ?? ( Login::AUTH_TYPE_EMAIL ), TRUE, array( 'options' => array(
|
|
Login::AUTH_TYPE_USERNAME + Login::AUTH_TYPE_EMAIL => 'username_or_email',
|
|
Login::AUTH_TYPE_EMAIL => 'email_address',
|
|
Login::AUTH_TYPE_USERNAME => 'username',
|
|
), 'toggles' => array( Login::AUTH_TYPE_USERNAME + Login::AUTH_TYPE_EMAIL => array( 'form_' . $id . '_login_auth_types_warning' ), Login::AUTH_TYPE_USERNAME => array( 'form_' . $id . '_login_auth_types_warning' ) ) ) )
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Authenticate
|
|
*
|
|
* @param Login $login The login object
|
|
* @param string $usernameOrEmail The username or email address provided by the user
|
|
* @param object $password The plaintext password provided by the user, wrapped in an object that can be cast to a string so it doesn't show in any logs
|
|
* @return Member
|
|
* @throws Exception
|
|
*/
|
|
abstract public function authenticateUsernamePassword( Login $login, string $usernameOrEmail, object $password ): Member;
|
|
|
|
/**
|
|
* Authenticate
|
|
*
|
|
* @param Member $member The member
|
|
* @param object $password The plaintext password provided by the user, wrapped in an object that can be cast to a string so it doesn't show in any logs
|
|
* @return bool
|
|
*/
|
|
abstract public function authenticatePasswordForMember( Member $member, object $password ): bool;
|
|
} |