ilAuthProviderCAS Class Reference

CAS authentication provider. More...

Inheritance diagram for ilAuthProviderCAS:

Collaboration diagram for ilAuthProviderCAS:

Public Member Functions
	__construct (ilAuthCredentials $credentials)
	ilAuthProviderCAS constructor. More...
	doAuthentication (\ilAuthStatus $status)
	Do authentication. Parameters \ilAuthStatus $status Authentication status Returns bool More...
Public Member Functions inherited from ilAuthProvider
	__construct (ilAuthCredentials $credentials)
	Constructor. More...
	getLogger ()
	Get logger. More...
	getCredentials ()

Protected Member Functions
	getSettings ()
	handleLDAPDataSource (\ilAuthStatus $status)
	Handle user data synchonization by ldap data source. More...
Protected Member Functions inherited from ilAuthProvider
	handleAuthenticationFail (ilAuthStatus $status, $a_reason)
	Handle failed authentication. More...

Private Attributes
	$settings = null

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

CAS authentication provider.

Author

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

Definition at line 13 of file class.ilAuthProviderCAS.php.

Constructor & Destructor Documentation

__construct()

ilAuthProviderCAS::__construct

(

ilAuthCredentials

$credentials

)

ilAuthProviderCAS constructor.

Parameters

\ilAuthCredentials

$credentials

Definition at line 24 of file class.ilAuthProviderCAS.php.

References $DIC, ilCASSettings\getInstance(), and settings().

        {
                global $DIC;

                parent::__construct($credentials);
                include_once './Services/CAS/classes/class.ilCASSettings.php';
                $this->settings = ilCASSettings::getInstance();
        }

Here is the call graph for this function:

Member Function Documentation

doAuthentication()

ilAuthProviderCAS::doAuthentication

(

\ilAuthStatus

$status

)

Do authentication.

Parameters

\ilAuthStatus

$status

Authentication status

Returns

bool

Implements ilAuthProviderInterface.

Definition at line 44 of file class.ilAuthProviderCAS.php.

References ilObjUser\_checkExternalAuthAccount(), ilObjUser\_lookupId(), AUTH_CAS, CAS_VERSION_2_0, phpCAS\client(), phpCAS\forceAuthentication(), ilAuthProvider\getCredentials(), ilAuthProvider\getLogger(), getSettings(), phpCAS\getUser(), ilAuthProvider\handleAuthenticationFail(), handleLDAPDataSource(), ilLDAPServer\isDataSourceActive(), ilAuthStatus\setAuthenticatedUserId(), phpCAS\setDebug(), phpCAS\setNoCasServerValidation(), ilAuthStatus\setStatus(), phpCAS\setVerbose(), and ilAuthStatus\STATUS_AUTHENTICATED.

        {
                include_once './Services/CAS/lib/CAS.php';
                global $phpCAS;

                $this->getLogger()->debug('Starting cas authentication attempt... ');

                try {
                        phpCAS::setDebug(false);
                        phpCAS::setVerbose(true);
                        phpCAS::client(
                                CAS_VERSION_2_0,
                                $this->getSettings()->getServer(),
                                (int) $this->getSettings()->getPort(),
                                $this->getSettings()->getUri()
                        );

                        phpCAS::setNoCasServerValidation();
                        phpCAS::forceAuthentication();
                }
                catch(Exception $e) {
                        $this->getLogger()->error('Cas authentication failed with message: ' . $e->getMessage());
                        $this->handleAuthenticationFail($status, 'err_wrong_login');
                        return false;
                }

                if(!strlen(phpCAS::getUser()))
                {
                        return $this->handleAuthenticationFail($status, 'err_wrong_login');
                }
                $this->getCredentials()->setUsername(phpCAS::getUser());

                // check and handle ldap data sources
                include_once './Services/LDAP/classes/class.ilLDAPServer.php';
                if(ilLDAPServer::isDataSourceActive(AUTH_CAS))
                {
                        return $this->handleLDAPDataSource($status);
                }

                // Check account available
                $local_user = ilObjUser::_checkExternalAuthAccount("cas", $this->getCredentials()->getUsername());
                if(strlen($local_user))
                {
                        $this->getLogger()->debug('CAS authentication successful.');
                        $status->setStatus(ilAuthStatus::STATUS_AUTHENTICATED);
                        $status->setAuthenticatedUserId(ilObjUser::_lookupId($local_user));
                        return true;
                }

                if(!$this->getSettings()->isUserCreationEnabled())
                {
                        $this->getLogger()->debug('User creation disabled. No valid local account found');
                        $this->handleAuthenticationFail($status, 'err_auth_cas_no_ilias_user');
                        return false;
                }


                include_once './Services/CAS/classes/class.ilCASAttributeToUser.php';
                $importer = new ilCASAttributeToUser($this->getSettings());
                $new_name = $importer->create($this->getCredentials()->getUsername());

                if(!strlen($new_name))
                {
                        $this->getLogger()->debug('User creation failed.');
                        $this->handleAuthenticationFail($status, 'err_auth_cas_no_ilias_user');
                        return false;
                }

                $status->setStatus(ilAuthStatus::STATUS_AUTHENTICATED);
                $status->setAuthenticatedUserId(ilObjUser::_lookupId($new_name));
                return true;
        }

