Auth prvider for ecs auth. More...

Inheritance diagram for ilAuthProviderECS:

Collaboration diagram for ilAuthProviderECS:

Public Member Functions
	__construct (\ilAuthCredentials $credentials)
	Constructor. More...

	getAbreviation ()
	get abbreviation More...

	getMID ()
	get mid More...

	setMID ($a_mid)

	setCurrentServer (ilECSSetting $server=null)
	Set current server. More...

	getCurrentServer ()
	Get current server. More...

	getServerSettings ()
	Get server settings. More...

	doAuthentication (\ilAuthStatus $status)
	Tra ecs authentication. More...

	handleLogin ()
	Called from base class after successful login. More...

	validateHash ()
	Validate ECS hash. More...

Public Member Functions inherited from ilAuthProvider
	__construct (ilAuthCredentials $credentials)
	Constructor. More...

	getLogger ()
	Get logger. More...

	getCredentials ()

Protected Member Functions
	createUser (ilECSUser $user)
	create new user More...

	updateUser (ilECSUser $user, $a_local_user_id)
	update existing user More...

	resetMailOptions ($a_usr_id)
	Reset mail options to "local only". More...

Protected Member Functions inherited from ilAuthProvider
	handleAuthenticationFail (ilAuthStatus $status, $a_reason)
	Handle failed authentication. More...

Protected Attributes
	$mid = null

	$abreviation = null

	$currentServer = null

	$servers = null

Private Member Functions
	initECSServices ()
	Init ECS Services private. More...

Additional Inherited Members
Data Fields inherited from ilAuthProvider
const	STATUS_UNDEFINED = 0

const	STATUS_AUTHENTICATION_SUCCESS = 1

const	STATUS_AUTHENTICATION_FAILED = 2

const	STATUS_MIGRATION = 3

Detailed Description

Auth prvider for ecs auth.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 14 of file class.ilAuthProviderECS.php.

Constructor & Destructor Documentation

◆ __construct()

ilAuthProviderECS::__construct ( \ilAuthCredentials $credentials )

Constructor.

Parameters

\ilAuthCredentials $credentials

Definition at line 27 of file class.ilAuthProviderECS.php.

References initECSServices().

     {
         parent::__construct($credentials);
 
         $this->initECSServices();
     }

Here is the call graph for this function:

Member Function Documentation

◆ createUser()

ilAuthProviderECS::createUser ( ilECSUser $user )

protected

create new user

protected

Definition at line 258 of file class.ilAuthProviderECS.php.

References $DIC, $ilLog, $ilSetting, ilAuthUtils\_generateLogin(), ilObject\_writeImportId(), getAbreviation(), getCurrentServer(), ilECSUser\getEmail(), ilECSUser\getFirstname(), ilECSUser\getImportId(), ilECSUser\getInstitution(), ilECSUser\getLastname(), ilAuthProvider\getLogger(), ilECSUser\getLogin(), IL_PASSWD_CRYPTED, and resetMailOptions().

