class.ilAuthFrontend.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilAuthFrontend
{
    const MIG_EXTERNAL_ACCOUNT = 'mig_ext_account';
    const MIG_TRIGGER_AUTHMODE = 'mig_trigger_auth_mode';
    const MIG_DESIRED_AUTHMODE = 'mig_desired_auth_mode';
    
    private $logger = null;
    private $credentials = null;
    private $status = null;
    private $providers = array();
    private $auth_session = null;
    
    private $authenticated = false;
    
    public function __construct(ilAuthSession $session, ilAuthStatus $status, ilAuthCredentials $credentials, array $providers)
    {
        $this->logger = ilLoggerFactory::getLogger('auth');
        
        $this->auth_session = $session;
        $this->credentials = $credentials;
        $this->status = $status;
        $this->providers = $providers;
    }
    
    public function getAuthSession()
    {
        return $this->auth_session;
    }
    
    public function getCredentials()
    {
        return $this->credentials;
    }
    
    public function getProviders()
    {
        return $this->providers;
    }
    
    public function getStatus()
    {
        return $this->status;
    }
    
    public function resetStatus()
    {
        $this->getStatus()->setStatus(ilAuthStatus::STATUS_UNDEFINED);
        $this->getStatus()->setReason('');
        $this->getStatus()->setAuthenticatedUserId(0);
    }
    
    public function getLogger()
    {
        return $this->logger;
    }
    
    public function migrateAccount(ilAuthSession $session)
    {
        if (!$session->isAuthenticated()) {
            $this->getLogger()->warning('Desired user account is not authenticated');
            return false;
        }
        include_once './Services/Object/classes/class.ilObjectFactory.php';
        $user_factory = new ilObjectFactory();
        $user = $user_factory->getInstanceByObjId($session->getUserId(), false);
        
        if (!$user instanceof ilObjUser) {
            $this->getLogger()->info('Cannot instantiate user account for account migration: ' . $session->getUserId());
            return false;
        }
        
        $user->setAuthMode(ilSession::get(static::MIG_DESIRED_AUTHMODE));
        
        $this->getLogger()->debug('new auth mode is: ' . ilSession::get(self::MIG_DESIRED_AUTHMODE));
        
        $user->setExternalAccount(ilSession::get(static::MIG_EXTERNAL_ACCOUNT));
        $user->update();
        
        foreach ($this->getProviders() as $provider) {
            if (!$provider instanceof ilAuthProviderAccountMigrationInterface) {
                $this->logger->warning('Provider: ' . get_class($provider) . ' does not support account migration.');
                throw new InvalidArgumentException('Invalid auth provider given.');
            }
            $this->getCredentials()->setUsername(ilSession::get(static::MIG_EXTERNAL_ACCOUNT));
            $provider->migrateAccount($this->getStatus());
            switch ($this->getStatus()->getStatus()) {
                case ilAuthStatus::STATUS_AUTHENTICATED:
                    return $this->handleAuthenticationSuccess($provider);
                    
            }
        }
        return $this->handleAuthenticationFail();
    }
    
    public function migrateAccountNew()
    {
        foreach ($this->providers as $provider) {
            if (!$provider instanceof ilAuthProviderAccountMigrationInterface) {
                $this->logger->warning('Provider: ' . get_class($provider) . ' does not support account migration.');
                throw new InvalidArgumentException('Invalid auth provider given.');
            }
            $provider->createNewAccount($this->getStatus());

            switch ($this->getStatus()->getStatus()) {
                case ilAuthStatus::STATUS_AUTHENTICATED:
                    return $this->handleAuthenticationSuccess($provider);
                    
            }
        }
        return $this->handleAuthenticationFail();
    }


    
    public function authenticate()
    {
        foreach ($this->getProviders() as $provider) {
            $this->resetStatus();
            
            $this->getLogger()->debug('Trying authentication against: ' . get_class($provider));
            
            $provider->doAuthentication($this->getStatus());
            
            $this->getLogger()->debug('Authentication user id: ' . $this->getStatus()->getAuthenticatedUserId());
            
            switch ($this->getStatus()->getStatus()) {
                case ilAuthStatus::STATUS_AUTHENTICATED:
                    return $this->handleAuthenticationSuccess($provider);
                    
                case ilAuthStatus::STATUS_ACCOUNT_MIGRATION_REQUIRED:
                    $this->getLogger()->notice("Account migration required.");
                    return $this->handleAccountMigration($provider);
                    
                case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                default:
                    $this->getLogger()->debug('Authentication failed against: ' . get_class($provider));
                    break;
            }
        }
        return $this->handleAuthenticationFail();
    }
    
