class.ilAuthFrontend.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

//TODO check why authfront does not include frontendInterface
class ilAuthFrontend
{
    public const MIG_EXTERNAL_ACCOUNT = 'mig_ext_account';
    public const MIG_TRIGGER_AUTHMODE = 'mig_trigger_auth_mode';
    public const MIG_DESIRED_AUTHMODE = 'mig_desired_auth_mode';

    private ilLogger $logger;
    private ilSetting $settings;
    private ilLanguage $lng;

    private ilAuthCredentials $credentials;
    private ilAuthStatus $status;
    private array $providers;
    private ilAuthSession $auth_session;
    private ilAppEventHandler $ilAppEventHandler;

    private ilUserProfile $user_profile;

    private bool $authenticated = false;

    public function __construct(ilAuthSession $session, ilAuthStatus $status, ilAuthCredentials $credentials, array $providers)
    {
        global $DIC;
        $this->logger = $DIC->logger()->auth();
        $this->settings = $DIC->settings();
        $this->lng = $DIC->language();
        $this->ilAppEventHandler = $DIC->event();

        $this->auth_session = $session;
        $this->credentials = $credentials;
        $this->status = $status;
        $this->providers = $providers;

        $this->user_profile = new ilUserProfile();
    }

    public function getAuthSession(): ilAuthSession
    {
        return $this->auth_session;
    }

    public function getCredentials(): ilAuthCredentials
    {
        return $this->credentials;
    }

    public function getProviders(): array
    {
        return $this->providers;
    }

    public function getStatus(): ilAuthStatus
    {
        return $this->status;
    }

    public function resetStatus(): void
    {
        $this->getStatus()->setStatus(ilAuthStatus::STATUS_UNDEFINED);
        $this->getStatus()->setReason('');
        $this->getStatus()->setAuthenticatedUserId(ANONYMOUS_USER_ID);
    }