Referenced by handleLogin().

     {
         global $DIC;
 
         $ilClientIniFile = $DIC['ilClientIniFile'];
         $ilSetting = $DIC['ilSetting'];
         $rbacadmin = $DIC['rbacadmin'];
         $ilLog = $DIC['ilLog'];
 
         $userObj = new ilObjUser();
         $userObj->setOwner(SYSTEM_USER_ID);
 
         include_once('./Services/Authentication/classes/class.ilAuthUtils.php');
         $local_user = ilAuthUtils::_generateLogin($this->getAbreviation() . '_' . $user->getLogin());
 
         $newUser["login"] = $local_user;
         $newUser["firstname"] = $user->getFirstname();
         $newUser["lastname"] = $user->getLastname();
         $newUser['email'] = $user->getEmail();
         $newUser['institution'] = $user->getInstitution();
 
         // set "plain md5" password (= no valid password)
         $newUser["passwd"] = "";
         $newUser["passwd_type"] = IL_PASSWD_CRYPTED;
 
         $newUser["auth_mode"] = "ecs";
         $newUser["profile_incomplete"] = 0;
 
         // system data
         $userObj->assignData($newUser);
         $userObj->setTitle($userObj->getFullname());
         $userObj->setDescription($userObj->getEmail());
 
         // set user language to system language
         $userObj->setLanguage($ilSetting->get("language"));
 
         // Time limit
         $userObj->setTimeLimitOwner(7);
         $userObj->setTimeLimitUnlimited(0);
         $userObj->setTimeLimitFrom(time() - 5);
         $userObj->setTimeLimitUntil(time() + $ilClientIniFile->readVariable("session", "expire"));
 
         #$now = new ilDateTime(time(), IL_CAL_UNIX);
         #$userObj->setAgreeDate($now->get(IL_CAL_DATETIME));
 
         // Create user in DB
         $userObj->setOwner(6);
         $userObj->create();
         $userObj->setActive(1);
         $userObj->updateOwner();
         $userObj->saveAsNew();
         $userObj->writePrefs();
 
         if ($global_role = $this->getCurrentServer()->getGlobalRole()) {
             $rbacadmin->assignUser($this->getCurrentServer()->getGlobalRole(), $userObj->getId(), true);
         }
         ilObject::_writeImportId($userObj->getId(), $user->getImportId());
 
         $this->getLogger()->info('Created new remote user with usr_id: ' . $user->getImportId());
 
         // Send Mail
         #$this->sendNotification($userObj);
         $this->resetMailOptions($userObj->getId());
         
         return $userObj->getLogin();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doAuthentication()

ilAuthProviderECS::doAuthentication ( \ilAuthStatus $status )

Tra ecs authentication.

Parameters

\ilAuthStatus $status

Returns: boolean

Implements ilAuthProviderInterface.

Definition at line 94 of file class.ilAuthProviderECS.php.

References $server, ilAuthProvider\getLogger(), getServerSettings(), ilAuthProvider\handleAuthenticationFail(), handleLogin(), ilAuthStatus\setAuthenticatedUserId(), setCurrentServer(), ilAuthStatus\setStatus(), ilAuthStatus\STATUS_AUTHENTICATED, and validateHash().

     {
         $this->getLogger()->debug('Starting ECS authentication');
         if (!$this->getServerSettings()->activeServerExists()) {
             $this->getLogger()->warning('No active ecs server found. Aborting');
             $this->handleAuthenticationFail($status, 'err_wrong_login');
             return false;
         }
         
         // Iterate through all active ecs instances
         include_once './Services/WebServices/ECS/classes/class.ilECSServerSettings.php';
         foreach ($this->getServerSettings()->getServers() as $server) {
             $this->setCurrentServer($server);
             if ($this->validateHash()) {
                 // handle successful authentication
                 $new_usr_id = $this->handleLogin();
                 $this->getLogger()->info('ECS authentication successful.');
                 $status->setStatus(ilAuthStatus::STATUS_AUTHENTICATED);
                 $status->setAuthenticatedUserId($new_usr_id);
                 return true;
             }
         }
 
         $this->getLogger()->warning('Could not validate ecs hash for any active server.');
         $this->handleAuthenticationFail($status, 'err_wrong_login');
         return false;
     }

Here is the call graph for this function:

◆ getAbreviation()

ilAuthProviderECS::getAbreviation ( )

get abbreviation

public

Parameters

Definition at line 41 of file class.ilAuthProviderECS.php.

References $abreviation.

Referenced by createUser().

     {
         return $this->abreviation;
     }

Here is the caller graph for this function:

◆ getCurrentServer()

ilAuthProviderECS::getCurrentServer ( )

Get current server.

Returns: ilECSSetting

Definition at line 74 of file class.ilAuthProviderECS.php.

References $currentServer.

Referenced by createUser(), handleLogin(), updateUser(), and validateHash().

     {
         return $this->currentServer;
     }

Here is the caller graph for this function:

◆ getMID()

ilAuthProviderECS::getMID ( )

get mid

public

Definition at line 51 of file class.ilAuthProviderECS.php.

References $mid.

Referenced by handleLogin().

     {
         return $this->mid;
     }

Here is the caller graph for this function:

◆ getServerSettings()

ilAuthProviderECS::getServerSettings ( )

Get server settings.

Returns: ilECSServerSettings

Definition at line 83 of file class.ilAuthProviderECS.php.

References $servers.

Referenced by doAuthentication().

     {
         return $this->servers;
     }

Here is the caller graph for this function:

◆ handleLogin()

ilAuthProviderECS::handleLogin ( )

Called from base class after successful login.

Parameters

string username

Definition at line 128 of file class.ilAuthProviderECS.php.

References $_GET, $user, ilObjUser\_lookupId(), ilObject\_lookupObjIdByImportId(), createUser(), getCurrentServer(), ilAuthProvider\getLogger(), getMID(), and updateUser().

Referenced by doAuthentication().

     {
         include_once('./Services/WebServices/ECS/classes/class.ilECSUser.php');
         
         $user = new ilECSUser($_GET);
         
         if (!$usr_id = ilObject::_lookupObjIdByImportId($user->getImportId())) {
             $username = $this->createUser($user);
         } else {
             $username = $this->updateUser($user, $usr_id);
         }
         
         // set user imported
         include_once './Services/WebServices/ECS/classes/class.ilECSImport.php';
         $import = new ilECSImport($this->getCurrentServer()->getServerId(), $usr_id);
         $import->save();
         
         // Store remote user data
         include_once './Services/WebServices/ECS/classes/class.ilECSRemoteUser.php';
         $remote = new ilECSRemoteUser();
         $remote->setServerId($this->getCurrentServer()->getServerId());
         $remote->setMid($this->getMID());
         $remote->setRemoteUserId($user->getImportId());
         $remote->setUserId(ilObjUser::_lookupId($username));
 
         $this->getLogger()->info('Current user is: ' . $username);
         
         if (!$remote->exists()) {
             $remote->create();
         }
         return ilObjUser::_lookupId($username);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initECSServices()

ilAuthProviderECS::initECSServices ( )

private

Init ECS Services private.

Parameters

Definition at line 247 of file class.ilAuthProviderECS.php.

References ilECSServerSettings\getInstance().

Referenced by __construct().

     {
         include_once './Services/WebServices/ECS/classes/class.ilECSServerSettings.php';
         $this->servers = ilECSServerSettings::getInstance();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetMailOptions()

ilAuthProviderECS::resetMailOptions ( $a_usr_id )

protected

Reset mail options to "local only".

Definition at line 372 of file class.ilAuthProviderECS.php.

References PHPMailer\PHPMailer\$options, and ilMailOptions\INCOMING_LOCAL.

Referenced by createUser(), and updateUser().

     {
         include_once './Services/Mail/classes/class.ilMailOptions.php';
         $options = new ilMailOptions($a_usr_id);
         $options->setIncomingType(ilMailOptions::INCOMING_LOCAL);
         $options->updateOptions();
     }

Here is the caller graph for this function:

◆ setCurrentServer()

ilAuthProviderECS::setCurrentServer ( ilECSSetting $server = null )

Set current server.

Parameters

ilECSSetting $server

Definition at line 65 of file class.ilAuthProviderECS.php.

References $server.

Referenced by doAuthentication().

     {
         $this->currentServer = $server;
     }

Here is the caller graph for this function:

◆ setMID()

ilAuthProviderECS::setMID ( $a_mid )

Definition at line 56 of file class.ilAuthProviderECS.php.

Referenced by validateHash().

     {
         $this->mid = $a_mid;
     }

Here is the caller graph for this function:

◆ updateUser()

ilAuthProviderECS::updateUser	(	ilECSUser	$user,
			$a_local_user_id
	)

protected

update existing user

protected

Definition at line 330 of file class.ilAuthProviderECS.php.

References $DIC, $ilLog, getCurrentServer(), ilECSUser\getEmail(), ilECSUser\getFirstname(), ilECSUser\getImportId(), ilECSUser\getInstitution(), ilECSUser\getLastname(), ilAuthProvider\getLogger(), and resetMailOptions().

Referenced by handleLogin().

     {
         global $DIC;
 
         $ilClientIniFile = $DIC['ilClientIniFile'];
         $ilLog = $DIC['ilLog'];
         $rbacadmin = $DIC['rbacadmin'];
         
         $user_obj = new ilObjUser($a_local_user_id);
         $user_obj->setFirstname($user->getFirstname());
         $user_obj->setLastname($user->getLastname());
         $user_obj->setEmail($user->getEmail());
         $user_obj->setInstitution($user->getInstitution());
         $user_obj->setActive(true);
         
         $until = $user_obj->getTimeLimitUntil();
 
         if ($until < (time() + $ilClientIniFile->readVariable('session', 'expire'))) {
             $user_obj->setTimeLimitFrom(time() - 60);
             $user_obj->setTimeLimitUntil(time() + $ilClientIniFile->readVariable("session", "expire"));
         }
         $user_obj->update();
         $user_obj->refreshLogin();
         
         if ($global_role = $this->getCurrentServer()->getGlobalRole()) {
             $rbacadmin->assignUser(
                 $this->getCurrentServer()->getGlobalRole(),
                 $user_obj->getId(),
                 true
             );
         }
         
         $this->resetMailOptions($a_local_user_id);
 
         $this->getLogger()->debug('Finished update of remote user with usr_id: ' . $user->getImportId());
         return $user_obj->getLogin();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validateHash()

ilAuthProviderECS::validateHash ( )

Validate ECS hash.

public

Parameters

string	username
string	pass

Definition at line 170 of file class.ilAuthProviderECS.php.

References $_GET, $DIC, $ilLog, $reader, $res, ilLogLevel\DEBUG, getCurrentServer(), ilECSCommunityReader\getInstanceByServerId(), ilAuthProvider\getLogger(), and setMID().

Referenced by doAuthentication().

     {
         global $DIC;
 
         $ilLog = $DIC['ilLog'];
         
         // fetch hash
         if (isset($_GET['ecs_hash']) and strlen($_GET['ecs_hash'])) {
             $hash = $_GET['ecs_hash'];
         }
         if (isset($_GET['ecs_hash_url'])) {
             $hashurl = urldecode($_GET['ecs_hash_url']);
             $hash = basename(parse_url($hashurl, PHP_URL_PATH));
             //$hash = urldecode($_GET['ecs_hash_url']);
         }
         
         $this->getLogger()->info('Using ecs hash: ' . $hash);
         // Check if hash is valid ...
         try {
             include_once('./Services/WebServices/ECS/classes/class.ilECSConnector.php');
             $connector = new ilECSConnector($this->getCurrentServer());
             $res = $connector->getAuth($hash);
             $auths = $res->getResult();
             
             $this->getLogger()->dump($auths, ilLogLevel::DEBUG);
 
             if ($auths->pid) {
                 try {
                     include_once './Services/WebServices/ECS/classes/class.ilECSCommunityReader.php';
                     $reader = ilECSCommunityReader::getInstanceByServerId($this->getCurrentServer()->getServerId());
                     foreach ($reader->getParticipantsByPid($auths->pid) as $participant) {
                         if ($participant->getOrganisation() instanceof \ilECSOrganisation) {
                             $this->abreviation = $participant->getOrganisation()->getAbbreviation();
                             break;
                         }
                     }
                     if (!$this->abreviation) {
                         $this->abreviation = $auths->abbr;
                     }
                 } catch (Exception $e) {
                     $this->getLogger()->warning('Authentication failed with message: ' . $e->getMessage());
                     return false;
                 }
             } else {
                 $this->abreviation = $auths->abbr;
             }
             
             $this->getLogger()->debug('Got abbreviation: ' . $this->abreviation);
         } catch (ilECSConnectorException $e) {
             $this->getLogger()->warning('Authentication failed with message: ' . $e->getMessage());
             return false;
         }
         
         // read current mid
         try {
             include_once('./Services/WebServices/ECS/classes/class.ilECSConnector.php');
             $connector = new ilECSConnector($this->getCurrentServer());
             $details = $connector->getAuth($hash, true);
             
             $this->getLogger()->dump($details, ilLogLevel::DEBUG);
             $this->getLogger()->debug('Token create for mid: ' . $details->getFirstSender());
             
             $this->setMID($details->getFirstSender());
         } catch (ilECSConnectorException $e) {
             $this->getLogger()->warning('Receiving mid failed with message: ' . $e->getMessage());
             return false;
         }
         return true;
     }