    protected function handleAccountMigration(ilAuthProviderAccountMigrationInterface $provider)
    {
        $this->getLogger()->debug('Trigger auth mode: ' . $provider->getTriggerAuthMode());
        $this->getLogger()->debug('Desired auth mode: ' . $provider->getUserAuthModeName());
        $this->getLogger()->debug('External account: ' . $provider->getExternalAccountName());
        
        $this->getStatus()->setAuthenticatedUserId(ANONYMOUS_USER_ID);
        #$this->getStatus()->setStatus(ilAuthStatus::STATUS_AUTHENTICATED);
        
        ilSession::set(static::MIG_TRIGGER_AUTHMODE, $provider->getTriggerAuthMode());
        ilSession::set(static::MIG_DESIRED_AUTHMODE, $provider->getUserAuthModeName());
        ilSession::set(static::MIG_EXTERNAL_ACCOUNT, $provider->getExternalAccountName());
        
        $this->getLogger()->dump($_SESSION, ilLogLevel::DEBUG);
        
        return true;
    }
    
    protected function handleAuthenticationSuccess(ilAuthProviderInterface $provider)
    {
        include_once './Services/Object/classes/class.ilObjectFactory.php';
        $factory = new ilObjectFactory();
        $user = $factory->getInstanceByObjId($this->getStatus()->getAuthenticatedUserId(), false);
        
        // reset expired status
        $this->getAuthSession()->setExpired(false);
        
        if (!$user instanceof ilObjUser) {
            $this->getLogger()->error('Cannot instantiate user account with id: ' . $this->getStatus()->getAuthenticatedUserId());
            $this->getStatus()->setStatus(ilAuthStatus::STATUS_AUTHENTICATION_FAILED);
            $this->getStatus()->setAuthenticatedUserId(0);
            $this->getStatus()->setReason('auth_err_invalid_user_account');
            return false;
        }

        if (!$this->checkExceededLoginAttempts($user)) {
            $this->getLogger()->info('Authentication failed for inactive user with id and too may login attempts: ' . $this->getStatus()->getAuthenticatedUserId());
            $this->getStatus()->setStatus(ilAuthStatus::STATUS_AUTHENTICATION_FAILED);
            $this->getStatus()->setAuthenticatedUserId(0);
            $this->getStatus()->setReason('auth_err_login_attempts_deactivation');
            return false;
        }

        if (!$this->checkActivation($user)) {
            $this->getLogger()->info('Authentication failed for inactive user with id: ' . $this->getStatus()->getAuthenticatedUserId());
            $this->getStatus()->setStatus(ilAuthStatus::STATUS_AUTHENTICATION_FAILED);
            $this->getStatus()->setAuthenticatedUserId(0);
            $this->getStatus()->setReason('err_inactive');
            return false;
        }
        
        // time limit
        if (!$this->checkTimeLimit($user)) {
            $this->getLogger()->info('Authentication failed (time limit restriction) for user with id: ' . $this->getStatus()->getAuthenticatedUserId());

            if ($GLOBALS['DIC']['ilSetting']->get('user_reactivate_code')) {
                $this->getLogger()->debug('Accout reactivation codes are active');
                $this->getStatus()->setStatus(ilAuthStatus::STATUS_CODE_ACTIVATION_REQUIRED);
            } else {
                $this->getLogger()->debug('Accout reactivation codes are inactive');
                $this->getStatus()->setStatus(ilAuthStatus::STATUS_AUTHENTICATION_FAILED);
                $this->getStatus()->setAuthenticatedUserId(0);
            }
            $this->getStatus()->setReason('time_limit_reached');
            return false;
        }
        
        // ip check
        if (!$this->checkIp($user)) {
            $this->getLogger()->info('Authentication failed (wrong ip) for user with id: ' . $this->getStatus()->getAuthenticatedUserId());
            $this->getStatus()->setStatus(ilAuthStatus::STATUS_AUTHENTICATION_FAILED);
            $this->getStatus()->setAuthenticatedUserId(0);
            
            $this->getStatus()->setTranslatedReason(
                sprintf(
                    $GLOBALS['DIC']->language()->txt('wrong_ip_detected'),
                    $_SERVER['REMOTE_ADDR']
                )
            );
            return false;
        }
        
        // check simultaneos logins
        $this->getLogger()->debug('Check simutaneous login');
        if (!$this->checkSimultaneousLogins($user)) {
            $this->getLogger()->info('Authentication failed: simultaneous logins forbidden for user: ' . $this->getStatus()->getAuthenticatedUserId());
            $this->getStatus()->setStatus(ilAuthStatus::STATUS_AUTHENTICATION_FAILED);
            $this->getStatus()->setAuthenticatedUserId(0);
            $this->getStatus()->setReason('simultaneous_login_detected');
            return false;
        }
        
        // check if profile is complete
        include_once "Services/User/classes/class.ilUserProfile.php";
        include_once './Services/Context/classes/class.ilContext.php';
        if (
            ilUserProfile::isProfileIncomplete($user) &&
            ilAuthFactory::getContext() != ilAuthFactory::CONTEXT_ECS &&
            ilContext::getType() != ilContext::CONTEXT_LTI_PROVIDER
        ) {
            ilLoggerFactory::getLogger('auth')->info('User profile is incomplete.');
            $user->setProfileIncomplete(true);
            $user->update();
        }

        // redirects in case of error (session pool limit reached)
        ilSessionControl::handleLoginEvent($user->getLogin(), $this->getAuthSession());
        

        // @todo move to event handling
        include_once 'Services/Tracking/classes/class.ilOnlineTracking.php';
        ilOnlineTracking::addUser($user->getId());

        // @todo move to event handling
        include_once 'Modules/Forum/classes/class.ilObjForum.php';
        ilObjForum::_updateOldAccess($user->getId());

        require_once 'Services/PrivacySecurity/classes/class.ilSecuritySettings.php';
        $security_settings = ilSecuritySettings::_getInstance();

        // determine first login of user for setting an indicator
        // which still is available in PersonalDesktop, Repository, ...
        // (last login date is set to current date in next step)
        if (
            $security_settings->isPasswordChangeOnFirstLoginEnabled() &&
            $user->getLastLogin() == null
        ) {
            $user->resetLastPasswordChange();
        }
        $user->refreshLogin();
            
        // reset counter for failed logins
        ilObjUser::_resetLoginAttempts($user->getId());


        $this->getLogger()->info('Successfully authenticated: ' . ilObjUser::_lookupLogin($this->getStatus()->getAuthenticatedUserId()));
        $this->getAuthSession()->setAuthenticated(true, $this->getStatus()->getAuthenticatedUserId());
        
        include_once './Services/Init/classes/class.ilInitialisation.php';
        ilInitialisation::initUserAccount();
        
        ilSession::set('orig_request_target', '');
        $user->hasToAcceptTermsOfServiceInSession(true);
        
        
        // --- anonymous/registered user
        $this->getLogger()->info(
            'logged in as ' . $user->getLogin() .
            ', remote:' . $_SERVER['REMOTE_ADDR'] . ':' . $_SERVER['REMOTE_PORT'] .
            ', server:' . $_SERVER['SERVER_ADDR'] . ':' . $_SERVER['SERVER_PORT']
        );

        // finally raise event
        global $DIC;

        $ilAppEventHandler = $DIC['ilAppEventHandler'];
        $ilAppEventHandler->raise(
            'Services/Authentication',
            'afterLogin',
            array(
                'username' => $user->getLogin())
        );
        
        return true;
    }
    