    public function migrateAccount(ilAuthSession $session): bool
    {
        if (!$session->isAuthenticated()) {
            $this->logger->warning('Desired user account is not authenticated');
            return false;
        }
        $user = ilObjectFactory::getInstanceByObjId($session->getUserId(), false);

        if (!$user instanceof ilObjUser) {
            $this->logger->info('Cannot instantiate user account for account migration: ' . $session->getUserId());
            return false;
        }

        $user->setAuthMode(ilSession::get(static::MIG_DESIRED_AUTHMODE));

        $this->logger->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());
            if ($this->getStatus()->getStatus() === ilAuthStatus::STATUS_AUTHENTICATED) {
                return $this->handleAuthenticationSuccess($provider);
            }
        }
        return $this->handleAuthenticationFail();
    }

    public function migrateAccountNew(): bool
    {
        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());

            if ($provider instanceof ilAuthProviderInterface &&
                $this->getStatus()->getStatus() === ilAuthStatus::STATUS_AUTHENTICATED) {
                return $this->handleAuthenticationSuccess($provider);
            }
        }
        return $this->handleAuthenticationFail();
    }



    public function authenticate(): bool
    {
        foreach ($this->getProviders() as $provider) {
            $this->resetStatus();

            $this->logger->debug('Trying authentication against: ' . get_class($provider));

            $provider->doAuthentication($this->getStatus());

            $this->logger->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->logger->notice("Account migration required.");
                    if ($provider instanceof ilAuthProviderAccountMigrationInterface) {
                        return $this->handleAccountMigration($provider);
                    }

                    $this->logger->error('Authentication migratittion required but provider does not support interface' . get_class($provider));
                    break;
                case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                default:
                    $this->logger->debug('Authentication failed against: ' . get_class($provider));
                    break;
            }
        }
        return $this->handleAuthenticationFail();
    }

    protected function handleAccountMigration(ilAuthProviderAccountMigrationInterface $provider): bool
    {
        $this->logger->debug('Trigger auth mode: ' . $provider->getTriggerAuthMode());
        $this->logger->debug('Desired auth mode: ' . $provider->getUserAuthModeName());
        $this->logger->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->logger->dump(ilSession::dumpToString(), ilLogLevel::DEBUG);

        return true;
    }

    protected function handleAuthenticationSuccess(ilAuthProviderInterface $provider): bool
    {
        $user = ilObjectFactory::getInstanceByObjId($this->getStatus()->getAuthenticatedUserId(), false);

        $this->getStatus()->setReason('auth_err_invalid_user_account');
        // reset expired status
        $this->getAuthSession()->setExpired(false);

        if (!$user instanceof ilObjUser) {
            $this->logger->error('Cannot instantiate user account with id: ' . $this->getStatus()->getAuthenticatedUserId());
            $this->getStatus()->setStatus(ilAuthStatus::STATUS_AUTHENTICATION_FAILED);
            $this->getStatus()->setAuthenticatedUserId(ANONYMOUS_USER_ID);
            return false;
        }

        if (!$this->checkExceededLoginAttempts($user)) {
            $this->logger->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(ANONYMOUS_USER_ID);
            return false;
        }

        if (!$this->checkActivation($user)) {
            $this->logger->info('Authentication failed for inactive user with id: ' . $this->getStatus()->getAuthenticatedUserId());
            $this->getStatus()->setStatus(ilAuthStatus::STATUS_AUTHENTICATION_FAILED);
            $this->getStatus()->setAuthenticatedUserId(ANONYMOUS_USER_ID);
            return false;
        }

        // time limit
        if (!$this->checkTimeLimit($user)) {
            $this->logger->info('Authentication failed (time limit restriction) for user with id: ' . $this->getStatus()->getAuthenticatedUserId());

            if ($this->settings->get('user_reactivate_code')) {
                $this->logger->debug('Accout reactivation codes are active');
                $this->getStatus()->setStatus(ilAuthStatus::STATUS_CODE_ACTIVATION_REQUIRED);
            } else {
                $this->logger->debug('Accout reactivation codes are inactive');
                $this->getStatus()->setStatus(ilAuthStatus::STATUS_AUTHENTICATION_FAILED);
                $this->getStatus()->setAuthenticatedUserId(ANONYMOUS_USER_ID);
            }
            return false;
        }

        // ip check
        if (!$this->checkIp($user)) {
            $this->logger->info('Authentication failed (wrong ip) for user with id: ' . $this->getStatus()->getAuthenticatedUserId());
            $this->getStatus()->setStatus(ilAuthStatus::STATUS_AUTHENTICATION_FAILED);
            $this->getStatus()->setAuthenticatedUserId(ANONYMOUS_USER_ID);
            return false;
        }

        // check simultaneos logins
        $this->logger->debug('Check simutaneous login');
        if (!$this->checkSimultaneousLogins($user)) {
            $this->logger->info('Authentication failed: simultaneous logins forbidden for user: ' . $this->getStatus()->getAuthenticatedUserId());
            $this->getStatus()->setStatus(ilAuthStatus::STATUS_AUTHENTICATION_FAILED);
            $this->getStatus()->setAuthenticatedUserId(ANONYMOUS_USER_ID);
            return false;
        }

        // check if profile is complete
        if (
            $this->user_profile->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
        ilOnlineTracking::addUser($user->getId());

        $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() === ''
        ) {
            $user->resetLastPasswordChange();
        }
        $user->refreshLogin();

        if ($user->getLoginAttempts() > 0) {
            $user->setLoginAttempts(0);
            $user->update();
        }


        $this->logger->info('Successfully authenticated: ' . ilObjUser::_lookupLogin($this->getStatus()->getAuthenticatedUserId()));
        $this->getAuthSession()->setAuthenticated(true, $this->getStatus()->getAuthenticatedUserId());

        ilInitialisation::initUserAccount();

        ilSession::set('orig_request_target', '');


        // --- anonymous/registered user
        if (PHP_SAPI !== "cli") {
            $this->logger->info(
                'logged in as ' . $user->getLogin() .
            ', remote:' . $_SERVER['REMOTE_ADDR'] . ':' . $_SERVER['REMOTE_PORT'] .
            ', server:' . $_SERVER['SERVER_ADDR'] . ':' . $_SERVER['SERVER_PORT']
            );
        } else {
            $this->logger->info(
                'logged in as ' . $user->getLogin() . ' from CLI'
            );
        }

        // finally raise event
        $this->ilAppEventHandler->raise(
            'components/ILIAS/Authentication',
            'afterLogin',
            array(
                'username' => $user->getLogin())
        );

        $this->getStatus()->setReason('');
        return true;
    }

    protected function checkActivation(ilObjUser $user): bool
    {
        return $user->getActive();
    }

    protected function checkExceededLoginAttempts(ilObjUser $user): bool
    {
        if ($user->getId() === ANONYMOUS_USER_ID) {
            return true;
        }

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

        $security = ilSecuritySettings::_getInstance();
        $maxLoginAttempts = $security->getLoginMaxAttempts();

        if (!$maxLoginAttempts) {
            return true;
        }

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

        return $numLoginAttempts < $maxLoginAttempts;
    }

    protected function checkTimeLimit(ilObjUser $user): bool
    {
        return $user->checkTimeLimit();
    }

    protected function checkIp(ilObjUser $user): bool
    {
        $clientip = $user->getClientIP();
        if (trim($clientip) !== "") {
            $clientip = preg_replace("/[^0-9.?*,:]+/", "", $clientip);
            $clientip = str_replace([".", "?", "*", ","], ["\\.", "[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): bool
    {
        $this->logger->debug('Setting prevent simultaneous session is: ' . $this->settings->get('ps_prevent_simultaneous_logins'));
        return !($this->settings->get('ps_prevent_simultaneous_logins') &&
            ilObjUser::hasActiveSession($user->getId(), $this->getAuthSession()->getId()));
    }

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

        $this->handleLoginAttempts();

        return false;
    }

    protected function handleLoginAttempts(): void
    {
        $security = ilSecuritySettings::_getInstance();
        $max_attempts = $security->getLoginMaxAttempts();
        if ($max_attempts < 1) {
            return;
        }

        $auth_determination = ilAuthModeDetermination::_getInstance();
        if ($this->getCredentials()->getAuthMode() !== '') {
            $auth_modes = [
                $this->getCredentials()->getAuthMode()
            ];
        } else {
            $auth_modes = $auth_determination->getAuthModeSequence($this->getCredentials()->getUsername());
        }

        $usr_id_candidates = [];
        foreach (array_filter($auth_modes) as $auth_mode) {
            if ((int) $auth_mode === ilAuthUtils::AUTH_LOCAL) {
                $usr_id_candidates[] = ilObjUser::_lookupId($this->getCredentials()->getUsername());
                continue;
            }

            $login = ilObjUser::_checkExternalAuthAccount(
                ilAuthUtils::_getAuthModeName($auth_mode),
                $this->getCredentials()->getUsername(),
                false
            );
            if (!is_string($login) || $login === '') {
                continue;
            }

            $usr_id_candidates[] = ilObjUser::_lookupId($login);
        }

        $usr_id_candidates = array_values(array_unique(array_filter($usr_id_candidates, intval(...))));
        $num_deacticated_accounts = 0;
        foreach ($usr_id_candidates as $usr_id) {
            if ($usr_id === ANONYMOUS_USER_ID) {
                continue;
            }

            $num_login_attempts = ilObjUser::_getLoginAttempts($usr_id);

            if ($num_login_attempts <= $max_attempts) {
                ilObjUser::_incrementLoginAttempts($usr_id);
                $this->logger->notice(
                    sprintf(
                        'Incremented login attempts for user %s with id %s.',
                        $this->getCredentials()->getUsername(),
                        $usr_id
                    )
                );
            }

            if ($num_login_attempts >= $max_attempts) {
                ilObjUser::_setUserInactive($usr_id);

                ++$num_deacticated_accounts;
                $this->logger->warning(
                    sprintf(
                        'User account %s with id %s set to inactive due to exceeded login attempts.',
                        $this->getCredentials()->getUsername(),
                        $usr_id
                    )
                );
            }
        }

        if ($num_deacticated_accounts > 0) {
            $this->getStatus()->setReason('auth_err_login_attempts_deactivation');
        }
    }
}