Here is the call graph for this function:

getSettings()

ilAuthProviderCAS::getSettings ( )

protected

Returns

Definition at line 36 of file class.ilAuthProviderCAS.php.

References $settings.

Referenced by doAuthentication().

        {
                return $this->settings;
        }

Here is the caller graph for this function:

handleLDAPDataSource()

ilAuthProviderCAS::handleLDAPDataSource ( \ilAuthStatus  $status )

protected

Handle user data synchonization by ldap data source.

Parameters

\ilAuthStatus

$status

Definition at line 121 of file class.ilAuthProviderCAS.php.

References $server, ilObjUser\_lookupId(), array, AUTH_CAS, ilAuthProvider\getCredentials(), ilLDAPServer\getDataSource(), ilLDAPServer\getInstanceByServerId(), ilAuthProvider\getLogger(), ilAuthProvider\handleAuthenticationFail(), ilAuthStatus\setAuthenticatedUserId(), ilLDAPUserSynchronisation\setExternalAccount(), ilAuthStatus\setStatus(), and ilAuthStatus\STATUS_AUTHENTICATED.

Referenced by doAuthentication().

        {
                include_once './Services/LDAP/classes/class.ilLDAPServer.php';
                $server = ilLDAPServer::getInstanceByServerId(
                        ilLDAPServer::getDataSource(AUTH_CAS)
                );

                $this->getLogger()->debug('Using ldap data source for user: ' . $this->getCredentials()->getUsername());

                include_once './Services/LDAP/classes/class.ilLDAPUserSynchronisation.php';
                $sync = new ilLDAPUserSynchronisation('cas', $server->getServerId());
                $sync->setExternalAccount($this->getCredentials()->getUsername());
                $sync->setUserData(array());
                $sync->forceCreation(true);

                try {
                        $internal_account = $sync->sync();
                }
                catch(UnexpectedValueException $e) {
                        $this->getLogger()->warning('Authentication failed with mesage: ' . $e->getMessage());
                        $this->handleAuthenticationFail($status, 'err_wrong_login');
                        return false;
                }
                catch(ilLDAPSynchronisationForbiddenException $e) {

                        // No syncronisation allowed => create Error
                        $this->getLogger()->warning('User creation disabled. No valid local account found');
                        $this->handleAuthenticationFail($status, 'err_auth_cas_no_ilias_user');
                        return false;
                }
                catch(ilLDAPAccountMigrationRequiredException $e) {

                        // No syncronisation allowed => create Error
                        $this->getLogger()->warning('User creation disabled. No valid local account found');
                        $this->handleAuthenticationFail($status, 'err_auth_cas_no_ilias_user');
                        return false;
                }
                $status->setStatus(ilAuthStatus::STATUS_AUTHENTICATED);
                $status->setAuthenticatedUserId(ilObjUser::_lookupId($internal_account));
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$settings

ilAuthProviderCAS::$settings = null

private

Definition at line 18 of file class.ilAuthProviderCAS.php.

Referenced by getSettings().

---

The documentation for this class was generated from the following file:

• Services/CAS/classes/class.ilAuthProviderCAS.php