    protected function checkActivation(ilObjUser $user)
    {
        return $user->getActive();
    }

    protected function checkExceededLoginAttempts(\ilObjUser $user)
    {
        if (in_array($user->getId(), array(ANONYMOUS_USER_ID))) {
            return true;
        }

        $isInactive = !$user->getActive();
        if (!$isInactive) {
            return true;
        }

        require_once 'Services/PrivacySecurity/classes/class.ilSecuritySettings.php';
        $security = ilSecuritySettings::_getInstance();
        $maxLoginAttempts = $security->getLoginMaxAttempts();

        if (!(int) $maxLoginAttempts) {
            return true;
        }

        $numLoginAttempts = \ilObjUser::_getLoginAttempts($user->getId());

        return $numLoginAttempts < $maxLoginAttempts;
    }

    protected function checkTimeLimit(ilObjUser $user)
    {
        return $user->checkTimeLimit();
    }
    
    protected function checkIp(ilObjUser $user)
    {
        $clientip = $user->getClientIP();
        if (trim($clientip) != "") {
            $clientip = preg_replace("/[^0-9.?*,:]+/", "", $clientip);
            $clientip = str_replace(".", "\\.", $clientip);
            $clientip = str_replace(array("?","*",","), array("[0-9]","[0-9]*","|"), $clientip);
            
            ilLoggerFactory::getLogger('auth')->debug('Check ip ' . $clientip . ' against ' . $_SERVER['REMOTE_ADDR']);

            if (!preg_match("/^" . $clientip . "$/", $_SERVER["REMOTE_ADDR"])) {
                return false;
            }
        }
        return true;
    }
    
    protected function checkSimultaneousLogins(ilObjUser $user)
    {
        $this->getLogger()->debug('Setting prevent simultaneous session is: ' . (string) $GLOBALS['DIC']['ilSetting']->get('ps_prevent_simultaneous_logins'));
        if (
            $GLOBALS['DIC']['ilSetting']->get('ps_prevent_simultaneous_logins') &&
            ilObjUser::hasActiveSession($user->getId(), $this->getAuthSession()->getId())
        ) {
            return false;
        }
        return true;
    }

    protected function handleAuthenticationFail()
    {
        $this->getLogger()->debug('Authentication failed for all authentication methods.');

        $user_id = ilObjUser::_lookupId($this->getCredentials()->getUsername());
        if (!in_array($user_id, array(ANONYMOUS_USER_ID))) {
            ilObjUser::_incrementLoginAttempts($user_id);
            $login_attempts = ilObjUser::_getLoginAttempts($user_id);
            
            $this->getLogger()->notice('Increased login attempts for user: ' . $this->getCredentials()->getUsername());
            
            include_once './Services/PrivacySecurity/classes/class.ilSecuritySettings.php';
            $security = ilSecuritySettings::_getInstance();
            $max_attempts = $security->getLoginMaxAttempts();
            
            if ((int) $max_attempts && $login_attempts >= $max_attempts) {
                $this->getStatus()->setReason('auth_err_login_attempts_deactivation');
                $this->getLogger()->warning('User account set to inactive due to exceeded login attempts.');
                ilObjUser::_setUserInactive($user_id);
            }
        }
    }
}