523 lines
15 KiB
PHP
523 lines
15 KiB
PHP
<?php
|
|
/**
|
|
* @brief Login Handler
|
|
* @author <a href='http://www.invisionpower.com'>Invision Power Services, Inc.</a>
|
|
* @copyright (c) 2001 - SVN_YYYY Invision Power Services, Inc.
|
|
* @license http://www.invisionpower.com/legal/standards/
|
|
* @package IPS Social Suite
|
|
* @since 13 Mar 2013
|
|
* @version SVN_VERSION_NUMBER
|
|
*/
|
|
|
|
namespace IPS;
|
|
|
|
/* To prevent PHP errors (extending class does not exist) revealing path */
|
|
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
|
|
{
|
|
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* Login Handler
|
|
*/
|
|
class _Login
|
|
{
|
|
const AUTH_TYPE_USERNAME = 1;
|
|
const AUTH_TYPE_EMAIL = 2;
|
|
|
|
/**
|
|
* @brief Handlers
|
|
*/
|
|
public static $handlers = NULL;
|
|
|
|
/**
|
|
* @brief All handlers
|
|
*/
|
|
public static $allHandlers = NULL;
|
|
|
|
/**
|
|
* Get Handlers
|
|
*
|
|
* @param bool $all Force fetching of all enabled login handlers
|
|
* @return array
|
|
*/
|
|
public static function handlers( $all=FALSE )
|
|
{
|
|
/* Do we need all handlers? */
|
|
if( $all === TRUE )
|
|
{
|
|
if( static::$allHandlers !== NULL )
|
|
{
|
|
return static::$allHandlers;
|
|
}
|
|
|
|
foreach ( \IPS\Db::i()->select( '*', 'core_login_handlers', 'login_enabled=1', 'login_order' ) as $row )
|
|
{
|
|
try
|
|
{
|
|
static::$allHandlers[ $row['login_key'] ] = \IPS\Login\LoginAbstract::constructFromData( $row );
|
|
}
|
|
catch ( \RuntimeException $e ) { /* Skip over any which error (may happen if they haven't bee updated for IPS4 for example */ }
|
|
}
|
|
|
|
if ( \IPS\Dispatcher::hasInstance() === TRUE )
|
|
{
|
|
if( \IPS\Dispatcher::i()->controllerLocation == 'front' )
|
|
{
|
|
static::$handlers = static::$allHandlers;
|
|
}
|
|
}
|
|
|
|
return static::$allHandlers;
|
|
}
|
|
|
|
/* Fetch the appropriate handlers */
|
|
if ( static::$handlers === NULL )
|
|
{
|
|
if ( \IPS\Dispatcher::i()->controllerLocation === 'front' )
|
|
{
|
|
if ( isset( \IPS\Data\Store::i()->loginHandlers ) )
|
|
{
|
|
$rows = \IPS\Data\Store::i()->loginHandlers;
|
|
}
|
|
else
|
|
{
|
|
$rows = iterator_to_array( \IPS\Db::i()->select( '*', 'core_login_handlers', 'login_enabled=1', 'login_order' ) );
|
|
\IPS\Data\Store::i()->loginHandlers = $rows;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
$rows = \IPS\Db::i()->select( '*', 'core_login_handlers', 'login_enabled=1 AND login_acp=1', 'login_order' );
|
|
}
|
|
|
|
foreach ( $rows as $row )
|
|
{
|
|
try
|
|
{
|
|
static::$handlers[ $row['login_key'] ] = \IPS\Login\LoginAbstract::constructFromData( $row );
|
|
}
|
|
catch ( \RuntimeException $e ) { /* Skip over any which error (may happen if they haven't bee updated for IPS4 for example */ }
|
|
}
|
|
|
|
if( \IPS\Dispatcher::i()->controllerLocation == 'front' )
|
|
{
|
|
static::$allHandlers = static::$handlers;
|
|
}
|
|
}
|
|
|
|
/* If we have no handlers, use the standard internal */
|
|
if ( empty( static::$handlers ) )
|
|
{
|
|
static::$handlers['Internal'] = \IPS\Login\LoginAbstract::load('internal');
|
|
}
|
|
|
|
return static::$handlers;
|
|
}
|
|
|
|
/**
|
|
* @brief URL
|
|
*/
|
|
protected $url = '';
|
|
|
|
/**
|
|
* @brief Handlers which use the 'Standard' log in form
|
|
*/
|
|
public $standardHandlers = array();
|
|
|
|
/**
|
|
* @brief Forms
|
|
*/
|
|
protected $forms = NULL;
|
|
|
|
/**
|
|
* @brief Show flag options (remember me, anonymous) on form?
|
|
*/
|
|
public $flagOptions = TRUE;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param \IPS\Http\Url $url The URL page for the login screen
|
|
* @return void
|
|
*/
|
|
public function __construct( \IPS\Http\Url $url )
|
|
{
|
|
$this->url = $url;
|
|
}
|
|
|
|
/**
|
|
* Fetch the URL to redirect to
|
|
*
|
|
* @return \IPS\Http\Url
|
|
*/
|
|
public static function getDestination()
|
|
{
|
|
$ref = NULL;
|
|
/* If there's an explicit ref value, go there */
|
|
if( !empty( \IPS\Request::i()->ref ) )
|
|
{
|
|
$ref = new \IPS\Http\Url( @base64_decode( \IPS\Request::i()->ref ) ?: \IPS\Request::i()->ref );
|
|
return $ref;
|
|
}
|
|
|
|
/* Don't redirect to an external domain unless explicitly requested, and don't redirect back to ACP */
|
|
if( isset( $_SERVER['HTTP_REFERER'] ) AND empty( \IPS\Request::i()->ips_force_return ) )
|
|
{
|
|
if( parse_url( \IPS\Settings::i()->base_url, PHP_URL_HOST ) != parse_url( $_SERVER['HTTP_REFERER'], PHP_URL_HOST ) )
|
|
{
|
|
unset( $_SERVER['HTTP_REFERER'] );
|
|
}
|
|
else
|
|
{
|
|
$ourBaseReferer = str_replace( \IPS\Settings::i()->base_url, '', $_SERVER['HTTP_REFERER'] );
|
|
|
|
if( mb_strpos( $ourBaseReferer, \IPS\CP_DIRECTORY ) === 0 )
|
|
{
|
|
unset( $_SERVER['HTTP_REFERER'] );
|
|
}
|
|
}
|
|
|
|
$ref = new \IPS\Http\Url( ( isset( $_SERVER['HTTP_REFERER'] ) ? $_SERVER['HTTP_REFERER'] : '' ) );
|
|
}
|
|
|
|
return isset( $ref ) ? $ref->stripQueryString( 'csrfKey' ) : \IPS\Http\Url::internal( '' );
|
|
}
|
|
|
|
/**
|
|
* Fetch the URL to redirect to following registration, if any
|
|
*
|
|
* @param \IPS\Member $member The member that just registered
|
|
* @return \IPS\Http\Url
|
|
*/
|
|
public static function getRegistrationDestination( $member )
|
|
{
|
|
foreach ( static::handlers() as $key => $handler )
|
|
{
|
|
if ( method_exists( $handler, 'getRegistrationDestination' ) )
|
|
{
|
|
return $handler->getRegistrationDestination( $member );
|
|
}
|
|
}
|
|
|
|
if ( in_array( \IPS\Settings::i()->reg_auth_type, array( 'admin', 'admin_user' ) ) )
|
|
{
|
|
return \IPS\Http\Url::internal( 'app=core&module=system&controller=register&do=validating', 'front', 'register' );
|
|
}
|
|
|
|
return \IPS\Http\Url::internal( '' );
|
|
}
|
|
|
|
/**
|
|
* Get Login Forms
|
|
*
|
|
* @param bool $acp TRUE=ACP login form, FALSE=front end login form
|
|
* @param bool $skipReferer If set to true we will skip adding the "referer" to the form, useful for the quick login popup where you want the same page to reload
|
|
* @return array
|
|
*/
|
|
public function forms( $acp=FALSE, $skipReferer=FALSE )
|
|
{
|
|
if ( $this->forms === NULL )
|
|
{
|
|
$this->forms = array();
|
|
$standardTypes = 0;
|
|
|
|
foreach ( static::handlers() as $key => $handler )
|
|
{
|
|
if ( method_exists( $handler, 'loginForm' ) )
|
|
{
|
|
try
|
|
{
|
|
$this->forms[ $key ] = $handler->loginForm( $this->url );
|
|
}
|
|
catch( \BadMethodCallException $e )
|
|
{
|
|
/* The user may have installed a custom login handler, but not provided a template for the upgrader.
|
|
This results in a NO_TEMPLATE_FILE exception and blocks the upgrader completely. We should just skip
|
|
that login handler in this case */
|
|
continue;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
$this->forms['_standard'] = NULL;
|
|
$standardTypes = $standardTypes | $handler->authTypes;
|
|
$this->standardHandlers[] = $key;
|
|
}
|
|
}
|
|
|
|
if ( $standardTypes !== 0 )
|
|
{
|
|
switch ( $standardTypes )
|
|
{
|
|
case static::AUTH_TYPE_USERNAME:
|
|
\IPS\Member::loggedIn()->language()->words['auth'] = \IPS\Member::loggedIn()->language()->addToStack( 'username', FALSE );
|
|
break;
|
|
|
|
case static::AUTH_TYPE_EMAIL:
|
|
\IPS\Member::loggedIn()->language()->words['auth'] = \IPS\Member::loggedIn()->language()->addToStack( 'email_address', FALSE );
|
|
break;
|
|
|
|
case static::AUTH_TYPE_USERNAME + static::AUTH_TYPE_EMAIL:
|
|
\IPS\Member::loggedIn()->language()->words['auth'] = \IPS\Member::loggedIn()->language()->addToStack( 'username_or_email', FALSE );
|
|
break;
|
|
}
|
|
|
|
$standardForm = new \IPS\Helpers\Form( "login__standard", 'login', $this->url );
|
|
|
|
$classname = 'IPS\Helpers\Form\Text';
|
|
if ( $standardTypes === static::AUTH_TYPE_EMAIL )
|
|
{
|
|
$classname = 'IPS\Helpers\Form\Email';
|
|
}
|
|
$standardForm->class = 'ipsForm_vertical';
|
|
$standardForm->add( new $classname( 'auth', NULL, TRUE, array( '_loginType' => $standardTypes ), NULL, NULL, NULL, 'auth' ) );
|
|
$standardForm->add( new \IPS\Helpers\Form\Password( 'password', NULL, TRUE, array(), NULL, NULL, NULL, 'password' ) );
|
|
|
|
/* Are we adding the referer value to the form? */
|
|
if( !$skipReferer )
|
|
{
|
|
$standardForm->hiddenValues['ref'] = base64_encode( static::getDestination() );
|
|
}
|
|
|
|
if ( $this->flagOptions )
|
|
{
|
|
$standardForm->add( new \IPS\Helpers\Form\Checkbox( 'remember_me', TRUE ) );
|
|
if ( !\IPS\Settings::i()->disable_anonymous )
|
|
{
|
|
$standardForm->add( new \IPS\Helpers\Form\Checkbox( 'signin_anonymous' ) );
|
|
}
|
|
$standardForm->addButton( 'forgotten_password', 'link', \IPS\Http\Url::internal( 'app=core&module=system&controller=lostpass', 'front', 'lostpassword' ), 'ipsButton_link' );
|
|
}
|
|
|
|
$this->forms['_standard'] = $standardForm;
|
|
}
|
|
}
|
|
|
|
return $this->forms;
|
|
}
|
|
|
|
/**
|
|
* @brief Login Flags
|
|
*/
|
|
public $flags = array( 'remember_me' => TRUE, 'signin_anonymous' => FALSE );
|
|
|
|
/**
|
|
* Check for successful authentication
|
|
*
|
|
* @return \IPS\Member|null
|
|
* @throws \IPS\Login\Exception
|
|
*/
|
|
public function authenticate()
|
|
{
|
|
if ( ( !isset( \IPS\Request::i()->cookie[ 'IPSSession' . ucfirst( \IPS\Dispatcher::i()->controllerLocation ) ] ) or \IPS\Request::i()->cookie[ 'IPSSession' . ucfirst( \IPS\Dispatcher::i()->controllerLocation ) ] != session_id() ) )
|
|
{
|
|
if ( !isset( \IPS\Request::i()->cookieCheck ) )
|
|
{
|
|
$_SESSION['_cookieCheck'] = TRUE; // Forces it to write the session so the above check will fail on the next load
|
|
\IPS\Output::i()->redirect( $this->url->setQueryString( 'cookieCheck', 1 ), NULL, 307 ); // 307 instructs the browser to resubmit the form as a POST request maintaining all the values from before
|
|
}
|
|
else
|
|
{
|
|
\IPS\Output::i()->error( 'login_err_no_cookies', '1S267/1', 403, '' );
|
|
}
|
|
}
|
|
|
|
$handlers = static::handlers();
|
|
foreach ( $this->forms() as $handler => $form )
|
|
{
|
|
/* Pass to the handler */
|
|
$values = NULL;
|
|
if ( ( is_object( $form ) and $values = $form->values() ) or ( ucfirst( \IPS\Request::i()->loginProcess ) === ucfirst( $handler ) ) )
|
|
{
|
|
/* Set any flags */
|
|
foreach ( array_keys( $this->flags ) as $k )
|
|
{
|
|
if ( isset( $values[ $k ] ) )
|
|
{
|
|
$this->flags[ $k ] = $values[ $k ];
|
|
}
|
|
}
|
|
|
|
/* Authenticate */
|
|
$member = NULL;
|
|
try
|
|
{
|
|
if ( $handler === '_standard' )
|
|
{
|
|
$values['auth'] = mb_strtolower( $values['auth'] );
|
|
$member = $this->authenticateStandard( $values );
|
|
}
|
|
else
|
|
{
|
|
$member = $handlers[ $handler ]->authenticate( is_object( $form ) ? $values : $this->url );
|
|
}
|
|
}
|
|
catch ( \IPS\Login\Exception $e )
|
|
{
|
|
/* Check if the account is locked and throw that error rather than a bad password error first */
|
|
if ( $e->getCode() === \IPS\Login\Exception::BAD_PASSWORD )
|
|
{
|
|
$this->checkIfAccountIsLocked( $e->member );
|
|
}
|
|
|
|
/* If we're still here, throw the error we got */
|
|
throw $e;
|
|
}
|
|
|
|
/* If we passed, log in! */
|
|
if ( $member->member_id )
|
|
{
|
|
/* http://community.invisionpower.com/4bugtrack/upgrading-within-admincp-r3097 - we can't find any reason not checking this is desired at this time */
|
|
//if( \IPS\Dispatcher::hasInstance() AND \IPS\Dispatcher::i()->controllerLocation != 'setup' )
|
|
//{
|
|
/* Check if the account is locked */
|
|
$this->checkIfAccountIsLocked( $member );
|
|
|
|
/* Remove old failed login attempts */
|
|
if ( \IPS\Settings::i()->ipb_bruteforce_period and ( \IPS\Settings::i()->ipb_bruteforce_unlock or !isset( $member->failed_logins[ \IPS\Request::i()->ipAddress() ] ) or $member->failed_logins[ \IPS\Request::i()->ipAddress() ] < \IPS\Settings::i()->ipb_bruteforce_attempts ) )
|
|
{
|
|
$removeLoginsOlderThan = \IPS\DateTime::create()->sub( new \DateInterval( 'PT' . \IPS\Settings::i()->ipb_bruteforce_period . 'M' ) );
|
|
$failedLogins = $member->failed_logins;
|
|
foreach ( $failedLogins as $ipAddress => $times )
|
|
{
|
|
foreach ( $times as $k => $v )
|
|
{
|
|
if ( $v < $removeLoginsOlderThan->getTimestamp() )
|
|
{
|
|
unset( $failedLogins[ $ipAddress ][ $k ] );
|
|
}
|
|
}
|
|
}
|
|
$member->failed_logins = $failedLogins;
|
|
$member->save();
|
|
}
|
|
|
|
/* If we're still here, the login was fine, so we can reset the count and process login */
|
|
if ( isset( $member->failed_logins[ \IPS\Request::i()->ipAddress() ] ) )
|
|
{
|
|
$failedLogins = $member->failed_logins;
|
|
unset( $failedLogins[ \IPS\Request::i()->ipAddress() ] );
|
|
$member->failed_logins = $failedLogins;
|
|
}
|
|
$member->last_visit = time();
|
|
$member->save();
|
|
//}
|
|
|
|
return $member;
|
|
}
|
|
}
|
|
}
|
|
|
|
/* Still here? Just throw an exception */
|
|
return NULL;
|
|
}
|
|
|
|
/**
|
|
* Authenticate all 'Standard' forms
|
|
*
|
|
* @param array $values Values from form
|
|
* @return \IPS\Member
|
|
* @throws \IPS\Login\Exception
|
|
*/
|
|
public function authenticateStandard( $values )
|
|
{
|
|
$member = NULL;
|
|
$leastOffensiveException = NULL;
|
|
|
|
$handlers = static::handlers();
|
|
foreach ( $this->standardHandlers as $key )
|
|
{
|
|
try
|
|
{
|
|
$member = $handlers[ $key ]->authenticate( $values );
|
|
break;
|
|
}
|
|
catch ( \IPS\Login\Exception $e )
|
|
{
|
|
if ( $leastOffensiveException === NULL or $leastOffensiveException->getCode() > $e->getCode() )
|
|
{
|
|
$leastOffensiveException = $e;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( $member === NULL )
|
|
{
|
|
throw $leastOffensiveException;
|
|
}
|
|
else
|
|
{
|
|
return $member;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check if an account is locked
|
|
*
|
|
* @param \IPS\Member $member The account
|
|
* @return void
|
|
* @throws \Exception
|
|
*/
|
|
protected function checkIfAccountIsLocked( $member )
|
|
{
|
|
if ( \IPS\Settings::i()->ipb_bruteforce_attempts and isset( $member->failed_logins[ \IPS\Request::i()->ipAddress() ] ) and count( $member->failed_logins[ \IPS\Request::i()->ipAddress() ] ) >= \IPS\Settings::i()->ipb_bruteforce_attempts )
|
|
{
|
|
if ( \IPS\Settings::i()->ipb_bruteforce_period and \IPS\Settings::i()->ipb_bruteforce_unlock )
|
|
{
|
|
$failedLogins = $member->failed_logins[ \IPS\Request::i()->ipAddress() ];
|
|
sort( $failedLogins );
|
|
|
|
while ( count( $failedLogins ) > \IPS\Settings::i()->ipb_bruteforce_attempts )
|
|
{
|
|
array_pop( $failedLogins );
|
|
}
|
|
$unlockTime = \IPS\DateTime::ts( array_pop( $failedLogins ) );
|
|
$unlockTime->add( new \DateInterval( 'PT' . \IPS\Settings::i()->ipb_bruteforce_period . 'M' ) );
|
|
$timeToUnlock = $unlockTime->diff( new DateTime() );
|
|
|
|
/* If Unlock Time is in the past, return FALSE to avoid the exception and allow login */
|
|
if ( $unlockTime->getTimestamp() < time() )
|
|
{
|
|
return FALSE;
|
|
}
|
|
|
|
throw new \IPS\Login\Exception( \IPS\Member::loggedIn()->language()->addToStack( 'login_err_locked_unlock', FALSE, array( 'pluralize' => array( $timeToUnlock->format('%i') ) ) ) );
|
|
}
|
|
else
|
|
{
|
|
throw new \IPS\Login\Exception( 'login_err_locked_nounlock' );
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Compare hashes in fixed length, time constant manner.
|
|
*
|
|
* @param string $expected The expected hash
|
|
* @param string $provided The provided input
|
|
* @return boolean
|
|
*/
|
|
public static function compareHashes( $expected, $provided )
|
|
{
|
|
if ( !is_string( $expected ) || !is_string( $provided ) )
|
|
{
|
|
return FALSE;
|
|
}
|
|
|
|
$len = \strlen( $expected );
|
|
if ( $len !== \strlen( $provided ) )
|
|
{
|
|
return FALSE;
|
|
}
|
|
|
|
$status = 0;
|
|
for ( $i = 0; $i < $len; $i++ )
|
|
{
|
|
$status |= ord( $expected[ $i ] ) ^ ord( $provided[ $i ] );
|
|
}
|
|
|
|
return $status === 0;
|
|
}
|
|
} |